Condividi tramite

Servizio Microsoft.ApiManagement/apis 2019-12-01

  • Articolo

Definizione di risorsa Bicep

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

  • 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 risorsa

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

resource symbolicname 'Microsoft.ApiManagement/service/apis@2019-12-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'
      }
    }
    description: 'string'
    displayName: 'string'
    format: 'string'
    isCurrent: bool
    path: 'string'
    protocols: [
      'string'
    ]
    serviceUrl: 'string'
    sourceApiId: 'string'
    subscriptionKeyParameterNames: {
      header: 'string'
      query: 'string'
    }
    subscriptionRequired: bool
    type: 'string'
    value: 'string'
    wsdlSelector: {
      wsdlEndpointName: 'string'
      wsdlServiceName: 'string'
    }
  }
}

Valori delle proprietà

ApiCreateOrUpdatePropertiesOrApiContractProperties

Nome Descrizione Valore
apiRevision Descrive la revisione dell'API. Se non viene specificato alcun valore, viene creata la revisione predefinita 1 corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1
apiRevisionDescription Descrizione della revisione api. corda

Vincoli:
Lunghezza massima =
apiType Tipo di API da creare.
* http crea un'API SOAP to REST
* soap crea un'API pass-through SOAP.		 'http'
'soap'
apiVersion Indica l'identificatore della versione dell'API se l'API è con versione corda

Vincoli:
Lunghezza massima =
apiVersionDescription Descrizione della versione api. corda

Vincoli:
Lunghezza massima =
apiVersionSet Dettagli del set di versioni ApiVersionSetContractDetails
apiVersionSetId Identificatore di risorsa per l'Oggetto ApiVersionSet correlato. corda
authenticationSettings Raccolta di impostazioni di autenticazione incluse in questa API. AuthenticationSettingsContract
descrizione Descrizione dell'API. Può includere tag di formattazione HTML. corda
displayName Nome API. Deve contenere da 1 a 300 caratteri. corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1
formato Formato del contenuto in cui viene importata l'API. '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 api corrente. Bool
sentiero URL relativo che identifica in modo univoco questa API e tutti i relativi percorsi di 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 per formare un URL pubblico per questa API. corda

Vincoli:
Lunghezza massima = (obbligatorio)
Protocolli Descrive i protocolli in cui è possibile richiamare le operazioni in questa API. Matrice di stringhe contenente uno dei seguenti elementi:
'http'
'https'
serviceUrl URL assoluto del servizio back-end che implementa questa API. Non può contenere più di 2000 caratteri. corda

Vincoli:
Lunghezza massima =
sourceApiId Identificatore API dell'API di origine. corda
subscriptionKeyParameterNames Protocolli su cui è disponibile l'API. SubscriptionKeyParameterNamesContract
subscriptionRequired Specifica se è necessaria una sottoscrizione api o prodotto per l'accesso all'API. Bool
digitare Tipo di API. 'http'
'soap'
valore Valore del contenuto durante l'importazione di un'API. corda
wsdlSelector Criteri per limitare l'importazione di WSDL in un subset del documento. ApiCreateOrUpdatePropertiesWsdlSelector

ApiCreateOrUpdatePropertiesWsdlSelector

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

ApiVersionSetContractDetails

Nome Descrizione Valore
descrizione Descrizione del set di versioni dell'API. corda
Id Identificatore per il set di versioni dell'API esistente. Omettere questo valore per creare un nuovo set di versioni. corda
nome Nome visualizzato del set di versioni dell'API. corda
versionHeaderName Nome del parametro di intestazione HTTP che indica la versione dell'API se versioningScheme è impostato su header. corda
controllo delle versioniScheme Valore che determina dove si trova 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. corda

AuthenticationSettingsContract

Nome Descrizione Valore
oAuth2 Impostazioni di autenticazione OAuth2 OAuth2AuthenticationSettingsContract
openid Impostazioni di autenticazione OpenID Connect OpenIdAuthenticationSettingsContract

Microsoft.ApiManagement/service/apis

