Microsoft.ApiManagement szolgáltatás/apis 2022-08-01

Cikk
01/18/2024

Bicep-erőforrásdefiníció

A szolgáltatás/apis erőforrástípus üzembe helyezhető olyan műveletekkel, amelyek a következőkre irányulnak:

Erőforráscsoportok – Lásd : erőforráscsoport üzembehelyezési parancsai

Az egyes API-verziók módosított tulajdonságainak listáját a változásnaplóban találja.

Erőforrás formátuma

Microsoft.ApiManagement/service/apis erőforrás létrehozásához adja hozzá a következő Bicep-et a sablonhoz.

resource symbolicname 'Microsoft.ApiManagement/service/apis@2022-08-01' = {
  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'
    }
  }
}

Tulajdonságértékek

service/apis

Név	Leírás	Érték
name	Az erőforrás neve Megtudhatja, hogyan állíthatja be a gyermekerőforrások nevét és típusát a Bicepben.	sztring (kötelező) Karakterkorlát: 1-80 Érvényes karakterek: Alfanumerikák és kötőjelek. Kezdje betűvel és végződéssel alfanumerikussal.
Szülő	A Bicepben megadhatja egy gyermekerőforrás szülőerőforrását. Ezt a tulajdonságot csak akkor kell hozzáadnia, ha a gyermekerőforrás a szülőerőforráson kívül van deklarálva. További információ: Gyermekerőforrás a szülőerőforráson kívül.	A típus erőforrásának szimbolikus neve: szolgáltatás
properties	Az API-entitások létrehozzák a frissítési tulajdonságokat.	ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiCreateOrUpdatePropertiesOrApiContractProperties

Név	Leírás	Érték
apiRevision	Az API változatának ismertetése. Ha nincs megadva érték, az alapértelmezett 1. változat jön létre	sztring
apiRevisionDescription	Az API-változat leírása.	sztring
apiType	A létrehozandó API típusa. * `http` REST API-t hoz létre * `soap` SOAP átmenő API-t hoz létre * `websocket` websocket API létrehozása * `graphql` GraphQL API-t hoz létre.	"graphql" "http" "szappan" "websocket"
apiVersion	Az API verzióazonosítóját jelzi, ha az API verziószámozott	sztring
apiVersionDescription	Az API-verzió leírása.	sztring
apiVersionSet	Verziókészlet részletei	ApiVersionSetContractDetails
apiVersionSetId	A kapcsolódó ApiVersionSet erőforrás-azonosítója.	sztring
authenticationSettings	Az API-ba tartozó hitelesítési beállítások gyűjteménye.	AuthenticationSettingsContract
kapcsolattartó	Az API kapcsolattartási adatai.	ApiContactInformation
leírás	Az API leírása. Tartalmazhat HTML-formázási címkéket is.	sztring
displayName	API-név. 1–300 karakter hosszúságúnak kell lennie.	sztring
Formátum	Annak a tartalomnak a formátuma, amelyben az API importálása történik.	"graphql-link" 'openapi' 'openapi+json' 'openapi+json-link' "openapi-link" 'swagger-json' 'swagger-link-json' "wadl-link-json" "wadl-xml" 'wsdl' "wsdl-link"
isCurrent	Azt jelzi, hogy az API-változat aktuális API-változat-e.	logikai
licenc	Licencinformációk az API-hoz.	ApiLicenseInformation
path	Relatív URL-cím, amely egyedileg azonosítja ezt az API-t és annak összes erőforrásútvonalát a API Management szolgáltatáspéldányon belül. A rendszer hozzáfűzi a szolgáltatáspéldány létrehozása során megadott API-végponti alap URL-címhez, hogy nyilvános URL-címet hozzon létre ehhez az API-hoz.	sztring (kötelező)
Protokollok	Ez a cikk azt ismerteti, hogy az API műveletei mely protokollokon hívhatók meg.	Sztringtömb, amely az alábbiak bármelyikét tartalmazza: 'http' "https" 'ws' "wss"
serviceUrl	Az API-t implementáló háttérszolgáltatás abszolút URL-címe. Legfeljebb 2000 karakter hosszúságú lehet.	sztring
sourceApiId	A forrás API API-azonosítója.	sztring
subscriptionKeyParameterNames	Protokollok, amelyeken keresztül az API elérhetővé válik.	SubscriptionKeyParameterNamesContract
subscriptionRequired	Megadja, hogy szükség van-e API- vagy termék-előfizetésre az API eléréséhez.	logikai
termsOfServiceUrl	Az API szolgáltatási feltételeinek URL-címe. URL-cím formátumúnak kell lennie.	sztring
translateRequiredQueryParameters	A szükséges lekérdezési paraméterek sablonra fordításának stratégiája. Alapértelmezés szerint a "template" érték van megadva. Lehetséges értékek: 'template', 'query'	"lekérdezés" "sablon"
típus	Az API típusa.	'graphql' 'http' "szappan" "websocket"
érték	Tartalomérték API importálásakor.	sztring
wsdlSelector	A WSDL importálásának a dokumentum egy részhalmazára való korlátozására vonatkozó feltételek.	ApiCreateOrUpdatePropertiesWsdlSelector

