Služba Microsoft.ApiManagement/apis 2017-03-01

Článek
12/21/2024

nejnovější
2024-06-01-preview
2024-05-01
2023-09-01-preview
2023-05-01-preview
1. 3. 2023 ve verzi Preview
2022-09-01-preview
2022-08-01
2022-04-01-preview
12. 12. 2021 ve verzi Preview
2021-08-01
2021-04-01-preview
2021-01-01-preview
12. 12. 2020
2020-06-01-preview
12. 12. 2019
12. 12. 2019
1. 1. 2019
06. 6. 2018 ve verzi Preview
1. 1. 2018
03.03.2017
10. 10. 2016
2016-07-07

Definice prostředku Bicep

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

skupiny prostředků – viz příkazy nasazení 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í bicep.

resource symbolicname 'Microsoft.ApiManagement/service/apis@2017-03-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    apiRevision: 'string'
    apiVersion: 'string'
    apiVersionSet: {
      properties: {
        description: 'string'
        displayName: 'string'
        versionHeaderName: 'string'
        versioningScheme: 'string'
        versionQueryName: 'string'
      }
    }
    apiVersionSetId: 'string'
    authenticationSettings: {
      oAuth2: {
        authorizationServerId: 'string'
        scope: 'string'
      }
    }
    contentFormat: 'string'
    contentValue: 'string'
    description: 'string'
    displayName: 'string'
    path: 'string'
    protocols: [
      'string'
    ]
    serviceUrl: 'string'
    subscriptionKeyParameterNames: {
      header: 'string'
      query: 'string'
    }
    type: 'string'
    wsdlSelector: {
      wsdlEndpointName: 'string'
      wsdlServiceName: 'string'
    }
  }
}

Hodnoty vlastností

ApiCreateOrUpdatePropertiesOrApiContractProperties

