Microsoft.ApiManagement service/apis 2018-06-01-preview
- последние
- 2024-06-01-preview
- 2024-05-01
- 2023-09-01-preview
- 2023-05-01-preview
- 2023-03-01-preview
- 2022-09-01-preview
- 2022-08-01
- 2022-04-01-preview
- 2021-12-01-preview
- 2021-08-01
- 2021-04-01-preview
- 2021-01-01-preview
- 2020-12-01
- 2020-06-01-preview
- 2019-12-01
- 2019-12-01-preview
- 2019-01-01
- 2018-06-01-preview
- 2018-01-01
- 2017-03-01
- 2016-10-10
- 2016-07-07
Определение ресурсов Bicep
Тип ресурса service/apis можно развернуть с помощью операций, предназначенных для следующих операций:
- группы ресурсов . См. команды развертывания группы ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.ApiManagement/service/apis, добавьте следующий Bicep в шаблон.
resource symbolicname 'Microsoft.ApiManagement/service/apis@2018-06-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
apiRevision: 'string'
apiRevisionDescription: 'string'
apiType: 'string'
apiVersion: 'string'
apiVersionDescription: 'string'
apiVersionSet: {
description: 'string'
id: 'string'
versionHeaderName: 'string'
versioningScheme: 'string'
versionQueryName: 'string'
}
apiVersionSetId: 'string'
authenticationSettings: {
oAuth2: {
authorizationServerId: 'string'
scope: 'string'
}
openid: {
bearerTokenSendingMethods: [
'string'
]
openidProviderId: 'string'
}
subscriptionKeyRequired: bool
}
contentFormat: 'string'
contentValue: 'string'
description: 'string'
displayName: 'string'
path: 'string'
protocols: [
'string'
]
serviceUrl: 'string'
subscriptionKeyParameterNames: {
header: 'string'
query: 'string'
}
subscriptionRequired: bool
type: 'string'
wsdlSelector: {
wsdlEndpointName: 'string'
wsdlServiceName: 'string'
}
}
}
Значения свойств
ApiCreateOrUpdatePropertiesOrApiContractProperties
| Имя | Описание | Ценность |
|---|---|---|
| apiRevision | Описывает редакцию API. Если значение не указано, создается версия 1 по умолчанию | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 1 |
| apiRevisionDescription | Описание редакции API. | струна Ограничения целостности: Максимальная длина = |
| apiType | Тип api для создания. * http создает SOAP для REST API * soap создает СКВОЗНОЙ API SOAP. |
"http" "soap" |
| apiVersion | Указывает идентификатор версии API, если API имеет версию | струна Ограничения целостности: Максимальная длина = |
| apiVersionDescription | Описание версии API. | струна Ограничения целостности: Максимальная длина = |
| apiVersionSet | Набор версий API содержит общую конфигурацию для набора версий API, связанных с | ApiVersionSetContractDetails |
| apiVersionSetId | Идентификатор ресурса для связанного ApiVersionSet. | струна |
| authenticationSettings | Коллекция параметров проверки подлинности, включенных в этот API. | AuthenticationSettingsContract |
| contentFormat | Формат содержимого, в котором API импортируется. | "openapi" 'openapi+json' 'openapi-link' Swagger-json 'swagger-link-json' 'wadl-link-json' Wadl-xml Wsdl "wsdl-link" |
| contentValue | Значение содержимого при импорте API. | струна |
| описание | Описание API. Может включать теги форматирования HTML. | струна |
| displayName | Имя API. | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 1 |
| путь | Относительный URL-адрес уникально идентифицирует этот API и все пути к ресурсам в экземпляре службы управления API. Он добавляется к базовому URL-адресу конечной точки API, указанному во время создания экземпляра службы, чтобы сформировать общедоступный URL-адрес для этого API. | струна Ограничения целостности: Максимальная длина = (обязательно) |
| Протоколы | Описывает, какие протоколы могут вызываться в этом API. | Массив строк, содержащий любой из: "http" Https |
| serviceUrl | Абсолютный URL-адрес серверной службы, реализующего этот API. | струна Ограничения целостности: Максимальная длина = |
| subscriptionKeyParameterNames | Протоколы, через которые предоставляется API. | SubscriptionKeyParameterNamesContract |
| subscriptionRequired | Указывает, требуется ли api или подписка на продукт для доступа к API. | bool |
| тип | Тип API. | "http" "soap" |
| wsdlSelector | Критерии для ограничения импорта WSDL в подмножество документа. | ApiCreateOrUpdatePropertiesWsdlSelector |
ApiCreateOrUpdatePropertiesWsdlSelector
| Имя | Описание | Ценность |
|---|---|---|
| wsdlEndpointName | Имя конечной точки (порта) для импорта из WSDL | струна |
| wsdlServiceName | Имя службы для импорта из WSDL | струна |
ApiVersionSetContractDetails
| Имя | Описание | Ценность |
|---|---|---|
| описание | Описание набора версий API. | струна |
| идентификатор | Идентификатор существующего набора версий API. Опустим это значение, чтобы создать новый набор версий. | струна |
| versionHeaderName | Имя параметра заголовка HTTP, указывающего версию API, если для versioningScheme задано значение header. |
струна |
| versioningScheme | Значение, определяющее расположение идентификатора версии API в HTTP-запросе. | "Заголовок" "Запрос" "Сегмент" |
| versionQueryName | Имя параметра запроса, указывающего версию API, если для versioningScheme задано значение query. |
струна |
AuthenticationSettingsContract
| Имя | Описание | Ценность |
|---|---|---|
| oAuth2 | Параметры проверки подлинности OAuth2 | OAuth2AuthenticationSettingsContract |
| openid | Параметры проверки подлинности OpenID Connect | OpenIdAuthenticationSettingsContract |
| subscriptionKeyRequired | Указывает, требуется ли ключ подписки во время вызова этого API, true — API включается только в закрытые продукты, false — API включается в открытые продукты только, null — существует сочетание продуктов. | bool |
Microsoft.ApiManagement/service/apis
| Имя | Описание | Ценность |
|---|---|---|
| имя | Имя ресурса | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 1 Pattern = ^[^*#&+:<>?]+$ (обязательно) |
| родитель | В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить, только если дочерний ресурс объявлен за пределами родительского ресурса. Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса. |
Символьное имя ресурса типа: служба |
| свойства | Создание сущности API свойств обновления. | ApiCreateOrUpdatePropertiesOrApiContractProperties |
OAuth2AuthenticationSettingsContract
| Имя | Описание | Ценность |
|---|---|---|
| authorizationServerId | Идентификатор сервера авторизации OAuth. | струна |
| размах | область операций. | струна |
OpenIdAuthenticationSettingsContract
| Имя | Описание | Ценность |
|---|---|---|
| bearerTokenSendingMethods | Как отправить маркер на сервер. | Массив строк, содержащий любой из: "authorizationHeader" "query" |
| openidProviderId | Идентификатор сервера авторизации OAuth. | струна |
SubscriptionKeyParameterNamesContract
| Имя | Описание | Ценность |
|---|---|---|
| заголовок | Имя заголовка ключа подписки. | струна |
| запрос | Имя параметра строки запроса ключа подписки. | струна |
Определение ресурса шаблона ARM
Тип ресурса service/apis можно развернуть с помощью операций, предназначенных для следующих операций:
- группы ресурсов . См. команды развертывания группы ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.ApiManagement/service/apis, добавьте следующий код JSON в шаблон.
{
"type": "Microsoft.ApiManagement/service/apis",
"apiVersion": "2018-06-01-preview",
"name": "string",
"properties": {
"apiRevision": "string",
"apiRevisionDescription": "string",
"apiType": "string",
"apiVersion": "string",
"apiVersionDescription": "string",
"apiVersionSet": {
"description": "string",
"id": "string",
"versionHeaderName": "string",
"versioningScheme": "string",
"versionQueryName": "string"
},
"apiVersionSetId": "string",
"authenticationSettings": {
"oAuth2": {
"authorizationServerId": "string",
"scope": "string"
},
"openid": {
"bearerTokenSendingMethods": [ "string" ],
"openidProviderId": "string"
},
"subscriptionKeyRequired": "bool"
},
"contentFormat": "string",
"contentValue": "string",
"description": "string",
"displayName": "string",
"path": "string",
"protocols": [ "string" ],
"serviceUrl": "string",
"subscriptionKeyParameterNames": {
"header": "string",
"query": "string"
},
"subscriptionRequired": "bool",
"type": "string",
"wsdlSelector": {
"wsdlEndpointName": "string",
"wsdlServiceName": "string"
}
}
}
Значения свойств
ApiCreateOrUpdatePropertiesOrApiContractProperties
| Имя | Описание | Ценность |
|---|---|---|
| apiRevision | Описывает редакцию API. Если значение не указано, создается версия 1 по умолчанию | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 1 |
| apiRevisionDescription | Описание редакции API. | струна Ограничения целостности: Максимальная длина = |
| apiType | Тип api для создания. * http создает SOAP для REST API * soap создает СКВОЗНОЙ API SOAP. |
"http" "soap" |
| apiVersion | Указывает идентификатор версии API, если API имеет версию | струна Ограничения целостности: Максимальная длина = |
| apiVersionDescription | Описание версии API. | струна Ограничения целостности: Максимальная длина = |
| apiVersionSet | Набор версий API содержит общую конфигурацию для набора версий API, связанных с | ApiVersionSetContractDetails |
| apiVersionSetId | Идентификатор ресурса для связанного ApiVersionSet. | струна |
| authenticationSettings | Коллекция параметров проверки подлинности, включенных в этот API. | AuthenticationSettingsContract |
| contentFormat | Формат содержимого, в котором API импортируется. | "openapi" 'openapi+json' 'openapi-link' Swagger-json 'swagger-link-json' 'wadl-link-json' Wadl-xml Wsdl "wsdl-link" |
| contentValue | Значение содержимого при импорте API. | струна |
| описание | Описание API. Может включать теги форматирования HTML. | струна |
| displayName | Имя API. | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 1 |
| путь | Относительный URL-адрес уникально идентифицирует этот API и все пути к ресурсам в экземпляре службы управления API. Он добавляется к базовому URL-адресу конечной точки API, указанному во время создания экземпляра службы, чтобы сформировать общедоступный URL-адрес для этого API. | струна Ограничения целостности: Максимальная длина = (обязательно) |
| Протоколы | Описывает, какие протоколы могут вызываться в этом API. | Массив строк, содержащий любой из: "http" Https |
| serviceUrl | Абсолютный URL-адрес серверной службы, реализующего этот API. | струна Ограничения целостности: Максимальная длина = |
| subscriptionKeyParameterNames | Протоколы, через которые предоставляется API. | SubscriptionKeyParameterNamesContract |
| subscriptionRequired | Указывает, требуется ли api или подписка на продукт для доступа к API. | bool |
| тип | Тип API. | "http" "soap" |
| wsdlSelector | Критерии для ограничения импорта WSDL в подмножество документа. | ApiCreateOrUpdatePropertiesWsdlSelector |
ApiCreateOrUpdatePropertiesWsdlSelector
| Имя | Описание | Ценность |
|---|---|---|
| wsdlEndpointName | Имя конечной точки (порта) для импорта из WSDL | струна |
| wsdlServiceName | Имя службы для импорта из WSDL | струна |
ApiVersionSetContractDetails
| Имя | Описание | Ценность |
|---|---|---|
| описание | Описание набора версий API. | струна |
| идентификатор | Идентификатор существующего набора версий API. Опустим это значение, чтобы создать новый набор версий. | струна |
| versionHeaderName | Имя параметра заголовка HTTP, указывающего версию API, если для versioningScheme задано значение header. |
струна |
| versioningScheme | Значение, определяющее расположение идентификатора версии API в HTTP-запросе. | "Заголовок" "Запрос" "Сегмент" |
| versionQueryName | Имя параметра запроса, указывающего версию API, если для versioningScheme задано значение query. |
струна |
AuthenticationSettingsContract
| Имя | Описание | Ценность |
|---|---|---|
| oAuth2 | Параметры проверки подлинности OAuth2 | OAuth2AuthenticationSettingsContract |
| openid | Параметры проверки подлинности OpenID Connect | OpenIdAuthenticationSettingsContract |
| subscriptionKeyRequired | Указывает, требуется ли ключ подписки во время вызова этого API, true — API включается только в закрытые продукты, false — API включается в открытые продукты только, null — существует сочетание продуктов. | bool |
Microsoft.ApiManagement/service/apis
| Имя | Описание | Ценность |
|---|---|---|
| apiVersion | Версия API | '2018-06-01-preview' |
| имя | Имя ресурса | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 1 Pattern = ^[^*#&+:<>?]+$ (обязательно) |
| свойства | Создание сущности API свойств обновления. | ApiCreateOrUpdatePropertiesOrApiContractProperties |
| тип | Тип ресурса | "Microsoft.ApiManagement/service/apis" |
OAuth2AuthenticationSettingsContract
| Имя | Описание | Ценность |
|---|---|---|
| authorizationServerId | Идентификатор сервера авторизации OAuth. | струна |
| размах | область операций. | струна |
OpenIdAuthenticationSettingsContract
| Имя | Описание | Ценность |
|---|---|---|
| bearerTokenSendingMethods | Как отправить маркер на сервер. | Массив строк, содержащий любой из: "authorizationHeader" "query" |
| openidProviderId | Идентификатор сервера авторизации OAuth. | струна |
SubscriptionKeyParameterNamesContract
| Имя | Описание | Ценность |
|---|---|---|
| заголовок | Имя заголовка ключа подписки. | струна |
| запрос | Имя параметра строки запроса ключа подписки. | струна |
Определение ресурса Terraform (поставщик AzAPI)
Тип ресурса service/apis можно развернуть с помощью операций, предназначенных для следующих операций:
- групп ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.ApiManagement/service/apis, добавьте следующий объект Terraform в шаблон.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/apis@2018-06-01-preview"
name = "string"
body = jsonencode({
properties = {
apiRevision = "string"
apiRevisionDescription = "string"
apiType = "string"
apiVersion = "string"
apiVersionDescription = "string"
apiVersionSet = {
description = "string"
id = "string"
versionHeaderName = "string"
versioningScheme = "string"
versionQueryName = "string"
}
apiVersionSetId = "string"
authenticationSettings = {
oAuth2 = {
authorizationServerId = "string"
scope = "string"
}
openid = {
bearerTokenSendingMethods = [
"string"
]
openidProviderId = "string"
}
subscriptionKeyRequired = bool
}
contentFormat = "string"
contentValue = "string"
description = "string"
displayName = "string"
path = "string"
protocols = [
"string"
]
serviceUrl = "string"
subscriptionKeyParameterNames = {
header = "string"
query = "string"
}
subscriptionRequired = bool
type = "string"
wsdlSelector = {
wsdlEndpointName = "string"
wsdlServiceName = "string"
}
}
})
}
Значения свойств
ApiCreateOrUpdatePropertiesOrApiContractProperties
| Имя | Описание | Ценность |
|---|---|---|
| apiRevision | Описывает редакцию API. Если значение не указано, создается версия 1 по умолчанию | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 1 |
| apiRevisionDescription | Описание редакции API. | струна Ограничения целостности: Максимальная длина = |
| apiType | Тип api для создания. * http создает SOAP для REST API * soap создает СКВОЗНОЙ API SOAP. |
"http" "soap" |
| apiVersion | Указывает идентификатор версии API, если API имеет версию | струна Ограничения целостности: Максимальная длина = |
| apiVersionDescription | Описание версии API. | струна Ограничения целостности: Максимальная длина = |
| apiVersionSet | Набор версий API содержит общую конфигурацию для набора версий API, связанных с | ApiVersionSetContractDetails |
| apiVersionSetId | Идентификатор ресурса для связанного ApiVersionSet. | струна |
| authenticationSettings | Коллекция параметров проверки подлинности, включенных в этот API. | AuthenticationSettingsContract |
| contentFormat | Формат содержимого, в котором API импортируется. | "openapi" 'openapi+json' 'openapi-link' Swagger-json 'swagger-link-json' 'wadl-link-json' Wadl-xml Wsdl "wsdl-link" |
| contentValue | Значение содержимого при импорте API. | струна |
| описание | Описание API. Может включать теги форматирования HTML. | струна |
| displayName | Имя API. | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 1 |
| путь | Относительный URL-адрес уникально идентифицирует этот API и все пути к ресурсам в экземпляре службы управления API. Он добавляется к базовому URL-адресу конечной точки API, указанному во время создания экземпляра службы, чтобы сформировать общедоступный URL-адрес для этого API. | струна Ограничения целостности: Максимальная длина = (обязательно) |
| Протоколы | Описывает, какие протоколы могут вызываться в этом API. | Массив строк, содержащий любой из: "http" Https |
| serviceUrl | Абсолютный URL-адрес серверной службы, реализующего этот API. | струна Ограничения целостности: Максимальная длина = |
| subscriptionKeyParameterNames | Протоколы, через которые предоставляется API. | SubscriptionKeyParameterNamesContract |
| subscriptionRequired | Указывает, требуется ли api или подписка на продукт для доступа к API. | bool |
| тип | Тип API. | "http" "soap" |
| wsdlSelector | Критерии для ограничения импорта WSDL в подмножество документа. | ApiCreateOrUpdatePropertiesWsdlSelector |
ApiCreateOrUpdatePropertiesWsdlSelector
| Имя | Описание | Ценность |
|---|---|---|
| wsdlEndpointName | Имя конечной точки (порта) для импорта из WSDL | струна |
| wsdlServiceName | Имя службы для импорта из WSDL | струна |
ApiVersionSetContractDetails
| Имя | Описание | Ценность |
|---|---|---|
| описание | Описание набора версий API. | струна |
| идентификатор | Идентификатор существующего набора версий API. Опустим это значение, чтобы создать новый набор версий. | струна |
| versionHeaderName | Имя параметра заголовка HTTP, указывающего версию API, если для versioningScheme задано значение header. |
струна |
| versioningScheme | Значение, определяющее расположение идентификатора версии API в HTTP-запросе. | "Заголовок" "Запрос" "Сегмент" |
| versionQueryName | Имя параметра запроса, указывающего версию API, если для versioningScheme задано значение query. |
струна |
AuthenticationSettingsContract
| Имя | Описание | Ценность |
|---|---|---|
| oAuth2 | Параметры проверки подлинности OAuth2 | OAuth2AuthenticationSettingsContract |
| openid | Параметры проверки подлинности OpenID Connect | OpenIdAuthenticationSettingsContract |
| subscriptionKeyRequired | Указывает, требуется ли ключ подписки во время вызова этого API, true — API включается только в закрытые продукты, false — API включается в открытые продукты только, null — существует сочетание продуктов. | bool |
Microsoft.ApiManagement/service/apis
| Имя | Описание | Ценность |
|---|---|---|
| имя | Имя ресурса | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 1 Pattern = ^[^*#&+:<>?]+$ (обязательно) |
| parent_id | Идентификатор ресурса, который является родительским для этого ресурса. | Идентификатор ресурса типа: службы |
| свойства | Создание сущности API свойств обновления. | ApiCreateOrUpdatePropertiesOrApiContractProperties |
| тип | Тип ресурса | "Microsoft.ApiManagement/service/apis@2018-06-01-preview" |
OAuth2AuthenticationSettingsContract
| Имя | Описание | Ценность |
|---|---|---|
| authorizationServerId | Идентификатор сервера авторизации OAuth. | струна |
| размах | область операций. | струна |
OpenIdAuthenticationSettingsContract
| Имя | Описание | Ценность |
|---|---|---|
| bearerTokenSendingMethods | Как отправить маркер на сервер. | Массив строк, содержащий любой из: "authorizationHeader" "query" |
| openidProviderId | Идентификатор сервера авторизации OAuth. | струна |
SubscriptionKeyParameterNamesContract
| Имя | Описание | Ценность |
|---|---|---|
| заголовок | Имя заголовка ключа подписки. | струна |
| запрос | Имя параметра строки запроса ключа подписки. | струна |