Služba Microsoft.ApiManagement/api 2022-09-01-preview
Definice prostředku Bicep
Typ prostředku služby nebo rozhraní API je možné nasadit s operacemi, které cílí na:
- Skupiny prostředků – viz příkazy pro nasazení skupin 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/apis, přidejte do šablony následující bicep.
resource symbolicname 'Microsoft.ApiManagement/service/apis@2022-09-01-preview' = {
name: 'string'
parent: resourceSymbolicName
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í
služba/rozhraní API
Název | Description | Hodnota |
---|---|---|
name | Název prostředku Podívejte se, jak nastavit názvy a typy pro podřízené prostředky v nástroji Bicep. |
string (povinné) Omezení počtu znaků: 1–80 Platné znaky: Alfanumerické znaky a pomlčky. Začněte písmenem a končíte alfanumerickými znaky. |
Nadřazené | V nástroji Bicep můžete zadat nadřazený prostředek podřízeného prostředku. Tuto vlastnost stačí 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 service |
properties | Vytvoření entity rozhraní API s vlastnostmi aktualizace | ApiCreateOrUpdatePropertiesOrApiContractProperties |
ApiCreateOrUpdatePropertiesOrApiContractProperties
Název | Description | Hodnota |
---|---|---|
apiRevision | Popisuje revizi rozhraní API. Pokud se nezadá žádná hodnota, vytvoří se výchozí revize 1. | řetězec |
apiRevisionDescription | Popis revize rozhraní API | řetězec |
Typ rozhraní API | Typ rozhraní API, které chcete vytvořit. * http vytvoří rozhraní REST API.* soap vytvoří předávací rozhraní API protokolu SOAP.* websocket vytvoří rozhraní WEBSocket API.* graphql vytvoří rozhraní GraphQL API. |
'graphql' 'http' "mýdlo" WebSocket |
apiVersion | Označuje identifikátor verze rozhraní API, pokud je rozhraní API s verzí. | řetězec |
popis apiVersionDescription | Popis verze rozhraní API. | řetězec |
apiVersionSet | Podrobnosti sady verzí | ApiVersionSetContractDetails |
apiVersionSetId | Identifikátor prostředku pro související ApiVersionSet. | řetězec |
authenticationSettings | Kolekce nastavení ověřování zahrnutých do tohoto rozhraní API | AuthenticationSettingsContract |
contact | Kontaktní informace pro rozhraní API. | Informace apiContactInformation |
description | Popis rozhraní API. Mohou obsahovat značky formátování HTML. | řetězec |
displayName | Název rozhraní API. Musí mít délku 1 až 300 znaků. | řetězec |
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í revize rozhraní API. | bool |
license | Informace o licenci pro rozhraní API | ApiLicenseInformation |
program | Relativní adresa URL jednoznačně identifikující toto rozhraní API a všechny jeho cesty k prostředkům v instanci služby API Management Připojí se k základní adrese URL koncového bodu rozhraní API zadané při vytváření instance služby a vytvoří veřejnou adresu URL pro toto rozhraní API. | string (povinné) |
Protokoly | Popisuje, na kterých protokolech lze vyvolat operace v tomto rozhraní API. | Pole řetězců obsahující některou z těchto možností: 'http' Https 'ws' 'wss' |
adresa URL služby | Absolutní adresa URL back-endové služby implementuje toto rozhraní API. Nesmí být delší než 2 000 znaků. | řetězec |
id zdrojového rozhraní Api | Identifikátor rozhraní API zdrojového rozhraní API | řetězec |
subscriptionKeyParameterNames | Protokoly, přes které je k dispozici rozhraní API. | SubscriptionKeyParameterNamesContract |
subscriptionRequired | Určuje, jestli se pro přístup k rozhraní API vyžaduje rozhraní API nebo předplatné 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řevodu požadovaných parametrů dotazu na parametry šablony Ve výchozím nastavení má hodnotu "template". Možné hodnoty: template, query | 'dotaz' 'šablona' |
typ | Typ rozhraní API | 'graphql' 'http' "mýdlo" WebSocket |
hodnota | Hodnota obsahu při importu rozhraní API | řetězec |
wsdlSelector | Kritéria pro omezení importu WSDL na podmnožinu dokumentu | ApiCreateOrUpdatePropertiesWsdlSelector |
ApiVersionSetContractDetails
Název | Description | Hodnota |
---|---|---|
description | Popis sady verzí rozhraní API. | řetězec |
id | Identifikátor existující sady verzí rozhraní API Pokud chcete vytvořit novou sadu verzí, tuto hodnotu vynecháte. | řetězec |
name | Zobrazovaný název sady verzí rozhraní API. | řetězec |
versionHeaderName | Název parametru hlavičky HTTP, který označuje verzi rozhraní API, pokud je parametr versioningScheme nastavený na header hodnotu . |
řetězec |
správa verzíScheme | Hodnota, která určuje, kde se v požadavku HTTP bude nacházet identifikátor verze rozhraní API. | 'Header' Dotaz 'Segment' |
versionQueryName | Název parametru dotazu, který označuje verzi rozhraní API, pokud je správa verzíScheme nastavená na query . |
řetězec |
AuthenticationSettingsContract
Název | Description | Hodnota |
---|---|---|
oAuth2 | Nastavení ověřování OAuth2 | OAuth2AuthenticationSettingsContract |
oAuth2AuthenticationSettings | Kolekce nastavení ověřování OAuth2, která jsou součástí tohoto rozhraní API. | OAuth2AuthenticationSettingsContract[] |
Openid | Nastavení ověřování OpenID Connect | OpenIdAuthenticationSettingsContract |
openidAuthenticationSettings | Kolekce nastavení ověřování Open ID Connect, která jsou součástí tohoto rozhraní API. | OpenIdAuthenticationSettingsContract[] |
OAuth2AuthenticationSettingsContract
Název | Description | Hodnota |
---|---|---|
ID autorizačního serveru | Identifikátor autorizačního serveru OAuth. | řetězec |
scope | rozsah operací. | řetězec |
OpenIdAuthenticationSettingsContract
Název | Description | Hodnota |
---|---|---|
bearerTokenSendingMethods | Postup odeslání tokenu na server | Pole řetězců obsahující některou z těchto možností: AuthorizationHeader 'dotaz' |
openidProviderId | Identifikátor autorizačního serveru OAuth. | řetězec |
Informace apiContactInformation
Název | Description | Hodnota |
---|---|---|
E-mailová adresa kontaktní osoby nebo organizace MUSÍ být ve formátu e-mailové adresy. | řetězec | |
name | Identifikační jméno kontaktní osoby nebo organizace | řetězec |
url | Adresa URL odkazující na kontaktní informace. MUSÍ být ve formátu adresy URL. | řetězec |
ApiLicenseInformation
Název | Description | Hodnota |
---|---|---|
name | Název licence použitý pro rozhraní API | řetězec |
url | Adresa URL licence použité pro rozhraní API. MUSÍ být ve formátu adresy URL. | řetězec |
SubscriptionKeyParameterNamesContract
Název | Description | Hodnota |
---|---|---|
header | Název hlavičky klíče předplatného. | řetězec |
query | Název parametru řetězce dotazu klíče předplatného. | řetězec |
ApiCreateOrUpdatePropertiesWsdlSelector
Název | Description | Hodnota |
---|---|---|
wsdlEndpointName | Název koncového bodu (portu) pro import z WSDL | řetězec |
wsdlServiceName | Název služby, která se má importovat z WSDL | řetězec |
Šablony pro rychlý start
Následující šablony pro rychlý start nasadí tento typ prostředku.
Template (Šablona) | Description |
---|---|
Vytvoření instance služby API Management a všech dílčích prostředků pomocí šablony |
Tato šablona ukazuje, jak vytvořit službu API Management a nakonfigurovat dílčí entity. |
Vytvoření služby Azure Front Door před azure API Management |
Tato ukázka ukazuje použití služby Azure Front Door jako globálního nástroje pro vyrovnávání zatížení před azure API Management. |
Definice prostředku šablony ARM
Typ prostředku služby nebo rozhraní API je možné nasadit s operacemi, které cílí na:
- Skupiny prostředků – viz příkazy pro nasazení skupin 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/apis, přidejte do šablony následující kód JSON.
{
"type": "Microsoft.ApiManagement/service/apis",
"apiVersion": "2022-09-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í
služba/rozhraní API
Název | Description | Hodnota |
---|---|---|
typ | Typ prostředku | Microsoft.ApiManagement/service/apis |
apiVersion | Verze rozhraní API prostředku | 2022-09-01-preview |
name | Název prostředku Podívejte se, jak nastavit názvy a typy pro podřízené prostředky v šablonách JSON ARM. |
string (povinné) Omezení počtu znaků: 1–80 Platné znaky: Alfanumerické znaky a pomlčky. Začněte písmenem a končíte alfanumerickými znaky. |
properties | Vytvoření entity rozhraní API s vlastnostmi aktualizace | ApiCreateOrUpdatePropertiesOrApiContractProperties |
ApiCreateOrUpdatePropertiesOrApiContractProperties
Název | Description | Hodnota |
---|---|---|
apiRevision | Popisuje revizi rozhraní API. Pokud se nezadá žádná hodnota, vytvoří se výchozí revize 1. | řetězec |
apiRevisionDescription | Popis revize rozhraní API | řetězec |
Typ rozhraní API | Typ rozhraní API, které chcete vytvořit. * http vytvoří rozhraní REST API.* soap vytvoří předávací rozhraní API protokolu SOAP.* websocket vytvoří rozhraní WEBSocket API.* graphql vytvoří rozhraní GraphQL API. |
'graphql' 'http' "mýdlo" WebSocket |
apiVersion | Označuje identifikátor verze rozhraní API, pokud je rozhraní API s verzí. | řetězec |
popis apiVersionDescription | Popis verze rozhraní API. | řetězec |
apiVersionSet | Podrobnosti sady verzí | ApiVersionSetContractDetails |
apiVersionSetId | Identifikátor prostředku pro související ApiVersionSet. | řetězec |
authenticationSettings | Kolekce nastavení ověřování zahrnutých do tohoto rozhraní API | AuthenticationSettingsContract |
contact | Kontaktní informace pro rozhraní API. | Informace apiContactInformation |
description | Popis rozhraní API. Mohou obsahovat značky formátování HTML. | řetězec |
displayName | Název rozhraní API. Musí mít délku 1 až 300 znaků. | řetězec |
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í revize rozhraní API. | bool |
license | Informace o licenci pro rozhraní API | ApiLicenseInformation |
program | Relativní adresa URL jednoznačně identifikující toto rozhraní API a všechny jeho cesty k prostředkům v instanci služby API Management Připojí se k základní adrese URL koncového bodu rozhraní API zadané při vytváření instance služby a vytvoří veřejnou adresu URL pro toto rozhraní API. | string (povinné) |
Protokoly | Popisuje, na kterých protokolech lze vyvolat operace v tomto rozhraní API. | Pole řetězců obsahující některou z těchto možností: 'http' Https 'ws' 'wss' |
adresa URL služby | Absolutní adresa URL back-endové služby implementuje toto rozhraní API. Nesmí být delší než 2 000 znaků. | řetězec |
id zdrojového rozhraní Api | Identifikátor rozhraní API zdrojového rozhraní API | řetězec |
subscriptionKeyParameterNames | Protokoly, přes které je k dispozici rozhraní API. | SubscriptionKeyParameterNamesContract |
subscriptionRequired | Určuje, jestli se pro přístup k rozhraní API vyžaduje rozhraní API nebo předplatné 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řevodu požadovaných parametrů dotazu na parametry šablony Ve výchozím nastavení má hodnotu "template". Možné hodnoty: template, query | 'dotaz' 'šablona' |
typ | Typ rozhraní API | 'graphql' 'http' "mýdlo" WebSocket |
hodnota | Hodnota obsahu při importu rozhraní API | řetězec |
wsdlSelector | Kritéria pro omezení importu WSDL na podmnožinu dokumentu | ApiCreateOrUpdatePropertiesWsdlSelector |
ApiVersionSetContractDetails
Název | Description | Hodnota |
---|---|---|
description | Popis sady verzí rozhraní API. | řetězec |
id | Identifikátor existující sady verzí rozhraní API Pokud chcete vytvořit novou sadu verzí, tuto hodnotu vynecháte. | řetězec |
name | Zobrazovaný název sady verzí rozhraní API. | řetězec |
versionHeaderName | Název parametru hlavičky HTTP, který označuje verzi rozhraní API, pokud je parametr versioningScheme nastavený na header hodnotu . |
řetězec |
správa verzíScheme | Hodnota, která určuje, kde se v požadavku HTTP bude nacházet identifikátor verze rozhraní API. | 'Header' Dotaz 'Segment' |
versionQueryName | Název parametru dotazu, který označuje verzi rozhraní API, pokud je správa verzíScheme nastavená na query . |
řetězec |
AuthenticationSettingsContract
Název | Description | Hodnota |
---|---|---|
oAuth2 | Nastavení ověřování OAuth2 | OAuth2AuthenticationSettingsContract |
oAuth2AuthenticationSettings | Kolekce nastavení ověřování OAuth2, která jsou součástí tohoto rozhraní API. | OAuth2AuthenticationSettingsContract[] |
Openid | Nastavení ověřování OpenID Connect | OpenIdAuthenticationSettingsContract |
openidAuthenticationSettings | Kolekce nastavení ověřování Open ID Connect, která jsou součástí tohoto rozhraní API. | OpenIdAuthenticationSettingsContract[] |
OAuth2AuthenticationSettingsContract
Název | Description | Hodnota |
---|---|---|
ID autorizačního serveru | Identifikátor autorizačního serveru OAuth. | řetězec |
scope | rozsah operací. | řetězec |
OpenIdAuthenticationSettingsContract
Název | Description | Hodnota |
---|---|---|
bearerTokenSendingMethods | Postup odeslání tokenu na server | Pole řetězců obsahující některou z těchto možností: AuthorizationHeader 'dotaz' |
openidProviderId | Identifikátor autorizačního serveru OAuth. | řetězec |
Informace apiContactInformation
Název | Description | Hodnota |
---|---|---|
E-mailová adresa kontaktní osoby nebo organizace MUSÍ být ve formátu e-mailové adresy. | řetězec | |
name | Identifikační jméno kontaktní osoby nebo organizace | řetězec |
url | Adresa URL odkazující na kontaktní informace. MUSÍ být ve formátu adresy URL. | řetězec |
ApiLicenseInformation
Název | Description | Hodnota |
---|---|---|
name | Název licence použitý pro rozhraní API | řetězec |
url | Adresa URL licence použité pro rozhraní API. MUSÍ být ve formátu adresy URL. | řetězec |
SubscriptionKeyParameterNamesContract
Název | Description | Hodnota |
---|---|---|
header | Název hlavičky klíče předplatného. | řetězec |
query | Název parametru řetězce dotazu klíče předplatného. | řetězec |
ApiCreateOrUpdatePropertiesWsdlSelector
Název | Description | Hodnota |
---|---|---|
wsdlEndpointName | Název koncového bodu (portu) pro import z WSDL | řetězec |
wsdlServiceName | Název služby, která se má importovat z WSDL | řetězec |
Šablony pro rychlý start
Následující šablony pro rychlý start nasadí tento typ prostředku.
Template (Šablona) | Description |
---|---|
Vytvoření instance služby API Management a všech dílčích prostředků pomocí šablony |
Tato šablona ukazuje, jak vytvořit službu API Management a nakonfigurovat dílčí entity. |
Vytvoření služby Azure Front Door před azure API Management |
Tato ukázka ukazuje použití služby Azure Front Door jako globálního nástroje pro vyrovnávání zatížení před azure API Management. |
Definice prostředku Terraform (poskytovatel AzAPI)
Typ prostředku služby nebo rozhraní API je možné nasadit s operacemi, které cílí na:
- 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/apis, přidejte do šablony následující Terraform.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/apis@2022-09-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
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í
služba/rozhraní API
Název | Description | Hodnota |
---|---|---|
typ | Typ prostředku | Microsoft.ApiManagement/service/apis@2022-09-01-preview |
name | Název prostředku | string (povinné) Omezení počtu znaků: 1–80 Platné znaky: Alfanumerické znaky a pomlčky. Začněte písmenem a končíte alfanumerickými znaky. |
parent_id | ID prostředku, který je nadřazený pro tento prostředek. | ID prostředku typu service |
properties | Vytvoření entity rozhraní API s vlastnostmi aktualizace | ApiCreateOrUpdatePropertiesOrApiContractProperties |
ApiCreateOrUpdatePropertiesOrApiContractProperties
Název | Description | Hodnota |
---|---|---|
apiRevision | Popisuje revizi rozhraní API. Pokud se nezadá žádná hodnota, vytvoří se výchozí revize 1. | řetězec |
apiRevisionDescription | Popis revize rozhraní API | řetězec |
Typ rozhraní API | Typ rozhraní API, které chcete vytvořit. * http vytvoří rozhraní REST API.* soap vytvoří předávací rozhraní API protokolu SOAP.* websocket vytvoří rozhraní WEBSocket API.* graphql vytvoří rozhraní GraphQL API. |
"graphql" "http" "soap" "websocket" |
apiVersion | Označuje identifikátor verze rozhraní API, pokud je rozhraní API s verzí. | řetězec |
popis apiVersionDescription | Popis verze rozhraní API. | řetězec |
apiVersionSet | Podrobnosti sady verzí | ApiVersionSetContractDetails |
apiVersionSetId | Identifikátor prostředku pro související ApiVersionSet. | řetězec |
authenticationSettings | Kolekce nastavení ověřování zahrnutých do tohoto rozhraní API | AuthenticationSettingsContract |
contact | Kontaktní informace pro rozhraní API. | Informace apiContactInformation |
description | Popis rozhraní API. Mohou obsahovat značky formátování HTML. | řetězec |
displayName | Název rozhraní API. Musí mít délku 1 až 300 znaků. | řetězec |
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í revize rozhraní API. | bool |
license | Informace o licencích pro rozhraní API | ApiLicenseInformation |
program | Relativní adresa URL jednoznačně identifikující 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 zadanou při vytváření instance služby a vytvoří veřejnou adresu URL pro toto rozhraní API. | string (povinné) |
Protokoly | Popisuje, na kterých protokolech lze vyvolat operace v tomto rozhraní API. | Pole řetězců obsahující některou z těchto možností: "http" "https" "ws" "wss" |
serviceUrl | Absolutní adresa URL back-endové služby implementuje toto rozhraní API. Nesmí být delší než 2000 znaků. | řetězec |
sourceApiId | Identifikátor rozhraní API zdrojového rozhraní API | řetězec |
subscriptionKeyParameterNames | Protokoly, přes které je k dispozici rozhraní API. | SubscriptionKeyParameterNamesContract |
subscriptionRequired | Určuje, jestli se pro přístup k rozhraní API vyžaduje předplatné rozhraní API nebo product. | bool |
termsOfServiceUrl | Adresa URL pro podmínky 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 parametry šablony. Ve výchozím nastavení má hodnotu "šablona". Možné hodnoty: 'template', 'query' | "dotaz" "šablona" |
typ | Typ rozhraní API | "graphql" "http" "mýdlo" "websocket" |
hodnota | Hodnota obsahu při importu rozhraní API | řetězec |
wsdlSelector | Kritéria pro omezení importu WSDL na podmnožinu dokumentu | ApiCreateOrUpdatePropertiesWsdlSelector |
ApiVersionSetContractDetails
Název | Description | Hodnota |
---|---|---|
description | Popis sady verzí rozhraní API | řetězec |
id | Identifikátor existující sady verzí rozhraní API. Pokud chcete vytvořit novou sadu verzí, tuto hodnotu vynecháte. | řetězec |
name | Zobrazovaný název sady verzí rozhraní API. | řetězec |
versionHeaderName | Název parametru hlavičky HTTP, který označuje verzi rozhraní API, pokud je funkce VersioningScheme nastavená na header hodnotu . |
řetězec |
správa verzíScheme | Hodnota, která určuje, kde se bude v požadavku HTTP nacházet identifikátor verze rozhraní API. | Hlavička "Dotaz" "Segment" |
versionQueryName | Název parametru dotazu, který označuje verzi rozhraní API, pokud je parametr versioningScheme nastavený na query hodnotu . |
řetězec |
AuthenticationSettingsContract
Název | Description | Hodnota |
---|---|---|
oAuth2 | Nastavení ověřování OAuth2 | OAuth2AuthenticationSettingsContract |
oAuth2AuthenticationSettings | Kolekce nastavení ověřování OAuth2, která jsou součástí tohoto rozhraní API. | OAuth2AuthenticationSettingsContract[] |
Openid | Nastavení ověřování OpenID Connect | OpenIdAuthenticationSettingsContract |
openidAuthenticationSettings | Kolekce nastavení ověřování Open ID Connect, která jsou součástí tohoto rozhraní API. | OpenIdAuthenticationSettingsContract[] |
OAuth2AuthenticationSettingsContract
Název | Description | Hodnota |
---|---|---|
authorizationServerId | Identifikátor autorizačního serveru OAuth. | řetězec |
scope | rozsah operací. | řetězec |
OpenIdAuthenticationSettingsContract
Název | Description | Hodnota |
---|---|---|
bearerTokenSendingMethods | Postup odeslání tokenu na server | Pole řetězců obsahující některou z těchto možností: "authorizationHeader" "dotaz" |
openidProviderId | Identifikátor autorizačního serveru OAuth. | řetězec |
ApiContactInformation
Název | Description | Hodnota |
---|---|---|
E-mailová adresa kontaktní osoby nebo organizace. MUSÍ být ve formátu e-mailové adresy. | řetězec | |
name | Identifikační jméno kontaktní osoby nebo organizace | řetězec |
url | Adresa URL odkazující na kontaktní informace. MUSÍ být ve formátu adresy URL. | řetězec |
ApiLicenseInformation
Název | Description | Hodnota |
---|---|---|
name | Název licence použitý pro rozhraní API | řetězec |
url | Adresa URL licence použité pro rozhraní API. MUSÍ být ve formátu adresy URL. | řetězec |
SubscriptionKeyParameterNamesContract
Název | Description | Hodnota |
---|---|---|
header | Název hlavičky klíče předplatného. | řetězec |
query | Název parametru řetězce dotazu s klíčem předplatného. | řetězec |
ApiCreateOrUpdatePropertiesWsdlSelector
Název | Description | Hodnota |
---|---|---|
wsdlEndpointName | Název koncového bodu (portu) pro import z WSDL | řetězec |
wsdlServiceName | Název služby, která se má importovat z WSDL | řetězec |