Servizio Microsoft.ApiManagement/apis 2022-04-01-preview

Articolo
01/18/2024

Definizione di risorsa Bicep

Il tipo di risorsa service/apis può essere distribuito con operazioni destinate:

Gruppi di risorse - Vedere i comandi di distribuzione dei gruppi di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere Log delle modifiche.

Formato di risorsa

Per creare una risorsa Microsoft.ApiManagement/service/apis, aggiungere il bicep seguente al modello.

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

Valori delle proprietà

service/apis

Nome	Descrizione	valore
name	Nome della risorsa Vedere come impostare nomi e tipi per le risorse figlio in Bicep.	stringa (obbligatorio) Limite di caratteri: 1-80 Caratteri validi: Caratteri alfanumerici e trattini. Inizia con la lettera e termina con alfanumerico.
padre	In Bicep è possibile specificare la risorsa padre per una risorsa figlio. È necessario aggiungere questa proprietà solo quando la risorsa figlio viene dichiarata all'esterno della risorsa padre. Per altre informazioni, vedere Risorsa figlio esterna alla risorsa padre.	Nome simbolico per la risorsa di tipo: servizio
properties	Creazione di entità API di proprietà di aggiornamento.	ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiCreateOrUpdatePropertiesOrApiContractProperties

Nome	Descrizione	Valore
apiRevision	Descrive la revisione dell'API. Se non viene specificato alcun valore, viene creata la revisione predefinita 1	string
apiRevisionDescription	Descrizione della revisione dell'API.	string
apiType	Tipo di API da creare. * `http` crea un'API REST * `soap` crea un'API pass-through SOAP * `websocket` crea l'API Websocket * `graphql` crea l'API GraphQL.	'graphql' 'http' 'soap' 'websocket'
apiVersion	Indica l'identificatore della versione dell'API se l'API è con versione	string
apiVersionDescription	Descrizione della versione dell'API.	string
apiVersionSet	Dettagli del set di versioni	ApiVersionSetContractDetails
apiVersionSetId	Identificatore di risorsa per l'ApiVersionSet correlato.	string
authenticationSettings	Raccolta di impostazioni di autenticazione incluse in questa API.	AuthenticationSettingsContract
contact	Informazioni di contatto per l'API.	ApiContactInformation
description	Descrizione dell'API. Può includere tag di formattazione HTML.	string
displayName	Nome API. Deve contenere da 1 a 300 caratteri.	string
format	Formato del contenuto in cui viene importata l'API.	'graphql-link' 'openapi' 'openapi+json' 'openapi+json-link' 'openapi-link' 'swagger-json' 'swagger-link-json' 'wadl-link-json' 'wadl-xml' 'wsdl' 'wsdl-link'
isCurrent	Indica se la revisione dell'API è la revisione dell'API corrente.	bool
license	Informazioni sulla licenza per l'API.	ApiLicenseInformation
path	URL relativo che identifica in modo univoco questa API e tutti i relativi percorsi delle risorse all'interno dell'istanza del servizio Gestione API. Viene aggiunto all'URL di base dell'endpoint API specificato durante la creazione dell'istanza del servizio in modo da formare un URL pubblico per questa API.	stringa (obbligatoria)
protocols	Descrive su quali protocolli è possibile richiamare le operazioni in questa API.	Matrice di stringhe contenente uno qualsiasi di: 'http' 'https' 'ws' 'wss'
serviceUrl	URL assoluto del servizio back-end che implementa questa API. Impossibile contenere più di 2000 caratteri.	string
sourceApiId	Identificatore API dell'API di origine.	string
subscriptionKeyParameterNames	Protocolli su cui è disponibile l'API.	SubscriptionKeyParameterNamesContract
subscriptionRequired	Specifica se è necessaria una sottoscrizione API o Product per l'accesso all'API.	bool
terminiOfServiceUrl	URL delle condizioni di servizio per l'API. DEVE essere nel formato di un URL.	string
translateRequiredQueryParameters	Strategia di conversione dei parametri di query necessari in quelli del modello. Per impostazione predefinita, il valore 'template'. Valori possibili: 'template', 'query'	'query' 'template'
tipo	Tipo di API.	'graphql' 'http' 'soap' 'websocket'
Valore	Valore del contenuto durante l'importazione di un'API.	string
wsdlSelector	Criteri per limitare l'importazione di WSDL a un subset del documento.	ApiCreateOrUpdatePropertiesWsdlSelector

