Freigeben über

Microsoft.ApiManagement service/backends 2021-12-01-preview

  • Artikel

Bicep-Ressourcendefinition

Der Ressourcentyp service/back-Ends kann mit Vorgängen bereitgestellt werden, die folgendes ziel haben:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.ApiManagement/service/back-Ends-Ressource zu erstellen, fügen Sie der Vorlage den folgenden Bicep hinzu.

resource symbolicname 'Microsoft.ApiManagement/service/backends@2021-12-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'
  }
}

Eigenschaftswerte

service/backends

Name BESCHREIBUNG Wert
name Der Ressourcenname

Weitere Informationen finden Sie unter Festlegen von Namen und Typen für untergeordnete Ressourcen in Bicep.		 Zeichenfolge (erforderlich)

Zeichenlimit: 1-80

Gültige Zeichen:
Alphanumerische Zeichen und Bindestriche.

Muss mit einem Buchstaben beginnen und mit einem alphanumerischen Zeichen enden.
parent In Bicep können Sie die übergeordnete Ressource für eine untergeordnete Ressource angeben. Sie müssen diese Eigenschaft nur hinzufügen, wenn die untergeordnete Ressource außerhalb der übergeordneten Ressource deklariert wird.

Weitere Informationen finden Sie unter Untergeordnete Ressource außerhalb der übergeordneten Ressource.		 Symbolischer Name für Ressource vom Typ: Dienst
properties Eigenschaften des Back-End-Entitätsvertrags. BackendContractProperties

BackendContractProperties

Name BESCHREIBUNG Wert
Anmeldeinformationen Eigenschaften des Back-End-Anmeldeinformationsvertrags Back-EndCredentialsContract
description Back-End-Beschreibung. Zeichenfolge
properties Vertrag für Back-End-Eigenschaften Back-EndProperties
Protokoll Back-End-Kommunikationsprotokoll. "http"
"Soap" (erforderlich)
proxy Eigenschaften des Back-End-Proxyvertrags Back-EndProxyContract
resourceId Verwaltungs-URI der Ressource im externen System. Bei dieser URL kann es sich um die Arm-Ressourcen-ID von Logic Apps, Funktions-Apps oder API-Apps handeln. Zeichenfolge
title Back-End-Titel. Zeichenfolge
Tls Back-End-TLS-Eigenschaften Back-EndTlsEigenschaften
url Laufzeit-URL des Back-Ends. Zeichenfolge (erforderlich)

Back-EndCredentialsContract

Name BESCHREIBUNG Wert
authorization Autorisierungsheaderauthentifizierung Back-EndAuthorizationHeaderCredentials
Zertifikat Liste der Clientzertifikatfingerabdrücke. Wird ignoriert, wenn certificatesIds bereitgestellt werden. string[]
certificateIds Liste der Clientzertifikat-IDs. string[]
header Beschreibung des Headerparameters. Back-EndCredentialsContractHeader
Abfrage Beschreibung des Abfrageparameters. Back-EndCredentialsContractQuery

Back-EndAuthorizationHeaderCredentials

Name BESCHREIBUNG Wert
parameter Authentifizierungsparameterwert. Zeichenfolge (erforderlich)
scheme Name des Authentifizierungsschemas. Zeichenfolge (erforderlich)

Back-EndCredentialsContractHeader

Name BESCHREIBUNG Wert
{angepasste Eigenschaft} string[]

Back-EndCredentialsContractQuery

Name BESCHREIBUNG Wert
{angepasste Eigenschaft} string[]

Back-EndProperties

Name BESCHREIBUNG Wert
serviceFabricCluster Back-End Service Fabric-Clustereigenschaften Back-EndServiceFabricClusterProperties

Back-EndServiceFabricClusterProperties

