Compartir a través de

Servicio Microsoft.ApiManagement/backends 2022-08-01

  • Artículo

Definición de recursos de Bicep

El tipo de recurso service/backends se puede implementar con operaciones que tienen como destino:

Para obtener una lista de las propiedades modificadas en cada versión de api, consulte registro de cambios.

Formato de los recursos

Para crear un recurso Microsoft.ApiManagement/service/backends, agregue el siguiente bicep a la plantilla.

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 propiedad

service/backends

Nombre Descripción Value
name El nombre del recurso

Vea cómo establecer nombres y tipos para recursos secundarios en Bicep.		 string (obligatorio)

Límite de caracteres: 1-80

Caracteres válidos:
Caracteres alfanuméricos y guiones.

Comience con una letra y termine con un carácter alfanumérico.
primario En Bicep, puede especificar el recurso primario para un recurso secundario. Solo tiene que agregar esta propiedad cuando el recurso secundario se declara fuera del recurso primario.

Para más información, consulte Recurso secundario fuera del recurso primario.		 Nombre simbólico del recurso de tipo: servicio
properties Propiedades del contrato de entidad de back-end. BackendContractProperties

BackendContractProperties

Nombre Descripción Valor
credentials Propiedades del contrato de credenciales de back-end BackendCredentialsContract
description Descripción del back-end. string
properties Contrato de propiedades de back-end BackendProperties
protocol Protocolo de comunicación de back-end. 'http'
'soap' (obligatorio)
proxy Propiedades del contrato de puerta de enlace de back-end BackendProxyContract
resourceId URI de administración del recurso en sistema externo. Esta dirección URL puede ser el identificador de recurso arm de Logic Apps, Function Apps o API Apps. string
title Título del back-end. string
Tls Propiedades de TLS de back-end BackendTlsProperties
url Dirección URL del entorno de ejecución del back-end. string (obligatorio)

BackendCredentialsContract

Nombre Descripción Valor
authorization Autenticación del encabezado de autorización BackendAuthorizationHeaderCredentials
certificado Lista de huellas digitales de certificado de cliente. Se omitirá si se proporcionan certificatesIds. string[]
certificateIds Lista de identificadores de certificado de cliente. string[]
header Descripción del parámetro de encabezado. BackendCredentialsContractHeader
Query Descripción del parámetro de consulta. BackendCredentialsContractQuery

BackendAuthorizationHeaderCredentials

Nombre Descripción Valor
parámetro Valor del parámetro de autenticación. string (obligatorio)
scheme Nombre del esquema de autenticación. string (obligatorio)

BackendCredentialsContractHeader

Nombre Descripción Valor
{propiedad personalizada} string[]

BackendCredentialsContractQuery

Nombre Descripción Valor
{propiedad personalizada} string[]

BackendProperties

Nombre Descripción Valor
serviceFabricCluster Propiedades del clúster de Service Fabric de back-end BackendServiceFabricClusterProperties

BackendServiceFabricClusterProperties

Nombre Descripción Valor
clientCertificateId Identificador de certificado de cliente para el punto de conexión de administración. string
clientCertificatethumbprint Huella digital del certificado de cliente para el punto de conexión de administración. Se omitirá si se proporcionan certificatesIds. string
managementEndpoints Punto de conexión de administración del clúster. string[] (obligatorio)
maxPartitionResolutionRetries Número máximo de reintentos al intentar resolver la partición. int
serverCertificateThumbprints Huellas digitales del servicio de administración de clústeres de certificados usa para la comunicación tls string[]
serverX509Names Colección Server X509 Certificate Names X509CertificateName[]

X509CertificateName

Nombre Descripción Valor
issuerCertificateThumbprint Huella digital del emisor del certificado. string
name Nombre común del certificado. string

BackendProxyContract

Nombre Descripción Valor
password Contraseña para conectarse al servidor WebProxy string
url Propiedad AbsoluteUri del servidor WebProxy que incluye todo el URI almacenado en la instancia de Uri, incluidos todos los fragmentos y cadenas de consulta. string (obligatorio)
username Nombre de usuario para conectarse al servidor WebProxy string

BackendTlsProperties

Nombre Descripción Valor
validateCertificateChain Marca que indica si se debe realizar la validación de la cadena de certificados SSL al usar certificados autofirmados para este host de back-end. bool
validateCertificateName Marca que indica si se debe realizar la validación del nombre del certificado SSL al usar certificados autofirmados para este host de back-end. bool