Jméno	Popis	Hodnota
apiRevision	Popisuje revizi rozhraní API. Pokud není zadána žádná hodnota, vytvoří se výchozí revize 1.	řetězec Omezení: Minimální délka = 1 Maximální délka = 100
apiVersion	Označuje identifikátor verze rozhraní API, pokud je rozhraní API s verzí.	řetězec Omezení: Maximální délka = 100
apiVersionSet	Podrobnosti kontraktu sady verzí rozhraní API	ApiVersionSetContract
apiVersionSetId	Identifikátor prostředku pro související sadu ApiVersionSet.	řetězec
authenticationSettings	Kolekce nastavení ověřování, která jsou součástí tohoto rozhraní API.	AuthenticationSettingsContract
contentFormat	Formát obsahu, ve kterém se rozhraní API importuje	Swagger-json swagger-link-json Wadl-link-json Wadl-xml Wsdl Wsdl-link
contentValue	Hodnota obsahu při importu rozhraní API	řetězec
popis	Popis rozhraní API Může obsahovat značky formátování HTML.	řetězec
displayName	Název rozhraní API	řetězec Omezení: Minimální délka = 1 Maximální délka = 300
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 = 400 (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
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 = 2000
subscriptionKeyParameterNames	Protokoly, u kterých je rozhraní API dostupné.	SubscriptionKeyParameterNamesContract
typ	Typ rozhraní API	Http "soap"
wsdlSelector	Kritéria pro omezení importu WSDL na podmnožinu dokumentu	ApiCreateOrUpdatePropertiesWsdlSelector

ApiCreateOrUpdatePropertiesWsdlSelector

Jméno	Popis	Hodnota
wsdlEndpointName	Název koncového bodu (portu) pro import z WSDL	řetězec
wsdlServiceName	Název služby, která se má importovat z WSDL	řetězec

ApiVersionSetContract

Jméno	Popis	Hodnota
vlastnosti	Vlastnosti sady verzí rozhraní API	apiVersionSetContractProperties

ApiVersionSetContractProperties

Jméno	Popis	Hodnota
popis	Popis sady verzí rozhraní API	řetězec
displayName	Název sady verzí rozhraní API	řetězec Omezení: Minimální délka = 1 Maximální délka = 100 (povinné)
versionHeaderName	Název parametru hlavičky HTTP, který označuje verzi rozhraní API, pokud je vlastnost versioningScheme nastavená na `header`.	řetězec Omezení: Minimální délka = 1 Maximální délka = 100
versioningScheme	Hodnota, která určuje, kde se bude identifikátor verze rozhraní API nacházet v požadavku HTTP.	Hlavička Dotaz Segment (povinné)
versionQueryName	Název parametru dotazu, který označuje verzi rozhraní API, pokud je správa verzí nastavena na `query`.	řetězec Omezení: Minimální délka = 1 Maximální délka = 100

AuthenticationSettingsContract

Jméno	Popis	Hodnota
oAuth2	Nastavení ověřování OAuth2	OAuth2AuthenticationSettingsContract

Microsoft.ApiManagement/service/apis

Jméno	Popis	Hodnota
Jméno	Název prostředku	řetězec Omezení: Minimální délka = 1 Maximální délka = 256 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
vlastnosti	Entita rozhraní API vytváří vlastnosti aktualizace.	ApiCreateOrUpdatePropertiesOrApiContractPropertProperties

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í:

skupiny prostředků – viz příkazy nasazení 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í JSON.

{
  "type": "Microsoft.ApiManagement/service/apis",
  "apiVersion": "2017-03-01",
  "name": "string",
  "properties": {
    "apiRevision": "string",
    "apiVersion": "string",
    "apiVersionSet": {
      "properties": {
        "description": "string",
        "displayName": "string",
        "versionHeaderName": "string",
        "versioningScheme": "string",
        "versionQueryName": "string"
      }
    },
    "apiVersionSetId": "string",
    "authenticationSettings": {
      "oAuth2": {
        "authorizationServerId": "string",
        "scope": "string"
      }
    },
    "contentFormat": "string",
    "contentValue": "string",
    "description": "string",
    "displayName": "string",
    "path": "string",
    "protocols": [ "string" ],
    "serviceUrl": "string",
    "subscriptionKeyParameterNames": {
      "header": "string",
      "query": "string"
    },
    "type": "string",
    "wsdlSelector": {
      "wsdlEndpointName": "string",
      "wsdlServiceName": "string"
    }
  }
}

Hodnoty vlastností

ApiCreateOrUpdatePropertiesOrApiContractProperties

Jméno	Popis	Hodnota
apiRevision	Popisuje revizi rozhraní API. Pokud není zadána žádná hodnota, vytvoří se výchozí revize 1.	řetězec Omezení: Minimální délka = 1 Maximální délka = 100
apiVersion	Označuje identifikátor verze rozhraní API, pokud je rozhraní API s verzí.	řetězec Omezení: Maximální délka = 100
apiVersionSet	Podrobnosti kontraktu sady verzí rozhraní API	ApiVersionSetContract
apiVersionSetId	Identifikátor prostředku pro související sadu ApiVersionSet.	řetězec
authenticationSettings	Kolekce nastavení ověřování, která jsou součástí tohoto rozhraní API.	AuthenticationSettingsContract
contentFormat	Formát obsahu, ve kterém se rozhraní API importuje	Swagger-json swagger-link-json Wadl-link-json Wadl-xml Wsdl Wsdl-link
contentValue	Hodnota obsahu při importu rozhraní API	řetězec
popis	Popis rozhraní API Může obsahovat značky formátování HTML.	řetězec
displayName	Název rozhraní API	řetězec Omezení: Minimální délka = 1 Maximální délka = 300
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 = 400 (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
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 = 2000
subscriptionKeyParameterNames	Protokoly, u kterých je rozhraní API dostupné.	SubscriptionKeyParameterNamesContract
typ	Typ rozhraní API	Http "soap"
wsdlSelector	Kritéria pro omezení importu WSDL na podmnožinu dokumentu	ApiCreateOrUpdatePropertiesWsdlSelector

ApiCreateOrUpdatePropertiesWsdlSelector

Jméno	Popis	Hodnota
wsdlEndpointName	Název koncového bodu (portu) pro import z WSDL	řetězec
wsdlServiceName	Název služby, která se má importovat z WSDL	řetězec

ApiVersionSetContract

Jméno	Popis	Hodnota
vlastnosti	Vlastnosti sady verzí rozhraní API	apiVersionSetContractProperties

ApiVersionSetContractProperties

Jméno	Popis	Hodnota
popis	Popis sady verzí rozhraní API	řetězec
displayName	Název sady verzí rozhraní API	řetězec Omezení: Minimální délka = 1 Maximální délka = 100 (povinné)
versionHeaderName	Název parametru hlavičky HTTP, který označuje verzi rozhraní API, pokud je vlastnost versioningScheme nastavená na `header`.	řetězec Omezení: Minimální délka = 1 Maximální délka = 100
versioningScheme	Hodnota, která určuje, kde se bude identifikátor verze rozhraní API nacházet v požadavku HTTP.	Hlavička Dotaz Segment (povinné)
versionQueryName	Název parametru dotazu, který označuje verzi rozhraní API, pokud je správa verzí nastavena na `query`.	řetězec Omezení: Minimální délka = 1 Maximální délka = 100

AuthenticationSettingsContract

Jméno	Popis	Hodnota
oAuth2	Nastavení ověřování OAuth2	OAuth2AuthenticationSettingsContract

Microsoft.ApiManagement/service/apis

Jméno	Popis	Hodnota
apiVersion	Verze rozhraní API	'2017-03-01'
Jméno	Název prostředku	řetězec Omezení: Minimální délka = 1 Maximální délka = 256 Model = `^[^*#&+:<>?]+$` (povinné)
vlastnosti	Entita rozhraní API vytváří vlastnosti aktualizace.	ApiCreateOrUpdatePropertiesOrApiContractPropertProperties
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@2017-03-01"
  name = "string"
  body = jsonencode({
    properties = {
      apiRevision = "string"
      apiVersion = "string"
      apiVersionSet = {
        properties = {
          description = "string"
          displayName = "string"
          versionHeaderName = "string"
          versioningScheme = "string"
          versionQueryName = "string"
        }
      }
      apiVersionSetId = "string"
      authenticationSettings = {
        oAuth2 = {
          authorizationServerId = "string"
          scope = "string"
        }
      }
      contentFormat = "string"
      contentValue = "string"
      description = "string"
      displayName = "string"
      path = "string"
      protocols = [
        "string"
      ]
      serviceUrl = "string"
      subscriptionKeyParameterNames = {
        header = "string"
        query = "string"
      }
      type = "string"
      wsdlSelector = {
        wsdlEndpointName = "string"
        wsdlServiceName = "string"
      }
    }
  })
}

Hodnoty vlastností

ApiCreateOrUpdatePropertiesOrApiContractProperties

Jméno	Popis	Hodnota
apiRevision	Popisuje revizi rozhraní API. Pokud není zadána žádná hodnota, vytvoří se výchozí revize 1.	řetězec Omezení: Minimální délka = 1 Maximální délka = 100
apiVersion	Označuje identifikátor verze rozhraní API, pokud je rozhraní API s verzí.	řetězec Omezení: Maximální délka = 100
apiVersionSet	Podrobnosti kontraktu sady verzí rozhraní API	ApiVersionSetContract
apiVersionSetId	Identifikátor prostředku pro související sadu ApiVersionSet.	řetězec
authenticationSettings	Kolekce nastavení ověřování, která jsou součástí tohoto rozhraní API.	AuthenticationSettingsContract
contentFormat	Formát obsahu, ve kterém se rozhraní API importuje	Swagger-json swagger-link-json Wadl-link-json Wadl-xml Wsdl Wsdl-link
contentValue	Hodnota obsahu při importu rozhraní API	řetězec
popis	Popis rozhraní API Může obsahovat značky formátování HTML.	řetězec
displayName	Název rozhraní API	řetězec Omezení: Minimální délka = 1 Maximální délka = 300
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 = 400 (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
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 = 2000
subscriptionKeyParameterNames	Protokoly, u kterých je rozhraní API dostupné.	SubscriptionKeyParameterNamesContract
typ	Typ rozhraní API	Http "soap"
wsdlSelector	Kritéria pro omezení importu WSDL na podmnožinu dokumentu	ApiCreateOrUpdatePropertiesWsdlSelector

ApiCreateOrUpdatePropertiesWsdlSelector

Jméno	Popis	Hodnota
wsdlEndpointName	Název koncového bodu (portu) pro import z WSDL	řetězec
wsdlServiceName	Název služby, která se má importovat z WSDL	řetězec

ApiVersionSetContract

Jméno	Popis	Hodnota
vlastnosti	Vlastnosti sady verzí rozhraní API	apiVersionSetContractProperties

ApiVersionSetContractProperties

Jméno	Popis	Hodnota
popis	Popis sady verzí rozhraní API	řetězec
displayName	Název sady verzí rozhraní API	řetězec Omezení: Minimální délka = 1 Maximální délka = 100 (povinné)
versionHeaderName	Název parametru hlavičky HTTP, který označuje verzi rozhraní API, pokud je vlastnost versioningScheme nastavená na `header`.	řetězec Omezení: Minimální délka = 1 Maximální délka = 100
versioningScheme	Hodnota, která určuje, kde se bude identifikátor verze rozhraní API nacházet v požadavku HTTP.	Hlavička Dotaz Segment (povinné)
versionQueryName	Název parametru dotazu, který označuje verzi rozhraní API, pokud je správa verzí nastavena na `query`.	řetězec Omezení: Minimální délka = 1 Maximální délka = 100

AuthenticationSettingsContract

Jméno	Popis	Hodnota
oAuth2	Nastavení ověřování OAuth2	OAuth2AuthenticationSettingsContract

Microsoft.ApiManagement/service/apis

Jméno	Popis	Hodnota
Jméno	Název prostředku	řetězec Omezení: Minimální délka = 1 Maximální délka = 256 Model = `^[^*#&+:<>?]+$` (povinné)
parent_id	ID prostředku, který je nadřazený pro tento prostředek.	ID prostředku typu: služby
vlastnosti	Entita rozhraní API vytváří vlastnosti aktualizace.	ApiCreateOrUpdatePropertiesOrApiContractPropertProperties
typ	Typ prostředku	Microsoft.ApiManagement/service/apis@2017-03-01

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

Sdílet prostřednictvím

Služba Microsoft.ApiManagement/apis 2017-03-01

Definice prostředku Bicep

Formát prostředku

Hodnoty vlastností

ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiCreateOrUpdatePropertiesWsdlSelector

ApiVersionSetContract

ApiVersionSetContractProperties

AuthenticationSettingsContract

Microsoft.ApiManagement/service/apis

OAuth2AuthenticationSettingsContract

SubscriptionKeyParameterNamesContract

Definice prostředku šablony ARM

Formát prostředku

Hodnoty vlastností

ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiCreateOrUpdatePropertiesWsdlSelector

ApiVersionSetContract

ApiVersionSetContractProperties

AuthenticationSettingsContract

Microsoft.ApiManagement/service/apis

OAuth2AuthenticationSettingsContract

SubscriptionKeyParameterNamesContract

Definice prostředku Terraformu (poskytovatel AzAPI)

Formát prostředku

Hodnoty vlastností

ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiCreateOrUpdatePropertiesWsdlSelector

ApiVersionSetContract

ApiVersionSetContractProperties

AuthenticationSettingsContract

Microsoft.ApiManagement/service/apis

OAuth2AuthenticationSettingsContract

SubscriptionKeyParameterNamesContract

Váš názor

Další materiály