Microsoft.ApiManagement service/backends 2021-08-01

Artikel
07/24/2024

Bicep-resursdefinition

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

Resursgrupper – Se resursgruppsdistributionskommandon

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

Egenskapsvärden

tjänst/serverdelar

Namn	Beskrivning	Värde
Namn	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.
förälder	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 den överordnade resursen.	Symboliskt namn för resurs av typen: tjänst
Egenskaper	Egenskaper för serverdelsentitetskontrakt.	BackendContractProperties

BackendContractProperties

Namn	Beskrivning	Värde
Autentiseringsuppgifter	Egenskaper för backend-autentiseringsuppgifter för kontrakt	BackendCredentialsContract
beskrivning	Serverdelsbeskrivning.	sträng Begränsningar: Min längd = 1 Max längd = 2000
Egenskaper	Kontrakt för serverdelsegenskaper	BackendProperties
protokoll	Protokoll för serverdelskommunikation.	"`http`" "soap" (krävs)
proxyserver	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 Begränsningar: Min längd = 1 Max längd = 2000
titel	Serverdelsrubrik.	sträng Begränsningar: Min längd = 1 Maximal längd = 300
tls	Egenskaper för serverdels-TLS	BackendTlsProperties
URL	Körnings-URL för serverdelen.	sträng (krävs) Begränsningar: Min längd = 1 Max längd = 2000

BackendCredentialsContract

Namn	Beskrivning	Värde
tillstånd	Auktoriseringshuvudautentisering	BackendAuthorizationHeaderCredentials
intyg	Lista över tumavtryck för klientcertifikat. Ignoreras om certificatesIds tillhandahålls.	string[] Begränsningar: Max längd = 32
certificateIds	Lista över klientcertifikat-ID:t.	string[] Begränsningar: Max längd = 32
rubrik	Beskrivning av rubrikparameter.	BackendCredentialsContractHeader
fråga	Beskrivning av frågeparameter.	BackendCredentialsContractQuery

BackendAuthorizationHeaderCredentials

Namn	Beskrivning	Värde
parameter	Autentiseringsparametervärde.	sträng (krävs) Begränsningar: Min längd = 1 Maximal längd = 300
schema	Namn på autentiseringsschema.	sträng (krävs) Begränsningar: Min längd = 1 Maxlängd = 100

BackendCredentialsContractHeader

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

BackendCredentialsContractQuery

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

BackendProperties

Namn	Beskrivning	Värde
serviceFabricCluster	Egenskaper för Serverdelens Service Fabric-kluster	BackendServiceFabricClusterProperties

BackendServiceFabricClusterEgenskaper

Namn	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 certifikatklusterhanteringstjänsten som används för tls-kommunikation	string[]
serverX509Names	Server X509-certifikatnamnsamling	X509CertificateName[]

X509CertificateName

Namn	Beskrivning	Värde
issuerCertificateThumbprint	Tumavtryck för certifikatutfärdaren.	sträng
Namn	Certifikatets gemensamma namn.	sträng

BackendProxyContract

Namn	Beskrivning	Värde
lösenord	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) Begränsningar: Min längd = 1 Max längd = 2000
användarnamn	Användarnamn för att ansluta till WebProxy-servern	sträng

BackendTlsEgenskaper

Namn	Beskrivning	Värde
validateCertificateChain	Flagga som anger om validering av SSL-certifikatkedja ska göras när du använder självsignerade certifikat för den här serverdelsvärden.	Bool
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.	Bool

Resursdefinition för ARM-mall

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

Resursgrupper – Se resursgruppsdistributionskommandon

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

Egenskapsvärden

tjänst/serverdelar

Namn	Beskrivning	Värde
typ	Resurstypen	"Microsoft.ApiManagement/service/backends"
apiVersion	Resurs-API-versionen	'2021-08-01'
Namn	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.
Egenskaper	Egenskaper för serverdelsentitetskontrakt.	BackendContractProperties

BackendContractProperties

Namn	Beskrivning	Värde
Autentiseringsuppgifter	Egenskaper för backend-autentiseringsuppgifter för kontrakt	BackendCredentialsContract
beskrivning	Serverdelsbeskrivning.	sträng Begränsningar: Min längd = 1 Max längd = 2000
Egenskaper	Kontrakt för serverdelsegenskaper	BackendProperties
protokoll	Protokoll för serverdelskommunikation.	"`http`" "soap" (krävs)
proxyserver	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 Begränsningar: Min längd = 1 Max längd = 2000
titel	Serverdelsrubrik.	sträng Begränsningar: Min längd = 1 Maximal längd = 300
tls	Egenskaper för serverdels-TLS	BackendTlsProperties
URL	Körnings-URL för serverdelen.	sträng (krävs) Begränsningar: Min längd = 1 Max längd = 2000

BackendCredentialsContract

Namn	Beskrivning	Värde
tillstånd	Auktoriseringshuvudautentisering	BackendAuthorizationHeaderCredentials
intyg	Lista över tumavtryck för klientcertifikat. Ignoreras om certificatesIds tillhandahålls.	string[] Begränsningar: Max längd = 32
certificateIds	Lista över klientcertifikat-ID:t.	string[] Begränsningar: Max längd = 32
rubrik	Beskrivning av rubrikparameter.	BackendCredentialsContractHeader
fråga	Beskrivning av frågeparameter.	BackendCredentialsContractQuery

