az cosmosdb keys

Note

Grup perintah ini memiliki perintah yang ditentukan dalam Azure CLI dan setidaknya satu ekstensi. Instal setiap ekstensi untuk mendapatkan manfaat dari kemampuannya yang diperluas. Pelajari selengkapnya tentang ekstensi.

Mengelola kunci Azure Cosmos DB.

Perintah

Nama Deskripsi Jenis Status
az cosmosdb keys list

Cantumkan kunci akses atau string koneksi untuk akun database Azure Cosmos DB.

Core GA
az cosmosdb keys regenerate

Meregenerasi kunci akses untuk akun database Azure Cosmos DB.

Core GA
az cosmosdb keys regenerate (cosmosdb-preview extension)

Meregenerasi kunci akses untuk akun database Azure Cosmos DB.

Extension GA

az cosmosdb keys list

Cantumkan kunci akses atau string koneksi untuk akun database Azure Cosmos DB.

az cosmosdb keys list --name
                      --resource-group
                      [--type {connection-strings, keys, read-only-keys}]

Contoh

Cantumkan kunci akses atau string koneksi untuk akun database Azure Cosmos DB. (autogenerated)

az cosmosdb keys list --name MyCosmosDBDatabaseAccount --resource-group MyResourceGroup --subscription MySubscription --type keys

Parameter yang Diperlukan

--name -n

Nama akun Cosmosdb.

--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

Parameter Opsional

Parameter berikut bersifat opsional, tetapi tergantung pada konteksnya, satu atau beberapa mungkin menjadi diperlukan agar perintah berhasil dijalankan.

--type

Jenis kunci akun.

Properti Nilai
Nilai default: keys
Nilai yang diterima: connection-strings, keys, read-only-keys
Parameter Global
--debug

Tingkatkan verbositas pengelogan untuk menampilkan semua log debug.

Properti Nilai
Nilai default: False
--help -h

Tampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya tampilkan kesalahan, menekan peringatan.

Properti Nilai
Nilai default: False
--output -o

Format output.

Properti Nilai
Nilai default: json
Nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi dan contoh selengkapnya.

--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

--verbose

Tingkatkan verbositas pengelogan. Gunakan --debug untuk log debug penuh.

Properti Nilai
Nilai default: False

az cosmosdb keys regenerate

Meregenerasi kunci akses untuk akun database Azure Cosmos DB.

az cosmosdb keys regenerate --key-kind {primary, primaryReadonly, secondary, secondaryReadonly}
                            [--acquire-policy-token]
                            [--change-reference]
                            [--ids]
                            [--name]
                            [--resource-group]
                            [--subscription]

Contoh

Regenerasi kunci akses primaryReadonly untuk akun database Azure Cosmos DB.

az cosmosdb keys regenerate --key-kind primaryReadonly --name MyCosmosDBDatabaseAccount --resource-group MyResourceGroup --subscription MySubscription

Parameter yang Diperlukan

--key-kind

Kunci akses untuk meregenerasi.

Properti Nilai
Nilai yang diterima: primary, primaryReadonly, secondary, secondaryReadonly

Parameter Opsional

Parameter berikut bersifat opsional, tetapi tergantung pada konteksnya, satu atau beberapa mungkin menjadi diperlukan agar perintah berhasil dijalankan.

--acquire-policy-token

Memperoleh token Azure Policy secara otomatis untuk operasi sumber daya ini.

Properti Nilai
Grup parameter: Global Policy Arguments
--change-reference

ID referensi perubahan terkait untuk operasi sumber daya ini.

Properti Nilai
Grup parameter: Global Policy Arguments
--ids

Satu atau beberapa ID sumber daya (dibatasi spasi). Ini harus menjadi ID sumber daya lengkap yang berisi semua informasi argumen 'Id Sumber Daya'. Anda harus menyediakan argumen --ids atau 'Resource Id' lainnya.

Properti Nilai
Grup parameter: Resource Id Arguments
--name -n

Nama akun database Cosmos DB.

Properti Nilai
Grup parameter: Resource Id Arguments
--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

