Dela via

Microsoft.ApiManagement service/backends 2022-08-01

  • Artikel

Bicep-resursdefinition

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

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@2022-08-01' = {
  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'
  }
}

Egenskapsvärden

BackendAuthorizationHeaderCredentials

Namn Beskrivning Värde
parameter Autentiseringsparametervärde. sträng

Begränsningar:
Min längd = 1
Maximal längd = 1 (krävs)
schema Namn på autentiseringsschema. sträng

Begränsningar:
Min längd = 1
Maximal längd = 1 (krävs)

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
Maximal längd = 1
Egenskaper Kontrakt för serverdelsegenskaper BackendProperties
protokoll Protokoll för serverdelskommunikation. "http"
"soap" (krävs)
proxyserver Egenskaper för serverdelsgatewaykontrakt 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-appar. sträng

Begränsningar:
Min längd = 1
Maximal längd = 1
titel Serverdelsrubrik. sträng

Begränsningar:
Min längd = 1
Maximal längd = 1
tls Egenskaper för serverdels-TLS BackendTlsProperties
URL Körnings-URL för serverdelen. sträng

Begränsningar:
Min längd = 1
Maximal längd = 1 (krävs)

BackendCredentialsContract

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

BackendCredentialsContractHeader

Namn Beskrivning Värde

BackendCredentialsContractQuery

Namn Beskrivning Värde

BackendProperties

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

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

Begränsningar:
Min längd = 1
Maximal längd = 1 (krävs)
användarnamn Användarnamn för att ansluta till WebProxy-servern sträng

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[]

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

Microsoft.ApiManagement/service/backends

Namn Beskrivning Värde
Namn Resursnamnet sträng

Begränsningar:
Min längd = 1
Maximal längd = 1 (krävs)
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

X509CertificateName

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

Resursdefinition för ARM-mall

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

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": "2022-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

BackendAuthorizationHeaderCredentials

Namn Beskrivning Värde
parameter Autentiseringsparametervärde. sträng

Begränsningar:
Min längd = 1
Maximal längd = 1 (krävs)
schema Namn på autentiseringsschema. sträng

Begränsningar:
Min längd = 1
Maximal längd = 1 (krävs)

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
Maximal längd = 1
Egenskaper Kontrakt för serverdelsegenskaper BackendProperties
protokoll Protokoll för serverdelskommunikation. "http"
"soap" (krävs)
proxyserver Egenskaper för serverdelsgatewaykontrakt 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-appar. sträng

Begränsningar:
Min längd = 1
Maximal längd = 1
titel Serverdelsrubrik. sträng

Begränsningar:
Min längd = 1
Maximal längd = 1
tls Egenskaper för serverdels-TLS BackendTlsProperties
URL Körnings-URL för serverdelen. sträng

Begränsningar:
Min längd = 1
Maximal längd = 1 (krävs)

BackendCredentialsContract

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

BackendCredentialsContractHeader

Namn Beskrivning Värde

BackendCredentialsContractQuery

Namn Beskrivning Värde

BackendProperties

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

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

Begränsningar:
Min längd = 1
Maximal längd = 1 (krävs)
användarnamn Användarnamn för att ansluta till WebProxy-servern sträng

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[]

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

Microsoft.ApiManagement/service/backends

Namn Beskrivning Värde
apiVersion API-versionen '2022-08-01'
Namn Resursnamnet sträng

Begränsningar:
Min längd = 1
Maximal längd = 1 (krävs)
Egenskaper Egenskaper för serverdelsentitetskontrakt. BackendContractProperties
typ Resurstypen "Microsoft.ApiManagement/service/backends"

X509CertificateName

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

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@2022-08-01"
  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"
    }
  })
}

Egenskapsvärden

BackendAuthorizationHeaderCredentials

Namn Beskrivning Värde
parameter Autentiseringsparametervärde. sträng

Begränsningar:
Min längd = 1
Maximal längd = 1 (krävs)
schema Namn på autentiseringsschema. sträng

Begränsningar:
Min längd = 1
Maximal längd = 1 (krävs)

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
Maximal längd = 1
Egenskaper Kontrakt för serverdelsegenskaper BackendProperties
protokoll Protokoll för serverdelskommunikation. "http"
"soap" (krävs)
proxyserver Egenskaper för serverdelsgatewaykontrakt 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-appar. sträng

Begränsningar:
Min längd = 1
Maximal längd = 1
titel Serverdelsrubrik. sträng

Begränsningar:
Min längd = 1
Maximal längd = 1
tls Egenskaper för serverdels-TLS BackendTlsProperties
URL Körnings-URL för serverdelen. sträng

Begränsningar:
Min längd = 1
Maximal längd = 1 (krävs)

BackendCredentialsContract

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

BackendCredentialsContractHeader

Namn Beskrivning Värde

BackendCredentialsContractQuery

Namn Beskrivning Värde

BackendProperties

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

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

Begränsningar:
Min längd = 1
Maximal längd = 1 (krävs)
användarnamn Användarnamn för att ansluta till WebProxy-servern sträng

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[]

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

Microsoft.ApiManagement/service/backends

Namn Beskrivning Värde
Namn Resursnamnet sträng

Begränsningar:
Min längd = 1
Maximal längd = 1 (krävs)
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
typ Resurstypen "Microsoft.ApiManagement/service/backends@2022-08-01"

X509CertificateName

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