RTDP.CLI.PartnerCmdlets.psd1

#
# Module manifest for module 'RTDP.CLI.PartnerCmdlets.dll'
#
# Generated by: AOLARIU
#
# Generated on: 03/07/2023
#

@{

# Script module or binary module file associated with this manifest.
RootModule = 'RTDP.CLI.PartnerCmdlets.dll'

# Version number of this module.
ModuleVersion = '2.1.0'

# Supported PSEditions
CompatiblePSEditions = @("Core")

# ID used to uniquely identify this module
GUID = 'fae99970-a8a2-4acc-816b-6f7d12f0fd85'

# Author of this module
Author = 'RISE Data Platform'

# Company or vendor of this module
CompanyName = 'Microsoft'

# Copyright statement for this module
Copyright = '(c) 2023-2024 Microsoft. All rights reserved.'

# Description of the functionality provided by this module
Description = '
The Partner PowerShell Cmdlets module is targeted for Data Platform partner-usage.
The cmdlets bring a breath of fresh air and come with an intuitive, verbose set of commands that can be ran as-is or as part of an automation script or a data management pipeline.'


# Minimum version of the Windows PowerShell engine required by this module
PowerShellVersion = '7.4.0'

# Assemblies that must be loaded prior to importing this module
RequiredAssemblies = @("Microsoft.Identity.Client.dll", "Microsoft.IdentityModel.Abstractions.dll")

# Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export.
FunctionsToExport = @()

# Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export.
CmdletsToExport = @(
                        "Initialize-PartnerSession",                                                        # Data Platform Partner Login Cmdlet

                        "Get-AvailableDatastores", "Get-DatastoreTables", "Get-DatastoreInformation",       # App Resources API Partner Cmdlets
                        "Promote-ResourceStorage",

                        "Get-DatasetContent", "Get-DatasetSchema", "Add-DatasetRecord",                     # Data Server API Partner Cmdlets

                        "Delete-PartnerDataset", "Get-AvailableDatasets", "Get-DatasetColumns",             # Dataset Manager API Partner Cmdlets
                        "Get-DatasetEnvironments", "Get-DatasetInformation", "Update-DatasetInformation",
                        "Promote-PartnerDataset", "Register-PartnerDataset", "Revoke-DatasetPromotion",

                        "Add-EntityEdge", "Get-EntityEdges", "Remove-EntityEdge",                            # Entity Service API Cmdlets
                        "Find-PossibleEntities", "Get-EntityEdgesConnectedToVertex", "Get-EntitySubgraph", "Get-ShortestPathFromVertexToVertex",
                        "Add-EntityVertex", "Get-EntityVertexById", "Get-EntityVertices", "Remove-EntityVertex", "Update-EntityVertex",

                        "Get-QueuedIngestionsByDatasetId", "Get-QueuedIngestionsByDatasetIdAndSourceId",
                        "Get-RequesterQueuedIngestions", "Register-QueuedIngestion",
                        "Add-PartnerKustoConnectorPipeline")                                                       # DataPipelineFactory API Partner Cmdlets


# Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export.
AliasesToExport = @(
                        "dp-login",                                                                 # Data Platform Partner Login alias

                        "dp-datastores", "dp-tables", "dp-datastore",                               # App Resources API Partner aliases
                        "dp-promote-storage",

                        "dp-content", "dp-schema", "dp-add",                                        # Data Server API Partner aliases

                        "dp-delete-dataset", "dp-datasets", "dp-columns",                           # Dataset Manager API Partner aliases
                        "dp-promote", "dp-register", "dp-demote",
                        "dp-environments", "dp-dataset", "dp-update",

                        "dp-add-edge", "dp-edges", "dp-delete-edge",                                 # Entity Service API aliases
                        "dp-find-possible-entities", "dp-edges-connected-to-vertex", "dp-subgraph", "dp-shortest-path",
                        "dp-add-vertex", "dp-get-vertex", "dp-get-vertices", "dp-remove-vertex", "dp-update-vertex",

                        "dp-queuedingestions", "dp-queuedingestions-dataset",
                        "dp-queuedingestions-dataset-source", "dp-ingestion",
                        "dp-add-kusto-connector-pipeline" )                                         # DataPipelineFactory API Partner aliases

# Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell.
PrivateData = @{

    PSData = @{

        # Tags applied to this module. These help with module discovery in online galleries.
        Tags = @("DataPlatform", "SovCloud")

        # A URL to the license for this module.
        #LicenseUri = 'Placeholder'

        # A URL to the main website for this project.
        #ProjectUri = 'Placeholder'

        # A URL to an icon representing this module.
        #IconUri = 'Placeholder'

        # ReleaseNotes of this module
        ReleaseNotes =
'
Version 2.1.0: added automatic proxy address HttpClient set-up for SAW machines.
Version 2.0.0: updated PowerShell Core SDK to v7.4.0 and migrated to .NET 8 foundation.
Version 1.6.0: swapped URLs for AFD; added failure message to HTTP response object;
Version 1.5.0: added a new environment: PPE.
Version 1.4.0: added queued ingestion cmdlets.
Version 1.3.0: added the `Promote-ResourceStorage` cmdlet, which allows for the promotion of a resource storage.
Version 1.2.0: added 1 more cmdlet; refactored internal logic for cmdlets: they all inherit from a base abstract class, to provide a standard experience throughout.
Version 1.1.1: refactored internal logic for cmdlets: they now perform better and are more verbose when specifying the `-Verbose` flag.
Version 1.1.0: total number of available partner cmdlets increased from 6 to 12. Currently supported environments: DEV, INT, PROD.
'


        # Flag to indicate whether the module requires explicit user acceptance for install/update/save
        #RequireLicenseAcceptance = $true

    } # End of PSData hashtable

} # End of PrivateData hashtable

# HelpInfo URI of this module
#HelpInfoURI = 'Placeholder'

}