Delegation Settings - Create Or Update
委任設定を作成または更新します。
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalsettings/delegation?api-version=2021-08-01
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
resource
|
path | True |
string |
リソース グループの名前。 |
service
|
path | True |
string |
API Management サービスの名前。 正規表現パターン: |
subscription
|
path | True |
string |
Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。 サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。 |
api-version
|
query | True |
string |
クライアント要求で使用される API のバージョン。 |
要求ヘッダー
名前 | 必須 | 型 | 説明 |
---|---|---|---|
If-Match |
string |
エンティティの ETag。 エンティティを作成する場合は必須ではありませんが、エンティティを更新する場合は必須です。 |
要求本文
名前 | 型 | 説明 |
---|---|---|
properties.subscriptions |
サブスクリプション委任の設定。 |
|
properties.url |
string |
委任 URL。 |
properties.userRegistration |
ユーザー登録の委任設定。 |
|
properties.validationKey |
string |
要求が Azure API Managementから送信されていることを検証するための base64 でエンコードされた検証キー。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
委任設定が正常に更新されました。 |
|
Other Status Codes |
操作に失敗した理由を説明するエラー応答。 |
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー。
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
名前 | 説明 |
---|---|
user_impersonation | ユーザー アカウントの借用 |
例
ApiManagementPortalSettingsUpdateDelegation
要求のサンプル
PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/delegation?api-version=2021-08-01
{
"properties": {
"url": "http://contoso.com/delegation",
"validationKey": "<validationKey>",
"subscriptions": {
"enabled": true
},
"userRegistration": {
"enabled": true
}
}
}
応答のサンプル
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/delegation",
"type": "Microsoft.ApiManagement/service/portalsettings",
"name": "delegation",
"properties": {
"url": "http://contoso.com/delegation",
"subscriptions": {
"enabled": true
},
"userRegistration": {
"enabled": true
}
}
}
定義
名前 | 説明 |
---|---|
Error |
エラー フィールド コントラクト。 |
Error |
エラー応答。 |
Portal |
開発者ポータルの委任設定。 |
Registration |
ユーザー登録委任設定のプロパティ。 |
Subscriptions |
サブスクリプション委任設定のプロパティ。 |
ErrorFieldContract
エラー フィールド コントラクト。
名前 | 型 | 説明 |
---|---|---|
code |
string |
プロパティ レベルのエラー コード。 |
message |
string |
プロパティ レベルエラーの人間が判読できる表現。 |
target |
string |
プロパティ名。 |
ErrorResponse
エラー応答。
名前 | 型 | 説明 |
---|---|---|
error.code |
string |
サービスによって定義されたエラー コード。 このコードは、応答に指定された HTTP エラー コードのサブステータスとして機能します。 |
error.details |
検証エラーが発生した場合に要求で送信される無効なフィールドの一覧。 |
|
error.message |
string |
人が判読できるエラーの表現。 |
PortalDelegationSettings
開発者ポータルの委任設定。
名前 | 型 | 説明 |
---|---|---|
id |
string |
リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
リソースの名前 |
properties.subscriptions |
サブスクリプション委任の設定。 |
|
properties.url |
string |
委任 URL。 |
properties.userRegistration |
ユーザー登録の委任設定。 |
|
properties.validationKey |
string |
要求が Azure API Managementから送信されていることを検証するための base64 でエンコードされた検証キー。 |
type |
string |
リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts" |
RegistrationDelegationSettingsProperties
ユーザー登録委任設定のプロパティ。
名前 | 型 | 説明 |
---|---|---|
enabled |
boolean |
ユーザー登録の委任を有効または無効にします。 |
SubscriptionsDelegationSettingsProperties
サブスクリプション委任設定のプロパティ。
名前 | 型 | 説明 |
---|---|---|
enabled |
boolean |
サブスクリプションの委任を有効または無効にします。 |