Microsoft.ApiManagement-service/api's

Artikel
07/24/2024

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@2023-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'
    }
  }
}

Eigenschapswaarden

service/api's

Naam	Beschrijving	Waarde
naam	De resourcenaam Zie hoe u namen en typen instelt voor onderliggende resources in Bicep-.	tekenreeks (vereist) Tekenlimiet: 1-80 Geldige tekens: Alfanumerieke en afbreekstreepjes. Begin met letter en eindig met alfanumeriek.
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

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
apiRevisionDescription	Beschrijving van de API-revisie.	snaar Beperkingen: Maximale lengte = 256
apiType	Type API dat moet worden gemaakt. * `http` maakt een REST API * `soap` maakt een SOAP Pass Through-API * `websocket` websocket-API maakt * `graphql` maakt GraphQL-API. Nieuwe typen kunnen in de toekomst worden toegevoegd.	'graphql' 'grpc' '`http`' 'odata' 'zeep' 'websocket'
apiVersion	Geeft de versie-id van de API aan als de API is geversied	snaar Beperkingen: Maximale lengte = 100
apiVersionDescription	Beschrijving van de API-versie.	snaar Beperkingen: Maximale lengte = 256
apiVersionSet	Details van versieset	ApiVersionSetContractDetails-
apiVersionSetId	Een resource-id voor de gerelateerde ApiVersionSet.	snaar
authenticationSettings	Verzameling van verificatie-instellingen die zijn opgenomen in deze API.	AuthenticationSettingsContract
contact	Contactgegevens voor de API.	ApiContactInformation-
beschrijving	Beschrijving van de API. Kan HTML-opmaaktags bevatten.	snaar
displayName	API-naam. Moet 1 tot 300 tekens lang zijn.	snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 300
formatteren	Indeling van de inhoud waarin de API wordt geïmporteerd. Nieuwe indelingen kunnen in de toekomst worden toegevoegd	'graphql-link' 'grpc' 'grpc-link' 'odata' 'odata-link' 'openapi' 'openapi+json' 'openapi+json-link' 'openapi-link' 'swagger-json' 'swagger-link-json' 'wadl-link-json' 'wadl-xml' 'wsdl' 'wsdl-link'
isCurrent	Geeft aan of API-revisie de huidige API-revisie is.	Bool
licentie	Licentiegegevens voor de API.	ApiLicenseInformation-
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.	tekenreeks (vereist) Beperkingen: Maximale lengte = 400
Protocollen	Beschrijft op welke protocollen de bewerkingen in deze API kunnen worden aangeroepen.	Tekenreeksmatrix met een van de volgende waarden: '`http`' '`https`' 'ws' 'wss'
serviceUrl	Absolute URL van de back-endservice die deze API implementeert. Mag niet langer zijn dan 2000 tekens.	snaar Beperkingen: Maximale lengte = 2000
sourceApiId	API-id van de bron-API.	snaar
subscriptionKeyParameterNames	Protocollen over welke API beschikbaar wordt gemaakt.	SubscriptionKeyParameterNamesContract
subscriptionRequired	Hiermee geeft u op of een API- of productabonnement vereist is voor toegang tot de API.	Bool
termsOfServiceUrl	Een URL naar de servicevoorwaarden voor de API. MOET de indeling van een URL hebben.	snaar
translateRequiredQueryParameters	Strategie voor het vertalen van vereiste queryparameters naar sjabloonparameters. Standaard heeft de waarde 'sjabloon'. Mogelijke waarden: 'template', 'query'	'query' 'sjabloon'
type	Type of API.	'graphql' 'grpc' '`http`' 'odata' 'zeep' 'websocket'
waarde	Inhoudswaarde bij het importeren van een API.	snaar
wsdlSelector	Criteria om het importeren van WSDL te beperken tot een subset van het document.	ApiCreateOrUpdatePropertiesWsdlSelector

ApiVersionSetContractDetails

Naam	Beschrijving	Waarde
beschrijving	Beschrijving van API-versieset.	snaar
legitimatiebewijs	Id voor bestaande API-versieset. Laat deze waarde weg om een nieuwe versieset te maken.	snaar
naam	De weergavenaam van de API-versieset.	snaar
versionHeaderName	Naam van de HTTP-headerparameter die de API-versie aangeeft als versioningScheme is ingesteld op `header`.	snaar
versioningScheme	Een waarde die bepaalt waar de API-versie-id zich in een HTTP-aanvraag bevindt.	Koptekst 'Query' 'Segment'
versionQueryName	De naam van de queryparameter die de API-versie aangeeft als versioningScheme is ingesteld op `query`.	snaar

