Service/back-ends Microsoft.ApiManagement 2021-04-01-preview

  • Article

Définition de ressource Bicep

Le type de ressource service/back-end peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.ApiManagement/service/backends, ajoutez le Bicep suivant à votre modèle.

resource symbolicname 'Microsoft.ApiManagement/service/backends@2021-04-01-preview' = {
  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'
  }
}

Valeurs de propriétés

service/backends

Nom Description Valeur
name Nom de la ressource

Découvrez comment définir des noms et des types pour des ressources enfants dans Bicep.		 chaîne (obligatoire)

Limite de caractères : 1-80

Caractères valides :
Caractères alphanumériques et traits d’union.

Doit commencer par une lettre et se terminer par un caractère alphanumérique.
parent Dans Bicep, vous pouvez spécifier la ressource parente pour une ressource enfant. Vous devez uniquement ajouter cette propriété lorsque la ressource enfant est déclarée en dehors de la ressource parente.

Pour plus d’informations, consultez Ressource enfant en dehors de la ressource parente.		 Nom symbolique de la ressource de type : service
properties Propriétés du contrat d’entité back-end. BackendContractProperties

BackendContractProperties

Nom Description Valeur
credentials Propriétés du contrat d’informations d’identification back-end BackendCredentialsContract
description Description du back-end. string
properties Contrat de propriétés du back-end BackendProperties
protocol Protocole de communication back-end. 'http'
'soap' (obligatoire)
proxy Propriétés du contrat de proxy principal BackendProxyContract
resourceId URI de gestion de la ressource dans le système externe. Cette URL peut être l’ID de ressource Arm des applications logiques, des applications de fonction ou des applications API. string
title Titre du back-end. string
Tls Propriétés TLS du back-end BackendTlsProperties
url URL d’exécution du serveur principal. chaîne (obligatoire)

BackendCredentialsContract

Nom Description Valeur
autorisation Authentification de l’en-tête d’autorisation BackendAuthorizationHeaderCredentials
certificat Liste des empreintes de certificat client. Sera ignoré si des id de certificats sont fournis. string[]
certificateIds Liste des ID de certificat client. string[]
en-tête Description du paramètre d’en-tête. BackendCredentialsContractHeader
query Description du paramètre de requête. BackendCredentialsContractQuery

BackendAuthorizationHeaderCredentials

Nom Description Valeur
paramètre Valeur du paramètre d’authentification. chaîne (obligatoire)
scheme Nom du schéma d’authentification. string (obligatoire)

BackendCredentialsContractHeader

Nom Description Valeur
{propriété personnalisée} string[]

BackendCredentialsContractQuery

Nom Description Valeur
{propriété personnalisée} string[]

BackendProperties

Nom Description Valeur
serviceFabricCluster Propriétés du cluster Service Fabric principal BackendServiceFabricClusterProperties

BackendServiceFabricClusterProperties

Nom Description Valeur
clientCertificateId ID de certificat client pour le point de terminaison de gestion. string
clientCertificatethumbprint Empreinte numérique du certificat client pour le point de terminaison de gestion. Sera ignoré si des id de certificats sont fournis string
managementEndpoints Point de terminaison de gestion du cluster. string[] (obligatoire)
maxPartitionResolutionRetries Nombre maximal de nouvelles tentatives lors de la tentative de résolution de la partition. int
serverCertificateThumbprints Empreintes numériques des certificats que le service de gestion de cluster utilise pour la communication tls string[]
serverX509Names Collection de noms de certificats Server X509 X509CertificateName[]

X509CertificateName

Nom Description Valeur
issuerCertificateThumbprint Empreinte numérique de l’émetteur du certificat. string
name Nom commun du certificat. string

BackendProxyContract

Nom Description Valeur
mot de passe Mot de passe pour se connecter au serveur WebProxy string
url Propriété AbsoluteUri du serveur WebProxy qui inclut l’URI entier stocké dans le instance URI, y compris tous les fragments et chaînes de requête. string (obligatoire)
username Nom d’utilisateur pour se connecter au serveur WebProxy string

BackendTlsProperties

