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

Служба и api Microsoft.ApiManagement

  • Статья

Определение ресурсов Bicep

Тип ресурса service/apis можно развернуть с помощью операций, предназначенных для следующих операций:

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.ApiManagement/service/apis, добавьте следующий Bicep в шаблон.

resource symbolicname 'Microsoft.ApiManagement/service/apis@2023-09-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    apiRevision: 'string'
    apiRevisionDescription: 'string'
    apiType: 'string'
    apiVersion: 'string'
    apiVersionDescription: 'string'
    apiVersionSet: {
      description: 'string'
      id: 'string'
      name: 'string'
      versionHeaderName: 'string'
      versioningScheme: 'string'
      versionQueryName: 'string'
    }
    apiVersionSetId: 'string'
    authenticationSettings: {
      oAuth2: {
        authorizationServerId: 'string'
        scope: 'string'
      }
      oAuth2AuthenticationSettings: [
        {
          authorizationServerId: 'string'
          scope: 'string'
        }
      ]
      openid: {
        bearerTokenSendingMethods: [
          'string'
        ]
        openidProviderId: 'string'
      }
      openidAuthenticationSettings: [
        {
          bearerTokenSendingMethods: [
            'string'
          ]
          openidProviderId: 'string'
        }
      ]
    }
    contact: {
      email: 'string'
      name: 'string'
      url: 'string'
    }
    description: 'string'
    displayName: 'string'
    format: 'string'
    isCurrent: bool
    license: {
      name: 'string'
      url: 'string'
    }
    path: 'string'
    protocols: [
      'string'
    ]
    serviceUrl: 'string'
    sourceApiId: 'string'
    subscriptionKeyParameterNames: {
      header: 'string'
      query: 'string'
    }
    subscriptionRequired: bool
    termsOfServiceUrl: 'string'
    translateRequiredQueryParameters: 'string'
    type: 'string'
    value: 'string'
    wsdlSelector: {
      wsdlEndpointName: 'string'
      wsdlServiceName: 'string'
    }
  }
}

Значения свойств

service/apis

Имя Описание Ценность
имя Имя ресурса

Узнайте, как задать имена и типы дочерних ресурсов в Bicep.		 строка (обязательно)

Ограничение символов: 1–80

Допустимые символы:
Буквенно-цифровые и дефисы.

Начните с буквы и заканчивается буквенно-цифровым.
родитель В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить, только если дочерний ресурс объявлен за пределами родительского ресурса.

Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса.		 Символьное имя ресурса типа: служба
свойства Создание сущности API свойств обновления. ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiCreateOrUpdatePropertiesOrApiContractProperties

Имя Описание Ценность
apiRevision Описывает редакцию API. Если значение не указано, создается версия 1 по умолчанию струна

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 100
apiRevisionDescription Описание редакции API. струна

Ограничения целостности:
Максимальная длина = 256
apiType Тип создаваемого API.
* http создает REST API
* soap создает API сквозной передачи SOAP
* websocket создает API websocket
* graphql создает API GraphQL.
Новые типы можно добавить в будущем.		 Graphql
'grpc'
'http'
'odata'
"soap"
"websocket"
apiVersion Указывает идентификатор версии API, если API имеет версию струна

Ограничения целостности:
Максимальная длина = 100
apiVersionDescription Описание версии API. струна

Ограничения целостности:
Максимальная длина = 256
apiVersionSet Сведения о наборе версий ApiVersionSetContractDetails
apiVersionSetId Идентификатор ресурса для связанного ApiVersionSet. струна
authenticationSettings Коллекция параметров проверки подлинности, включенных в этот API. AuthenticationSettingsContract
контакт Контактные данные API. ApiContactInformation
описание Описание API. Может включать теги форматирования HTML. струна
displayName Имя API. Должно составлять от 1 до 300 символов. струна

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 300
формат Формат содержимого, в котором API импортируется. Новые форматы можно добавить в будущем Graphql-link
'grpc'
"grpc-link"
'odata'
'odata-link'
"openapi"
'openapi+json'
'openapi+json-link'
'openapi-link'
Swagger-json
'swagger-link-json'
'wadl-link-json'
Wadl-xml
Wsdl
"wsdl-link"
isCurrent Указывает, является ли редакция API текущей редакцией API. bool
лицензия Сведения о лицензии для API. ApiLicenseInformation
путь Относительный URL-адрес уникально идентифицирует этот API и все пути к ресурсам в экземпляре службы управления API. Он добавляется к базовому URL-адресу конечной точки API, указанному во время создания экземпляра службы, чтобы сформировать общедоступный URL-адрес для этого API. строка (обязательно)

