Servicio Microsoft.ApiManagement/backends 2021-08-01

Artículo
07/24/2024

Definición de recursos de Bicep

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

grupos de recursos: consulte comandos de implementación de grupos de recursos

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

Formato de recurso

Para crear un recurso Microsoft.ApiManagement/service/backends, agregue lo siguiente a la plantilla de Bicep.

resource symbolicname 'Microsoft.ApiManagement/service/backends@2021-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	Valor
nombre	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 la letra y termine con alfanumérico.
padre	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 obtener más información, consulte recurso secundario fuera del recurso primario.	Nombre simbólico del recurso de tipo: de servicio de
Propiedades	Propiedades del contrato de entidad de back-end.	BackendContractProperties

BackendContractProperties

Nombre	Descripción	Valor
credenciales	Propiedades del contrato de credenciales de back-end	backendCredentialsContract
descripción	Descripción del back-end.	cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 2000
Propiedades	Contrato de propiedades de back-end	backendProperties de
protocolo	Protocolo de comunicación back-end.	'`http`' 'soap' (obligatorio)
proxy	Propiedades del contrato de proxy 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.	cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 2000
título	Título de back-end.	cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 300
tls	Propiedades tls de back-end	backendTlsProperties
URL	Dirección URL en tiempo de ejecución del back-end.	string (obligatorio) Restricciones: Longitud mínima = 1 Longitud máxima = 2000

BackendCredentialsContract

Nombre	Descripción	Valor
autorización	Autenticación de encabezado de autorización	BackendAuthorizationHeaderCredentials
certificado	Lista de huellas digitales de certificado de cliente. Se omitirá si se proporcionan certificatesIds.	string[] Restricciones: Longitud máxima = 32
certificateIds	Lista de identificadores de certificado de cliente.	string[] Restricciones: Longitud máxima = 32
encabezado	Descripción del parámetro de encabezado.	backendCredentialsContractHeader
consulta	Descripción del parámetro de consulta.	backendCredentialsContractQuery

BackendAuthorizationHeaderCredentials

Nombre	Descripción	Valor
parámetro	Valor del parámetro de autenticación.	string (obligatorio) Restricciones: Longitud mínima = 1 Longitud máxima = 300
esquema	Nombre del esquema de autenticación.	string (obligatorio) Restricciones: Longitud mínima = 1 Longitud máxima = 100

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.	cuerda
clientCertificatethumbprint	Huella digital del certificado de cliente para el punto de conexión de administración. Se omitirá si se proporcionan certificatesIds.	cuerda
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.	cuerda
nombre	Nombre común del certificado.	cuerda

BackendProxyContract

Nombre	Descripción	Valor
contraseña	Contraseña para conectarse al servidor WebProxy	cuerda
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) Restricciones: Longitud mínima = 1 Longitud máxima = 2000
nombre de usuario	Nombre de usuario para conectarse al servidor WebProxy	cuerda

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:

grupos de recursos: consulte comandos de implementación de grupos de recursos

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

Formato de recurso

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

{
  "type": "Microsoft.ApiManagement/service/backends",
  "apiVersion": "2021-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	Valor
tipo	El tipo de recurso	"Microsoft.ApiManagement/service/backends"
apiVersion	La versión de la API de recursos	'2021-08-01'
nombre	El nombre del recurso Vea 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 la letra y termine con alfanumérico.
Propiedades	Propiedades del contrato de entidad de back-end.	BackendContractProperties

BackendContractProperties

Nombre	Descripción	Valor
credenciales	Propiedades del contrato de credenciales de back-end	backendCredentialsContract
descripción	Descripción del back-end.	cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 2000
Propiedades	Contrato de propiedades de back-end	backendProperties de
protocolo	Protocolo de comunicación back-end.	'`http`' 'soap' (obligatorio)
proxy	Propiedades del contrato de proxy 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.	cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 2000
título	Título de back-end.	cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 300
tls	Propiedades tls de back-end	backendTlsProperties
URL	Dirección URL en tiempo de ejecución del back-end.	string (obligatorio) Restricciones: Longitud mínima = 1 Longitud máxima = 2000

BackendCredentialsContract

Nombre	Descripción	Valor
autorización	Autenticación de encabezado de autorización	BackendAuthorizationHeaderCredentials
certificado	Lista de huellas digitales de certificado de cliente. Se omitirá si se proporcionan certificatesIds.	string[] Restricciones: Longitud máxima = 32
certificateIds	Lista de identificadores de certificado de cliente.	string[] Restricciones: Longitud máxima = 32
encabezado	Descripción del parámetro de encabezado.	backendCredentialsContractHeader
consulta	Descripción del parámetro de consulta.	backendCredentialsContractQuery

BackendAuthorizationHeaderCredentials

Nombre	Descripción	Valor
parámetro	Valor del parámetro de autenticación.	string (obligatorio) Restricciones: Longitud mínima = 1 Longitud máxima = 300
esquema	Nombre del esquema de autenticación.	string (obligatorio) Restricciones: Longitud mínima = 1 Longitud máxima = 100

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.	cuerda
clientCertificatethumbprint	Huella digital del certificado de cliente para el punto de conexión de administración. Se omitirá si se proporcionan certificatesIds.	cuerda
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.	cuerda
nombre	Nombre común del certificado.	cuerda

BackendProxyContract

Nombre	Descripción	Valor
contraseña	Contraseña para conectarse al servidor WebProxy	cuerda
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) Restricciones: Longitud mínima = 1 Longitud máxima = 2000
nombre de usuario	Nombre de usuario para conectarse al servidor WebProxy	cuerda

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 de

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

