Condividi tramite

Servizio Microsoft.ApiManagement/back-ends 2023-05-01-preview

  • Articolo

Definizione di risorsa Bicep

Il tipo di risorsa service/backends può essere distribuito con operazioni destinate a:

  • gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.ApiManagement/service/backends, aggiungere il bicep seguente al modello.

resource symbolicname 'Microsoft.ApiManagement/service/backends@2023-05-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    circuitBreaker: {
      rules: [
        {
          failureCondition: {
            count: int
            errorReasons: [
              'string'
            ]
            interval: 'string'
            percentage: int
            statusCodeRanges: [
              {
                max: int
                min: int
              }
            ]
          }
          name: 'string'
          tripDuration: 'string'
        }
      ]
    }
    credentials: {
      authorization: {
        parameter: 'string'
        scheme: 'string'
      }
      certificate: [
        'string'
      ]
      certificateIds: [
        'string'
      ]
      header: {
        {customized property}: [
          'string'
        ]
      }
      query: {
        {customized property}: [
          'string'
        ]
      }
    }
    description: 'string'
    pool: {
      services: [
        {
          id: '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
    }
    type: 'string'
    url: 'string'
  }
}

Valori delle proprietà

BackendAuthorizationHeaderCredentials

Nome Descrizione Valore
parametro Valore del parametro di autenticazione. corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1 (obbligatorio)
schema Nome schema di autenticazione. corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1 (obbligatorio)

BackendBaseParametersPool

Nome Descrizione Valore
servizi Elenco di entità back-end appartenenti a un pool. BackendPoolItem []

BackendCircuitBreaker

Nome Descrizione Valore
norme Regole per il tripping del back-end. CircuitBreakerRule[]

BackendContractProperties

Nome Descrizione Valore
circuitBreaker Configurazione dell'interruttore back-end back-endCircuitBreaker
credenziali Proprietà del contratto credenziali back-end BackendCredentialsContract
descrizione Descrizione back-end. corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1
pozza BackendBaseParametersPool
proprietà Contratto proprietà back-end Proprietà back-end
protocollo Protocollo di comunicazione back-end. 'http'
'soap' (obbligatorio)
procura Proprietà del contratto del gateway back-end BackendProxyContract
resourceId URI di gestione della risorsa nel sistema esterno. Questo URL può essere l'ID risorsa arm di App per la logica, app per le funzioni o app per le API. corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1
titolo Titolo back-end. corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1
tls Proprietà TLS back-end BackendTlsProperties
digitare Tipo del back-end. Un back-end può essere singolo o pool. 'Pool'
'Single'
URL URL di runtime del back-end. corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1 (obbligatorio)

BackendCredentialsContract

Nome Descrizione Valore
autorizzazione Autenticazione dell'intestazione dell'autorizzazione BackendAuthorizationHeaderCredentials
certificato Elenco delle identificazioni personali del certificato client. Verrà ignorato se vengono forniti certificatesId. string[]
certificateIds Elenco di ID certificato client. string[]
intestazione Descrizione del parametro di intestazione. BackendCredentialsContractHeader
quesito Descrizione del parametro di query. BackendCredentialsContractQuery

BackendCredentialsContractHeader

Nome Descrizione Valore

BackendCredentialsContractQuery

Nome Descrizione Valore

BackendPoolItem

Nome Descrizione Valore
Id ID ARM univoco dell'entità back-end. L'ID ARM deve fare riferimento a un'entità back-end già esistente. stringa (obbligatorio)

Back-endProprietà

Nome Descrizione Valore
serviceFabricCluster Proprietà del cluster back-end di Service Fabric BackendServiceFabricClusterProperties

BackendProxyContract

Nome Descrizione Valore
parola d’ordine Password per la connessione al server WebProxy corda
URL Proprietà AbsoluteUri del server WebProxy che include l'intero URI archiviato nell'istanza Uri, inclusi tutti i frammenti e le stringhe di query. corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1 (obbligatorio)
nome utente Nome utente per la connessione al server WebProxy corda