Ограничения целостности:
Максимальная длина = 400
Протоколы Описывает, какие протоколы могут вызываться в этом API. Массив строк, содержащий любой из:
'http'
'https'
"ws"
"wss"
serviceUrl Абсолютный URL-адрес серверной службы, реализующего этот API. Не может превышать 2000 символов. струна

Ограничения целостности:
Максимальная длина = 2000
sourceApiId Идентификатор API исходного API. струна
subscriptionKeyParameterNames Протоколы, через которые предоставляется API. SubscriptionKeyParameterNamesContract
subscriptionRequired Указывает, требуется ли api или подписка на продукт для доступа к API. bool
termsOfServiceUrl URL-адрес условий обслуживания для API. ДОЛЖЕН быть в формате URL-адреса. струна
translateRequiredQueryParameters Стратегия перевода необходимых параметров запроса в шаблонные. По умолчанию имеет значение template. Возможные значения: "template", "query" "query"
"шаблон"
тип Тип API. Graphql
'grpc'
'http'
'odata'
"soap"
"websocket"
ценность Значение содержимого при импорте API. струна
wsdlSelector Критерии для ограничения импорта WSDL в подмножество документа. ApiCreateOrUpdatePropertiesWsdlSelector

ApiVersionSetContractDetails

Имя Описание Ценность
описание Описание набора версий API. струна
идентификатор Идентификатор существующего набора версий API. Опустим это значение, чтобы создать новый набор версий. струна
имя Отображаемое имя набора версий API. струна
versionHeaderName Имя параметра заголовка HTTP, указывающего версию API, если для versioningScheme задано значение header. струна
versioningScheme Значение, определяющее расположение идентификатора версии API в HTTP-запросе. "Заголовок"
"Запрос"
"Сегмент"
versionQueryName Имя параметра запроса, указывающего версию API, если для versioningScheme задано значение query. струна

AuthenticationSettingsContract

Имя Описание Ценность
oAuth2 Параметры проверки подлинности OAuth2 OAuth2AuthenticationSettingsContract
oAuth2AuthenticationSettings Коллекция параметров проверки подлинности OAuth2, включенных в этот API. OAuth2AuthenticationSettingsContract[]
openid Параметры проверки подлинности OpenID Connect OpenIdAuthenticationSettingsContract
openidAuthenticationSettings Коллекция параметров проверки подлинности Open ID Connect, включенных в этот API. OpenIdAuthenticationSettingsContract[]

OAuth2AuthenticationSettingsContract

Имя Описание Ценность
authorizationServerId Идентификатор сервера авторизации OAuth. струна
размах область операций. струна

OpenIdAuthenticationSettingsContract

Имя Описание Ценность
bearerTokenSendingMethods Как отправить маркер на сервер. Массив строк, содержащий любой из:
"authorizationHeader"
"query"
openidProviderId Идентификатор сервера авторизации OAuth. струна

ApiContactInformation

Имя Описание Ценность
Отправить по электронной почте Адрес электронной почты контактного лица или организации. Должен быть в формате адреса электронной почты струна
имя Идентификация имени контактного лица или организации струна
URL-адрес URL-адрес, указывающий на контактные данные. ДОЛЖЕН быть в формате URL-адреса струна

ApiLicenseInformation

Имя Описание Ценность
имя Имя лицензии, используемое для API струна
URL-адрес URL-адрес лицензии, используемой для API. ДОЛЖЕН быть в формате URL-адреса струна

SubscriptionKeyParameterNamesContract

Имя Описание Ценность
заголовок Имя заголовка ключа подписки. струна
запрос Имя параметра строки запроса ключа подписки. струна

ApiCreateOrUpdatePropertiesWsdlSelector

Имя Описание Ценность
wsdlEndpointName Имя конечной точки (порта) для импорта из WSDL струна
wsdlServiceName Имя службы для импорта из WSDL струна

Шаблоны быстрого запуска

Следующие шаблоны быстрого запуска развертывают этот тип ресурса.

Шаблон Описание
Создание экземпляра службы управления API и всех вложенных ресурсов с помощью шаблона

развертывание в Azure		 В этом шаблоне показано, как создать службу управления API и настроить вложенные сущности
создание Azure Front Door перед управления API Azure

