Freigeben über


Microsoft.ApiManagement-Dienst/Back-Ends 2020-06-01-preview

Bicep-Ressourcendefinition

Der Ressourcentyp "Service/Back-Ends" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

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 Bicep hinzu.

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

Eigenschaftswerte

Back-EndAuthorizationHeaderCredentials

Name Beschreibung Wert
Parameter Authentifizierungsparameterwert. Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1 (erforderlich)
Schema Name des Authentifizierungsschemas. Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1 (erforderlich)

Back-EndContractProperties

Name Beschreibung Wert
Beglaubigungsschreiben Eigenschaften des Back-End-Anmeldeinformationsvertrags Back-EndCredentialsContract-
Beschreibung Back-End-Beschreibung. Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1
Eigenschaften Vertrag für Back-End-Eigenschaften Back-EndProperties-
Protokoll Back-End-Kommunikationsprotokoll. 'http'
"Soap" (erforderlich)
Stellvertreter 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. Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1
Titel Back-End-Titel. Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1
tls Back-End-TLS-Eigenschaften Back-EndTlsProperties-
URL Laufzeit-URL des Back-End. Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1 (erforderlich)

Back-EndCredentialsContract

Name Beschreibung Wert
Ermächtigung Autorisierungsheaderauthentifizierung Back-EndAuthorizationHeaderCredentials-
Zertifikat Liste der Clientzertifikatfingerabdrücke. Wird ignoriert, wenn zertifikateIds bereitgestellt werden. string[]
certificateIds Liste der Clientzertifikat-IDs. string[]
Kopfball Beschreibung des Headerparameters. Back-EndCredentialsContractHeader-
Frage Beschreibung des Abfrageparameters. Back-EndCredentialsContractQuery-

Back-EndCredentialsContractHeader

Name Beschreibung Wert

Back-EndCredentialsContractQuery

Name Beschreibung Wert

Back-EndProperties

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

Back-EndProxyContract

Name Beschreibung Wert
Passwort Kennwort zum Herstellen einer Verbindung mit dem WebProxy-Server Schnur
URL WebProxy Server AbsoluteUri-Eigenschaft, die den gesamten URI enthält, der in der URI-Instanz gespeichert ist, einschließlich aller Fragmente und Abfragezeichenfolgen. Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1 (erforderlich)
Nutzername Benutzername zum Herstellen einer Verbindung mit dem WebProxy-Server Schnur

Back-EndServiceFabricClusterProperties

Name Beschreibung Wert
clientCertificateId Die Clientzertifikat-ID für den Verwaltungsendpunkt. Schnur
clientCertificatethumbprint Der Clientzertifikatfingerabdruck für den Verwaltungsendpunkt. Wird ignoriert, wenn zertifikateIds bereitgestellt werden Schnur
managementEndpoints Der Clusterverwaltungsendpunkt. string[] (erforderlich)
maxPartitionResolutionRetries Maximale Anzahl von Wiederholungen beim Auflösen der Partition. Int
serverCertificateThumbprints Fingerabdruck von Zertifikaten, die für die Tls-Kommunikation verwendet werden string[]
serverX509Names Server X509-Zertifikatnamensammlung X509CertificateName[]

Back-EndTlsProperties

Name Beschreibung Wert
validateCertificateChain Flag, das angibt, ob die ÜBERPRÜFUNG der SSL-Zertifikatkette erfolgen soll, wenn selbstsignierte Zertifikate für diesen Back-End-Host verwendet werden sollen. Bool
validateCertificateName Flag, das angibt, ob die ÜBERPRÜFUNG des SSL-Zertifikatnamens bei Verwendung von selbstsignierten Zertifikaten für diesen Back-End-Host erfolgen soll. Bool

Microsoft.ApiManagement/service/backends

Name Beschreibung Wert
Name Der Ressourcenname Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1 (erforderlich)
Elternteil 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 des Typs: Dienst-
Eigenschaften Eigenschaften des Back-End-Entitätsvertrags. Back-EndContractProperties-

X509CertificateName

Name Beschreibung Wert
issuerCertificateThumbprint Fingerabdruck für den Aussteller des Zertifikats. Schnur
Name Allgemeiner Name des Zertifikats. Schnur

ARM-Vorlagenressourcendefinition