Nom Description Valeur
validateCertificateChain Indicateur indiquant si la validation de la chaîne de certificats SSL doit être effectuée lors de l’utilisation de certificats auto-signés pour cet hôte principal. bool
validateCertificateName Indicateur indiquant si la validation du nom de certificat SSL doit être effectuée lors de l’utilisation de certificats auto-signés pour cet hôte principal. bool

Définition de ressources de modèle ARM

Le type de ressource service/back-end peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version d’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.ApiManagement/service/backends, ajoutez le json suivant à votre modèle.

{
  "type": "Microsoft.ApiManagement/service/backends",
  "apiVersion": "2021-04-01-preview",
  "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"
  }
}

Valeurs de propriétés

service/backends

Nom Description Valeur
type Type de ressource « Microsoft.ApiManagement/service/backends »
apiVersion Version de l’API de ressource '2021-04-01-preview'
name Nom de la ressource

Découvrez comment définir des noms et des types pour des ressources enfants dans des modèles ARM JSON.		 string (obligatoire)

Limite de caractères : 1-80

Caractères valides :
Caractères alphanumériques et traits d’union.

Doit commencer par une lettre et se terminer par un caractère alphanumérique.
properties Propriétés du contrat d’entité back-end. BackendContractProperties

BackendContractProperties

Nom Description Valeur
credentials Propriétés du contrat d’informations d’identification back-end BackendCredentialsContract
description Description du back-end. string
properties Contrat de propriétés du back-end BackendProperties
protocol Protocole de communication back-end. 'http'
'soap' (obligatoire)
proxy Propriétés du contrat de proxy principal BackendProxyContract
resourceId URI de gestion de la ressource dans le système externe. Cette URL peut être l’ID de ressource Arm des applications logiques, des applications de fonction ou des applications API. string
title Titre du back-end. string
Tls Propriétés TLS du back-end BackendTlsProperties
url URL d’exécution du serveur principal. chaîne (obligatoire)

BackendCredentialsContract

Nom Description Valeur
autorisation Authentification de l’en-tête d’autorisation BackendAuthorizationHeaderCredentials
certificat Liste des empreintes de certificat client. Sera ignoré si des id de certificats sont fournis. string[]
certificateIds Liste des ID de certificat client. string[]
en-tête Description du paramètre d’en-tête. BackendCredentialsContractHeader
query Description du paramètre de requête. BackendCredentialsContractQuery

BackendAuthorizationHeaderCredentials

Nom Description Valeur
paramètre Valeur du paramètre d’authentification. chaîne (obligatoire)
scheme Nom du schéma d’authentification. chaîne (obligatoire)

BackendCredentialsContractHeader

Nom Description Valeur
{propriété personnalisée} string[]

BackendCredentialsContractQuery

Nom Description Valeur
{propriété personnalisée} string[]

BackendProperties

Nom Description Valeur
serviceFabricCluster Propriétés du cluster Service Fabric principal BackendServiceFabricClusterProperties

BackendServiceFabricClusterProperties

Nom Description Valeur
clientCertificateId ID de certificat client pour le point de terminaison de gestion. string
clientCertificatethumbprint Empreinte du certificat client pour le point de terminaison de gestion. Sera ignoré si des id de certificats sont fournis string
managementEndpoints Point de terminaison de gestion du cluster. string[] (obligatoire)
maxPartitionResolutionRetries Nombre maximal de nouvelles tentatives lors de la tentative de résolution de la partition. int
serverCertificateThumbprints Utilisations des empreintes numériques du service de gestion de cluster de certificats pour la communication TLS string[]
serverX509Names Collection de noms de certificats Server X509 X509CertificateName[]

X509CertificateName

Nom Description Valeur
issuerCertificateThumbprint Empreinte numérique de l’émetteur du certificat. string
name Nom commun du certificat. string

BackendProxyContract

Nom Description Valeur
mot de passe Mot de passe pour se connecter au serveur WebProxy string
url Propriété AbsoluteUri du serveur WebProxy qui inclut l’URI entier stocké dans le instance URI, y compris tous les fragments et chaînes de requête. chaîne (obligatoire)
username Nom d’utilisateur pour se connecter au serveur WebProxy string

BackendTlsProperties