развертывание в Azure		 В этом примере показано, как использовать Azure Front Door в качестве глобальной подсистемы балансировки нагрузки перед управлением API Azure.

Определение ресурса шаблона ARM

Тип ресурса service/apis можно развернуть с помощью операций, предназначенных для следующих операций:

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.ApiManagement/service/apis, добавьте следующий код JSON в шаблон.

{
  "type": "Microsoft.ApiManagement/service/apis",
  "apiVersion": "2023-09-01-preview",
  "name": "string",
  "properties": {
    "apiRevision": "string",
    "apiRevisionDescription": "string",
    "apiType": "string",
    "apiVersion": "string",
    "apiVersionDescription": "string",
    "apiVersionSet": {
      "description": "string",
      "id": "string",
      "name": "string",
      "versionHeaderName": "string",
      "versioningScheme": "string",
      "versionQueryName": "string"
    },
    "apiVersionSetId": "string",
    "authenticationSettings": {
      "oAuth2": {
        "authorizationServerId": "string",
        "scope": "string"
      },
      "oAuth2AuthenticationSettings": [
        {
          "authorizationServerId": "string",
          "scope": "string"
        }
      ],
      "openid": {
        "bearerTokenSendingMethods": [ "string" ],
        "openidProviderId": "string"
      },
      "openidAuthenticationSettings": [
        {
          "bearerTokenSendingMethods": [ "string" ],
          "openidProviderId": "string"
        }
      ]
    },
    "contact": {
      "email": "string",
      "name": "string",
      "url": "string"
    },
    "description": "string",
    "displayName": "string",
    "format": "string",
    "isCurrent": "bool",
    "license": {
      "name": "string",
      "url": "string"
    },
    "path": "string",
    "protocols": [ "string" ],
    "serviceUrl": "string",
    "sourceApiId": "string",
    "subscriptionKeyParameterNames": {
      "header": "string",
      "query": "string"
    },
    "subscriptionRequired": "bool",
    "termsOfServiceUrl": "string",
    "translateRequiredQueryParameters": "string",
    "type": "string",
    "value": "string",
    "wsdlSelector": {
      "wsdlEndpointName": "string",
      "wsdlServiceName": "string"
    }
  }
}

Значения свойств

service/apis

Имя Описание Ценность
тип Тип ресурса "Microsoft.ApiManagement/service/apis"
apiVersion Версия API ресурсов '2023-09-01-preview'
имя Имя ресурса

Узнайте, как задать имена и типы дочерних ресурсов в шаблонах ARM JSON.		 строка (обязательно)

Ограничение символов: 1–80

Допустимые символы:
Буквенно-цифровые и дефисы.

Начните с буквы и заканчивается буквенно-цифровым.
свойства Создание сущности API свойств обновления. ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiCreateOrUpdatePropertiesOrApiContractProperties

Имя Описание Ценность
apiRevision Описывает редакцию API. Если значение не указано, создается версия 1 по умолчанию струна

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 100
apiRevisionDescription Описание редакции API. струна

Ограничения целостности:
Максимальная длина = 256
apiType Тип создаваемого API.
* http создает REST API
* soap создает API сквозной передачи SOAP
* websocket создает API websocket
* graphql создает API GraphQL.
Новые типы можно добавить в будущем.		 Graphql
'grpc'
'http'
'odata'
"soap"
"websocket"
apiVersion Указывает идентификатор версии API, если API имеет версию струна

Ограничения целостности:
Максимальная длина = 100
apiVersionDescription Описание версии API. струна

Ограничения целостности:
Максимальная длина = 256
apiVersionSet Сведения о наборе версий ApiVersionSetContractDetails
apiVersionSetId Идентификатор ресурса для связанного ApiVersionSet. струна
authenticationSettings Коллекция параметров проверки подлинности, включенных в этот API. AuthenticationSettingsContract
контакт Контактные данные API. ApiContactInformation
описание Описание API. Может включать теги форматирования HTML. струна
displayName Имя API. Должно составлять от 1 до 300 символов. струна

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 300
формат Формат содержимого, в котором API импортируется. Новые форматы можно добавить в будущем Graphql-link
'grpc'
"grpc-link"
'odata'
'odata-link'
"openapi"
'openapi+json'
'openapi+json-link'
'openapi-link'
Swagger-json
'swagger-link-json'
'wadl-link-json'
Wadl-xml
Wsdl
"wsdl-link"
isCurrent Указывает, является ли редакция API текущей редакцией API. bool
лицензия Сведения о лицензии для API. ApiLicenseInformation
путь Относительный URL-адрес уникально идентифицирует этот API и все пути к ресурсам в экземпляре службы управления API. Он добавляется к базовому URL-адресу конечной точки API, указанному во время создания экземпляра службы, чтобы сформировать общедоступный URL-адрес для этого API. строка (обязательно)