ApiVersionSetContractDetails

Név	Leírás	Érték
leírás	Az API-verziókészlet leírása.	sztring
id	A meglévő API-verziókészlet azonosítója. Ezt az értéket kihagyva hozzon létre egy új verziókészletet.	sztring
name	A megjelenített API-verziókészlet neve.	sztring
versionHeaderName	Annak a HTTP-fejlécparaméternek a neve, amely az API-verziót jelzi, ha a versioningScheme értékre `header`van állítva.	sztring
versioningScheme	Egy érték, amely meghatározza, hogy az API-verzió azonosítója hol található egy HTTP-kérelemben.	"Fejléc" "Lekérdezés" "Szegmens"
versionQueryName	Annak a lekérdezési paraméternek a neve, amely az API-verziót jelzi, ha a versioningScheme értékre `query`van állítva.	sztring

AuthenticationSettingsContract

Név	Leírás	Érték
oAuth2	Az OAuth2 hitelesítési beállításai	OAuth2AuthenticationSettingsContract
oAuth2AuthenticationSettings	Az API részét képező OAuth2 hitelesítési beállítások gyűjteménye.	OAuth2AuthenticationSettingsContract[]
Openid	OpenID Connect-hitelesítési beállítások	OpenIdAuthenticationSettingsContract
openidAuthenticationSettings	Az API-hoz tartozó Open ID Connect hitelesítési beállítások gyűjteménye.	OpenIdAuthenticationSettingsContract[]

OAuth2AuthenticationSettingsContract

Név	Leírás	Érték
authorizationServerId	OAuth engedélyezési kiszolgáló azonosítója.	sztring
scope	műveleti hatókör.	sztring

OpenIdAuthenticationSettingsContract

Név	Leírás	Érték
bearerTokenSendingMethods	Jogkivonat küldése a kiszolgálóra.	Sztringtömb, amely az alábbiak bármelyikét tartalmazza: "authorizationHeader" "lekérdezés"
openidProviderId	OAuth engedélyezési kiszolgáló azonosítója.	sztring

ApiContactInformation

Név	Leírás	Érték
e-mail	A kapcsolattartó/szervezet e-mail-címe. E-mail-cím formátumban kell lennie	sztring
name	A kapcsolattartó/szervezet azonosító neve	sztring
url	Az URL-cím a kapcsolattartási adatokra mutat. URL-cím formátumának kell lennie	sztring

ApiLicenseInformation

Név	Leírás	Érték
name	Az API-hoz használt licencnév	sztring
url	Az API-hoz használt licenc URL-címe. URL-cím formátumának kell lennie	sztring

SubscriptionKeyParameterNamesContract

Név	Leírás	Érték
fejléc	Előfizetési kulcs fejlécének neve.	sztring
query	Előfizetési kulcs lekérdezési sztring paraméterének neve.	sztring

ApiCreateOrUpdatePropertiesWsdlSelector

Név	Leírás	Érték
wsdlEndpointName	A WSDL-ből importálandó végpont(port) neve	sztring
wsdlServiceName	A WSDL-ből importálandó szolgáltatás neve	sztring

Gyorssablonok

Az alábbi rövid útmutatósablonok ezt az erőforrástípust helyezik üzembe.

Sablon	Description
Az API Management-példány és az összes alárendelt erőforrás létrehozása sablonból	Ez a sablon bemutatja, hogyan hozhat létre API Management szolgáltatást, és hogyan konfigurálhat alentititásokat
Azure Front Door létrehozása az Azure API Management előtt	Ez a minta bemutatja, hogyan használhatja az Azure Front Doort globális terheléselosztóként az Azure API Management előtt.

