Configuration Stores - List Keys

指定した構成ストアのアクセス キーを一覧表示します。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/listKeys?api-version=2023-03-01
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/listKeys?api-version=2023-03-01&$skipToken={$skipToken}

URI パラメーター

名前 / 必須 説明
configStoreName
path True

string

構成ストアの名前。

Regex pattern: ^[a-zA-Z0-9_-]*$

resourceGroupName
path True

string

コンテナー レジストリが属するリソース グループの名前。

subscriptionId
path True

string

Microsoft Azure サブスクリプション ID。

api-version
query True

string

クライアント API のバージョン。

$skipToken
query

string

スキップ トークンは、操作によって部分的な結果が返された後もアイテムの取得を続行するために使用されます。 前の応答に nextLink 要素が含まれている場合、nextLink 要素の値には、後続の呼び出しに使用する開始点を指定する skipToken パラメーターが含まれます。

応答

名前 説明
200 OK

ApiKeyListResult

要求は成功しました。要求は整形式であり、適切に受信されました。

Other Status Codes

ErrorResponse

操作に失敗した理由を説明するエラー応答

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名前 説明
user_impersonation ユーザー アカウントの借用

ConfigurationStores_ListKeys

Sample Request

POST https://management.azure.com/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso/listKeys?api-version=2023-03-01

Sample Response

{
  "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
    }
  ]
}

定義

名前 説明
ApiKey

構成ストア エンドポイントを使用した認証に使用される API キー。

ApiKeyListResult

API キーを一覧表示する要求の結果。

ErrorAdditionalInfo

リソース管理エラーの追加情報。

ErrorDetails

エラーの詳細。

ErrorResponse

エラー応答は、サービスが受信要求を処理できないことを示します。 理由は、エラー メッセージに表示されます。

ApiKey

構成ストア エンドポイントを使用した認証に使用される API キー。

名前 説明
connectionString

string

認証のためにクライアントをサポートすることによって使用できる接続文字列。

id

string

キー ID。

lastModified

string

キーのプロパティのいずれかが最後に変更された時刻。

name

string

使用法を説明するキーの名前。

readOnly

boolean

このキーを読み取り操作にのみ使用できるかどうか。

value

string

認証目的で使用されるキーの値。

ApiKeyListResult

API キーを一覧表示する要求の結果。

名前 説明
nextLink

string

ページングされた結果の次のセットを要求するために使用できる URI。

value

ApiKey[]

コレクション値。

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前 説明
info

object

追加情報。

type

string

追加情報の種類。

ErrorDetails

エラーの詳細。

名前 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。

code

string

エラー コード。

message

string

操作が失敗した理由を示すエラー メッセージ。

ErrorResponse

エラー応答は、サービスが受信要求を処理できないことを示します。 理由は、エラー メッセージに表示されます。

名前 説明
error

ErrorDetails

エラーの詳細。