Ограничения целостности:
Максимальная длина = 400
Протоколы Описывает, какие протоколы могут вызываться в этом API. Массив строк, содержащий любой из:
'http'
'https'
"ws"
"wss"
serviceUrl Абсолютный URL-адрес серверной службы, реализующего этот API. Не может превышать 2000 символов. струна

Ограничения целостности:
Максимальная длина = 2000
sourceApiId Идентификатор API исходного API. струна
subscriptionKeyParameterNames Протоколы, через которые предоставляется API. SubscriptionKeyParameterNamesContract
subscriptionRequired Указывает, требуется ли api или подписка на продукт для доступа к API. bool
termsOfServiceUrl URL-адрес условий обслуживания для API. ДОЛЖЕН быть в формате URL-адреса. струна
translateRequiredQueryParameters Стратегия перевода необходимых параметров запроса в шаблонные. По умолчанию имеет значение template. Возможные значения: "template", "query" "query"
"шаблон"
тип Тип API. Graphql
'grpc'
'http'
'odata'
"soap"
"websocket"
ценность Значение содержимого при импорте API. струна
wsdlSelector Критерии для ограничения импорта WSDL в подмножество документа. ApiCreateOrUpdatePropertiesWsdlSelector

ApiVersionSetContractDetails

Имя Описание Ценность
описание Описание набора версий API. струна
идентификатор Идентификатор существующего набора версий API. Опустим это значение, чтобы создать новый набор версий. струна
имя Отображаемое имя набора версий API. струна
versionHeaderName Имя параметра заголовка HTTP, указывающего версию API, если для versioningScheme задано значение header. струна
versioningScheme Значение, определяющее расположение идентификатора версии API в HTTP-запросе. "Заголовок"
"Запрос"
"Сегмент"
versionQueryName Имя параметра запроса, указывающего версию API, если для versioningScheme задано значение query. струна

AuthenticationSettingsContract

Имя Описание Ценность
oAuth2 Параметры проверки подлинности OAuth2 OAuth2AuthenticationSettingsContract
oAuth2AuthenticationSettings Коллекция параметров проверки подлинности OAuth2, включенных в этот API. OAuth2AuthenticationSettingsContract[]
openid Параметры проверки подлинности OpenID Connect OpenIdAuthenticationSettingsContract
openidAuthenticationSettings Коллекция параметров проверки подлинности Open ID Connect, включенных в этот API. OpenIdAuthenticationSettingsContract[]

OAuth2AuthenticationSettingsContract

Имя Описание Ценность
authorizationServerId Идентификатор сервера авторизации OAuth. струна
размах область операций. струна

OpenIdAuthenticationSettingsContract

Имя Описание Ценность
bearerTokenSendingMethods Как отправить маркер на сервер. Массив строк, содержащий любой из:
"authorizationHeader"
"query"
openidProviderId Идентификатор сервера авторизации OAuth. струна

ApiContactInformation

Имя Описание Ценность
Отправить по электронной почте Адрес электронной почты контактного лица или организации. Должен быть в формате адреса электронной почты струна
имя Идентификация имени контактного лица или организации струна
URL-адрес URL-адрес, указывающий на контактные данные. ДОЛЖЕН быть в формате URL-адреса струна

ApiLicenseInformation

Имя Описание Ценность
имя Имя лицензии, используемое для API струна
URL-адрес URL-адрес лицензии, используемой для API. ДОЛЖЕН быть в формате URL-адреса струна

SubscriptionKeyParameterNamesContract

Имя Описание Ценность
заголовок Имя заголовка ключа подписки. струна
запрос Имя параметра строки запроса ключа подписки. струна

ApiCreateOrUpdatePropertiesWsdlSelector

Имя Описание Ценность
wsdlEndpointName Имя конечной точки (порта) для импорта из WSDL струна
wsdlServiceName Имя службы для импорта из WSDL струна

Шаблоны быстрого запуска