ApiVersionSetContractDetails

Nome	Descrizione	Valore
description	Descrizione del set di versioni dell'API.	string
id	Identificatore per il set di versioni DELL'API esistente. Omettere questo valore per creare un nuovo set di versioni.	string
name	Nome visualizzato del set di versioni dell'API.	string
versionHeaderName	Nome del parametro di intestazione HTTP che indica la versione DELL'API se il controllo delle versioniScheme è impostato su `header`.	string
controllo delle versioniScheme	Valore che determina dove si trova l'identificatore della versione API in una richiesta HTTP.	'Intestazione' 'Query' 'Segmento'
versionQueryName	Nome del parametro di query che indica la versione DELL'API se il controllo delle versioniScheme è impostato su `query`.	string

AuthenticationSettingsContract

Nome	Descrizione	Valore
oAuth2	Impostazioni di autenticazione OAuth2	OAuth2AuthenticationSettingsContract
oAuth2AuthenticationSettings	Raccolta di impostazioni di autenticazione OAuth2 incluse in questa API.	OAuth2AuthenticationSettingsContract[]
openid	Impostazioni di autenticazione openID Connect	OpenIdAuthenticationSettingsContract
openidAuthenticationSettings	Raccolta di impostazioni di autenticazione Open ID Connect incluse in questa API.	OpenIdAuthenticationSettingsContract[]

OAuth2AuthenticationSettingsContract

Nome	Descrizione	Valore
authorizationServerId	Identificatore del server di autorizzazione OAuth.	string
ambito	ambito operazioni.	string

OpenIdAuthenticationSettingsContract

Nome	Descrizione	Valore
bearerTokenSendingMethods	Come inviare il token al server.	Matrice di stringhe contenente uno qualsiasi di: 'authorizationHeader' 'query'
openidProviderId	Identificatore del server di autorizzazione OAuth.	string

ApiContactInformation

Nome	Descrizione	Valore
email	Indirizzo di posta elettronica della persona o dell'organizzazione di contatto. DEVE essere nel formato di un indirizzo di posta elettronica	string
name	Nome di identificazione della persona di contatto/organizzazione	string
url	URL che punta alle informazioni di contatto. DEVE essere nel formato di un URL	string

ApiLicenseInformation

Nome	Descrizione	valore
name	Nome della licenza usato per l'API	string
url	URL della licenza usata per l'API. DEVE essere nel formato di un URL	string

SubscriptionKeyParameterNamesContract

Nome	Descrizione	Valore
header	Nome dell'intestazione della chiave di sottoscrizione.	string
query	Nome del parametro della stringa di query della chiave di sottoscrizione.	string

ApiCreateOrUpdatePropertiesWsdlSelector

Nome	Descrizione	Valore
wsdlEndpointName	Nome dell'endpoint(porta) da importare da WSDL	string
wsdlServiceName	Nome del servizio da importare da WSDL	string

Modelli di avvio rapido

I modelli di avvio rapido seguenti distribuiscono questo tipo di risorsa.

Modello	Descrizione
Creare un'istanza di Gestione API e tutte le relative risorse secondarie tramite un modello	Questo modello illustra come creare un servizio di Gestione API e configurare le sottoentità
Creare Frontdoor di Azure davanti ad Azure Gestione API	Questo esempio illustra come usare Frontdoor di Azure come servizio di bilanciamento del carico globale davanti ad Azure Gestione API.

