Операции со строкой подключения и ключом для учетной записи Azure Cosmos с использованием PowerShell
ПРИМЕНИМО К: Nosql Mongodb Кассандра Гремлин Таблица
Примечание
Для взаимодействия с Azure рекомендуется использовать модуль Azure Az PowerShell. Чтобы начать работу, см. статью Установка Azure PowerShell. Дополнительные сведения см. в статье Перенос Azure PowerShell с AzureRM на Az.
Для работы с этим примером требуется модуль Az PowerShell версии 5.4.0 или более поздней. Запустите Get-Module -ListAvailable Az
для просмотра установленных версий.
Если необходимо выполнить установку, см. статью об установке модуля Azure PowerShell.
Запустите Connect AzAccount для входа Azure.
Пример скрипта
Примечание
В этом примере показано использование учетной записи API для NoSQL. Чтобы использовать этот пример с другими API, соответствующие свойства необходимо скопировать в скрипт для такого API.
# Reference: Az.CosmosDB | https://docs.microsoft.com/powershell/module/az.cosmosdb
# --------------------------------------------------
# Purpose
# List an account's connection strings and keys; regenerate a key.
# --------------------------------------------------
# Variables - ***** SUBSTITUTE YOUR VALUES *****
$resourceGroupName = "myResourceGroup" # Resource Group must already exist
$accountName = "myaccount" # Must be all lower case
$keyKind = "primary" # Other key kinds: secondary, primaryReadonly, secondaryReadonly
# --------------------------------------------------
Write-Host "List connection strings"
Get-AzCosmosDBAccountKey -ResourceGroupName $resourceGroupName `
-Name $accountName -Type "ConnectionStrings"
Write-Host "List keys"
Get-AzCosmosDBAccountKey -ResourceGroupName $resourceGroupName `
-Name $accountName -Type "Keys"
Write-Host "Reset key"
New-AzCosmosDBAccountKey -ResourceGroupName $resourceGroupName `
-Name $accountName -KeyKind $keyKind
Очистка развертывания
После выполнения примера сценария можно удалить группу ресурсов и все связанные с ней ресурсы, выполнив следующую команду.
Remove-AzResourceGroup -ResourceGroupName "myResourceGroup"
Описание скрипта
Этот скрипт использует следующие команды. Для каждой команды в таблице приведены ссылки на соответствующую документацию.
Get-Help | Примечания |
---|---|
Azure Cosmos DB | |
Get-AzCosmosDBAccountKey | Возвращает строку подключения или ключ (для чтения и записи или только для чтения) для учетной записи Azure Cosmos DB. |
New-AzCosmosDBAccountKey | Повторно создайте указанный ключ для учетной записи Azure Cosmos DB. |
Группы ресурсов Azure | |
Remove-AzResourceGroup | Удаляет группу ресурсов со всеми вложенными ресурсами. |
Дальнейшие действия
Дополнительные сведения о Azure PowerShell см. в документации по Azure PowerShell.