Nome Descrizione Valore
nome Nome della risorsa corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1
Pattern = ^[^*#&+:<>?]+$ (obbligatorio)
genitore 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 all'esterno della risorsa padre.		 Nome simbolico per la risorsa di tipo: servizio
proprietà Creazione di entità API delle proprietà di aggiornamento. ApiCreateOrUpdatePropertiesOrApiContractProperties

OAuth2AuthenticationSettingsContract

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

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. corda

SubscriptionKeyParameterNamesContract

Nome Descrizione Valore
intestazione Nome dell'intestazione della chiave di sottoscrizione. corda
quesito Nome del parametro della stringa di query della chiave di sottoscrizione. corda

Definizione di risorsa del modello di Resource Manager

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

  • 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 risorsa

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

{
  "type": "Microsoft.ApiManagement/service/apis",
  "apiVersion": "2019-12-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"
      }
    },
    "description": "string",
    "displayName": "string",
    "format": "string",
    "isCurrent": "bool",
    "path": "string",
    "protocols": [ "string" ],
    "serviceUrl": "string",
    "sourceApiId": "string",
    "subscriptionKeyParameterNames": {
      "header": "string",
      "query": "string"
    },
    "subscriptionRequired": "bool",
    "type": "string",
    "value": "string",
    "wsdlSelector": {
      "wsdlEndpointName": "string",
      "wsdlServiceName": "string"
    }
  }
}

Valori delle proprietà

ApiCreateOrUpdatePropertiesOrApiContractProperties

Nome Descrizione Valore
apiRevision Descrive la revisione dell'API. Se non viene specificato alcun valore, viene creata la revisione predefinita 1 corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1
apiRevisionDescription Descrizione della revisione api. corda

Vincoli:
Lunghezza massima =
apiType Tipo di API da creare.
* http crea un'API SOAP to REST
* soap crea un'API pass-through SOAP.		 'http'
'soap'
apiVersion Indica l'identificatore della versione dell'API se l'API è con versione corda

Vincoli:
Lunghezza massima =
apiVersionDescription Descrizione della versione api. corda

Vincoli:
Lunghezza massima =
apiVersionSet Dettagli del set di versioni ApiVersionSetContractDetails
apiVersionSetId Identificatore di risorsa per l'Oggetto ApiVersionSet correlato. corda
authenticationSettings Raccolta di impostazioni di autenticazione incluse in questa API. AuthenticationSettingsContract
descrizione Descrizione dell'API. Può includere tag di formattazione HTML. corda
displayName Nome API. Deve contenere da 1 a 300 caratteri. corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1
formato Formato del contenuto in cui viene importata l'API. '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 api corrente. Bool
sentiero URL relativo che identifica in modo univoco questa API e tutti i relativi percorsi di 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 per formare un URL pubblico per questa API. corda

Vincoli:
Lunghezza massima = (obbligatorio)
Protocolli Descrive i protocolli in cui è possibile richiamare le operazioni in questa API. Matrice di stringhe contenente uno dei seguenti elementi:
'http'
'https'
serviceUrl URL assoluto del servizio back-end che implementa questa API. Non può contenere più di 2000 caratteri. corda

Vincoli:
Lunghezza massima =
sourceApiId Identificatore API dell'API di origine. corda
subscriptionKeyParameterNames Protocolli su cui è disponibile l'API. SubscriptionKeyParameterNamesContract
subscriptionRequired Specifica se è necessaria una sottoscrizione api o prodotto per l'accesso all'API. Bool
digitare Tipo di API. 'http'
'soap'
valore Valore del contenuto durante l'importazione di un'API. corda
wsdlSelector Criteri per limitare l'importazione di WSDL in un subset del documento. ApiCreateOrUpdatePropertiesWsdlSelector

ApiCreateOrUpdatePropertiesWsdlSelector

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

ApiVersionSetContractDetails

Nome Descrizione Valore
descrizione Descrizione del set di versioni dell'API. corda
Id Identificatore per il set di versioni dell'API esistente. Omettere questo valore per creare un nuovo set di versioni. corda
nome Nome visualizzato del set di versioni dell'API. corda
versionHeaderName Nome del parametro di intestazione HTTP che indica la versione dell'API se versioningScheme è impostato su header. corda
controllo delle versioniScheme Valore che determina dove si trova 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. corda

AuthenticationSettingsContract

Nome Descrizione Valore
oAuth2 Impostazioni di autenticazione OAuth2 OAuth2AuthenticationSettingsContract
openid Impostazioni di autenticazione OpenID Connect OpenIdAuthenticationSettingsContract

Microsoft.ApiManagement/service/apis

