Tenant Access - List Secrets

サービス:

API Management

API バージョン:

2024-05-01

テナント アクセス情報の詳細を取得します。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/{accessName}/listSecrets?api-version=2024-05-01

URI パラメーター

名前	/	必須	型	説明
accessName	path	True	AccessIdName	Access 構成の識別子。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソース グループの名前。 名前では大文字と小文字が区別されません。
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	API Management サービスの名前。
subscriptionId	path	True	string (uuid)	ターゲット サブスクリプションの ID。 値は UUID である必要があります。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	AccessInformationSecretsContract	テナント アクセス情報。 ヘッダー ETag: string
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントを偽装する

例

ApiManagementListSecretsTenantAccess

要求のサンプル

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/access/listSecrets?api-version=2024-05-01

応答のサンプル

状態コード:

200

{
  "id": "5600b59375ff190048030003",
  "primaryKey": "<primaryKey>",
  "secondaryKey": "<secondaryKey>",
  "enabled": true
}

定義

名前	説明
AccessIdName	Access 構成の識別子。
AccessInformationSecretsContract	API Management サービスのテナント アクセス情報コントラクト。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答

AccessIdName

列挙

Access 構成の識別子。

値	説明
access
gitAccess

AccessInformationSecretsContract

Object

API Management サービスのテナント アクセス情報コントラクト。

名前	型	説明
enabled	boolean	直接アクセスが有効かどうかを判断します。
id	string	アクセス情報の種類 ('access' または 'gitAccess')
primaryKey	string	プライマリ アクセス キー。 このプロパティは'GET' 操作では入力されません。 値を取得するには、'/listSecrets' POST 要求を使用します。
principalId	string	プリンシパル (ユーザー) 識別子。
secondaryKey	string	セカンダリ アクセス キー。 このプロパティは'GET' 操作では入力されません。 値を取得するには、'/listSecrets' POST 要求を使用します。

ErrorAdditionalInfo

Object

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

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラー コード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラー メッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラー オブジェクト。