Name BESCHREIBUNG Wert
clientCertificateId Die Clientzertifikat-ID für den Verwaltungsendpunkt. Zeichenfolge
clientCertificatethumbprint Der Clientzertifikatfingerabdruck für den Verwaltungsendpunkt. Wird ignoriert, wenn certificatesIds angegeben werden. Zeichenfolge
managementEndpoints Der Clusterverwaltungsendpunkt. string[] (erforderlich)
maxPartitionResolutionRetries Maximale Anzahl von Wiederholungsversuchen beim Auflösen der Partition. INT
serverCertificateThumbprints Fingerabdrucke von Zertifikaten, die der Clusterverwaltungsdienst für die TLS-Kommunikation verwendet string[]
serverX509Names Server X509-Zertifikatnamensammlung X509CertificateName[]

X509CertificateName

Name BESCHREIBUNG Wert
issuerCertificateThumbprint Fingerabdruck für den Aussteller des Zertifikats. Zeichenfolge
name Allgemeiner Name des Zertifikats. Zeichenfolge

Back-EndProxyContract

Name BESCHREIBUNG Wert
password Kennwort zum Herstellen einer Verbindung mit dem WebProxy-Server Zeichenfolge
url WebProxy Server AbsoluteUri-Eigenschaft, die den gesamten URI enthält, der im Uri instance gespeichert ist, einschließlich aller Fragmente und Abfragezeichenfolgen. Zeichenfolge (erforderlich)
username Benutzername zum Herstellen einer Verbindung mit dem WebProxy-Server Zeichenfolge

Back-EndTlsProperties

Name BESCHREIBUNG Wert
validateCertificateChain Flag, das angibt, ob die SSL-Zertifikatkettenüberprüfung durchgeführt werden soll, wenn selbstsignierte Zertifikate für diesen Back-End-Host verwendet werden. bool
validateCertificateName Flag, das angibt, ob die SSL-Zertifikatnamenüberprüfung durchgeführt werden soll, wenn selbstsignierte Zertifikate für diesen Back-End-Host verwendet werden sollen. bool

Ressourcendefinition mit einer ARM-Vorlage

Der Ressourcentyp Dienst/Back-Ends kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.ApiManagement/service/back-Ends-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.

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

Eigenschaftswerte

service/backends

Name BESCHREIBUNG Wert
type Ressourcentyp "Microsoft.ApiManagement/service/back-Ends"
apiVersion Die Ressourcen-API-Version "2021-12-01-preview"
name Der Ressourcenname

Erfahren Sie, wie Sie Namen und Typen für untergeordnete Ressourcen in JSON-ARM-Vorlagen festlegen.		 Zeichenfolge (erforderlich)

Zeichenlimit: 1-80

Gültige Zeichen:
Alphanumerische Zeichen und Bindestriche.

Muss mit einem Buchstaben beginnen und mit einem alphanumerischen Zeichen enden.
properties Eigenschaften des Back-End-Entitätsvertrags. Back-EndContractProperties

Back-EndContractProperties

Name BESCHREIBUNG Wert
Anmeldeinformationen Vertragseigenschaften für Back-End-Anmeldeinformationen Back-EndCredentialsContract
description Back-End-Beschreibung. Zeichenfolge
properties Back-End-Eigenschaften-Vertrag Back-EndProperties
Protokoll Back-End-Kommunikationsprotokoll. "http"
"Seife" (erforderlich)
proxy Eigenschaften des Back-End-Proxyvertrags Back-EndProxyContract
resourceId Verwaltungs-URI der Ressource im externen System. Diese URL kann die Arm-Ressourcen-ID von Logik-Apps, Funktions-Apps oder API-Apps sein. Zeichenfolge
title Back-End-Titel. Zeichenfolge
Tls Back-End-TLS-Eigenschaften Back-EndTlsProperties
url Laufzeit-URL des Back-Ends. Zeichenfolge (erforderlich)

Back-EndCredentialsContract

Name BESCHREIBUNG Wert
authorization Authentifizierung des Autorisierungsheaders Back-EndAuthorizationHeaderCredentials
Zertifikat Liste der Clientzertifikatfingerabdrücke. Wird ignoriert, wenn certificatesIds angegeben werden. string[]
certificateIds Liste der Clientzertifikat-IDs. string[]
header Beschreibung des Headerparameters. Back-EndCredentialsContractHeader
Abfrage Beschreibung des Abfrageparameters. Back-EndCredentialsContractQuery

