Servicio Microsoft.ApiManagement/backends 2021-08-01

• más reciente
• 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

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' = {
  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'
  }
}

Valores de propiedad

BackendAuthorizationHeaderCredentials

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

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 = 1
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 = 1
título	Título de back-end.	cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 1
tls	Propiedades tls de back-end	backendTlsProperties
URL	Dirección URL en tiempo de ejecución del back-end.	cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 1 (obligatorio)

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[]
certificateIds	Lista de identificadores de certificado de cliente.	string[]
encabezado	Descripción del parámetro de encabezado.	backendCredentialsContractHeader
consulta	Descripción del parámetro de consulta.	backendCredentialsContractQuery

BackendCredentialsContractHeader

Nombre	Descripción	Valor

BackendCredentialsContractQuery

Nombre	Descripción	Valor

BackendProperties

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

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.	cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 1 (obligatorio)
nombre de usuario	Nombre de usuario para conectarse al servidor WebProxy	cuerda

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[]

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

Microsoft.ApiManagement/service/backends

Nombre	Descripción	Valor
nombre	El nombre del recurso	cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 1 (obligatorio)
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

X509CertificateName

Nombre	Descripción	Valor
issuerCertificateThumbprint	Huella digital del emisor del certificado.	cuerda
nombre	Nombre común del certificado.	cuerda

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

BackendAuthorizationHeaderCredentials

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

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 = 1
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 = 1
título	Título de back-end.	cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 1
tls	Propiedades tls de back-end	backendTlsProperties
URL	Dirección URL en tiempo de ejecución del back-end.	cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 1 (obligatorio)

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[]
certificateIds	Lista de identificadores de certificado de cliente.	string[]
encabezado	Descripción del parámetro de encabezado.	backendCredentialsContractHeader
consulta	Descripción del parámetro de consulta.	backendCredentialsContractQuery

BackendCredentialsContractHeader

Nombre	Descripción	Valor

BackendCredentialsContractQuery

Nombre	Descripción	Valor

BackendProperties

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

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.	cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 1 (obligatorio)
nombre de usuario	Nombre de usuario para conectarse al servidor WebProxy	cuerda

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[]

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

Microsoft.ApiManagement/service/backends

Nombre	Descripción	Valor
apiVersion	La versión de api	'2021-08-01'
nombre	El nombre del recurso	cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 1 (obligatorio)
Propiedades	Propiedades del contrato de entidad de back-end.	BackendContractProperties
tipo	El tipo de recurso	"Microsoft.ApiManagement/service/backends"

X509CertificateName

Nombre	Descripción	Valor
issuerCertificateThumbprint	Huella digital del emisor del certificado.	cuerda
nombre	Nombre común del certificado.	cuerda

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

BackendAuthorizationHeaderCredentials

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

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 = 1
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 = 1
título	Título de back-end.	cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 1
tls	Propiedades tls de back-end	backendTlsProperties
URL	Dirección URL en tiempo de ejecución del back-end.	cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 1 (obligatorio)

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[]
certificateIds	Lista de identificadores de certificado de cliente.	string[]
encabezado	Descripción del parámetro de encabezado.	backendCredentialsContractHeader
consulta	Descripción del parámetro de consulta.	backendCredentialsContractQuery

BackendCredentialsContractHeader

Nombre	Descripción	Valor

BackendCredentialsContractQuery

Nombre	Descripción	Valor

BackendProperties

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

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.	cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 1 (obligatorio)
nombre de usuario	Nombre de usuario para conectarse al servidor WebProxy	cuerda

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[]

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

Microsoft.ApiManagement/service/backends

Nombre	Descripción	Valor
nombre	El nombre del recurso	cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 1 (obligatorio)
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
tipo	El tipo de recurso	"Microsoft.ApiManagement/service/backends@2021-08-01"

X509CertificateName

Nombre	Descripción	Valor
issuerCertificateThumbprint	Huella digital del emisor del certificado.	cuerda
nombre	Nombre común del certificado.	cuerda