Servizio Microsoft.ApiManagement/back-end 2021-08-01
- più recenti
- 2023-09-01-preview
- 2022-08-01
- 2021-08-01
Definizione di risorsa Bicep
Il tipo di risorsa service/backends può essere distribuito con operazioni destinate a:
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@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'
}
}
Valori delle proprietà
service/backends
| Nome | Descrizione | Valore |
|---|---|---|
| nome | 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. |
| 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 |
BackendContractProperties
| Nome | Descrizione | Valore |
|---|---|---|
| credenziali | Proprietà del contratto credenziali back-end | BackendCredentialsContract |
| descrizione | Descrizione back-end. | corda Vincoli: Lunghezza minima = 1 Lunghezza massima = 2000 |
| proprietà | Contratto proprietà back-end | Proprietà back-end |
| protocollo | Protocollo di comunicazione back-end. | 'http''soap' (obbligatorio) |
| procura | 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. | corda Vincoli: Lunghezza minima = 1 Lunghezza massima = 2000 |
| titolo | Titolo back-end. | corda Vincoli: Lunghezza minima = 1 Lunghezza massima = 300 |
| tls | Proprietà TLS back-end | BackendTlsProperties |
| URL | URL di runtime del back-end. | stringa (obbligatorio) Vincoli: Lunghezza minima = 1 Lunghezza massima = 2000 |
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[] Vincoli: Lunghezza massima = 32 |
| certificateIds | Elenco di ID certificato client. | string[] Vincoli: Lunghezza massima = 32 |
| intestazione | Descrizione del parametro di intestazione. | BackendCredentialsContractHeader |
| quesito | Descrizione del parametro di query. | BackendCredentialsContractQuery |
BackendAuthorizationHeaderCredentials
| Nome | Descrizione | Valore |
|---|---|---|
| parametro | Valore del parametro di autenticazione. | stringa (obbligatorio) Vincoli: Lunghezza minima = 1 Lunghezza massima = 300 |
| schema | Nome schema di autenticazione. | stringa (obbligatorio) Vincoli: Lunghezza minima = 1 Lunghezza massima = 100 |
BackendCredentialsContractHeader
| Nome | Descrizione | Valore |
|---|---|---|
| {proprietà personalizzata} | string[] |
BackendCredentialsContractQuery
| Nome | Descrizione | Valore |
|---|---|---|
| {proprietà personalizzata} | string[] |
Back-endProprietà
| 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. | 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[] |
X509CertificateName
| Nome | Descrizione | Valore |
|---|---|---|
| issuerCertificateThumbprint | Identificazione personale per l'autorità emittente del certificato. | corda |
| nome | Nome comune del certificato. | corda |
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. | stringa (obbligatorio) Vincoli: Lunghezza minima = 1 Lunghezza massima = 2000 |
| nome utente | Nome utente per la connessione al server WebProxy | corda |
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 |
Definizione di risorsa del modello di Resource Manager
Il tipo di risorsa service/backends può essere distribuito con operazioni destinate a:
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": "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"
}
}
Valori delle proprietà
service/backends
| Nome | Descrizione | Valore |
|---|---|---|
| digitare | Tipo di risorsa | 'Microsoft.ApiManagement/service/backends' |
| apiVersion | Versione dell'API della risorsa | '2021-08-01' |
| nome | Nome della risorsa Vedere come impostare nomi e tipi per le risorse figlio in modelli DI Resource Manager JSON. |
stringa (obbligatorio) Limite di caratteri: 1-80 Caratteri validi: Caratteri alfanumerici e trattini. Inizia con la lettera e termina con alfanumerico. |
| proprietà | Proprietà del contratto di entità back-end. | BackendContractProperties |
BackendContractProperties
| Nome | Descrizione | Valore |
|---|---|---|
| credenziali | Proprietà del contratto credenziali back-end | BackendCredentialsContract |
| descrizione | Descrizione back-end. | corda Vincoli: Lunghezza minima = 1 Lunghezza massima = 2000 |
| proprietà | Contratto proprietà back-end | Proprietà back-end |
| protocollo | Protocollo di comunicazione back-end. | 'http''soap' (obbligatorio) |
| procura | 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. | corda Vincoli: Lunghezza minima = 1 Lunghezza massima = 2000 |
| titolo | Titolo back-end. | corda Vincoli: Lunghezza minima = 1 Lunghezza massima = 300 |
| tls | Proprietà TLS back-end | BackendTlsProperties |
| URL | URL di runtime del back-end. | stringa (obbligatorio) Vincoli: Lunghezza minima = 1 Lunghezza massima = 2000 |
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[] Vincoli: Lunghezza massima = 32 |
| certificateIds | Elenco di ID certificato client. | string[] Vincoli: Lunghezza massima = 32 |
| intestazione | Descrizione del parametro di intestazione. | BackendCredentialsContractHeader |
| quesito | Descrizione del parametro di query. | BackendCredentialsContractQuery |
BackendAuthorizationHeaderCredentials
| Nome | Descrizione | Valore |
|---|---|---|
| parametro | Valore del parametro di autenticazione. | stringa (obbligatorio) Vincoli: Lunghezza minima = 1 Lunghezza massima = 300 |
| schema | Nome schema di autenticazione. | stringa (obbligatorio) Vincoli: Lunghezza minima = 1 Lunghezza massima = 100 |
BackendCredentialsContractHeader
| Nome | Descrizione | Valore |
|---|---|---|
| {proprietà personalizzata} | string[] |
BackendCredentialsContractQuery
| Nome | Descrizione | Valore |
|---|---|---|
| {proprietà personalizzata} | string[] |
Back-endProprietà
| 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. | 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[] |
X509CertificateName
| Nome | Descrizione | Valore |
|---|---|---|
| issuerCertificateThumbprint | Identificazione personale per l'autorità emittente del certificato. | corda |
| nome | Nome comune del certificato. | corda |
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. | stringa (obbligatorio) Vincoli: Lunghezza minima = 1 Lunghezza massima = 2000 |
| nome utente | Nome utente per la connessione al server WebProxy | corda |
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 |
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@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"
}
})
}
Valori delle proprietà
service/backends
| Nome | Descrizione | Valore |
|---|---|---|
| digitare | Tipo di risorsa | "Microsoft.ApiManagement/service/backends@2021-08-01" |
| nome | Nome della risorsa | stringa (obbligatorio) 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 |
| proprietà | Proprietà del contratto di entità back-end. | BackendContractProperties |
BackendContractProperties
| Nome | Descrizione | Valore |
|---|---|---|
| credenziali | Proprietà del contratto credenziali back-end | BackendCredentialsContract |
| descrizione | Descrizione back-end. | corda Vincoli: Lunghezza minima = 1 Lunghezza massima = 2000 |
| proprietà | Contratto proprietà back-end | Proprietà back-end |
| protocollo | Protocollo di comunicazione back-end. | "http""soap" (obbligatorio) |
| procura | 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. | corda Vincoli: Lunghezza minima = 1 Lunghezza massima = 2000 |
| titolo | Titolo back-end. | corda Vincoli: Lunghezza minima = 1 Lunghezza massima = 300 |
| tls | Proprietà TLS back-end | BackendTlsProperties |
| URL | URL di runtime del back-end. | stringa (obbligatorio) Vincoli: Lunghezza minima = 1 Lunghezza massima = 2000 |
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[] Vincoli: Lunghezza massima = 32 |
| certificateIds | Elenco di ID certificato client. | string[] Vincoli: Lunghezza massima = 32 |
| intestazione | Descrizione del parametro di intestazione. | BackendCredentialsContractHeader |
| quesito | Descrizione del parametro di query. | BackendCredentialsContractQuery |
BackendAuthorizationHeaderCredentials
| Nome | Descrizione | Valore |
|---|---|---|
| parametro | Valore del parametro di autenticazione. | stringa (obbligatorio) Vincoli: Lunghezza minima = 1 Lunghezza massima = 300 |
| schema | Nome schema di autenticazione. | stringa (obbligatorio) Vincoli: Lunghezza minima = 1 Lunghezza massima = 100 |
BackendCredentialsContractHeader
| Nome | Descrizione | Valore |
|---|---|---|
| {proprietà personalizzata} | string[] |
BackendCredentialsContractQuery
| Nome | Descrizione | Valore |
|---|---|---|
| {proprietà personalizzata} | string[] |
Back-endProprietà
| 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. | 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[] |
X509CertificateName
| Nome | Descrizione | Valore |
|---|---|---|
| issuerCertificateThumbprint | Identificazione personale per l'autorità emittente del certificato. | corda |
| nome | Nome comune del certificato. | corda |
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. | stringa (obbligatorio) Vincoli: Lunghezza minima = 1 Lunghezza massima = 2000 |
| nome utente | Nome utente per la connessione al server WebProxy | corda |
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 |
Commenti e suggerimenti
Presto disponibile: Nel corso del 2024 verranno gradualmente disattivati i problemi di GitHub come meccanismo di feedback per il contenuto e ciò verrà sostituito con un nuovo sistema di feedback. Per altre informazioni, vedere https://aka.ms/ContentUserFeedback.
Invia e visualizza il feedback per