Accounts - List Keys

指定した Cognitive Services アカウントのアカウント キーをListsします。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/listKeys?api-version=2023-05-01

URI パラメーター

名前 / 必須 説明
accountName
path True

string

Cognitive Services アカウントの名前。

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

resourceGroupName
path True

string

リソース グループの名前。 名前の大文字と小文字は区別されます。

subscriptionId
path True

string

ターゲット サブスクリプションの ID。

api-version
query True

string

この操作に使用する API バージョン。

応答

名前 説明
200 OK

ApiKeys

リソースのサブスクリプション キーを含む応答本文を返します。 key1 クライアントが API エンドポイントを呼び出すときの認証用の最初の API キー。

key2 クライアントが API エンドポイントを呼び出すときの認証用の 2 番目の API キー。

Other Status Codes

ErrorResponse

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

List Keys

Sample Request

POST https://management.azure.com/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.CognitiveServices/accounts/myAccount/listKeys?api-version=2023-05-01

Sample Response

{
  "key1": "KEY1",
  "key2": "KEY2"
}

定義

名前 説明
ApiKeys

コグニティブ サービス アカウントのアクセス キー。

ErrorAdditionalInfo

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

ErrorDetail

エラーの詳細。

ErrorResponse

エラー応答

ApiKeys

コグニティブ サービス アカウントのアクセス キー。

名前 説明
key1

string

キー 1 の値を取得します。

key2

string

キー 2 の値を取得します。

ErrorAdditionalInfo

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

名前 説明
info

object

追加情報。

type

string

追加情報の種類。

ErrorDetail

エラーの詳細。

名前 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。

code

string

エラー コード。

details

ErrorDetail[]

エラーの詳細です。

message

string

エラー メッセージ。

target

string

エラーのターゲット。

ErrorResponse

エラー応答

名前 説明
error

ErrorDetail

error オブジェクト。