Definizione della risorsa modello di Resource Manager

Il tipo di risorsa service/apis può essere distribuito con operazioni destinate:

Gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato di risorsa

Per creare una risorsa Microsoft.ApiManagement/service/apis, aggiungere il codice JSON seguente al modello.

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

Valori delle proprietà

service/apis

Nome	Descrizione	Valore
tipo	Tipo di risorsa	'Microsoft.ApiManagement/service/apis'
apiVersion	Versione dell'API risorsa	'2022-04-01-preview'
name	Nome della risorsa Vedere come impostare nomi e tipi per le risorse figlio nei modelli di RESOURCE JSON.	stringa (obbligatoria) Limite di caratteri: 1-80 Caratteri validi: Caratteri alfanumerici e trattini. Inizia con la lettera e termina con alfanumerico.
properties	Entità API create di proprietà di aggiornamento.	ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiCreateOrUpdatePropertiesOrApiContractProperties

Nome	Descrizione	Valore
apiRevision	Descrive la revisione dell'API. Se non viene specificato alcun valore, viene creata la revisione predefinita 1	string
apiRevisionDescription	Descrizione della revisione DELL'API.	string
apiType	Tipo di API da creare. * `http` crea un'API REST * `soap` crea un'API pass-through SOAP * `websocket` crea l'API websocket * `graphql` crea l'API GraphQL.	'graphql' 'http' 'soap' 'websocket'
apiVersion	Indica l'identificatore della versione dell'API se l'API è in versione	string
apiVersionDescription	Descrizione della versione dell'API.	string
apiVersionSet	Dettagli del set di versioni	ApiVersionSetContractDetails
apiVersionSetId	Identificatore di risorsa per ApiVersionSet correlato.	string
authenticationSettings	Raccolta di impostazioni di autenticazione incluse in questa API.	AuthenticationSettingsContract
contact	Informazioni di contatto per l'API.	ApiContactInformation
description	Descrizione dell'API. Può includere tag di formattazione HTML.	string
displayName	Nome API. Deve essere lungo da 1 a 300 caratteri.	string
format	Formato del contenuto in cui viene importata l'API.	'graphql-link' 'openapi' 'openapi+json' 'openapi+json-link' 'openapi-link' 'swagger-json' 'swagger-link-json' 'wadl-link-json' 'wadl-xml' 'wsdl' 'wsdl-link'
isCurrent	Indica se la revisione dell'API è la revisione dell'API corrente.	bool
license	Informazioni sulla licenza per l'API.	ApiLicenseInformation
path	URL relativo che identifica in modo univoco questa API e tutti i relativi percorsi delle risorse all'interno dell'istanza del servizio Gestione API. Viene aggiunto all'URL di base dell'endpoint API specificato durante la creazione dell'istanza del servizio in modo da formare un URL pubblico per questa API.	stringa (obbligatoria)
protocols	Descrive su quali protocolli è possibile richiamare le operazioni in questa API.	Matrice di stringhe contenente uno qualsiasi di: 'http' 'https' 'ws' 'wss'
serviceUrl	URL assoluto del servizio back-end che implementa questa API. Impossibile contenere più di 2000 caratteri.	string
sourceApiId	Identificatore API dell'API di origine.	string
subscriptionKeyParameterNames	Protocolli su cui è disponibile l'API.	SubscriptionKeyParameterNamesContract
subscriptionRequired	Specifica se è necessaria una sottoscrizione API o Product per l'accesso all'API.	bool
terminiOfServiceUrl	URL delle condizioni di servizio per l'API. DEVE essere nel formato di un URL.	string
translateRequiredQueryParameters	Strategia di conversione dei parametri di query necessari in quelli del modello. Per impostazione predefinita, il valore 'template'. Valori possibili: 'template', 'query'	'query' 'template'
tipo	Tipo di API.	'graphql' 'http' 'soap' 'websocket'
Valore	Valore del contenuto durante l'importazione di un'API.	string
wsdlSelector	Criteri per limitare l'importazione di WSDL a un subset del documento.	ApiCreateOrUpdatePropertiesWsdlSelector

