Share via

Microsoft.ApiManagement service/workspaces/apis 2023-05-01-preview

  • Статья

Определение ресурса Bicep

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

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

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

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

resource symbolicname 'Microsoft.ApiManagement/service/workspaces/apis@2023-05-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/workspaces/apis

Имя Описание Значение
name имя ресурса.

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

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

ApiCreateOrUpdatePropertiesOrApiContractProperties

Имя Описание Значение
apiRevision Описывает редакцию API. Если значение не указано, создается редакция 1 по умолчанию строка
apiRevisionDescription Описание редакции API. строка
apiType Тип создаваемого API.
* http создает REST API
* soap создает API сквозной передачи SOAP
* websocket создает API websocket
* graphqlсоздает API GraphQL.
Новые типы могут быть добавлены в будущем.		 "graphql"
'grpc'
"http"
'odata'
'soap'
'websocket'
версия_API Указывает идентификатор версии API, если API имеет версию строка
apiVersionDescription Описание версии API. строка
apiVersionSet Сведения о наборе версий ApiVersionSetContractDetails
apiVersionSetId Идентификатор ресурса для связанного ApiVersionSet. строка
authenticationSettings Коллекция параметров проверки подлинности, включенных в этот API. AuthenticationSettingsContract
contact Контактные данные ДЛЯ API. ApiContactInformation
description Описание API. Может содержать теги форматирования HTML. строка
displayName Имя API. Должен содержать от 1 до 300 символов. строка
format Формат содержимого, в котором импортируется 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
license Сведения о лицензии для API. ApiLicenseInformation
path Относительный URL-адрес, однозначно идентифицирующий этот API и все его пути к ресурсам в пределах экземпляра службы управления API. Он добавляется к базовому URL-адресу конечной точки API, указанному во время создания экземпляра службы, чтобы сформировать общедоступный URL-адрес для этого API. string (обязательно)
protocols Описывает, на каких протоколах могут вызываться операции в данном API. Массив строк, содержащий любой из:
"http"
"https"
'ws'
'wss'
serviceUrl Абсолютный URL-адрес внутренней службы, реализующей этот API. Не может содержать более 2000 символов. строка
sourceApiId Идентификатор API исходного API. строка
subscriptionKeyParameterNames Протоколы, по которым становится доступным API. SubscriptionKeyParameterNamesContract
subscriptionRequired Указывает, требуется ли api или подписка на продукт для доступа к API. bool
termsOfServiceUrl URL-адрес условий предоставления услуг для API. ДОЛЖЕН быть в формате URL-адреса. строка
translateRequiredQueryParameters Стратегия преобразования необходимых параметров запроса в шаблонные. По умолчанию имеет значение template. Возможные значения: "template", "query" "запрос"
"template"
тип Тип API. "graphql"
'grpc'
"http"
'odata'
'soap'
'websocket'
значение Значение содержимого при импорте API. строка
wsdlSelector Условия для ограничения импорта WSDL до подмножества документа. ApiCreateOrUpdatePropertiesWsdlSelector

ApiVersionSetContractDetails

Имя Описание Значение
description Описание набора версий API. строка
идентификатор Идентификатор существующего набора версий API. Пропустите это значение, чтобы создать новый набор версий. строка
name Отображаемое имя набора версий API. строка
versionHeaderName Имя параметра заголовка HTTP, указывающее версию API, если versioningScheme имеет значение header. строка
управление версиямиScheme Значение , определяющее расположение идентификатора версии 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

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

ApiLicenseInformation

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

SubscriptionKeyParameterNamesContract

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

ApiCreateOrUpdatePropertiesWsdlSelector

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

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

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

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

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

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