ARM-sablon erőforrásdefiníciója

A szolgáltatás/apis erőforrástípus üzembe helyezhető olyan műveletekkel, amelyek a következőkre irányulnak:

Erőforráscsoportok – Lásd : erőforráscsoport üzembehelyezési parancsai

Az egyes API-verziók módosított tulajdonságainak listáját a változásnaplóban találja.

Erőforrás formátuma

Microsoft.ApiManagement/service/apis erőforrás létrehozásához adja hozzá a következő JSON-t a sablonhoz.

{
  "type": "Microsoft.ApiManagement/service/apis",
  "apiVersion": "2022-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"
      },
      "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"
    }
  }
}

Tulajdonságértékek

service/apis

Név	Leírás	Érték
típus	Az erőforrás típusa	"Microsoft.ApiManagement/service/apis"
apiVersion	Az erőforrás API-verziója	'2022-08-01'
name	Az erőforrás neve Megtudhatja, hogyan állíthatja be a gyermekerőforrások nevét és típusát A JSON ARM-sablonokban.	sztring (kötelező) Karakterkorlát: 1-80 Érvényes karakterek: Alfanumerikák és kötőjelek. Kezdje betűvel és végződéssel alfanumerikussal.
properties	Az API-entitások létrehozzák a frissítési tulajdonságokat.	ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiCreateOrUpdatePropertiesOrApiContractProperties

Név	Leírás	Érték
apiRevision	Az API változatának ismertetése. Ha nincs megadva érték, az alapértelmezett 1. változat jön létre	sztring
apiRevisionDescription	Az API-változat leírása.	sztring
apiType	A létrehozandó API típusa. * `http` REST API-t hoz létre * `soap` SOAP átmenő API-t hoz létre * `websocket` websocket API létrehozása * `graphql` GraphQL API-t hoz létre.	"graphql" "http" "szappan" "websocket"
apiVersion	Az API verzióazonosítóját jelzi, ha az API verziószámozott	sztring
apiVersionDescription	Az API-verzió leírása.	sztring
apiVersionSet	Verziókészlet részletei	ApiVersionSetContractDetails
apiVersionSetId	A kapcsolódó ApiVersionSet erőforrás-azonosítója.	sztring
authenticationSettings	Az API-ba tartozó hitelesítési beállítások gyűjteménye.	AuthenticationSettingsContract
kapcsolattartó	Az API kapcsolattartási adatai.	ApiContactInformation
leírás	Az API leírása. Tartalmazhat HTML-formázási címkéket is.	sztring
displayName	API-név. 1–300 karakter hosszúságúnak kell lennie.	sztring
Formátum	Annak a tartalomnak a formátuma, amelyben az API importálása történik.	"graphql-link" 'openapi' 'openapi+json' 'openapi+json-link' "openapi-link" 'swagger-json' 'swagger-link-json' "wadl-link-json" "wadl-xml" 'wsdl' "wsdl-link"
isCurrent	Azt jelzi, hogy az API-változat aktuális API-változat-e.	logikai
licenc	Licencinformációk az API-hoz.	ApiLicenseInformation
path	Relatív URL-cím, amely egyedileg azonosítja ezt az API-t és annak összes erőforrásútvonalát a API Management szolgáltatáspéldányon belül. A rendszer hozzáfűzi a szolgáltatáspéldány létrehozása során megadott API-végpontbázis URL-címéhez, hogy nyilvános URL-címet hozzon létre ehhez az API-hoz.	sztring (kötelező)
Protokollok	Ismerteti, hogy mely protokollokon hívhatók meg az API műveletei.	Sztringtömb, amely az alábbiak bármelyikét tartalmazza: "http" "https" 'ws' 'wss'
serviceUrl	Az API-t implementáló háttérszolgáltatás abszolút URL-címe. Legfeljebb 2000 karakter hosszú lehet.	sztring
sourceApiId	A forrás API API-azonosítója.	sztring
subscriptionKeyParameterNames	Protokollok, amelyeken keresztül az API elérhetővé válik.	SubscriptionKeyParameterNamesContract
subscriptionRequired	Meghatározza, hogy szükség van-e API- vagy Termék-előfizetésre az API eléréséhez.	logikai
termsOfServiceUrl	Az API szolgáltatási feltételeinek URL-címe. URL-cím formátumban kell lennie.	sztring
translateRequiredQueryParameters	A szükséges lekérdezési paraméterek sablonra történő fordításának stratégiája. Alapértelmezés szerint "sablon" értékű. Lehetséges értékek: "sablon", "lekérdezés"	"lekérdezés" "sablon"
típus	Az API típusa.	'graphql' 'http' "szappan" "websocket"
érték	Tartalomérték API importálásakor.	sztring
wsdlSelector	A WSDL importálásának a dokumentum egy részhalmazára való korlátozására vonatkozó feltételek.	ApiCreateOrUpdatePropertiesWsdlSelector