ApiVersionSetContractDetails

Nome	Descrizione	Valore
description	Descrizione del set di versioni dell'API.	string
id	Identificatore per il set di versioni dell'API esistente. Omettere questo valore per creare un nuovo set di versioni.	string
name	Nome visualizzato del set di versioni dell'API.	string
versionHeaderName	Nome del parametro di intestazione HTTP che indica la versione dell'API se versioningScheme è impostato su `header`.	string
controllo delle versioniScheme	Valore che determina dove si troverà l'identificatore della versione dell'API in una richiesta HTTP.	'Header' 'Query' 'Segment'
versionQueryName	Nome del parametro di query che indica la versione dell'API se versioningScheme è impostato su `query`.	string

AuthenticationSettingsContract

Nome	Descrizione	Valore
oAuth2	Impostazioni di autenticazione OAuth2	OAuth2AuthenticationSettingsContract
oAuth2AuthenticationSettings	Raccolta di impostazioni di autenticazione OAuth2 incluse in questa API.	OAuth2AuthenticationSettingsContract[]
openid	Impostazioni di autenticazione openID Connect	OpenIdAuthenticationSettingsContract
openidAuthenticationSettings	Raccolta di impostazioni di autenticazione open ID Connect incluse in questa API.	OpenIdAuthenticationSettingsContract[]

OAuth2AuthenticationSettingsContract

Nome	Descrizione	Valore
authorizationServerId	Identificatore del server di autorizzazione OAuth.	string
ambito	ambito delle operazioni.	string

OpenIdAuthenticationSettingsContract

Nome	Descrizione	Valore
bearerTokenSendingMethods	Come inviare il token al server.	Matrice di stringhe contenente uno dei seguenti elementi: 'authorizationHeader' 'query'
openidProviderId	Identificatore del server di autorizzazione OAuth.	string

ApiContactInformation

Nome	Descrizione	Valore
email	Indirizzo di posta elettronica della persona o dell'organizzazione di contatto. DEVE essere nel formato di un indirizzo di posta elettronica	string
name	Nome di identificazione della persona o dell'organizzazione di contatto	string
url	URL che punta alle informazioni di contatto. DEVE essere nel formato di un URL	string

ApiLicenseInformation

Nome	Descrizione	valore
name	Nome della licenza usato per l'API	string
url	URL della licenza usata per l'API. DEVE essere nel formato di un URL	string

SubscriptionKeyParameterNamesContract

Nome	Descrizione	Valore
header	Nome dell'intestazione della chiave di sottoscrizione.	string
query	Nome del parametro della stringa di query della chiave di sottoscrizione.	string

ApiCreateOrUpdatePropertiesWsdlSelector

Nome	Descrizione	Valore
wsdlEndpointName	Nome dell'endpoint(porta) da importare da WSDL	string
wsdlServiceName	Nome del servizio da importare da WSDL	string

Modelli di avvio rapido

I modelli di avvio rapido seguenti distribuiscono questo tipo di risorsa.

Modello	Descrizione
Creare un'istanza di Gestione API e tutte le relative risorse secondarie tramite un modello	Questo modello illustra come creare un servizio di Gestione API e configurare le sottoentità
Creare Frontdoor di Azure davanti ad Azure Gestione API	Questo esempio illustra come usare Frontdoor di Azure come servizio di bilanciamento del carico globale davanti ad Azure Gestione API.

Definizione della risorsa Terraform (provider AzAPI)

Il tipo di risorsa service/apis può essere distribuito con operazioni destinate:

Gruppi di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato di risorsa

Per creare una risorsa Microsoft.ApiManagement/service/apis, aggiungere il codice Terraform seguente al modello.

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

