Servizio Microsoft.ApiManagement/back-end 2021-12-01-preview

Articolo
01/18/2024

Definizione di risorsa Bicep

Il tipo di risorsa del servizio/back-end può essere distribuito con operazioni destinate a:

Gruppi di risorse - Vedere i comandi di distribuzione dei gruppi di risorse

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

Formato di risorsa

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

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

Valori delle proprietà

service/backends

Nome	Descrizione	valore
name	Nome della risorsa Vedere come impostare nomi e tipi per le risorse figlio in Bicep.	stringa (obbligatorio) Limite di caratteri: 1-80 Caratteri validi: Caratteri alfanumerici e trattini. Inizia con la lettera e termina con alfanumerico.
padre	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 esterna alla risorsa padre.	Nome simbolico per la risorsa di tipo: servizio
properties	Proprietà del contratto di entità back-end.	BackendContractProperties

BackendContractProperties

Nome	Descrizione	Valore
credentials	Proprietà del contratto credenziali back-end	BackendCredentialsContract
description	Descrizione back-end.	string
properties	Contratto proprietà back-end	Proprietà back-end
protocol	Protocollo di comunicazione back-end.	'http' 'soap' (obbligatorio)
proxy	Proprietà del contratto proxy 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.	string
title	Titolo back-end.	string
Tls	Proprietà TLS back-end	BackendTlsProperties
url	URL di runtime del back-end.	stringa (obbligatorio)

BackendCredentialsContract

Nome	Descrizione	Valore
authorization	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[]
header	Descrizione del parametro di intestazione.	BackendCredentialsContractHeader
query	Descrizione del parametro di query.	BackendCredentialsContractQuery

BackendAuthorizationHeaderCredentials

Nome	Descrizione	Valore
parameter	Valore del parametro di autenticazione.	stringa (obbligatorio)
scheme	Nome schema di autenticazione.	stringa (obbligatoria)

BackCredentialsContractHeader

Nome	Descrizione	Valore
{proprietà personalizzata}		string[]

Back-endCredentialsContractQuery

Nome	Descrizione	Valore
{proprietà personalizzata}		string[]

Back-endProperties

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

BackServiceFabricClusterProperties

Nome	Descrizione	Valore
clientCertificateId	ID certificato client per l'endpoint di gestione.	string
clientCertificatethumbprint	Identificazione personale del certificato client per l'endpoint di gestione. Verrà ignorato se vengono forniti certificatiId	string
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 usano per la comunicazione tls	string[]
serverX509Names	Raccolta Nomi certificati server X509	X509CertificateName[]

X509CertificateName

Nome	Descrizione	Valore
emittenteCertificateThumbprint	Identificazione personale per l'autorità emittente del certificato.	string
name	Nome comune del certificato.	string

BackProxyContract

Nome	Descrizione	Valore
password	Password per connettersi al server WebProxy	string
url	Proprietà WebProxy Server AbsoluteUri che include l'intero URI archiviato nell'istanza di Uri, inclusi tutti i frammenti e le stringhe di query.	stringa (obbligatoria)
username	Nome utente per connettersi al server WebProxy	string

Back-endTlsProperties

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 certificato SSL deve essere eseguita quando si usano certificati autofirmato per questo host back-end.	bool

Definizione della risorsa modello di Resource Manager

Il tipo di risorsa service/back-end può essere distribuito con operazioni destinate:

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 di risorsa

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

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

Valori delle proprietà

service/back-end

Nome	Descrizione	Valore
tipo	Tipo di risorsa	'Microsoft.ApiManagement/service/back-end'
apiVersion	Versione dell'API risorsa	'2021-12-01-preview'
name	Nome della risorsa Vedere come impostare nomi e tipi per le risorse figlio nei modelli di RESOURCE JSON.	stringa (obbligatoria) Limite di caratteri: 1-80 Caratteri validi: Caratteri alfanumerici e trattini. Inizia con la lettera e termina con alfanumerico.
properties	Proprietà del contratto di entità back-end.	BackendContractProperties

BackendContractProperties

Nome	Descrizione	Valore
credentials	Proprietà del contratto credenziali back-end	BackendCredentialsContract
description	Descrizione back-end.	string
properties	Contratto proprietà back-end	Proprietà back-end
protocol	Protocollo di comunicazione back-end.	'http' 'soap' (obbligatorio)
proxy	Proprietà del contratto proxy 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.	string
title	Titolo back-end.	string
Tls	Proprietà TLS back-end	BackendTlsProperties
url	URL di runtime del back-end.	stringa (obbligatorio)

BackendCredentialsContract

Nome	Descrizione	Valore
authorization	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[]
header	Descrizione del parametro di intestazione.	BackendCredentialsContractHeader
query	Descrizione del parametro di query.	BackendCredentialsContractQuery

BackendAuthorizationHeaderCredentials

Nome	Descrizione	Valore
parameter	Valore del parametro di autenticazione.	stringa (obbligatorio)
scheme	Nome schema di autenticazione.	stringa (obbligatorio)

BackendCredentialsContractHeader

Nome	Descrizione	Valore
{proprietà personalizzata}		string[]

BackendCredentialsContractQuery

Nome	Descrizione	Valore
{proprietà personalizzata}		string[]

Proprietà back-end

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

BackendServiceFabricClusterProperties

