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

Artikel
01/18/2024

Bicep-resursdefinition

Resurstypen tjänst/serverdelar kan distribueras med åtgärder som mål:

Resursgrupper – Se distributionskommandon för resursgrupper

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.ApiManagement/service/backends-resurs lägger du till följande Bicep i mallen.

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

Egenskapsvärden

tjänst/serverdelar

Name	Beskrivning	Värde
name	Resursnamnet Se hur du anger namn och typer för underordnade resurser i Bicep.	sträng (krävs) Teckengräns: 1–80 Giltiga tecken: Alfanumeriska tecken och bindestreck. Börja med bokstav och slut med alfanumeriskt.
parent	I Bicep kan du ange den överordnade resursen för en underordnad resurs. Du behöver bara lägga till den här egenskapen när den underordnade resursen deklareras utanför den överordnade resursen. Mer information finns i Underordnad resurs utanför överordnad resurs.	Symboliskt namn för resurs av typen: tjänst
properties	Egenskaper för serverdelsentitetskontrakt.	BackendContractProperties

BackendContractProperties

Name	Beskrivning	Värde
autentiseringsuppgifter	Egenskaper för kontrakt för serverdelsautentiseringsuppgifter	BackendCredentialsContract
beskrivning	Beskrivning av serverdelen.	sträng
properties	Kontrakt för serverdelsegenskaper	BackendProperties
Protokollet	Protokoll för serverdelskommunikation.	"http" "soap" (krävs)
proxy	Egenskaper för serverdelsproxykontrakt	BackendProxyContract
resourceId	Hanterings-URI för resursen i det externa systemet. Den här URL:en kan vara armresurs-ID för Logic Apps, Funktionsappar eller API Apps.	sträng
title	Serverdelsrubrik.	sträng
Tls	Egenskaper för serverdels-TLS	BackendTlsEgenskaper
url	Körnings-URL för serverdelen.	sträng (krävs)

BackendCredentialsContract

Name	Beskrivning	Värde
auktorisering	Autentisering med auktoriseringshuvud	BackendAuthorizationHeaderCredentials
certifikat	Lista över tumavtryck för klientcertifikat. Ignoreras om certificatesIds tillhandahålls.	string[]
certificateIds	Lista över klientcertifikat-ID:t.	string[]
sidhuvud	Beskrivning av rubrikparameter.	BackendCredentialsContractHeader
query	Beskrivning av frågeparameter.	BackendCredentialsContractQuery

BackendAuthorizationHeaderCredentials

Name	Beskrivning	Värde
parameter	Autentiseringsparametervärde.	sträng (krävs)
System	Namn på autentiseringsschema.	sträng (krävs)

BackendCredentialsContractHeader

Name	Beskrivning	Värde
{anpassad egenskap}		string[]

BackendCredentialsContractQuery

Name	Beskrivning	Värde
{anpassad egenskap}		string[]

BackendProperties

Name	Beskrivning	Värde
serviceFabricCluster	Egenskaper för Service Fabric-kluster i serverdelen	BackendServiceFabricClusterEgenskaper

BackendServiceFabricClusterEgenskaper

Name	Beskrivning	Värde
clientCertificateId	Klientcertifikat-ID för hanteringsslutpunkten.	sträng
clientCertificatethumbprint	Tumavtrycket för klientcertifikatet för hanteringsslutpunkten. Ignoreras om certificatesIds tillhandahålls	sträng
managementEndpoints	Slutpunkten för klusterhantering.	string[] (krävs)
maxPartitionResolutionRetries	Maximalt antal återförsök vid försök att lösa partitionen.	int
serverCertificateThumbprints	Tumavtryck för certifikat som klusterhanteringstjänsten använder för tls-kommunikation	string[]
serverX509Names	Server X509-certifikatnamnsamling	X509CertificateName[]

X509CertificateName

Name	Beskrivning	Värde
issuerCertificateThumbprint	Tumavtryck för certifikatutfärdaren.	sträng
name	Eget namn på certifikatet.	sträng

BackendProxyContract

Name	Beskrivning	Värde
password	Lösenord för att ansluta till WebProxy Server	sträng
url	Egenskapen WebProxy Server AbsoluteUri som innehåller hela URI:n som lagras i URI-instansen, inklusive alla fragment och frågesträngar.	sträng (krävs)
användarnamn	Användarnamn för att ansluta till WebProxy-servern	sträng

BackendTlsEgenskaper

Name	Beskrivning	Värde
validateCertificateChain	Flagga som anger om validering av SSL-certifikatkedja ska utföras när du använder självsignerade certifikat för den här serverdelsvärden.	boolesk
validateCertificateName	Flagga som anger om validering av SSL-certifikatnamn ska göras när du använder självsignerade certifikat för den här serverdelsvärden.	boolesk

Resursdefinition för ARM-mall

Resurstypen tjänst/serverdelar kan distribueras med åtgärder som mål:

Resursgrupper – Se distributionskommandon för resursgrupper

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.ApiManagement/service/backends-resurs lägger du till följande JSON i mallen.

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

Egenskapsvärden