ApiVersionSetContractDetails

Név	Leírás	Érték
leírás	Az API-verziókészlet leírása.	sztring
id	A meglévő API-verziókészlet azonosítója. Ezt az értéket kihagyva hozzon létre egy új verziókészletet.	sztring
name	A megjelenített API-verziókészlet neve.	sztring
versionHeaderName	Annak a HTTP-fejlécparaméternek a neve, amely az API-verziót jelzi, ha a versioningScheme értékre `header`van állítva.	sztring
versioningScheme	Egy érték, amely meghatározza, hogy az API-verzió azonosítója hol található egy HTTP-kérelemben.	"Fejléc" "Lekérdezés" "Szegmens"
versionQueryName	Annak a lekérdezési paraméternek a neve, amely az API-verziót jelzi, ha a versioningScheme értékre `query`van állítva.	sztring

AuthenticationSettingsContract

Név	Leírás	Érték
oAuth2	Az OAuth2 hitelesítési beállításai	OAuth2AuthenticationSettingsContract
oAuth2AuthenticationSettings	Az API részét képező OAuth2 hitelesítési beállítások gyűjteménye.	OAuth2AuthenticationSettingsContract[]
Openid	OpenID Connect-hitelesítési beállítások	OpenIdAuthenticationSettingsContract
openidAuthenticationSettings	Az API-hoz tartozó Open ID Connect hitelesítési beállítások gyűjteménye.	OpenIdAuthenticationSettingsContract[]

OAuth2AuthenticationSettingsContract

Név	Leírás	Érték
authorizationServerId	OAuth engedélyezési kiszolgáló azonosítója.	sztring
scope	műveleti hatókör.	sztring

OpenIdAuthenticationSettingsContract

Név	Leírás	Érték
bearerTokenSendingMethods	Jogkivonat küldése a kiszolgálóra.	Sztringtömb, amely az alábbiak bármelyikét tartalmazza: "authorizationHeader" "lekérdezés"
openidProviderId	OAuth engedélyezési kiszolgáló azonosítója.	sztring

ApiContactInformation

Név	Leírás	Érték
e-mail	A kapcsolattartó/szervezet e-mail-címe. E-mail-cím formátumban kell lennie	sztring
name	A kapcsolattartó/szervezet azonosító neve	sztring
url	A kapcsolattartási adatokra mutató URL-cím. URL-cím formátumban kell lennie	sztring

ApiLicenseInformation

Név	Leírás	Érték
name	Az API-hoz használt licencnév	sztring
url	Az API-hoz használt licenc URL-címe. URL-cím formátumban kell lennie	sztring

SubscriptionKeyParameterNamesContract

Név	Leírás	Érték
fejléc	Előfizetési kulcs fejlécének neve.	sztring
query	Előfizetési kulcs lekérdezési sztring paraméterének neve.	sztring

ApiCreateOrUpdatePropertiesWsdlSelector

Név	Leírás	Érték
wsdlEndpointName	A WSDL-ből importálandó végpont(port) neve	sztring
wsdlServiceName	A WSDL-ből importálandó szolgáltatás neve	sztring

Gyorssablonok

Az alábbi rövid útmutatósablonok ezt az erőforrástípust helyezik üzembe.

Sablon	Description
Az API Management-példány és az összes alárendelt erőforrás létrehozása sablonból	Ez a sablon bemutatja, hogyan hozhat létre API Management szolgáltatást, és hogyan konfigurálhat alentititásokat
Azure Front Door létrehozása az Azure API Management előtt	Ez a minta bemutatja, hogyan használhatja az Azure Front Doort globális terheléselosztóként az Azure API Management előtt.

Terraform (AzAPI-szolgáltató) erőforrásdefiníció

A szolgáltatás/apis erőforrástípus üzembe helyezhető olyan műveletekkel, amelyek a következőkre irányulnak:

Erőforráscsoportok