Definición de recursos de plantilla de ARM

El tipo de recurso service/backends se puede implementar con operaciones que tienen como destino:

Para obtener una lista de las propiedades modificadas en cada versión de api, consulte registro de cambios.

Formato de los recursos

Para crear un recurso Microsoft.ApiManagement/service/backends, agregue el siguiente json a la plantilla.

{
  "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 propiedad

service/backends

Nombre Descripción Value
type Tipo de recurso "Microsoft.ApiManagement/service/backends"
apiVersion La versión de la API de recursos '2022-08-01'
name El nombre del recurso

Consulte cómo establecer nombres y tipos para recursos secundarios en plantillas de ARM json.		 string (obligatorio)

Límite de caracteres: 1-80

Caracteres válidos:
Caracteres alfanuméricos y guiones.

Comience con una letra y termine con un carácter alfanumérico.
properties Propiedades del contrato de entidad de back-end. BackendContractProperties

BackendContractProperties

Nombre Descripción Valor
credentials Propiedades del contrato de credenciales de back-end BackendCredentialsContract
description Descripción del back-end. string
properties Contrato de propiedades de back-end BackendProperties
protocol Protocolo de comunicación back-end. 'http'
'soap' (obligatorio)
proxy Propiedades del contrato de puerta de enlace de back-end BackendProxyContract
resourceId Uri de administración del recurso en sistema externo. Esta dirección URL puede ser el identificador de recurso de Arm de Logic Apps, Function Apps o API Apps. string
title Título del back-end. string
Tls Propiedades de TLS de back-end BackendTlsProperties
url Dirección URL del entorno de ejecución del back-end. string (obligatorio)

BackendCredentialsContract

Nombre Descripción Valor
authorization Autenticación de encabezado de autorización BackendAuthorizationHeaderCredentials
certificado Lista de huellas digitales de certificado de cliente. Se omitirá si se proporcionan certificatesIds. string[]
certificateIds Lista de identificadores de certificado de cliente. string[]
header Descripción del parámetro de encabezado. BackendCredentialsContractHeader
Query Descripción del parámetro de consulta. BackendCredentialsContractQuery

BackendAuthorizationHeaderCredentials

Nombre Descripción Valor
parámetro Valor del parámetro de autenticación. string (obligatorio)
scheme Nombre del esquema de autenticación. string (obligatorio)

BackendCredentialsContractHeader

Nombre Descripción Valor
{propiedad personalizada} string[]

BackendCredentialsContractQuery

Nombre Descripción Valor
{propiedad personalizada} string[]

BackendProperties

Nombre Descripción Valor
serviceFabricCluster Propiedades del clúster de Service Fabric de back-end BackendServiceFabricClusterProperties

BackendServiceFabricClusterProperties

Nombre Descripción Valor
clientCertificateId Identificador de certificado de cliente para el punto de conexión de administración. string
clientCertificatethumbprint Huella digital del certificado de cliente para el punto de conexión de administración. Se omitirá si se proporcionan certificatesIds. string
managementEndpoints Punto de conexión de administración del clúster. string[] (obligatorio)
maxPartitionResolutionRetries Número máximo de reintentos al intentar resolver la partición. int
serverCertificateThumbprints Huellas digitales del servicio de administración de clústeres de certificados usa para la comunicación tls string[]
serverX509Names Colección Server X509 Certificate Names X509CertificateName[]

X509CertificateName

Nombre Descripción Valor
issuerCertificateThumbprint Huella digital del emisor del certificado. string
name Nombre común del certificado. string

BackendProxyContract

Nombre Descripción Valor
password Contraseña para conectarse al servidor WebProxy string
url Propiedad AbsoluteUri del servidor WebProxy que incluye todo el URI almacenado en la instancia de Uri, incluidos todos los fragmentos y cadenas de consulta. string (obligatorio)
username Nombre de usuario para conectarse al servidor WebProxy string

BackendTlsProperties

Nombre Descripción Valor
validateCertificateChain Marca que indica si se debe realizar la validación de la cadena de certificados SSL al usar certificados autofirmados para este host de back-end. bool
validateCertificateName Marca que indica si se debe realizar la validación del nombre del certificado SSL al usar certificados autofirmados para este host de back-end. bool

Definición de recursos de Terraform (proveedor AzAPI)

El tipo de recurso service/backends se puede implementar con operaciones que tienen como destino:

  • Grupos de recursos

Para obtener una lista de las propiedades modificadas en cada versión de api, consulte registro de cambios.

Formato de los recursos

Para crear un recurso Microsoft.ApiManagement/service/backends, agregue el siguiente terraform a la plantilla.

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 propiedad

service/backends

Nombre Descripción Value
type Tipo de recurso "Microsoft.ApiManagement/service/backends@2022-08-01"
name El nombre del recurso string (obligatorio)

Límite de caracteres: 1-80

Caracteres válidos:
Caracteres alfanuméricos y guiones.

Comience con una letra y termine con un carácter alfanumérico.
parent_id Identificador del recurso que es el elemento primario de este recurso. Identificador del recurso de tipo: servicio
properties Propiedades del contrato de entidad de back-end. BackendContractProperties

BackendContractProperties

Nombre Descripción Valor
credentials Propiedades del contrato de credenciales de back-end BackendCredentialsContract
description Descripción del back-end. string
properties Contrato de propiedades de back-end BackendProperties
protocol Protocolo de comunicación de back-end. "http"
"soap" (obligatorio)
proxy Propiedades del contrato de puerta de enlace de back-end BackendProxyContract
resourceId URI de administración del recurso en sistema externo. Esta dirección URL puede ser el identificador de recurso arm de Logic Apps, Function Apps o API Apps. string
title Título del back-end. string
Tls Propiedades de TLS de back-end BackendTlsProperties
url Dirección URL del entorno de ejecución del back-end. string (obligatorio)

BackendCredentialsContract

Nombre Descripción Valor
authorization Autenticación del encabezado de autorización BackendAuthorizationHeaderCredentials
certificado Lista de huellas digitales de certificado de cliente. Se omitirá si se proporcionan certificatesIds. string[]
certificateIds Lista de identificadores de certificado de cliente. string[]
header Descripción del parámetro de encabezado. BackendCredentialsContractHeader
Query Descripción del parámetro de consulta. BackendCredentialsContractQuery

BackendAuthorizationHeaderCredentials

Nombre Descripción Valor
parámetro Valor del parámetro de autenticación. string (obligatorio)
scheme Nombre del esquema de autenticación. string (obligatorio)

BackendCredentialsContractHeader

Nombre Descripción Valor
{propiedad personalizada} string[]

BackendCredentialsContractQuery

Nombre Descripción Valor
{propiedad personalizada} string[]

BackendProperties

Nombre Descripción Valor
serviceFabricCluster Propiedades del clúster de Service Fabric de back-end BackendServiceFabricClusterProperties

BackendServiceFabricClusterProperties

Nombre Descripción Valor
clientCertificateId Identificador de certificado de cliente para el punto de conexión de administración. string
clientCertificatethumbprint Huella digital del certificado de cliente para el punto de conexión de administración. Se omitirá si se proporcionan certificatesIds. string
managementEndpoints Punto de conexión de administración del clúster. string[] (obligatorio)
maxPartitionResolutionRetries Número máximo de reintentos al intentar resolver la partición. int
serverCertificateThumbprints Huellas digitales del servicio de administración de clústeres de certificados usa para la comunicación tls string[]
serverX509Names Colección Server X509 Certificate Names X509CertificateName[]

X509CertificateName

Nombre Descripción Valor
issuerCertificateThumbprint Huella digital del emisor del certificado. string
name Nombre común del certificado. string

BackendProxyContract

Nombre Descripción Valor
password Contraseña para conectarse al servidor WebProxy string
url Propiedad AbsoluteUri del servidor WebProxy que incluye todo el URI almacenado en la instancia de Uri, incluidos todos los fragmentos y cadenas de consulta. string (obligatorio)
username Nombre de usuario para conectarse al servidor WebProxy string

BackendTlsProperties

Nombre Descripción Valor
validateCertificateChain Marca que indica si se debe realizar la validación de la cadena de certificados SSL al usar certificados autofirmados para este host de back-end. bool
validateCertificateName Marca que indica si se debe realizar la validación del nombre del certificado SSL al usar certificados autofirmados para este host de back-end. bool