BackendServiceFabricClusterProperties

Nome Descrizione Valore
clientCertificateId ID certificato client per l'endpoint di gestione. corda
clientCertificatethumbprint Identificazione personale del certificato client per l'endpoint di gestione. Verrà ignorato se vengono forniti certificatiId corda
managementEndpoints Endpoint di gestione del cluster. string[] (obbligatorio)
maxPartitionResolutionRetries Numero massimo di tentativi durante il tentativo di risolvere la partizione. Int
serverCertificateThumbprints Identificazioni personali del servizio di gestione del cluster certificati usati per la comunicazione tls string[]
serverX509Names Raccolta nomi certificati server X509 X509CertificateName[]

BackendTlsProperties

Nome Descrizione Valore
validateCertificateChain Flag che indica se la convalida della catena di certificati SSL deve essere eseguita quando si usano certificati autofirmato per questo host back-end. Bool
validateCertificateName Flag che indica se la convalida del nome del certificato SSL deve essere eseguita quando si usano certificati autofirmato per questo host back-end. Bool

CircuitBreakerFailureCondition

Nome Descrizione Valore
contare Soglia per l'apertura del circuito. Int
errorReasons Motivi dell'errore considerati come errori. corda

Vincoli:
Lunghezza massima = []
intervallo Intervallo durante il quale vengono conteggiati gli errori. corda
percentuale Soglia per l'apertura del circuito. Int
statusCodeRanges Intervalli di codici di stato considerati come errori. FailureStatusCodeRange[]

CircuitBreakerRule

Nome Descrizione Valore
failureCondition Condizioni per il tripping dell'interruttore. CircuitBreakerFailureCondition
nome Nome della regola. corda
tripDuration Durata per cui verrà ritagliato il circuito. corda

FailureStatusCodeRange

Nome Descrizione Valore
Max Codice di stato http massimo. Int

Vincoli:
Valore minimo = 200
Valore massimo = 599
Min Codice di stato http minimo. Int

Vincoli:
Valore minimo = 200
Valore massimo = 599

Microsoft.ApiManagement/service/backends

Nome Descrizione Valore
nome Nome della risorsa corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1 (obbligatorio)
genitore In Bicep è possibile specificare la risorsa padre per una risorsa figlio. È necessario aggiungere questa proprietà solo quando la risorsa figlio viene dichiarata all'esterno della risorsa padre.

Per altre informazioni, vedere risorsa figlio all'esterno della risorsa padre.		 Nome simbolico per la risorsa di tipo: servizio
proprietà Proprietà del contratto di entità back-end. BackendContractProperties

X509CertificateName

Nome Descrizione Valore
issuerCertificateThumbprint Identificazione personale per l'autorità emittente del certificato. corda
nome Nome comune del certificato. corda

Definizione di risorsa del modello di Resource Manager

Il tipo di risorsa service/backends può essere distribuito con operazioni destinate a:

  • gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.ApiManagement/service/backends, aggiungere il codice JSON seguente al modello.