tjänst/serverdelar

Name	Beskrivning	Värde
typ	Resurstypen	"Microsoft.ApiManagement/service/backends"
apiVersion	Resurs-API-versionen	"2021-12-01-preview"
name	Resursnamnet Se hur du anger namn och typer för underordnade resurser i JSON ARM-mallar.	sträng (krävs) Teckengräns: 1–80 Giltiga tecken: Alfanumeriska tecken och bindestreck. Börja med bokstav och slut med alfanumeriskt.
properties	Egenskaper för serverdelsentitetskontrakt.	BackendContractProperties

BackendContractProperties

Name	Beskrivning	Värde
autentiseringsuppgifter	Egenskaper för kontrakt för serverdelsautentiseringsuppgifter	BackendCredentialsContract
beskrivning	Beskrivning av serverdelen.	sträng
properties	Kontrakt för serverdelsegenskaper	BackendProperties
Protokollet	Protokoll för serverdelskommunikation.	"http" "soap" (krävs)
proxy	Egenskaper för serverdelsproxykontrakt	BackendProxyContract
resourceId	Hanterings-URI för resursen i det externa systemet. Den här URL:en kan vara armresurs-ID för Logic Apps, Funktionsappar eller API Apps.	sträng
title	Serverdelsrubrik.	sträng
Tls	Egenskaper för serverdels-TLS	BackendTlsEgenskaper
url	Körnings-URL för serverdelen.	sträng (krävs)

BackendCredentialsContract

Name	Beskrivning	Värde
auktorisering	Autentisering med auktoriseringshuvud	BackendAuthorizationHeaderCredentials
certifikat	Lista över tumavtryck för klientcertifikat. Ignoreras om certificatesIds tillhandahålls.	string[]
certificateIds	Lista över klientcertifikat-ID:t.	string[]
sidhuvud	Beskrivning av rubrikparameter.	BackendCredentialsContractHeader
query	Beskrivning av frågeparameter.	BackendCredentialsContractQuery

BackendAuthorizationHeaderCredentials

Name	Beskrivning	Värde
parameter	Autentiseringsparametervärde.	sträng (krävs)
System	Namn på autentiseringsschema.	sträng (krävs)

BackendCredentialsContractHeader

Name	Beskrivning	Värde
{anpassad egenskap}		string[]

BackendCredentialsContractQuery

Name	Beskrivning	Värde
{anpassad egenskap}		string[]

BackendProperties

Name	Beskrivning	Värde
serviceFabricCluster	Egenskaper för Service Fabric-kluster i serverdelen	BackendServiceFabricClusterEgenskaper

BackendServiceFabricClusterEgenskaper

Name	Beskrivning	Värde
clientCertificateId	Klientcertifikat-ID för hanteringsslutpunkten.	sträng
clientCertificatethumbprint	Tumavtrycket för klientcertifikatet för hanteringsslutpunkten. Ignoreras om certificatesIds tillhandahålls	sträng
managementEndpoints	Slutpunkten för klusterhantering.	string[] (krävs)
maxPartitionResolutionRetries	Maximalt antal återförsök vid försök att lösa partitionen.	int
serverCertificateThumbprints	Tumavtryck för certifikat som klusterhanteringstjänsten använder för tls-kommunikation	string[]
serverX509Names	Server X509-certifikatnamnsamling	X509CertificateName[]

X509CertificateName

Name	Beskrivning	Värde
issuerCertificateThumbprint	Tumavtryck för certifikatutfärdaren.	sträng
name	Eget namn på certifikatet.	sträng

BackendProxyContract

Name	Beskrivning	Värde
password	Lösenord för att ansluta till WebProxy Server	sträng
url	Egenskapen WebProxy Server AbsoluteUri som innehåller hela URI:n som lagras i URI-instansen, inklusive alla fragment och frågesträngar.	sträng (krävs)
användarnamn	Användarnamn för att ansluta till WebProxy-servern	sträng

BackendTlsEgenskaper

Name	Beskrivning	Värde
validateCertificateChain	Flagga som anger om validering av SSL-certifikatkedja ska utföras när du använder självsignerade certifikat för den här serverdelsvärden.	boolesk
validateCertificateName	Flagga som anger om validering av SSL-certifikatnamn ska göras när du använder självsignerade certifikat för den här serverdelsvärden.	boolesk

Resursdefinition för Terraform (AzAPI-provider)

Resurstypen tjänst/serverdelar kan distribueras med åtgärder som mål:

Resursgrupper

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.ApiManagement/service/backends-resurs lägger du till följande Terraform i mallen.

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

Egenskapsvärden

tjänst/serverdelar

Name	Beskrivning	Värde
typ	Resurstypen	"Microsoft.ApiManagement/service/backends@2021-12-01-preview"
name	Resursnamnet	sträng (krävs) Teckengräns: 1–80 Giltiga tecken: Alfanumeriska tecken och bindestreck. Börja med bokstav och slut med alfanumeriskt.
parent_id	ID:t för resursen som är överordnad för den här resursen.	ID för resurs av typen: tjänst
properties	Egenskaper för serverdelsentitetskontrakt.	BackendContractProperties

