Configuration Stores - List Keys
指定した構成ストアのアクセス キーを一覧表示します。
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/listKeys?api-version=2024-06-01
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/listKeys?api-version=2024-06-01&$skipToken={$skipToken}
URI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
config
|
path | True |
string minLength: 5maxLength: 50 pattern: ^[a-zA-Z0-9_-]*$ |
構成ストアの名前。 |
|
resource
|
path | True |
string |
コンテナー レジストリが属するリソース グループの名前。 |
|
subscription
|
path | True |
string |
Microsoft Azure サブスクリプション ID。 |
|
api-version
|
query | True |
string |
クライアント API のバージョン。 |
|
$skip
|
query |
string |
スキップ トークンは、操作が部分的な結果を返した後もアイテムの取得を続行するために使用されます。 前の応答に nextLink 要素が含まれている場合、nextLink 要素の値には、後続の呼び出しに使用する開始点を指定する skipToken パラメーターが含まれます。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK |
要求が成功しました。要求は整形式であり、適切に受信されました。 |
|
| Other Status Codes |
操作に失敗した理由を説明するエラー応答 |
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
| 名前 | 説明 |
|---|---|
| user_impersonation | ユーザー アカウントを偽装する |
例
ConfigurationStores_ListKeys
要求のサンプル
POST https://management.azure.com/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso/listKeys?api-version=2024-06-01
応答のサンプル
{
"value": [
{
"id": "439AD01B4BE67DB1",
"name": "Primary",
"value": "000000000000000000000000000000000000000000000000000000",
"connectionString": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"lastModified": "2018-04-24T16:30:54+00:00",
"readOnly": false
},
{
"id": "CB45E100456857B9",
"name": "Secondary",
"value": "000000000000000000000000000000000000000000000000000000",
"connectionString": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"lastModified": "2018-04-24T16:30:54+00:00",
"readOnly": false
},
{
"id": "B3AC55B7E71431A9",
"name": "Primary Read Only",
"value": "000000000000000000000000000000000000000000000000000000",
"connectionString": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"lastModified": "2018-04-24T16:30:54+00:00",
"readOnly": true
},
{
"id": "E2AF6A9A89DCC177",
"name": "Secondary Read Only",
"value": "000000000000000000000000000000000000000000000000000000",
"connectionString": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"lastModified": "2018-04-24T16:30:54+00:00",
"readOnly": true
}
]
}
定義
| 名前 | 説明 |
|---|---|
|
Api |
構成ストア エンドポイントでの認証に使用される API キー。 |
|
Api |
API キーを一覧表示する要求の結果。 |
|
Error |
リソース管理エラーの追加情報。 |
|
Error |
エラーの詳細。 |
|
Error |
エラー応答は、サービスが受信要求を処理できないことを示します。 エラー メッセージに理由が示されます。 |
ApiKey
構成ストア エンドポイントでの認証に使用される API キー。
| 名前 | 型 | 説明 |
|---|---|---|
| connectionString |
string |
認証にクライアントをサポートすることで使用できる接続文字列。 |
| id |
string |
キー ID。 |
| lastModified |
string (date-time) |
キーのプロパティのいずれかが最後に変更された時刻。 |
| name |
string |
使用法を説明するキーの名前。 |
| readOnly |
boolean |
このキーを読み取り操作にのみ使用できるかどうか。 |
| value |
string |
認証目的で使用されるキーの値。 |
ApiKeyListResult
API キーを一覧表示する要求の結果。
| 名前 | 型 | 説明 |
|---|---|---|
| nextLink |
string |
ページングされた結果の次のセットを要求するために使用できる URI。 |
| value |
Api |
コレクション値。 |
ErrorAdditionalInfo
リソース管理エラーの追加情報。
| 名前 | 型 | 説明 |
|---|---|---|
| info |
object |
追加情報。 |
| type |
string |
追加情報の種類。 |
ErrorDetails
エラーの詳細。
| 名前 | 型 | 説明 |
|---|---|---|
| additionalInfo |
エラーの追加情報。 |
|
| code |
string |
エラー コード。 |
| message |
string |
操作が失敗した理由を示すエラー メッセージ。 |
ErrorResponse
エラー応答は、サービスが受信要求を処理できないことを示します。 エラー メッセージに理由が示されます。
| 名前 | 型 | 説明 |
|---|---|---|
| error |
エラーの詳細。 |