String koneksi dan operasi kunci untuk akun Azure Cosmos DB menggunakan PowerShell

BERLAKU UNTUK: SQL API Cassandra API Gremlin API Table API Azure Cosmos DB API untuk MongoDB

Catatan

Artikel ini menggunakan modul Azure Az PowerShell, yang merupakan modul PowerShell yang direkomendasikan untuk berinteraksi dengan Azure. Untuk mulai menggunakan modul Az PowerShell, lihat Menginstal Azure PowerShell. Untuk mempelajari cara bermigrasi ke modul Az PowerShell, lihat Memigrasikan Azure PowerShell dari AzureRM ke Az.

Sampel ini memerlukan Azure PowerShell Az 5.4.0 atau yang lebih baru. Jalankan Get-Module -ListAvailable Az untuk melihat versi mana yang dipasang. Jika Anda ingin memasangnya, lihat modul Memasang Azure PowerShell.

Jalankan Connect-AzAccount untuk masuk ke Azure.

Sampel skrip

Catatan

Sampel ini menjelaskan menggunakan akun API SQL. Untuk menggunakan sampel ini di API lain, salin properti terkait dan terapkan ke skrip khusus API Anda

# 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

Membersihkan penyebaran

Setelah sampel skrip dijalankan, perintah berikut dapat digunakan untuk menghapus grup sumber daya dan semua sumber daya yang terkait.

Remove-AzResourceGroup -ResourceGroupName "myResourceGroup"

Penjelasan skrip

Skrip ini menggunakan perintah berikut. Setiap perintah dalam tabel ditautkan ke dokumentasi spesifik perintah.

Perintah Catatan
Azure Cosmos DB
Get-AzCosmosDBAccountKey Mendapatkan string koneksi atau kunci (baca-tulis atau baca-saja) untuk Akun Cosmos DB.
New-AzCosmosDBAccountKey Membuat ulang kunci yang ditentukan untuk Akun Cosmos DB.
Grup Sumber Daya Azure
Remove-AzResourceGroup Menghapus grup sumber daya termasuk semua sumber daya berlapis.

Langkah berikutnya

Untuk informasi selengkapnya tentang Azure PowerShell, lihat dokumentasi Azure PowerShell.