Sdílet prostřednictvím

Služba Microsoft.ApiManagement/apis 2016-10-10

  • Článek

Definice prostředku Bicep

Typ prostředku service/apis je možné nasadit s operacemi, které cílí:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.ApiManagement/service/apis, přidejte do šablony následující bicep.

resource symbolicname 'Microsoft.ApiManagement/service/apis@2016-10-10' = {
  parent: resourceSymbolicName
  authenticationSettings: {
    oAuth2: {
      authorizationServerId: 'string'
      scope: 'string'
    }
  }
  description: 'string'
  name: 'string'
  path: 'string'
  protocols: [
    'string'
  ]
  serviceUrl: 'string'
  subscriptionKeyParameterNames: {
    header: 'string'
    query: 'string'
  }
}

Hodnoty vlastností

AuthenticationSettingsContract

Jméno Popis Hodnota
oAuth2 Podrobnosti o nastavení ověřování OAuth2 rozhraní API OAuth2AuthenticationSettingsContract

Microsoft.ApiManagement/service/apis

Jméno Popis Hodnota
authenticationSettings Kolekce nastavení ověřování, která jsou součástí tohoto rozhraní API. AuthenticationSettingsContract
popis Popis rozhraní API Může obsahovat značky formátování HTML. řetězec
Jméno Název prostředku řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1
Model = ^[^*#&+:<>?]+$ (povinné)
rodič V bicep můžete zadat nadřazený prostředek pro podřízený prostředek. Tuto vlastnost je potřeba přidat pouze v případě, že je podřízený prostředek deklarován mimo nadřazený prostředek.

Další informace najdete v tématu Podřízený prostředek mimo nadřazený prostředek.		 Symbolický název prostředku typu: služby
cesta Relativní adresa URL jednoznačně identifikuje toto rozhraní API a všechny jeho cesty k prostředkům v rámci instance služby API Management. Připojí se k základní adrese URL koncového bodu rozhraní API zadané během vytváření instance služby a vytvoří veřejnou adresu URL pro toto rozhraní API. řetězec

Omezení:
Maximální délka = (povinné)
protokoly Popisuje, na kterých protokolech lze vyvolat operace v tomto rozhraní API. Řetězcové pole obsahující některou z těchto možností:
Http
Https (povinné)
serviceUrl Absolutní adresa URL back-endové služby, která toto rozhraní API implementuje. řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1 (povinné)
subscriptionKeyParameterNames Protokoly, u kterých je rozhraní API dostupné. SubscriptionKeyParameterNamesContract

OAuth2AuthenticationSettingsContract

Jméno Popis Hodnota
authorizationServerId Identifikátor autorizačního serveru OAuth. řetězec
rozsah rozsah operací. řetězec

SubscriptionKeyParameterNamesContract

Jméno Popis Hodnota
záhlaví Název hlavičky klíče předplatného řetězec
dotaz Název parametru řetězce dotazu klíče předplatného řetězec

Definice prostředku šablony ARM

Typ prostředku service/apis je možné nasadit s operacemi, které cílí:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.ApiManagement/service/apis, přidejte do šablony následující JSON.

{
  "type": "Microsoft.ApiManagement/service/apis",
  "apiVersion": "2016-10-10",
  "name": "string",
  "authenticationSettings": {
    "oAuth2": {
      "authorizationServerId": "string",
      "scope": "string"
    }
  },
  "description": "string",
  "path": "string",
  "protocols": [ "string" ],
  "serviceUrl": "string",
  "subscriptionKeyParameterNames": {
    "header": "string",
    "query": "string"
  }
}

Hodnoty vlastností

AuthenticationSettingsContract

Jméno Popis Hodnota
oAuth2 Podrobnosti o nastavení ověřování OAuth2 rozhraní API OAuth2AuthenticationSettingsContract

Microsoft.ApiManagement/service/apis

Jméno Popis Hodnota
apiVersion Verze rozhraní API '2016-10-10'
authenticationSettings Kolekce nastavení ověřování, která jsou součástí tohoto rozhraní API. AuthenticationSettingsContract
popis Popis rozhraní API Může obsahovat značky formátování HTML. řetězec
Jméno Název prostředku řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1
Model = ^[^*#&+:<>?]+$ (povinné)
cesta Relativní adresa URL jednoznačně identifikuje toto rozhraní API a všechny jeho cesty k prostředkům v rámci instance služby API Management. Připojí se k základní adrese URL koncového bodu rozhraní API zadané během vytváření instance služby a vytvoří veřejnou adresu URL pro toto rozhraní API. řetězec

Omezení:
Maximální délka = (povinné)
protokoly Popisuje, na kterých protokolech lze vyvolat operace v tomto rozhraní API. Řetězcové pole obsahující některou z těchto možností:
Http
Https (povinné)
serviceUrl Absolutní adresa URL back-endové služby, která toto rozhraní API implementuje. řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1 (povinné)
subscriptionKeyParameterNames Protokoly, u kterých je rozhraní API dostupné. SubscriptionKeyParameterNamesContract
typ Typ prostředku Microsoft.ApiManagement/service/apis

OAuth2AuthenticationSettingsContract

Jméno Popis Hodnota
authorizationServerId Identifikátor autorizačního serveru OAuth. řetězec
rozsah rozsah operací. řetězec

SubscriptionKeyParameterNamesContract

Jméno Popis Hodnota
záhlaví Název hlavičky klíče předplatného řetězec
dotaz Název parametru řetězce dotazu klíče předplatného řetězec

Definice prostředku Terraformu (poskytovatel AzAPI)

Typ prostředku service/apis je možné nasadit s operacemi, které cílí:

  • skupiny prostředků

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.ApiManagement/service/apis, přidejte do šablony následující Terraform.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis@2016-10-10"
  name = "string"
  authenticationSettings = {
    oAuth2 = {
      authorizationServerId = "string"
      scope = "string"
    }
  }
  description = "string"
  path = "string"
  protocols = [
    "string"
  ]
  serviceUrl = "string"
  subscriptionKeyParameterNames = {
    header = "string"
    query = "string"
  }
}

Hodnoty vlastností

AuthenticationSettingsContract

Jméno Popis Hodnota
oAuth2 Podrobnosti o nastavení ověřování OAuth2 rozhraní API OAuth2AuthenticationSettingsContract

Microsoft.ApiManagement/service/apis

Jméno Popis Hodnota
authenticationSettings Kolekce nastavení ověřování, která jsou součástí tohoto rozhraní API. AuthenticationSettingsContract
popis Popis rozhraní API Může obsahovat značky formátování HTML. řetězec
Jméno Název prostředku řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1
Model = ^[^*#&+:<>?]+$ (povinné)
parent_id ID prostředku, který je nadřazený pro tento prostředek. ID prostředku typu: služby
cesta Relativní adresa URL jednoznačně identifikuje toto rozhraní API a všechny jeho cesty k prostředkům v rámci instance služby API Management. Připojí se k základní adrese URL koncového bodu rozhraní API zadané během vytváření instance služby a vytvoří veřejnou adresu URL pro toto rozhraní API. řetězec

Omezení:
Maximální délka = (povinné)
protokoly Popisuje, na kterých protokolech lze vyvolat operace v tomto rozhraní API. Řetězcové pole obsahující některou z těchto možností:
Http
Https (povinné)
serviceUrl Absolutní adresa URL back-endové služby, která toto rozhraní API implementuje. řetězec

Omezení:
Minimální délka = 1
Maximální délka = 1 (povinné)
subscriptionKeyParameterNames Protokoly, u kterých je rozhraní API dostupné. SubscriptionKeyParameterNamesContract
typ Typ prostředku Microsoft.ApiManagement/service/apis@2016-10-10

OAuth2AuthenticationSettingsContract

Jméno Popis Hodnota
authorizationServerId Identifikátor autorizačního serveru OAuth. řetězec
rozsah rozsah operací. řetězec

SubscriptionKeyParameterNamesContract

Jméno Popis Hodnota
záhlaví Název hlavičky klíče předplatného řetězec
dotaz Název parametru řetězce dotazu klíče předplatného řetězec