{
  "type": "Microsoft.ApiManagement/service/workspaces/apis",
  "apiVersion": "2023-05-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/workspaces/apis

Имя Описание Значение
тип Тип ресурса Microsoft.ApiManagement/service/workspaces/apis
версия_API Версия API ресурсов '2023-05-01-preview'
name имя ресурса.

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

ApiCreateOrUpdatePropertiesOrApiContractProperties

Имя Описание Значение
apiRevision Описывает редакцию API. Если значение не указано, создается редакция по умолчанию 1. строка
apiRevisionDescription Описание редакции API. строка
apiType Тип создаваемого API.
* http создает REST API
* soap создает API сквозной передачи SOAP
* websocket создает API websocket
* graphqlсоздает API GraphQL.
В будущем можно добавить новые типы.		 "graphql"
'grpc'
"http"
'odata'
'soap'
websocket
версия_API Указывает идентификатор версии API, если API имеет управление версиями. строка
apiVersionDescription Описание версии API. строка
apiVersionSet Сведения о наборе версий ApiVersionSetContractDetails
apiVersionSetId Идентификатор ресурса для связанного ApiVersionSet. строка
authenticationSettings Коллекция параметров проверки подлинности, включенных в этот API. AuthenticationSettingsContract
contact Контактные данные API. ApiContactInformation
description Описание API. Может содержать теги форматирования HTML. строка
displayName Имя API. Должен содержать от 1 до 300 символов. строка
format Формат содержимого, в который импортируется 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
license Сведения о лицензии для API. ApiLicenseInformation
path Относительный URL-адрес, однозначно идентифицирующий этот API и все его пути к ресурсам в пределах экземпляра службы управления API. Он добавляется к базовому URL-адресу конечной точки API, указанному во время создания экземпляра службы, чтобы сформировать общедоступный URL-адрес для этого API. строка (обязательно)
protocols Описывает, на каких протоколах могут вызываться операции в данном API. Массив строк, содержащий любой из:
"http"
"https"
'ws'
'wss'
serviceUrl Абсолютный URL-адрес внутренней службы, реализующей этот API. Не может содержать более 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

Имя Описание Значение
description Описание набора версий API. строка
идентификатор Идентификатор существующего набора версий API. Опустите это значение, чтобы создать новый набор версий. строка
name Отображаемое имя набора версий 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

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

ApiLicenseInformation

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

SubscriptionKeyParameterNamesContract

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

ApiCreateOrUpdatePropertiesWsdlSelector

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

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

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

  • Группы ресурсов

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/workspaces/apis@2023-05-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/workspaces/apis

Имя Описание Значение
тип Тип ресурса Microsoft.ApiManagement/service/workspaces/apis@2023-05-01-preview
name имя ресурса. строка (обязательно)
parent_id Идентификатор ресурса, который является родительским для этого ресурса. Идентификатор ресурса типа: workspaces
properties Создание сущности API для свойств обновления. ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiCreateOrUpdatePropertiesOrApiContractProperties

Имя Описание Значение
apiRevision Описывает редакцию API. Если значение не указано, создается редакция по умолчанию 1. строка
apiRevisionDescription Описание редакции API. строка
apiType Тип создаваемого API.
* http создает REST API
* soap создает API сквозной передачи SOAP
* websocket создает API websocket
* graphqlсоздает API GraphQL.
В будущем можно добавить новые типы.		 "graphql"
"grpc"
"http"
"odata"
"soap"
"websocket"
версия_API Указывает идентификатор версии API, если API имеет управление версиями. строка
apiVersionDescription Описание версии API. строка
apiVersionSet Сведения о наборе версий ApiVersionSetContractDetails
apiVersionSetId Идентификатор ресурса для связанного ApiVersionSet. строка
authenticationSettings Коллекция параметров проверки подлинности, включенных в этот API. AuthenticationSettingsContract
contact Контактные данные API. ApiContactInformation
description Описание API. Может содержать теги форматирования HTML. строка
displayName Имя API. Должен содержать от 1 до 300 символов. строка
format Формат содержимого, в который импортируется 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
license Сведения о лицензии для API. ApiLicenseInformation
path Относительный URL-адрес, однозначно идентифицирующий этот API и все его пути к ресурсам в пределах экземпляра службы управления API. Он добавляется к базовому URL-адресу конечной точки API, указанному во время создания экземпляра службы, чтобы сформировать общедоступный URL-адрес для этого API. string (обязательно)
protocols Описывает, на каких протоколах могут вызываться операции в данном API. Массив строк, содержащий любой из:
"http"
"https"
"ws"
"wss"
serviceUrl Абсолютный URL-адрес внутренней службы, реализующей этот API. Не может содержать более 2000 символов. строка
sourceApiId Идентификатор API исходного API. строка
subscriptionKeyParameterNames Протоколы, по которым становится доступным API. SubscriptionKeyParameterNamesContract
subscriptionRequired Указывает, требуется ли api или подписка на продукт для доступа к API. bool
termsOfServiceUrl URL-адрес условий предоставления услуг для API. ДОЛЖЕН быть в формате URL-адреса. строка
translateRequiredQueryParameters Стратегия преобразования необходимых параметров запроса в шаблонные. По умолчанию имеет значение template. Возможные значения: "template", "query" "query"
"template"
тип Тип API. "graphql"
"grpc"
"http"
"odata"
"soap"
"websocket"
значение Значение содержимого при импорте API. строка
wsdlSelector Условия для ограничения импорта WSDL до подмножества документа. ApiCreateOrUpdatePropertiesWsdlSelector

ApiVersionSetContractDetails

Имя Описание Значение
description Описание набора версий API. строка
идентификатор Идентификатор существующего набора версий API. Пропустите это значение, чтобы создать новый набор версий. строка
name Отображаемое имя набора версий API. строка
versionHeaderName Имя параметра заголовка HTTP, указывающее версию API, если versioningScheme имеет значение header. строка
управление версиямиScheme Значение , определяющее расположение идентификатора версии API в HTTP-запросе. Заголовок
"Запрос"
"Segment"
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

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

ApiLicenseInformation

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

SubscriptionKeyParameterNamesContract

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

ApiCreateOrUpdatePropertiesWsdlSelector

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