Der Ressourcentyp "Service/Back-Ends" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

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

Ressourcenformat

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

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

Back-EndAuthorizationHeaderCredentials

Name Beschreibung Wert
Parameter Authentifizierungsparameterwert. Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1 (erforderlich)
Schema Name des Authentifizierungsschemas. Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1 (erforderlich)

Back-EndContractProperties

Name Beschreibung Wert
Beglaubigungsschreiben Eigenschaften des Back-End-Anmeldeinformationsvertrags Back-EndCredentialsContract-
Beschreibung Back-End-Beschreibung. Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1
Eigenschaften Vertrag für Back-End-Eigenschaften Back-EndProperties-
Protokoll Back-End-Kommunikationsprotokoll. 'http'
"Soap" (erforderlich)
Stellvertreter 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. Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1
Titel Back-End-Titel. Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1
tls Back-End-TLS-Eigenschaften Back-EndTlsProperties-
URL Laufzeit-URL des Back-End. Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1 (erforderlich)

Back-EndCredentialsContract

Name Beschreibung Wert
Ermächtigung Autorisierungsheaderauthentifizierung Back-EndAuthorizationHeaderCredentials-
Zertifikat Liste der Clientzertifikatfingerabdrücke. Wird ignoriert, wenn zertifikateIds bereitgestellt werden. string[]
certificateIds Liste der Clientzertifikat-IDs. string[]
Kopfball Beschreibung des Headerparameters. Back-EndCredentialsContractHeader-
Frage Beschreibung des Abfrageparameters. Back-EndCredentialsContractQuery-

Back-EndCredentialsContractHeader

Name Beschreibung Wert

Back-EndCredentialsContractQuery

Name Beschreibung Wert

Back-EndProperties

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

Back-EndProxyContract

Name Beschreibung Wert
Passwort Kennwort zum Herstellen einer Verbindung mit dem WebProxy-Server Schnur
URL WebProxy Server AbsoluteUri-Eigenschaft, die den gesamten URI enthält, der in der URI-Instanz gespeichert ist, einschließlich aller Fragmente und Abfragezeichenfolgen. Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1 (erforderlich)
Nutzername Benutzername zum Herstellen einer Verbindung mit dem WebProxy-Server Schnur

Back-EndServiceFabricClusterProperties

Name Beschreibung Wert
clientCertificateId Die Clientzertifikat-ID für den Verwaltungsendpunkt. Schnur
clientCertificatethumbprint Der Clientzertifikatfingerabdruck für den Verwaltungsendpunkt. Wird ignoriert, wenn zertifikateIds bereitgestellt werden Schnur
managementEndpoints Der Clusterverwaltungsendpunkt. string[] (erforderlich)
maxPartitionResolutionRetries Maximale Anzahl von Wiederholungen beim Auflösen der Partition. Int
serverCertificateThumbprints Fingerabdruck von Zertifikaten, die für die Tls-Kommunikation verwendet werden string[]
serverX509Names Server X509-Zertifikatnamensammlung X509CertificateName[]

Back-EndTlsProperties

Name Beschreibung Wert
validateCertificateChain Flag, das angibt, ob die ÜBERPRÜFUNG der SSL-Zertifikatkette erfolgen soll, wenn selbstsignierte Zertifikate für diesen Back-End-Host verwendet werden sollen. Bool
validateCertificateName Flag, das angibt, ob die ÜBERPRÜFUNG des SSL-Zertifikatnamens bei Verwendung von selbstsignierten Zertifikaten für diesen Back-End-Host erfolgen soll. Bool

Microsoft.ApiManagement/service/backends

Name Beschreibung Wert
apiVersion Die API-Version "2020-06-01-preview"
Name Der Ressourcenname Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1 (erforderlich)
Eigenschaften Eigenschaften des Back-End-Entitätsvertrags. Back-EndContractProperties-
Art Der Ressourcentyp 'Microsoft.ApiManagement/service/backends'

X509CertificateName

Name Beschreibung Wert
issuerCertificateThumbprint Fingerabdruck für den Aussteller des Zertifikats. Schnur
Name Allgemeiner Name des Zertifikats. Schnur

Terraform -Ressourcendefinition (AzAPI-Anbieter)