Az egyes API-verziók módosított tulajdonságainak listáját a változásnaplóban találja.

Erőforrás formátuma

Microsoft.ApiManagement/service/apis erőforrás létrehozásához adja hozzá a következő Terraformot a sablonhoz.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis@2022-08-01"
  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"
      }
    }
  })
}

Tulajdonságértékek

service/apis

Név	Leírás	Érték
típus	Az erőforrás típusa	"Microsoft.ApiManagement/service/apis@2022-08-01"
name	Az erőforrás neve	sztring (kötelező) Karakterkorlát: 1-80 Érvényes karakterek: Alfanumerikák és kötőjelek. Kezdje betűvel és végződéssel alfanumerikussal.
parent_id	Az erőforrás szülőjének azonosítója.	A következő típusú erőforrás azonosítója: szolgáltatás
properties	Az API-entitások létrehozzák a frissítési tulajdonságokat.	ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiCreateOrUpdatePropertiesOrApiContractProperties

Név	Leírás	Érték
apiRevision	Az API változatának ismertetése. Ha nincs megadva érték, az alapértelmezett 1. változat jön létre	sztring
apiRevisionDescription	Az API-változat leírása.	sztring
apiType	A létrehozandó API típusa. * `http` REST API-t hoz létre * `soap` SOAP átmenő API-t hoz létre * `websocket` websocket API létrehozása * `graphql` GraphQL API-t hoz létre.	"graphql" "http" "szappan" "websocket"
apiVersion	Az API verzióazonosítóját jelzi, ha az API verziószámozott	sztring
apiVersionDescription	Az API-verzió leírása.	sztring
apiVersionSet	Verziókészlet részletei	ApiVersionSetContractDetails
apiVersionSetId	A kapcsolódó ApiVersionSet erőforrás-azonosítója.	sztring
authenticationSettings	Az API-ba tartozó hitelesítési beállítások gyűjteménye.	AuthenticationSettingsContract
kapcsolattartó	Az API kapcsolattartási adatai.	ApiContactInformation
leírás	Az API leírása. Tartalmazhat HTML-formázási címkéket is.	sztring
displayName	API neve. 1–300 karakter hosszúságúnak kell lennie.	sztring
Formátum	Annak a tartalomnak a formátuma, amelyben az API importálása történik.	"graphql-link" "openapi" "openapi+json" "openapi+json-link" "openapi-link" "swagger-json" "swagger-link-json" "wadl-link-json" "wadl-xml" "wsdl" "wsdl-link"
isCurrent	Azt jelzi, hogy az API-változat aktuális API-változat-e.	logikai
licenc	Licencinformációk az API-hoz.	ApiLicenseInformation
path	Relatív URL-cím, amely egyedileg azonosítja ezt az API-t és annak összes erőforrásútvonalát a API Management szolgáltatáspéldányon belül. A rendszer hozzáfűzi a szolgáltatáspéldány létrehozása során megadott API-végponti alap URL-címhez, hogy nyilvános URL-címet hozzon létre ehhez az API-hoz.	sztring (kötelező)
Protokollok	Ez a cikk azt ismerteti, hogy az API műveletei mely protokollokon hívhatók meg.	Sztringtömb, amely az alábbiak bármelyikét tartalmazza: "http" "https" "ws" "wss"
serviceUrl	Az API-t implementáló háttérszolgáltatás abszolút URL-címe. Legfeljebb 2000 karakter hosszúságú lehet.	sztring
sourceApiId	A forrás API API-azonosítója.	sztring
subscriptionKeyParameterNames	Protokollok, amelyeken keresztül az API elérhetővé válik.	SubscriptionKeyParameterNamesContract
subscriptionRequired	Megadja, hogy szükség van-e API- vagy termék-előfizetésre az API eléréséhez.	logikai
termsOfServiceUrl	Az API szolgáltatási feltételeinek URL-címe. URL-cím formátumúnak kell lennie.	sztring
translateRequiredQueryParameters	A szükséges lekérdezési paraméterek sablonra fordításának stratégiája. Alapértelmezés szerint a "template" érték van megadva. Lehetséges értékek: 'template', 'query'	"lekérdezés" "sablon"
típus	Az API típusa.	"graphql" "http" "szappan" "websocket"
érték	Tartalomérték API importálásakor.	sztring
wsdlSelector	A WSDL importálásának a dokumentum egy részhalmazára való korlátozására vonatkozó feltételek.	ApiCreateOrUpdatePropertiesWsdlSelector

