Служба Microsoft.ApiManagement/серверные части
Статья 01/18/2024
1 участник
Обратная связь
В этой статье
Определение ресурса Bicep
Тип ресурса service/backends можно развернуть с помощью операций, предназначенных для:
Список измененных свойств в каждой версии API см. в журнале изменений .
Чтобы создать ресурс Microsoft.ApiManagement/service/backends, добавьте следующий Bicep в шаблон.
resource symbolicname 'Microsoft.ApiManagement/service/backends@2023-05-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
circuitBreaker: {
rules: [
{
failureCondition: {
count: int
errorReasons: [
'string'
]
interval: 'string'
percentage: int
statusCodeRanges: [
{
max: int
min: int
}
]
}
name: 'string'
tripDuration: 'string'
}
]
}
credentials: {
authorization: {
parameter: 'string'
scheme: 'string'
}
certificate: [
'string'
]
certificateIds: [
'string'
]
header: {
{customized property}: [
'string'
]
}
query: {
{customized property}: [
'string'
]
}
}
description: 'string'
pool: {
services: [
{
id: '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
}
type: 'string'
url: 'string'
}
}
Значения свойств
служба или серверная часть
Имя
Описание
Значение
name
имя ресурса.Bicep .
строка (обязательно)
родитель
В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить только в том случае, если дочерний ресурс объявлен вне родительского ресурса.в разделе Дочерний ресурс за пределами родительского ресурса .
Символьное имя ресурса типа: service
properties
Свойства контракта сущности серверной части.
BackendContractProperties
BackendContractProperties
Имя
Описание
Значение
circuitBreaker
Конфигурация серверного автоматического выключения
BackendCircuitBreaker
credentials
Свойства контракта учетных данных серверной части
BackendCredentialsContract
description
Описание серверной части.
строка
pool
BackendBaseParametersPool
properties
Контракт свойств серверной части
BackendProperties
protocol
Серверный протокол связи.
"http"
proxy
Свойства контракта внутреннего шлюза
BackendProxyContract
resourceId
URI управления ресурсом во внешней системе. Этот URL-адрес может быть идентификатором ресурса Arm приложений логики, приложений-функций или приложений API.
строка
title
Заголовок серверной части.
строка
Tls
Свойства TLS серверной части
BackendTlsProperties
тип
Тип серверной части. Серверная часть может быть отдельной или пулом.
'Pool'
url
URL-адрес среды выполнения серверной части.
строка (обязательно)
BackendCircuitBreaker
CircuitBreakerRule
Имя
Описание
Значение
failureCondition
Условия для спотыкания автоматического выключения.
CircuitBreakerFailureCondition
name
Имя правила.
строка
tripDuration
Длительность, в течение которой будет споткнут канал.
строка
CircuitBreakerFailureCondition
Имя
Описание
Значение
count
Пороговое значение для открытия канала.
INT
errorReasons
Причины ошибок, которые рассматриваются как сбои.
string[]
interval
Интервал, в течение которого учитываются сбои.
строка
процент
Пороговое значение для открытия канала.
INT
statusCodeRanges
Диапазоны кодов состояния, которые считаются сбоем.
FailureStatusCodeRange []
FailureStatusCodeRange
Имя
Описание
Значение
max
Максимальный код состояния HTTP.
INT
мин
Минимальный код состояния HTTP.
INT
BackendCredentialsContract
Имя
Описание
Значение
параметр
Значение параметра проверки подлинности.
строка (обязательно)
схема
Имя схемы проверки подлинности.
строка (обязательно)
Имя
Описание
Значение
{настроенное свойство}
string[]
BackendCredentialsContractQuery
Имя
Описание
Значение
{настроенное свойство}
string[]
BackendBaseParametersPool
Имя
Описание
Значение
services;
Список внутренних сущностей, принадлежащих пулу.
BackendPoolItem []
BackendPoolItem
Имя
Описание
Значение
идентификатор
Уникальный идентификатор ARM серверной сущности. Идентификатор ARM должен ссылаться на уже существующую сущность серверной части.
строка (обязательно)
BackendProperties
BackendServiceFabricClusterProperties
Имя
Описание
Значение
clientCertificateId
Идентификатор сертификата клиента для конечной точки управления.
строка
clientCertificatethumbprint
Отпечаток сертификата клиента для конечной точки управления. Игнорируется при предоставлении идентификаторов сертификатов
строка
managementEndpoints
Конечная точка управления кластером.
string[] (обязательно)
maxPartitionResolutionRetries
Максимальное количество повторных попыток при попытке разрешения секции.
INT
serverCertificateThumbprints
Отпечатки сертификатов, которые служба управления кластером использует для обмена данными по протоколу TLS
string[]
serverX509Names
Коллекция имен сертификатов Server X509
X509CertificateName []
X509CertificateName
Имя
Описание
Значение
issuerCertificateThumbprint
Отпечаток для издателя сертификата.
строка
name
Общее имя сертификата.
строка
BackendProxyContract
Имя
Описание
Значение
password
Пароль для подключения к серверу WebProxy
строка
url
Свойство AbsoluteUri сервера WebProxy, которое включает весь URI, хранящийся в экземпляре URI, включая все фрагменты и строки запроса.
string (обязательно)
username
Имя пользователя для подключения к серверу WebProxy
строка
BackendTlsProperties
Имя
Описание
Значение
validateCertificateChain
Флаг, указывающий, следует ли выполнять проверку цепочки SSL-сертификатов при использовании самозаверяющих сертификатов для этого серверного узла.
bool
validateCertificateName
Флаг, указывающий, следует ли проверять имя SSL-сертификата при использовании самозаверяющих сертификатов для этого серверного узла.
bool
Определение ресурса шаблона ARM
Тип ресурса service/backends можно развернуть с помощью операций, предназначенных для:
Список измененных свойств в каждой версии API см. в журнале изменений .
Чтобы создать ресурс Microsoft.ApiManagement/service/backends, добавьте следующий код JSON в шаблон.
{
"type": "Microsoft.ApiManagement/service/backends",
"apiVersion": "2023-05-01-preview",
"name": "string",
"properties": {
"circuitBreaker": {
"rules": [
{
"failureCondition": {
"count": "int",
"errorReasons": [ "string" ],
"interval": "string",
"percentage": "int",
"statusCodeRanges": [
{
"max": "int",
"min": "int"
}
]
},
"name": "string",
"tripDuration": "string"
}
]
},
"credentials": {
"authorization": {
"parameter": "string",
"scheme": "string"
},
"certificate": [ "string" ],
"certificateIds": [ "string" ],
"header": {
"{customized property}": [ "string" ]
},
"query": {
"{customized property}": [ "string" ]
}
},
"description": "string",
"pool": {
"services": [
{
"id": "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"
},
"type": "string",
"url": "string"
}
}
Значения свойств
служба или серверная часть
Имя
Описание
Значение
тип
Тип ресурса
Microsoft.ApiManagement/service/backends
версия_API
Версия API ресурсов
'2023-05-01-preview'
name
имя ресурса.шаблонах JSON ARM .
string (обязательно)
properties
Свойства контракта сущности серверной части.
BackendContractProperties
BackendContractProperties
Имя
Описание
Значение
circuitBreaker
Конфигурация серверного размыкателя цепи
BackendCircuitBreaker
credentials
Свойства контракта учетных данных серверной части
BackendCredentialsContract
description
Описание серверной части.
строка
pool
BackendBaseParametersPool
properties
Контракт свойств серверной части
BackendProperties
protocol
Серверный протокол связи.
"http"
proxy
Свойства контракта внутреннего шлюза
BackendProxyContract
resourceId
URI управления ресурсом во внешней системе. Этот URL-адрес может быть идентификатором ресурса Arm приложений логики, приложений-функций или приложений API.
строка
title
Заголовок серверной части.
строка
Tls
Свойства TLS серверной части
BackendTlsProperties
тип
Тип серверной части. Серверная часть может быть отдельной или пулом.
'Pool'
url
URL-адрес среды выполнения серверной части.
строка (обязательно)
BackendCircuitBreaker
CircuitBreakerRule
Имя
Описание
Значение
failureCondition
Условия для спотыкания автоматического выключения.
CircuitBreakerFailureCondition
name
Имя правила.
строка
tripDuration
Длительность, в течение которой будет споткнут канал.
строка
CircuitBreakerFailureCondition
Имя
Описание
Значение
count
Пороговое значение для открытия канала.
INT
errorReasons
Причины ошибок, которые рассматриваются как сбои.
string[]
interval
Интервал, в течение которого учитываются сбои.
строка
процент
Пороговое значение для открытия канала.
INT
statusCodeRanges
Диапазоны кодов состояния, которые считаются сбоем.
FailureStatusCodeRange []
FailureStatusCodeRange
Имя
Описание
Значение
max
Максимальный код состояния HTTP.
INT
мин
Минимальный код состояния HTTP.
INT
BackendCredentialsContract
Имя
Описание
Значение
параметр
Значение параметра проверки подлинности.
строка (обязательно)
схема
Имя схемы проверки подлинности.
string (обязательно)
Имя
Описание
Значение
{настраиваемое свойство}
string[]
BackendCredentialsContractQuery
Имя
Описание
Значение
{настраиваемое свойство}
string[]
BackendBaseParametersPool
Имя
Описание
Значение
services;
Список внутренних сущностей, принадлежащих пулу.
BackendPoolItem []
BackendPoolItem
Имя
Описание
Значение
идентификатор
Уникальный идентификатор ARM серверной сущности. Идентификатор ARM должен ссылаться на уже существующую сущность серверной части.
string (обязательно)
BackendProperties
BackendServiceFabricClusterProperties
Имя
Описание
Значение
clientCertificateId
Идентификатор сертификата клиента для конечной точки управления.
строка
clientCertificatethumbprint
Отпечаток сертификата клиента для конечной точки управления. Игнорируется при предоставлении идентификаторов сертификатов
строка
managementEndpoints
Конечная точка управления кластером.
string[] (обязательно)
maxPartitionResolutionRetries
Максимальное количество повторных попыток при попытке разрешения секции.
INT
serverCertificateThumbprints
Отпечатки сертификатов, которые служба управления кластером использует для обмена данными по протоколу TLS
string[]
serverX509Names
Коллекция имен сертификатов Server X509
X509CertificateName []
X509CertificateName
Имя
Описание
Значение
issuerCertificateThumbprint
Отпечаток для издателя сертификата.
строка
name
Общее имя сертификата.
строка
BackendProxyContract
Имя
Описание
Значение
password
Пароль для подключения к серверу WebProxy
строка
url
Свойство AbsoluteUri сервера WebProxy, которое включает весь URI, хранящийся в экземпляре URI, включая все фрагменты и строки запроса.
string (обязательно)
username
Имя пользователя для подключения к серверу WebProxy
строка
BackendTlsProperties
Имя
Описание
Значение
validateCertificateChain
Флаг, указывающий, следует ли выполнять проверку цепочки SSL-сертификатов при использовании самозаверяющих сертификатов для этого серверного узла.
bool
validateCertificateName
Флаг, указывающий, следует ли проверять имя SSL-сертификата при использовании самозаверяющих сертификатов для этого серверного узла.
bool
Тип ресурса service/backends можно развернуть с помощью операций, предназначенных для:
Список измененных свойств в каждой версии API см. в журнале изменений .
Чтобы создать ресурс Microsoft.ApiManagement/service/backends, добавьте следующую версию Terraform в шаблон.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/backends@2023-05-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
circuitBreaker = {
rules = [
{
failureCondition = {
count = int
errorReasons = [
"string"
]
interval = "string"
percentage = int
statusCodeRanges = [
{
max = int
min = int
}
]
}
name = "string"
tripDuration = "string"
}
]
}
credentials = {
authorization = {
parameter = "string"
scheme = "string"
}
certificate = [
"string"
]
certificateIds = [
"string"
]
header = {
{customized property} = [
"string"
]
}
query = {
{customized property} = [
"string"
]
}
}
description = "string"
pool = {
services = [
{
id = "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
}
type = "string"
url = "string"
}
})
}
Значения свойств
служба или серверная часть
Имя
Описание
Значение
тип
Тип ресурса
"Microsoft.ApiManagement/service/backends@2023-05-01-preview"
name
имя ресурса.
string (обязательно)
parent_id
Идентификатор ресурса, который является родительским для этого ресурса.
Идентификатор ресурса типа: service
properties
Свойства контракта сущности серверной части.
BackendContractProperties
BackendContractProperties
Имя
Описание
Значение
circuitBreaker
Конфигурация серверного размыкателя цепи
BackendCircuitBreaker
credentials
Свойства контракта учетных данных серверной части
BackendCredentialsContract
description
Описание серверной части.
строка
pool
BackendBaseParametersPool
properties
Контракт свойств серверной части
BackendProperties
protocol
Серверный протокол связи.
"http"
proxy
Свойства контракта внутреннего шлюза
BackendProxyContract
resourceId
URI управления ресурсом во внешней системе. Этот URL-адрес может быть идентификатором ресурса Arm приложений логики, приложений-функций или приложений API.
строка
title
Название серверной части.
строка
Tls
Свойства TLS серверной части
BackendTlsProperties
тип
Тип серверной части. Серверная часть может быть отдельной или пуловой.
"Пул"
url
URL-адрес среды выполнения серверной части.
string (обязательно)
BackendCircuitBreaker
CircuitBreakerRule
Имя
Описание
Значение
failureCondition
Условия для спотыкания автоматического выключения.
CircuitBreakerFailureCondition
name
Имя правила.
строка
tripDuration
Длительность, в течение которой канал будет споткнут.
строка
CircuitBreakerFailureCondition
Имя
Описание
Значение
count
Пороговое значение для открытия канала.
INT
errorReasons
Причины ошибок, которые рассматриваются как сбои.
string[]
interval
Интервал, в течение которого учитываются сбои.
строка
процент
Пороговое значение для открытия канала.
INT
statusCodeRanges
Диапазоны кодов состояния, которые считаются сбоем.
FailureStatusCodeRange []
FailureStatusCodeRange
Имя
Описание
Значение
max
Максимальный код состояния HTTP.
INT
мин
Минимальный код состояния HTTP.
INT
BackendCredentialsContract
Имя
Описание
Значение
параметр
Значение параметра проверки подлинности.
строка (обязательно)
схема
Имя схемы проверки подлинности.
строка (обязательно)
Имя
Описание
Значение
{настроенное свойство}
string[]
BackendCredentialsContractQuery
Имя
Описание
Значение
{настроенное свойство}
string[]
BackendBaseParametersPool
Имя
Описание
Значение
services;
Список внутренних сущностей, принадлежащих пулу.
BackendPoolItem []
BackendPoolItem
Имя
Описание
Значение
идентификатор
Уникальный идентификатор ARM серверной сущности. Идентификатор ARM должен ссылаться на уже существующую сущность серверной части.
строка (обязательно)
BackendProperties
BackendServiceFabricClusterProperties
Имя
Описание
Значение
clientCertificateId
Идентификатор сертификата клиента для конечной точки управления.
строка
clientCertificatethumbprint
Отпечаток сертификата клиента для конечной точки управления. Игнорируется, если указаны идентификаторы сертификатов
строка
managementEndpoints
Конечная точка управления кластером.
string[] (обязательно)
maxPartitionResolutionRetries
Максимальное число повторных попыток при попытке разрешения секции.
INT
serverCertificateThumbprints
Отпечатки сертификатов, которые служба управления кластером использует для обмена данными по протоколу TLS
string[]
serverX509Names
Коллекция имен сертификатов X509 server
X509CertificateName []
X509CertificateName
Имя
Описание
Значение
issuerCertificateThumbprint
Отпечаток для издателя сертификата.
строка
name
Общее имя сертификата.
строка
BackendProxyContract
Имя
Описание
Значение
password
Пароль для подключения к серверу WebProxy
строка
url
Свойство AbsoluteUri сервера WebProxy, которое включает весь URI, хранящийся в экземпляре URI, включая все фрагменты и строки запроса.
строка (обязательно)
username
Имя пользователя для подключения к серверу WebProxy
строка
BackendTlsProperties
Имя
Описание
Значение
validateCertificateChain
Флаг, указывающий, следует ли проверять цепочку SSL-сертификатов при использовании самозаверяющих сертификатов для этого внутреннего узла.
bool
validateCertificateName
Флаг, указывающий, следует ли проверять имя SSL-сертификата при использовании самозаверяющих сертификатов для этого внутреннего узла.
bool