BackendContractProperties

Name	Beskrivning	Värde
autentiseringsuppgifter	Egenskaper för kontrakt för serverdelsautentiseringsuppgifter	BackendCredentialsContract
beskrivning	Beskrivning av serverdelen.	sträng
properties	Kontrakt för serverdelsegenskaper	BackendProperties
Protokollet	Protokoll för serverdelskommunikation.	"http" "soap" (krävs)
proxy	Egenskaper för serverdelsproxykontrakt	BackendProxyContract
resourceId	Hanterings-URI för resursen i det externa systemet. Den här URL:en kan vara armresurs-ID för Logic Apps, Funktionsappar eller API Apps.	sträng
title	Serverdelsrubrik.	sträng
Tls	Egenskaper för serverdels-TLS	BackendTlsEgenskaper
url	Körnings-URL för serverdelen.	sträng (krävs)

BackendCredentialsContract

Name	Beskrivning	Värde
auktorisering	Autentisering med auktoriseringshuvud	BackendAuthorizationHeaderCredentials
certifikat	Lista över tumavtryck för klientcertifikat. Ignoreras om certificatesIds tillhandahålls.	string[]
certificateIds	Lista över klientcertifikat-ID:t.	string[]
sidhuvud	Beskrivning av rubrikparameter.	BackendCredentialsContractHeader
query	Beskrivning av frågeparameter.	BackendCredentialsContractQuery

BackendAuthorizationHeaderCredentials

Name	Beskrivning	Värde
parameter	Autentiseringsparametervärde.	sträng (krävs)
System	Namn på autentiseringsschema.	sträng (krävs)

BackendCredentialsContractHeader

Name	Beskrivning	Värde
{anpassad egenskap}		string[]

BackendCredentialsContractQuery

Name	Beskrivning	Värde
{anpassad egenskap}		string[]

BackendProperties

Name	Beskrivning	Värde
serviceFabricCluster	Egenskaper för Service Fabric-kluster i serverdelen	BackendServiceFabricClusterEgenskaper

BackendServiceFabricClusterEgenskaper

Name	Beskrivning	Värde
clientCertificateId	Klientcertifikat-ID för hanteringsslutpunkten.	sträng
clientCertificatethumbprint	Tumavtrycket för klientcertifikatet för hanteringsslutpunkten. Ignoreras om certificatesIds tillhandahålls	sträng
managementEndpoints	Slutpunkten för klusterhantering.	string[] (krävs)
maxPartitionResolutionRetries	Maximalt antal återförsök vid försök att lösa partitionen.	int
serverCertificateThumbprints	Tumavtryck för certifikat som klusterhanteringstjänsten använder för tls-kommunikation	string[]
serverX509Names	Server X509-certifikatnamnsamling	X509CertificateName[]

X509CertificateName

Name	Beskrivning	Värde
issuerCertificateThumbprint	Tumavtryck för certifikatutfärdaren.	sträng
name	Eget namn på certifikatet.	sträng

BackendProxyContract

Name	Beskrivning	Värde
password	Lösenord för att ansluta till WebProxy Server	sträng
url	Egenskapen WebProxy Server AbsoluteUri som innehåller hela URI:n som lagras i URI-instansen, inklusive alla fragment och frågesträngar.	sträng (krävs)
användarnamn	Användarnamn för att ansluta till WebProxy-servern	sträng

BackendTlsEgenskaper

Name	Beskrivning	Värde
validateCertificateChain	Flagga som anger om SSL-certifikatkedjans validering ska utföras när du använder självsignerade certifikat för den här serverdelsvärden.	boolesk
validateCertificateName	Flagga som anger om SSL-certifikatets namnverifiering ska utföras när du använder självsignerade certifikat för den här serverdelsvärden.	boolesk

Share via

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

Bicep-resursdefinition

Resursformat

Egenskapsvärden

tjänst/serverdelar

BackendContractProperties

BackendCredentialsContract

BackendAuthorizationHeaderCredentials

BackendCredentialsContractHeader

BackendCredentialsContractQuery

BackendProperties

BackendServiceFabricClusterEgenskaper

X509CertificateName

BackendProxyContract

BackendTlsEgenskaper

Resursdefinition för ARM-mall

Resursformat

Egenskapsvärden

tjänst/serverdelar

BackendContractProperties

BackendCredentialsContract

BackendAuthorizationHeaderCredentials

BackendCredentialsContractHeader

BackendCredentialsContractQuery

BackendProperties

BackendServiceFabricClusterEgenskaper

X509CertificateName

BackendProxyContract

BackendTlsEgenskaper

Resursdefinition för Terraform (AzAPI-provider)

Resursformat

Egenskapsvärden

tjänst/serverdelar

BackendContractProperties

BackendCredentialsContract

BackendAuthorizationHeaderCredentials

BackendCredentialsContractHeader

BackendCredentialsContractQuery

BackendProperties

BackendServiceFabricClusterEgenskaper

X509CertificateName

BackendProxyContract

BackendTlsEgenskaper

Ytterligare resurser