Delen via

Microsoft.ApiManagement-service/apis 2016-07-07

  • Artikel

Bicep-resourcedefinitie

Het resourcetype service/API's kan worden geïmplementeerd met bewerkingen die zijn gericht op:

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@2016-07-07' = {
  parent: resourceSymbolicName
  authenticationSettings: {
    oAuth2: {
      authorizationServerId: 'string'
      scope: 'string'
    }
  }
  description: 'string'
  name: 'string'
  path: 'string'
  protocols: [
    'string'
  ]
  serviceUrl: 'string'
  subscriptionKeyParameterNames: {
    header: 'string'
    query: 'string'
  }
}

Eigenschapswaarden

AuthenticationSettingsContract

Naam Beschrijving Waarde
oAuth2 Details van verificatie-instellingen voor API OAuth2. OAuth2AuthenticationSettingsContract

Microsoft.ApiManagement/service/apis

Naam Beschrijving Waarde
authenticationSettings Verzameling van verificatie-instellingen die zijn opgenomen in deze API. AuthenticationSettingsContract
beschrijving Beschrijving van de API. Kan HTML-opmaaktags bevatten. snaar
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
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 (vereist)
serviceUrl Absolute URL van de back-endservice die deze API implementeert. snaar

Beperkingen:
Minimale lengte = 1
Maximale lengte = 2000 (vereist)
subscriptionKeyParameterNames Protocollen over welke API beschikbaar wordt gemaakt. SubscriptionKeyParameterNamesContract

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:

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": "2016-07-07",
  "name": "string",
  "authenticationSettings": {
    "oAuth2": {
      "authorizationServerId": "string",
      "scope": "string"
    }
  },
  "description": "string",
  "path": "string",
  "protocols": [ "string" ],
  "serviceUrl": "string",
  "subscriptionKeyParameterNames": {
    "header": "string",
    "query": "string"
  }
}

Eigenschapswaarden

AuthenticationSettingsContract

Naam Beschrijving Waarde
oAuth2 Details van verificatie-instellingen voor API OAuth2. OAuth2AuthenticationSettingsContract

Microsoft.ApiManagement/service/apis

Naam Beschrijving Waarde
apiVersion De API-versie '2016-07-07'
authenticationSettings Verzameling van verificatie-instellingen die zijn opgenomen in deze API. AuthenticationSettingsContract
beschrijving Beschrijving van de API. Kan HTML-opmaaktags bevatten. snaar
naam De resourcenaam snaar

Beperkingen:
Minimale lengte = 1
Maximale lengte = 256
Patroon = ^[^*#&+:<>?]+$ (vereist)
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 (vereist)
serviceUrl Absolute URL van de back-endservice die deze API implementeert. snaar

Beperkingen:
Minimale lengte = 1
Maximale lengte = 2000 (vereist)
subscriptionKeyParameterNames Protocollen over welke API beschikbaar wordt gemaakt. SubscriptionKeyParameterNamesContract
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

Gebruiksvoorbeelden

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@2016-07-07"
  name = "string"
  authenticationSettings = {
    oAuth2 = {
      authorizationServerId = "string"
      scope = "string"
    }
  }
  description = "string"
  path = "string"
  protocols = [
    "string"
  ]
  serviceUrl = "string"
  subscriptionKeyParameterNames = {
    header = "string"
    query = "string"
  }
}

Eigenschapswaarden

AuthenticationSettingsContract

Naam Beschrijving Waarde
oAuth2 Details van verificatie-instellingen voor API OAuth2. OAuth2AuthenticationSettingsContract

Microsoft.ApiManagement/service/apis

Naam Beschrijving Waarde
authenticationSettings Verzameling van verificatie-instellingen die zijn opgenomen in deze API. AuthenticationSettingsContract
beschrijving Beschrijving van de API. Kan HTML-opmaaktags bevatten. snaar
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-
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 (vereist)
serviceUrl Absolute URL van de back-endservice die deze API implementeert. snaar

Beperkingen:
Minimale lengte = 1
Maximale lengte = 2000 (vereist)
subscriptionKeyParameterNames Protocollen over welke API beschikbaar wordt gemaakt. SubscriptionKeyParameterNamesContract
type Het resourcetype "Microsoft.ApiManagement/service/apis@2016-07-07"

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