Delegation Settings - Update

サービス:

API Management

API バージョン:

2024-05-01

委任設定を更新します。

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalsettings/delegation?api-version=2024-05-01

URI パラメーター

名前	/	必須	型	説明
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 バージョン。

要求ヘッダー

名前	必須	型	説明
If-Match	True	string	エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティの状態と一致するか、無条件更新の場合は * にする必要があります。

要求本文

名前	型	説明
properties.subscriptions	SubscriptionsDelegationSettingsProperties	サブスクリプション委任の設定。
properties.url	string	委任 URL。
properties.userRegistration	RegistrationDelegationSettingsProperties	ユーザー登録委任の設定。
properties.validationKey	string	要求が Azure API Management から送信されていることを検証するための base64 でエンコードされた検証キー。

応答

名前	型	説明
204 No Content		委任設定が正常に更新されました。
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

スコープ

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

例

ApiManagementPortalSettingsUpdateDelegation

要求のサンプル

HTTP

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/delegation?api-version=2024-05-01


{
  "properties": {
    "url": "http://contoso.com/delegation",
    "validationKey": "<validationKey>",
    "subscriptions": {
      "enabled": true
    },
    "userRegistration": {
      "enabled": true
    }
  }
}

応答のサンプル

状態コード:

204

定義

名前	説明
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
PortalDelegationSettings	開発者ポータルの委任設定。
RegistrationDelegationSettingsProperties	ユーザー登録委任設定のプロパティ。
SubscriptionsDelegationSettingsProperties	サブスクリプション委任設定のプロパティ。

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

エラーの詳細。

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

ErrorResponse

Object

エラー応答

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

PortalDelegationSettings

Object

開発者ポータルの委任設定。

名前	型	説明
id	string	リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	リソースの名前
properties.subscriptions	SubscriptionsDelegationSettingsProperties	サブスクリプション委任の設定。
properties.url	string	委任 URL。
properties.userRegistration	RegistrationDelegationSettingsProperties	ユーザー登録委任の設定。
properties.validationKey	string	要求が Azure API Management から送信されていることを検証するための base64 でエンコードされた検証キー。
type	string	リソースの種類。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

RegistrationDelegationSettingsProperties

Object

ユーザー登録委任設定のプロパティ。

名前	型	説明
enabled	boolean	ユーザー登録の委任を有効または無効にします。

SubscriptionsDelegationSettingsProperties

Object

サブスクリプション委任設定のプロパティ。

名前	型	説明
enabled	boolean	サブスクリプションの委任を有効または無効にします。