CosmosDB.psd1
|
@{ # Script module or binary module file associated with this manifest. RootModule = 'CosmosDB.psm1' # Version number of this module. ModuleVersion = '5.0.0' # Supported PSEditions CompatiblePSEditions = 'Core', 'Desktop' # ID used to uniquely identify this module GUID = '7d7aeb42-8ed9-4555-b5fd-020795a5aa01' # Author of this module Author = 'Daniel Scott-Raynsford' # Company or vendor of this module CompanyName = 'None' # Copyright statement for this module Copyright = '(c) Daniel Scott-Raynsford. All rights reserved.' # Description of the functionality provided by this module Description = 'This module provides cmdlets for working with Azure Cosmos DB databases, collections, documents, attachments, offers, users, permissions, triggers, stored procedures and user defined functions.' # Minimum version of the Windows PowerShell engine required by this module PowerShellVersion = '5.1' # Modules that must be imported into the global environment prior to importing this module RequiredModules = @( @{ ModuleName = 'Az.Accounts'; GUID = '17a2feff-488b-47f9-8729-e2cec094624c'; ModuleVersion = '2.19.0'; }, @{ ModuleName = 'Az.Resources'; GUID = '48bb344d-4c24-441e-8ea0-589947784700'; ModuleVersion = '6.16.2'; } ) # Type files (.ps1xml) to be loaded when importing this module TypesToProcess = @( 'types\attachments.types.ps1xml', 'types\collections.types.ps1xml', 'types\databases.types.ps1xml', 'types\documents.types.ps1xml', 'types\offers.types.ps1xml', 'types\permissions.types.ps1xml', 'types\storedprocedures.types.ps1xml', 'types\triggers.types.ps1xml', 'types\userdefinedfunctions.types.ps1xml', 'types\users.types.ps1xml' ) # Format files (.ps1xml) to be loaded when importing this module FormatsToProcess = @( 'formats\attachments.formats.ps1xml', 'formats\collections.formats.ps1xml', 'formats\databases.formats.ps1xml', 'formats\documents.formats.ps1xml', 'formats\offers.formats.ps1xml', 'formats\permissions.formats.ps1xml', 'formats\storedprocedures.formats.ps1xml', 'formats\triggers.formats.ps1xml', 'formats\userdefinedfunctions.formats.ps1xml', 'formats\users.formats.ps1xml' ) # 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 = @('Get-CosmosDbAccount','Get-CosmosDbAccountConnectionString','Get-CosmosDbAccountMasterKey','New-CosmosDbAccount','New-CosmosDbAccountMasterKey','Remove-CosmosDbAccount','Set-CosmosDbAccount','Get-CosmosDbAttachment','Get-CosmosDbAttachmentResourcePath','New-CosmosDbAttachment','Remove-CosmosDbAttachment','Set-CosmosDbAttachment','Get-CosmosDbCollection','Get-CosmosDbCollectionResourcePath','Get-CosmosDbCollectionSize','New-CosmosDbCollection','New-CosmosDbCollectionCompositeIndexElement','New-CosmosDbCollectionExcludedPath','New-CosmosDbCollectionIncludedPath','New-CosmosDbCollectionIncludedPathIndex','New-CosmosDbCollectionIndexingPolicy','New-CosmosDbCollectionUniqueKey','New-CosmosDbCollectionUniqueKeyPolicy','Remove-CosmosDbCollection','Set-CosmosDbCollection','Get-CosmosDbDatabase','Get-CosmosDbDatabaseResourcePath','New-CosmosDbDatabase','Remove-CosmosDbDatabase','Get-CosmosDbDocument','Get-CosmosDbDocumentJson','Get-CosmosDbDocumentResourcePath','New-CosmosDbDocument','Remove-CosmosDbDocument','Set-CosmosDbDocument','Get-CosmosDbOffer','Get-CosmosDbOfferResourcePath','Set-CosmosDbOffer','Get-CosmosDbPermission','Get-CosmosDbPermissionResourcePath','New-CosmosDbPermission','Remove-CosmosDbPermission','Get-CosmosDbStoredProcedure','Get-CosmosDbStoredProcedureResourcePath','Invoke-CosmosDbStoredProcedure','New-CosmosDbStoredProcedure','Remove-CosmosDbStoredProcedure','Set-CosmosDbStoredProcedure','Get-CosmosDbTrigger','Get-CosmosDbTriggerResourcePath','New-CosmosDbTrigger','Remove-CosmosDbTrigger','Set-CosmosDbTrigger','Get-CosmosDbUserDefinedFunction','Get-CosmosDbUserDefinedFunctionResourcePath','New-CosmosDbUserDefinedFunction','Remove-CosmosDbUserDefinedFunction','Set-CosmosDbUserDefinedFunction','Get-CosmosDbUser','Get-CosmosDbUserResourcePath','New-CosmosDbUser','Remove-CosmosDbUser','Set-CosmosDbUser','Set-CosmosDbUserType','Get-CosmosDbContinuationToken','Get-CosmosDbEntraIdToken','Get-CosmosDbResponseHeaderAttribute','New-CosmosDbBackoffPolicy','New-CosmosDbContext','New-CosmosDbContextToken') # 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 = @() # Variables to export from this module VariablesToExport = '*' # 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 = 'New-CosmosDbConnection' # 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 = @('CosmosDB', 'DocumentDb', 'Azure', 'PSEdition_Core', 'PSEdition_Desktop', 'Windows', 'Linux', 'MacOS') # A URL to the license for this module. LicenseUri = 'https://github.com/PlagueHO/CosmosDB/blob/main/LICENSE' # A URL to the main website for this project. ProjectUri = 'https://github.com/PlagueHO/CosmosDB' # A URL to an icon representing this module. # IconUri = '' # ReleaseNotes of this module ReleaseNotes = '## [5.0.0] - 2024-06-07 ### Fixed - Removed unnecessary quotes from README (works without them in PowerShell and is easier to read) - Modified README to use splats, which is part of the recommended style guide - Removed Ubuntu-18.04 testing from build pipeline because it is no longer supported by Microsoft managed Azure DevOps images - Fixes [Issue #473](https://github.com/PlagueHO/CosmosDB/issues/473). - Added Ubuntu-22.04 testing to build pipeline - Fixes [Issue #474](https://github.com/PlagueHO/CosmosDB/issues/474). - Removed MacOS-10.15 testing from build pipeline because it is no longer supported by Microsoft managed Azure DevOps images - Fixes [Issue #476](https://github.com/PlagueHO/CosmosDB/issues/476). - Added macOS-12 testing to build pipeline - Fixes [Issue #477](https://github.com/PlagueHO/CosmosDB/issues/477). - Changed integration tests to deploy Cosmos DB using Bicep. - Update `requirements.psd1` to install modules `Az.Accounts` 2.19.0 and `Az.Resources` 6.16.2. - Renamed `New-CosmosDbAuthorizationToken` to `New-CosmosDbAuthorizationHeader` to better indicate actual function return type. - Refactored `Invoke-CosmosDbRequest` to support getting the EntraIdToken property from the context object and using it for authentication if it is provided. If the Key property is provided, the EntraIdToken property will take precendence and the key will be ignored. - Updated CI pipeline to use `PublishCodeCoverageResults@2` task rather than `PublishCodeCoverageResults@1` task to support the latest version of the task. ### Changed - BREAKING CHANGE: Updated module to require `Az.Accounts` v2.19.0 or newer and `Az.Resources` v6.16.2 or newer. - Renamed `New-CosmosDbAuthorizationHeader` to `Get-CosmosDbAuthorizationHeaderFromContext` to better indicate actual function behaviour. - Renamed `Get-CosmosDbAuthorizationHeadersFromContext` to `Get-CosmosDbAuthorizationHeaderFromContextResourceToken` to better indicate actual function behaviour and align naming convention. - Refactored `Invoke-CosmosDbRequest` to clean up logic to generate the authorization header. - Added new utillity function `Get-CosmosDbAuthorizationHeaderFromContextEntraId` to generate the authorization header when an Entra ID Token is provided in the context. This function is used by `Invoke-CosmosDbRequest` to generate the authorization header when an Entra ID Token is provided. - Changed module import process to load the `Az.Accounts` and `Az.Resources` modules only if they haven''t already been loaded to support saving the module and storing in folders. ### Added - Added support for setting an Entra Id OAuth2 Token in the `New-CosmosDbContext` - Fixes [Issue #479](https://github.com/PlagueHO/CosmosDB/issues/479). - Added new `Get-CosmosDbEntraIdToken` function that uses `Get-AzAccessToken` to get an Entra Id Token for use in Cosmos DB requests. This is used by `New-CosmosDbContext` to set the Entra Id Token in the context object - Fixes [Issue #479](https://github.com/PlagueHO/CosmosDB/issues/479). ' Prerelease = '' } # End of PSData hashtable } # End of PrivateData hashtable } |