Service Microsoft.ApiManagement/backends 2021-08-01

Article
07/24/2024

Définition de ressource Bicep

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

groupes de ressources - Consultez commandes de déploiement de groupes de ressources

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

Format de ressource

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

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

Valeurs de propriété

service/back-ends

Nom	Description	Valeur
nom	Nom de la ressource Découvrez comment définir des noms et des types pour les ressources enfants dans Bicep.	chaîne (obligatoire) Limite de caractères : 1 à 80 Caractères valides : Alphanumériques et traits d’union. Commencez par la lettre et terminez par alphanumérique.
parent	Dans Bicep, vous pouvez spécifier la ressource parente d’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
Propriétés	Propriétés du contrat d’entité back-end.	BackendContractProperties

BackendContractProperties

Nom	Description	Valeur
Pouvoirs	Propriétés du contrat d’informations d’identification du serveur principal	BackendCredentialsContract
description	Description du back-end.	corde Contraintes: Longueur minimale = 1 Longueur maximale = 2000
Propriétés	Contrat propriétés du back-end	BackendProperties
protocole	Protocole de communication back-end.	'`http`' 'soap' (obligatoire)
procuration	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.	corde Contraintes: Longueur minimale = 1 Longueur maximale = 2000
titre	Titre du back-end.	corde Contraintes: Longueur minimale = 1 Longueur maximale = 300
tls	Propriétés TLS du back-end	BackendTlsProperties
URL	URL du runtime du back-end.	chaîne (obligatoire) Contraintes: Longueur minimale = 1 Longueur maximale = 2000

BackendCredentialsContract

Nom	Description	Valeur
autorisation	Authentification de l’en-tête d’autorisation	BackendAuthorizationHeaderCredentials
certificat	Liste des empreintes de certificat client. Sera ignoré si les certificatesIds sont fournis.	string[] Contraintes: Longueur maximale = 32
certificateIds	Liste des ID de certificat client.	string[] Contraintes: Longueur maximale = 32
en-tête	Description du paramètre d’en-tête.	BackendCredentialsContractHeader
requête	Description du paramètre de requête.	BackendCredentialsContractQuery

BackendAuthorizationHeaderCredentials

Nom	Description	Valeur
paramètre	Valeur du paramètre d’authentification.	chaîne (obligatoire) Contraintes: Longueur minimale = 1 Longueur maximale = 300
schéma	Nom du schéma d’authentification.	chaîne (obligatoire) Contraintes: Longueur minimale = 1 Longueur maximale = 100

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.	corde
clientCertificatethumbprint	Empreinte numérique du certificat client pour le point de terminaison de gestion. Sera ignoré si les certificatesIds sont fournis	corde
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 du service de gestion de cluster de certificats utilisée 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.	corde
nom	Nom commun du certificat.	corde

BackendProxyContract

Nom	Description	Valeur
mot de passe	Mot de passe pour se connecter au serveur WebProxy	corde
URL	Propriété WebProxy Server AbsoluteUri qui inclut l’URI entier stocké dans l’instance d’URI, y compris tous les fragments et chaînes de requête.	chaîne (obligatoire) Contraintes: Longueur minimale = 1 Longueur maximale = 2000
nom d’utilisateur	Nom d’utilisateur pour se connecter au serveur WebProxy	corde

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 de modèle ARM

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

groupes de ressources - Consultez commandes de déploiement de groupes de ressources

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

Format de ressource

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

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

Valeurs de propriété

service/back-ends

Nom	Description	Valeur
type	Type de ressource	'Microsoft.ApiManagement/service/backends'
apiVersion	Version de l’API de ressource	'2021-08-01'
nom	Nom de la ressource Découvrez comment définir des noms et des types pour les ressources enfants dans modèles ARM JSON.	chaîne (obligatoire) Limite de caractères : 1 à 80 Caractères valides : Alphanumériques et traits d’union. Commencez par la lettre et terminez par alphanumérique.
Propriétés	Propriétés du contrat d’entité back-end.	BackendContractProperties

BackendContractProperties

Nom	Description	Valeur
Pouvoirs	Propriétés du contrat d’informations d’identification du serveur principal	BackendCredentialsContract
description	Description du back-end.	corde Contraintes: Longueur minimale = 1 Longueur maximale = 2000
Propriétés	Contrat propriétés du back-end	BackendProperties
protocole	Protocole de communication back-end.	'`http`' 'soap' (obligatoire)
procuration	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.	corde Contraintes: Longueur minimale = 1 Longueur maximale = 2000
titre	Titre du back-end.	corde Contraintes: Longueur minimale = 1 Longueur maximale = 300
tls	Propriétés TLS du back-end	BackendTlsProperties
URL	URL du runtime du back-end.	chaîne (obligatoire) Contraintes: Longueur minimale = 1 Longueur maximale = 2000

BackendCredentialsContract

Nom	Description	Valeur
autorisation	Authentification de l’en-tête d’autorisation	BackendAuthorizationHeaderCredentials
certificat	Liste des empreintes de certificat client. Sera ignoré si les certificatesIds sont fournis.	string[] Contraintes: Longueur maximale = 32
certificateIds	Liste des ID de certificat client.	string[] Contraintes: Longueur maximale = 32
en-tête	Description du paramètre d’en-tête.	BackendCredentialsContractHeader
requête	Description du paramètre de requête.	BackendCredentialsContractQuery

BackendAuthorizationHeaderCredentials

