Служба Microsoft.ApiManagement/серверные части 2021-04-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
Тип ресурса службы или серверной части можно развернуть с помощью операций, предназначенных для следующих операций:
- группы ресурсов . См. команды развертывания группы ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.ApiManagement/service/backends, добавьте следующий Bicep в шаблон.
resource symbolicname 'Microsoft.ApiManagement/service/backends@2021-04-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
credentials: {
authorization: {
parameter: 'string'
scheme: 'string'
}
certificate: [
'string'
]
certificateIds: [
'string'
]
header: {
{customized property}: [
'string'
]
}
query: {
{customized property}: [
'string'
]
}
}
description: 'string'
properties: {
serviceFabricCluster: {
clientCertificateId: 'string'
clientCertificatethumbprint: 'string'
managementEndpoints: [
'string'
]
maxPartitionResolutionRetries: int
serverCertificateThumbprints: [
'string'
]
serverX509Names: [
{
issuerCertificateThumbprint: 'string'
name: 'string'
}
]
}
}
protocol: 'string'
proxy: {
password: 'string'
url: 'string'
username: 'string'
}
resourceId: 'string'
title: 'string'
tls: {
validateCertificateChain: bool
validateCertificateName: bool
}
url: 'string'
}
}
Значения свойств
BackendAuthorizationHeaderCredentials
| Имя | Описание | Ценность |
|---|---|---|
| параметр | Значение параметра проверки подлинности. | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 1 (обязательно) |
| схема | Имя схемы проверки подлинности. | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 1 (обязательно) |
BackendContractProperties
| Имя | Описание | Ценность |
|---|---|---|
| верительные грамоты | Свойства контракта учетных данных серверной части | BackendCredentialsContract |
| описание | Описание серверной части. | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 1 |
| свойства | Контракт свойств серверной части | BackendProperties |
| протокол | Внутренний протокол связи. | "http" "soap" (обязательно) |
| доверенность | Свойства контракта внутреннего прокси-сервера | BackendProxyContract |
| resourceId | Uri управления ресурса во внешней системе. Этот URL-адрес может быть идентификатором ресурса Arm logic Apps, приложений-функций или приложений API. | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 1 |
| титул | Заголовок серверной части. | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 1 |
| tls | Свойства TLS серверной части | BackendTlsProperties |
| URL-адрес | URL-адрес среды выполнения серверной части. | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 1 (обязательно) |
BackendCredentialsContract
| Имя | Описание | Ценность |
|---|---|---|
| авторизация | Проверка подлинности заголовка авторизации | BackendAuthorizationHeaderCredentials |
| сертификат | Список отпечаток сертификата клиента. Будет игнорироваться, если указаны сертификаты. | string[] |
| certificateIds | Список идентификаторов сертификата клиента. | string[] |
| заголовок | Описание параметра заголовка. | BackendCredentialsContractHeader |
| запрос | Описание параметра запроса. | BackendCredentialsContractQuery |
BackendCredentialsContractHeader
| Имя | Описание | Ценность |
|---|
BackendCredentialsContractQuery
| Имя | Описание | Ценность |
|---|
BackendProperties
| Имя | Описание | Ценность |
|---|---|---|
| serviceFabricCluster | Свойства кластера Service Fabric серверной части | BackendServiceFabricClusterProperties |
BackendProxyContract
| Имя | Описание | Ценность |
|---|---|---|
| пароль | Пароль для подключения к серверу WebProxy | струна |
| URL-адрес | Свойство WebProxy Server AbsoluteUri, которое включает весь URI, хранящийся в экземпляре URI, включая все фрагменты и строки запроса. | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 1 (обязательно) |
| имя пользователя | Имя пользователя для подключения к серверу WebProxy | струна |
BackendServiceFabricClusterProperties
| Имя | Описание | Ценность |
|---|---|---|
| clientCertificateId | Идентификатор сертификата клиента для конечной точки управления. | струна |
| clientCertificatethumbprint | Отпечаток сертификата клиента для конечной точки управления. Будет игнорироваться, если указаны сертификаты | струна |
| managementEndpoints | Конечная точка управления кластерами. | string[] (обязательно) |
| maxPartitionResolutionRetries | Максимальное количество повторных попыток при попытке разрешения секции. | int |
| serverCertificateThumbprints | Отпечатки службы управления кластерами сертификатов, которые используются для обмена данными по протоколу TLS | string[] |
| serverX509Names | Коллекция имен сертификатов X509 server | X509CertificateName[] |
BackendTlsProperties
| Имя | Описание | Ценность |
|---|---|---|
| validateCertificateChain | Флаг, указывающий, следует ли выполнять проверку цепочки SSL-сертификатов при использовании самозаверяющих сертификатов для этого внутреннего узла. | bool |
| validateCertificateName | Флаг, указывающий, следует ли проверять имя SSL-сертификата при использовании самозаверяющих сертификатов для этого внутреннего узла. | bool |
Microsoft.ApiManagement/service/backends
| Имя | Описание | Ценность |
|---|---|---|
| имя | Имя ресурса | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 1 (обязательно) |
| родитель | В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить, только если дочерний ресурс объявлен за пределами родительского ресурса. Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса. |
Символьное имя ресурса типа: служба |
| свойства | Свойства контракта сущности серверной части. | BackendContractProperties |
X509CertificateName
| Имя | Описание | Ценность |
|---|---|---|
| issuerCertificateThumbprint | Отпечаток издателя сертификата. | струна |
| имя | Общее имя сертификата. | струна |
Определение ресурса шаблона ARM
Тип ресурса службы или серверной части можно развернуть с помощью операций, предназначенных для следующих операций:
- группы ресурсов . См. команды развертывания группы ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.ApiManagement/service/backends, добавьте следующий код JSON в шаблон.
{
"type": "Microsoft.ApiManagement/service/backends",
"apiVersion": "2021-04-01-preview",
"name": "string",
"properties": {
"credentials": {
"authorization": {
"parameter": "string",
"scheme": "string"
},
"certificate": [ "string" ],
"certificateIds": [ "string" ],
"header": {
"{customized property}": [ "string" ]
},
"query": {
"{customized property}": [ "string" ]
}
},
"description": "string",
"properties": {
"serviceFabricCluster": {
"clientCertificateId": "string",
"clientCertificatethumbprint": "string",
"managementEndpoints": [ "string" ],
"maxPartitionResolutionRetries": "int",
"serverCertificateThumbprints": [ "string" ],
"serverX509Names": [
{
"issuerCertificateThumbprint": "string",
"name": "string"
}
]
}
},
"protocol": "string",
"proxy": {
"password": "string",
"url": "string",
"username": "string"
},
"resourceId": "string",
"title": "string",
"tls": {
"validateCertificateChain": "bool",
"validateCertificateName": "bool"
},
"url": "string"
}
}
Значения свойств
BackendAuthorizationHeaderCredentials
| Имя | Описание | Ценность |
|---|---|---|
| параметр | Значение параметра проверки подлинности. | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 1 (обязательно) |
| схема | Имя схемы проверки подлинности. | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 1 (обязательно) |
BackendContractProperties
| Имя | Описание | Ценность |
|---|---|---|
| верительные грамоты | Свойства контракта учетных данных серверной части | BackendCredentialsContract |
| описание | Описание серверной части. | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 1 |
| свойства | Контракт свойств серверной части | BackendProperties |
| протокол | Внутренний протокол связи. | "http" "soap" (обязательно) |
| доверенность | Свойства контракта внутреннего прокси-сервера | BackendProxyContract |
| resourceId | Uri управления ресурса во внешней системе. Этот URL-адрес может быть идентификатором ресурса Arm logic Apps, приложений-функций или приложений API. | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 1 |
| титул | Заголовок серверной части. | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 1 |
| tls | Свойства TLS серверной части | BackendTlsProperties |
| URL-адрес | URL-адрес среды выполнения серверной части. | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 1 (обязательно) |
BackendCredentialsContract
| Имя | Описание | Ценность |
|---|---|---|
| авторизация | Проверка подлинности заголовка авторизации | BackendAuthorizationHeaderCredentials |
| сертификат | Список отпечаток сертификата клиента. Будет игнорироваться, если указаны сертификаты. | string[] |
| certificateIds | Список идентификаторов сертификата клиента. | string[] |
| заголовок | Описание параметра заголовка. | BackendCredentialsContractHeader |
| запрос | Описание параметра запроса. | BackendCredentialsContractQuery |
BackendCredentialsContractHeader
| Имя | Описание | Ценность |
|---|
BackendCredentialsContractQuery
| Имя | Описание | Ценность |
|---|
BackendProperties
| Имя | Описание | Ценность |
|---|---|---|
| serviceFabricCluster | Свойства кластера Service Fabric серверной части | BackendServiceFabricClusterProperties |
BackendProxyContract
| Имя | Описание | Ценность |
|---|---|---|
| пароль | Пароль для подключения к серверу WebProxy | струна |
| URL-адрес | Свойство WebProxy Server AbsoluteUri, которое включает весь URI, хранящийся в экземпляре URI, включая все фрагменты и строки запроса. | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 1 (обязательно) |
| имя пользователя | Имя пользователя для подключения к серверу WebProxy | струна |
BackendServiceFabricClusterProperties
| Имя | Описание | Ценность |
|---|---|---|
| clientCertificateId | Идентификатор сертификата клиента для конечной точки управления. | струна |
| clientCertificatethumbprint | Отпечаток сертификата клиента для конечной точки управления. Будет игнорироваться, если указаны сертификаты | струна |
| managementEndpoints | Конечная точка управления кластерами. | string[] (обязательно) |
| maxPartitionResolutionRetries | Максимальное количество повторных попыток при попытке разрешения секции. | int |
| serverCertificateThumbprints | Отпечатки службы управления кластерами сертификатов, которые используются для обмена данными по протоколу TLS | string[] |
| serverX509Names | Коллекция имен сертификатов X509 server | X509CertificateName[] |
BackendTlsProperties
| Имя | Описание | Ценность |
|---|---|---|
| validateCertificateChain | Флаг, указывающий, следует ли выполнять проверку цепочки SSL-сертификатов при использовании самозаверяющих сертификатов для этого внутреннего узла. | bool |
| validateCertificateName | Флаг, указывающий, следует ли проверять имя SSL-сертификата при использовании самозаверяющих сертификатов для этого внутреннего узла. | bool |
Microsoft.ApiManagement/service/backends
| Имя | Описание | Ценность |
|---|---|---|
| apiVersion | Версия API | '2021-04-01-preview' |
| имя | Имя ресурса | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 1 (обязательно) |
| свойства | Свойства контракта сущности серверной части. | BackendContractProperties |
| тип | Тип ресурса | "Microsoft.ApiManagement/service/backends" |
X509CertificateName
| Имя | Описание | Ценность |
|---|---|---|
| issuerCertificateThumbprint | Отпечаток издателя сертификата. | струна |
| имя | Общее имя сертификата. | струна |
Определение ресурса Terraform (поставщик AzAPI)
Тип ресурса службы или серверной части можно развернуть с помощью операций, предназначенных для следующих операций:
- групп ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.ApiManagement/service/backends, добавьте следующий объект Terraform в шаблон.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/backends@2021-04-01-preview"
name = "string"
body = jsonencode({
properties = {
credentials = {
authorization = {
parameter = "string"
scheme = "string"
}
certificate = [
"string"
]
certificateIds = [
"string"
]
header = {
{customized property} = [
"string"
]
}
query = {
{customized property} = [
"string"
]
}
}
description = "string"
properties = {
serviceFabricCluster = {
clientCertificateId = "string"
clientCertificatethumbprint = "string"
managementEndpoints = [
"string"
]
maxPartitionResolutionRetries = int
serverCertificateThumbprints = [
"string"
]
serverX509Names = [
{
issuerCertificateThumbprint = "string"
name = "string"
}
]
}
}
protocol = "string"
proxy = {
password = "string"
url = "string"
username = "string"
}
resourceId = "string"
title = "string"
tls = {
validateCertificateChain = bool
validateCertificateName = bool
}
url = "string"
}
})
}
Значения свойств
BackendAuthorizationHeaderCredentials
| Имя | Описание | Ценность |
|---|---|---|
| параметр | Значение параметра проверки подлинности. | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 1 (обязательно) |
| схема | Имя схемы проверки подлинности. | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 1 (обязательно) |
BackendContractProperties
| Имя | Описание | Ценность |
|---|---|---|
| верительные грамоты | Свойства контракта учетных данных серверной части | BackendCredentialsContract |
| описание | Описание серверной части. | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 1 |
| свойства | Контракт свойств серверной части | BackendProperties |
| протокол | Внутренний протокол связи. | "http" "soap" (обязательно) |
| доверенность | Свойства контракта внутреннего прокси-сервера | BackendProxyContract |
| resourceId | Uri управления ресурса во внешней системе. Этот URL-адрес может быть идентификатором ресурса Arm logic Apps, приложений-функций или приложений API. | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 1 |
| титул | Заголовок серверной части. | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 1 |
| tls | Свойства TLS серверной части | BackendTlsProperties |
| URL-адрес | URL-адрес среды выполнения серверной части. | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 1 (обязательно) |
BackendCredentialsContract
| Имя | Описание | Ценность |
|---|---|---|
| авторизация | Проверка подлинности заголовка авторизации | BackendAuthorizationHeaderCredentials |
| сертификат | Список отпечаток сертификата клиента. Будет игнорироваться, если указаны сертификаты. | string[] |
| certificateIds | Список идентификаторов сертификата клиента. | string[] |
| заголовок | Описание параметра заголовка. | BackendCredentialsContractHeader |
| запрос | Описание параметра запроса. | BackendCredentialsContractQuery |
BackendCredentialsContractHeader
| Имя | Описание | Ценность |
|---|
BackendCredentialsContractQuery
| Имя | Описание | Ценность |
|---|
BackendProperties
| Имя | Описание | Ценность |
|---|---|---|
| serviceFabricCluster | Свойства кластера Service Fabric серверной части | BackendServiceFabricClusterProperties |
BackendProxyContract
| Имя | Описание | Ценность |
|---|---|---|
| пароль | Пароль для подключения к серверу WebProxy | струна |
| URL-адрес | Свойство WebProxy Server AbsoluteUri, которое включает весь URI, хранящийся в экземпляре URI, включая все фрагменты и строки запроса. | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 1 (обязательно) |
| имя пользователя | Имя пользователя для подключения к серверу WebProxy | струна |
BackendServiceFabricClusterProperties
| Имя | Описание | Ценность |
|---|---|---|
| clientCertificateId | Идентификатор сертификата клиента для конечной точки управления. | струна |
| clientCertificatethumbprint | Отпечаток сертификата клиента для конечной точки управления. Будет игнорироваться, если указаны сертификаты | струна |
| managementEndpoints | Конечная точка управления кластерами. | string[] (обязательно) |
| maxPartitionResolutionRetries | Максимальное количество повторных попыток при попытке разрешения секции. | int |
| serverCertificateThumbprints | Отпечатки службы управления кластерами сертификатов, которые используются для обмена данными по протоколу TLS | string[] |
| serverX509Names | Коллекция имен сертификатов X509 server | X509CertificateName[] |
BackendTlsProperties
| Имя | Описание | Ценность |
|---|---|---|
| validateCertificateChain | Флаг, указывающий, следует ли выполнять проверку цепочки SSL-сертификатов при использовании самозаверяющих сертификатов для этого внутреннего узла. | bool |
| validateCertificateName | Флаг, указывающий, следует ли проверять имя SSL-сертификата при использовании самозаверяющих сертификатов для этого внутреннего узла. | bool |
Microsoft.ApiManagement/service/backends
| Имя | Описание | Ценность |
|---|---|---|
| имя | Имя ресурса | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 1 (обязательно) |
| parent_id | Идентификатор ресурса, который является родительским для этого ресурса. | Идентификатор ресурса типа: службы |
| свойства | Свойства контракта сущности серверной части. | BackendContractProperties |
| тип | Тип ресурса | "Microsoft.ApiManagement/service/backends@2021-04-01-preview" |
X509CertificateName
| Имя | Описание | Ценность |
|---|---|---|
| issuerCertificateThumbprint | Отпечаток издателя сертификата. | струна |
| имя | Общее имя сертификата. | струна |