Valori delle proprietà

service/apis

Nome	Descrizione	Valore
tipo	Tipo di risorsa	"Microsoft.ApiManagement/service/apis@2022-04-01-preview"
name	Nome della risorsa	stringa (obbligatoria) Limite di caratteri: 1-80 Caratteri validi: Caratteri alfanumerici e trattini. Inizia con la lettera e termina con alfanumerico.
parent_id	ID della risorsa padre per questa risorsa.	ID per la risorsa di tipo: servizio
properties	Entità API create di proprietà di aggiornamento.	ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiCreateOrUpdatePropertiesOrApiContractProperties

Nome	Descrizione	Valore
apiRevision	Descrive la revisione dell'API. Se non viene specificato alcun valore, viene creata la revisione predefinita 1	string
apiRevisionDescription	Descrizione della revisione DELL'API.	string
apiType	Tipo di API da creare. * `http` crea un'API REST * `soap` crea un'API pass-through SOAP * `websocket` crea l'API websocket * `graphql` crea l'API GraphQL.	"graphql" "http" "soap" "websocket"
apiVersion	Indica l'identificatore della versione dell'API se l'API è in versione	string
apiVersionDescription	Descrizione della versione dell'API.	string
apiVersionSet	Dettagli del set di versioni	ApiVersionSetContractDetails
apiVersionSetId	Identificatore di risorsa per ApiVersionSet correlato.	string
authenticationSettings	Raccolta di impostazioni di autenticazione incluse in questa API.	AuthenticationSettingsContract
contact	Informazioni di contatto per l'API.	ApiContactInformation
description	Descrizione dell'API. Può includere tag di formattazione HTML.	string
displayName	Nome API. Deve essere lungo da 1 a 300 caratteri.	string
format	Formato del contenuto in cui viene importata l'API.	"graphql-link" "openapi" "openapi+json" "openapi+json-link" "openapi-link" "swagger-json" "swagger-link-json" "wadl-link-json" "wadl-xml" "wsdl" "wsdl-link"
isCurrent	Indica se la revisione dell'API è la revisione dell'API corrente.	bool
license	Informazioni sulla licenza per l'API.	ApiLicenseInformation
path	URL relativo che identifica in modo univoco questa API e tutti i relativi percorsi delle risorse all'interno dell'istanza del servizio Gestione API. Viene aggiunto all'URL di base dell'endpoint API specificato durante la creazione dell'istanza del servizio in modo da formare un URL pubblico per questa API.	stringa (obbligatoria)
protocols	Descrive su quali protocolli è possibile richiamare le operazioni in questa API.	Matrice di stringhe contenente uno qualsiasi di: "http" "https" "ws" "wss"
serviceUrl	URL assoluto del servizio back-end che implementa questa API. Impossibile contenere più di 2000 caratteri.	string
sourceApiId	Identificatore API dell'API di origine.	string
subscriptionKeyParameterNames	Protocolli su cui è disponibile l'API.	SubscriptionKeyParameterNamesContract
subscriptionRequired	Specifica se è necessaria una sottoscrizione API o Product per l'accesso all'API.	bool
terminiOfServiceUrl	URL delle condizioni di servizio per l'API. DEVE essere nel formato di un URL.	string
translateRequiredQueryParameters	Strategia di conversione dei parametri di query necessari in quelli del modello. Per impostazione predefinita, il valore 'template'. Valori possibili: 'template', 'query'	"query" "modello"
tipo	Tipo di API.	"graphql" "http" "soap" "websocket"
Valore	Valore del contenuto durante l'importazione di un'API.	string
wsdlSelector	Criteri per limitare l'importazione di WSDL a un subset del documento.	ApiCreateOrUpdatePropertiesWsdlSelector

ApiVersionSetContractDetails

