Dela via

Microsoft.ApiManagement service/apis 2021-08-01

  • Artikel

Bicep-resursdefinition

Resurstypen tjänst/apis kan distribueras med åtgärder som mål:

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@2021-08-01' = {
  parent: resourceSymbolicName
  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'
      }
      openid: {
        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'
    type: 'string'
    value: 'string'
    wsdlSelector: {
      wsdlEndpointName: 'string'
      wsdlServiceName: 'string'
    }
  }
}

Egenskapsvärden

ApiContactInformation

Namn Beskrivning Värde
E-post Kontaktpersonens/organisationens e-postadress. MÅSTE vara i formatet för en e-postadress sträng
Namn Det identifierande namnet på kontaktpersonen/organisationen sträng
URL URL:en som pekar på kontaktinformationen. MÅSTE vara i formatet för en URL sträng

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
apiRevisionDescription Beskrivning av API-revisionen. sträng

Begränsningar:
Max längd =
apiType Typ av API som ska skapas.
* http skapar ett REST-API
* soap skapar ett SOAP-DIREKT-API
* 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

Begränsningar:
Max längd =
apiVersionDescription Beskrivning av API-versionen. sträng

Begränsningar:
Max längd =
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

Begränsningar:
Min längd = 1
Maximal längd = 1
format Format för innehållet 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. Bool
licens Licensinformation för API:et. ApiLicenseInformation
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"
"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

Begränsningar:
Max längd =
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. Bool
termsOfServiceUrl En URL till användningsvillkoren för API:et. MÅSTE vara i formatet för en URL. sträng
typ Typ av API. "graphql"
"http"
"soap"
"websocket"
värde Innehållsvärde när du importerar ett API. sträng
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

ApiLicenseInformation

Namn Beskrivning Värde
Namn 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

ApiVersionSetContractDetails

Namn 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
Namn 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
versionshanteringScheme 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

Namn Beskrivning Värde
oAuth2 Autentiseringsinställningar för OAuth2 OAuth2AuthenticationSettingsContract
openid Inställningar för OpenID Connect-autentisering OpenIdAuthenticationSettingsContract

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

OpenIdAuthenticationSettingsContract

Namn 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

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:

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": "2021-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"
      },
      "openid": {
        "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",
    "type": "string",
    "value": "string",
    "wsdlSelector": {
      "wsdlEndpointName": "string",
      "wsdlServiceName": "string"
    }
  }
}

Egenskapsvärden

ApiContactInformation

Namn Beskrivning Värde
E-post Kontaktpersonens/organisationens e-postadress. MÅSTE vara i formatet för en e-postadress sträng
Namn Det identifierande namnet på kontaktpersonen/organisationen sträng
URL URL:en som pekar på kontaktinformationen. MÅSTE vara i formatet för en URL sträng

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
apiRevisionDescription Beskrivning av API-revisionen. sträng

Begränsningar:
Max längd =
apiType Typ av API som ska skapas.
* http skapar ett REST-API
* soap skapar ett SOAP-DIREKT-API
* 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

Begränsningar:
Max längd =
apiVersionDescription Beskrivning av API-versionen. sträng

Begränsningar:
Max längd =
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

Begränsningar:
Min längd = 1
Maximal längd = 1
format Format för innehållet 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. Bool
licens Licensinformation för API:et. ApiLicenseInformation
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"
"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

Begränsningar:
Max längd =
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. Bool
termsOfServiceUrl En URL till användningsvillkoren för API:et. MÅSTE vara i formatet för en URL. sträng
typ Typ av API. "graphql"
"http"
"soap"
"websocket"
värde Innehållsvärde när du importerar ett API. sträng
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

ApiLicenseInformation

Namn Beskrivning Värde
Namn 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

ApiVersionSetContractDetails

Namn 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
Namn 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
versionshanteringScheme 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

Namn Beskrivning Värde
oAuth2 Autentiseringsinställningar för OAuth2 OAuth2AuthenticationSettingsContract
openid Inställningar för OpenID Connect-autentisering OpenIdAuthenticationSettingsContract

Microsoft.ApiManagement/service/apis

Namn Beskrivning Värde
apiVersion API-versionen '2021-08-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

OpenIdAuthenticationSettingsContract

Namn 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

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@2021-08-01"
  name = "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"
        }
        openid = {
          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"
      type = "string"
      value = "string"
      wsdlSelector = {
        wsdlEndpointName = "string"
        wsdlServiceName = "string"
      }
    }
  })
}

Egenskapsvärden

ApiContactInformation

Namn Beskrivning Värde
E-post Kontaktpersonens/organisationens e-postadress. MÅSTE vara i formatet för en e-postadress sträng
Namn Det identifierande namnet på kontaktpersonen/organisationen sträng
URL URL:en som pekar på kontaktinformationen. MÅSTE vara i formatet för en URL sträng

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
apiRevisionDescription Beskrivning av API-revisionen. sträng

Begränsningar:
Max längd =
apiType Typ av API som ska skapas.
* http skapar ett REST-API
* soap skapar ett SOAP-DIREKT-API
* 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

Begränsningar:
Max längd =
apiVersionDescription Beskrivning av API-versionen. sträng

Begränsningar:
Max längd =
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

Begränsningar:
Min längd = 1
Maximal längd = 1
format Format för innehållet 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. Bool
licens Licensinformation för API:et. ApiLicenseInformation
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"
"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

Begränsningar:
Max längd =
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. Bool
termsOfServiceUrl En URL till användningsvillkoren för API:et. MÅSTE vara i formatet för en URL. sträng
typ Typ av API. "graphql"
"http"
"soap"
"websocket"
värde Innehållsvärde när du importerar ett API. sträng
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

ApiLicenseInformation

Namn Beskrivning Värde
Namn 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

ApiVersionSetContractDetails

Namn 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
Namn 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
versionshanteringScheme 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

Namn Beskrivning Värde
oAuth2 Autentiseringsinställningar för OAuth2 OAuth2AuthenticationSettingsContract
openid Inställningar för OpenID Connect-autentisering OpenIdAuthenticationSettingsContract

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@2021-08-01"

OAuth2AuthenticationSettingsContract

Namn Beskrivning Värde
authorizationServerId OAuth-auktoriseringsserveridentifierare. sträng
omfattning driftsomfång. sträng

OpenIdAuthenticationSettingsContract

Namn 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

SubscriptionKeyParameterNamesContract

Namn Beskrivning Värde
rubrik Namn på prenumerationsnyckelhuvud. sträng
fråga Parameternamn för frågesträng för prenumerationsnyckel. sträng