Poznámka:
Přístup k této stránce vyžaduje autorizaci. Můžete se zkusit přihlásit nebo změnit adresáře.
Přístup k této stránce vyžaduje autorizaci. Můžete zkusit změnit adresáře.
- nejnovější
- 2025-09-01-náhled
- 2025-03-01-preview
- z 10. 10. 2024 ve verzi Preview
-
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-náhled
- 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 service/apis 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.
Příklady použití
Ukázky Bicep
Základní příklad nasazení rozhraní API v rámci služby API Management.
param resourceName string = 'acctest0001'
param location string = 'westeurope'
resource service 'Microsoft.ApiManagement/service@2021-08-01' = {
name: resourceName
location: location
sku: {
capacity: 0
name: 'Consumption'
}
properties: {
certificates: []
customProperties: {
'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30': 'false'
'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10': 'false'
'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11': 'false'
'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10': 'false'
'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11': 'false'
}
disableGateway: false
publicNetworkAccess: 'Enabled'
publisherEmail: 'pub1@email.com'
publisherName: 'pub1'
virtualNetworkType: 'None'
}
}
resource api 'Microsoft.ApiManagement/service/apis@2021-08-01' = {
name: '${resourceName};rev=1'
parent: service
properties: {
apiRevisionDescription: ''
apiType: 'http'
apiVersion: ''
apiVersionDescription: ''
authenticationSettings: {}
description: ''
displayName: 'api1'
path: 'api1'
protocols: [
'https'
]
serviceUrl: ''
subscriptionRequired: true
type: 'http'
}
}
Ověřené moduly Azure
K nasazení tohoto typu prostředku je možné použít následující ověřené moduly Azure.
| Module | Popis |
|---|---|
| Služba správy API - API | AVM Child Module for API Management Service - API |
Formát prostředku
Pokud chcete vytvořit prostředek Microsoft.ApiManagement/service/apis, přidejte do šablony následující bicep.
resource symbolicname 'Microsoft.ApiManagement/service/apis@2022-04-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
apiRevision: 'string'
apiRevisionDescription: 'string'
apiType: 'string'
apiVersion: 'string'
apiVersionDescription: 'string'
apiVersionSet: {
description: 'string'
id: 'string'
name: 'string'
versionHeaderName: 'string'
versioningScheme: 'string'
versionQueryName: 'string'
}
apiVersionSetId: 'string'
authenticationSettings: {
oAuth2: {
authorizationServerId: 'string'
scope: 'string'
}
oAuth2AuthenticationSettings: [
{
authorizationServerId: 'string'
scope: 'string'
}
]
openid: {
bearerTokenSendingMethods: [
'string'
]
openidProviderId: 'string'
}
openidAuthenticationSettings: [
{
bearerTokenSendingMethods: [
'string'
]
openidProviderId: 'string'
}
]
}
contact: {
email: 'string'
name: 'string'
url: 'string'
}
description: 'string'
displayName: 'string'
format: 'string'
isCurrent: bool
license: {
name: 'string'
url: 'string'
}
path: 'string'
protocols: [
'string'
]
serviceUrl: 'string'
sourceApiId: 'string'
subscriptionKeyParameterNames: {
header: 'string'
query: 'string'
}
subscriptionRequired: bool
termsOfServiceUrl: 'string'
translateRequiredQueryParameters: 'string'
type: 'string'
value: 'string'
wsdlSelector: {
wsdlEndpointName: 'string'
wsdlServiceName: 'string'
}
}
}
Hodnoty vlastností
Microsoft.ApiManagement/service/api
| Jméno | Popis | Hodnota |
|---|---|---|
| Jméno | Název prostředku | řetězec Omezení: Minimální délka = 1 Maximální délka = 256 Model = ^[^*#&+:<>?]+$ (povinné) |
| nadřazený objekt | 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 | Entita rozhraní API vytváří vlastnosti aktualizace. | ApiCreateOrUpdatePropertiesOrApiContractPropertProperties |
ApiContactInformation
| Jméno | Popis | Hodnota |
|---|---|---|
| E-mailová adresa kontaktní osoby nebo organizace Musí být ve formátu e-mailové adresy. | řetězec | |
| Jméno | Identifikační jméno kontaktní osoby nebo organizace | řetězec |
| adresa URL | Adresa URL odkazující na kontaktní údaje. Musí být ve formátu adresy URL. | řetězec |
ApiCreateOrUpdatePropertiesOrApiContractProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| apiRevize | Popisuje revizi rozhraní API. Pokud není zadána žádná hodnota, vytvoří se výchozí revize 1. | řetězec Omezení: Minimální délka = 1 Maximální délka = 100 |
| apiRevisionDescription | Popis revize rozhraní API | řetězec Omezení: Maximální délka = 256 |
| Typ rozhraní apiType | Typ rozhraní API, které se má vytvořit. * http vytvoření rozhraní REST API * soap vytvoří předávací rozhraní API protokolu SOAP * websocket vytvoření rozhraní API protokolu websocket * graphql vytvoří rozhraní GraphQL API. |
Graphql Http "soap" Websocket |
| Verze rozhraní apiVersion | Označuje identifikátor verze rozhraní API, pokud je rozhraní API s verzí. | řetězec Omezení: Maximální délka = 100 |
| apiVersionDescription | Popis verze rozhraní API | řetězec Omezení: Maximální délka = 256 |
| apiVersionSet | Podrobnosti o sadě verzí | apiVersionSetContractDetails |
| apiVersionSetId | Identifikátor prostředku pro související sadu ApiVersionSet. | řetězec |
| Nastavení ověřování | Kolekce nastavení ověřování, která jsou součástí tohoto rozhraní API. | Smlouva AuthenticationSettingsContract |
| kontakt | Kontaktní informace pro rozhraní API | apiContactInformation |
| popis | Popis rozhraní API Může obsahovat značky formátování HTML. | řetězec |
| zobrazované jméno | Název rozhraní API Musí mít délku 1 až 300 znaků. | řetězec Omezení: Minimální délka = 1 Maximální délka = 300 |
| formát | Formát obsahu, ve kterém se rozhraní API importuje | Graphql-link Openapi Openapi+json Openapi+json-link Openapi-link Swagger-json swagger-link-json Wadl-link-json Wadl-xml Wsdl Wsdl-link |
| isCurrent | Označuje, jestli je revize rozhraní API aktuální revizí rozhraní API. | Bool |
| licence | Informace o licenci pro rozhraní API | apiLicenseInformation |
| cesta | Relativní adresa URL jednoznačně identifikuje toto rozhraní API a všechny jeho cesty k prostředkům v rámci instance služby API Management. Připojí se k základní adrese URL koncového bodu rozhraní API zadané během vytváření instance služby a vytvoří veřejnou adresu URL pro toto rozhraní API. | řetězec Omezení: Maximální délka = 400 (povinné) |
| protokoly | Popisuje, na kterých protokolech lze vyvolat operace v tomto rozhraní API. | Řetězcové pole obsahující některou z těchto možností: Http Https 'ws' Wss |
| adresa služby | Absolutní adresa URL back-endové služby, která toto rozhraní API implementuje. Nesmí být delší než 2 000 znaků. | řetězec Omezení: Maximální délka = 2000 |
| sourceApiId | Identifikátor rozhraní API zdrojového rozhraní API. | řetězec |
| subscriptionKeyParameterNames | Protokoly, u kterých je rozhraní API dostupné. | SubscriptionKeyParameterNamesContract |
| předplatnéVyžadováno | Určuje, jestli se pro přístup k rozhraní API vyžaduje předplatné rozhraní API nebo produktu. | Bool |
| termsOfServiceUrl | Adresa URL podmínek služby pro rozhraní API. Musí být ve formátu adresy URL. | řetězec |
| translateRequiredQueryParameters | Strategie překladu požadovaných parametrů dotazu na šablony Ve výchozím nastavení má hodnotu template. Možné hodnoty: template, query | Dotaz Šablona |
| typ | Typ rozhraní API | Graphql Http "soap" Websocket |
| hodnota | Hodnota obsahu při importu rozhraní API | řetězec |
| wsdlSelektor | Kritéria pro omezení importu WSDL na podmnožinu dokumentu | ApiCreateOrUpdatePropertiesWsdlSelector |
ApiCreateOrUpdatePropertiesWsdlSelector
| Jméno | Popis | Hodnota |
|---|---|---|
| wsdlEndpointName | Název koncového bodu (portu) pro import z WSDL | řetězec |
| wsdlNázev_služby | Název služby, která se má importovat z WSDL | řetězec |
Informace o licenci Api
| Jméno | Popis | Hodnota |
|---|---|---|
| Jméno | Název licence použitý pro rozhraní API | řetězec |
| adresa URL | Adresa URL licence použité pro rozhraní API. Musí být ve formátu adresy URL. | řetězec |
ApiVersionSetContractDetails
| Jméno | Popis | Hodnota |
|---|---|---|
| popis | Popis sady verzí rozhraní API | řetězec |
| identifikační číslo | Identifikátor existující sady verzí rozhraní API Tuto hodnotu vynecháte, pokud chcete vytvořit novou sadu verzí. | řetězec |
| Jméno | Zobrazovaný název sady verzí rozhraní API | řetězec |
| versionHeaderName | Název parametru hlavičky HTTP, který označuje verzi rozhraní API, pokud je vlastnost versioningScheme nastavená na header. |
řetězec |
| versioningScheme | Hodnota, která určuje, kde se bude identifikátor verze rozhraní API nacházet v požadavku HTTP. | Hlavička Dotaz Segment |
| versionNázevDotazu | Název parametru dotazu, který označuje verzi rozhraní API, pokud je správa verzí nastavena na query. |
řetězec |
Smlouva AuthenticationSettingsContract
| Jméno | Popis | Hodnota |
|---|---|---|
| oAuth2 řekl: | Nastavení ověřování OAuth2 | Kontrakt OAuth2AuthenticationSettingsContract |
| oAuth2AuthenticationSettings | Kolekce nastavení ověřování OAuth2, která jsou součástí tohoto rozhraní API. | OAuth2AuthenticationSettingsContract[] |
| OpenID | Nastavení ověřování OpenID Connect | Smlouva OpenIdAuthenticationSettingsContract |
| openidAuthenticationSettings | Kolekce nastavení ověřování Open ID Connect, která jsou součástí tohoto rozhraní API. | OpenIdAuthenticationSettingsContract[] |
Kontrakt OAuth2AuthenticationSettingsContract
| Jméno | Popis | Hodnota |
|---|---|---|
| ID autorizačního serveru | Identifikátor autorizačního serveru OAuth. | řetězec |
| obor | rozsah operací. | řetězec |
Smlouva OpenIdAuthenticationSettingsContract
| Jméno | Popis | Hodnota |
|---|---|---|
| bearerTokenSendingMethods | Postup odeslání tokenu na server | Řetězcové pole obsahující některou z těchto možností: AuthorizationHeader Dotaz |
| openidProviderId | Identifikátor autorizačního serveru OAuth. | řetězec |
SubscriptionKeyParameterNamesContract
| Jméno | Popis | Hodnota |
|---|---|---|
| hlavička | Název hlavičky klíče předplatného | řetězec |
| dotaz | Název parametru řetězce dotazu klíče předplatného | řetězec |
Definice prostředku šablony ARM
Typ prostředku service/apis je možné nasadit s operacemi, které cílí:
- Skupiny zdrojů – viz příkazy pro nasazení skupin zdrojů Pro seznam změněných vlastností v každé verzi API viz log změn.
Příklady použití
Formát prostředku
Pokud chcete vytvořit prostředek Microsoft.ApiManagement/service/apis, přidejte do šablony následující JSON.
{
"type": "Microsoft.ApiManagement/service/apis",
"apiVersion": "2022-04-01-preview",
"name": "string",
"properties": {
"apiRevision": "string",
"apiRevisionDescription": "string",
"apiType": "string",
"apiVersion": "string",
"apiVersionDescription": "string",
"apiVersionSet": {
"description": "string",
"id": "string",
"name": "string",
"versionHeaderName": "string",
"versioningScheme": "string",
"versionQueryName": "string"
},
"apiVersionSetId": "string",
"authenticationSettings": {
"oAuth2": {
"authorizationServerId": "string",
"scope": "string"
},
"oAuth2AuthenticationSettings": [
{
"authorizationServerId": "string",
"scope": "string"
}
],
"openid": {
"bearerTokenSendingMethods": [ "string" ],
"openidProviderId": "string"
},
"openidAuthenticationSettings": [
{
"bearerTokenSendingMethods": [ "string" ],
"openidProviderId": "string"
}
]
},
"contact": {
"email": "string",
"name": "string",
"url": "string"
},
"description": "string",
"displayName": "string",
"format": "string",
"isCurrent": "bool",
"license": {
"name": "string",
"url": "string"
},
"path": "string",
"protocols": [ "string" ],
"serviceUrl": "string",
"sourceApiId": "string",
"subscriptionKeyParameterNames": {
"header": "string",
"query": "string"
},
"subscriptionRequired": "bool",
"termsOfServiceUrl": "string",
"translateRequiredQueryParameters": "string",
"type": "string",
"value": "string",
"wsdlSelector": {
"wsdlEndpointName": "string",
"wsdlServiceName": "string"
}
}
}
Hodnoty vlastností
Microsoft.ApiManagement/service/api
ApiContactInformation
| Jméno | Popis | Hodnota |
|---|---|---|
| E-mailová adresa kontaktní osoby nebo organizace Musí být ve formátu e-mailové adresy. | řetězec | |
| Jméno | Identifikační jméno kontaktní osoby nebo organizace | řetězec |
| adresa URL | Adresa URL odkazující na kontaktní údaje. Musí být ve formátu adresy URL. | řetězec |
ApiCreateOrUpdatePropertiesOrApiContractProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| apiRevize | Popisuje revizi rozhraní API. Pokud není zadána žádná hodnota, vytvoří se výchozí revize 1. | řetězec Omezení: Minimální délka = 1 Maximální délka = 100 |
| apiRevisionDescription | Popis revize rozhraní API | řetězec Omezení: Maximální délka = 256 |
| Typ rozhraní apiType | Typ rozhraní API, které se má vytvořit. * http vytvoření rozhraní REST API * soap vytvoří předávací rozhraní API protokolu SOAP * websocket vytvoření rozhraní API protokolu websocket * graphql vytvoří rozhraní GraphQL API. |
Graphql Http "soap" Websocket |
| Verze rozhraní apiVersion | Označuje identifikátor verze rozhraní API, pokud je rozhraní API s verzí. | řetězec Omezení: Maximální délka = 100 |
| apiVersionDescription | Popis verze rozhraní API | řetězec Omezení: Maximální délka = 256 |
| apiVersionSet | Podrobnosti o sadě verzí | apiVersionSetContractDetails |
| apiVersionSetId | Identifikátor prostředku pro související sadu ApiVersionSet. | řetězec |
| Nastavení ověřování | Kolekce nastavení ověřování, která jsou součástí tohoto rozhraní API. | Smlouva AuthenticationSettingsContract |
| kontakt | Kontaktní informace pro rozhraní API | apiContactInformation |
| popis | Popis rozhraní API Může obsahovat značky formátování HTML. | řetězec |
| zobrazované jméno | Název rozhraní API Musí mít délku 1 až 300 znaků. | řetězec Omezení: Minimální délka = 1 Maximální délka = 300 |
| formát | Formát obsahu, ve kterém se rozhraní API importuje | Graphql-link Openapi Openapi+json Openapi+json-link Openapi-link Swagger-json swagger-link-json Wadl-link-json Wadl-xml Wsdl Wsdl-link |
| isCurrent | Označuje, jestli je revize rozhraní API aktuální revizí rozhraní API. | Bool |
| licence | Informace o licenci pro rozhraní API | apiLicenseInformation |
| cesta | Relativní adresa URL jednoznačně identifikuje toto rozhraní API a všechny jeho cesty k prostředkům v rámci instance služby API Management. Připojí se k základní adrese URL koncového bodu rozhraní API zadané během vytváření instance služby a vytvoří veřejnou adresu URL pro toto rozhraní API. | řetězec Omezení: Maximální délka = 400 (povinné) |
| protokoly | Popisuje, na kterých protokolech lze vyvolat operace v tomto rozhraní API. | Řetězcové pole obsahující některou z těchto možností: Http Https 'ws' Wss |
| adresa služby | Absolutní adresa URL back-endové služby, která toto rozhraní API implementuje. Nesmí být delší než 2 000 znaků. | řetězec Omezení: Maximální délka = 2000 |
| sourceApiId | Identifikátor rozhraní API zdrojového rozhraní API. | řetězec |
| subscriptionKeyParameterNames | Protokoly, u kterých je rozhraní API dostupné. | SubscriptionKeyParameterNamesContract |
| předplatnéVyžadováno | Určuje, jestli se pro přístup k rozhraní API vyžaduje předplatné rozhraní API nebo produktu. | Bool |
| termsOfServiceUrl | Adresa URL podmínek služby pro rozhraní API. Musí být ve formátu adresy URL. | řetězec |
| translateRequiredQueryParameters | Strategie překladu požadovaných parametrů dotazu na šablony Ve výchozím nastavení má hodnotu template. Možné hodnoty: template, query | Dotaz Šablona |
| typ | Typ rozhraní API | Graphql Http "soap" Websocket |
| hodnota | Hodnota obsahu při importu rozhraní API | řetězec |
| wsdlSelektor | Kritéria pro omezení importu WSDL na podmnožinu dokumentu | ApiCreateOrUpdatePropertiesWsdlSelector |
ApiCreateOrUpdatePropertiesWsdlSelector
| Jméno | Popis | Hodnota |
|---|---|---|
| wsdlEndpointName | Název koncového bodu (portu) pro import z WSDL | řetězec |
| wsdlNázev_služby | Název služby, která se má importovat z WSDL | řetězec |
Informace o licenci Api
| Jméno | Popis | Hodnota |
|---|---|---|
| Jméno | Název licence použitý pro rozhraní API | řetězec |
| adresa URL | Adresa URL licence použité pro rozhraní API. Musí být ve formátu adresy URL. | řetězec |
ApiVersionSetContractDetails
| Jméno | Popis | Hodnota |
|---|---|---|
| popis | Popis sady verzí rozhraní API | řetězec |
| identifikační číslo | Identifikátor existující sady verzí rozhraní API Tuto hodnotu vynecháte, pokud chcete vytvořit novou sadu verzí. | řetězec |
| Jméno | Zobrazovaný název sady verzí rozhraní API | řetězec |
| versionHeaderName | Název parametru hlavičky HTTP, který označuje verzi rozhraní API, pokud je vlastnost versioningScheme nastavená na header. |
řetězec |
| versioningScheme | Hodnota, která určuje, kde se bude identifikátor verze rozhraní API nacházet v požadavku HTTP. | Hlavička Dotaz Segment |
| versionNázevDotazu | Název parametru dotazu, který označuje verzi rozhraní API, pokud je správa verzí nastavena na query. |
řetězec |
Smlouva AuthenticationSettingsContract
| Jméno | Popis | Hodnota |
|---|---|---|
| oAuth2 řekl: | Nastavení ověřování OAuth2 | Kontrakt OAuth2AuthenticationSettingsContract |
| oAuth2AuthenticationSettings | Kolekce nastavení ověřování OAuth2, která jsou součástí tohoto rozhraní API. | OAuth2AuthenticationSettingsContract[] |
| OpenID | Nastavení ověřování OpenID Connect | Smlouva OpenIdAuthenticationSettingsContract |
| openidAuthenticationSettings | Kolekce nastavení ověřování Open ID Connect, která jsou součástí tohoto rozhraní API. | OpenIdAuthenticationSettingsContract[] |
Kontrakt OAuth2AuthenticationSettingsContract
| Jméno | Popis | Hodnota |
|---|---|---|
| ID autorizačního serveru | Identifikátor autorizačního serveru OAuth. | řetězec |
| obor | rozsah operací. | řetězec |
Smlouva OpenIdAuthenticationSettingsContract
| Jméno | Popis | Hodnota |
|---|---|---|
| bearerTokenSendingMethods | Postup odeslání tokenu na server | Řetězcové pole obsahující některou z těchto možností: AuthorizationHeader Dotaz |
| openidProviderId | Identifikátor autorizačního serveru OAuth. | řetězec |
SubscriptionKeyParameterNamesContract
| Jméno | Popis | Hodnota |
|---|---|---|
| hlavička | Název hlavičky klíče předplatného | řetězec |
| dotaz | Název parametru řetězce dotazu klíče předplatného | řetězec |
Definice prostředku Terraformu (poskytovatel AzAPI)
Typ prostředku service/apis je možné nasadit s operacemi, které cílí:
- Skupiny zdrojů Pro seznam změněných vlastností v každé verzi API viz log změn.
Příklady použití
Ukázky Terraformu
Základní příklad nasazení rozhraní API v rámci služby API Management.
terraform {
required_providers {
azapi = {
source = "Azure/azapi"
}
}
}
provider "azapi" {
skip_provider_registration = false
}
variable "resource_name" {
type = string
default = "acctest0001"
}
variable "location" {
type = string
default = "westeurope"
}
resource "azapi_resource" "resourceGroup" {
type = "Microsoft.Resources/resourceGroups@2020-06-01"
name = var.resource_name
location = var.location
}
resource "azapi_resource" "service" {
type = "Microsoft.ApiManagement/service@2021-08-01"
parent_id = azapi_resource.resourceGroup.id
name = var.resource_name
location = var.location
body = {
properties = {
certificates = [
]
customProperties = {
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30" = "false"
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10" = "false"
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11" = "false"
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10" = "false"
"Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11" = "false"
}
disableGateway = false
publicNetworkAccess = "Enabled"
publisherEmail = "pub1@email.com"
publisherName = "pub1"
virtualNetworkType = "None"
}
sku = {
capacity = 0
name = "Consumption"
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
resource "azapi_resource" "api" {
type = "Microsoft.ApiManagement/service/apis@2021-08-01"
parent_id = azapi_resource.service.id
name = "${var.resource_name};rev=1"
body = {
properties = {
apiRevisionDescription = ""
apiType = "http"
apiVersion = ""
apiVersionDescription = ""
authenticationSettings = {
}
description = ""
displayName = "api1"
path = "api1"
protocols = [
"https",
]
serviceUrl = ""
subscriptionRequired = true
type = "http"
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
Formát prostředku
Pokud chcete vytvořit prostředek Microsoft.ApiManagement/service/apis, přidejte do šablony následující Terraform.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/apis@2022-04-01-preview"
name = "string"
parent_id = "string"
body = {
properties = {
apiRevision = "string"
apiRevisionDescription = "string"
apiType = "string"
apiVersion = "string"
apiVersionDescription = "string"
apiVersionSet = {
description = "string"
id = "string"
name = "string"
versionHeaderName = "string"
versioningScheme = "string"
versionQueryName = "string"
}
apiVersionSetId = "string"
authenticationSettings = {
oAuth2 = {
authorizationServerId = "string"
scope = "string"
}
oAuth2AuthenticationSettings = [
{
authorizationServerId = "string"
scope = "string"
}
]
openid = {
bearerTokenSendingMethods = [
"string"
]
openidProviderId = "string"
}
openidAuthenticationSettings = [
{
bearerTokenSendingMethods = [
"string"
]
openidProviderId = "string"
}
]
}
contact = {
email = "string"
name = "string"
url = "string"
}
description = "string"
displayName = "string"
format = "string"
isCurrent = bool
license = {
name = "string"
url = "string"
}
path = "string"
protocols = [
"string"
]
serviceUrl = "string"
sourceApiId = "string"
subscriptionKeyParameterNames = {
header = "string"
query = "string"
}
subscriptionRequired = bool
termsOfServiceUrl = "string"
translateRequiredQueryParameters = "string"
type = "string"
value = "string"
wsdlSelector = {
wsdlEndpointName = "string"
wsdlServiceName = "string"
}
}
}
}
Hodnoty vlastností
Microsoft.ApiManagement/service/api
ApiContactInformation
| Jméno | Popis | Hodnota |
|---|---|---|
| E-mailová adresa kontaktní osoby nebo organizace Musí být ve formátu e-mailové adresy. | řetězec | |
| Jméno | Identifikační jméno kontaktní osoby nebo organizace | řetězec |
| adresa URL | Adresa URL odkazující na kontaktní údaje. Musí být ve formátu adresy URL. | řetězec |
ApiCreateOrUpdatePropertiesOrApiContractProperties
| Jméno | Popis | Hodnota |
|---|---|---|
| apiRevize | Popisuje revizi rozhraní API. Pokud není zadána žádná hodnota, vytvoří se výchozí revize 1. | řetězec Omezení: Minimální délka = 1 Maximální délka = 100 |
| apiRevisionDescription | Popis revize rozhraní API | řetězec Omezení: Maximální délka = 256 |
| Typ rozhraní apiType | Typ rozhraní API, které se má vytvořit. * http vytvoření rozhraní REST API * soap vytvoří předávací rozhraní API protokolu SOAP * websocket vytvoření rozhraní API protokolu websocket * graphql vytvoří rozhraní GraphQL API. |
Graphql Http "soap" Websocket |
| Verze rozhraní apiVersion | Označuje identifikátor verze rozhraní API, pokud je rozhraní API s verzí. | řetězec Omezení: Maximální délka = 100 |
| apiVersionDescription | Popis verze rozhraní API | řetězec Omezení: Maximální délka = 256 |
| apiVersionSet | Podrobnosti o sadě verzí | apiVersionSetContractDetails |
| apiVersionSetId | Identifikátor prostředku pro související sadu ApiVersionSet. | řetězec |
| Nastavení ověřování | Kolekce nastavení ověřování, která jsou součástí tohoto rozhraní API. | Smlouva AuthenticationSettingsContract |
| kontakt | Kontaktní informace pro rozhraní API | apiContactInformation |
| popis | Popis rozhraní API Může obsahovat značky formátování HTML. | řetězec |
| zobrazované jméno | Název rozhraní API Musí mít délku 1 až 300 znaků. | řetězec Omezení: Minimální délka = 1 Maximální délka = 300 |
| formát | Formát obsahu, ve kterém se rozhraní API importuje | Graphql-link Openapi Openapi+json Openapi+json-link Openapi-link Swagger-json swagger-link-json Wadl-link-json Wadl-xml Wsdl Wsdl-link |
| isCurrent | Označuje, jestli je revize rozhraní API aktuální revizí rozhraní API. | Bool |
| licence | Informace o licenci pro rozhraní API | apiLicenseInformation |
| cesta | Relativní adresa URL jednoznačně identifikuje toto rozhraní API a všechny jeho cesty k prostředkům v rámci instance služby API Management. Připojí se k základní adrese URL koncového bodu rozhraní API zadané během vytváření instance služby a vytvoří veřejnou adresu URL pro toto rozhraní API. | řetězec Omezení: Maximální délka = 400 (povinné) |
| protokoly | Popisuje, na kterých protokolech lze vyvolat operace v tomto rozhraní API. | Řetězcové pole obsahující některou z těchto možností: Http Https 'ws' Wss |
| adresa služby | Absolutní adresa URL back-endové služby, která toto rozhraní API implementuje. Nesmí být delší než 2 000 znaků. | řetězec Omezení: Maximální délka = 2000 |
| sourceApiId | Identifikátor rozhraní API zdrojového rozhraní API. | řetězec |
| subscriptionKeyParameterNames | Protokoly, u kterých je rozhraní API dostupné. | SubscriptionKeyParameterNamesContract |
| předplatnéVyžadováno | Určuje, jestli se pro přístup k rozhraní API vyžaduje předplatné rozhraní API nebo produktu. | Bool |
| termsOfServiceUrl | Adresa URL podmínek služby pro rozhraní API. Musí být ve formátu adresy URL. | řetězec |
| translateRequiredQueryParameters | Strategie překladu požadovaných parametrů dotazu na šablony Ve výchozím nastavení má hodnotu template. Možné hodnoty: template, query | Dotaz Šablona |
| typ | Typ rozhraní API | Graphql Http "soap" Websocket |
| hodnota | Hodnota obsahu při importu rozhraní API | řetězec |
| wsdlSelektor | Kritéria pro omezení importu WSDL na podmnožinu dokumentu | ApiCreateOrUpdatePropertiesWsdlSelector |
ApiCreateOrUpdatePropertiesWsdlSelector
| Jméno | Popis | Hodnota |
|---|---|---|
| wsdlEndpointName | Název koncového bodu (portu) pro import z WSDL | řetězec |
| wsdlNázev_služby | Název služby, která se má importovat z WSDL | řetězec |
Informace o licenci Api
| Jméno | Popis | Hodnota |
|---|---|---|
| Jméno | Název licence použitý pro rozhraní API | řetězec |
| adresa URL | Adresa URL licence použité pro rozhraní API. Musí být ve formátu adresy URL. | řetězec |
ApiVersionSetContractDetails
| Jméno | Popis | Hodnota |
|---|---|---|
| popis | Popis sady verzí rozhraní API | řetězec |
| identifikační číslo | Identifikátor existující sady verzí rozhraní API Tuto hodnotu vynecháte, pokud chcete vytvořit novou sadu verzí. | řetězec |
| Jméno | Zobrazovaný název sady verzí rozhraní API | řetězec |
| versionHeaderName | Název parametru hlavičky HTTP, který označuje verzi rozhraní API, pokud je vlastnost versioningScheme nastavená na header. |
řetězec |
| versioningScheme | Hodnota, která určuje, kde se bude identifikátor verze rozhraní API nacházet v požadavku HTTP. | Hlavička Dotaz Segment |
| versionNázevDotazu | Název parametru dotazu, který označuje verzi rozhraní API, pokud je správa verzí nastavena na query. |
řetězec |
Smlouva AuthenticationSettingsContract
| Jméno | Popis | Hodnota |
|---|---|---|
| oAuth2 řekl: | Nastavení ověřování OAuth2 | Kontrakt OAuth2AuthenticationSettingsContract |
| oAuth2AuthenticationSettings | Kolekce nastavení ověřování OAuth2, která jsou součástí tohoto rozhraní API. | OAuth2AuthenticationSettingsContract[] |
| OpenID | Nastavení ověřování OpenID Connect | Smlouva OpenIdAuthenticationSettingsContract |
| openidAuthenticationSettings | Kolekce nastavení ověřování Open ID Connect, která jsou součástí tohoto rozhraní API. | OpenIdAuthenticationSettingsContract[] |
Kontrakt OAuth2AuthenticationSettingsContract
| Jméno | Popis | Hodnota |
|---|---|---|
| ID autorizačního serveru | Identifikátor autorizačního serveru OAuth. | řetězec |
| obor | rozsah operací. | řetězec |
Smlouva OpenIdAuthenticationSettingsContract
| Jméno | Popis | Hodnota |
|---|---|---|
| bearerTokenSendingMethods | Postup odeslání tokenu na server | Řetězcové pole obsahující některou z těchto možností: AuthorizationHeader Dotaz |
| openidProviderId | Identifikátor autorizačního serveru OAuth. | řetězec |
SubscriptionKeyParameterNamesContract
| Jméno | Popis | Hodnota |
|---|---|---|
| hlavička | Název hlavičky klíče předplatného | řetězec |
| dotaz | Název parametru řetězce dotazu klíče předplatného | řetězec |