ApiVersionSetContractDetails

Név	Leírás	Érték
leírás	Az API-verziókészlet leírása.	sztring
id	A meglévő API-verziókészlet azonosítója. Ezt az értéket kihagyva hozzon létre egy új verziókészletet.	sztring
name	A megjelenített API-verziókészlet neve.	sztring
versionHeaderName	Annak a HTTP-fejlécparaméternek a neve, amely az API-verziót jelzi, ha a versioningScheme értékre `header`van állítva.	sztring
versioningScheme	Egy érték, amely meghatározza, hogy az API-verzió azonosítója hol található egy HTTP-kérelemben.	„Fejléc” "Lekérdezés" "Szegmens"
versionQueryName	Annak a lekérdezési paraméternek a neve, amely az API-verziót jelzi, ha a versioningScheme értékre `query`van állítva.	sztring

AuthenticationSettingsContract

Név	Leírás	Érték
oAuth2	Az OAuth2 hitelesítési beállításai	OAuth2AuthenticationSettingsContract
oAuth2AuthenticationSettings	Az API részét képező OAuth2 hitelesítési beállítások gyűjteménye.	OAuth2AuthenticationSettingsContract[]
Openid	OpenID Connect-hitelesítési beállítások	OpenIdAuthenticationSettingsContract
openidAuthenticationSettings	Az API-hoz tartozó Open ID Connect hitelesítési beállítások gyűjteménye.	OpenIdAuthenticationSettingsContract[]

OAuth2AuthenticationSettingsContract

Név	Leírás	Érték
authorizationServerId	OAuth engedélyezési kiszolgáló azonosítója.	sztring
scope	műveleti hatókör.	sztring

OpenIdAuthenticationSettingsContract

Név	Leírás	Érték
bearerTokenSendingMethods	Jogkivonat küldése a kiszolgálóra.	Sztringtömb, amely az alábbiak bármelyikét tartalmazza: "authorizationHeader" "lekérdezés"
openidProviderId	OAuth engedélyezési kiszolgáló azonosítója.	sztring

ApiContactInformation

Név	Leírás	Érték
e-mail	A kapcsolattartó/szervezet e-mail-címe. E-mail-cím formátumban kell lennie	sztring
name	A kapcsolattartó/szervezet azonosító neve	sztring
url	A kapcsolattartási adatokra mutató URL-cím. URL-cím formátumban kell lennie	sztring

ApiLicenseInformation

Név	Leírás	Érték
name	Az API-hoz használt licencnév	sztring
url	Az API-hoz használt licenc URL-címe. URL-cím formátumban kell lennie	sztring

SubscriptionKeyParameterNamesContract

Név	Leírás	Érték
fejléc	Előfizetési kulcs fejlécének neve.	sztring
query	Előfizetési kulcs lekérdezési sztring paraméterének neve.	sztring

ApiCreateOrUpdatePropertiesWsdlSelector

Név	Leírás	Érték
wsdlEndpointName	A WSDL-ből importálandó végpont(port) neve	sztring
wsdlServiceName	A WSDL-ből importálandó szolgáltatás neve	sztring

Megosztás a következőn keresztül:

Microsoft.ApiManagement szolgáltatás/apis 2022-08-01

Bicep-erőforrásdefiníció

Erőforrás formátuma

Tulajdonságértékek

service/apis

ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiVersionSetContractDetails

AuthenticationSettingsContract

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

ApiContactInformation

ApiLicenseInformation

SubscriptionKeyParameterNamesContract

ApiCreateOrUpdatePropertiesWsdlSelector

Gyorssablonok

ARM-sablon erőforrásdefiníciója

Erőforrás formátuma

Tulajdonságértékek

service/apis

ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiVersionSetContractDetails

AuthenticationSettingsContract

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

ApiContactInformation

ApiLicenseInformation

SubscriptionKeyParameterNamesContract

ApiCreateOrUpdatePropertiesWsdlSelector

Gyorssablonok

Terraform (AzAPI-szolgáltató) erőforrásdefiníció

Erőforrás formátuma

Tulajdonságértékek

service/apis

ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiVersionSetContractDetails

AuthenticationSettingsContract

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

ApiContactInformation

ApiLicenseInformation

SubscriptionKeyParameterNamesContract

ApiCreateOrUpdatePropertiesWsdlSelector

További források