Nome Descrizione Valore
apiVersion Versione dell'API '2019-12-01'
nome Nome della risorsa corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1
Pattern = ^[^*#&+:<>?]+$ (obbligatorio)
proprietà Creazione di entità API delle proprietà di aggiornamento. ApiCreateOrUpdatePropertiesOrApiContractProperties
digitare Tipo di risorsa 'Microsoft.ApiManagement/service/apis'

OAuth2AuthenticationSettingsContract

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

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. corda

SubscriptionKeyParameterNamesContract

Nome Descrizione Valore
intestazione Nome dell'intestazione della chiave di sottoscrizione. corda
quesito Nome del parametro della stringa di query della chiave di sottoscrizione. corda

Definizione di risorsa Terraform (provider AzAPI)

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

  • gruppi di risorse

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

Formato 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@2019-12-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"
        }
      }
      description = "string"
      displayName = "string"
      format = "string"
      isCurrent = bool
      path = "string"
      protocols = [
        "string"
      ]
      serviceUrl = "string"
      sourceApiId = "string"
      subscriptionKeyParameterNames = {
        header = "string"
        query = "string"
      }
      subscriptionRequired = bool
      type = "string"
      value = "string"
      wsdlSelector = {
        wsdlEndpointName = "string"
        wsdlServiceName = "string"
      }
    }
  })
}

Valori delle proprietà

ApiCreateOrUpdatePropertiesOrApiContractProperties

Nome Descrizione Valore
apiRevision Descrive la revisione dell'API. Se non viene specificato alcun valore, viene creata la revisione predefinita 1 corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1
apiRevisionDescription Descrizione della revisione api. corda

Vincoli:
Lunghezza massima =
apiType Tipo di API da creare.
* http crea un'API SOAP to REST
* soap crea un'API pass-through SOAP.		 'http'
'soap'
apiVersion Indica l'identificatore della versione dell'API se l'API è con versione corda

Vincoli:
Lunghezza massima =
apiVersionDescription Descrizione della versione api. corda

Vincoli:
Lunghezza massima =
apiVersionSet Dettagli del set di versioni ApiVersionSetContractDetails
apiVersionSetId Identificatore di risorsa per l'Oggetto ApiVersionSet correlato. corda
authenticationSettings Raccolta di impostazioni di autenticazione incluse in questa API. AuthenticationSettingsContract
descrizione Descrizione dell'API. Può includere tag di formattazione HTML. corda
displayName Nome API. Deve contenere da 1 a 300 caratteri. corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1
formato Formato del contenuto in cui viene importata l'API. '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 api corrente. Bool
sentiero URL relativo che identifica in modo univoco questa API e tutti i relativi percorsi di 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 per formare un URL pubblico per questa API. corda

Vincoli:
Lunghezza massima = (obbligatorio)
Protocolli Descrive i protocolli in cui è possibile richiamare le operazioni in questa API. Matrice di stringhe contenente uno dei seguenti elementi:
'http'
'https'
serviceUrl URL assoluto del servizio back-end che implementa questa API. Non può contenere più di 2000 caratteri. corda

Vincoli:
Lunghezza massima =
sourceApiId Identificatore API dell'API di origine. corda
subscriptionKeyParameterNames Protocolli su cui è disponibile l'API. SubscriptionKeyParameterNamesContract
subscriptionRequired Specifica se è necessaria una sottoscrizione api o prodotto per l'accesso all'API. Bool
digitare Tipo di API. 'http'
'soap'
valore Valore del contenuto durante l'importazione di un'API. corda
wsdlSelector Criteri per limitare l'importazione di WSDL in un subset del documento. ApiCreateOrUpdatePropertiesWsdlSelector

ApiCreateOrUpdatePropertiesWsdlSelector

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

ApiVersionSetContractDetails

Nome Descrizione Valore
descrizione Descrizione del set di versioni dell'API. corda
Id Identificatore per il set di versioni dell'API esistente. Omettere questo valore per creare un nuovo set di versioni. corda
nome Nome visualizzato del set di versioni dell'API. corda
versionHeaderName Nome del parametro di intestazione HTTP che indica la versione dell'API se versioningScheme è impostato su header. corda
controllo delle versioniScheme Valore che determina dove si trova 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. corda

AuthenticationSettingsContract

Nome Descrizione Valore
oAuth2 Impostazioni di autenticazione OAuth2 OAuth2AuthenticationSettingsContract
openid Impostazioni di autenticazione OpenID Connect OpenIdAuthenticationSettingsContract

Microsoft.ApiManagement/service/apis

Nome Descrizione Valore
nome Nome della risorsa corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1
Pattern = ^[^*#&+:<>?]+$ (obbligatorio)
parent_id ID della risorsa padre per questa risorsa. ID per la risorsa di tipo: servizio
proprietà Creazione di entità API delle proprietà di aggiornamento. ApiCreateOrUpdatePropertiesOrApiContractProperties
digitare Tipo di risorsa "Microsoft.ApiManagement/service/apis@2019-12-01"

OAuth2AuthenticationSettingsContract

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

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. corda

SubscriptionKeyParameterNamesContract

Nome Descrizione Valore
intestazione Nome dell'intestazione della chiave di sottoscrizione. corda
quesito Nome del parametro della stringa di query della chiave di sottoscrizione. corda