AuthenticationSettingsContract

Naam	Beschrijving	Waarde
oAuth2	OAuth2-verificatie-instellingen	OAuth2AuthenticationSettingsContract
oAuth2AuthenticationSettings	Verzameling OAuth2-verificatie-instellingen die zijn opgenomen in deze API.	OAuth2AuthenticationSettingsContract[]
openid	OpenID Connect-verificatie-instellingen	OpenIdAuthenticationSettingsContract
openidAuthenticationSettings	Verzameling open ID Connect-verificatie-instellingen die zijn opgenomen in deze API.	OpenIdAuthenticationSettingsContract[]

OAuth2AuthenticationSettingsContract

Naam	Beschrijving	Waarde
authorizationServerId	OAuth-autorisatieserver-id.	snaar
draagwijdte	bewerkingsbereik.	snaar

OpenIdAuthenticationSettingsContract

Naam	Beschrijving	Waarde
bearerTokenSendingMethods	Token naar de server verzenden.	Tekenreeksmatrix met een van de volgende waarden: 'authorizationHeader' 'query'
openidProviderId	OAuth-autorisatieserver-id.	snaar

ApiContactInformation

Naam	Beschrijving	Waarde
E-mail	Het e-mailadres van de contactpersoon/organisatie. MOET de indeling van een e-mailadres hebben	snaar
naam	De identificatienaam van de contactpersoon/organisatie	snaar
URL	De URL die verwijst naar de contactgegevens. MOET de indeling van een URL hebben	snaar

ApiLicenseInformation

Naam	Beschrijving	Waarde
naam	De licentienaam die wordt gebruikt voor de API	snaar
URL	Een URL naar de licentie die wordt gebruikt voor de API. MOET de indeling van een URL hebben	snaar

SubscriptionKeyParameterNamesContract

Naam	Beschrijving	Waarde
rubriek	Naam van abonnementssleutelheader.	snaar
vraag	Naam van queryreeksparameter voor abonnementssleutel.	snaar

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

Quickstart-sjablonen

Met de volgende quickstart-sjablonen wordt dit resourcetype geïmplementeerd.

Sjabloon	Beschrijving
Een API Management-exemplaar en alle subbronnen maken met behulp van sjabloon-	Deze sjabloon laat zien hoe u een API Management-service maakt en subentiteiten configureert
Azure Front Door maken vóór Azure API Management	In dit voorbeeld ziet u hoe u Azure Front Door gebruikt als een globale load balancer voor Azure API Management.

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": "2023-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"
    }
  }
}

Eigenschapswaarden

service/api's

