共用方式為


Tenant Settings - List By Service

公用設定。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/settings?api-version=2021-08-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/settings?$filter={$filter}&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 版本。

$filter
query

string

未使用

回應

名稱 類型 Description
200 OK

TenantSettingsCollection

列出TenantSettings實體的集合。

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 模擬您的用戶帳戶

範例

ApiManagementListTenantSettings

範例要求

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/settings?api-version=2021-08-01

範例回覆

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/settings/public",
      "type": "Microsoft.ApiManagement/service/settings",
      "name": "public",
      "properties": {
        "settings": {
          "CustomPortalSettings.UserRegistrationTerms": null,
          "CustomPortalSettings.UserRegistrationTermsEnabled": "False",
          "CustomPortalSettings.UserRegistrationTermsConsentRequired": "False",
          "CustomPortalSettings.DelegationEnabled": "False",
          "CustomPortalSettings.DelegationUrl": "",
          "CustomPortalSettings.DelegatedSubscriptionEnabled": "False"
        }
      }
    }
  ],
  "nextLink": ""
}

定義

名稱 Description
ErrorFieldContract

錯誤欄位合約。

ErrorResponse

錯誤回應。

TenantSettingsCollection

分頁 AccessInformation 清單表示法。

TenantSettingsContract

租用戶設定。

ErrorFieldContract

錯誤欄位合約。

名稱 類型 Description
code

string

屬性層級錯誤碼。

message

string

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

target

string

屬性名稱。

ErrorResponse

錯誤回應。

名稱 類型 Description
error.code

string

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

error.details

ErrorFieldContract[]

在驗證錯誤時,要求中傳送的無效欄位清單。

error.message

string

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

TenantSettingsCollection

分頁 AccessInformation 清單表示法。

名稱 類型 Description
nextLink

string

如果有的話,下一頁連結。

value

TenantSettingsContract[]

頁面值。

TenantSettingsContract

租用戶設定。

名稱 類型 Description
id

string

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

name

string

資源的名稱

properties.settings

object

租用戶設定

type

string

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