Připojovací řetězec a operace klíčů účtu pro účet Azure Cosmos DB s využitím PowerShellu

platí pro: SQL api rozhraní API Cassandra Gremlin api rozhraní API pro tabulky Azure Cosmos DB api pro MongoDB

Poznámka

Tento článek používá modul Azure Az PowerShell, což je doporučený modul PowerShellu pro interakci s Azure. Pokud chcete začít s modulem Az PowerShell, projděte si téma věnované instalaci Azure PowerShellu. Informace o tom, jak migrovat na modul Az PowerShell, najdete v tématu Migrace Azure PowerShellu z AzureRM na Az.

Tato ukázka vyžaduje Azure PowerShell az 5.4.0 nebo novější. Spusťte Get-Module -ListAvailable Az , chcete-li zjistit, které verze jsou nainstalovány. Pokud potřebujete instalaci, přečtěte si téma Instalace modulu Azure PowerShell.

Spusťte Connect-AzAccount a přihlaste se k Azure.

Ukázkový skript

Poznámka

Tato ukázka demonstruje použití účtu rozhraní SQL API. Pokud chcete tuto ukázku použít pro jiná rozhraní API, zkopírujte související vlastnosti a aplikujte je na skript specifický pro rozhraní 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

Vyčištění nasazení

Po spuštění ukázkového skriptu můžete pomocí následujícího příkazu odebrat skupinu prostředků a všechny k ní přidružené prostředky.

Remove-AzResourceGroup -ResourceGroupName "myResourceGroup"

Vysvětlení skriptu

Tento skript používá následující příkazy. Každý příkaz v tabulce odkazuje na příslušnou část dokumentace.

Příkaz Poznámky
Azure Cosmos DB
Get-AzCosmosDBAccountKey Získá připojovací řetězec nebo klíč (jen pro čtení a zápis) pro účet Cosmos DB.
New-AzCosmosDBAccountKey Znovu vygenerujte zadaný klíč pro účet Cosmos DB.
Skupiny prostředků Azure
Remove-AzResourceGroup Odstraní skupinu prostředků včetně všech vnořených prostředků.

Další kroky

Další informace o Azure PowerShellu najdete v dokumentaci k Azure PowerShellu.