Condividi tramite

Servizio Microsoft.ApiManagement/apis 2016-10-10

  • 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@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'
  }
}

Valori delle proprietà

AuthenticationSettingsContract

Nome Descrizione Valore
oAuth2 Dettagli delle impostazioni di autenticazione OAuth2 dell'API. OAuth2AuthenticationSettingsContract

Microsoft.ApiManagement/service/apis

Nome Descrizione Valore
authenticationSettings Raccolta di impostazioni di autenticazione incluse in questa API. AuthenticationSettingsContract
descrizione Descrizione dell'API. Può includere tag di formattazione HTML. corda
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
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' (obbligatorio)
serviceUrl URL assoluto del servizio back-end che implementa questa API. corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1 (obbligatorio)
subscriptionKeyParameterNames Protocolli su cui è disponibile l'API. SubscriptionKeyParameterNamesContract

OAuth2AuthenticationSettingsContract

Nome Descrizione Valore
authorizationServerId Identificatore del server di autorizzazione OAuth. corda
portata ambito delle operazioni. 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": "2016-10-10",
  "name": "string",
  "authenticationSettings": {
    "oAuth2": {
      "authorizationServerId": "string",
      "scope": "string"
    }
  },
  "description": "string",
  "path": "string",
  "protocols": [ "string" ],
  "serviceUrl": "string",
  "subscriptionKeyParameterNames": {
    "header": "string",
    "query": "string"
  }
}

Valori delle proprietà

AuthenticationSettingsContract

Nome Descrizione Valore
oAuth2 Dettagli delle impostazioni di autenticazione OAuth2 dell'API. OAuth2AuthenticationSettingsContract

Microsoft.ApiManagement/service/apis

Nome Descrizione Valore
apiVersion Versione dell'API '2016-10-10'
authenticationSettings Raccolta di impostazioni di autenticazione incluse in questa API. AuthenticationSettingsContract
descrizione Descrizione dell'API. Può includere tag di formattazione HTML. corda
nome Nome della risorsa corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1
Pattern = ^[^*#&+:<>?]+$ (obbligatorio)
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' (obbligatorio)
serviceUrl URL assoluto del servizio back-end che implementa questa API. corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1 (obbligatorio)
subscriptionKeyParameterNames Protocolli su cui è disponibile l'API. SubscriptionKeyParameterNamesContract
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

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@2016-10-10"
  name = "string"
  authenticationSettings = {
    oAuth2 = {
      authorizationServerId = "string"
      scope = "string"
    }
  }
  description = "string"
  path = "string"
  protocols = [
    "string"
  ]
  serviceUrl = "string"
  subscriptionKeyParameterNames = {
    header = "string"
    query = "string"
  }
}

Valori delle proprietà

AuthenticationSettingsContract

Nome Descrizione Valore
oAuth2 Dettagli delle impostazioni di autenticazione OAuth2 dell'API. OAuth2AuthenticationSettingsContract

Microsoft.ApiManagement/service/apis

Nome Descrizione Valore
authenticationSettings Raccolta di impostazioni di autenticazione incluse in questa API. AuthenticationSettingsContract
descrizione Descrizione dell'API. Può includere tag di formattazione HTML. corda
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
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' (obbligatorio)
serviceUrl URL assoluto del servizio back-end che implementa questa API. corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1 (obbligatorio)
subscriptionKeyParameterNames Protocolli su cui è disponibile l'API. SubscriptionKeyParameterNamesContract
digitare Tipo di risorsa "Microsoft.ApiManagement/service/apis@2016-10-10"

OAuth2AuthenticationSettingsContract

Nome Descrizione Valore
authorizationServerId Identificatore del server di autorizzazione OAuth. corda
portata ambito delle operazioni. 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