Следующие шаблоны быстрого запуска развертывают этот тип ресурса.

Шаблон Описание
Создание экземпляра службы управления API и всех вложенных ресурсов с помощью шаблона

развертывание в Azure		 В этом шаблоне показано, как создать службу управления API и настроить вложенные сущности
создание Azure Front Door перед управления API Azure

развертывание в Azure		 В этом примере показано, как использовать Azure Front Door в качестве глобальной подсистемы балансировки нагрузки перед управлением API Azure.

Определение ресурса Terraform (поставщик AzAPI)

Тип ресурса service/apis можно развернуть с помощью операций, предназначенных для следующих операций:

  • групп ресурсов

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.ApiManagement/service/apis, добавьте следующий объект Terraform в шаблон.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis@2023-09-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      apiRevision = "string"
      apiRevisionDescription = "string"
      apiType = "string"
      apiVersion = "string"
      apiVersionDescription = "string"
      apiVersionSet = {
        description = "string"
        id = "string"
        name = "string"
        versionHeaderName = "string"
        versioningScheme = "string"
        versionQueryName = "string"
      }
      apiVersionSetId = "string"
      authenticationSettings = {
        oAuth2 = {
          authorizationServerId = "string"
          scope = "string"
        }
        oAuth2AuthenticationSettings = [
          {
            authorizationServerId = "string"
            scope = "string"
          }
        ]
        openid = {
          bearerTokenSendingMethods = [
            "string"
          ]
          openidProviderId = "string"
        }
        openidAuthenticationSettings = [
          {
            bearerTokenSendingMethods = [
              "string"
            ]
            openidProviderId = "string"
          }
        ]
      }
      contact = {
        email = "string"
        name = "string"
        url = "string"
      }
      description = "string"
      displayName = "string"
      format = "string"
      isCurrent = bool
      license = {
        name = "string"
        url = "string"
      }
      path = "string"
      protocols = [
        "string"
      ]
      serviceUrl = "string"
      sourceApiId = "string"
      subscriptionKeyParameterNames = {
        header = "string"
        query = "string"
      }
      subscriptionRequired = bool
      termsOfServiceUrl = "string"
      translateRequiredQueryParameters = "string"
      type = "string"
      value = "string"
      wsdlSelector = {
        wsdlEndpointName = "string"
        wsdlServiceName = "string"
      }
    }
  })
}

Значения свойств

service/apis

Имя Описание Ценность
тип Тип ресурса "Microsoft.ApiManagement/service/apis@2023-09-01-preview"
имя Имя ресурса строка (обязательно)

Ограничение символов: 1–80

Допустимые символы:
Буквенно-цифровые и дефисы.

Начните с буквы и заканчивается буквенно-цифровым.
parent_id Идентификатор ресурса, который является родительским для этого ресурса. Идентификатор ресурса типа: службы
свойства Создание сущности API свойств обновления. ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiCreateOrUpdatePropertiesOrApiContractProperties

Имя Описание Ценность
apiRevision Описывает редакцию API. Если значение не указано, создается версия 1 по умолчанию струна

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 100
apiRevisionDescription Описание редакции API. струна

Ограничения целостности:
Максимальная длина = 256
apiType Тип создаваемого API.
* http создает REST API
* soap создает API сквозной передачи SOAP
* websocket создает API websocket
* graphql создает API GraphQL.
Новые типы можно добавить в будущем.		 Graphql
"grpc"
"http"
"odata"
"soap"
"websocket"
apiVersion Указывает идентификатор версии API, если API имеет версию струна

Ограничения целостности:
Максимальная длина = 100
apiVersionDescription Описание версии API. струна

Ограничения целостности:
Максимальная длина = 256
apiVersionSet Сведения о наборе версий ApiVersionSetContractDetails
apiVersionSetId Идентификатор ресурса для связанного ApiVersionSet. струна
authenticationSettings Коллекция параметров проверки подлинности, включенных в этот API. AuthenticationSettingsContract
контакт Контактные данные API. ApiContactInformation
описание Описание API. Может включать теги форматирования HTML. струна
displayName Имя API. Должно составлять от 1 до 300 символов. струна

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 300
формат Формат содержимого, в котором API импортируется. Новые форматы можно добавить в будущем Graphql-link
"grpc"
"grpc-link"
"odata"
"odata-link"
"openapi"
"openapi+json"
"openapi+json-link"
"openapi-link"
Swagger-json
Swagger-link-json"
Wadl-link-json
Wadl-xml
Wsdl
"wsdl-link"
isCurrent Указывает, является ли редакция API текущей редакцией API. bool
лицензия Сведения о лицензии для API. ApiLicenseInformation
путь Относительный URL-адрес уникально идентифицирует этот API и все пути к ресурсам в экземпляре службы управления API. Он добавляется к базовому URL-адресу конечной точки API, указанному во время создания экземпляра службы, чтобы сформировать общедоступный URL-адрес для этого API. строка (обязательно)