Nom Description Valeur
validateCertificateChain Indicateur indiquant si la validation de la chaîne de certificats SSL doit être effectuée lors de l’utilisation de certificats auto-signés pour cet hôte principal. bool
validateCertificateName Indicateur indiquant si la validation du nom de certificat SSL doit être effectuée lors de l’utilisation de certificats auto-signés pour cet hôte principal. bool

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource service/back-end peut être déployé avec des opérations qui ciblent :

  • Groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.ApiManagement/service/backends, ajoutez le Terraform suivant à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/backends@2021-04-01-preview"
  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"
    }
  })
}

Valeurs de propriétés

service/backends

Nom Description Valeur
type Type de ressource « Microsoft.ApiManagement/service/backends@2021-04-01-preview »
name Nom de la ressource chaîne (obligatoire)

Limite de caractères : 1-80

Caractères valides :
Caractères alphanumériques et traits d’union.

Doit commencer par une lettre et se terminer par un caractère alphanumérique.
parent_id ID de la ressource qui est le parent de cette ressource. ID pour la ressource de type : service
properties Propriétés du contrat d’entité back-end. BackendContractProperties

BackendContractProperties

Nom Description Valeur
credentials Propriétés du contrat d’informations d’identification back-end BackendCredentialsContract
description Description du back-end. string
properties Contrat de propriétés du back-end BackendProperties
protocol Protocole de communication back-end. « http »
« soap » (obligatoire)
proxy Propriétés du contrat de proxy principal BackendProxyContract
resourceId URI de gestion de la ressource dans le système externe. Cette URL peut être l’ID de ressource Arm des applications logiques, des applications de fonction ou des applications API. string
title Titre du back-end. string
Tls Propriétés TLS du back-end BackendTlsProperties
url URL d’exécution du serveur principal. chaîne (obligatoire)

BackendCredentialsContract

Nom Description Valeur
autorisation Authentification de l’en-tête d’autorisation BackendAuthorizationHeaderCredentials
certificat Liste des empreintes de certificat client. Sera ignoré si des id de certificats sont fournis. string[]
certificateIds Liste des ID de certificat client. string[]
en-tête Description du paramètre d’en-tête. BackendCredentialsContractHeader
query Description du paramètre de requête. BackendCredentialsContractQuery

BackendAuthorizationHeaderCredentials

Nom Description Valeur
paramètre Valeur du paramètre d’authentification. chaîne (obligatoire)
scheme Nom du schéma d’authentification. chaîne (obligatoire)

BackendCredentialsContractHeader

Nom Description Valeur
{propriété personnalisée} string[]

BackendCredentialsContractQuery

Nom Description Valeur
{propriété personnalisée} string[]

BackendProperties

Nom Description Valeur
serviceFabricCluster Propriétés du cluster Service Fabric principal BackendServiceFabricClusterProperties

BackendServiceFabricClusterProperties

Nom Description Valeur
clientCertificateId ID de certificat client pour le point de terminaison de gestion. string
clientCertificatethumbprint Empreinte du certificat client pour le point de terminaison de gestion. Sera ignoré si des id de certificats sont fournis string
managementEndpoints Point de terminaison de gestion du cluster. string[] (obligatoire)
maxPartitionResolutionRetries Nombre maximal de nouvelles tentatives lors de la tentative de résolution de la partition. int
serverCertificateThumbprints Utilisations des empreintes numériques du service de gestion de cluster de certificats pour la communication TLS string[]
serverX509Names Collection de noms de certificats Server X509 X509CertificateName[]

X509CertificateName

Nom Description Valeur
issuerCertificateThumbprint Empreinte numérique de l’émetteur du certificat. string
name Nom commun du certificat. string

BackendProxyContract

Nom Description Valeur
mot de passe Mot de passe pour se connecter au serveur WebProxy string
url Propriété AbsoluteUri du serveur WebProxy qui inclut l’URI entier stocké dans le instance URI, y compris tous les fragments et chaînes de requête. chaîne (obligatoire)
username Nom d’utilisateur pour se connecter au serveur WebProxy string

BackendTlsProperties

Nom Description Valeur
validateCertificateChain Indicateur indiquant si la validation de la chaîne de certificats SSL doit être effectuée lors de l’utilisation de certificats auto-signés pour cet hôte principal. bool
validateCertificateName Indicateur indiquant si la validation du nom de certificat SSL doit être effectuée lors de l’utilisation de certificats auto-signés pour cet hôte principal. bool