Naam	Beschrijving	Waarde
type	Het resourcetype	'Microsoft.ApiManagement/service/apis'
apiVersion	De versie van de resource-API	'2023-09-01-preview'
naam	De resourcenaam Zie hoe u namen en typen instelt voor onderliggende resources in JSON ARM-sjablonen.	tekenreeks (vereist) Tekenlimiet: 1-80 Geldige tekens: Alfanumerieke en afbreekstreepjes. Begin met letter en eindig met alfanumeriek.
Eigenschappen	API-entiteit maken van update-eigenschappen.	ApiCreateOrUpdatePropertiesOrApiContractProperties

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
apiRevisionDescription	Beschrijving van de API-revisie.	snaar Beperkingen: Maximale lengte = 256
apiType	Type API dat moet worden gemaakt. * `http` maakt een REST API * `soap` maakt een SOAP Pass Through-API * `websocket` websocket-API maakt * `graphql` maakt GraphQL-API. Nieuwe typen kunnen in de toekomst worden toegevoegd.	'graphql' 'grpc' '`http`' 'odata' 'zeep' 'websocket'
apiVersion	Geeft de versie-id van de API aan als de API is geversied	snaar Beperkingen: Maximale lengte = 100
apiVersionDescription	Beschrijving van de API-versie.	snaar Beperkingen: Maximale lengte = 256
apiVersionSet	Details van versieset	ApiVersionSetContractDetails-
apiVersionSetId	Een resource-id voor de gerelateerde ApiVersionSet.	snaar
authenticationSettings	Verzameling van verificatie-instellingen die zijn opgenomen in deze API.	AuthenticationSettingsContract
contact	Contactgegevens voor de API.	ApiContactInformation-
beschrijving	Beschrijving van de API. Kan HTML-opmaaktags bevatten.	snaar
displayName	API-naam. Moet 1 tot 300 tekens lang zijn.	snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 300
formatteren	Indeling van de inhoud waarin de API wordt geïmporteerd. Nieuwe indelingen kunnen in de toekomst worden toegevoegd	'graphql-link' 'grpc' 'grpc-link' 'odata' 'odata-link' 'openapi' 'openapi+json' 'openapi+json-link' 'openapi-link' 'swagger-json' 'swagger-link-json' 'wadl-link-json' 'wadl-xml' 'wsdl' 'wsdl-link'
isCurrent	Geeft aan of API-revisie de huidige API-revisie is.	Bool
licentie	Licentiegegevens voor de API.	ApiLicenseInformation-
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.	tekenreeks (vereist) Beperkingen: Maximale lengte = 400
Protocollen	Beschrijft op welke protocollen de bewerkingen in deze API kunnen worden aangeroepen.	Tekenreeksmatrix met een van de volgende waarden: '`http`' '`https`' 'ws' 'wss'
serviceUrl	Absolute URL van de back-endservice die deze API implementeert. Mag niet langer zijn dan 2000 tekens.	snaar Beperkingen: Maximale lengte = 2000
sourceApiId	API-id van de bron-API.	snaar
subscriptionKeyParameterNames	Protocollen over welke API beschikbaar wordt gemaakt.	SubscriptionKeyParameterNamesContract
subscriptionRequired	Hiermee geeft u op of een API- of productabonnement vereist is voor toegang tot de API.	Bool
termsOfServiceUrl	Een URL naar de servicevoorwaarden voor de API. MOET de indeling van een URL hebben.	snaar
translateRequiredQueryParameters	Strategie voor het vertalen van vereiste queryparameters naar sjabloonparameters. Standaard heeft de waarde 'sjabloon'. Mogelijke waarden: 'template', 'query'	'query' 'sjabloon'
type	Type of API.	'graphql' 'grpc' '`http`' 'odata' 'zeep' 'websocket'
waarde	Inhoudswaarde bij het importeren van een API.	snaar
wsdlSelector	Criteria om het importeren van WSDL te beperken tot een subset van het document.	ApiCreateOrUpdatePropertiesWsdlSelector

ApiVersionSetContractDetails

Naam	Beschrijving	Waarde
beschrijving	Beschrijving van API-versieset.	snaar
legitimatiebewijs	Id voor bestaande API-versieset. Laat deze waarde weg om een nieuwe versieset te maken.	snaar
naam	De weergavenaam van de API-versieset.	snaar
versionHeaderName	Naam van de HTTP-headerparameter die de API-versie aangeeft als versioningScheme is ingesteld op `header`.	snaar
versioningScheme	Een waarde die bepaalt waar de API-versie-id zich in een HTTP-aanvraag bevindt.	Koptekst 'Query' 'Segment'
versionQueryName	De naam van de queryparameter die de API-versie aangeeft als versioningScheme is ingesteld op `query`.	snaar

AuthenticationSettingsContract

Naam	Beschrijving	Waarde
oAuth2	OAuth2-verificatie-instellingen	OAuth2AuthenticationSettingsContract
oAuth2AuthenticationSettings	Verzameling OAuth2-verificatie-instellingen die zijn opgenomen in deze API.	OAuth2AuthenticationSettingsContract[]
openid	OpenID Connect-verificatie-instellingen	OpenIdAuthenticationSettingsContract
openidAuthenticationSettings	Verzameling open ID Connect-verificatie-instellingen die zijn opgenomen in deze API.	OpenIdAuthenticationSettingsContract[]

OAuth2AuthenticationSettingsContract

Naam	Beschrijving	Waarde
authorizationServerId	OAuth-autorisatieserver-id.	snaar
draagwijdte	bewerkingsbereik.	snaar

OpenIdAuthenticationSettingsContract

Naam	Beschrijving	Waarde
bearerTokenSendingMethods	Token naar de server verzenden.	Tekenreeksmatrix met een van de volgende waarden: 'authorizationHeader' 'query'
openidProviderId	OAuth-autorisatieserver-id.	snaar

ApiContactInformation

Naam	Beschrijving	Waarde
E-mail	Het e-mailadres van de contactpersoon/organisatie. MOET de indeling van een e-mailadres hebben	snaar
naam	De identificatienaam van de contactpersoon/organisatie	snaar
URL	De URL die verwijst naar de contactgegevens. MOET de indeling van een URL hebben	snaar

