Služba Microsoft.ApiManagement / back-endy 2022-08-01
- nejnovější
-
2024-06-01-preview - 2024-05-01
-
2023-09-01-preview -
2023-05-01-preview - 1. 3. 2023 ve verzi Preview
-
2022-09-01-preview - 2022-08-01
-
2022-04-01-preview -
12. 12. 2021 ve verzi Preview -
2021-08-01 -
2021-04-01-preview -
2021-01-01-preview - 12. 12. 2020
- 2020-06-01-preview
- 12. 12. 2019
-
12. 12. 2019 -
1. 1. 2019 - 06. 6. 2018 ve verzi Preview
- 1. 1. 2018
-
03.03.2017 - 10. 10. 2016
-
2016-07-07
Definice prostředku Bicep
Typ prostředku služby nebo back-endu je možné nasadit s operacemi, které cílí:
- skupiny prostředků – viz příkazy nasazení skupiny prostředků
Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.
Formát prostředku
Pokud chcete vytvořit prostředek Microsoft.ApiManagement/service/back-ends, přidejte do šablony následující bicep.
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'
}
}
Hodnoty vlastností
BackendAuthorizationHeaderCredentials
| Jméno | Popis | Hodnota |
|---|---|---|
| parametr | Hodnota parametru ověřování | řetězec Omezení: Minimální délka = 1 Maximální délka = 300 (povinné) |
| schéma | Název schématu ověřování | řetězec Omezení: Minimální délka = 1 Maximální délka = 100 (povinné) |
Back-endContractProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| pověření | Vlastnosti kontraktu přihlašovacích údajů back-endu | BackendCredentialsContract |
| popis | Popis back-endu | řetězec Omezení: Minimální délka = 1 Maximální délka = 2000 |
| vlastnosti | Kontrakt vlastností back-endu | back-endovýchproperties |
| protokol | Komunikační protokol back-endu. | Http Soap (povinné) |
| plná moc | Vlastnosti kontraktu back-endové brány | backendProxyContract |
| resourceId | Identifikátor URI správy prostředku v externím systému Tato adresa URL může být ID prostředku Arm pro Logic Apps, Function Apps nebo API Apps. | řetězec Omezení: Minimální délka = 1 Maximální délka = 2000 |
| titul | Název back-endu | řetězec Omezení: Minimální délka = 1 Maximální délka = 300 |
| tls | Vlastnosti protokolu TLS back-endu | back-endTlsProperties |
| adresa URL | Adresa URL modulu runtime back-endu | řetězec Omezení: Minimální délka = 1 Maximální délka = 2000 (povinné) |
BackendCredentialsContract
| Jméno | Popis | Hodnota |
|---|---|---|
| oprávnění | Ověřování autorizační hlavičky | |
| certifikát | Seznam kryptografických otisků klientského certifikátu Pokud jsou zadané id certifikátů, bude ignorováno. | string[] |
| certificateIds | Seznam ID klientských certifikátů | string[] |
| záhlaví | Popis parametru hlavičky | backendCredentialsContractHeader |
| dotaz | Popis parametru dotazu | backendCredentialsContractQuery |
BackendCredentialsContractHeader
| Jméno | Popis | Hodnota |
|---|
BackendCredentialsContractQuery
| Jméno | Popis | Hodnota |
|---|
BackendProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| serviceFabricCluster | Vlastnosti clusteru Service Fabric back-endu | backendServiceFabricClusterProperties |
BackendProxyContract
| Jméno | Popis | Hodnota |
|---|---|---|
| heslo | Heslo pro připojení k serveru WebProxy | řetězec |
| adresa URL | Vlastnost WebProxy Server AbsoluteUri, která zahrnuje celý identifikátor URI uložený v instanci Uri, včetně všech fragmentů a řetězců dotazů. | řetězec Omezení: Minimální délka = 1 Maximální délka = 2000 (povinné) |
| uživatelské jméno | Uživatelské jméno pro připojení k serveru WebProxy | řetězec |
BackendServiceFabricClusterProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| clientCertificateId | ID klientského certifikátu pro koncový bod správy. | řetězec |
| clientCertificatethumbprint | Kryptografický otisk klientského certifikátu pro koncový bod správy. Pokud jsou zadané id certifikátů, bude ignorováno. | řetězec |
| managementEndpoints | Koncový bod správy clusteru. | string[] (povinné) |
| maxPartitionResolutionRetries | Maximální počet opakování při pokusu o vyřešení oddílu | Int |
| serverCertificateThumbprints | Kryptografické otisky služby pro správu clusteru certifikátů používají pro komunikaci tls | string[] |
| serverX509Names | Kolekce názvů certifikátů X509 serveru | X509CertificateName[] |
BackendTlsProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| validateCertificateChain | Příznak označující, jestli se má ověření řetězu certifikátů SSL provést při použití certifikátů podepsaných svým držitelem pro tohoto back-endového hostitele. | Bool |
| validateCertificateName | Příznak označující, jestli se má ověření názvu certifikátu SSL provést při použití certifikátů podepsaných svým držitelem pro tohoto back-endového hostitele. | Bool |
Microsoft.ApiManagement/service/back-ends
| Jméno | Popis | Hodnota |
|---|---|---|
| Jméno | Název prostředku | řetězec Omezení: Minimální délka = 1 Maximální délka = 80 (povinné) |
| rodič | V bicep můžete zadat nadřazený prostředek pro podřízený prostředek. Tuto vlastnost je potřeba přidat pouze v případě, že je podřízený prostředek deklarován mimo nadřazený prostředek. Další informace najdete v tématu Podřízený prostředek mimo nadřazený prostředek. |
Symbolický název prostředku typu: služby |
| vlastnosti | Vlastnosti kontraktu back-endových entit | back-endcontractProperties |
X509CertificateName
| Jméno | Popis | Hodnota |
|---|---|---|
| issuerCertificateThumbprint | Kryptografický otisk pro vystavitele certifikátu | řetězec |
| Jméno | Běžný název certifikátu | řetězec |
Definice prostředku šablony ARM
Typ prostředku služby nebo back-endu je možné nasadit s operacemi, které cílí:
- skupiny prostředků – viz příkazy nasazení skupiny prostředků
Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.
Formát prostředku
Pokud chcete vytvořit prostředek Microsoft.ApiManagement/service/back-ends, přidejte do šablony následující JSON.
{
"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"
}
}
Hodnoty vlastností
BackendAuthorizationHeaderCredentials
| Jméno | Popis | Hodnota |
|---|---|---|
| parametr | Hodnota parametru ověřování | řetězec Omezení: Minimální délka = 1 Maximální délka = 300 (povinné) |
| schéma | Název schématu ověřování | řetězec Omezení: Minimální délka = 1 Maximální délka = 100 (povinné) |
Back-endContractProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| pověření | Vlastnosti kontraktu přihlašovacích údajů back-endu | BackendCredentialsContract |
| popis | Popis back-endu | řetězec Omezení: Minimální délka = 1 Maximální délka = 2000 |
| vlastnosti | Kontrakt vlastností back-endu | back-endovýchproperties |
| protokol | Komunikační protokol back-endu. | Http Soap (povinné) |
| plná moc | Vlastnosti kontraktu back-endové brány | backendProxyContract |
| resourceId | Identifikátor URI správy prostředku v externím systému Tato adresa URL může být ID prostředku Arm pro Logic Apps, Function Apps nebo API Apps. | řetězec Omezení: Minimální délka = 1 Maximální délka = 2000 |
| titul | Název back-endu | řetězec Omezení: Minimální délka = 1 Maximální délka = 300 |
| tls | Vlastnosti protokolu TLS back-endu | back-endTlsProperties |
| adresa URL | Adresa URL modulu runtime back-endu | řetězec Omezení: Minimální délka = 1 Maximální délka = 2000 (povinné) |
BackendCredentialsContract
| Jméno | Popis | Hodnota |
|---|---|---|
| oprávnění | Ověřování autorizační hlavičky | |
| certifikát | Seznam kryptografických otisků klientského certifikátu Pokud jsou zadané id certifikátů, bude ignorováno. | string[] |
| certificateIds | Seznam ID klientských certifikátů | string[] |
| záhlaví | Popis parametru hlavičky | backendCredentialsContractHeader |
| dotaz | Popis parametru dotazu | backendCredentialsContractQuery |
BackendCredentialsContractHeader
| Jméno | Popis | Hodnota |
|---|
BackendCredentialsContractQuery
| Jméno | Popis | Hodnota |
|---|
BackendProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| serviceFabricCluster | Vlastnosti clusteru Service Fabric back-endu | backendServiceFabricClusterProperties |
BackendProxyContract
| Jméno | Popis | Hodnota |
|---|---|---|
| heslo | Heslo pro připojení k serveru WebProxy | řetězec |
| adresa URL | Vlastnost WebProxy Server AbsoluteUri, která zahrnuje celý identifikátor URI uložený v instanci Uri, včetně všech fragmentů a řetězců dotazů. | řetězec Omezení: Minimální délka = 1 Maximální délka = 2000 (povinné) |
| uživatelské jméno | Uživatelské jméno pro připojení k serveru WebProxy | řetězec |
BackendServiceFabricClusterProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| clientCertificateId | ID klientského certifikátu pro koncový bod správy. | řetězec |
| clientCertificatethumbprint | Kryptografický otisk klientského certifikátu pro koncový bod správy. Pokud jsou zadané id certifikátů, bude ignorováno. | řetězec |
| managementEndpoints | Koncový bod správy clusteru. | string[] (povinné) |
| maxPartitionResolutionRetries | Maximální počet opakování při pokusu o vyřešení oddílu | Int |
| serverCertificateThumbprints | Kryptografické otisky služby pro správu clusteru certifikátů používají pro komunikaci tls | string[] |
| serverX509Names | Kolekce názvů certifikátů X509 serveru | X509CertificateName[] |
BackendTlsProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| validateCertificateChain | Příznak označující, jestli se má ověření řetězu certifikátů SSL provést při použití certifikátů podepsaných svým držitelem pro tohoto back-endového hostitele. | Bool |
| validateCertificateName | Příznak označující, jestli se má ověření názvu certifikátu SSL provést při použití certifikátů podepsaných svým držitelem pro tohoto back-endového hostitele. | Bool |
Microsoft.ApiManagement/service/back-ends
| Jméno | Popis | Hodnota |
|---|---|---|
| apiVersion | Verze rozhraní API | '2022-08-01' |
| Jméno | Název prostředku | řetězec Omezení: Minimální délka = 1 Maximální délka = 80 (povinné) |
| vlastnosti | Vlastnosti kontraktu back-endových entit | back-endcontractProperties |
| typ | Typ prostředku | Microsoft.ApiManagement/service/back-ends |
X509CertificateName
| Jméno | Popis | Hodnota |
|---|---|---|
| issuerCertificateThumbprint | Kryptografický otisk pro vystavitele certifikátu | řetězec |
| Jméno | Běžný název certifikátu | řetězec |
Definice prostředku Terraformu (poskytovatel AzAPI)
Typ prostředku služby nebo back-endu je možné nasadit s operacemi, které cílí:
- skupiny prostředků
Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.
Formát prostředku
Pokud chcete vytvořit prostředek Microsoft.ApiManagement/service/back-ends, přidejte do šablony následující Terraform.
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"
}
})
}
Hodnoty vlastností
BackendAuthorizationHeaderCredentials
| Jméno | Popis | Hodnota |
|---|---|---|
| parametr | Hodnota parametru ověřování | řetězec Omezení: Minimální délka = 1 Maximální délka = 300 (povinné) |
| schéma | Název schématu ověřování | řetězec Omezení: Minimální délka = 1 Maximální délka = 100 (povinné) |
Back-endContractProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| pověření | Vlastnosti kontraktu přihlašovacích údajů back-endu | BackendCredentialsContract |
| popis | Popis back-endu | řetězec Omezení: Minimální délka = 1 Maximální délka = 2000 |
| vlastnosti | Kontrakt vlastností back-endu | back-endovýchproperties |
| protokol | Komunikační protokol back-endu. | Http Soap (povinné) |
| plná moc | Vlastnosti kontraktu back-endové brány | backendProxyContract |
| resourceId | Identifikátor URI správy prostředku v externím systému Tato adresa URL může být ID prostředku Arm pro Logic Apps, Function Apps nebo API Apps. | řetězec Omezení: Minimální délka = 1 Maximální délka = 2000 |
| titul | Název back-endu | řetězec Omezení: Minimální délka = 1 Maximální délka = 300 |
| tls | Vlastnosti protokolu TLS back-endu | back-endTlsProperties |
| adresa URL | Adresa URL modulu runtime back-endu | řetězec Omezení: Minimální délka = 1 Maximální délka = 2000 (povinné) |
BackendCredentialsContract
| Jméno | Popis | Hodnota |
|---|---|---|
| oprávnění | Ověřování autorizační hlavičky | |
| certifikát | Seznam kryptografických otisků klientského certifikátu Pokud jsou zadané id certifikátů, bude ignorováno. | string[] |
| certificateIds | Seznam ID klientských certifikátů | string[] |
| záhlaví | Popis parametru hlavičky | backendCredentialsContractHeader |
| dotaz | Popis parametru dotazu | backendCredentialsContractQuery |
BackendCredentialsContractHeader
| Jméno | Popis | Hodnota |
|---|
BackendCredentialsContractQuery
| Jméno | Popis | Hodnota |
|---|
BackendProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| serviceFabricCluster | Vlastnosti clusteru Service Fabric back-endu | backendServiceFabricClusterProperties |
BackendProxyContract
| Jméno | Popis | Hodnota |
|---|---|---|
| heslo | Heslo pro připojení k serveru WebProxy | řetězec |
| adresa URL | Vlastnost WebProxy Server AbsoluteUri, která zahrnuje celý identifikátor URI uložený v instanci Uri, včetně všech fragmentů a řetězců dotazů. | řetězec Omezení: Minimální délka = 1 Maximální délka = 2000 (povinné) |
| uživatelské jméno | Uživatelské jméno pro připojení k serveru WebProxy | řetězec |
BackendServiceFabricClusterProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| clientCertificateId | ID klientského certifikátu pro koncový bod správy. | řetězec |
| clientCertificatethumbprint | Kryptografický otisk klientského certifikátu pro koncový bod správy. Pokud jsou zadané id certifikátů, bude ignorováno. | řetězec |
| managementEndpoints | Koncový bod správy clusteru. | string[] (povinné) |
| maxPartitionResolutionRetries | Maximální počet opakování při pokusu o vyřešení oddílu | Int |
| serverCertificateThumbprints | Kryptografické otisky služby pro správu clusteru certifikátů používají pro komunikaci tls | string[] |
| serverX509Names | Kolekce názvů certifikátů X509 serveru | X509CertificateName[] |
BackendTlsProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| validateCertificateChain | Příznak označující, jestli se má ověření řetězu certifikátů SSL provést při použití certifikátů podepsaných svým držitelem pro tohoto back-endového hostitele. | Bool |
| validateCertificateName | Příznak označující, jestli se má ověření názvu certifikátu SSL provést při použití certifikátů podepsaných svým držitelem pro tohoto back-endového hostitele. | Bool |
Microsoft.ApiManagement/service/back-ends
| Jméno | Popis | Hodnota |
|---|---|---|
| Jméno | Název prostředku | řetězec Omezení: Minimální délka = 1 Maximální délka = 80 (povinné) |
| parent_id | ID prostředku, který je nadřazený pro tento prostředek. | ID prostředku typu: služby |
| vlastnosti | Vlastnosti kontraktu back-endových entit | back-endcontractProperties |
| typ | Typ prostředku | Microsoft.ApiManagement/service/backends@2022-08-01 |
X509CertificateName
| Jméno | Popis | Hodnota |
|---|---|---|
| issuerCertificateThumbprint | Kryptografický otisk pro vystavitele certifikátu | řetězec |
| Jméno | Běžný název certifikátu | řetězec |