共用方式為


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 參數

名稱 位於 必要 類型 Description
resourceGroupName
path True

string

資源群組的名稱。

serviceName
path True

string

API 管理 服務的名稱。

Regex 模式: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

可唯一識別 Microsoft Azure 訂用帳戶的訂用帳戶認證。 訂用帳戶識別碼會構成每個服務呼叫 URI 的一部分。

api-version
query True

string

要與用戶端要求搭配使用的 API 版本。

要求標頭

名稱 必要 類型 Description
If-Match

string

實體的 ETag。 建立實體時不需要,但在更新實體時則為必要專案。

要求本文

名稱 類型 Description
properties.subscriptions

SubscriptionsDelegationSettingsProperties

訂用帳戶委派設定。

properties.url

string

委派 URL。

properties.userRegistration

RegistrationDelegationSettingsProperties

用戶註冊委派設定。

properties.validationKey

string

要驗證的base64編碼驗證金鑰,要求來自 Azure API 管理。

回應

名稱 類型 Description
200 OK

PortalDelegationSettings

已成功更新委派設定。

Other Status Codes

ErrorResponse

描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱 Description
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
    }
  }
}

定義

名稱 Description
ErrorFieldContract

錯誤欄位合約。

ErrorResponse

錯誤回應。

PortalDelegationSettings

開發人員入口網站的委派設定。

RegistrationDelegationSettingsProperties

用戶註冊委派設定屬性。

SubscriptionsDelegationSettingsProperties

訂閱委派設定屬性。

ErrorFieldContract

錯誤欄位合約。

名稱 類型 Description
code

string

屬性層級錯誤碼。

message

string

人類可讀取的屬性層級錯誤表示法。

target

string

屬性名稱。

ErrorResponse

錯誤回應。

名稱 類型 Description
error.code

string

服務定義的錯誤碼。 此代碼會作為回應中指定之 HTTP 錯誤碼的子狀態。

error.details

ErrorFieldContract[]

要求中傳送無效欄位的清單,以防發生驗證錯誤。

error.message

string

人類可閱讀的錯誤表示法。

PortalDelegationSettings

開發人員入口網站的委派設定。

名稱 類型 Description
id

string

資源的完整資源識別碼。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

資源的名稱

properties.subscriptions

SubscriptionsDelegationSettingsProperties

訂用帳戶委派設定。

properties.url

string

委派 URL。

properties.userRegistration

RegistrationDelegationSettingsProperties

用戶註冊委派設定。

properties.validationKey

string

要驗證的base64編碼驗證金鑰,要求來自 Azure API 管理。

type

string

資源類型。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

RegistrationDelegationSettingsProperties

用戶註冊委派設定屬性。

名稱 類型 Description
enabled

boolean

啟用或停用用戶註冊的委派。

SubscriptionsDelegationSettingsProperties

訂閱委派設定屬性。

名稱 類型 Description
enabled

boolean

啟用或停用訂用帳戶的委派。