ApiLicenseInformation

Naam	Beschrijving	Waarde
naam	De licentienaam die wordt gebruikt voor de API	snaar
URL	Een URL naar de licentie die wordt gebruikt voor de API. MOET de indeling van een URL hebben	snaar

SubscriptionKeyParameterNamesContract

Naam	Beschrijving	Waarde
rubriek	Naam van abonnementssleutelheader.	snaar
vraag	Naam van queryreeksparameter voor abonnementssleutel.	snaar

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

Quickstart-sjablonen

Met de volgende quickstart-sjablonen wordt dit resourcetype geïmplementeerd.

Sjabloon	Beschrijving
Een API Management-exemplaar en alle subbronnen maken met behulp van sjabloon-	Deze sjabloon laat zien hoe u een API Management-service maakt en subentiteiten configureert
Azure Front Door maken vóór Azure API Management	In dit voorbeeld ziet u hoe u Azure Front Door gebruikt als een globale load balancer voor Azure API Management.

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@2023-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"
      }
    }
  })
}

Eigenschapswaarden

service/api's

Naam	Beschrijving	Waarde
type	Het resourcetype	"Microsoft.ApiManagement/service/apis@2023-09-01-preview"
naam	De resourcenaam	tekenreeks (vereist) Tekenlimiet: 1-80 Geldige tekens: Alfanumerieke en afbreekstreepjes. Begin met letter en eindig met alfanumeriek.
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

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
apiRevisionDescription	Beschrijving van de API-revisie.	snaar Beperkingen: Maximale lengte = 256
apiType	Type API dat moet worden gemaakt. * `http` maakt een REST API * `soap` maakt een SOAP Pass Through-API * `websocket` websocket-API maakt * `graphql` maakt GraphQL-API. Nieuwe typen kunnen in de toekomst worden toegevoegd.	"graphql" "grpc" "`http`" "odata" "zeep" "websocket"
apiVersion	Geeft de versie-id van de API aan als de API is geversied	snaar Beperkingen: Maximale lengte = 100
apiVersionDescription	Beschrijving van de API-versie.	snaar Beperkingen: Maximale lengte = 256
apiVersionSet	Details van versieset	ApiVersionSetContractDetails-
apiVersionSetId	Een resource-id voor de gerelateerde ApiVersionSet.	snaar
authenticationSettings	Verzameling van verificatie-instellingen die zijn opgenomen in deze API.	AuthenticationSettingsContract
contact	Contactgegevens voor de API.	ApiContactInformation-
beschrijving	Beschrijving van de API. Kan HTML-opmaaktags bevatten.	snaar
displayName	API-naam. Moet 1 tot 300 tekens lang zijn.	snaar Beperkingen: Minimale lengte = 1 Maximale lengte = 300
formatteren	Indeling van de inhoud waarin de API wordt geïmporteerd. Nieuwe indelingen kunnen in de toekomst worden toegevoegd	"graphql-link" "grpc" "grpc-link" "odata" "odata-link" "openapi" "openapi+json" "openapi+json-link" "openapi-link" "swagger-json" "swagger-link-json" "wadl-link-json" "wadl-xml" "wsdl" "wsdl-link"
isCurrent	Geeft aan of API-revisie de huidige API-revisie is.	Bool
licentie	Licentiegegevens voor de API.	ApiLicenseInformation-
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.	tekenreeks (vereist) Beperkingen: Maximale lengte = 400
Protocollen	Beschrijft op welke protocollen de bewerkingen in deze API kunnen worden aangeroepen.	Tekenreeksmatrix met een van de volgende waarden: "`http`" "`https`" "ws" "wss"
serviceUrl	Absolute URL van de back-endservice die deze API implementeert. Mag niet langer zijn dan 2000 tekens.	snaar Beperkingen: Maximale lengte = 2000
sourceApiId	API-id van de bron-API.	snaar
subscriptionKeyParameterNames	Protocollen over welke API beschikbaar wordt gemaakt.	SubscriptionKeyParameterNamesContract
subscriptionRequired	Hiermee geeft u op of een API- of productabonnement vereist is voor toegang tot de API.	Bool
termsOfServiceUrl	Een URL naar de servicevoorwaarden voor de API. MOET de indeling van een URL hebben.	snaar
translateRequiredQueryParameters	Strategie voor het vertalen van vereiste queryparameters naar sjabloonparameters. Standaard heeft de waarde 'sjabloon'. Mogelijke waarden: 'template', 'query'	"query" "sjabloon"
type	Type of API.	"graphql" "grpc" "`http`" "odata" "zeep" "websocket"
waarde	Inhoudswaarde bij het importeren van een API.	snaar
wsdlSelector	Criteria om het importeren van WSDL te beperken tot een subset van het document.	ApiCreateOrUpdatePropertiesWsdlSelector

