Get the connection strings for a Cosmos DB account in Azure.

Get-CosmosDbAccountConnectionString [-Name] <String> [-ResourceGroupName] <String>
 [-MasterKeyType <String>] [<CommonParameters>]

This will return the connection strings for using to connect to an existing Cosmos DB account in Azure.

PS C:\> Get-CosmosDbAccountConnectionString -Name 'MyCosmosDBAccount' -ResourceGroupName 'MyResourceGroup'

Return the primary SQL connection string for a Cosmos DB account named 'MyCosmosDBAccount' in the resource group 'MyResourceGroup'.

PS C:\> Get-CosmosDbAccountConnectionString -Name 'MyCosmosDBAccount' -ResourceGroupName 'MyResourceGroup' -MasterKeyType 'SecondaryReadonlyMasterKey'

Return the secondary read-only SQL connection string connection string for a Cosmos DB account named 'MyCosmosDBAccount' in the resource group 'MyResourceGroup'.

The name of the Cosmos DB account to return the connection strings for.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

The resource group containing the Cosmos DB account.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

The master key type to return in the connection string.

Type: String
Parameter Sets: (All)
Aliases:
Accepted values: PrimaryMasterKey, SecondaryMasterKey, PrimaryReadonlyMasterKey, SecondaryReadonlyMasterKey

Required: False
Position: Named
Default value: PrimaryMasterKey
Accept pipeline input: False
Accept wildcard characters: False

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).