{
  "type": "Microsoft.ApiManagement/service/backends",
  "apiVersion": "2023-05-01-preview",
  "name": "string",
  "properties": {
    "circuitBreaker": {
      "rules": [
        {
          "failureCondition": {
            "count": "int",
            "errorReasons": [ "string" ],
            "interval": "string",
            "percentage": "int",
            "statusCodeRanges": [
              {
                "max": "int",
                "min": "int"
              }
            ]
          },
          "name": "string",
          "tripDuration": "string"
        }
      ]
    },
    "credentials": {
      "authorization": {
        "parameter": "string",
        "scheme": "string"
      },
      "certificate": [ "string" ],
      "certificateIds": [ "string" ],
      "header": {
        "{customized property}": [ "string" ]
      },
      "query": {
        "{customized property}": [ "string" ]
      }
    },
    "description": "string",
    "pool": {
      "services": [
        {
          "id": "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"
    },
    "type": "string",
    "url": "string"
  }
}

Valori delle proprietà

BackendAuthorizationHeaderCredentials

Nome Descrizione Valore
parametro Valore del parametro di autenticazione. corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1 (obbligatorio)
schema Nome schema di autenticazione. corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1 (obbligatorio)

BackendBaseParametersPool

Nome Descrizione Valore
servizi Elenco di entità back-end appartenenti a un pool. BackendPoolItem []

BackendCircuitBreaker

Nome Descrizione Valore
norme Regole per il tripping del back-end. CircuitBreakerRule[]

BackendContractProperties

Nome Descrizione Valore
circuitBreaker Configurazione dell'interruttore back-end back-endCircuitBreaker
credenziali Proprietà del contratto credenziali back-end BackendCredentialsContract
descrizione Descrizione back-end. corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1
pozza BackendBaseParametersPool
proprietà Contratto proprietà back-end Proprietà back-end
protocollo Protocollo di comunicazione back-end. 'http'
'soap' (obbligatorio)
procura Proprietà del contratto del gateway back-end BackendProxyContract
resourceId URI di gestione della risorsa nel sistema esterno. Questo URL può essere l'ID risorsa arm di App per la logica, app per le funzioni o app per le API. corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1
titolo Titolo back-end. corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1
tls Proprietà TLS back-end BackendTlsProperties
digitare Tipo del back-end. Un back-end può essere singolo o pool. 'Pool'
'Single'
URL URL di runtime del back-end. corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1 (obbligatorio)

BackendCredentialsContract

Nome Descrizione Valore
autorizzazione Autenticazione dell'intestazione dell'autorizzazione BackendAuthorizationHeaderCredentials
certificato Elenco delle identificazioni personali del certificato client. Verrà ignorato se vengono forniti certificatesId. string[]
certificateIds Elenco di ID certificato client. string[]
intestazione Descrizione del parametro di intestazione. BackendCredentialsContractHeader
quesito Descrizione del parametro di query. BackendCredentialsContractQuery

BackendCredentialsContractHeader

Nome Descrizione Valore

BackendCredentialsContractQuery

Nome Descrizione Valore

BackendPoolItem

Nome Descrizione Valore
Id ID ARM univoco dell'entità back-end. L'ID ARM deve fare riferimento a un'entità back-end già esistente. stringa (obbligatorio)

Back-endProprietà

Nome Descrizione Valore
serviceFabricCluster Proprietà del cluster back-end di Service Fabric BackendServiceFabricClusterProperties

BackendProxyContract

Nome Descrizione Valore
parola d’ordine Password per la connessione al server WebProxy corda
URL Proprietà AbsoluteUri del server WebProxy che include l'intero URI archiviato nell'istanza Uri, inclusi tutti i frammenti e le stringhe di query. corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1 (obbligatorio)
nome utente Nome utente per la connessione al server WebProxy corda

BackendServiceFabricClusterProperties

Nome Descrizione Valore
clientCertificateId ID certificato client per l'endpoint di gestione. corda
clientCertificatethumbprint Identificazione personale del certificato client per l'endpoint di gestione. Verrà ignorato se vengono forniti certificatiId corda
managementEndpoints Endpoint di gestione del cluster. string[] (obbligatorio)
maxPartitionResolutionRetries Numero massimo di tentativi durante il tentativo di risolvere la partizione. Int
serverCertificateThumbprints Identificazioni personali del servizio di gestione del cluster certificati usati per la comunicazione tls string[]
serverX509Names Raccolta nomi certificati server X509 X509CertificateName[]

BackendTlsProperties

Nome Descrizione Valore
validateCertificateChain Flag che indica se la convalida della catena di certificati SSL deve essere eseguita quando si usano certificati autofirmato per questo host back-end. Bool
validateCertificateName Flag che indica se la convalida del nome del certificato SSL deve essere eseguita quando si usano certificati autofirmato per questo host back-end. Bool

CircuitBreakerFailureCondition

Nome Descrizione Valore
contare Soglia per l'apertura del circuito. Int
errorReasons Motivi dell'errore considerati come errori. corda

Vincoli:
Lunghezza massima = []
intervallo Intervallo durante il quale vengono conteggiati gli errori. corda
percentuale Soglia per l'apertura del circuito. Int
statusCodeRanges Intervalli di codici di stato considerati come errori. FailureStatusCodeRange[]

CircuitBreakerRule

Nome Descrizione Valore
failureCondition Condizioni per il tripping dell'interruttore. CircuitBreakerFailureCondition
nome Nome della regola. corda
tripDuration Durata per cui verrà ritagliato il circuito. corda

FailureStatusCodeRange

Nome Descrizione Valore
Max Codice di stato http massimo. Int

Vincoli:
Valore minimo = 200
Valore massimo = 599
Min Codice di stato http minimo. Int

Vincoli:
Valore minimo = 200
Valore massimo = 599

Microsoft.ApiManagement/service/backends

Nome Descrizione Valore
apiVersion Versione dell'API '2023-05-01-preview'
nome Nome della risorsa corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1 (obbligatorio)
proprietà Proprietà del contratto di entità back-end. BackendContractProperties
digitare Tipo di risorsa 'Microsoft.ApiManagement/service/backends'

X509CertificateName

Nome Descrizione Valore
issuerCertificateThumbprint Identificazione personale per l'autorità emittente del certificato. corda
nome Nome comune del certificato. corda

Definizione di risorsa Terraform (provider AzAPI)

Il tipo di risorsa service/backends può essere distribuito con operazioni destinate a:

  • gruppi di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.ApiManagement/service/backends, aggiungere il codice Terraform seguente al modello.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/backends@2023-05-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      circuitBreaker = {
        rules = [
          {
            failureCondition = {
              count = int
              errorReasons = [
                "string"
              ]
              interval = "string"
              percentage = int
              statusCodeRanges = [
                {
                  max = int
                  min = int
                }
              ]
            }
            name = "string"
            tripDuration = "string"
          }
        ]
      }
      credentials = {
        authorization = {
          parameter = "string"
          scheme = "string"
        }
        certificate = [
          "string"
        ]
        certificateIds = [
          "string"
        ]
        header = {
          {customized property} = [
            "string"
          ]
        }
        query = {
          {customized property} = [
            "string"
          ]
        }
      }
      description = "string"
      pool = {
        services = [
          {
            id = "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
      }
      type = "string"
      url = "string"
    }
  })
}