ApiVersionSetContractDetails

Naam	Beschrijving	Waarde
beschrijving	Beschrijving van API-versieset.	snaar
legitimatiebewijs	Id voor bestaande API-versieset. Laat deze waarde weg om een nieuwe versieset te maken.	snaar
naam	De weergavenaam van de API-versieset.	snaar
versionHeaderName	Naam van de HTTP-headerparameter die de API-versie aangeeft als versioningScheme is ingesteld op `header`.	snaar
versioningScheme	Een waarde die bepaalt waar de API-versie-id zich in een HTTP-aanvraag bevindt.	"Koptekst" "Query" "Segment"
versionQueryName	De naam van de queryparameter die de API-versie aangeeft als versioningScheme is ingesteld op `query`.	snaar

AuthenticationSettingsContract

Naam	Beschrijving	Waarde
oAuth2	OAuth2-verificatie-instellingen	OAuth2AuthenticationSettingsContract
oAuth2AuthenticationSettings	Verzameling OAuth2-verificatie-instellingen die zijn opgenomen in deze API.	OAuth2AuthenticationSettingsContract[]
openid	OpenID Connect-verificatie-instellingen	OpenIdAuthenticationSettingsContract
openidAuthenticationSettings	Verzameling open ID Connect-verificatie-instellingen die zijn opgenomen in deze API.	OpenIdAuthenticationSettingsContract[]

OAuth2AuthenticationSettingsContract

Naam	Beschrijving	Waarde
authorizationServerId	OAuth-autorisatieserver-id.	snaar
draagwijdte	bewerkingsbereik.	snaar

OpenIdAuthenticationSettingsContract

Naam	Beschrijving	Waarde
bearerTokenSendingMethods	Token naar de server verzenden.	Tekenreeksmatrix met een van de volgende waarden: "authorizationHeader" "query"
openidProviderId	OAuth-autorisatieserver-id.	snaar

ApiContactInformation

Naam	Beschrijving	Waarde
E-mail	Het e-mailadres van de contactpersoon/organisatie. MOET de indeling van een e-mailadres hebben	snaar
naam	De identificatienaam van de contactpersoon/organisatie	snaar
URL	De URL die verwijst naar de contactgegevens. MOET de indeling van een URL hebben	snaar

ApiLicenseInformation

Naam	Beschrijving	Waarde
naam	De licentienaam die wordt gebruikt voor de API	snaar
URL	Een URL naar de licentie die wordt gebruikt voor de API. MOET de indeling van een URL hebben	snaar

SubscriptionKeyParameterNamesContract

Naam	Beschrijving	Waarde
rubriek	Naam van abonnementssleutelheader.	snaar
vraag	Naam van queryreeksparameter voor abonnementssleutel.	snaar

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

Delen via

Microsoft.ApiManagement-service/api's

Bicep-resourcedefinitie

Resource-indeling

Eigenschapswaarden

service/api's

ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiVersionSetContractDetails

AuthenticationSettingsContract

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

ApiContactInformation

ApiLicenseInformation

SubscriptionKeyParameterNamesContract

ApiCreateOrUpdatePropertiesWsdlSelector

Quickstart-sjablonen

Resourcedefinitie van ARM-sjabloon

Resource-indeling

Eigenschapswaarden

service/api's

ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiVersionSetContractDetails

AuthenticationSettingsContract

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

ApiContactInformation

ApiLicenseInformation

SubscriptionKeyParameterNamesContract

ApiCreateOrUpdatePropertiesWsdlSelector

Quickstart-sjablonen

Resourcedefinitie van Terraform (AzAPI-provider)

Resource-indeling

Eigenschapswaarden

service/api's

ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiVersionSetContractDetails

AuthenticationSettingsContract

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

ApiContactInformation

ApiLicenseInformation

SubscriptionKeyParameterNamesContract

ApiCreateOrUpdatePropertiesWsdlSelector

Feedback

Aanvullende resources