Back-EndAuthorizationHeaderCredentials

Name BESCHREIBUNG Wert
parameter Authentifizierungsparameterwert. Zeichenfolge (erforderlich)
scheme Name des Authentifizierungsschemas. Zeichenfolge (erforderlich)

Back-EndCredentialsContractHeader

Name BESCHREIBUNG Wert
{angepasste Eigenschaft} string[]

Back-EndCredentialsContractQuery

Name BESCHREIBUNG Wert
{angepasste Eigenschaft} string[]

Back-EndProperties

Name BESCHREIBUNG Wert
serviceFabricCluster Back-End Service Fabric-Clustereigenschaften Back-EndServiceFabricClusterProperties

Back-EndServiceFabricClusterProperties

Name BESCHREIBUNG Wert
clientCertificateId Die Clientzertifikat-ID für den Verwaltungsendpunkt. Zeichenfolge
clientCertificatethumbprint Der Clientzertifikatfingerabdruck für den Verwaltungsendpunkt. Wird ignoriert, wenn certificatesIds angegeben werden. Zeichenfolge
managementEndpoints Der Clusterverwaltungsendpunkt. string[] (erforderlich)
maxPartitionResolutionRetries Maximale Anzahl von Wiederholungsversuchen beim Auflösen der Partition. INT
serverCertificateThumbprints Fingerabdrucke von Zertifikaten, die der Clusterverwaltungsdienst für die TLS-Kommunikation verwendet string[]
serverX509Names Server X509-Zertifikatnamensammlung X509CertificateName[]

X509CertificateName

Name BESCHREIBUNG Wert
issuerCertificateThumbprint Fingerabdruck für den Aussteller des Zertifikats. Zeichenfolge
name Allgemeiner Name des Zertifikats. Zeichenfolge

Back-EndProxyContract

Name BESCHREIBUNG Wert
password Kennwort zum Herstellen einer Verbindung mit dem WebProxy-Server Zeichenfolge
url WebProxy Server AbsoluteUri-Eigenschaft, die den gesamten URI enthält, der im Uri instance gespeichert ist, einschließlich aller Fragmente und Abfragezeichenfolgen. Zeichenfolge (erforderlich)
username Benutzername zum Herstellen einer Verbindung mit dem WebProxy-Server Zeichenfolge

Back-EndTlsProperties

Name BESCHREIBUNG Wert
validateCertificateChain Flag, das angibt, ob die SSL-Zertifikatkettenüberprüfung durchgeführt werden soll, wenn selbstsignierte Zertifikate für diesen Back-End-Host verwendet werden. bool
validateCertificateName Flag, das angibt, ob die SSL-Zertifikatnamenüberprüfung durchgeführt werden soll, wenn selbstsignierte Zertifikate für diesen Back-End-Host verwendet werden sollen. bool

Terraform (AzAPI-Anbieter) Ressourcendefinition

Der Ressourcentyp Dienst/Back-Ends kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:

  • Ressourcengruppen

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.ApiManagement/service/back-Ends-Ressource zu erstellen, fügen Sie der Vorlage die folgende Terraform-Ressource hinzu.

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

Eigenschaftswerte

service/backends

Name BESCHREIBUNG Wert
type Ressourcentyp "Microsoft.ApiManagement/service/backends@2021-12-01-preview"
name Der Ressourcenname Zeichenfolge (erforderlich)

Zeichenlimit: 1-80

Gültige Zeichen:
Alphanumerische Zeichen und Bindestriche.

Muss mit einem Buchstaben beginnen und mit einem alphanumerischen Zeichen enden.
parent_id Die ID der Ressource, die die übergeordnete Ressource für diese Ressource ist. ID für Ressource vom Typ: Dienst
properties Eigenschaften des Back-End-Entitätsvertrags. Back-EndContractProperties

Back-EndContractProperties

