Authorization - Get

サービス:

API Management

API バージョン:

2024-05-01

識別子で指定された承認の詳細を取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationProviders/{authorizationProviderId}/authorizations/{authorizationId}?api-version=2024-05-01

URI パラメーター

名前	/	必須	型	説明
authorizationId	path	True	string minLength: 1 maxLength: 256 pattern: ^[^*#&+:<>?]+$	承認の識別子。
authorizationProviderId	path	True	string minLength: 1 maxLength: 256 pattern: ^[^*#&+:<>?]+$	承認プロバイダーの識別子。
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	AuthorizationContract	応答本文には、指定された承認エンティティが含まれています。 シークレットは含まれません ヘッダー 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	ユーザー アカウントを偽装する

例

ApiManagementGetAuthorization

要求のサンプル

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode/authorizations/authz1?api-version=2024-05-01

応答のサンプル

状態コード:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/authorizationProviders/aadwithauthcode/authorizations/authz1",
  "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations",
  "name": "authz1",
  "properties": {
    "authorizationType": "OAuth2",
    "oauth2grantType": "AuthorizationCode",
    "status": "Connected"
  }
}

定義

名前	説明
AuthorizationContract	承認コントラクト。
AuthorizationError	承認エラーの詳細。
AuthorizationType	承認の種類のオプション
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
OAuth2GrantType	OAuth2 許可の種類のオプション

AuthorizationContract

Object

承認コントラクト。

名前	型	説明
id	string	リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	リソースの名前
properties.authorizationType	AuthorizationType	承認の種類のオプション
properties.error	AuthorizationError
properties.oauth2grantType	OAuth2GrantType	OAuth2 許可の種類のオプション
properties.parameters	object	承認パラメーター
properties.status	string	承認の状態
type	string	リソースの種類。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

AuthorizationError

Object

承認エラーの詳細。

名前	型	説明
code	string	エラー コード
message	string	エラーメッセージ

AuthorizationType

列挙

承認の種類のオプション

値	説明
OAuth2	OAuth2 承認の種類

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

エラーの詳細。

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

ErrorResponse

Object

エラー応答

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

OAuth2GrantType

列挙

OAuth2 許可の種類のオプション

値	説明
AuthorizationCode	承認コードの付与
ClientCredentials	クライアント資格情報の付与