Microsoft.ApiManagement service/apis 2022-08-01
Bicep-resursdefinition
Resurstypen service/apis kan distribueras med åtgärder som mål:
- Resursgrupper – Se distributionskommandon för resursgrupper
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.ApiManagement/service/apis-resurs lägger du till följande Bicep i mallen.
resource symbolicname 'Microsoft.ApiManagement/service/apis@2022-08-01' = {
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'
}
}
}
Egenskapsvärden
service/apis
Name | Beskrivning | Värde |
---|---|---|
name | Resursnamnet Se hur du anger namn och typer för underordnade resurser i Bicep. |
sträng (krävs) Teckengräns: 1–80 Giltiga tecken: Alfanumeriska tecken och bindestreck. Börja med bokstav och slut med alfanumeriskt. |
parent | I Bicep kan du ange den överordnade resursen för en underordnad resurs. Du behöver bara lägga till den här egenskapen när den underordnade resursen deklareras utanför den överordnade resursen. Mer information finns i Underordnad resurs utanför överordnad resurs. |
Symboliskt namn för resurs av typen: tjänst |
properties | API-entitetsskapande av uppdateringsegenskaper. | ApiCreateOrUpdatePropertiesOrApiContractProperties |
ApiCreateOrUpdatePropertiesOrApiContractProperties
Name | Beskrivning | Värde |
---|---|---|
apiRevision | Beskriver revisionen av API:et. Om inget värde anges skapas standardrevision 1 | sträng |
apiRevisionDescription | Beskrivning av API Revision. | sträng |
apiType | Typ av API som ska skapas. * http skapar ett REST-API* soap skapar ett SOAP-API för direktströmning* websocket skapar websocket-API* graphql skapar GraphQL API. |
"graphql" "http" "soap" "websocket" |
apiVersion | Anger versionsidentifieraren för API:et om API:et är versionshanterat | sträng |
apiVersionDescription | Beskrivning av API-versionen. | sträng |
apiVersionSet | Information om versionsuppsättning | ApiVersionSetContractDetails |
apiVersionSetId | En resursidentifierare för den relaterade ApiVersionSet. | sträng |
authenticationSettings | Samling autentiseringsinställningar som ingår i det här API:et. | AuthenticationSettingsContract |
kontakt | Kontaktuppgifter för API:et. | ApiContactInformation |
beskrivning | Beskrivning av API:et. Kan innehålla HTML-formateringstaggar. | sträng |
displayName | API-namn. Måste vara mellan 1 och 300 tecken långt. | sträng |
format | Format för det innehåll där API:et importeras. | "graphql-link" "openapi" "openapi+json" "openapi+json-link" "openapi-link" "swagger-json" "swagger-link-json" "wadl-link-json" "wadl-xml" "wsdl" "wsdl-link" |
isCurrent | Anger om API-revision är aktuell API-revision. | boolesk |
licens | Licensinformation för API:et. | ApiLicenseInformation |
path | Relativ URL som unikt identifierar det här API:et och alla dess resurssökvägar i API Management tjänstinstans. Den läggs till i DEN API-slutpunktsbas-URL som angavs när tjänstinstansen skapades för att skapa en offentlig URL för det här API:et. | sträng (krävs) |
Protokoll | Beskriver vilka protokoll som åtgärderna i det här API:et kan anropas för. | Strängmatris som innehåller något av: "http" "https" "ws" "wss" |
serviceUrl | Absolut URL för serverdelstjänsten som implementerar det här API:et. Får inte vara längre än 2 000 tecken. | sträng |
sourceApiId | API-identifierare för käll-API:et. | sträng |
subscriptionKeyParameterNames | Protokoll över vilka API:et görs tillgängligt. | SubscriptionKeyParameterNamesContract |
subscriptionRequired | Anger om ett API eller en produktprenumeration krävs för åtkomst till API:et. | boolesk |
termsOfServiceUrl | En URL till användarvillkoren för API:et. MÅSTE vara i formatet för en URL. | sträng |
translateRequiredQueryParameters | Strategi för att översätta obligatoriska frågeparametrar till mallparametrar. Som standard har värdet "mall". Möjliga värden: "mall", "fråga" | "fråga" "mall" |
typ | Typ av API. | "graphql" "http" "soap" "websocket" |
värde | Innehållsvärde vid import av ett API. | sträng |
wsdlSelector | Villkor för att begränsa importen av WSDL till en delmängd av dokumentet. | ApiCreateOrUpdatePropertiesWsdlSelector |
ApiVersionSetContractDetails
Name | Beskrivning | Värde |
---|---|---|
beskrivning | Beskrivning av API-versionsuppsättning. | sträng |
id | Identifierare för befintlig API-versionsuppsättning. Utelämna det här värdet för att skapa en ny versionsuppsättning. | sträng |
name | Visningsnamnet för API-versionsuppsättningen. | sträng |
versionHeaderName | Namnet på HTTP-huvudparametern som anger API-versionen om versionshanteringScheme är inställt på header . |
sträng |
versioningScheme | Ett värde som avgör var API-versionsidentifieraren ska finnas i en HTTP-begäran. | "Rubrik" "Fråga" Segment |
versionQueryName | Namnet på frågeparametern som anger API-versionen om versionshanteringScheme är inställt på query . |
sträng |
AuthenticationSettingsContract
Name | Beskrivning | Värde |
---|---|---|
oAuth2 | Autentiseringsinställningar för OAuth2 | OAuth2AuthenticationSettingsContract |
oAuth2AuthenticationSettings | Samling OAuth2-autentiseringsinställningar som ingår i det här API:et. | OAuth2AuthenticationSettingsContract[] |
Openid | Inställningar för OpenID Connect-autentisering | OpenIdAuthenticationSettingsContract |
openidAuthenticationSettings | Samling av autentiseringsinställningar för Open ID Connect som ingår i det här API:et. | OpenIdAuthenticationSettingsContract[] |
OAuth2AuthenticationSettingsContract
Name | Beskrivning | Värde |
---|---|---|
authorizationServerId | OAuth-auktoriseringsserveridentifierare. | sträng |
omfång | åtgärdsomfång. | sträng |
OpenIdAuthenticationSettingsContract
Name | Beskrivning | Värde |
---|---|---|
bearerTokenSendingMethods | Så här skickar du token till servern. | Strängmatris som innehåller något av: "authorizationHeader" "fråga" |
openidProviderId | OAuth-auktoriseringsserveridentifierare. | sträng |
ApiContactInformation
Name | Beskrivning | Värde |
---|---|---|
e-post | Kontaktpersonens/organisationens e-postadress. MÅSTE vara i formatet för en e-postadress | sträng |
name | Identitetsnamnet för kontaktpersonen/organisationen | sträng |
url | Url:en som pekar på kontaktinformationen. MÅSTE vara i formatet för en URL | sträng |
ApiLicenseInformation
Name | Beskrivning | Värde |
---|---|---|
name | Licensnamnet som används för API:et | sträng |
url | En URL till den licens som används för API:et. MÅSTE vara i formatet för en URL | sträng |
SubscriptionKeyParameterNamesContract
Name | Beskrivning | Värde |
---|---|---|
sidhuvud | Namn på prenumerationsnyckelhuvud. | sträng |
query | Parameternamn för frågesträng för prenumerationsnyckel. | sträng |
ApiCreateOrUpdatePropertiesWsdlSelector
Name | Beskrivning | Värde |
---|---|---|
wsdlEndpointName | Namn på slutpunkt(port) som ska importeras från WSDL | sträng |
wsdlServiceName | Namnet på tjänsten som ska importeras från WSDL | sträng |
Snabbstartsmallar
Följande snabbstartsmallar distribuerar den här resurstypen.
Mall | Description |
---|---|
Skapa en API Management-instans och alla underresurser med hjälp av mallen |
Den här mallen visar hur du skapar en API Management-tjänst och konfigurerar underentiteter |
Skapa Azure Front Door framför Azure API Management |
Det här exemplet visar hur du använder Azure Front Door som global lastbalanserare framför Azure API Management. |
Resursdefinition för ARM-mall
Resurstypen service/apis kan distribueras med åtgärder som mål:
- Resursgrupper – Se distributionskommandon för resursgrupper
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.ApiManagement/service/apis-resurs lägger du till följande JSON i mallen.
{
"type": "Microsoft.ApiManagement/service/apis",
"apiVersion": "2022-08-01",
"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"
}
}
}
Egenskapsvärden
service/apis
Name | Beskrivning | Värde |
---|---|---|
typ | Resurstypen | "Microsoft.ApiManagement/service/apis" |
apiVersion | Resurs-API-versionen | '2022-08-01' |
name | Resursnamnet Se hur du anger namn och typer för underordnade resurser i JSON ARM-mallar. |
sträng (krävs) Teckengräns: 1–80 Giltiga tecken: Alfanumeriska tecken och bindestreck. Börja med bokstav och slut med alfanumeriskt. |
properties | API-entitetsskapande av uppdateringsegenskaper. | ApiCreateOrUpdatePropertiesOrApiContractProperties |
ApiCreateOrUpdatePropertiesOrApiContractProperties
Name | Beskrivning | Värde |
---|---|---|
apiRevision | Beskriver revisionen av API:et. Om inget värde anges skapas standardrevision 1 | sträng |
apiRevisionDescription | Beskrivning av API-revisionen. | sträng |
apiType | Typ av API som ska skapas. * http skapar ett REST-API* soap skapar ett SOAP-api för direktströmning* websocket skapar websocket-API* graphql skapar GraphQL API. |
'graphql' "http" "tvål" "websocket" |
apiVersion | Anger versionsidentifieraren för API:et om API:et är versionshanterat | sträng |
apiVersionDescription | Beskrivning av API-versionen. | sträng |
apiVersionSet | Information om versionsuppsättning | ApiVersionSetContractDetails |
apiVersionSetId | En resursidentifierare för den relaterade ApiVersionSet. | sträng |
authenticationSettings | Samling autentiseringsinställningar som ingår i det här API:et. | AuthenticationSettingsContract |
kontakt | Kontaktuppgifter för API:et. | ApiContactInformation |
beskrivning | Beskrivning av API:et. Kan innehålla HTML-formateringstaggar. | sträng |
displayName | API-namn. Måste vara mellan 1 och 300 tecken långt. | sträng |
format | Format för det innehåll där API:et importeras. | "graphql-link" "openapi" "openapi+json" "openapi+json-link" "openapi-link" "swagger-json" "swagger-link-json" "wadl-link-json" "wadl-xml" "wsdl" "wsdl-link" |
isCurrent | Anger om API-revisionen är aktuell API-revision. | boolesk |
licens | Licensinformation för API:et. | ApiLicenseInformation |
path | Relativ URL som unikt identifierar det här API:et och alla dess resurssökvägar i API Management tjänstinstans. Den läggs till i DEN API-slutpunktsbas-URL som angavs när tjänstinstansen skapades för att skapa en offentlig URL för det här API:et. | sträng (krävs) |
Protokoll | Beskriver vilka protokoll som åtgärderna i det här API:et kan anropas för. | Strängmatris som innehåller något av: "http" "https" "ws" "wss" |
serviceUrl | Absolut URL för serverdelstjänsten som implementerar det här API:et. Får inte vara längre än 2 000 tecken. | sträng |
sourceApiId | API-identifierare för käll-API:et. | sträng |
subscriptionKeyParameterNames | Protokoll som API:et görs tillgängligt för. | SubscriptionKeyParameterNamesContract |
subscriptionRequired | Anger om ett API eller en produktprenumeration krävs för åtkomst till API:et. | boolesk |
termsOfServiceUrl | En URL till användningsvillkoren för API:et. MÅSTE vara i formatet för en URL. | sträng |
translateRequiredQueryParameters | Strategi för översättning av obligatoriska frågeparametrar till mallparametrar. Som standard har värdet "template". Möjliga värden: "template", "query" | "fråga" "mall" |
typ | Typ av API. | 'graphql' "http" "tvål" "websocket" |
värde | Innehållsvärde när du importerar ett API. | sträng |
wsdlSelector | Kriterier för att begränsa importen av WSDL till en delmängd av dokumentet. | ApiCreateOrUpdatePropertiesWsdlSelector |
ApiVersionSetContractDetails
Name | Beskrivning | Värde |
---|---|---|
beskrivning | Beskrivning av API-versionsuppsättning. | sträng |
id | Identifierare för befintlig API-versionsuppsättning. Utelämna det här värdet om du vill skapa en ny versionsuppsättning. | sträng |
name | Visningsnamn för API-versionsuppsättningen. | sträng |
versionHeaderName | Namnet på HTTP-huvudparametern som anger API-versionen om versioningScheme har angetts till header . |
sträng |
versioningScheme | Ett värde som avgör var API-versionsidentifieraren ska finnas i en HTTP-begäran. | "Sidhuvud" "Fråga" Segment |
versionQueryName | Namnet på frågeparametern som anger API-versionen om versioningScheme är inställt på query . |
sträng |
AuthenticationSettingsContract
Name | Beskrivning | Värde |
---|---|---|
oAuth2 | Inställningar för OAuth2-autentisering | OAuth2AuthenticationSettingsContract |
oAuth2AuthenticationSettings | Samling OAuth2-autentiseringsinställningar som ingår i det här API:et. | OAuth2AuthenticationSettingsContract[] |
Openid | Inställningar för OpenID Connect-autentisering | OpenIdAuthenticationSettingsContract |
openidAuthenticationSettings | Samling autentiseringsinställningar för Open ID Connect som ingår i det här API:et. | OpenIdAuthenticationSettingsContract[] |
OAuth2AuthenticationSettingsContract
Name | Beskrivning | Värde |
---|---|---|
authorizationServerId | OAuth-auktoriseringsserveridentifierare. | sträng |
omfång | omfång för åtgärder. | sträng |
OpenIdAuthenticationSettingsContract
Name | Beskrivning | Värde |
---|---|---|
bearerTokenSendingMethods | Skicka token till servern. | Strängmatris som innehåller något av: "authorizationHeader" "fråga" |
openidProviderId | OAuth-auktoriseringsserveridentifierare. | sträng |
ApiContactInformation
Name | Beskrivning | Värde |
---|---|---|
e-post | Kontaktpersonens/organisationens e-postadress. MÅSTE vara i formatet för en e-postadress | sträng |
name | Kontaktpersonens/organisationens identifieringsnamn | sträng |
url | URL:en som pekar på kontaktinformationen. MÅSTE vara i formatet för en URL | sträng |
ApiLicenseInformation
Name | Beskrivning | Värde |
---|---|---|
name | Licensnamnet som används för API:et | sträng |
url | En URL till den licens som används för API:et. MÅSTE vara i formatet för en URL | sträng |
SubscriptionKeyParameterNamesContract
Name | Beskrivning | Värde |
---|---|---|
sidhuvud | Rubriknamn för prenumerationsnyckel. | sträng |
query | Parameternamn för frågesträng för prenumerationsnyckel. | sträng |
ApiCreateOrUpdatePropertiesWsdlSelector
Name | Beskrivning | Värde |
---|---|---|
wsdlEndpointName | Namn på slutpunkt (port) som ska importeras från WSDL | sträng |
wsdlServiceName | Namn på tjänst som ska importeras från WSDL | sträng |
Snabbstartsmallar
Följande snabbstartsmallar distribuerar den här resurstypen.
Mall | Description |
---|---|
Skapa en API Management-instans och alla underresurser med hjälp av mallen |
Den här mallen visar hur du skapar en API Management-tjänst och konfigurerar underentiteter |
Skapa Azure Front Door framför Azure API Management |
Det här exemplet visar hur du använder Azure Front Door som global lastbalanserare framför Azure API Management. |
Resursdefinition för Terraform (AzAPI-provider)
Resurstypen tjänst/apis kan distribueras med åtgärder som mål:
- Resursgrupper
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.ApiManagement/service/apis-resurs lägger du till följande Terraform i mallen.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/apis@2022-08-01"
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"
}
}
})
}
Egenskapsvärden
service/apis
Name | Beskrivning | Värde |
---|---|---|
typ | Resurstypen | "Microsoft.ApiManagement/service/apis@2022-08-01" |
name | Resursnamnet | sträng (krävs) Teckengräns: 1–80 Giltiga tecken: Alfanumeriska tecken och bindestreck. Börja med bokstav och slut med alfanumeriskt. |
parent_id | ID för resursen som är överordnad för den här resursen. | ID för resurs av typen: tjänst |
properties | API-entitetsskapande av uppdateringsegenskaper. | ApiCreateOrUpdatePropertiesOrApiContractProperties |
ApiCreateOrUpdatePropertiesOrApiContractProperties
Name | Beskrivning | Värde |
---|---|---|
apiRevision | Beskriver revisionen av API:et. Om inget värde anges skapas standardrevision 1 | sträng |
apiRevisionDescription | Beskrivning av API-revisionen. | sträng |
apiType | Typ av API som ska skapas. * http skapar ett REST-API* soap skapar ett SOAP-api för direktströmning* websocket skapar websocket-API* graphql skapar GraphQL API. |
"graphql" "http" "soap" "websocket" |
apiVersion | Anger versionsidentifieraren för API:et om API:et är versionshanterat | sträng |
apiVersionDescription | Beskrivning av API-versionen. | sträng |
apiVersionSet | Information om versionsuppsättning | ApiVersionSetContractDetails |
apiVersionSetId | En resursidentifierare för den relaterade ApiVersionSet. | sträng |
authenticationSettings | Samling autentiseringsinställningar som ingår i det här API:et. | AuthenticationSettingsContract |
kontakt | Kontaktuppgifter för API:et. | ApiContactInformation |
beskrivning | Beskrivning av API:et. Kan innehålla HTML-formateringstaggar. | sträng |
displayName | API-namn. Måste vara mellan 1 och 300 tecken långt. | sträng |
format | Format för det innehåll där API:et importeras. | "graphql-link" "openapi" "openapi+json" "openapi+json-link" "openapi-link" "swagger-json" "swagger-link-json" "wadl-link-json" "wadl-xml" "wsdl" "wsdl-link" |
isCurrent | Anger om API-revisionen är aktuell API-revision. | boolesk |
licens | Licensinformation för API:et. | ApiLicenseInformation |
path | Relativ URL som unikt identifierar det här API:et och alla dess resurssökvägar i API Management tjänstinstans. Den läggs till i DEN API-slutpunktsbas-URL som angavs när tjänstinstansen skapades för att skapa en offentlig URL för det här API:et. | sträng (krävs) |
Protokoll | Beskriver vilka protokoll som åtgärderna i det här API:et kan anropas för. | Strängmatris som innehåller något av: "http" "https" "ws" "wss" |
serviceUrl | Absolut URL för serverdelstjänsten som implementerar det här API:et. Får inte vara längre än 2 000 tecken. | sträng |
sourceApiId | API-identifierare för käll-API:et. | sträng |
subscriptionKeyParameterNames | Protokoll som API:et görs tillgängligt för. | SubscriptionKeyParameterNamesContract |
subscriptionRequired | Anger om ett API eller en produktprenumeration krävs för åtkomst till API:et. | boolesk |
termsOfServiceUrl | En URL till användningsvillkoren för API:et. MÅSTE vara i formatet för en URL. | sträng |
translateRequiredQueryParameters | Strategi för översättning av obligatoriska frågeparametrar till mallparametrar. Som standard har värdet "template". Möjliga värden: "template", "query" | "query" "mall" |
typ | Typ av API. | "graphql" "http" "soap" "websocket" |
värde | Innehållsvärde när du importerar ett API. | sträng |
wsdlSelector | Kriterier för att begränsa importen av WSDL till en delmängd av dokumentet. | ApiCreateOrUpdatePropertiesWsdlSelector |
ApiVersionSetContractDetails
Name | Beskrivning | Värde |
---|---|---|
beskrivning | Beskrivning av API-versionsuppsättning. | sträng |
id | Identifierare för befintlig API-versionsuppsättning. Utelämna det här värdet om du vill skapa en ny versionsuppsättning. | sträng |
name | Visningsnamn för API-versionsuppsättningen. | sträng |
versionHeaderName | Namnet på HTTP-huvudparametern som anger API-versionen om versioningScheme har angetts till header . |
sträng |
versioningScheme | Ett värde som avgör var API-versionsidentifieraren ska finnas i en HTTP-begäran. | ”Huvud” "Fråga" "Segment" |
versionQueryName | Namnet på frågeparametern som anger API-versionen om versioningScheme är inställt på query . |
sträng |
AuthenticationSettingsContract
Name | Beskrivning | Värde |
---|---|---|
oAuth2 | Inställningar för OAuth2-autentisering | OAuth2AuthenticationSettingsContract |
oAuth2AuthenticationSettings | Samling OAuth2-autentiseringsinställningar som ingår i det här API:et. | OAuth2AuthenticationSettingsContract[] |
Openid | Inställningar för OpenID Connect-autentisering | OpenIdAuthenticationSettingsContract |
openidAuthenticationSettings | Samling autentiseringsinställningar för Open ID Connect som ingår i det här API:et. | OpenIdAuthenticationSettingsContract[] |
OAuth2AuthenticationSettingsContract
Name | Beskrivning | Värde |
---|---|---|
authorizationServerId | OAuth-auktoriseringsserveridentifierare. | sträng |
omfång | omfång för åtgärder. | sträng |
OpenIdAuthenticationSettingsContract
Name | Beskrivning | Värde |
---|---|---|
bearerTokenSendingMethods | Skicka token till servern. | Strängmatris som innehåller något av: "authorizationHeader" "query" |
openidProviderId | OAuth-auktoriseringsserveridentifierare. | sträng |
ApiContactInformation
Name | Beskrivning | Värde |
---|---|---|
e-post | Kontaktpersonens/organisationens e-postadress. MÅSTE vara i formatet för en e-postadress | sträng |
name | Kontaktpersonens/organisationens identifieringsnamn | sträng |
url | URL:en som pekar på kontaktinformationen. MÅSTE vara i formatet för en URL | sträng |
ApiLicenseInformation
Name | Beskrivning | Värde |
---|---|---|
name | Licensnamnet som används för API:et | sträng |
url | En URL till den licens som används för API:et. MÅSTE vara i formatet för en URL | sträng |
SubscriptionKeyParameterNamesContract
Name | Beskrivning | Värde |
---|---|---|
sidhuvud | Rubriknamn för prenumerationsnyckel. | sträng |
query | Parameternamn för frågesträng för prenumerationsnyckel. | sträng |
ApiCreateOrUpdatePropertiesWsdlSelector
Name | Beskrivning | Värde |
---|---|---|
wsdlEndpointName | Namn på slutpunkt (port) som ska importeras från WSDL | sträng |
wsdlServiceName | Namn på tjänst som ska importeras från WSDL | sträng |