Properti Nilai
Grup parameter: Resource Id Arguments
--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

Properti Nilai
Grup parameter: Resource Id Arguments
Parameter Global
--debug

Tingkatkan verbositas pengelogan untuk menampilkan semua log debug.

Properti Nilai
Nilai default: False
--help -h

Tampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya tampilkan kesalahan, menekan peringatan.

Properti Nilai
Nilai default: False
--output -o

Format output.

Properti Nilai
Nilai default: json
Nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi dan contoh selengkapnya.

--verbose

Tingkatkan verbositas pengelogan. Gunakan --debug untuk log debug penuh.

Properti Nilai
Nilai default: False

az cosmosdb keys regenerate (cosmosdb-preview extension)

Meregenerasi kunci akses untuk akun database Azure Cosmos DB.

az cosmosdb keys regenerate --key-kind {primary, primaryReadonly, secondary, secondaryReadonly}
                            [--acquire-policy-token]
                            [--change-reference]
                            [--ids]
                            [--name]
                            [--resource-group]
                            [--skip-safe-rotation {false, true}]
                            [--subscription]

Contoh

Meregenerasi kunci akses untuk akun database Azure Cosmos DB.

az cosmosdb keys regenerate --resource-group MyResourceGroup --name MyAccount --key-kind primary

Meregenerasi kunci akses, melewati pemeriksaan penggunaan terakhir kunci akun.

az cosmosdb keys regenerate --resource-group MyResourceGroup --name MyAccount --key-kind primary --skip-safe-rotation true

Parameter yang Diperlukan

--key-kind

Kunci akses untuk meregenerasi.

Properti Nilai
Nilai yang diterima: primary, primaryReadonly, secondary, secondaryReadonly

Parameter Opsional

Parameter berikut bersifat opsional, tetapi tergantung pada konteksnya, satu atau beberapa mungkin menjadi diperlukan agar perintah berhasil dijalankan.

--acquire-policy-token

Memperoleh token Azure Policy secara otomatis untuk operasi sumber daya ini.

Properti Nilai
Grup parameter: Global Policy Arguments
--change-reference

ID referensi perubahan terkait untuk operasi sumber daya ini.

Properti Nilai
Grup parameter: Global Policy Arguments
--ids

Satu atau beberapa ID sumber daya (dibatasi spasi). Ini harus menjadi ID sumber daya lengkap yang berisi semua informasi argumen 'Id Sumber Daya'. Anda harus menyediakan argumen --ids atau 'Resource Id' lainnya.

Properti Nilai
Grup parameter: Resource Id Arguments
--name -n

Nama akun database Cosmos DB.

Properti Nilai
Grup parameter: Resource Id Arguments
--resource-group -g

Nama grup sumber daya. Anda dapat mengonfigurasi grup default menggunakan az configure --defaults group=<name>.

Properti Nilai
Grup parameter: Resource Id Arguments
--skip-safe-rotation
Pratinjau

Lewati pemeriksaan penggunaan terakhir kunci akun yang memblokir regenerasi kunci saat kunci baru-baru ini digunakan.

Properti Nilai
Nilai yang diterima: false, true
--subscription

Nama atau ID langganan. Anda dapat mengonfigurasi langganan default menggunakan az account set -s NAME_OR_ID.

Properti Nilai
Grup parameter: Resource Id Arguments
Parameter Global
--debug

Tingkatkan verbositas pengelogan untuk menampilkan semua log debug.

Properti Nilai
Nilai default: False
--help -h

Tampilkan pesan bantuan ini dan keluar.

--only-show-errors

Hanya tampilkan kesalahan, menekan peringatan.

Properti Nilai
Nilai default: False
--output -o

Format output.

Properti Nilai
Nilai default: json
Nilai yang diterima: json, jsonc, none, table, tsv, yaml, yamlc
--query

String kueri JMESPath. Lihat http://jmespath.org/ untuk informasi dan contoh selengkapnya.

--verbose

Tingkatkan verbositas pengelogan. Gunakan --debug untuk log debug penuh.

Properti Nilai
Nilai default: False