Valori delle proprietà

BackendAuthorizationHeaderCredentials

Nome Descrizione Valore
parametro Valore del parametro di autenticazione. corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1 (obbligatorio)
schema Nome schema di autenticazione. corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1 (obbligatorio)

BackendBaseParametersPool

Nome Descrizione Valore
servizi Elenco di entità back-end appartenenti a un pool. BackendPoolItem []

BackendCircuitBreaker

Nome Descrizione Valore
norme Regole per il tripping del back-end. CircuitBreakerRule[]

BackendContractProperties

Nome Descrizione Valore
circuitBreaker Configurazione dell'interruttore back-end back-endCircuitBreaker
credenziali Proprietà del contratto credenziali back-end BackendCredentialsContract
descrizione Descrizione back-end. corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1
pozza BackendBaseParametersPool
proprietà Contratto proprietà back-end Proprietà back-end
protocollo Protocollo di comunicazione back-end. 'http'
'soap' (obbligatorio)
procura Proprietà del contratto del gateway back-end BackendProxyContract
resourceId URI di gestione della risorsa nel sistema esterno. Questo URL può essere l'ID risorsa arm di App per la logica, app per le funzioni o app per le API. corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1
titolo Titolo back-end. corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1
tls Proprietà TLS back-end BackendTlsProperties
digitare Tipo del back-end. Un back-end può essere singolo o pool. 'Pool'
'Single'
URL URL di runtime del back-end. corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1 (obbligatorio)

