Get-AzCosmosDBAccountKey

リファレンス

モジュール:: Az.CosmosDB

指定された CosmosDB アカウントのキー{"ConnectionKeys"、"PrimaryReadOnly"、または "Keys"} を取得します。

構文

Get-AzCosmosDBAccountKey
   -ResourceGroupName <String>
   -Name <String>
   [-Type <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzCosmosDBAccountKey
   [-Type <String>]
   -ResourceId <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzCosmosDBAccountKey
   [-Type <String>]
   -InputObject <PSDatabaseAccountGetResults>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

説明

接続キーの一覧を取得します。

例

例 1

Get-AzCosmosDBAccountKey -ResourceGroupName rg1 -Name dbname -Type "ReadOnlyKeys"

Name                           Value
----                           -----
PrimaryReadonlyMasterKey       ********************************
SecondaryReadonlyMasterKey     ********************************

CosmosDB アカウントのキーを一覧表示します。キーの種類には、ConnectionStrings、Keys、ReadOnlyKeys の値を指定できます。既定値は [キー] です。

パラメーター

-DefaultProfile

Azure との通信のために使用される資格情報、アカウント、テナント、サブスクリプションです。

型:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-InputObject

CosmosDB アカウントオブジェクト

型:	PSDatabaseAccountGetResults
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-Name

Cosmos DB データベースアカウントの名前。

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ResourceGroupName

リソースグループの名前。

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ResourceId

リソースの ResourceId。

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Type

値の由来: {ConnectionStrings、Keys、ReadOnlyKeys}。既定値は [キー] です。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

入力

None

出力

Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountListConnectionStrings

Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountListKeysResult

Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountListReadOnlyKeysResult

次の方法で共有