diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 08fcbcbf..15d66633 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -15,7 +15,7 @@ If you'd like to contribute to this project, there are several different methods Before working on any enhancement, submit an Issue describing the proposed enhancement. Someone may already be working on the same thing. It also allows other contributors to comment on the proposal. -Alternately, feel free to post on the [CosmosDB Gitter Chat at https://gitter.im/PlagueHO/CosmosDB](https://gitter.im/PlagueHO/CosmosDB). This is also a great place to just say Hi, ask any questions you might have or get help. +Alternately, feel free to post on the [CosmosDB PowerShell Module Gitter Chat at https://gitter.im/PlagueHO/CosmosDB](https://gitter.im/PlagueHO/CosmosDB). This is also a great place to just say Hi, ask any questions you might have or get help. If you're new to Git revision control, and the GitHub service, it's suggested that you learn about some basic Git fundamentals, and take an overview of the GitHub service offerings. @@ -50,10 +50,10 @@ For more information, learn about our [branch structure](#branch-structure). - When you create a pull request, fill out the description with a summary of what's included in your changes. If the changes are related to an existing GitHub issue, please reference the issue in pull request title or description (e.g. ```Closes #11```). See [this](https://help.github.com/articles/closing-issues-via-commit-messages/) for more details. -- Include an update in the [/CosmosDB/Docs/ChangeList.md](/CosmosDB/Docs/ChangeList.md) file in your pull request to reflect changes for future versions changelog. Put them in `Unreleased` section (create one if doesn't exist). This would simplify the release process for Maintainers. Example: +- Include an update in the [/CHANGELOG.md](/CHANGELOG.md) file in your pull request to reflect changes for future versions changelog. Put them in `Unreleased` section (create one if doesn't exist). This would simplify the release process for Maintainers. Example: ``` - ### Unreleased + ## Unreleased - Added support for `-FriendlyName` in `Update-xDscResource`. ``` diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index f865e475..bdf8d089 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -3,8 +3,8 @@ Before submitting your issue for the CosmosDB project, please take a moment to p - [ ] Version of PowerShell you're using - [ ] PowerShell host you're using (eg. Console Host, ISE, Visual Studio) - [ ] Operating system you're running -- [ ] Version of CosmosDB you're using (use `Get-Module -Name CosmosDB`) +- [ ] Version of CosmosDB PowerShell Module you're using (use `Get-Module -Name CosmosDB`) -If you have a general question or suggestion, feel free to post on the [CosmosDB Gitter Chat at https://gitter.im/PlagueHO/CosmosDB](https://gitter.im/PlagueHO/CosmosDB). This is also a great place to just say Hi, ask any questions you might have or get help. +If you have a general question or suggestion, feel free to post on the [CosmosDB PowerShell Module Gitter Chat at https://gitter.im/PlagueHO/CosmosDB](https://gitter.im/PlagueHO/CosmosDB). This is also a great place to just say Hi, ask any questions you might have or get help. -Thanks for contributing your feedback and support! You can optionally submit a Pull Request against this project, if you have a fix you'd like to share. \ No newline at end of file +Thanks for contributing your feedback and support! You can optionally submit a Pull Request against this project, if you have a fix you'd like to share. diff --git a/CHANGELOG.md b/CHANGELOG.md index 881c4880..a9c04083 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,9 @@ # Change Log +## Unreleased + +- Changed references to `CosmosDB` to `Cosmos DB` in documentation - fixes [Issue #147](https://github.com/PlagueHO/CosmosDB/issues/147) + ## 2.1.4.536 - Added `RemoveDefaultTimeToLive` switch parameter to `Set-CosmosDbCollection` diff --git a/README.md b/README.md index c0e59395..20f92818 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,7 @@ [![PowerShell Gallery - CosmosDB](https://img.shields.io/badge/PowerShell%20Gallery-CosmosDB-blue.svg)](https://www.powershellgallery.com/packages/CosmosDB) [![Minimum Supported PowerShell Version](https://img.shields.io/badge/PowerShell-4.0-blue.svg)](https://github.com/PlagueHO/CosmosDB) [![Minimum Supported PowerShell Core Version](https://img.shields.io/badge/PowerShell_Core-6.0-blue.svg)](https://github.com/PlagueHO/CosmosDB) +[![Join the chat at https://gitter.im/PlagueHO/CosmosDB](https://badges.gitter.im/PlagueHO/CosmosDB.svg)](https://gitter.im/PlagueHO/CosmosDB?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) # CosmosDB PowerShell Module @@ -22,7 +23,7 @@ - [Working with Contexts](#working-with-contexts) - [Create a Context specifying the Key Manually](#create-a-context-specifying-the-key-manually) - [Use CosmosDB Module to Retrieve Key from Azure Management Portal](#use-cosmosdb-module-to-retrieve-key-from-azure-management-portal) - - [Create a Context for a CosmosDB Emulator](#create-a-context-for-a-cosmosdb-emulator) + - [Create a Context for a Cosmos DB Emulator](#create-a-context-for-a-cosmos-db-emulator) - [Create a Context from Resource Authorization Tokens](#create-a-Context-from-resource-authorization-tokens) - [Working with Databases](#working-with-databases) - [Working with Offers](#working-with-offers) @@ -47,7 +48,7 @@ This PowerShell module provides cmdlets for working with Azure Cosmos DB. -The CosmosDB PowerShell module enables management of: +The _CosmosDB PowerShell module_ enables management of: - [Attachments](#working-with-attachments) - [Collections](#working-with-collections) @@ -60,9 +61,9 @@ The CosmosDB PowerShell module enables management of: - [User Defined Functions](#working-with-user-defined-functions) - [Users](#working-with-users) -The module uses the CosmosDB (DocumentDB) Rest APIs. +The module uses the Cosmos DB (DocumentDB) Rest APIs. -For more information on the CosmosDB Rest APIs, see [this link](https://docs.microsoft.com/en-us/rest/api/documentdb/restful-interactions-with-documentdb-resources). +For more information on the Cosmos DB Rest APIs, see [this link](https://docs.microsoft.com/en-us/rest/api/documentdb/restful-interactions-with-documentdb-resources). ## Requirements @@ -90,12 +91,12 @@ Install-Module -Name CosmosDB The easiest way to use this module is to first create a context object using the `New-CosmosDbContext` cmdlet which you can then -use to pass to the other CosmosDB cmdlets in the module. +use to pass to the other Cosmos DB cmdlets in the module. To create the context object you will either need access to the -primary primary or secondary keys from your CosmosDB account or allow -the CosmosDB module to retrieve the keys directly from the Azure -management portal for you. +primary primary or secondary keys from your Cosmos DB account or allow +the _CosmosDB Powershell module_ to retrieve the keys directly from +the Azure management portal for you. ### Working with Contexts @@ -107,7 +108,7 @@ First convert your key into a secure string: $primaryKey = ConvertTo-SecureString -String 'GFJqJesi2Rq910E0G7P4WoZkzowzbj23Sm9DUWFX0l0P8o16mYyuaZBN00Nbtj9F1QQnumzZKSGZwknXGERrlA==' -AsPlainText -Force ``` -Use the key secure string, Azure CosmosDB account name and database to +Use the key secure string, Azure Cosmos DB account name and database to create a context variable: ```powershell @@ -116,9 +117,9 @@ $cosmosDbContext = New-CosmosDbContext -Account 'MyAzureCosmosDB' -Database 'MyD #### Use CosmosDB Module to Retrieve Key from Azure Management Portal -To create a context object so that the CosmosDB module retrieves the -primary or secondary key from the Azure Management Portal, use the -following command: +To create a context object so that the _CosmosDB PowerShell module_ +retrieves the primary or secondary key from the Azure Management +Portal, use the following command: ```powershell $cosmosDbContext = New-CosmosDbContext -Account 'MyAzureCosmosDB' -Database 'MyDatabase' -ResourceGroup 'MyCosmosDbResourceGroup' -MasterKeyType 'SecondaryMasterKey' @@ -126,15 +127,15 @@ $cosmosDbContext = New-CosmosDbContext -Account 'MyAzureCosmosDB' -Database 'MyD _Note: if PowerShell is not connected to Azure then an interactive Azure login will be initiated. If PowerShell is already connected to -an account that doesn't contain the CosmosDB you wish to connect to then +an account that doesn't contain the Cosmos DB you wish to connect to then you will first need to connect to the correct account using the `Add-AzureRmAccount` cmdlet._ -#### Create a Context for a CosmosDB Emulator +#### Create a Context for a Cosmos DB Emulator -Microsoft provides a [CosmosDB emulator](https://docs.microsoft.com/en-us/azure/cosmos-db/local-emulator) that +Microsoft provides a [Cosmos DB emulator](https://docs.microsoft.com/en-us/azure/cosmos-db/local-emulator) that you can run locally to enable testing and debugging scenarios. To create -a context for a CosmosDB emulator installed on the localhost use the +a context for a Cosmos DB emulator installed on the localhost use the following command: ```powershell @@ -149,19 +150,19 @@ Authorization Tokens_. ### Working with Databases -Create a new database in the CosmosDB account: +Create a new database in the Cosmos DB account: ```powershell New-CosmosDbDatabase -Context $cosmosDbContext -Id 'AnotherDatabase' ``` -Get a list of databases in the CosmosDB account: +Get a list of databases in the Cosmos DB account: ```powershell Get-CosmosDbDatabase -Context $cosmosDbContext ``` -Get the specified database from the CosmosDB account: +Get the specified database from the Cosmos DB account: ```powershell Get-CosmosDbDatabase -Context $cosmosDbContext -Id 'MyDatabase' @@ -169,13 +170,13 @@ Get-CosmosDbDatabase -Context $cosmosDbContext -Id 'MyDatabase' ### Working with Offers -Get a list of offers in the CosmosDB account: +Get a list of offers in the Cosmos DB account: ```powershell Get-CosmosDbOffer -Context $cosmosDbContext ``` -Query the offers in the CosmosDB account: +Query the offers in the Cosmos DB account: ```powershell Get-CosmosDbOffer -Context $cosmosDbContext -Query 'SELECT * FROM root WHERE (root["id"] = "lyiu")' @@ -233,10 +234,10 @@ Remove-CosmosDbCollection -Context $cosmosDbContext -Id 'MyNewCollection' You can create a collection with a custom indexing policy by assembling an Indexing Policy object using the functions: -- New-CosmosDbCollectionIncludedPathIndex -- New-CosmosDbCollectionIncludedPath -- New-CosmosDbCollectionExcludedPath -- New-CosmosDbCollectionIndexingPolicy +- `New-CosmosDbCollectionIncludedPathIndex` +- `New-CosmosDbCollectionIncludedPath` +- `New-CosmosDbCollectionExcludedPath` +- `New-CosmosDbCollectionIndexingPolicy` For example, to create a string range, a number range index and a point spatial index on the '/*' path using consistent indexing mode with no @@ -251,7 +252,7 @@ $indexingPolicy = New-CosmosDbCollectionIndexingPolicy -Automatic $true -Indexin New-CosmosDbCollection -Context $cosmosDbContext -Id 'MyNewCollection' -PartitionKey 'account' -IndexingPolicy $indexingPolicy ``` -For more information on how CosmosDB indexes documents, see [this page](https://docs.microsoft.com/en-us/azure/cosmos-db/indexing-policies). +For more information on how Cosmos DB indexes documents, see [this page](https://docs.microsoft.com/en-us/azure/cosmos-db/indexing-policies). #### Update an existing Collection with a new Indexing Policy @@ -464,7 +465,7 @@ The typical pattern for using _resource authorization tokens_ is to have a **token broker app** that provides some form of user authentication and then returns the _resource authorization tokens_ assigned to that user. This removes the requirement for the user to be given access to -the **master** key for the CosmosDB database. +the **master** key for the Cosmos DB database. For more information on using _resource authorization tokens_ or the **token broker app* pattern, please see [this document](https://docs.microsoft.com/en-us/azure/cosmos-db/secure-access-to-data#resource-tokens). @@ -784,11 +785,11 @@ document first. We would be very grateful of any contributions. ## Cmdlets -A list of Cmdlets in the CosmosDB module can be found by running the +A list of Cmdlets in the _CosmosDB PowerShell module_ can be found by running the following PowerShell commands: ```PowerShell -Import-Module CosmosDB +Import-Module -Name CosmosDB Get-Command -Module CosmosDB ``` diff --git a/docs/CosmosDB.md b/docs/CosmosDB.md index 841ce2a2..e441c67b 100644 --- a/docs/CosmosDB.md +++ b/docs/CosmosDB.md @@ -16,11 +16,11 @@ This PowerShell module provides cmdlets for working with Azure Cosmos DB. ### [ConvertTo-CosmosDbTokenDateString](ConvertTo-CosmosDbTokenDateString.md) Convert a DateTime object into the format required for use -in a CosmosDB Authorization Token and request header. +in a Cosmos DB Authorization Token and request header. ### [Get-CosmosDbAttachment](Get-CosmosDbAttachment.md) -Return the attachments for a CosmosDB document. +Return the attachments for a Cosmos DB document. ### [Get-CosmosDbAttachmentResourcePath](Get-CosmosDbAttachmentResourcePath.md) @@ -28,7 +28,7 @@ Return the resource path for an attachment object. ### [Get-CosmosDbCollection](Get-CosmosDbCollection.md) -Return the collections in a CosmosDB database. +Return the collections in a Cosmos DB database. ### [Get-CosmosDbCollectionResourcePath](Get-CosmosDbCollectionResourcePath.md) @@ -36,7 +36,7 @@ Return the resource path for a collection object. ### [Get-CosmosDbDatabase](Get-CosmosDbDatabase.md) -Return the databases in a CosmosDB account. +Return the databases in a Cosmos DB account. ### [Get-CosmosDbDatabaseResourcePath](Get-CosmosDbDatabaseResourcePath.md) @@ -44,7 +44,7 @@ Return the resource path for a database object. ### [Get-CosmosDbDocument](Get-CosmosDbDocument.md) -Return the documents for a CosmosDB database collection. +Return the documents for a Cosmos DB database collection. ### [Get-CosmosDbDocumentResourcePath](Get-CosmosDbDocumentResourcePath.md) @@ -52,7 +52,7 @@ Return the resource path for a document object. ### [Get-CosmosDbOffer](Get-CosmosDbOffer.md) -Return the offers in a CosmosDB account. +Return the offers in a Cosmos DB account. ### [Get-CosmosDbOfferResourcePath](Get-CosmosDbOfferResourcePath.md) @@ -60,7 +60,7 @@ Return the resource path for a offer object. ### [Get-CosmosDbPermission](Get-CosmosDbPermission.md) -Return the permissions for a CosmosDB database user. +Return the permissions for a Cosmos DB database user. ### [Get-CosmosDbPermissionResourcePath](Get-CosmosDbPermissionResourcePath.md) @@ -68,16 +68,16 @@ Return the resource path for a permission object. ### [Get-CosmosDbStoredProcedure](Get-CosmosDbStoredProcedure.md) -Return the stored procedures for a CosmosDB database collection. +Return the stored procedures for a Cosmos DB database collection. ### [Get-CosmosDbStoredProcedureResourcePath](Get-CosmosDbStoredProcedureResourcePath.md) -Execute a new stored procedure for a collection in a CosmosDB +Execute a new stored procedure for a collection in a Cosmos DB database. ### [Get-CosmosDbTrigger](Get-CosmosDbTrigger.md) -Return the triggers for a CosmosDB database collection. +Return the triggers for a Cosmos DB database collection. ### [Get-CosmosDbTriggerResourcePath](Get-CosmosDbTriggerResourcePath.md) @@ -85,16 +85,16 @@ Return the resource path for a trigger object. ### [Get-CosmosDbUri](Get-CosmosDbUri.md) -Return the URI of the CosmosDB that Rest APIs requests will +Return the URI of the Cosmos DB that Rest APIs requests will be sent to. ### [Get-CosmosDbUser](Get-CosmosDbUser.md) -Return the users in a CosmosDB database. +Return the users in a Cosmos DB database. ### [Get-CosmosDbUserDefinedFunction](Get-CosmosDbUserDefinedFunction.md) -Return the user defined functions for a CosmosDB database collection. +Return the user defined functions for a Cosmos DB database collection. ### [Get-CosmosDbUserDefinedFunctionResourcePath](Get-CosmosDbUserDefinedFunctionResourcePath.md) @@ -106,24 +106,24 @@ Return the resource path for a user object. ### [Invoke-CosmosDbRequest](Invoke-CosmosDbRequest.md) -Execute a new request to a CosmosDB REST endpoint. +Execute a new request to a Cosmos DB REST endpoint. ### [Invoke-CosmosDbStoredProcedure](Invoke-CosmosDbStoredProcedure.md) -Execute a new stored procedure for a collection in a CosmosDB database. +Execute a new stored procedure for a collection in a Cosmos DB database. ### [New-CosmosDbAttachment](New-CosmosDbAttachment.md) -Create a new attachment for a document in a CosmosDB database. +Create a new attachment for a document in a Cosmos DB database. ### [New-CosmosDbAuthorizationToken](New-CosmosDbAuthorizationToken.md) Create a new Authorization Token to be used with in a -Rest API request to CosmosDB. +Rest API request to Cosmos DB. ### [New-CosmosDbCollection](New-CosmosDbCollection.md) -Create a new collection in a CosmosDB database. +Create a new collection in a Cosmos DB database. ### [New-CosmosDbCollectionExcludedPath](New-CosmosDbCollectionExcludedPath.md) @@ -148,15 +148,15 @@ New-CosmosDbCollection function. ### [New-CosmosDbContext](New-CosmosDbContext.md) Create a context object containing the information required -to connect to a CosmosDB. +to connect to a Cosmos DB. ### [New-CosmosDbDatabase](New-CosmosDbDatabase.md) -Create a new database in a CosmosDB account. +Create a new database in a Cosmos DB account. ### [New-CosmosDbDocument](New-CosmosDbDocument.md) -Create a new document for a collection in a CosmosDB database. +Create a new document for a collection in a Cosmos DB database. ### [New-CosmosDbInvalidArgumentException](New-CosmosDbInvalidArgumentException.md) @@ -168,63 +168,63 @@ Creates and throws an invalid operation exception. ### [New-CosmosDbPermission](New-CosmosDbPermission.md) -Create a new permission for a user in a CosmosDB database. +Create a new permission for a user in a Cosmos DB database. ### [New-CosmosDbStoredProcedure](New-CosmosDbStoredProcedure.md) -Create a new stored procedure for a collection in a CosmosDB database. +Create a new stored procedure for a collection in a Cosmos DB database. ### [New-CosmosDbTrigger](New-CosmosDbTrigger.md) -Create a new trigger for a collection in a CosmosDB database. +Create a new trigger for a collection in a Cosmos DB database. ### [New-CosmosDbUser](New-CosmosDbUser.md) -Create a new user in a CosmosDB database. +Create a new user in a Cosmos DB database. ### [New-CosmosDbUserDefinedFunction](New-CosmosDbUserDefinedFunction.md) -Create a new user defined function for a collection in a CosmosDB database. +Create a new user defined function for a collection in a Cosmos DB database. ### [Remove-CosmosDbAttachment](Remove-CosmosDbAttachment.md) -Delete an attachment from a CosmosDB document. +Delete an attachment from a Cosmos DB document. ### [Remove-CosmosDbCollection](Remove-CosmosDbCollection.md) -Delete a collection from a CosmosDB database. +Delete a collection from a Cosmos DB database. ### [Remove-CosmosDbDatabase](Remove-CosmosDbDatabase.md) -Delete a database from a CosmosDB account. +Delete a database from a Cosmos DB account. ### [Remove-CosmosDbDocument](Remove-CosmosDbDocument.md) -Delete a document from a CosmosDB collection. +Delete a document from a Cosmos DB collection. ### [Remove-CosmosDbPermission](Remove-CosmosDbPermission.md) -Delete a permission from a CosmosDB user. +Delete a permission from a Cosmos DB user. ### [Remove-CosmosDbStoredProcedure](Remove-CosmosDbStoredProcedure.md) -Delete a stored procedure from a CosmosDB collection. +Delete a stored procedure from a Cosmos DB collection. ### [Remove-CosmosDbTrigger](Remove-CosmosDbTrigger.md) -Delete a trigger from a CosmosDB collection. +Delete a trigger from a Cosmos DB collection. ### [Remove-CosmosDbUser](Remove-CosmosDbUser.md) -Delete a user from a CosmosDB database. +Delete a user from a Cosmos DB database. ### [Remove-CosmosDbUserDefinedFunction](Remove-CosmosDbUserDefinedFunction.md) -Delete a user defined function from a CosmosDB collection. +Delete a user defined function from a Cosmos DB collection. ### [Set-CosmosDbAttachment](Set-CosmosDbAttachment.md) -Update am attachment for a CosmosDB document. +Update am attachment for a Cosmos DB document. ### [Set-CosmosDbAttachmentType](Set-CosmosDbAttachmentType.md) @@ -243,7 +243,7 @@ returned by an API call. ### [Set-CosmosDbDocument](Set-CosmosDbDocument.md) -Update a document from a CosmosDB collection. +Update a document from a Cosmos DB collection. ### [Set-CosmosDbDocumentType](Set-CosmosDbDocumentType.md) @@ -252,7 +252,7 @@ by an API call. ### [Set-CosmosDbOffer](Set-CosmosDbOffer.md) -Update an existing offer in a CosmosDB database. +Update an existing offer in a Cosmos DB database. ### [Set-CosmosDbOfferType](Set-CosmosDbOfferType.md) @@ -266,7 +266,7 @@ returned by an API call. ### [Set-CosmosDbStoredProcedure](Set-CosmosDbStoredProcedure.md) -Update a stored procedure from a CosmosDB collection. +Update a stored procedure from a Cosmos DB collection. ### [Set-CosmosDbStoredProcedureType](Set-CosmosDbStoredProcedureType.md) @@ -275,7 +275,7 @@ stored procedure returned by an API call. ### [Set-CosmosDbTrigger](Set-CosmosDbTrigger.md) -Update a trigger from a CosmosDB collection. +Update a trigger from a Cosmos DB collection. ### [Set-CosmosDbTriggerType](Set-CosmosDbTriggerType.md) @@ -284,11 +284,11 @@ by an API call. ### [Set-CosmosDbUser](Set-CosmosDbUser.md) -Set the user Id of an existing user in a CosmosDB database. +Set the user Id of an existing user in a Cosmos DB database. ### [Set-CosmosDbUserDefinedFunction](Set-CosmosDbUserDefinedFunction.md) -Update a user defined function from a CosmosDB collection. +Update a user defined function from a Cosmos DB collection. ### [Set-CosmosDbUserDefinedFunctionType](Set-CosmosDbUserDefinedFunctionType.md) diff --git a/docs/Get-CosmosDbAttachment.md b/docs/Get-CosmosDbAttachment.md index b1d16b64..9651ae83 100644 --- a/docs/Get-CosmosDbAttachment.md +++ b/docs/Get-CosmosDbAttachment.md @@ -9,7 +9,7 @@ schema: 2.0.0 ## SYNOPSIS -Return the attachments for a CosmosDB document. +Return the attachments for a Cosmos DB document. ## SYNTAX @@ -55,7 +55,7 @@ Get an attachment by Id for a document in a collection. ### -Context -This is an object containing the context information of the CosmosDB database +This is an object containing the context information of the Cosmos DB database that will be deleted. It should be created by \`New-CosmosDbContext\`. ```yaml @@ -72,7 +72,7 @@ Accept wildcard characters: False ### -Account -The account name of the CosmosDB to access. +The account name of the Cosmos DB to access. ```yaml Type: String @@ -88,7 +88,7 @@ Accept wildcard characters: False ### -Key -The key to be used to access this CosmosDB. +The key to be used to access this Cosmos DB. ```yaml Type: SecureString @@ -104,7 +104,7 @@ Accept wildcard characters: False ### -KeyType -The type of key that will be used to access ths CosmosDB. +The type of key that will be used to access ths Cosmos DB. ```yaml Type: String @@ -120,7 +120,7 @@ Accept wildcard characters: False ### -Database -The name of the database to access in the CosmosDB account. +The name of the database to access in the Cosmos DB account. ```yaml Type: String diff --git a/docs/Get-CosmosDbCollection.md b/docs/Get-CosmosDbCollection.md index c4b68f81..677245e6 100644 --- a/docs/Get-CosmosDbCollection.md +++ b/docs/Get-CosmosDbCollection.md @@ -9,7 +9,7 @@ schema: 2.0.0 ## SYNOPSIS -Return the collections in a CosmosDB database. +Return the collections in a Cosmos DB database. ## SYNTAX @@ -29,7 +29,7 @@ Get-CosmosDbCollection -Account [-Key ] [-KeyType [-Key ] [-KeyType [-Key ] [-KeyType ] ## DESCRIPTION -This cmdlet will return the databases in a CosmosDB account. +This cmdlet will return the databases in a Cosmos DB account. If the Id is specified then only the database matching this Id will be returned, otherwise all databases will be returned. @@ -55,7 +55,7 @@ Get the database 'MyDatabase' from the CosmosDB account. ### -Context -This is an object containing the context information of the CosmosDB database +This is an object containing the context information of the Cosmos DB database that will be deleted. It should be created by \`New-CosmosDbContext\`. If the context contains a database it will be ignored. @@ -74,7 +74,7 @@ Accept wildcard characters: False ### -Account -The account name of the CosmosDB to access. +The account name of the Cosmos DB to access. ```yaml Type: String @@ -90,7 +90,7 @@ Accept wildcard characters: False ### -Key -The key to be used to access this CosmosDB. +The key to be used to access this Cosmos DB. ```yaml Type: SecureString @@ -106,7 +106,7 @@ Accept wildcard characters: False ### -KeyType -The type of key that will be used to access ths CosmosDB. +The type of key that will be used to access ths Cosmos DB. ```yaml Type: String diff --git a/docs/Get-CosmosDbDocument.md b/docs/Get-CosmosDbDocument.md index 33c5caea..b8af6917 100644 --- a/docs/Get-CosmosDbDocument.md +++ b/docs/Get-CosmosDbDocument.md @@ -9,7 +9,7 @@ schema: 2.0.0 ## SYNOPSIS -Return the documents for a CosmosDB database collection. +Return the documents for a Cosmos DB database collection. ## SYNTAX @@ -35,8 +35,8 @@ Get-CosmosDbDocument -Account [-Key ] [-KeyType ] ## DESCRIPTION -This cmdlet will return the documents for a specified -collection in a CosmosDB database. +This cmdlet will return the documents for a specified collection in a +Cosmos DB database. If an Id is specified then only the specified documents will be returned. ## EXAMPLES @@ -94,7 +94,7 @@ Query the documents in a collection using a parameterized query. ### -Context -This is an object containing the context information of the CosmosDB database +This is an object containing the context information of the Cosmos DB database that will be deleted. It should be created by \`New-CosmosDbContext\`. ```yaml @@ -111,7 +111,7 @@ Accept wildcard characters: False ### -Account -The account name of the CosmosDB to access. +The account name of the Cosmos DB to access. ```yaml Type: String @@ -127,7 +127,7 @@ Accept wildcard characters: False ### -Key -The key to be used to access this CosmosDB. +The key to be used to access this Cosmos DB. ```yaml Type: SecureString @@ -143,7 +143,7 @@ Accept wildcard characters: False ### -KeyType -The type of key that will be used to access ths CosmosDB. +The type of key that will be used to access ths Cosmos DB. ```yaml Type: String @@ -159,7 +159,7 @@ Accept wildcard characters: False ### -Database -The name of the database to access in the CosmosDB account. +The name of the database to access in the Cosmos DB account. ```yaml Type: String diff --git a/docs/Get-CosmosDbOffer.md b/docs/Get-CosmosDbOffer.md index 2f51ddf4..53438ab0 100644 --- a/docs/Get-CosmosDbOffer.md +++ b/docs/Get-CosmosDbOffer.md @@ -9,7 +9,7 @@ schema: 2.0.0 ## SYNOPSIS -Return the offers in a CosmosDB account. +Return the offers in a Cosmos DB account. ## SYNTAX @@ -29,7 +29,7 @@ Get-CosmosDbOffer -Account [-Key ] [-KeyType ] [- ## DESCRIPTION -This cmdlet will return the offers in a CosmosDB account. +This cmdlet will return the offers in a Cosmos DB account. If the Id is specified then only the offer matching this Id will be returned, otherwise all offers will be returned. @@ -41,7 +41,7 @@ Id will be returned, otherwise all offers will be returned. PS C:\> Get-CosmosDbOffer -Context $cosmosDbContext ``` -Get a list of offers in a CosmosDB account. +Get a list of offers in a Cosmos DB account. ### Example 2 @@ -49,7 +49,7 @@ Get a list of offers in a CosmosDB account. PS C:\> Get-CosmosDbOffer -Context $cosmosDbContext -Id '6d9t' ``` -Get the offer with Id '6d9t' from a CosmosDB account. +Get the offer with Id '6d9t' from a Cosmos DB account. ### Example 3 @@ -57,14 +57,14 @@ Get the offer with Id '6d9t' from a CosmosDB account. PS C:\> Get-CosmosDbOffer -Context $cosmosDbContext -Query 'SELECT * FROM root WHERE (root["id"] = "6d9t")' ``` -Get the offer with Id '6d9t' from a CosmosDB account using +Get the offer with Id '6d9t' from a Cosmos DB account using a select query. ## PARAMETERS ### -Context -This is an object containing the context information of the CosmosDB database +This is an object containing the context information of the Cosmos DB database that will be deleted. It should be created by \`New-CosmosDbContext\`. If the context contains a database it will be ignored. @@ -83,7 +83,7 @@ Accept wildcard characters: False ### -Account -The account name of the CosmosDB to access. +The account name of the Cosmos DB to access. ```yaml Type: String @@ -99,7 +99,7 @@ Accept wildcard characters: False ### -Key -The key to be used to access this CosmosDB. +The key to be used to access this Cosmos DB. ```yaml Type: SecureString @@ -115,7 +115,7 @@ Accept wildcard characters: False ### -KeyType -The type of key that will be used to access ths CosmosDB. +The type of key that will be used to access ths Cosmos DB. ```yaml Type: String diff --git a/docs/Get-CosmosDbPermission.md b/docs/Get-CosmosDbPermission.md index 710e2c43..9105085b 100644 --- a/docs/Get-CosmosDbPermission.md +++ b/docs/Get-CosmosDbPermission.md @@ -9,7 +9,7 @@ schema: 2.0.0 ## SYNOPSIS -Return the permissions for a CosmosDB database user. +Return the permissions for a Cosmos DB database user. ## SYNTAX @@ -30,7 +30,7 @@ Get-CosmosDbPermission -Account [-Key ] [-KeyType [-Key ] [-KeyType [-Key ] [-KeyType ] ## DESCRIPTION This cmdlet will return the triggers for a specified collection -in a CosmosDB database. +in a Cosmos DB database. If an Id is specified then only the specified trigger will be returned. ## EXAMPLES @@ -55,7 +55,7 @@ Get the 'eventhub' trigger from a collection in the database. ### -Context -This is an object containing the context information of the CosmosDB database +This is an object containing the context information of the Cosmos DB database that will be deleted. It should be created by \`New-CosmosDbContext\`. ```yaml @@ -72,7 +72,7 @@ Accept wildcard characters: False ### -Account -The account name of the CosmosDB to access. +The account name of the Cosmos DB to access. ```yaml Type: String @@ -88,7 +88,7 @@ Accept wildcard characters: False ### -Key -The key to be used to access this CosmosDB. +The key to be used to access this Cosmos DB. ```yaml Type: SecureString @@ -104,7 +104,7 @@ Accept wildcard characters: False ### -KeyType -The type of key that will be used to access ths CosmosDB. +The type of key that will be used to access ths Cosmos DB. ```yaml Type: String @@ -120,7 +120,7 @@ Accept wildcard characters: False ### -Database -The name of the database to access in the CosmosDB account. +The name of the database to access in the Cosmos DB account. ```yaml Type: String diff --git a/docs/Get-CosmosDbUri.md b/docs/Get-CosmosDbUri.md index fd937bbc..a7cd6ce8 100644 --- a/docs/Get-CosmosDbUri.md +++ b/docs/Get-CosmosDbUri.md @@ -9,7 +9,7 @@ schema: 2.0.0 ## SYNOPSIS -Return the URI of the CosmosDB that Rest APIs requests will +Return the URI of the Cosmos DB that Rest APIs requests will be sent to. ## SYNTAX @@ -20,7 +20,7 @@ Get-CosmosDbUri [-Account] [[-BaseUri] ] [] ## DESCRIPTION -This cmdlet returns the root URI of the CosmosDB. +This cmdlet returns the root URI of the Cosmos DB. ## EXAMPLES @@ -30,7 +30,7 @@ This cmdlet returns the root URI of the CosmosDB. PS C:\> $uri = Get-CosmosDbUri -Account 'MyAzureCosmosDB' ``` -Generates the URI for accessing an Azure CosmosDB account. +Generates the URI for accessing an Azure Cosmos DB account. ### EXAMPLE 2 @@ -38,14 +38,14 @@ Generates the URI for accessing an Azure CosmosDB account. PS C:\>$uri = Get-CosmosDbUri -Account 'MyAzureCosmosDB' -BaseUri 'localhost' ``` -Generates the URI for accessing a CosmosDB emulator account +Generates the URI for accessing a Cosmos DB emulator account on the localhost. ## PARAMETERS ### -Account -This is the name of the CosmosDB Account to get the URI +This is the name of the Cosmos DB Account to get the URI for. ```yaml @@ -62,7 +62,7 @@ Accept wildcard characters: False ### -BaseUri -This is the base URI of the CosmosDB to use. +This is the base URI of the Cosmos DB to use. If not specified it will default to 'documents.azure.com'. ```yaml diff --git a/docs/Get-CosmosDbUser.md b/docs/Get-CosmosDbUser.md index b52337f0..9fa8cf4a 100644 --- a/docs/Get-CosmosDbUser.md +++ b/docs/Get-CosmosDbUser.md @@ -9,7 +9,7 @@ schema: 2.0.0 ## SYNOPSIS -Return the users in a CosmosDB database. +Return the users in a Cosmos DB database. ## SYNTAX @@ -29,7 +29,7 @@ Get-CosmosDbUser -Account [-Database ] [-Key ] [- ## DESCRIPTION -This cmdlet will return the users in a CosmosDB database. +This cmdlet will return the users in a Cosmos DB database. If the Id is specified then only the user matching this Id will be returned, otherwise all users will be returned. @@ -55,7 +55,7 @@ Get a the user with Id 'Mary' from the database. ### -Context -This is an object containing the context information of the CosmosDB database +This is an object containing the context information of the Cosmos DB database that will be deleted. It should be created by \`New-CosmosDbContext\`. ```yaml @@ -72,7 +72,7 @@ Accept wildcard characters: False ### -Account -The account name of the CosmosDB to access. +The account name of the Cosmos DB to access. ```yaml Type: String @@ -88,7 +88,7 @@ Accept wildcard characters: False ### -Database -The name of the database to access in the CosmosDB account. +The name of the database to access in the Cosmos DB account. ```yaml Type: String @@ -104,7 +104,7 @@ Accept wildcard characters: False ### -Key -The key to be used to access this CosmosDB. +The key to be used to access this Cosmos DB. ```yaml Type: SecureString @@ -120,7 +120,7 @@ Accept wildcard characters: False ### -KeyType -The type of key that will be used to access ths CosmosDB. +The type of key that will be used to access ths Cosmos DB. ```yaml Type: String diff --git a/docs/Get-CosmosDbUserDefinedFunction.md b/docs/Get-CosmosDbUserDefinedFunction.md index d3406742..99b3ef5f 100644 --- a/docs/Get-CosmosDbUserDefinedFunction.md +++ b/docs/Get-CosmosDbUserDefinedFunction.md @@ -9,7 +9,7 @@ schema: 2.0.0 ## SYNOPSIS -Return the user defined functions for a CosmosDB database collection. +Return the user defined functions for a Cosmos DB database collection. ## SYNTAX @@ -30,9 +30,9 @@ Get-CosmosDbUserDefinedFunction -Account [-Key ] [-KeyTyp ## DESCRIPTION This cmdlet will return the user defined functions for a specified -collection in a CosmosDB database. -If an Id is specified then only -the specified user defined functions will be returned. +collection in a Cosmos DB database. +If an Id is specified then only the specified user defined functions +will be returned. ## EXAMPLES @@ -56,7 +56,7 @@ Get the 'myudf' user defined function from a collection in the database. ### -Context -This is an object containing the context information of the CosmosDB database +This is an object containing the context information of the Cosmos DB database that will be deleted. It should be created by \`New-CosmosDbContext\`. ```yaml @@ -73,7 +73,7 @@ Accept wildcard characters: False ### -Account -The account name of the CosmosDB to access. +The account name of the Cosmos DB to access. ```yaml Type: String @@ -89,7 +89,7 @@ Accept wildcard characters: False ### -Key -The key to be used to access this CosmosDB. +The key to be used to access this Cosmos DB. ```yaml Type: SecureString @@ -105,7 +105,7 @@ Accept wildcard characters: False ### -KeyType -The type of key that will be used to access ths CosmosDB. +The type of key that will be used to access ths Cosmos DB. ```yaml Type: String @@ -121,7 +121,7 @@ Accept wildcard characters: False ### -Database -The name of the database to access in the CosmosDB account. +The name of the database to access in the Cosmos DB account. ```yaml Type: String diff --git a/docs/Invoke-CosmosDbRequest.md b/docs/Invoke-CosmosDbRequest.md index 6dc2a869..720aad43 100644 --- a/docs/Invoke-CosmosDbRequest.md +++ b/docs/Invoke-CosmosDbRequest.md @@ -9,7 +9,7 @@ schema: 2.0.0 ## SYNOPSIS -Execute a new request to a CosmosDB REST endpoint. +Execute a new request to a Cosmos DB REST endpoint. ## SYNTAX @@ -31,7 +31,7 @@ Invoke-CosmosDbRequest -Account [-Database ] [-Key $result = Invoke-CosmosDbRequest -Context $context -ResourceType 'colls' -ResourcePath 'dbs/mydatabase' ``` -Execute a request to the CosmosDB specified by the context +Execute a request to the Cosmos DB specified by the context $context to Get the collections in the database mydatabase. ### Example 2 @@ -51,7 +51,7 @@ $context to Get the collections in the database mydatabase. PS C:\> $result = Invoke-CosmosDbRequest -Context $context -ResourceType 'docs' -ResourcePath 'dbs/mydatabase/colls/mycollection/docs/ac12345' -Method 'Put' -Body $body ``` -Execute a request to the CosmosDB specified by the context +Execute a request to the Cosmos DB specified by the context $context to Put document 'ac12345' into collection mycollection in database mydatabase. @@ -59,7 +59,7 @@ in database mydatabase. ### -Context -This is an object containing the context information of the CosmosDB database +This is an object containing the context information of the Cosmos DB database that will be deleted. It should be created by \`New-CosmosDbContext\`. ```yaml @@ -76,7 +76,7 @@ Accept wildcard characters: False ### -Account -The account name of the CosmosDB to access. +The account name of the Cosmos DB to access. ```yaml Type: String @@ -111,7 +111,7 @@ Accept wildcard characters: False ### -Key -The key to be used to access this CosmosDB. +The key to be used to access this Cosmos DB. ```yaml Type: SecureString @@ -127,7 +127,7 @@ Accept wildcard characters: False ### -KeyType -The type of key that will be used to access ths CosmosDB. +The type of key that will be used to access ths Cosmos DB. ```yaml Type: String @@ -143,7 +143,7 @@ Accept wildcard characters: False ### -Method -This is the Rest API method that will be made to the CosmosDB. +This is the Rest API method that will be made to the Cosmos DB. ```yaml Type: String @@ -159,7 +159,7 @@ Accept wildcard characters: False ### -ResourceType -This is type of resource being accessed in the CosmosDB. +This is type of resource being accessed in the Cosmos DB. For example: users, colls ```yaml @@ -177,9 +177,9 @@ Accept wildcard characters: False ### -ResourcePath This is the path to the resource that should be accessed in -the CosmosDB. -This will be appended to the path after the -resourceId in the URI that will be used to access the resource. +the Cosmos DB. +This will be appended to the path after the resourceId in the URI +that will be used to access the resource. ```yaml Type: String diff --git a/docs/Invoke-CosmosDbStoredProcedure.md b/docs/Invoke-CosmosDbStoredProcedure.md index 03d4ccdc..9e5b82b8 100644 --- a/docs/Invoke-CosmosDbStoredProcedure.md +++ b/docs/Invoke-CosmosDbStoredProcedure.md @@ -9,7 +9,7 @@ schema: 2.0.0 ## SYNOPSIS -Execute a new stored procedure for a collection in a CosmosDB database. +Execute a new stored procedure for a collection in a Cosmos DB database. ## SYNTAX @@ -32,7 +32,7 @@ Invoke-CosmosDbStoredProcedure -Account [-KeyType ] [-Key Invoke-CosmosDbStoredProcedure -Context $cosmosDbContext -CollectionId 'MyNewCollection' -Id 'spHelloWorld' ``` -Execute a stored procedure called 'spHelloWorld' in a collection in the database. +Execute a stored procedure called 'spHelloWorld' in a collection in the +database. ### Example 2 @@ -50,13 +51,14 @@ Execute a stored procedure called 'spHelloWorld' in a collection in the database PS C:\> Invoke-CosmosDbStoredProcedure -Context $cosmosDbContext -CollectionId 'MyNewCollection' -Id 'spHelloWorld' -StoredProcedureParameters @('PowerShell') ``` -Execute a stored procedure called 'spHelloWorld' passing in the parameter 'PowerShell' in a collection in the database. +Execute a stored procedure called 'spHelloWorld' passing in the parameter +'PowerShell' in a collection in the database. ## PARAMETERS ### -Context -This is an object containing the context information of the CosmosDB database +This is an object containing the context information of the Cosmos DB database that will be deleted. It should be created by \`New-CosmosDbContext\`. ```yaml @@ -73,7 +75,7 @@ Accept wildcard characters: False ### -Account -The account name of the CosmosDB to access. +The account name of the Cosmos DB to access. ```yaml Type: String @@ -89,7 +91,7 @@ Accept wildcard characters: False ### -KeyType -The type of key that will be used to access ths CosmosDB. +The type of key that will be used to access ths Cosmos DB. ```yaml Type: String @@ -105,7 +107,7 @@ Accept wildcard characters: False ### -Key -The key to be used to access this CosmosDB. +The key to be used to access this Cosmos DB. ```yaml Type: SecureString @@ -121,7 +123,7 @@ Accept wildcard characters: False ### -Database -The name of the database to access in the CosmosDB account. +The name of the database to access in the Cosmos DB account. ```yaml Type: String diff --git a/docs/New-CosmosDbAttachment.md b/docs/New-CosmosDbAttachment.md index 89833245..6dac8476 100644 --- a/docs/New-CosmosDbAttachment.md +++ b/docs/New-CosmosDbAttachment.md @@ -9,7 +9,7 @@ schema: 2.0.0 ## SYNOPSIS -Create a new attachment for a document in a CosmosDB database. +Create a new attachment for a document in a Cosmos DB database. ## SYNTAX @@ -31,7 +31,7 @@ New-CosmosDbAttachment -Account [-KeyType ] [-Key [[-KeyType] ] [[-Me ## DESCRIPTION This cmdlet is used to create an Authorization Token to -pass in the header of a Rest API request to an Azure CosmosDB. +pass in the header of a Rest API request to an Azure Cosmos DB. The Authorization token that is generated must match the other parameters in the header of the request that is passed. @@ -36,14 +36,14 @@ PS C:\> $dttoken = ConvertTo-CosmosDbTokenDateString -Date (Get-Date) PS C:\> $token = New-CosmosDbAuthorizationToken -Key $Key -KeyType master -Method Get -ResourceType 'dbs' -ResourceId 'dbs/mydatabase' -Date ($dttoken) ``` -Generate a CosmosDB authorization token using a master key $Key +Generate a Cosmos DB authorization token using a master key $Key for issuing a 'Get' request on the dbs (database) 'mydatabase'. ## PARAMETERS ### -Key -The key to be used to access this CosmosDB. +The key to be used to access this Cosmos DB. ```yaml Type: SecureString @@ -59,7 +59,7 @@ Accept wildcard characters: False ### -KeyType -The type of key that will be used to access ths CosmosDB. +The type of key that will be used to access ths Cosmos DB. ```yaml Type: String @@ -92,7 +92,7 @@ Accept wildcard characters: False ### -ResourceType -This is type of resource being accessed in the CosmosDB. +This is type of resource being accessed in the Cosmos DB. For example: users, colls ```yaml @@ -109,7 +109,7 @@ Accept wildcard characters: False ### -ResourceId -This is the resource Id of the CosmosDB being accessed. +This is the resource Id of the Cosmos DB being accessed. This is in the format 'dbs/{database}' and must match the the value in the path of the URI that the request is made to. diff --git a/docs/New-CosmosDbCollection.md b/docs/New-CosmosDbCollection.md index 2ac2567b..3185c86b 100644 --- a/docs/New-CosmosDbCollection.md +++ b/docs/New-CosmosDbCollection.md @@ -9,7 +9,7 @@ schema: 2.0.0 ## SYNOPSIS -Create a new collection in a CosmosDB database. +Create a new collection in a Cosmos DB database. ## SYNTAX @@ -31,7 +31,7 @@ New-CosmosDbCollection -Account [-Key ] [-KeyType ] [-Emulator] [-Port ] [-RetryPoli ## DESCRIPTION -This cmdlet is used to simplify the calling of the CosmosDB +This cmdlet is used to simplify the calling of the Cosmos DB cmdlets by providing all the context information in an -object that can be passed to the CosmosDB cmdlets. +object that can be passed to the Cosmos DB cmdlets. -It can also retrieve the CosmosDB primary or secondary key +It can also retrieve the Cosmos DB primary or secondary key from Azure Resource Manager. A retry policy can be applied to the context to control @@ -66,7 +66,7 @@ PS C:\> Add-AzureRmAccount PS C:\> $cosmosDbContext = New-CosmosDbContext -Account 'MyAzureCosmosDB' -Database 'MyDatabase' -ResourceGroup 'MyCosmosDbResourceGroup' -MasterKeyType 'PrimaryMasterKey' ``` -Creates a CosmosDB context by logging into Azure and getting +Creates a Cosmos DB context by logging into Azure and getting it from the portal. ### EXAMPLE 3 @@ -75,7 +75,7 @@ it from the portal. PS C:\> $cosmosDbContext = New-CosmosDbContext -Emulator ``` -Creates a CosmosDB context by using a local CosmosDB Emulator. +Creates a Cosmos DB context by using a local Cosmos DB Emulator. ### EXAMPLE 4 @@ -85,7 +85,7 @@ PS C:\> $retryPolicy = New-CosmosDBRetryPolicy -MaxRetries 5 -Delay 2000 PS C:\> $cosmosDbContext = New-CosmosDbContext -Account 'MyAzureCosmosDB' -Database 'MyDatabase' -Key $primaryKey -RetryPolicy $retryPolicy ``` -Creates a CosmosDB context specifying the master key manually. A +Creates a Cosmos DB context specifying the master key manually. A retry policy will be applied to the context that allows 5 retries with a delay of 2 seconds between them. @@ -93,7 +93,7 @@ with a delay of 2 seconds between them. ### -Account -The account name of the CosmosDB to access. +The account name of the Cosmos DB to access. ```yaml Type: String @@ -109,7 +109,7 @@ Accept wildcard characters: False ### -Database -The name of the database to access in the CosmosDB account. +The name of the database to access in the Cosmos DB account. ```yaml Type: String @@ -125,7 +125,7 @@ Accept wildcard characters: False ### -Key -The key to be used to access this CosmosDB. +The key to be used to access this Cosmos DB. ```yaml Type: SecureString @@ -141,7 +141,7 @@ Accept wildcard characters: False ### -KeyType -The type of key that will be used to access ths CosmosDB. +The type of key that will be used to access ths Cosmos DB. Note: This parameter should always be set to master and will be deprecated in a future release. Do not use it. @@ -161,7 +161,7 @@ Accept wildcard characters: False ### -ResourceGroup This is the name of the Azure Resouce Group containing the -CosmosDB. +Cosmos DB. ```yaml Type: String @@ -178,7 +178,7 @@ Accept wildcard characters: False ### -MasterKeyType This is the master key type to use retrieve from Azure for -the CosmosDB. +the Cosmos DB. ```yaml Type: String @@ -194,7 +194,7 @@ Accept wildcard characters: False ### -Emulator -Using this switch creates a context for a CosmosDB emulator +Using this switch creates a context for a Cosmos DB emulator installed onto the local host. ```yaml @@ -211,7 +211,7 @@ Accept wildcard characters: False ### -Port -This is the port the CosmosDB emulator is installed onto. +This is the port the Cosmos DB emulator is installed onto. If not specified it will use the default port of 8081. ```yaml @@ -229,7 +229,7 @@ Accept wildcard characters: False ### -Token This is an array of Token objects. These can be generated by -retrieving a CosmosDB user account that has had permissions assigned. +retrieving a Cosmos DB user account that has had permissions assigned. ```yaml Type: CosmosDB.Token diff --git a/docs/New-CosmosDbDatabase.md b/docs/New-CosmosDbDatabase.md index d28bf72a..41d3c580 100644 --- a/docs/New-CosmosDbDatabase.md +++ b/docs/New-CosmosDbDatabase.md @@ -9,7 +9,7 @@ schema: 2.0.0 ## SYNOPSIS -Create a new database in a CosmosDB account. +Create a new database in a Cosmos DB account. ## SYNTAX @@ -29,7 +29,7 @@ New-CosmosDbDatabase -Account [-Key ] [-KeyType ] ## DESCRIPTION -This cmdlet will create a database in CosmosDB. +This cmdlet will create a database in Cosmos DB. ## EXAMPLES @@ -39,13 +39,13 @@ This cmdlet will create a database in CosmosDB. PS C:\> New-CosmosDbDatabase -Context $cosmosDbContext -Id 'AnotherDatabase' ``` -Create a new database in the CosmosDB account. +Create a new database in the Cosmos DB account. ## PARAMETERS ### -Context -This is an object containing the context information of the CosmosDB database +This is an object containing the context information of the Cosmos DB database that will be deleted. It should be created by \`New-CosmosDbContext\`. ```yaml @@ -62,7 +62,7 @@ Accept wildcard characters: False ### -Account -The account name of the CosmosDB to access. +The account name of the Cosmos DB to access. ```yaml Type: String @@ -78,7 +78,7 @@ Accept wildcard characters: False ### -Key -The key to be used to access this CosmosDB. +The key to be used to access this Cosmos DB. ```yaml Type: SecureString @@ -94,7 +94,7 @@ Accept wildcard characters: False ### -KeyType -The type of key that will be used to access ths CosmosDB. +The type of key that will be used to access ths Cosmos DB. ```yaml Type: String diff --git a/docs/New-CosmosDbDocument.md b/docs/New-CosmosDbDocument.md index 9938ea48..b2d0311f 100644 --- a/docs/New-CosmosDbDocument.md +++ b/docs/New-CosmosDbDocument.md @@ -9,7 +9,7 @@ schema: 2.0.0 ## SYNOPSIS -Create a new document for a collection in a CosmosDB database. +Create a new document for a collection in a Cosmos DB database. ## SYNTAX @@ -31,7 +31,7 @@ New-CosmosDbDocument -Account [-KeyType ] [-Key ] ## DESCRIPTION -This cmdlet will create a document for a collection in a CosmosDB. +This cmdlet will create a document for a collection in a Cosmos DB. ## EXAMPLES @@ -69,7 +69,7 @@ Create a new document in the 'en-us' in a partitioned collection in a database. ### -Context -This is an object containing the context information of the CosmosDB database +This is an object containing the context information of the Cosmos DB database that will be deleted. It should be created by \`New-CosmosDbContext\`. ```yaml @@ -86,7 +86,7 @@ Accept wildcard characters: False ### -Account -The account name of the CosmosDB to access. +The account name of the Cosmos DB to access. ```yaml Type: String @@ -102,7 +102,7 @@ Accept wildcard characters: False ### -KeyType -The type of key that will be used to access ths CosmosDB. +The type of key that will be used to access ths Cosmos DB. ```yaml Type: String @@ -118,7 +118,7 @@ Accept wildcard characters: False ### -Key -The key to be used to access this CosmosDB. +The key to be used to access this Cosmos DB. ```yaml Type: SecureString @@ -134,7 +134,7 @@ Accept wildcard characters: False ### -Database -The name of the database to access in the CosmosDB account. +The name of the database to access in the Cosmos DB account. ```yaml Type: String diff --git a/docs/New-CosmosDbPermission.md b/docs/New-CosmosDbPermission.md index f06d9c67..3c2659c9 100644 --- a/docs/New-CosmosDbPermission.md +++ b/docs/New-CosmosDbPermission.md @@ -9,7 +9,7 @@ schema: 2.0.0 ## SYNOPSIS -Create a new permission for a user in a CosmosDB database. +Create a new permission for a user in a Cosmos DB database. ## SYNTAX @@ -29,7 +29,7 @@ New-CosmosDbPermission -Account [-KeyType ] [-Key [-KeyType ] [-Key [-KeyType ] [-Key ] ## DESCRIPTION -This cmdlet will create a trigger for a collection in a CosmosDB. +This cmdlet will create a trigger for a collection in a Cosmos DB. ## EXAMPLES @@ -78,7 +78,7 @@ Create a new trigger called 'MyTrigger' in the collection 'MyNewCollection' that ### -Context -This is an object containing the context information of the CosmosDB database +This is an object containing the context information of the Cosmos DB database that will be deleted. It should be created by \`New-CosmosDbContext\`. ```yaml @@ -95,7 +95,7 @@ Accept wildcard characters: False ### -Account -The account name of the CosmosDB to access. +The account name of the Cosmos DB to access. ```yaml Type: String @@ -111,7 +111,7 @@ Accept wildcard characters: False ### -KeyType -The type of key that will be used to access ths CosmosDB. +The type of key that will be used to access ths Cosmos DB. ```yaml Type: String @@ -127,7 +127,7 @@ Accept wildcard characters: False ### -Key -The key to be used to access this CosmosDB. +The key to be used to access this Cosmos DB. ```yaml Type: SecureString @@ -143,7 +143,7 @@ Accept wildcard characters: False ### -Database -The name of the database to access in the CosmosDB account. +The name of the database to access in the Cosmos DB account. ```yaml Type: String diff --git a/docs/New-CosmosDbUser.md b/docs/New-CosmosDbUser.md index 1c758e90..35f216ab 100644 --- a/docs/New-CosmosDbUser.md +++ b/docs/New-CosmosDbUser.md @@ -9,7 +9,7 @@ schema: 2.0.0 ## SYNOPSIS -Create a new user in a CosmosDB database. +Create a new user in a Cosmos DB database. ## SYNTAX @@ -29,7 +29,7 @@ New-CosmosDbUser -Account [-Database ] [-Key ] [- ## DESCRIPTION -This cmdlet will create a user in a CosmosDB. +This cmdlet will create a user in a Cosmos DB. ## EXAMPLES @@ -45,10 +45,9 @@ Create a user 'Mary' in the database. ### -Context -This is an object containing the context information of -the CosmosDB database that will be deleted. -It should be created -by \`New-CosmosDbContext\`. +This is an object containing the context information of the Cosmos DB database +that will be deleted. +It should be created by \`New-CosmosDbContext\`. ```yaml Type: Context @@ -64,7 +63,7 @@ Accept wildcard characters: False ### -Account -The account name of the CosmosDB to access. +The account name of the Cosmos DB to access. ```yaml Type: String @@ -80,7 +79,7 @@ Accept wildcard characters: False ### -Database -The name of the database to access in the CosmosDB account. +The name of the database to access in the Cosmos DB account. ```yaml Type: String @@ -96,7 +95,7 @@ Accept wildcard characters: False ### -Key -The key to be used to access this CosmosDB. +The key to be used to access this Cosmos DB. ```yaml Type: SecureString @@ -112,7 +111,7 @@ Accept wildcard characters: False ### -KeyType -The type of key that will be used to access ths CosmosDB. +The type of key that will be used to access ths Cosmos DB. ```yaml Type: String diff --git a/docs/New-CosmosDbUserDefinedFunction.md b/docs/New-CosmosDbUserDefinedFunction.md index f004287b..1d1709c0 100644 --- a/docs/New-CosmosDbUserDefinedFunction.md +++ b/docs/New-CosmosDbUserDefinedFunction.md @@ -9,7 +9,7 @@ schema: 2.0.0 ## SYNOPSIS -Create a new user defined function for a collection in a CosmosDB database. +Create a new user defined function for a collection in a Cosmos DB database. ## SYNTAX @@ -31,7 +31,7 @@ New-CosmosDbUserDefinedFunction -Account [-KeyType ] [-Key [-Database ] [-Key [-Key ] [-KeyType [-Key ] [-KeyType New-CosmosDbDatabase -Context $cosmosDbContext -Id 'AnotherDatabase' ``` -Delete the database 'AnotherDatabase' the CosmosDB account. +Delete the database 'AnotherDatabase' the Cosmos DB account. ## PARAMETERS ### -Context -This is an object containing the context information of the CosmosDB database +This is an object containing the context information of the Cosmos DB database that will be deleted. It should be created by \`New-CosmosDbContext\`. ```yaml @@ -62,7 +62,7 @@ Accept wildcard characters: False ### -Account -The account name of the CosmosDB to access. +The account name of the Cosmos DB to access. ```yaml Type: String @@ -78,7 +78,7 @@ Accept wildcard characters: False ### -Key -The key to be used to access this CosmosDB. +The key to be used to access this Cosmos DB. ```yaml Type: SecureString @@ -94,7 +94,7 @@ Accept wildcard characters: False ### -KeyType -The type of key that will be used to access ths CosmosDB. +The type of key that will be used to access ths Cosmos DB. ```yaml Type: String diff --git a/docs/Remove-CosmosDbDocument.md b/docs/Remove-CosmosDbDocument.md index 5a45b73f..8208c672 100644 --- a/docs/Remove-CosmosDbDocument.md +++ b/docs/Remove-CosmosDbDocument.md @@ -9,7 +9,7 @@ schema: 2.0.0 ## SYNOPSIS -Delete a document from a CosmosDB collection. +Delete a document from a Cosmos DB collection. ## SYNTAX @@ -29,7 +29,7 @@ Remove-CosmosDbDocument -Account [-Database ] [-Key [-Database ] [-Key [-Database ] [-Key [-Database ] [-Key [-Database ] [-Key ] ## DESCRIPTION -This cmdlet will delete a user in a CosmosDB. +This cmdlet will delete a user in a Cosmos DB. ## EXAMPLES @@ -45,7 +45,7 @@ Delete the user 'Mary' from the database. ### -Context -This is an object containing the context information of the CosmosDB database +This is an object containing the context information of the Cosmos DB database that will be deleted. It should be created by \`New-CosmosDbContext\`. ```yaml @@ -62,7 +62,7 @@ Accept wildcard characters: False ### -Account -The account name of the CosmosDB to access. +The account name of the Cosmos DB to access. ```yaml Type: String @@ -78,7 +78,7 @@ Accept wildcard characters: False ### -Database -The name of the database to access in the CosmosDB account. +The name of the database to access in the Cosmos DB account. ```yaml Type: String @@ -94,7 +94,7 @@ Accept wildcard characters: False ### -Key -The key to be used to access this CosmosDB. +The key to be used to access this Cosmos DB. ```yaml Type: SecureString @@ -110,7 +110,7 @@ Accept wildcard characters: False ### -KeyType -The type of key that will be used to access ths CosmosDB. +The type of key that will be used to access ths Cosmos DB. ```yaml Type: String diff --git a/docs/Remove-CosmosDbUserDefinedFunction.md b/docs/Remove-CosmosDbUserDefinedFunction.md index 0bd63a85..bf692551 100644 --- a/docs/Remove-CosmosDbUserDefinedFunction.md +++ b/docs/Remove-CosmosDbUserDefinedFunction.md @@ -9,7 +9,7 @@ schema: 2.0.0 ## SYNOPSIS -Delete a user defined function from a CosmosDB collection. +Delete a user defined function from a Cosmos DB collection. ## SYNTAX @@ -29,7 +29,7 @@ Remove-CosmosDbUserDefinedFunction -Account [-Database ] [-Key ## DESCRIPTION -This cmdlet will delete a user defined function in a CosmosDB from a collection. +This cmdlet will delete a user defined function in a Cosmos DB from a collection. ## EXAMPLES @@ -45,7 +45,7 @@ Remove a user defined function 'udfTax' from a collection in the database. ### -Context -This is an object containing the context information of the CosmosDB database +This is an object containing the context information of the Cosmos DB database that will be deleted. It should be created by \`New-CosmosDbContext\`. ```yaml @@ -62,7 +62,7 @@ Accept wildcard characters: False ### -Account -The account name of the CosmosDB to access. +The account name of the Cosmos DB to access. ```yaml Type: String @@ -78,7 +78,7 @@ Accept wildcard characters: False ### -Database -The name of the database to access in the CosmosDB account. +The name of the database to access in the Cosmos DB account. ```yaml Type: String @@ -94,7 +94,7 @@ Accept wildcard characters: False ### -Key -The key to be used to access this CosmosDB. +The key to be used to access this Cosmos DB. ```yaml Type: SecureString @@ -110,7 +110,7 @@ Accept wildcard characters: False ### -KeyType -The type of key that will be used to access ths CosmosDB. +The type of key that will be used to access ths Cosmos DB. ```yaml Type: String diff --git a/docs/Set-CosmosDbAttachment.md b/docs/Set-CosmosDbAttachment.md index 93c259c3..06089396 100644 --- a/docs/Set-CosmosDbAttachment.md +++ b/docs/Set-CosmosDbAttachment.md @@ -9,7 +9,7 @@ schema: 2.0.0 ## SYNOPSIS -Update am attachment for a CosmosDB document. +Update am attachment for a Cosmos DB document. ## SYNTAX @@ -31,7 +31,7 @@ Set-CosmosDbAttachment -Account [-Database ] [-Key [-Key ] [-KeyType [-Database ] [-Key ## DESCRIPTION -This cmdlet will update an existing document in a CosmosDB collection. +This cmdlet will update an existing document in a Cosmos DB collection. ## EXAMPLES @@ -54,7 +54,7 @@ Replace the content of a document in a collection in the database. ### -Context -This is an object containing the context information of the CosmosDB database +This is an object containing the context information of the Cosmos DB database that will be deleted. It should be created by \`New-CosmosDbContext\`. ```yaml @@ -70,7 +70,7 @@ Accept wildcard characters: False ``` ### -Account -The account name of the CosmosDB to access. +The account name of the Cosmos DB to access. ```yaml Type: String @@ -85,7 +85,7 @@ Accept wildcard characters: False ``` ### -Database -The name of the database to access in the CosmosDB account. +The name of the database to access in the Cosmos DB account. ```yaml Type: String @@ -100,7 +100,7 @@ Accept wildcard characters: False ``` ### -Key -The key to be used to access this CosmosDB. +The key to be used to access this Cosmos DB. ```yaml Type: SecureString @@ -115,7 +115,7 @@ Accept wildcard characters: False ``` ### -KeyType -The type of key that will be used to access ths CosmosDB. +The type of key that will be used to access ths Cosmos DB. ```yaml Type: String diff --git a/docs/Set-CosmosDbOffer.md b/docs/Set-CosmosDbOffer.md index 3e58c0af..eb00805d 100644 --- a/docs/Set-CosmosDbOffer.md +++ b/docs/Set-CosmosDbOffer.md @@ -9,7 +9,7 @@ schema: 2.0.0 ## SYNOPSIS -Update an existing offer in a CosmosDB database. +Update an existing offer in a Cosmos DB database. ## SYNTAX @@ -31,7 +31,7 @@ Set-CosmosDbOffer -Account [-Database ] [-Key ] [ ## DESCRIPTION -This cmdlet will update an offer resource in CosmosDB. +This cmdlet will update an offer resource in Cosmos DB. ## EXAMPLES @@ -47,7 +47,7 @@ Update an existing V2 offer with the Id 'lyiu' to set a different throughput. ### -Context -This is an object containing the context information of the CosmosDB database +This is an object containing the context information of the Cosmos DB database that will be deleted. It should be created by \`New-CosmosDbContext\`. ```yaml @@ -64,7 +64,7 @@ Accept wildcard characters: False ### -Account -The account name of the CosmosDB to access. +The account name of the Cosmos DB to access. ```yaml Type: String @@ -80,7 +80,7 @@ Accept wildcard characters: False ### -Key -The key to be used to access this CosmosDB. +The key to be used to access this Cosmos DB. ```yaml Type: SecureString @@ -96,7 +96,7 @@ Accept wildcard characters: False ### -KeyType -The type of key that will be used to access ths CosmosDB. +The type of key that will be used to access ths Cosmos DB. ```yaml Type: String diff --git a/docs/Set-CosmosDbStoredProcedure.md b/docs/Set-CosmosDbStoredProcedure.md index 94c63be9..777e47ce 100644 --- a/docs/Set-CosmosDbStoredProcedure.md +++ b/docs/Set-CosmosDbStoredProcedure.md @@ -9,7 +9,7 @@ schema: 2.0.0 ## SYNOPSIS -Update a stored procedure from a CosmosDB collection. +Update a stored procedure from a Cosmos DB collection. ## SYNTAX @@ -29,7 +29,7 @@ Set-CosmosDbStoredProcedure -Account [-Database ] [-Key [-Database ] [-Key ] ## DESCRIPTION -This cmdlet will update an existing trigger in a CosmosDB +This cmdlet will update an existing trigger in a Cosmos DB collection. ## EXAMPLES @@ -79,7 +79,7 @@ all operations. ### -Context -This is an object containing the context information of the CosmosDB database +This is an object containing the context information of the Cosmos DB database that will be deleted. It should be created by \`New-CosmosDbContext\`. ```yaml @@ -96,7 +96,7 @@ Accept wildcard characters: False ### -Account -The account name of the CosmosDB to access. +The account name of the Cosmos DB to access. ```yaml Type: String @@ -112,7 +112,7 @@ Accept wildcard characters: False ### -Database -The name of the database to access in the CosmosDB account. +The name of the database to access in the Cosmos DB account. ```yaml Type: String @@ -128,7 +128,7 @@ Accept wildcard characters: False ### -Key -The key to be used to access this CosmosDB. +The key to be used to access this Cosmos DB. ```yaml Type: SecureString @@ -144,7 +144,7 @@ Accept wildcard characters: False ### -KeyType -The type of key that will be used to access ths CosmosDB. +The type of key that will be used to access ths Cosmos DB. ```yaml Type: String diff --git a/docs/Set-CosmosDbUser.md b/docs/Set-CosmosDbUser.md index 6b6a52d2..ba3a17de 100644 --- a/docs/Set-CosmosDbUser.md +++ b/docs/Set-CosmosDbUser.md @@ -9,7 +9,7 @@ schema: 2.0.0 ## SYNOPSIS -Set the user Id of an existing user in a CosmosDB database. +Set the user Id of an existing user in a Cosmos DB database. ## SYNTAX @@ -30,7 +30,7 @@ Set-CosmosDbUser -Account [-Database ] [-Key ] [- ## DESCRIPTION This cmdlet will set the user Id of an existing user in -a CosmosDB. +a Cosmos DB. ## EXAMPLES @@ -46,7 +46,7 @@ Rename the user 'Mary' to 'Sam' in the database. ### -Context -This is an object containing the context information of the CosmosDB database +This is an object containing the context information of the Cosmos DB database that will be deleted. It should be created by \`New-CosmosDbContext\`. ```yaml @@ -63,7 +63,7 @@ Accept wildcard characters: False ### -Account -The account name of the CosmosDB to access. +The account name of the Cosmos DB to access. ```yaml Type: String @@ -79,7 +79,7 @@ Accept wildcard characters: False ### -Database -The name of the database to access in the CosmosDB account. +The name of the database to access in the Cosmos DB account. ```yaml Type: String @@ -95,7 +95,7 @@ Accept wildcard characters: False ### -Key -The key to be used to access this CosmosDB. +The key to be used to access this Cosmos DB. ```yaml Type: SecureString @@ -111,7 +111,7 @@ Accept wildcard characters: False ### -KeyType -The type of key that will be used to access ths CosmosDB. +The type of key that will be used to access ths Cosmos DB. ```yaml Type: String diff --git a/docs/Set-CosmosDbUserDefinedFunction.md b/docs/Set-CosmosDbUserDefinedFunction.md index d0cb2cf3..c63e35ad 100644 --- a/docs/Set-CosmosDbUserDefinedFunction.md +++ b/docs/Set-CosmosDbUserDefinedFunction.md @@ -9,7 +9,7 @@ schema: 2.0.0 ## SYNOPSIS -Update a user defined function from a CosmosDB collection. +Update a user defined function from a Cosmos DB collection. ## SYNTAX @@ -29,7 +29,7 @@ Set-CosmosDbUserDefinedFunction -Account [-Database ] [-Key