Microsoft.ApiManagement-service/apis 2017-03-01
- meest recente
- 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-resourcedefinitie
Het resourcetype service/API's kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- Resourcegroepen - Zie opdrachten voor de implementatie van resourcegroepen
Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een Resource microsoft.ApiManagement/service/apis wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.
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'
}
}
}
Eigenschapswaarden
ApiCreateOrUpdatePropertiesOrApiContractProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| apiRevision | Beschrijft de revisie van de API. Als er geen waarde is opgegeven, wordt standaardrevisie 1 gemaakt | snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 100 |
| apiVersion | Geeft de versie-id van de API aan als de API is geversied | snaar Beperkingen: Maximale lengte = 100 |
| apiVersionSet | Contractgegevens van api-versieset. | ApiVersionSetContract- |
| apiVersionSetId | Een resource-id voor de gerelateerde ApiVersionSet. | snaar |
| authenticationSettings | Verzameling van verificatie-instellingen die zijn opgenomen in deze API. | AuthenticationSettingsContract |
| contentFormat | Indeling van de inhoud waarin de API wordt geïmporteerd. | 'swagger-json' 'swagger-link-json' 'wadl-link-json' 'wadl-xml' 'wsdl' 'wsdl-link' |
| contentValue | Inhoudswaarde bij het importeren van een API. | snaar |
| beschrijving | Beschrijving van de API. Kan HTML-opmaaktags bevatten. | snaar |
| displayName | API-naam. | snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 300 |
| pad | Relatieve URL die deze API en alle bijbehorende resourcepaden uniek identificeert binnen het API Management-service-exemplaar. Deze wordt toegevoegd aan de basis-URL van het API-eindpunt die is opgegeven tijdens het maken van het service-exemplaar om een openbare URL voor deze API te vormen. | snaar Beperkingen: Maximale lengte = 400 (vereist) |
| Protocollen | Beschrijft op welke protocollen de bewerkingen in deze API kunnen worden aangeroepen. | Tekenreeksmatrix met een van de volgende waarden: 'http' 'https' |
| serviceUrl | Absolute URL van de back-endservice die deze API implementeert. | snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 2000 |
| subscriptionKeyParameterNames | Protocollen over welke API beschikbaar wordt gemaakt. | SubscriptionKeyParameterNamesContract |
| type | Type of API. | 'http' 'zeep' |
| wsdlSelector | Criteria om het importeren van WSDL te beperken tot een subset van het document. | ApiCreateOrUpdatePropertiesWsdlSelector |
ApiCreateOrUpdatePropertiesWsdlSelector
| Naam | Beschrijving | Waarde |
|---|---|---|
| wsdlEndpointName | Naam van eindpunt (poort) om te importeren uit WSDL | snaar |
| wsdlServiceName | De servicenaam die moet worden geïmporteerd uit WSDL | snaar |
ApiVersionSetContract
| Naam | Beschrijving | Waarde |
|---|---|---|
| Eigenschappen | Eigenschappen van een API-versieset. | ApiVersionSetContractProperties- |
ApiVersionSetContractProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| beschrijving | Beschrijving van API-versieset. | snaar |
| displayName | Naam van API-versieset | snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 100 (vereist) |
| versionHeaderName | Naam van de HTTP-headerparameter die de API-versie aangeeft als versioningScheme is ingesteld op header. |
snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 100 |
| versioningScheme | Een waarde die bepaalt waar de API-versie-id zich in een HTTP-aanvraag bevindt. | Koptekst 'Query' Segment (vereist) |
| versionQueryName | De naam van de queryparameter die de API-versie aangeeft als versioningScheme is ingesteld op query. |
snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 100 |
AuthenticationSettingsContract
| Naam | Beschrijving | Waarde |
|---|---|---|
| oAuth2 | OAuth2-verificatie-instellingen | OAuth2AuthenticationSettingsContract |
Microsoft.ApiManagement/service/apis
| Naam | Beschrijving | Waarde |
|---|---|---|
| naam | De resourcenaam | snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 256 Patroon = ^[^*#&+:<>?]+$ (vereist) |
| ouder | In Bicep kunt u de bovenliggende resource voor een onderliggende resource opgeven. U hoeft deze eigenschap alleen toe te voegen wanneer de onderliggende resource buiten de bovenliggende resource wordt gedeclareerd. Zie onderliggende resource buiten de bovenliggende resourcevoor meer informatie. |
Symbolische naam voor resource van het type: service |
| Eigenschappen | Api-entiteit maken van update-eigenschappen. | ApiCreateOrUpdatePropertiesOrApiContractProperties |
OAuth2AuthenticationSettingsContract
| Naam | Beschrijving | Waarde |
|---|---|---|
| authorizationServerId | OAuth-autorisatieserver-id. | snaar |
| draagwijdte | bewerkingsbereik. | snaar |
SubscriptionKeyParameterNamesContract
| Naam | Beschrijving | Waarde |
|---|---|---|
| rubriek | Naam van abonnementssleutelheader. | snaar |
| vraag | Naam van queryreeksparameter voor abonnementssleutel. | snaar |
Resourcedefinitie van ARM-sjabloon
Het resourcetype service/API's kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- Resourcegroepen - Zie opdrachten voor de implementatie van resourcegroepen
Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een Microsoft.ApiManagement/service/apis-resource wilt maken, voegt u de volgende JSON toe aan uw sjabloon.
{
"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"
}
}
}
Eigenschapswaarden
ApiCreateOrUpdatePropertiesOrApiContractProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| apiRevision | Beschrijft de revisie van de API. Als er geen waarde is opgegeven, wordt standaardrevisie 1 gemaakt | snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 100 |
| apiVersion | Geeft de versie-id van de API aan als de API is geversied | snaar Beperkingen: Maximale lengte = 100 |
| apiVersionSet | Contractgegevens van api-versieset. | ApiVersionSetContract- |
| apiVersionSetId | Een resource-id voor de gerelateerde ApiVersionSet. | snaar |
| authenticationSettings | Verzameling van verificatie-instellingen die zijn opgenomen in deze API. | AuthenticationSettingsContract |
| contentFormat | Indeling van de inhoud waarin de API wordt geïmporteerd. | 'swagger-json' 'swagger-link-json' 'wadl-link-json' 'wadl-xml' 'wsdl' 'wsdl-link' |
| contentValue | Inhoudswaarde bij het importeren van een API. | snaar |
| beschrijving | Beschrijving van de API. Kan HTML-opmaaktags bevatten. | snaar |
| displayName | API-naam. | snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 300 |
| pad | Relatieve URL die deze API en alle bijbehorende resourcepaden uniek identificeert binnen het API Management-service-exemplaar. Deze wordt toegevoegd aan de basis-URL van het API-eindpunt die is opgegeven tijdens het maken van het service-exemplaar om een openbare URL voor deze API te vormen. | snaar Beperkingen: Maximale lengte = 400 (vereist) |
| Protocollen | Beschrijft op welke protocollen de bewerkingen in deze API kunnen worden aangeroepen. | Tekenreeksmatrix met een van de volgende waarden: 'http' 'https' |
| serviceUrl | Absolute URL van de back-endservice die deze API implementeert. | snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 2000 |
| subscriptionKeyParameterNames | Protocollen over welke API beschikbaar wordt gemaakt. | SubscriptionKeyParameterNamesContract |
| type | Type of API. | 'http' 'zeep' |
| wsdlSelector | Criteria om het importeren van WSDL te beperken tot een subset van het document. | ApiCreateOrUpdatePropertiesWsdlSelector |
ApiCreateOrUpdatePropertiesWsdlSelector
| Naam | Beschrijving | Waarde |
|---|---|---|
| wsdlEndpointName | Naam van eindpunt (poort) om te importeren uit WSDL | snaar |
| wsdlServiceName | De servicenaam die moet worden geïmporteerd uit WSDL | snaar |
ApiVersionSetContract
| Naam | Beschrijving | Waarde |
|---|---|---|
| Eigenschappen | Eigenschappen van een API-versieset. | ApiVersionSetContractProperties- |
ApiVersionSetContractProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| beschrijving | Beschrijving van API-versieset. | snaar |
| displayName | Naam van API-versieset | snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 100 (vereist) |
| versionHeaderName | Naam van de HTTP-headerparameter die de API-versie aangeeft als versioningScheme is ingesteld op header. |
snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 100 |
| versioningScheme | Een waarde die bepaalt waar de API-versie-id zich in een HTTP-aanvraag bevindt. | Koptekst 'Query' Segment (vereist) |
| versionQueryName | De naam van de queryparameter die de API-versie aangeeft als versioningScheme is ingesteld op query. |
snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 100 |
AuthenticationSettingsContract
| Naam | Beschrijving | Waarde |
|---|---|---|
| oAuth2 | OAuth2-verificatie-instellingen | OAuth2AuthenticationSettingsContract |
Microsoft.ApiManagement/service/apis
| Naam | Beschrijving | Waarde |
|---|---|---|
| apiVersion | De API-versie | '2017-03-01' |
| naam | De resourcenaam | snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 256 Patroon = ^[^*#&+:<>?]+$ (vereist) |
| Eigenschappen | Api-entiteit maken van update-eigenschappen. | ApiCreateOrUpdatePropertiesOrApiContractProperties |
| type | Het resourcetype | 'Microsoft.ApiManagement/service/apis' |
OAuth2AuthenticationSettingsContract
| Naam | Beschrijving | Waarde |
|---|---|---|
| authorizationServerId | OAuth-autorisatieserver-id. | snaar |
| draagwijdte | bewerkingsbereik. | snaar |
SubscriptionKeyParameterNamesContract
| Naam | Beschrijving | Waarde |
|---|---|---|
| rubriek | Naam van abonnementssleutelheader. | snaar |
| vraag | Naam van queryreeksparameter voor abonnementssleutel. | snaar |
Resourcedefinitie van Terraform (AzAPI-provider)
Het resourcetype service/API's kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- resourcegroepen
Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een Microsoft.ApiManagement/service/apis-resource wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.
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"
}
}
})
}
Eigenschapswaarden
ApiCreateOrUpdatePropertiesOrApiContractProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| apiRevision | Beschrijft de revisie van de API. Als er geen waarde is opgegeven, wordt standaardrevisie 1 gemaakt | snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 100 |
| apiVersion | Geeft de versie-id van de API aan als de API is geversied | snaar Beperkingen: Maximale lengte = 100 |
| apiVersionSet | Contractgegevens van api-versieset. | ApiVersionSetContract- |
| apiVersionSetId | Een resource-id voor de gerelateerde ApiVersionSet. | snaar |
| authenticationSettings | Verzameling van verificatie-instellingen die zijn opgenomen in deze API. | AuthenticationSettingsContract |
| contentFormat | Indeling van de inhoud waarin de API wordt geïmporteerd. | 'swagger-json' 'swagger-link-json' 'wadl-link-json' 'wadl-xml' 'wsdl' 'wsdl-link' |
| contentValue | Inhoudswaarde bij het importeren van een API. | snaar |
| beschrijving | Beschrijving van de API. Kan HTML-opmaaktags bevatten. | snaar |
| displayName | API-naam. | snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 300 |
| pad | Relatieve URL die deze API en alle bijbehorende resourcepaden uniek identificeert binnen het API Management-service-exemplaar. Deze wordt toegevoegd aan de basis-URL van het API-eindpunt die is opgegeven tijdens het maken van het service-exemplaar om een openbare URL voor deze API te vormen. | snaar Beperkingen: Maximale lengte = 400 (vereist) |
| Protocollen | Beschrijft op welke protocollen de bewerkingen in deze API kunnen worden aangeroepen. | Tekenreeksmatrix met een van de volgende waarden: 'http' 'https' |
| serviceUrl | Absolute URL van de back-endservice die deze API implementeert. | snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 2000 |
| subscriptionKeyParameterNames | Protocollen over welke API beschikbaar wordt gemaakt. | SubscriptionKeyParameterNamesContract |
| type | Type of API. | 'http' 'zeep' |
| wsdlSelector | Criteria om het importeren van WSDL te beperken tot een subset van het document. | ApiCreateOrUpdatePropertiesWsdlSelector |
ApiCreateOrUpdatePropertiesWsdlSelector
| Naam | Beschrijving | Waarde |
|---|---|---|
| wsdlEndpointName | Naam van eindpunt (poort) om te importeren uit WSDL | snaar |
| wsdlServiceName | De servicenaam die moet worden geïmporteerd uit WSDL | snaar |
ApiVersionSetContract
| Naam | Beschrijving | Waarde |
|---|---|---|
| Eigenschappen | Eigenschappen van een API-versieset. | ApiVersionSetContractProperties- |
ApiVersionSetContractProperties
| Naam | Beschrijving | Waarde |
|---|---|---|
| beschrijving | Beschrijving van API-versieset. | snaar |
| displayName | Naam van API-versieset | snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 100 (vereist) |
| versionHeaderName | Naam van de HTTP-headerparameter die de API-versie aangeeft als versioningScheme is ingesteld op header. |
snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 100 |
| versioningScheme | Een waarde die bepaalt waar de API-versie-id zich in een HTTP-aanvraag bevindt. | Koptekst 'Query' Segment (vereist) |
| versionQueryName | De naam van de queryparameter die de API-versie aangeeft als versioningScheme is ingesteld op query. |
snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 100 |
AuthenticationSettingsContract
| Naam | Beschrijving | Waarde |
|---|---|---|
| oAuth2 | OAuth2-verificatie-instellingen | OAuth2AuthenticationSettingsContract |
Microsoft.ApiManagement/service/apis
| Naam | Beschrijving | Waarde |
|---|---|---|
| naam | De resourcenaam | snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 256 Patroon = ^[^*#&+:<>?]+$ (vereist) |
| parent_id | De id van de resource die het bovenliggende item voor deze resource is. | Id voor resource van het type: service- |
| Eigenschappen | Api-entiteit maken van update-eigenschappen. | ApiCreateOrUpdatePropertiesOrApiContractProperties |
| type | Het resourcetype | "Microsoft.ApiManagement/service/apis@2017-03-01" |
OAuth2AuthenticationSettingsContract
| Naam | Beschrijving | Waarde |
|---|---|---|
| authorizationServerId | OAuth-autorisatieserver-id. | snaar |
| draagwijdte | bewerkingsbereik. | snaar |
SubscriptionKeyParameterNamesContract
| Naam | Beschrijving | Waarde |
|---|---|---|
| rubriek | Naam van abonnementssleutelheader. | snaar |
| vraag | Naam van queryreeksparameter voor abonnementssleutel. | snaar |