Поделиться через


Tenant Settings - Get

Получение параметров клиента.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/settings/public?api-version=2021-08-01

Параметры URI

Имя В Обязательно Тип Описание
resourceGroupName
path True

string

Имя группы ресурсов.

serviceName
path True

string

minLength: 1
maxLength: 50
pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

Имя службы управления API.

settingsType
path True

settingsTypeName

Идентификатор параметров.

subscriptionId
path True

string

Учетные данные подписки, которые однозначно определяют подписку Microsoft Azure. Идентификатор подписки входит в состав URI для каждого вызова службы.

api-version
query True

string

Версия API для использования с клиентским запросом.

Ответы

Имя Тип Описание
200 OK

TenantSettingsContract

Параметры клиента.

Заголовки

ETag: string

Other Status Codes

ErrorResponse

Ответ на ошибку, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
user_impersonation олицетворения учетной записи пользователя

Примеры

ApiManagementGetTenantSettings

Образец запроса

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

Пример ответа

{
  "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"
    }
  }
}

Определения

Имя Описание
ErrorFieldContract

Контракт поля ошибки.

ErrorResponse

Ответ на ошибку.

settingsTypeName

Идентификатор параметров.

TenantSettingsContract

Параметры клиента.

ErrorFieldContract

Контракт поля ошибки.

Имя Тип Описание
code

string

Код ошибки уровня свойств.

message

string

Удобочитаемое пользователем представление ошибки уровня свойств.

target

string

Имя свойства.

ErrorResponse

Ответ на ошибку.

Имя Тип Описание
error.code

string

Код ошибки, определенный службой. Этот код служит вложенным состоянием для кода ошибки HTTP, указанного в ответе.

error.details

ErrorFieldContract[]

Список недопустимых полей, отправляемых в запросе, в случае ошибки проверки.

error.message

string

Читаемое человеком представление ошибки.

settingsTypeName

Идентификатор параметров.

Значение Описание
public

TenantSettingsContract

Параметры клиента.

Имя Тип Описание
id

string

Полный идентификатор ресурса для ресурса. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Имя ресурса

properties.settings

object

Параметры клиента

type

string

Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"