https://github.com/cyb3rward0g/pwshazcosmosdb
A PowerShell module to manage documents on an Azure CosmosDB Database
https://github.com/cyb3rward0g/pwshazcosmosdb
Last synced: 6 months ago
JSON representation
A PowerShell module to manage documents on an Azure CosmosDB Database
- Host: GitHub
- URL: https://github.com/cyb3rward0g/pwshazcosmosdb
- Owner: Cyb3rWard0g
- License: mit
- Created: 2023-08-25T04:56:40.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-09-01T17:54:16.000Z (about 2 years ago)
- Last Synced: 2025-02-09T16:41:10.649Z (8 months ago)
- Language: C#
- Size: 34.2 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PwshAzCosmosDB
PwshAzCosmosDB is a PowerShell binary module built using .NET Core and designed to work with PowerShell Core. It provides cmdlets, written in C#, for performing document-level operations against Azure Cosmos DB. This module is designed to fill the gap left by the lack of document-level operations in the existing [Az.CosmosDB module](https://learn.microsoft.com/en-us/powershell/module/az.cosmosdb/?view=azps-10.2.0).
## Dependencies
`PwshAzCosmosDB` depends on the following NuGet packages:
- [Azure.Identity](https://www.nuget.org/packages/Azure.Identity/) (Version 1.10.0)
- [Microsoft.Azure.Cosmos](https://www.nuget.org/packages/Microsoft.Azure.Cosmos/) (Version 3.35.3)
- [PowerShellStandard.Library](https://www.nuget.org/packages/PowerShellStandard.Library/) (Version 7.0.0-preview.1)
- [dnMerge](https://www.nuget.org/packages/dnMerge/) (Version 0.5.15)
Note that the `dnMerge` package is used to merge multiple NuGet packages into a single assembly to improve module compatibility.
## Installation
To install the [PwshAzCosmosDB module](https://www.powershellgallery.com/packages/PwshAzCosmosDB), you can use the PowerShell Gallery:
```powershell
Install-Module -Name PwshAzCosmosDB -Scope CurrentUser -verbose
```
## Usage
`PwshAzCosmosDB` provides cmdlets for various document-level operations, including creating, reading, updating, and deleting documents in Azure Cosmos DB.
### Initialize Cosmos Client
first you need to connect to the Azure CosmosDB
#### Master Key
```powershell
$params = @{
"Endpoint" = "https://.documents.azure.com:443/"
"DatabaseName" = ""
"ContainerName" = ""
"MasterKey" = ""
"Verbose" = $true
}
Connect-AzCosmosDB @params
```
#### User Assigned Managed Identity
```powershell
$env:MANAGED_IDENTITY_CLIENT_ID = '.documents.azure.com:443/"
"DatabaseName" = ""
"ContainerName" = ""
"Verbose" = $true
}
Connect-AzCosmosDB @params
```
### Retrieve an existing document from Azure Cosmos DB
```powershell
Get-AzCosmosDBDocument -DocumentId "document-id" -PartitionKey "" -verbose
```
### Create a new document in Azure Cosmos DB
```powershell
$pkField = ''
$pkValue = ''
$documentHashtable = @{
"title" = "New Title"
"description" = "This is a new document"
"author" = "Roberto Rodriguez"
}
New-AzCosmosDBDocument -Document $documentHashTable -PartitionKeyField $pkField -PartitionKeyValue $pkValue -verbose
```
### Update an existing document in Azure Cosmos DB
```powershell
$documentId = ''
$pkField = ''
$pkValue = ''
$updatesHashtable = @{
"testField" = "testvalue"
}
Update-AzCosmosDBDocument -DocumentId $documentId -Updates $updatesHashtable -PartitionKeyField $pkField -PartitionKeyValue $pkValue -verbose
```
### Delete a document from Azure Cosmos DB
```powershell
Remove-AzCosmosDBDocument -DocumentId "document-id" -PartitionKey "" -verbose
```
## Contributing
Contributions are welcome! If you find any issues or have suggestions for improvements, feel free to open an issue or submit a pull request.
## License
This project is licensed under the MIT License.