Microsoft.ApiManagement service/apis 2017-03-01
- senaste
- 2024-06-01-preview
- 2024-05-01
- 2023-09-01-preview
- 2023-05-01-preview
- 2023-03-01-preview
- 2022-09-01-preview
- 2022-08-01
- 2022-04-01-preview
- 2021-12-01-preview
- 2021-08-01
- 2021-04-01-preview
- 2021-01-01-preview
- 2020-12-01
- 2020-06-01-preview
- 2019-12-01
- 2019-12-01-preview
- 2019-01-01
- 2018-06-01-preview
- 2018-01-01
- 2017-03-01
- 2016-10-10
- 2016-07-07
Bicep-resursdefinition
Resurstypen tjänst/apis kan distribueras med åtgärder som mål:
- Resursgrupper – Se resursgruppsdistributionskommandon
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@2017-03-01' = {
parent: resourceSymbolicName
name: 'string'
properties: {
apiRevision: 'string'
apiVersion: 'string'
apiVersionSet: {
properties: {
description: 'string'
displayName: 'string'
versionHeaderName: 'string'
versioningScheme: 'string'
versionQueryName: 'string'
}
}
apiVersionSetId: 'string'
authenticationSettings: {
oAuth2: {
authorizationServerId: 'string'
scope: 'string'
}
}
contentFormat: 'string'
contentValue: 'string'
description: 'string'
displayName: 'string'
path: 'string'
protocols: [
'string'
]
serviceUrl: 'string'
subscriptionKeyParameterNames: {
header: 'string'
query: 'string'
}
type: 'string'
wsdlSelector: {
wsdlEndpointName: 'string'
wsdlServiceName: 'string'
}
}
}
Egenskapsvärden
ApiCreateOrUpdatePropertiesOrApiContractProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| apiRevision | Beskriver revisionen av API:et. Om inget värde anges skapas standardrevision 1 | sträng Begränsningar: Min längd = 1 Maximal längd = 1 |
| apiVersion | Anger versionsidentifieraren för API:et om API:et är versionshanterat | sträng Begränsningar: Max längd = |
| apiVersionSet | Kontraktsinformation för API-versionsuppsättning. | ApiVersionSetContract |
| apiVersionSetId | En resursidentifierare för den relaterade ApiVersionSet. | sträng |
| authenticationSettings | Samling autentiseringsinställningar som ingår i det här API:et. | AuthenticationSettingsContract |
| contentFormat | Format för innehållet där API:et importeras. | "swagger-json" "swagger-link-json" "wadl-link-json" "wadl-xml" "wsdl" "wsdl-link" |
| contentValue | Innehållsvärde när du importerar ett API. | sträng |
| beskrivning | Beskrivning av API:et. Kan innehålla HTML-formateringstaggar. | sträng |
| displayName | API-namn. | sträng Begränsningar: Min längd = 1 Maximal längd = 1 |
| stig | Relativ URL som unikt identifierar det här API:et och alla dess resurssökvägar i API Management-tjänstinstansen. 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 Begränsningar: Maximal längd = (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" |
| serviceUrl | Absolut URL för serverdelstjänsten som implementerar det här API:et. | sträng Begränsningar: Min längd = 1 Maximal längd = 1 |
| subscriptionKeyParameterNames | Protokoll som API:et görs tillgängligt för. | SubscriptionKeyParameterNamesContract |
| typ | Typ av API. | "http" "soap" |
| wsdlSelector | Villkor för att begränsa importen av WSDL till en delmängd av dokumentet. | ApiCreateOrUpdatePropertiesWsdlSelector |
ApiCreateOrUpdatePropertiesWsdlSelector
| Namn | 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 |
ApiVersionSetContract
| Namn | Beskrivning | Värde |
|---|---|---|
| Egenskaper | Egenskaper för en API-versionsuppsättning. | ApiVersionSetContractProperties |
ApiVersionSetContractProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| beskrivning | Beskrivning av API-versionsuppsättning. | sträng |
| displayName | Namn på API-versionsuppsättning | sträng Begränsningar: Min längd = 1 Maximal längd = 1 (krävs) |
| versionHeaderName | Namnet på HTTP-huvudparametern som anger API-versionen om versionshanteringScheme är inställt på header. |
sträng Begränsningar: Min längd = 1 Maximal längd = 1 |
| versionshanteringScheme | Ett värde som avgör var API-versionsidentifieraren ska finnas i en HTTP-begäran. | "Rubrik" "Fråga" Segment (krävs) |
| versionQueryName | Namnet på frågeparametern som anger API-versionen om versionshanteringScheme är inställt på query. |
sträng Begränsningar: Min längd = 1 Maximal längd = 1 |
AuthenticationSettingsContract
| Namn | Beskrivning | Värde |
|---|---|---|
| oAuth2 | Autentiseringsinställningar för OAuth2 | OAuth2AuthenticationSettingsContract |
Microsoft.ApiManagement/service/apis
| Namn | Beskrivning | Värde |
|---|---|---|
| Namn | Resursnamnet | sträng Begränsningar: Min längd = 1 Maximal längd = 1 Mönster = ^[^*#&+:<>?]+$ (krävs) |
| förälder | 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 den överordnade resursen. |
Symboliskt namn för resurs av typen: tjänst |
| Egenskaper | Api-entitetsskapande av uppdateringsegenskaper. | ApiCreateOrUpdatePropertiesOrApiContractProperties |
OAuth2AuthenticationSettingsContract
| Namn | Beskrivning | Värde |
|---|---|---|
| authorizationServerId | OAuth-auktoriseringsserveridentifierare. | sträng |
| omfattning | driftsomfång. | sträng |
SubscriptionKeyParameterNamesContract
| Namn | Beskrivning | Värde |
|---|---|---|
| rubrik | Namn på prenumerationsnyckelhuvud. | sträng |
| fråga | Parameternamn för frågesträng för prenumerationsnyckel. | sträng |
Resursdefinition för ARM-mall
Resurstypen tjänst/apis kan distribueras med åtgärder som mål:
- Resursgrupper – Se resursgruppsdistributionskommandon
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": "2017-03-01",
"name": "string",
"properties": {
"apiRevision": "string",
"apiVersion": "string",
"apiVersionSet": {
"properties": {
"description": "string",
"displayName": "string",
"versionHeaderName": "string",
"versioningScheme": "string",
"versionQueryName": "string"
}
},
"apiVersionSetId": "string",
"authenticationSettings": {
"oAuth2": {
"authorizationServerId": "string",
"scope": "string"
}
},
"contentFormat": "string",
"contentValue": "string",
"description": "string",
"displayName": "string",
"path": "string",
"protocols": [ "string" ],
"serviceUrl": "string",
"subscriptionKeyParameterNames": {
"header": "string",
"query": "string"
},
"type": "string",
"wsdlSelector": {
"wsdlEndpointName": "string",
"wsdlServiceName": "string"
}
}
}
Egenskapsvärden
ApiCreateOrUpdatePropertiesOrApiContractProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| apiRevision | Beskriver revisionen av API:et. Om inget värde anges skapas standardrevision 1 | sträng Begränsningar: Min längd = 1 Maximal längd = 1 |
| apiVersion | Anger versionsidentifieraren för API:et om API:et är versionshanterat | sträng Begränsningar: Max längd = |
| apiVersionSet | Kontraktsinformation för API-versionsuppsättning. | ApiVersionSetContract |
| apiVersionSetId | En resursidentifierare för den relaterade ApiVersionSet. | sträng |
| authenticationSettings | Samling autentiseringsinställningar som ingår i det här API:et. | AuthenticationSettingsContract |
| contentFormat | Format för innehållet där API:et importeras. | "swagger-json" "swagger-link-json" "wadl-link-json" "wadl-xml" "wsdl" "wsdl-link" |
| contentValue | Innehållsvärde när du importerar ett API. | sträng |
| beskrivning | Beskrivning av API:et. Kan innehålla HTML-formateringstaggar. | sträng |
| displayName | API-namn. | sträng Begränsningar: Min längd = 1 Maximal längd = 1 |
| stig | Relativ URL som unikt identifierar det här API:et och alla dess resurssökvägar i API Management-tjänstinstansen. 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 Begränsningar: Maximal längd = (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" |
| serviceUrl | Absolut URL för serverdelstjänsten som implementerar det här API:et. | sträng Begränsningar: Min längd = 1 Maximal längd = 1 |
| subscriptionKeyParameterNames | Protokoll som API:et görs tillgängligt för. | SubscriptionKeyParameterNamesContract |
| typ | Typ av API. | "http" "soap" |
| wsdlSelector | Villkor för att begränsa importen av WSDL till en delmängd av dokumentet. | ApiCreateOrUpdatePropertiesWsdlSelector |
ApiCreateOrUpdatePropertiesWsdlSelector
| Namn | 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 |
ApiVersionSetContract
| Namn | Beskrivning | Värde |
|---|---|---|
| Egenskaper | Egenskaper för en API-versionsuppsättning. | ApiVersionSetContractProperties |
ApiVersionSetContractProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| beskrivning | Beskrivning av API-versionsuppsättning. | sträng |
| displayName | Namn på API-versionsuppsättning | sträng Begränsningar: Min längd = 1 Maximal längd = 1 (krävs) |
| versionHeaderName | Namnet på HTTP-huvudparametern som anger API-versionen om versionshanteringScheme är inställt på header. |
sträng Begränsningar: Min längd = 1 Maximal längd = 1 |
| versionshanteringScheme | Ett värde som avgör var API-versionsidentifieraren ska finnas i en HTTP-begäran. | "Rubrik" "Fråga" Segment (krävs) |
| versionQueryName | Namnet på frågeparametern som anger API-versionen om versionshanteringScheme är inställt på query. |
sträng Begränsningar: Min längd = 1 Maximal längd = 1 |
AuthenticationSettingsContract
| Namn | Beskrivning | Värde |
|---|---|---|
| oAuth2 | Autentiseringsinställningar för OAuth2 | OAuth2AuthenticationSettingsContract |
Microsoft.ApiManagement/service/apis
| Namn | Beskrivning | Värde |
|---|---|---|
| apiVersion | API-versionen | '2017-03-01' |
| Namn | Resursnamnet | sträng Begränsningar: Min längd = 1 Maximal längd = 1 Mönster = ^[^*#&+:<>?]+$ (krävs) |
| Egenskaper | Api-entitetsskapande av uppdateringsegenskaper. | ApiCreateOrUpdatePropertiesOrApiContractProperties |
| typ | Resurstypen | "Microsoft.ApiManagement/service/apis" |
OAuth2AuthenticationSettingsContract
| Namn | Beskrivning | Värde |
|---|---|---|
| authorizationServerId | OAuth-auktoriseringsserveridentifierare. | sträng |
| omfattning | driftsomfång. | sträng |
SubscriptionKeyParameterNamesContract
| Namn | Beskrivning | Värde |
|---|---|---|
| rubrik | Namn på prenumerationsnyckelhuvud. | sträng |
| fråga | Parameternamn för frågesträng för prenumerationsnyckel. | sträng |
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@2017-03-01"
name = "string"
body = jsonencode({
properties = {
apiRevision = "string"
apiVersion = "string"
apiVersionSet = {
properties = {
description = "string"
displayName = "string"
versionHeaderName = "string"
versioningScheme = "string"
versionQueryName = "string"
}
}
apiVersionSetId = "string"
authenticationSettings = {
oAuth2 = {
authorizationServerId = "string"
scope = "string"
}
}
contentFormat = "string"
contentValue = "string"
description = "string"
displayName = "string"
path = "string"
protocols = [
"string"
]
serviceUrl = "string"
subscriptionKeyParameterNames = {
header = "string"
query = "string"
}
type = "string"
wsdlSelector = {
wsdlEndpointName = "string"
wsdlServiceName = "string"
}
}
})
}
Egenskapsvärden
ApiCreateOrUpdatePropertiesOrApiContractProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| apiRevision | Beskriver revisionen av API:et. Om inget värde anges skapas standardrevision 1 | sträng Begränsningar: Min längd = 1 Maximal längd = 1 |
| apiVersion | Anger versionsidentifieraren för API:et om API:et är versionshanterat | sträng Begränsningar: Max längd = |
| apiVersionSet | Kontraktsinformation för API-versionsuppsättning. | ApiVersionSetContract |
| apiVersionSetId | En resursidentifierare för den relaterade ApiVersionSet. | sträng |
| authenticationSettings | Samling autentiseringsinställningar som ingår i det här API:et. | AuthenticationSettingsContract |
| contentFormat | Format för innehållet där API:et importeras. | "swagger-json" "swagger-link-json" "wadl-link-json" "wadl-xml" "wsdl" "wsdl-link" |
| contentValue | Innehållsvärde när du importerar ett API. | sträng |
| beskrivning | Beskrivning av API:et. Kan innehålla HTML-formateringstaggar. | sträng |
| displayName | API-namn. | sträng Begränsningar: Min längd = 1 Maximal längd = 1 |
| stig | Relativ URL som unikt identifierar det här API:et och alla dess resurssökvägar i API Management-tjänstinstansen. 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 Begränsningar: Maximal längd = (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" |
| serviceUrl | Absolut URL för serverdelstjänsten som implementerar det här API:et. | sträng Begränsningar: Min längd = 1 Maximal längd = 1 |
| subscriptionKeyParameterNames | Protokoll som API:et görs tillgängligt för. | SubscriptionKeyParameterNamesContract |
| typ | Typ av API. | "http" "soap" |
| wsdlSelector | Villkor för att begränsa importen av WSDL till en delmängd av dokumentet. | ApiCreateOrUpdatePropertiesWsdlSelector |
ApiCreateOrUpdatePropertiesWsdlSelector
| Namn | 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 |
ApiVersionSetContract
| Namn | Beskrivning | Värde |
|---|---|---|
| Egenskaper | Egenskaper för en API-versionsuppsättning. | ApiVersionSetContractProperties |
ApiVersionSetContractProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| beskrivning | Beskrivning av API-versionsuppsättning. | sträng |
| displayName | Namn på API-versionsuppsättning | sträng Begränsningar: Min längd = 1 Maximal längd = 1 (krävs) |
| versionHeaderName | Namnet på HTTP-huvudparametern som anger API-versionen om versionshanteringScheme är inställt på header. |
sträng Begränsningar: Min längd = 1 Maximal längd = 1 |
| versionshanteringScheme | Ett värde som avgör var API-versionsidentifieraren ska finnas i en HTTP-begäran. | "Rubrik" "Fråga" Segment (krävs) |
| versionQueryName | Namnet på frågeparametern som anger API-versionen om versionshanteringScheme är inställt på query. |
sträng Begränsningar: Min längd = 1 Maximal längd = 1 |
AuthenticationSettingsContract
| Namn | Beskrivning | Värde |
|---|---|---|
| oAuth2 | Autentiseringsinställningar för OAuth2 | OAuth2AuthenticationSettingsContract |
Microsoft.ApiManagement/service/apis
| Namn | Beskrivning | Värde |
|---|---|---|
| Namn | Resursnamnet | sträng Begränsningar: Min längd = 1 Maximal längd = 1 Mönster = ^[^*#&+:<>?]+$ (krävs) |
| parent_id | ID för resursen som är överordnad för den här resursen. | ID för resurs av typen: tjänst |
| Egenskaper | Api-entitetsskapande av uppdateringsegenskaper. | ApiCreateOrUpdatePropertiesOrApiContractProperties |
| typ | Resurstypen | "Microsoft.ApiManagement/service/apis@2017-03-01" |
OAuth2AuthenticationSettingsContract
| Namn | Beskrivning | Värde |
|---|---|---|
| authorizationServerId | OAuth-auktoriseringsserveridentifierare. | sträng |
| omfattning | driftsomfång. | sträng |
SubscriptionKeyParameterNamesContract
| Namn | Beskrivning | Värde |
|---|---|---|
| rubrik | Namn på prenumerationsnyckelhuvud. | sträng |
| fråga | Parameternamn för frågesträng för prenumerationsnyckel. | sträng |