Microsoft.ApiManagement service/backends 2022-08-01
Bicep-erőforrásdefiníció
A szolgáltatás/háttérrendszer erőforrástípusa üzembe helyezhető olyan műveletekkel, amelyek a következő célokat célják:
- Erőforráscsoportok – Lásd erőforráscsoport üzembe helyezési parancsaival
Az egyes API-verziók módosított tulajdonságainak listáját a változásnaplócímű témakörben találja.
Erőforrás formátuma
Microsoft.ApiManagement/service/backends erőforrás létrehozásához adja hozzá a következő Bicep-et a sablonhoz.
resource symbolicname 'Microsoft.ApiManagement/service/backends@2022-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'
}
}
Tulajdonságértékek
szolgáltatás/háttérrendszerek
| Név | Leírás | Érték |
|---|---|---|
| név | Az erőforrás neve Megtudhatja, hogyan állíthat be neveket és típusokat a gyermekerőforrásokhoz Bicep. |
sztring (kötelező) Karakterkorlát: 1-80 Érvényes karakterek: Alfanumerikus és kötőjelek. Kezdje betűvel és végződéssel alfanumerikussal. |
| szülő | A Bicepben megadhatja a gyermekerőforrás szülőerőforrását. Ezt a tulajdonságot csak akkor kell hozzáadnia, ha a gyermekerőforrás a szülőerőforráson kívül van deklarálva. További információ: szülőerőforráson kívüli gyermekerőforrás. |
A típus erőforrásának szimbolikus neve: szolgáltatás |
| kellékek | Háttér entitásszerződés tulajdonságai. | BackendContractProperties |
BackendContractProperties
| Név | Leírás | Érték |
|---|---|---|
| Megbízólevél | Háttérbeli hitelesítő adatok szerződésének tulajdonságai | BackendCredentialsContract |
| leírás | Háttér leírása. | húr Korlátok: Minimális hossz = 1 Maximális hossz = 2000 |
| kellékek | Háttértulajdonságok szerződése | BackendProperties |
| protokoll | Háttérkommunikációs protokoll. | 'http'"szappan" (kötelező) |
| helyettes | Háttérátjáró szerződésének tulajdonságai | BackendProxyContract |
| resourceId | Az erőforrás felügyeleti URI-ja a külső rendszerben. Ez az URL-cím lehet a Logic Apps, a Function Apps vagy az API Apps arm erőforrás-azonosítója. | húr Korlátok: Minimális hossz = 1 Maximális hossz = 2000 |
| cím | Háttércím. | húr Korlátok: Minimális hossz = 1 Maximális hossz = 300 |
| tls | Háttérbeli TLS-tulajdonságok | BackendTlsProperties |
| URL-cím | A háttérrendszer futtatókörnyezeti URL-címe. | sztring (kötelező) Korlátok: Minimális hossz = 1 Maximális hossz = 2000 |
HáttérbeliCredentialsContract
| Név | Leírás | Érték |
|---|---|---|
| felhatalmazás | Engedélyezési fejléc hitelesítése | BackendAuthorizationHeaderCredentials |
| igazolás | Az ügyféltanúsítvány ujjlenyomatainak listája. A rendszer figyelmen kívül hagyja, ha a tanúsítványazonosítók meg vannak adva. | sztring[] Korlátok: Maximális hossz = 32 |
| certificateIds | Ügyféltanúsítvány-azonosítók listája. | sztring[] Korlátok: Maximális hossz = 32 |
| fejléc | Fejlécparaméter leírása. | HáttérbeliCredentialsContractHeader |
| lekérdezés | Lekérdezési paraméter leírása. | BackendCredentialsContractQuery |
BackendAuthorizationHeaderCredentials
| Név | Leírás | Érték |
|---|---|---|
| paraméter | Hitelesítési paraméter értéke. | sztring (kötelező) Korlátok: Minimális hossz = 1 Maximális hossz = 300 |
| cselszövés | Hitelesítési séma neve. | sztring (kötelező) Korlátok: Minimális hossz = 1 Maximális hossz = 100 |
HáttérbeliCredentialsContractHeader
| Név | Leírás | Érték |
|---|---|---|
| {testreszabott tulajdonság} | sztring[] |
HáttérbeliCredentialsContractQuery
| Név | Leírás | Érték |
|---|---|---|
| {testreszabott tulajdonság} | sztring[] |
BackendProperties
| Név | Leírás | Érték |
|---|---|---|
| serviceFabricCluster | HáttérSzolgáltatás-hálófürt tulajdonságai | BackendServiceFabricClusterProperties |
BackendServiceFabricClusterProperties
| Név | Leírás | Érték |
|---|---|---|
| clientCertificateId | A felügyeleti végpont ügyféltanúsítvány-azonosítója. | húr |
| clientCertificatethumbprint | A felügyeleti végpont ügyféltanúsítványának ujjlenyomata. A rendszer figyelmen kívül hagyja, ha a tanúsítványazonosítók meg vannak adva | húr |
| managementEndpoints | A fürtkezelési végpont. | sztring[] (kötelező) |
| maxPartitionResolutionRetries | A partíció feloldása során az újrapróbálkozási kísérletek maximális száma. | Int |
| serverCertificateThumbprints | Tanúsítványok fürtfelügyeleti szolgáltatásának ujjlenyomatai tls-kommunikációhoz | sztring[] |
| serverX509Names | Kiszolgáló X509 tanúsítványnévgyűjteménye | X509CertificateName[] |
X509CertificateName
| Név | Leírás | Érték |
|---|---|---|
| issuerCertificateThumbprint | A tanúsítvány kiállítójának ujjlenyomata. | húr |
| név | A tanúsítvány köznapi neve. | húr |
BackendProxyContract
| Név | Leírás | Érték |
|---|---|---|
| jelszó | Jelszó a WebProxy-kiszolgálóhoz való csatlakozáshoz | húr |
| URL-cím | WebProxy Server AbsoluteUri tulajdonság, amely az Uri-példányban tárolt teljes URI-t tartalmazza, beleértve az összes töredéket és lekérdezési sztringet. | sztring (kötelező) Korlátok: Minimális hossz = 1 Maximális hossz = 2000 |
| felhasználónév | Felhasználónév a WebProxy-kiszolgálóhoz való csatlakozáshoz | húr |
BackendTlsProperties
| Név | Leírás | Érték |
|---|---|---|
| validateCertificateChain | Jelző, amely jelzi, hogy az SSL-tanúsítványlánc érvényesítését el kell-e végezni, ha önaláírt tanúsítványokat használ ehhez a háttér gazdagéphez. | Bool |
| validateCertificateName | Jelző, amely jelzi, hogy az SSL-tanúsítvány nevének érvényesítése akkor történjen-e meg, ha önaláírt tanúsítványokat használ ehhez a háttér gazdagéphez. | Bool |
ARM-sablon erőforrásdefiníciója
A szolgáltatás/háttérrendszer erőforrástípusa üzembe helyezhető olyan műveletekkel, amelyek a következő célokat célják:
- Erőforráscsoportok – Lásd erőforráscsoport üzembe helyezési parancsaival
Az egyes API-verziók módosított tulajdonságainak listáját a változásnaplócímű témakörben találja.
Erőforrás formátuma
Microsoft.ApiManagement/service/backends erőforrás létrehozásához adja hozzá a következő JSON-t a sablonhoz.
{
"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"
}
}
Tulajdonságértékek
szolgáltatás/háttérrendszerek
| Név | Leírás | Érték |
|---|---|---|
| típus | Az erőforrás típusa | "Microsoft.ApiManagement/service/backends" |
| apiVersion | Az erőforrás API-verziója | '2022-08-01' |
| név | Az erőforrás neve Megtudhatja, hogyan állíthat be neveket és típusokat a gyermekerőforrásokhoz JSON ARM-sablonokban. |
sztring (kötelező) Karakterkorlát: 1-80 Érvényes karakterek: Alfanumerikus és kötőjelek. Kezdje betűvel és végződéssel alfanumerikussal. |
| kellékek | Háttér entitásszerződés tulajdonságai. | BackendContractProperties |
BackendContractProperties
| Név | Leírás | Érték |
|---|---|---|
| Megbízólevél | Háttérbeli hitelesítő adatok szerződésének tulajdonságai | BackendCredentialsContract |
| leírás | Háttér leírása. | húr Korlátok: Minimális hossz = 1 Maximális hossz = 2000 |
| kellékek | Háttértulajdonságok szerződése | BackendProperties |
| protokoll | Háttérkommunikációs protokoll. | 'http'"szappan" (kötelező) |
| helyettes | Háttérátjáró szerződésének tulajdonságai | BackendProxyContract |
| resourceId | Az erőforrás felügyeleti URI-ja a külső rendszerben. Ez az URL-cím lehet a Logic Apps, a Function Apps vagy az API Apps arm erőforrás-azonosítója. | húr Korlátok: Minimális hossz = 1 Maximális hossz = 2000 |
| cím | Háttércím. | húr Korlátok: Minimális hossz = 1 Maximális hossz = 300 |
| tls | Háttérbeli TLS-tulajdonságok | BackendTlsProperties |
| URL-cím | A háttérrendszer futtatókörnyezeti URL-címe. | sztring (kötelező) Korlátok: Minimális hossz = 1 Maximális hossz = 2000 |
HáttérbeliCredentialsContract
| Név | Leírás | Érték |
|---|---|---|
| felhatalmazás | Engedélyezési fejléc hitelesítése | BackendAuthorizationHeaderCredentials |
| igazolás | Az ügyféltanúsítvány ujjlenyomatainak listája. A rendszer figyelmen kívül hagyja, ha a tanúsítványazonosítók meg vannak adva. | sztring[] Korlátok: Maximális hossz = 32 |
| certificateIds | Ügyféltanúsítvány-azonosítók listája. | sztring[] Korlátok: Maximális hossz = 32 |
| fejléc | Fejlécparaméter leírása. | HáttérbeliCredentialsContractHeader |
| lekérdezés | Lekérdezési paraméter leírása. | BackendCredentialsContractQuery |
BackendAuthorizationHeaderCredentials
| Név | Leírás | Érték |
|---|---|---|
| paraméter | Hitelesítési paraméter értéke. | sztring (kötelező) Korlátok: Minimális hossz = 1 Maximális hossz = 300 |
| cselszövés | Hitelesítési séma neve. | sztring (kötelező) Korlátok: Minimális hossz = 1 Maximális hossz = 100 |
HáttérbeliCredentialsContractHeader
| Név | Leírás | Érték |
|---|---|---|
| {testreszabott tulajdonság} | sztring[] |
HáttérbeliCredentialsContractQuery
| Név | Leírás | Érték |
|---|---|---|
| {testreszabott tulajdonság} | sztring[] |
BackendProperties
| Név | Leírás | Érték |
|---|---|---|
| serviceFabricCluster | HáttérSzolgáltatás-hálófürt tulajdonságai | BackendServiceFabricClusterProperties |
BackendServiceFabricClusterProperties
| Név | Leírás | Érték |
|---|---|---|
| clientCertificateId | A felügyeleti végpont ügyféltanúsítvány-azonosítója. | húr |
| clientCertificatethumbprint | A felügyeleti végpont ügyféltanúsítványának ujjlenyomata. A rendszer figyelmen kívül hagyja, ha a tanúsítványazonosítók meg vannak adva | húr |
| managementEndpoints | A fürtkezelési végpont. | sztring[] (kötelező) |
| maxPartitionResolutionRetries | A partíció feloldása során az újrapróbálkozási kísérletek maximális száma. | Int |
| serverCertificateThumbprints | Tanúsítványok fürtfelügyeleti szolgáltatásának ujjlenyomatai tls-kommunikációhoz | sztring[] |
| serverX509Names | Kiszolgáló X509 tanúsítványnévgyűjteménye | X509CertificateName[] |
X509CertificateName
| Név | Leírás | Érték |
|---|---|---|
| issuerCertificateThumbprint | A tanúsítvány kiállítójának ujjlenyomata. | húr |
| név | A tanúsítvány köznapi neve. | húr |
BackendProxyContract
| Név | Leírás | Érték |
|---|---|---|
| jelszó | Jelszó a WebProxy-kiszolgálóhoz való csatlakozáshoz | húr |
| URL-cím | WebProxy Server AbsoluteUri tulajdonság, amely az Uri-példányban tárolt teljes URI-t tartalmazza, beleértve az összes töredéket és lekérdezési sztringet. | sztring (kötelező) Korlátok: Minimális hossz = 1 Maximális hossz = 2000 |
| felhasználónév | Felhasználónév a WebProxy-kiszolgálóhoz való csatlakozáshoz | húr |
BackendTlsProperties
| Név | Leírás | Érték |
|---|---|---|
| validateCertificateChain | Jelző, amely jelzi, hogy az SSL-tanúsítványlánc érvényesítését el kell-e végezni, ha önaláírt tanúsítványokat használ ehhez a háttér gazdagéphez. | Bool |
| validateCertificateName | Jelző, amely jelzi, hogy az SSL-tanúsítvány nevének érvényesítése akkor történjen-e meg, ha önaláírt tanúsítványokat használ ehhez a háttér gazdagéphez. | Bool |
Terraform (AzAPI-szolgáltató) erőforrásdefiníciója
A szolgáltatás/háttérrendszer erőforrástípusa üzembe helyezhető olyan műveletekkel, amelyek a következő célokat célják:
- erőforráscsoportok
Az egyes API-verziók módosított tulajdonságainak listáját a változásnaplócímű témakörben találja.
Erőforrás formátuma
Microsoft.ApiManagement/service/backends erőforrás létrehozásához adja hozzá a következő Terraformot a sablonhoz.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/backends@2022-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"
}
})
}
Tulajdonságértékek
szolgáltatás/háttérrendszerek
| Név | Leírás | Érték |
|---|---|---|
| típus | Az erőforrás típusa | "Microsoft.ApiManagement/service/backends@2022-08-01" |
| név | Az erőforrás neve | sztring (kötelező) Karakterkorlát: 1-80 Érvényes karakterek: Alfanumerikus és kötőjelek. Kezdje betűvel és végződéssel alfanumerikussal. |
| parent_id | Annak az erőforrásnak az azonosítója, amely az erőforrás szülője. | Típus típusú erőforrás azonosítója: szolgáltatás |
| kellékek | Háttér entitásszerződés tulajdonságai. | BackendContractProperties |
BackendContractProperties
| Név | Leírás | Érték |
|---|---|---|
| Megbízólevél | Háttérbeli hitelesítő adatok szerződésének tulajdonságai | BackendCredentialsContract |
| leírás | Háttér leírása. | húr Korlátok: Minimális hossz = 1 Maximális hossz = 2000 |
| kellékek | Háttértulajdonságok szerződése | BackendProperties |
| protokoll | Háttérkommunikációs protokoll. | "http""szappan" (kötelező) |
| helyettes | Háttérátjáró szerződésének tulajdonságai | BackendProxyContract |
| resourceId | Az erőforrás felügyeleti URI-ja a külső rendszerben. Ez az URL-cím lehet a Logic Apps, a Function Apps vagy az API Apps arm erőforrás-azonosítója. | húr Korlátok: Minimális hossz = 1 Maximális hossz = 2000 |
| cím | Háttércím. | húr Korlátok: Minimális hossz = 1 Maximális hossz = 300 |
| tls | Háttérbeli TLS-tulajdonságok | BackendTlsProperties |
| URL-cím | A háttérrendszer futtatókörnyezeti URL-címe. | sztring (kötelező) Korlátok: Minimális hossz = 1 Maximális hossz = 2000 |
HáttérbeliCredentialsContract
| Név | Leírás | Érték |
|---|---|---|
| felhatalmazás | Engedélyezési fejléc hitelesítése | BackendAuthorizationHeaderCredentials |
| igazolás | Az ügyféltanúsítvány ujjlenyomatainak listája. A rendszer figyelmen kívül hagyja, ha a tanúsítványazonosítók meg vannak adva. | sztring[] Korlátok: Maximális hossz = 32 |
| certificateIds | Ügyféltanúsítvány-azonosítók listája. | sztring[] Korlátok: Maximális hossz = 32 |
| fejléc | Fejlécparaméter leírása. | HáttérbeliCredentialsContractHeader |
| lekérdezés | Lekérdezési paraméter leírása. | BackendCredentialsContractQuery |
BackendAuthorizationHeaderCredentials
| Név | Leírás | Érték |
|---|---|---|
| paraméter | Hitelesítési paraméter értéke. | sztring (kötelező) Korlátok: Minimális hossz = 1 Maximális hossz = 300 |
| cselszövés | Hitelesítési séma neve. | sztring (kötelező) Korlátok: Minimális hossz = 1 Maximális hossz = 100 |
HáttérbeliCredentialsContractHeader
| Név | Leírás | Érték |
|---|---|---|
| {testreszabott tulajdonság} | sztring[] |
HáttérbeliCredentialsContractQuery
| Név | Leírás | Érték |
|---|---|---|
| {testreszabott tulajdonság} | sztring[] |
BackendProperties
| Név | Leírás | Érték |
|---|---|---|
| serviceFabricCluster | HáttérSzolgáltatás-hálófürt tulajdonságai | BackendServiceFabricClusterProperties |
BackendServiceFabricClusterProperties
| Név | Leírás | Érték |
|---|---|---|
| clientCertificateId | A felügyeleti végpont ügyféltanúsítvány-azonosítója. | húr |
| clientCertificatethumbprint | A felügyeleti végpont ügyféltanúsítványának ujjlenyomata. A rendszer figyelmen kívül hagyja, ha a tanúsítványazonosítók meg vannak adva | húr |
| managementEndpoints | A fürtkezelési végpont. | sztring[] (kötelező) |
| maxPartitionResolutionRetries | A partíció feloldása során az újrapróbálkozási kísérletek maximális száma. | Int |
| serverCertificateThumbprints | Tanúsítványok fürtfelügyeleti szolgáltatásának ujjlenyomatai tls-kommunikációhoz | sztring[] |
| serverX509Names | Kiszolgáló X509 tanúsítványnévgyűjteménye | X509CertificateName[] |
X509CertificateName
| Név | Leírás | Érték |
|---|---|---|
| issuerCertificateThumbprint | A tanúsítvány kiállítójának ujjlenyomata. | húr |
| név | A tanúsítvány köznapi neve. | húr |
BackendProxyContract
| Név | Leírás | Érték |
|---|---|---|
| jelszó | Jelszó a WebProxy-kiszolgálóhoz való csatlakozáshoz | húr |
| URL-cím | WebProxy Server AbsoluteUri tulajdonság, amely az Uri-példányban tárolt teljes URI-t tartalmazza, beleértve az összes töredéket és lekérdezési sztringet. | sztring (kötelező) Korlátok: Minimális hossz = 1 Maximális hossz = 2000 |
| felhasználónév | Felhasználónév a WebProxy-kiszolgálóhoz való csatlakozáshoz | húr |
BackendTlsProperties
| Név | Leírás | Érték |
|---|---|---|
| validateCertificateChain | Jelző, amely jelzi, hogy az SSL-tanúsítványlánc érvényesítését el kell-e végezni, ha önaláírt tanúsítványokat használ ehhez a háttér gazdagéphez. | Bool |
| validateCertificateName | Jelző, amely jelzi, hogy az SSL-tanúsítvány nevének érvényesítése akkor történjen-e meg, ha önaláírt tanúsítványokat használ ehhez a háttér gazdagéphez. | Bool |