Serviço Microsoft.ApiManagement/backends 2022-08-01
Definição de recursos do bíceps
O tipo de recurso de serviço/back-ends pode ser implantado com operações que visam:
- Grupos de recursos - Consulte comandos de implantação de grupo de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.
Formato do recurso
Para criar um recurso Microsoft.ApiManagement/service/backends, adicione o seguinte Bicep ao seu modelo.
resource symbolicname 'Microsoft.ApiManagement/service/backends@2022-08-01' = {
name: 'string'
parent: resourceSymbolicName
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'
}
}
Valores de propriedade
serviço/back-ends
| Designação | Descrição | Valor |
|---|---|---|
| Designação | O nome do recurso Veja como definir nomes e tipos para recursos filho no Bicep. |
string (obrigatório) Limite de caracteres: 1-80 Caracteres válidos: Alfanuméricos e hífenes. Comece com letra e termine com alfanumérico. |
| pai | No Bicep, você pode especificar o recurso pai para um recurso filho. Você só precisa adicionar essa propriedade quando o recurso filho é declarado fora do recurso pai. Para obter mais informações, consulte recurso filho fora do recurso pai. |
Nome simbólico para recurso do tipo: serviço |
| propriedades | Propriedades de contrato de entidade de back-end. | BackendContractProperties |
BackendContractProperties
| Designação | Descrição | Valor |
|---|---|---|
| Credenciais | Propriedades do contrato de credenciais de back-end | BackendCredentialsContract |
| Descrição | Descrição do back-end. | string Restrições: Comprimento mínimo = 1 Comprimento máximo = 2000 |
| propriedades | Contrato de propriedades de back-end | BackendProperties |
| protocolo | Protocolo de comunicação de back-end. | 'http''sabão' (obrigatório) |
| procuração | Propriedades do contrato do gateway de back-end | BackendProxyContract |
| resourceId | Uri de Gestão do Recurso no Sistema Externo. Este URL pode ser o Arm Resource Id de Aplicativos Lógicos, Aplicativos de Função ou Aplicativos de API. | string Restrições: Comprimento mínimo = 1 Comprimento máximo = 2000 |
| título | Título de back-end. | string Restrições: Comprimento mínimo = 1 Comprimento máximo = 300 |
| TLS | Propriedades TLS de back-end | BackendTlsProperties |
| URL | url de tempo de execução do back-end. | string (obrigatório) Restrições: Comprimento mínimo = 1 Comprimento máximo = 2000 |
BackendCredentialsContract
BackendAuthorizationHeaderCredentials
| Designação | Descrição | Valor |
|---|---|---|
| parâmetro | Valor do parâmetro de autenticação. | string (obrigatório) Restrições: Comprimento mínimo = 1 Comprimento máximo = 300 |
| Regime | Nome do esquema de autenticação. | string (obrigatório) Restrições: Comprimento mínimo = 1 Comprimento máximo = 100 |
BackendCredentialsContractHeader
| Designação | Descrição | Valor |
|---|---|---|
| {propriedade personalizada} | string[] |
BackendCredentialsContractQuery
| Designação | Descrição | Valor |
|---|---|---|
| {propriedade personalizada} | string[] |
BackendProperties
| Designação | Descrição | Valor |
|---|---|---|
| serviceFabricCluster | Propriedades do cluster do Backend Service Fabric | BackendServiceFabricClusterProperties |
BackendServiceFabricClusterProperties
| Designação | Descrição | Valor |
|---|---|---|
| clientCertificateId | A ID do certificado do cliente para o ponto de extremidade de gerenciamento. | string |
| clientCertificateimpressão digital | A impressão digital do certificado do cliente para o ponto de extremidade de gerenciamento. Será ignorado se certificatesIds forem fornecidos | string |
| gerenciamentoPontos finais | O ponto de extremidade de gerenciamento de cluster. | string[] (obrigatório) |
| maxPartitionResolutionRetries | Número máximo de tentativas ao tentar resolver a partição. | Int |
| serverCertificateImpressões digitais | Impressões digitais de certificados que o serviço de gerenciamento de cluster usa para comunicação tls | string[] |
| serverX509Nomes | Coleção de Nomes de Certificados X509 do Servidor | X509CertificateName[] |
X509CertificateName
| Designação | Descrição | Valor |
|---|---|---|
| emissorCertificadoImpressão digital | Impressão digital para o emissor do certificado. | string |
| Designação | Nome comum do certificado. | string |
BackendProxyContract
| Designação | Descrição | Valor |
|---|---|---|
| palavra-passe | Senha para se conectar ao WebProxy Server | string |
| URL | Propriedade WebProxy Server AbsoluteUri que inclui todo o URI armazenado na instância de Uri, incluindo todos os fragmentos e cadeias de caracteres de consulta. | string (obrigatório) Restrições: Comprimento mínimo = 1 Comprimento máximo = 2000 |
| nome de utilizador | Nome de usuário para se conectar ao servidor WebProxy | string |
BackendTlsProperties
| Designação | Descrição | Valor |
|---|---|---|
| validateCertificateChain | Sinalizador que indica se a validação da cadeia de certificados SSL deve ser feita ao usar certificados autoassinados para esse host de back-end. | Bool |
| validateCertificateName | Sinalizador que indica se a validação do nome do certificado SSL deve ser feita ao usar certificados autoassinados para esse host de back-end. | Bool |
Definição de recurso de modelo ARM
O tipo de recurso de serviço/back-ends pode ser implantado com operações que visam:
- Grupos de recursos - Consulte comandos de implantação de grupo de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.
Formato do recurso
Para criar um recurso Microsoft.ApiManagement/service/backends, adicione o seguinte JSON ao seu modelo.
{
"type": "Microsoft.ApiManagement/service/backends",
"apiVersion": "2022-08-01",
"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"
}
}
Valores de propriedade
serviço/back-ends
| Designação | Descrição | Valor |
|---|---|---|
| tipo | O tipo de recurso | 'Microsoft.ApiManagement/service/backends' |
| apiVersion | A versão da api de recursos | '2022-08-01' |
| Designação | O nome do recurso Veja como definir nomes e tipos para recursos filho em modelos JSON ARM. |
string (obrigatório) Limite de caracteres: 1-80 Caracteres válidos: Alfanuméricos e hífenes. Comece com letra e termine com alfanumérico. |
| propriedades | Propriedades de contrato de entidade de back-end. | BackendContractProperties |
BackendContractProperties
| Designação | Descrição | Valor |
|---|---|---|
| Credenciais | Propriedades do contrato de credenciais de back-end | BackendCredentialsContract |
| Descrição | Descrição do back-end. | string Restrições: Comprimento mínimo = 1 Comprimento máximo = 2000 |
| propriedades | Contrato de propriedades de back-end | BackendProperties |
| protocolo | Protocolo de comunicação de back-end. | 'http''sabão' (obrigatório) |
| procuração | Propriedades do contrato do gateway de back-end | BackendProxyContract |
| resourceId | Uri de Gestão do Recurso no Sistema Externo. Este URL pode ser o Arm Resource Id de Aplicativos Lógicos, Aplicativos de Função ou Aplicativos de API. | string Restrições: Comprimento mínimo = 1 Comprimento máximo = 2000 |
| título | Título de back-end. | string Restrições: Comprimento mínimo = 1 Comprimento máximo = 300 |
| TLS | Propriedades TLS de back-end | BackendTlsProperties |
| URL | url de tempo de execução do back-end. | string (obrigatório) Restrições: Comprimento mínimo = 1 Comprimento máximo = 2000 |
BackendCredentialsContract
BackendAuthorizationHeaderCredentials
| Designação | Descrição | Valor |
|---|---|---|
| parâmetro | Valor do parâmetro de autenticação. | string (obrigatório) Restrições: Comprimento mínimo = 1 Comprimento máximo = 300 |
| Regime | Nome do esquema de autenticação. | string (obrigatório) Restrições: Comprimento mínimo = 1 Comprimento máximo = 100 |
BackendCredentialsContractHeader
| Designação | Descrição | Valor |
|---|---|---|
| {propriedade personalizada} | string[] |
BackendCredentialsContractQuery
| Designação | Descrição | Valor |
|---|---|---|
| {propriedade personalizada} | string[] |
BackendProperties
| Designação | Descrição | Valor |
|---|---|---|
| serviceFabricCluster | Propriedades do cluster do Backend Service Fabric | BackendServiceFabricClusterProperties |
BackendServiceFabricClusterProperties
| Designação | Descrição | Valor |
|---|---|---|
| clientCertificateId | A ID do certificado do cliente para o ponto de extremidade de gerenciamento. | string |
| clientCertificateimpressão digital | A impressão digital do certificado do cliente para o ponto de extremidade de gerenciamento. Será ignorado se certificatesIds forem fornecidos | string |
| gerenciamentoPontos finais | O ponto de extremidade de gerenciamento de cluster. | string[] (obrigatório) |
| maxPartitionResolutionRetries | Número máximo de tentativas ao tentar resolver a partição. | Int |
| serverCertificateImpressões digitais | Impressões digitais de certificados que o serviço de gerenciamento de cluster usa para comunicação tls | string[] |
| serverX509Nomes | Coleção de Nomes de Certificados X509 do Servidor | X509CertificateName[] |
X509CertificateName
| Designação | Descrição | Valor |
|---|---|---|
| emissorCertificadoImpressão digital | Impressão digital para o emissor do certificado. | string |
| Designação | Nome comum do certificado. | string |
BackendProxyContract
| Designação | Descrição | Valor |
|---|---|---|
| palavra-passe | Senha para se conectar ao WebProxy Server | string |
| URL | Propriedade WebProxy Server AbsoluteUri que inclui todo o URI armazenado na instância de Uri, incluindo todos os fragmentos e cadeias de caracteres de consulta. | string (obrigatório) Restrições: Comprimento mínimo = 1 Comprimento máximo = 2000 |
| nome de utilizador | Nome de usuário para se conectar ao servidor WebProxy | string |
BackendTlsProperties
| Designação | Descrição | Valor |
|---|---|---|
| validateCertificateChain | Sinalizador que indica se a validação da cadeia de certificados SSL deve ser feita ao usar certificados autoassinados para esse host de back-end. | Bool |
| validateCertificateName | Sinalizador que indica se a validação do nome do certificado SSL deve ser feita ao usar certificados autoassinados para esse host de back-end. | Bool |
Definição de recursos Terraform (provedor AzAPI)
O tipo de recurso de serviço/back-ends pode ser implantado com operações que visam:
- Grupos de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.
Formato do recurso
Para criar um recurso Microsoft.ApiManagement/service/backends, adicione o seguinte Terraform ao seu modelo.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/backends@2022-08-01"
name = "string"
parent_id = "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"
}
})
}
Valores de propriedade
serviço/back-ends
| Designação | Descrição | Valor |
|---|---|---|
| tipo | O tipo de recurso | "Microsoft.ApiManagement/service/backends@2022-08-01" |
| Designação | O nome do recurso | string (obrigatório) Limite de caracteres: 1-80 Caracteres válidos: Alfanuméricos e hífenes. Comece com letra e termine com alfanumérico. |
| parent_id | A ID do recurso que é o pai para este recurso. | ID do recurso do tipo: serviço |
| propriedades | Propriedades de contrato de entidade de back-end. | BackendContractProperties |
BackendContractProperties
| Designação | Descrição | Valor |
|---|---|---|
| Credenciais | Propriedades do contrato de credenciais de back-end | BackendCredentialsContract |
| Descrição | Descrição do back-end. | string Restrições: Comprimento mínimo = 1 Comprimento máximo = 2000 |
| propriedades | Contrato de propriedades de back-end | BackendProperties |
| protocolo | Protocolo de comunicação de back-end. | "http""sabão" (obrigatório) |
| procuração | Propriedades do contrato do gateway de back-end | BackendProxyContract |
| resourceId | Uri de Gestão do Recurso no Sistema Externo. Este URL pode ser o Arm Resource Id de Aplicativos Lógicos, Aplicativos de Função ou Aplicativos de API. | string Restrições: Comprimento mínimo = 1 Comprimento máximo = 2000 |
| título | Título de back-end. | string Restrições: Comprimento mínimo = 1 Comprimento máximo = 300 |
| TLS | Propriedades TLS de back-end | BackendTlsProperties |
| URL | url de tempo de execução do back-end. | string (obrigatório) Restrições: Comprimento mínimo = 1 Comprimento máximo = 2000 |
BackendCredentialsContract
BackendAuthorizationHeaderCredentials
| Designação | Descrição | Valor |
|---|---|---|
| parâmetro | Valor do parâmetro de autenticação. | string (obrigatório) Restrições: Comprimento mínimo = 1 Comprimento máximo = 300 |
| Regime | Nome do esquema de autenticação. | string (obrigatório) Restrições: Comprimento mínimo = 1 Comprimento máximo = 100 |
BackendCredentialsContractHeader
| Designação | Descrição | Valor |
|---|---|---|
| {propriedade personalizada} | string[] |
BackendCredentialsContractQuery
| Designação | Descrição | Valor |
|---|---|---|
| {propriedade personalizada} | string[] |
BackendProperties
| Designação | Descrição | Valor |
|---|---|---|
| serviceFabricCluster | Propriedades do cluster do Backend Service Fabric | BackendServiceFabricClusterProperties |
BackendServiceFabricClusterProperties
| Designação | Descrição | Valor |
|---|---|---|
| clientCertificateId | A ID do certificado do cliente para o ponto de extremidade de gerenciamento. | string |
| clientCertificateimpressão digital | A impressão digital do certificado do cliente para o ponto de extremidade de gerenciamento. Será ignorado se certificatesIds forem fornecidos | string |
| gerenciamentoPontos finais | O ponto de extremidade de gerenciamento de cluster. | string[] (obrigatório) |
| maxPartitionResolutionRetries | Número máximo de tentativas ao tentar resolver a partição. | Int |
| serverCertificateImpressões digitais | Impressões digitais de certificados que o serviço de gerenciamento de cluster usa para comunicação tls | string[] |
| serverX509Nomes | Coleção de Nomes de Certificados X509 do Servidor | X509CertificateName[] |
X509CertificateName
| Designação | Descrição | Valor |
|---|---|---|
| emissorCertificadoImpressão digital | Impressão digital para o emissor do certificado. | string |
| Designação | Nome comum do certificado. | string |
BackendProxyContract
| Designação | Descrição | Valor |
|---|---|---|
| palavra-passe | Senha para se conectar ao WebProxy Server | string |
| URL | Propriedade WebProxy Server AbsoluteUri que inclui todo o URI armazenado na instância de Uri, incluindo todos os fragmentos e cadeias de caracteres de consulta. | string (obrigatório) Restrições: Comprimento mínimo = 1 Comprimento máximo = 2000 |
| nome de utilizador | Nome de usuário para se conectar ao servidor WebProxy | string |
BackendTlsProperties
| Designação | Descrição | Valor |
|---|---|---|
| validateCertificateChain | Sinalizador que indica se a validação da cadeia de certificados SSL deve ser feita ao usar certificados autoassinados para esse host de back-end. | Bool |
| validateCertificateName | Sinalizador que indica se a validação do nome do certificado SSL deve ser feita ao usar certificados autoassinados para esse host de back-end. | Bool |