Formato de recurso

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/backends@2021-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	Valor
tipo	El tipo de recurso	"Microsoft.ApiManagement/service/backends@2021-08-01"
nombre	El nombre del recurso	string (obligatorio) Límite de caracteres: 1-80 Caracteres válidos: Caracteres alfanuméricos y guiones. Comience con la letra y termine con alfanumérico.
parent_id	Identificador del recurso que es el elemento primario de este recurso.	Identificador del recurso de tipo: de servicio de
Propiedades	Propiedades del contrato de entidad de back-end.	BackendContractProperties

BackendContractProperties

Nombre	Descripción	Valor
credenciales	Propiedades del contrato de credenciales de back-end	backendCredentialsContract
descripción	Descripción del back-end.	cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 2000
Propiedades	Contrato de propiedades de back-end	backendProperties de
protocolo	Protocolo de comunicación back-end.	"`http`" "soap" (obligatorio)
proxy	Propiedades del contrato de proxy 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.	cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 2000
título	Título de back-end.	cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 300
tls	Propiedades tls de back-end	backendTlsProperties
URL	Dirección URL en tiempo de ejecución del back-end.	string (obligatorio) Restricciones: Longitud mínima = 1 Longitud máxima = 2000

BackendCredentialsContract

Nombre	Descripción	Valor
autorización	Autenticación de encabezado de autorización	BackendAuthorizationHeaderCredentials
certificado	Lista de huellas digitales de certificado de cliente. Se omitirá si se proporcionan certificatesIds.	string[] Restricciones: Longitud máxima = 32
certificateIds	Lista de identificadores de certificado de cliente.	string[] Restricciones: Longitud máxima = 32
encabezado	Descripción del parámetro de encabezado.	backendCredentialsContractHeader
consulta	Descripción del parámetro de consulta.	backendCredentialsContractQuery

BackendAuthorizationHeaderCredentials

Nombre	Descripción	Valor
parámetro	Valor del parámetro de autenticación.	string (obligatorio) Restricciones: Longitud mínima = 1 Longitud máxima = 300
esquema	Nombre del esquema de autenticación.	string (obligatorio) Restricciones: Longitud mínima = 1 Longitud máxima = 100

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.	cuerda
clientCertificatethumbprint	Huella digital del certificado de cliente para el punto de conexión de administración. Se omitirá si se proporcionan certificatesIds.	cuerda
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.	cuerda
nombre	Nombre común del certificado.	cuerda

BackendProxyContract

Nombre	Descripción	Valor
contraseña	Contraseña para conectarse al servidor WebProxy	cuerda
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) Restricciones: Longitud mínima = 1 Longitud máxima = 2000
nombre de usuario	Nombre de usuario para conectarse al servidor WebProxy	cuerda

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

Compartir a través de

Servicio Microsoft.ApiManagement/backends 2021-08-01

Definición de recursos de Bicep

Formato de recurso

Valores de propiedad

service/backends

BackendContractProperties

BackendCredentialsContract

BackendAuthorizationHeaderCredentials

BackendCredentialsContractHeader

BackendCredentialsContractQuery

BackendProperties

BackendServiceFabricClusterProperties

X509CertificateName

BackendProxyContract

BackendTlsProperties

Definición de recursos de plantilla de ARM

Formato de recurso

Valores de propiedad

service/backends

BackendContractProperties

BackendCredentialsContract

BackendAuthorizationHeaderCredentials

BackendCredentialsContractHeader

BackendCredentialsContractQuery

BackendProperties

BackendServiceFabricClusterProperties

X509CertificateName

BackendProxyContract

BackendTlsProperties

Definición de recursos de Terraform (proveedor AzAPI)

Formato de recurso

Valores de propiedad

service/backends

BackendContractProperties

BackendCredentialsContract

BackendAuthorizationHeaderCredentials

BackendCredentialsContractHeader

BackendCredentialsContractQuery

BackendProperties

BackendServiceFabricClusterProperties

X509CertificateName

BackendProxyContract

BackendTlsProperties

Comentarios

Recursos adicionales