Name BESCHREIBUNG Wert
Anmeldeinformationen Vertragseigenschaften für Back-End-Anmeldeinformationen Back-EndCredentialsContract
description Back-End-Beschreibung. Zeichenfolge
properties Back-End-Eigenschaften-Vertrag Back-EndProperties
Protokoll Back-End-Kommunikationsprotokoll. "http"
"Seife" (erforderlich)
proxy Eigenschaften des Back-End-Proxyvertrags Back-EndProxyContract
resourceId Verwaltungs-URI der Ressource im externen System. Diese URL kann die Arm-Ressourcen-ID von Logik-Apps, Funktions-Apps oder API-Apps sein. Zeichenfolge
title Back-End-Titel. Zeichenfolge
Tls Back-End-TLS-Eigenschaften Back-EndTlsProperties
url Laufzeit-URL des Back-Ends. Zeichenfolge (erforderlich)

Back-EndCredentialsContract

Name BESCHREIBUNG Wert
authorization Authentifizierung des Autorisierungsheaders Back-EndAuthorizationHeaderCredentials
Zertifikat Liste der Clientzertifikatfingerabdrücke. Wird ignoriert, wenn certificatesIds angegeben werden. string[]
certificateIds Liste der Clientzertifikat-IDs. string[]
header Beschreibung des Headerparameters. Back-EndCredentialsContractHeader
Abfrage Beschreibung des Abfrageparameters. Back-EndCredentialsContractQuery

Back-EndAuthorizationHeaderCredentials

Name BESCHREIBUNG Wert
parameter Authentifizierungsparameterwert. Zeichenfolge (erforderlich)
scheme Name des Authentifizierungsschemas. Zeichenfolge (erforderlich)

Back-EndCredentialsContractHeader

Name BESCHREIBUNG Wert
{angepasste Eigenschaft} string[]

Back-EndCredentialsContractQuery

Name BESCHREIBUNG Wert
{angepasste Eigenschaft} string[]

Back-EndProperties

Name BESCHREIBUNG Wert
serviceFabricCluster Back-End Service Fabric-Clustereigenschaften Back-EndServiceFabricClusterProperties

Back-EndServiceFabricClusterProperties

Name BESCHREIBUNG Wert
clientCertificateId Die Clientzertifikat-ID für den Verwaltungsendpunkt. Zeichenfolge
clientCertificatethumbprint Der Clientzertifikatfingerabdruck für den Verwaltungsendpunkt. Wird ignoriert, wenn certificatesIds angegeben werden. Zeichenfolge
managementEndpoints Der Clusterverwaltungsendpunkt. string[] (erforderlich)
maxPartitionResolutionRetries Maximale Anzahl von Wiederholungsversuchen beim Auflösen der Partition. INT
serverCertificateThumbprints Fingerabdrucke von Zertifikaten, die der Clusterverwaltungsdienst für die TLS-Kommunikation verwendet string[]
serverX509Names Server X509-Zertifikatnamensammlung X509CertificateName[]

X509CertificateName

Name BESCHREIBUNG Wert
issuerCertificateThumbprint Fingerabdruck für den Aussteller des Zertifikats. Zeichenfolge
name Allgemeiner Name des Zertifikats. Zeichenfolge

Back-EndProxyContract

Name BESCHREIBUNG Wert
password Kennwort zum Herstellen einer Verbindung mit dem WebProxy-Server Zeichenfolge
url WebProxy Server AbsoluteUri-Eigenschaft, die den gesamten URI enthält, der im Uri instance gespeichert ist, einschließlich aller Fragmente und Abfragezeichenfolgen. Zeichenfolge (erforderlich)
username Benutzername zum Herstellen einer Verbindung mit dem WebProxy-Server Zeichenfolge

Back-EndTlsProperties

Name BESCHREIBUNG Wert
validateCertificateChain Flag, das angibt, ob die SSL-Zertifikatkette überprüft werden soll, wenn selbstsignierte Zertifikate für diesen Back-End-Host verwendet werden sollen. bool
validateCertificateName Flag, das angibt, ob die SSL-Zertifikatnamenüberprüfung durchgeführt werden soll, wenn selbstsignierte Zertifikate für diesen Back-End-Host verwendet werden sollen. bool