BackendAuthorizationHeaderCredentials

Namn	Beskrivning	Värde
parameter	Autentiseringsparametervärde.	sträng (krävs) Begränsningar: Min längd = 1 Maximal längd = 300
schema	Namn på autentiseringsschema.	sträng (krävs) Begränsningar: Min längd = 1 Maxlängd = 100

BackendCredentialsContractHeader

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

BackendCredentialsContractQuery

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

BackendProperties

Namn	Beskrivning	Värde
serviceFabricCluster	Egenskaper för Serverdelens Service Fabric-kluster	BackendServiceFabricClusterProperties

BackendServiceFabricClusterEgenskaper

Namn	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 certifikatklusterhanteringstjänsten som används för tls-kommunikation	string[]
serverX509Names	Server X509-certifikatnamnsamling	X509CertificateName[]

X509CertificateName

Namn	Beskrivning	Värde
issuerCertificateThumbprint	Tumavtryck för certifikatutfärdaren.	sträng
Namn	Certifikatets gemensamma namn.	sträng

BackendProxyContract

Namn	Beskrivning	Värde
lösenord	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) Begränsningar: Min längd = 1 Max längd = 2000
användarnamn	Användarnamn för att ansluta till WebProxy-servern	sträng

BackendTlsEgenskaper

Namn	Beskrivning	Värde
validateCertificateChain	Flagga som anger om validering av SSL-certifikatkedja ska göras när du använder självsignerade certifikat för den här serverdelsvärden.	Bool
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.	Bool

Resursdefinition för Terraform (AzAPI-provider)

Resurstypen tjänst/serverdel 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-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"
    }
  })
}

Egenskapsvärden

tjänst/serverdelar

Namn	Beskrivning	Värde
typ	Resurstypen	"Microsoft.ApiManagement/service/backends@2021-08-01"
Namn	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 för resursen som är överordnad för den här resursen.	ID för resurs av typen: tjänst
Egenskaper	Egenskaper för serverdelsentitetskontrakt.	BackendContractProperties

BackendContractProperties

Namn	Beskrivning	Värde
Autentiseringsuppgifter	Egenskaper för backend-autentiseringsuppgifter för kontrakt	BackendCredentialsContract
beskrivning	Serverdelsbeskrivning.	sträng Begränsningar: Min längd = 1 Max längd = 2000
Egenskaper	Kontrakt för serverdelsegenskaper	BackendProperties
protokoll	Protokoll för serverdelskommunikation.	"`http`" "soap" (krävs)
proxyserver	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 Begränsningar: Min längd = 1 Max längd = 2000
titel	Serverdelsrubrik.	sträng Begränsningar: Min längd = 1 Maximal längd = 300
tls	Egenskaper för serverdels-TLS	BackendTlsProperties
URL	Körnings-URL för serverdelen.	sträng (krävs) Begränsningar: Min längd = 1 Max längd = 2000

BackendCredentialsContract

Namn	Beskrivning	Värde
tillstånd	Auktoriseringshuvudautentisering	BackendAuthorizationHeaderCredentials
intyg	Lista över tumavtryck för klientcertifikat. Ignoreras om certificatesIds tillhandahålls.	string[] Begränsningar: Max längd = 32
certificateIds	Lista över klientcertifikat-ID:t.	string[] Begränsningar: Max längd = 32
rubrik	Beskrivning av rubrikparameter.	BackendCredentialsContractHeader
fråga	Beskrivning av frågeparameter.	BackendCredentialsContractQuery

BackendAuthorizationHeaderCredentials

Namn	Beskrivning	Värde
parameter	Autentiseringsparametervärde.	sträng (krävs) Begränsningar: Min längd = 1 Maximal längd = 300
schema	Namn på autentiseringsschema.	sträng (krävs) Begränsningar: Min längd = 1 Maxlängd = 100

BackendCredentialsContractHeader

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

BackendCredentialsContractQuery

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

BackendProperties

Namn	Beskrivning	Värde
serviceFabricCluster	Egenskaper för Serverdelens Service Fabric-kluster	BackendServiceFabricClusterProperties

BackendServiceFabricClusterEgenskaper

Namn	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 certifikatklusterhanteringstjänsten som används för tls-kommunikation	string[]
serverX509Names	Server X509-certifikatnamnsamling	X509CertificateName[]

X509CertificateName

Namn	Beskrivning	Värde
issuerCertificateThumbprint	Tumavtryck för certifikatutfärdaren.	sträng
Namn	Certifikatets gemensamma namn.	sträng

BackendProxyContract

Namn	Beskrivning	Värde
lösenord	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) Begränsningar: Min längd = 1 Max längd = 2000
användarnamn	Användarnamn för att ansluta till WebProxy-servern	sträng

BackendTlsEgenskaper

Namn	Beskrivning	Värde
validateCertificateChain	Flagga som anger om validering av SSL-certifikatkedja ska göras när du använder självsignerade certifikat för den här serverdelsvärden.	Bool
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.	Bool

Dela via

Microsoft.ApiManagement service/backends 2021-08-01

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

Feedback

Ytterligare resurser