Nom	Description	Valeur
paramètre	Valeur du paramètre d’authentification.	chaîne (obligatoire) Contraintes: Longueur minimale = 1 Longueur maximale = 300
schéma	Nom du schéma d’authentification.	chaîne (obligatoire) Contraintes: Longueur minimale = 1 Longueur maximale = 100

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.	corde
clientCertificatethumbprint	Empreinte numérique du certificat client pour le point de terminaison de gestion. Sera ignoré si les certificatesIds sont fournis	corde
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 du service de gestion de cluster de certificats utilisée 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.	corde
nom	Nom commun du certificat.	corde

BackendProxyContract

Nom	Description	Valeur
mot de passe	Mot de passe pour se connecter au serveur WebProxy	corde
URL	Propriété WebProxy Server AbsoluteUri qui inclut l’URI entier stocké dans l’instance d’URI, y compris tous les fragments et chaînes de requête.	chaîne (obligatoire) Contraintes: Longueur minimale = 1 Longueur maximale = 2000
nom d’utilisateur	Nom d’utilisateur pour se connecter au serveur WebProxy	corde

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 de service/back-ends 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 de ressource

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

Valeurs de propriété

service/back-ends

Nom	Description	Valeur
type	Type de ressource	« Microsoft.ApiManagement/service/backends@2021-08-01 »
nom	Nom de la ressource	chaîne (obligatoire) Limite de caractères : 1 à 80 Caractères valides : Alphanumériques et traits d’union. Commencez par la lettre et terminez par alphanumérique.
parent_id	ID de la ressource qui est le parent de cette ressource.	ID de ressource de type : de service
Propriétés	Propriétés du contrat d’entité back-end.	BackendContractProperties

BackendContractProperties

Nom	Description	Valeur
Pouvoirs	Propriétés du contrat d’informations d’identification du serveur principal	BackendCredentialsContract
description	Description du back-end.	corde Contraintes: Longueur minimale = 1 Longueur maximale = 2000
Propriétés	Contrat propriétés du back-end	BackendProperties
protocole	Protocole de communication back-end.	«`http`» « soap » (obligatoire)
procuration	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.	corde Contraintes: Longueur minimale = 1 Longueur maximale = 2000
titre	Titre du back-end.	corde Contraintes: Longueur minimale = 1 Longueur maximale = 300
tls	Propriétés TLS du back-end	BackendTlsProperties
URL	URL du runtime du back-end.	chaîne (obligatoire) Contraintes: Longueur minimale = 1 Longueur maximale = 2000

BackendCredentialsContract

Nom	Description	Valeur
autorisation	Authentification de l’en-tête d’autorisation	BackendAuthorizationHeaderCredentials
certificat	Liste des empreintes de certificat client. Sera ignoré si les certificatesIds sont fournis.	string[] Contraintes: Longueur maximale = 32
certificateIds	Liste des ID de certificat client.	string[] Contraintes: Longueur maximale = 32
en-tête	Description du paramètre d’en-tête.	BackendCredentialsContractHeader
requête	Description du paramètre de requête.	BackendCredentialsContractQuery

BackendAuthorizationHeaderCredentials

Nom	Description	Valeur
paramètre	Valeur du paramètre d’authentification.	chaîne (obligatoire) Contraintes: Longueur minimale = 1 Longueur maximale = 300
schéma	Nom du schéma d’authentification.	chaîne (obligatoire) Contraintes: Longueur minimale = 1 Longueur maximale = 100

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.	corde
clientCertificatethumbprint	Empreinte numérique du certificat client pour le point de terminaison de gestion. Sera ignoré si les certificatesIds sont fournis	corde
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 du service de gestion de cluster de certificats utilisée 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.	corde
nom	Nom commun du certificat.	corde

BackendProxyContract

Nom	Description	Valeur
mot de passe	Mot de passe pour se connecter au serveur WebProxy	corde
URL	Propriété WebProxy Server AbsoluteUri qui inclut l’URI entier stocké dans l’instance d’URI, y compris tous les fragments et chaînes de requête.	chaîne (obligatoire) Contraintes: Longueur minimale = 1 Longueur maximale = 2000
nom d’utilisateur	Nom d’utilisateur pour se connecter au serveur WebProxy	corde

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

Partager via

Service Microsoft.ApiManagement/backends 2021-08-01

Définition de ressource Bicep

Format de ressource

Valeurs de propriété

service/back-ends

BackendContractProperties

BackendCredentialsContract

BackendAuthorizationHeaderCredentials

BackendCredentialsContractHeader

BackendCredentialsContractQuery

BackendProperties

BackendServiceFabricClusterProperties

X509CertificateName

BackendProxyContract

BackendTlsProperties

Définition de ressource de modèle ARM

Format de ressource

Valeurs de propriété

service/back-ends

BackendContractProperties

BackendCredentialsContract

BackendAuthorizationHeaderCredentials

BackendCredentialsContractHeader

BackendCredentialsContractQuery

BackendProperties

BackendServiceFabricClusterProperties

X509CertificateName

BackendProxyContract

BackendTlsProperties

Définition de ressource Terraform (fournisseur AzAPI)

Format de ressource

Valeurs de propriété

service/back-ends

BackendContractProperties

BackendCredentialsContract

BackendAuthorizationHeaderCredentials

BackendCredentialsContractHeader

BackendCredentialsContractQuery

BackendProperties

BackendServiceFabricClusterProperties

X509CertificateName

BackendProxyContract

BackendTlsProperties

Commentaires

Ressources supplémentaires