Nome	Descrizione	Valore
description	Descrizione del set di versioni dell'API.	string
id	Identificatore per il set di versioni DELL'API esistente. Omettere questo valore per creare un nuovo set di versioni.	string
name	Nome visualizzato del set di versioni dell'API.	string
versionHeaderName	Nome del parametro di intestazione HTTP che indica la versione DELL'API se il controllo delle versioniScheme è impostato su `header`.	string
controllo delle versioniScheme	Valore che determina dove si trova l'identificatore della versione API in una richiesta HTTP.	"Intestazione" "Query" "Segmento"
versionQueryName	Nome del parametro di query che indica la versione DELL'API se il controllo delle versioniScheme è impostato su `query`.	string

AuthenticationSettingsContract

Nome	Descrizione	Valore
oAuth2	Impostazioni di autenticazione OAuth2	OAuth2AuthenticationSettingsContract
oAuth2AuthenticationSettings	Raccolta di impostazioni di autenticazione OAuth2 incluse in questa API.	OAuth2AuthenticationSettingsContract[]
openid	Impostazioni di autenticazione openID Connect	OpenIdAuthenticationSettingsContract
openidAuthenticationSettings	Raccolta di impostazioni di autenticazione open ID Connect incluse in questa API.	OpenIdAuthenticationSettingsContract[]

OAuth2AuthenticationSettingsContract

Nome	Descrizione	Valore
authorizationServerId	Identificatore del server di autorizzazione OAuth.	string
ambito	ambito delle operazioni.	string

OpenIdAuthenticationSettingsContract

Nome	Descrizione	Valore
bearerTokenSendingMethods	Come inviare il token al server.	Matrice di stringhe contenente uno dei seguenti elementi: "authorizationHeader" "query"
openidProviderId	Identificatore del server di autorizzazione OAuth.	string

ApiContactInformation

Nome	Descrizione	Valore
email	Indirizzo di posta elettronica della persona o dell'organizzazione di contatto. DEVE essere nel formato di un indirizzo di posta elettronica	string
name	Nome di identificazione della persona o dell'organizzazione di contatto	string
url	URL che punta alle informazioni di contatto. DEVE essere nel formato di un URL	string

ApiLicenseInformation

Nome	Descrizione	valore
name	Nome della licenza usato per l'API	string
url	URL della licenza usata per l'API. DEVE essere nel formato di un URL	string

SubscriptionKeyParameterNamesContract

Nome	Descrizione	Valore
header	Nome dell'intestazione della chiave di sottoscrizione.	string
query	Nome del parametro della stringa di query della chiave di sottoscrizione.	string

ApiCreateOrUpdatePropertiesWsdlSelector

Nome	Descrizione	Valore
wsdlEndpointName	Nome dell'endpoint(porta) da importare da WSDL	string
wsdlServiceName	Nome del servizio da importare da WSDL	string

Condividi tramite

Servizio Microsoft.ApiManagement/apis 2022-04-01-preview

Definizione di risorsa Bicep

Formato di risorsa

Valori delle proprietà

service/apis

ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiVersionSetContractDetails

AuthenticationSettingsContract

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

ApiContactInformation

ApiLicenseInformation

SubscriptionKeyParameterNamesContract

ApiCreateOrUpdatePropertiesWsdlSelector

Modelli di avvio rapido

Definizione della risorsa modello di Resource Manager

Formato di risorsa

Valori delle proprietà

service/apis

ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiVersionSetContractDetails

AuthenticationSettingsContract

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

ApiContactInformation

ApiLicenseInformation

SubscriptionKeyParameterNamesContract

ApiCreateOrUpdatePropertiesWsdlSelector

Modelli di avvio rapido

Definizione della risorsa Terraform (provider AzAPI)

Formato di risorsa

Valori delle proprietà

service/apis

ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiVersionSetContractDetails

AuthenticationSettingsContract

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

ApiContactInformation

ApiLicenseInformation

SubscriptionKeyParameterNamesContract

ApiCreateOrUpdatePropertiesWsdlSelector

Risorse aggiuntive