Get-AzCosmosDBAccountKey
指定された CosmosDB アカウントのキー{"ConnectionKeys"、"PrimaryReadOnly"、または "Keys"} を取得します。
構文
ByNameParameterSet (既定)
Get-AzCosmosDBAccountKey
-ResourceGroupName <String>
-Name <String>
[-Type <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
ByResourceIdParameterSet
Get-AzCosmosDBAccountKey
-ResourceId <String>
[-Type <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
ByObjectParameterSet
Get-AzCosmosDBAccountKey
-InputObject <PSDatabaseAccountGetResults>
[-Type <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
説明
例
例 1
Get-AzCosmosDBAccountKey -ResourceGroupName rg1 -Name dbname -Type "ReadOnlyKeys"
Name Value
---- -----
PrimaryReadonlyMasterKey ********************************
SecondaryReadonlyMasterKey ********************************
CosmosDB アカウントのキーを一覧表示します。 キーの種類には、ConnectionStrings、Keys、ReadOnlyKeys の値を指定できます。 既定値は [キー] です。
パラメーター
-DefaultProfile
Azureとの通信に使用される資格情報、アカウント、テナント、サブスクリプション。
パラメーターのプロパティ
| 型: | IAzureContextContainer
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CosmosDB アカウント オブジェクト
ByObjectParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Name
Cosmos DB データベース アカウントの名前。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
ByNameParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ResourceGroupName
リソース グループの名前。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
ByNameParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ResourceId
リソースの ResourceId。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
ByResourceIdParameterSet
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Type
値の由来: {ConnectionStrings、Keys、ReadOnlyKeys}。
既定値は [キー] です。
パラメーターのプロパティ
| 型: | String
|
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。
None
出力
Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountListConnectionStrings
Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountListKeysResult
Microsoft.Azure.Commands.CosmosDB.Models.PSDatabaseAccountListReadOnlyKeysResult