Der Ressourcentyp "Service/Back-Ends" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

  • Ressourcengruppen

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

Ressourcenformat

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

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

Eigenschaftswerte

Back-EndAuthorizationHeaderCredentials

Name Beschreibung Wert
Parameter Authentifizierungsparameterwert. Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1 (erforderlich)
Schema Name des Authentifizierungsschemas. Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1 (erforderlich)

Back-EndContractProperties

Name Beschreibung Wert
Beglaubigungsschreiben Eigenschaften des Back-End-Anmeldeinformationsvertrags Back-EndCredentialsContract-
Beschreibung Back-End-Beschreibung. Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1
Eigenschaften Vertrag für Back-End-Eigenschaften Back-EndProperties-
Protokoll Back-End-Kommunikationsprotokoll. 'http'
"Soap" (erforderlich)
Stellvertreter 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. Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1
Titel Back-End-Titel. Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1
tls Back-End-TLS-Eigenschaften Back-EndTlsProperties-
URL Laufzeit-URL des Back-End. Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1 (erforderlich)

Back-EndCredentialsContract

Name Beschreibung Wert
Ermächtigung Autorisierungsheaderauthentifizierung Back-EndAuthorizationHeaderCredentials-
Zertifikat Liste der Clientzertifikatfingerabdrücke. Wird ignoriert, wenn zertifikateIds bereitgestellt werden. string[]
certificateIds Liste der Clientzertifikat-IDs. string[]
Kopfball Beschreibung des Headerparameters. Back-EndCredentialsContractHeader-
Frage Beschreibung des Abfrageparameters. Back-EndCredentialsContractQuery-

Back-EndCredentialsContractHeader

Name Beschreibung Wert

Back-EndCredentialsContractQuery

Name Beschreibung Wert

Back-EndProperties

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

Back-EndProxyContract

Name Beschreibung Wert
Passwort Kennwort zum Herstellen einer Verbindung mit dem WebProxy-Server Schnur
URL WebProxy Server AbsoluteUri-Eigenschaft, die den gesamten URI enthält, der in der URI-Instanz gespeichert ist, einschließlich aller Fragmente und Abfragezeichenfolgen. Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1 (erforderlich)
Nutzername Benutzername zum Herstellen einer Verbindung mit dem WebProxy-Server Schnur

Back-EndServiceFabricClusterProperties

Name Beschreibung Wert
clientCertificateId Die Clientzertifikat-ID für den Verwaltungsendpunkt. Schnur
clientCertificatethumbprint Der Clientzertifikatfingerabdruck für den Verwaltungsendpunkt. Wird ignoriert, wenn zertifikateIds bereitgestellt werden Schnur
managementEndpoints Der Clusterverwaltungsendpunkt. string[] (erforderlich)
maxPartitionResolutionRetries Maximale Anzahl von Wiederholungen beim Auflösen der Partition. Int
serverCertificateThumbprints Fingerabdruck von Zertifikaten, die für die Tls-Kommunikation verwendet werden string[]
serverX509Names Server X509-Zertifikatnamensammlung X509CertificateName[]

Back-EndTlsProperties

Name Beschreibung Wert
validateCertificateChain Flag, das angibt, ob die ÜBERPRÜFUNG der SSL-Zertifikatkette erfolgen soll, wenn selbstsignierte Zertifikate für diesen Back-End-Host verwendet werden sollen. Bool
validateCertificateName Flag, das angibt, ob die ÜBERPRÜFUNG des SSL-Zertifikatnamens bei Verwendung von selbstsignierten Zertifikaten für diesen Back-End-Host erfolgen soll. Bool

Microsoft.ApiManagement/service/backends

Name Beschreibung Wert
Name Der Ressourcenname Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1 (erforderlich)
parent_id Die ID der Ressource, die das übergeordnete Element für diese Ressource ist. ID für Ressource des Typs: Dienst-
Eigenschaften Eigenschaften des Back-End-Entitätsvertrags. Back-EndContractProperties-
Art Der Ressourcentyp "Microsoft.ApiManagement/service/backends@2020-06-01-preview"

X509CertificateName

Name Beschreibung Wert
issuerCertificateThumbprint Fingerabdruck für den Aussteller des Zertifikats. Schnur
Name Allgemeiner Name des Zertifikats. Schnur