Ограничения целостности:
Максимальная длина = 400
Протоколы Описывает, какие протоколы могут вызываться в этом API. Массив строк, содержащий любой из:
"http"
"https"
"ws"
"wss"
serviceUrl Абсолютный URL-адрес серверной службы, реализующего этот API. Не может превышать 2000 символов. струна

Ограничения целостности:
Максимальная длина = 2000
sourceApiId Идентификатор API исходного API. струна
subscriptionKeyParameterNames Протоколы, через которые предоставляется API. SubscriptionKeyParameterNamesContract
subscriptionRequired Указывает, требуется ли api или подписка на продукт для доступа к API. bool
termsOfServiceUrl URL-адрес условий обслуживания для API. ДОЛЖЕН быть в формате URL-адреса. струна
translateRequiredQueryParameters Стратегия перевода необходимых параметров запроса в шаблонные. По умолчанию имеет значение template. Возможные значения: "template", "query" "query"
"шаблон"
тип Тип API. Graphql
"grpc"
"http"
"odata"
"soap"
"websocket"
ценность Значение содержимого при импорте API. струна
wsdlSelector Критерии для ограничения импорта WSDL в подмножество документа. ApiCreateOrUpdatePropertiesWsdlSelector

ApiVersionSetContractDetails

Имя Описание Ценность
описание Описание набора версий API. струна
идентификатор Идентификатор существующего набора версий API. Опустим это значение, чтобы создать новый набор версий. струна
имя Отображаемое имя набора версий API. струна
versionHeaderName Имя параметра заголовка HTTP, указывающего версию API, если для versioningScheme задано значение header. струна
versioningScheme Значение, определяющее расположение идентификатора версии API в HTTP-запросе. "Заголовок"
"Запрос"
"Сегмент"
versionQueryName Имя параметра запроса, указывающего версию API, если для versioningScheme задано значение query. струна

AuthenticationSettingsContract

Имя Описание Ценность
oAuth2 Параметры проверки подлинности OAuth2 OAuth2AuthenticationSettingsContract
oAuth2AuthenticationSettings Коллекция параметров проверки подлинности OAuth2, включенных в этот API. OAuth2AuthenticationSettingsContract[]
openid Параметры проверки подлинности OpenID Connect OpenIdAuthenticationSettingsContract
openidAuthenticationSettings Коллекция параметров проверки подлинности Open ID Connect, включенных в этот API. OpenIdAuthenticationSettingsContract[]

OAuth2AuthenticationSettingsContract

Имя Описание Ценность
authorizationServerId Идентификатор сервера авторизации OAuth. струна
размах область операций. струна

OpenIdAuthenticationSettingsContract

Имя Описание Ценность
bearerTokenSendingMethods Как отправить маркер на сервер. Массив строк, содержащий любой из:
"authorizationHeader"
"query"
openidProviderId Идентификатор сервера авторизации OAuth. струна

ApiContactInformation

Имя Описание Ценность
Отправить по электронной почте Адрес электронной почты контактного лица или организации. Должен быть в формате адреса электронной почты струна
имя Идентификация имени контактного лица или организации струна
URL-адрес URL-адрес, указывающий на контактные данные. ДОЛЖЕН быть в формате URL-адреса струна

ApiLicenseInformation

Имя Описание Ценность
имя Имя лицензии, используемое для API струна
URL-адрес URL-адрес лицензии, используемой для API. ДОЛЖЕН быть в формате URL-адреса струна

SubscriptionKeyParameterNamesContract

Имя Описание Ценность
заголовок Имя заголовка ключа подписки. струна
запрос Имя параметра строки запроса ключа подписки. струна

ApiCreateOrUpdatePropertiesWsdlSelector

Имя Описание Ценность
wsdlEndpointName Имя конечной точки (порта) для импорта из WSDL струна
wsdlServiceName Имя службы для импорта из WSDL струна