BackendCredentialsContract

Nome Descrizione Valore
autorizzazione Autenticazione dell'intestazione dell'autorizzazione BackendAuthorizationHeaderCredentials
certificato Elenco delle identificazioni personali del certificato client. Verrà ignorato se vengono forniti certificatesId. string[]
certificateIds Elenco di ID certificato client. string[]
intestazione Descrizione del parametro di intestazione. BackendCredentialsContractHeader
quesito Descrizione del parametro di query. BackendCredentialsContractQuery

BackendCredentialsContractHeader

Nome Descrizione Valore

BackendCredentialsContractQuery

Nome Descrizione Valore

BackendPoolItem

Nome Descrizione Valore
Id ID ARM univoco dell'entità back-end. L'ID ARM deve fare riferimento a un'entità back-end già esistente. stringa (obbligatorio)

Back-endProprietà

Nome Descrizione Valore
serviceFabricCluster Proprietà del cluster back-end di Service Fabric BackendServiceFabricClusterProperties

BackendProxyContract

Nome Descrizione Valore
parola d’ordine Password per la connessione al server WebProxy corda
URL Proprietà AbsoluteUri del server WebProxy che include l'intero URI archiviato nell'istanza Uri, inclusi tutti i frammenti e le stringhe di query. corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1 (obbligatorio)
nome utente Nome utente per la connessione al server WebProxy corda

BackendServiceFabricClusterProperties

Nome Descrizione Valore
clientCertificateId ID certificato client per l'endpoint di gestione. corda
clientCertificatethumbprint Identificazione personale del certificato client per l'endpoint di gestione. Verrà ignorato se vengono forniti certificatiId corda
managementEndpoints Endpoint di gestione del cluster. string[] (obbligatorio)
maxPartitionResolutionRetries Numero massimo di tentativi durante il tentativo di risolvere la partizione. Int
serverCertificateThumbprints Identificazioni personali del servizio di gestione del cluster certificati usati per la comunicazione tls string[]
serverX509Names Raccolta nomi certificati server X509 X509CertificateName[]

BackendTlsProperties

Nome Descrizione Valore
validateCertificateChain Flag che indica se la convalida della catena di certificati SSL deve essere eseguita quando si usano certificati autofirmato per questo host back-end. Bool
validateCertificateName Flag che indica se la convalida del nome del certificato SSL deve essere eseguita quando si usano certificati autofirmato per questo host back-end. Bool

CircuitBreakerFailureCondition

Nome Descrizione Valore
contare Soglia per l'apertura del circuito. Int
errorReasons Motivi dell'errore considerati come errori. corda

Vincoli:
Lunghezza massima = []
intervallo Intervallo durante il quale vengono conteggiati gli errori. corda
percentuale Soglia per l'apertura del circuito. Int
statusCodeRanges Intervalli di codici di stato considerati come errori. FailureStatusCodeRange[]

CircuitBreakerRule

Nome Descrizione Valore
failureCondition Condizioni per il tripping dell'interruttore. CircuitBreakerFailureCondition
nome Nome della regola. corda
tripDuration Durata per cui verrà ritagliato il circuito. corda

FailureStatusCodeRange

Nome Descrizione Valore
Max Codice di stato http massimo. Int

Vincoli:
Valore minimo = 200
Valore massimo = 599
Min Codice di stato http minimo. Int

Vincoli:
Valore minimo = 200
Valore massimo = 599

Microsoft.ApiManagement/service/backends

Nome Descrizione Valore
nome Nome della risorsa corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1 (obbligatorio)
parent_id ID della risorsa padre per questa risorsa. ID per la risorsa di tipo: servizio
proprietà Proprietà del contratto di entità back-end. BackendContractProperties
digitare Tipo di risorsa "Microsoft.ApiManagement/service/backends@2023-05-01-preview"

X509CertificateName

Nome Descrizione Valore
issuerCertificateThumbprint Identificazione personale per l'autorità emittente del certificato. corda
nome Nome comune del certificato. corda