Nome	Descrizione	Valore
clientCertificateId	ID certificato client per l'endpoint di gestione.	string
clientCertificatethumbprint	Identificazione personale del certificato client per l'endpoint di gestione. Verrà ignorato se vengono forniti certificatesId	string
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 usano per la comunicazione tls	string[]
serverX509Names	Raccolta Nomi certificati server X509	X509CertificateName[]

X509CertificateName

Nome	Descrizione	Valore
emittenteCertificateThumbprint	Identificazione personale per l'autorità emittente del certificato.	string
name	Nome comune del certificato.	string

BackProxyContract

Nome	Descrizione	Valore
password	Password per connettersi al server WebProxy	string
url	Proprietà WebProxy Server AbsoluteUri che include l'intero URI archiviato nell'istanza di Uri, inclusi tutti i frammenti e le stringhe di query.	stringa (obbligatoria)
username	Nome utente per connettersi al server WebProxy	string

Back-endTlsProperties

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 certificato SSL deve essere eseguita quando si usano certificati autofirmato per questo host back-end.	bool

Definizione della risorsa Terraform (provider AzAPI)

Il tipo di risorsa service/back-end può essere distribuito con operazioni destinate:

Gruppi di risorse

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

Formato di risorsa

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

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

Valori delle proprietà

service/back-end

Nome	Descrizione	Valore
tipo	Tipo di risorsa	"Microsoft.ApiManagement/service/backends@2021-12-01-preview"
name	Nome della risorsa	stringa (obbligatoria) Limite di caratteri: 1-80 Caratteri validi: Caratteri alfanumerici e trattini. Inizia con la lettera e termina con alfanumerico.
parent_id	ID della risorsa padre per questa risorsa.	ID per la risorsa di tipo: servizio
properties	Proprietà del contratto di entità back-end.	Back-endContractProperties

Back-endContractProperties

Nome	Descrizione	Valore
credentials	Proprietà del contratto credenziali back-end	Back-endCredentialsContract
description	Descrizione back-end.	string
properties	Contratto proprietà back-end	Back-endProperties
protocol	Protocollo di comunicazione back-end.	"http" "soap" (obbligatorio)
proxy	Proprietà del contratto proxy back-end	BackProxyContract
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.	string
title	Titolo back-end.	string
Tls	Proprietà TLS back-end	BackendTlsProperties
url	URL di runtime del back-end.	stringa (obbligatorio)

BackendCredentialsContract

Nome	Descrizione	Valore
authorization	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[]
header	Descrizione del parametro di intestazione.	BackendCredentialsContractHeader
query	Descrizione del parametro di query.	BackendCredentialsContractQuery

BackendAuthorizationHeaderCredentials

Nome	Descrizione	Valore
parameter	Valore del parametro di autenticazione.	stringa (obbligatorio)
scheme	Nome schema di autenticazione.	stringa (obbligatorio)

BackendCredentialsContractHeader

Nome	Descrizione	Valore
{proprietà personalizzata}		string[]

BackendCredentialsContractQuery

Nome	Descrizione	Valore
{proprietà personalizzata}		string[]

Proprietà back-end

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

BackendServiceFabricClusterProperties

Nome	Descrizione	Valore
clientCertificateId	ID certificato client per l'endpoint di gestione.	string
clientCertificatethumbprint	Identificazione personale del certificato client per l'endpoint di gestione. Verrà ignorato se vengono forniti certificatesId	string
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 dei nomi dei certificati server X509	X509CertificateName[]

X509CertificateName

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

BackendProxyContract

Nome	Descrizione	Valore
password	Password per la connessione al server WebProxy	string
url	Proprietà AbsoluteUri del server WebProxy che include l'intero URI archiviato nell'istanza Uri, inclusi tutti i frammenti e le stringhe di query.	stringa (obbligatorio)
username	Nome utente per connettersi al server WebProxy	string

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 certificato SSL deve essere eseguita quando si usano certificati autofirmato per questo host back-end.	bool

Condividi tramite

Servizio Microsoft.ApiManagement/back-end 2021-12-01-preview

Definizione di risorsa Bicep

Formato di risorsa

Valori delle proprietà

service/backends

BackendContractProperties

BackendCredentialsContract

BackendAuthorizationHeaderCredentials

BackCredentialsContractHeader

Back-endCredentialsContractQuery

Back-endProperties

BackServiceFabricClusterProperties

X509CertificateName

BackProxyContract

Back-endTlsProperties

Definizione della risorsa modello di Resource Manager

Formato di risorsa

Valori delle proprietà

service/back-end

BackendContractProperties

BackendCredentialsContract

BackendAuthorizationHeaderCredentials

BackendCredentialsContractHeader

BackendCredentialsContractQuery

Proprietà back-end

BackendServiceFabricClusterProperties

X509CertificateName

BackProxyContract

Back-endTlsProperties

Definizione della risorsa Terraform (provider AzAPI)

Formato di risorsa

Valori delle proprietà

service/back-end

Back-endContractProperties

BackendCredentialsContract

BackendAuthorizationHeaderCredentials

BackendCredentialsContractHeader

BackendCredentialsContractQuery

Proprietà back-end

BackendServiceFabricClusterProperties

X509CertificateName

BackendProxyContract

BackendTlsProperties

Risorse aggiuntive