Condividi tramite

Servizio Microsoft.ApiManagement 2016-10-10

  • Articolo

Definizione di risorsa Bicep

Il tipo di risorsa del servizio 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, aggiungere il bicep seguente al modello.

resource symbolicname 'Microsoft.ApiManagement/service@2016-10-10' = {
  location: 'string'
  name: 'string'
  properties: {
    additionalLocations: [
      {
        location: 'string'
        skuType: 'string'
        skuUnitCount: int
        vpnconfiguration: {
          location: 'string'
          subnetResourceId: 'string'
        }
      }
    ]
    addresserEmail: 'string'
    customProperties: {
      {customized property}: 'string'
    }
    hostnameConfigurations: [
      {
        certificate: {
          expiry: 'string'
          subject: 'string'
          thumbprint: 'string'
        }
        hostname: 'string'
        type: 'string'
      }
    ]
    publisherEmail: 'string'
    publisherName: 'string'
    vpnconfiguration: {
      location: 'string'
      subnetResourceId: 'string'
    }
    vpnType: 'string'
  }
  sku: {
    capacity: int
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Valori delle proprietà

Area aggiuntiva

Nome Descrizione Valore
ubicazione Nome della località dell'area aggiuntiva tra le aree del data center di Azure. stringa (obbligatorio)
skuType Tipo di SKU nella posizione. 'Developer'
'Premium'
'Standard' (obbligatorio)
skuUnitCount Numero di unità SKU nella posizione. Il numero massimo di unità SKU dipende dallo SkuType. Il valore massimo consentito per lo SKU per sviluppatori è 1, per lo SKU Standard è 4 e per lo SKU Premium è 10, in una posizione. Int

Vincoli:
Valore massimo = 10
vpnconfiguration Configurazione della rete virtuale per il percorso. VirtualNetworkConfiguration

ApiManagementServiceProperties

Nome Descrizione Valore
additionalLocations Località del data center aggiuntive del servizio Gestione API. AdditionalRegion []
addresserEmail Indirizzo di posta elettronica del destinatario. corda
customProperties Proprietà personalizzate del servizio Gestione API, ad esempio la disabilitazione di TLS 1.0. ApiManagementServicePropertiesProprietà personalizzate
hostnameConfigurations Configurazione del nome host personalizzato del servizio Gestione API. HostnameConfiguration[]
publisherEmail Posta elettronica dell'editore. corda

Vincoli:
Lunghezza massima = 100 (obbligatorio)
publisherName Nome server di pubblicazione. stringa (obbligatorio)
vpnconfiguration Configurazione della rete virtuale del servizio Gestione API. VirtualNetworkConfiguration
vpnType Tipo di VPN in cui deve essere configurato il servizio Gestione API. Nessuno (valore predefinito) significa che il servizio Gestione API non fa parte di alcuna rete virtuale, esternamente indica che la distribuzione di Gestione API è configurata all'interno di una rete virtuale con un endpoint con connessione Internet e internal significa che la distribuzione di Gestione API è configurata solo all'interno di una rete virtuale con un endpoint intranet. 'External'
'Interno'
'Nessuno'

ApiManagementServicePropertiesProprietà personalizzate

Nome Descrizione Valore

ApiManagementServiceSkuProperties

Nome Descrizione Valore
capacità Capacità dello SKU (numero di unità distribuite dello SKU). Il valore predefinito è 1. Int
nome Nome dello SKU. 'Developer'
'Premium'
'Standard' (obbligatorio)

CertificateInformation

Nome Descrizione Valore
scadenza Data di scadenza del certificato. La data è conforme al formato seguente: yyyy-MM-ddTHH:mm:ssZ come specificato dallo standard ISO 8601. stringa (obbligatorio)
Oggetto Oggetto del certificato. stringa (obbligatorio)
Identificazione personale Identificazione personale del certificato. stringa (obbligatorio)

HostnameConfiguration

Nome Descrizione Valore
certificato Informazioni sul certificato. CertificateInformation (obbligatorio)
hostname Nome host. stringa (obbligatorio)
digitare Tipo nome host. 'Gestione'
'Portal'
'Proxy'
'Scm' (obbligatorio)

Microsoft.ApiManagement/service

Nome Descrizione Valore
ubicazione Percorso della risorsa. stringa (obbligatorio)
nome Nome della risorsa corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 50
Pattern = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (obbligatorio)
proprietà Proprietà del servizio Gestione API. ApiManagementServiceProperties (obbligatorio)
Sku Proprietà SKU del servizio Gestione API. ApiManagementServiceSkuProperties (obbligatorio)
Tag Tag delle risorse Dizionario di nomi e valori di tag. Vedere tag nei modelli

ResourceTags

Nome Descrizione Valore

VirtualNetworkConfiguration

Nome Descrizione Valore
ubicazione Percorso della rete virtuale. corda
subnetResourceId ID risorsa completo di una subnet in una rete virtuale in cui distribuire il servizio Gestione API. corda

Vincoli:
Pattern = ^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$

Esempi di avvio rapido

Gli esempi di avvio rapido seguenti distribuiscono questo tipo di risorsa.

Bicep File Descrizione
gateway applicazione con gestione API interna e app Web Il gateway applicazione instrada il traffico Internet a un'istanza di Gestione API di rete virtuale (modalità interna) che supporta un'API Web ospitata in un'app Web di Azure.
Creare un'istanza di Gestione API di livello Premium multiregion Questo modello illustra come creare un'istanza di Gestione API con posizioni aggiuntive. La posizione primaria corrisponde alla posizione del gruppo di risorse. Per altre posizioni, il modello mostra NorthCentralUs e Stati Uniti orientali 2. La posizione primaria deve essere diversa da posizioni aggiuntive.
Creare un'istanza di Gestione API con identità MSI Questo modello crea un'istanza per sviluppatori di Gestione API di Azure con un'identità MSI
Creare un'istanza di Gestione API usando un modello Questo modello crea un'istanza per sviluppatori di Gestione API di Azure
Creare un servizio Gestione API con un endpoint privato Questo modello creerà un servizio Gestione API, una rete virtuale e un endpoint privato che espone il servizio Gestione API alla rete virtuale.
Creare un servizio Gestione API con SSL da KeyVault Questo modello distribuisce un servizio Gestione API configurato con identità assegnata dall'utente. Usa questa identità per recuperare il certificato SSL da KeyVault e lo mantiene aggiornato controllando ogni 4 ore.
Creare Gestione API nella rete virtuale interna con il gateway app Questo modello illustra come creare un'istanza di Gestione API di Azure in una rete privata protetta dal gateway applicazione di Azure.
Distribuire Gestione API in una rete virtuale esterna con IP pubblico Questo modello illustra come creare un'istanza di Gestione API di Azure nel livello Premium all'interno della subnet della rete virtuale in modalità esterna e configurare le regole del gruppo di sicurezza di rete consigliate nella subnet. L'istanza viene distribuita in due zone di disponibilità. Il modello configura anche un indirizzo IP pubblico dalla sottoscrizione.
Distribuire Gestione API nella rete virtuale interna con ip pubblico Questo modello illustra come creare un'istanza di Gestione API di Azure nel livello Premium all'interno della subnet della rete virtuale in modalità interna e configurare le regole del gruppo di sicurezza di rete consigliate nella subnet. L'istanza viene distribuita in due zone di disponibilità. Il modello configura anche un indirizzo IP pubblico dalla sottoscrizione.
Distribuire Gestione API in zone di disponibilità Questo modello crea un'istanza Premium di Gestione API di Azure e viene distribuita in una zona di disponibilità
Distribuire Gestione API con un'istanza esterna di Cache Redis di Azure Questo modello illustra come creare un'istanza di Gestione API di Azure nel livello a consumo con un'istanza esterna di Cache Redis di Azure come cache esterna di Gestione API.
Frontdoor Standard/Premium con di origine di Gestione API Questo modello crea un'istanza di Frontdoor Premium e di Gestione API e usa un gruppo di sicurezza di rete e un criterio di Gestione API globale per verificare che il traffico provenga dall'origine di Frontdoor.

Definizione di risorsa del modello di Resource Manager

Il tipo di risorsa del servizio 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, aggiungere il codice JSON seguente al modello.

{
  "type": "Microsoft.ApiManagement/service",
  "apiVersion": "2016-10-10",
  "name": "string",
  "location": "string",
  "properties": {
    "additionalLocations": [
      {
        "location": "string",
        "skuType": "string",
        "skuUnitCount": "int",
        "vpnconfiguration": {
          "location": "string",
          "subnetResourceId": "string"
        }
      }
    ],
    "addresserEmail": "string",
    "customProperties": {
      "{customized property}": "string"
    },
    "hostnameConfigurations": [
      {
        "certificate": {
          "expiry": "string",
          "subject": "string",
          "thumbprint": "string"
        },
        "hostname": "string",
        "type": "string"
      }
    ],
    "publisherEmail": "string",
    "publisherName": "string",
    "vpnconfiguration": {
      "location": "string",
      "subnetResourceId": "string"
    },
    "vpnType": "string"
  },
  "sku": {
    "capacity": "int",
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valori delle proprietà

Area aggiuntiva

Nome Descrizione Valore
ubicazione Nome della località dell'area aggiuntiva tra le aree del data center di Azure. stringa (obbligatorio)
skuType Tipo di SKU nella posizione. 'Developer'
'Premium'
'Standard' (obbligatorio)
skuUnitCount Numero di unità SKU nella posizione. Il numero massimo di unità SKU dipende dallo SkuType. Il valore massimo consentito per lo SKU per sviluppatori è 1, per lo SKU Standard è 4 e per lo SKU Premium è 10, in una posizione. Int

Vincoli:
Valore massimo = 10
vpnconfiguration Configurazione della rete virtuale per il percorso. VirtualNetworkConfiguration

ApiManagementServiceProperties

Nome Descrizione Valore
additionalLocations Località del data center aggiuntive del servizio Gestione API. AdditionalRegion []
addresserEmail Indirizzo di posta elettronica del destinatario. corda
customProperties Proprietà personalizzate del servizio Gestione API, ad esempio la disabilitazione di TLS 1.0. ApiManagementServicePropertiesProprietà personalizzate
hostnameConfigurations Configurazione del nome host personalizzato del servizio Gestione API. HostnameConfiguration[]
publisherEmail Posta elettronica dell'editore. corda

Vincoli:
Lunghezza massima = 100 (obbligatorio)
publisherName Nome server di pubblicazione. stringa (obbligatorio)
vpnconfiguration Configurazione della rete virtuale del servizio Gestione API. VirtualNetworkConfiguration
vpnType Tipo di VPN in cui deve essere configurato il servizio Gestione API. Nessuno (valore predefinito) significa che il servizio Gestione API non fa parte di alcuna rete virtuale, esternamente indica che la distribuzione di Gestione API è configurata all'interno di una rete virtuale con un endpoint con connessione Internet e internal significa che la distribuzione di Gestione API è configurata solo all'interno di una rete virtuale con un endpoint intranet. 'External'
'Interno'
'Nessuno'

ApiManagementServicePropertiesProprietà personalizzate

Nome Descrizione Valore

ApiManagementServiceSkuProperties

Nome Descrizione Valore
capacità Capacità dello SKU (numero di unità distribuite dello SKU). Il valore predefinito è 1. Int
nome Nome dello SKU. 'Developer'
'Premium'
'Standard' (obbligatorio)

CertificateInformation

Nome Descrizione Valore
scadenza Data di scadenza del certificato. La data è conforme al formato seguente: yyyy-MM-ddTHH:mm:ssZ come specificato dallo standard ISO 8601. stringa (obbligatorio)
Oggetto Oggetto del certificato. stringa (obbligatorio)
Identificazione personale Identificazione personale del certificato. stringa (obbligatorio)

HostnameConfiguration

Nome Descrizione Valore
certificato Informazioni sul certificato. CertificateInformation (obbligatorio)
hostname Nome host. stringa (obbligatorio)
digitare Tipo nome host. 'Gestione'
'Portal'
'Proxy'
'Scm' (obbligatorio)

Microsoft.ApiManagement/service

Nome Descrizione Valore
apiVersion Versione dell'API '2016-10-10'
ubicazione Percorso della risorsa. stringa (obbligatorio)
nome Nome della risorsa corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 50
Pattern = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (obbligatorio)
proprietà Proprietà del servizio Gestione API. ApiManagementServiceProperties (obbligatorio)
Sku Proprietà SKU del servizio Gestione API. ApiManagementServiceSkuProperties (obbligatorio)
Tag Tag delle risorse Dizionario di nomi e valori di tag. Vedere tag nei modelli
digitare Tipo di risorsa 'Microsoft.ApiManagement/service'

ResourceTags

Nome Descrizione Valore

VirtualNetworkConfiguration

Nome Descrizione Valore
ubicazione Percorso della rete virtuale. corda
subnetResourceId ID risorsa completo di una subnet in una rete virtuale in cui distribuire il servizio Gestione API. corda

Vincoli:
Pattern = ^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$

Modelli di avvio rapido

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

Sagoma Descrizione
gateway applicazione con gestione API interna e app Web

Distribuire in Azure 		Il gateway applicazione instrada il traffico Internet a un'istanza di Gestione API di rete virtuale (modalità interna) che supporta un'API Web ospitata in un'app Web di Azure.
Creare un'istanza di Gestione API di livello Premium multiregion

Distribuire in Azure 		Questo modello illustra come creare un'istanza di Gestione API con posizioni aggiuntive. La posizione primaria corrisponde alla posizione del gruppo di risorse. Per altre posizioni, il modello mostra NorthCentralUs e Stati Uniti orientali 2. La posizione primaria deve essere diversa da posizioni aggiuntive.
Creare un'istanza di Gestione API e tutte le risorse secondarie usando modello

Distribuire in Azure 		Questo modello illustra come creare un servizio Gestione API e configurare le sottoentità
Creare un'istanza di Gestione API con identità MSI

Distribuire in Azure 		Questo modello crea un'istanza per sviluppatori di Gestione API di Azure con un'identità MSI
Creare un'istanza di Gestione API usando un modello

Distribuire in Azure 		Questo modello crea un'istanza per sviluppatori di Gestione API di Azure
Creare un'istanza di Gestione API con nomi host personalizzati

Distribuire in Azure 		Questo modello illustra come creare un'istanza di Gestione API di Azure con il nome host personalizzato per il portale e più nomi host personalizzati per il proxy
Creare un servizio Gestione API con un endpoint privato

Distribuire in Azure 		Questo modello creerà un servizio Gestione API, una rete virtuale e un endpoint privato che espone il servizio Gestione API alla rete virtuale.
Creare un servizio Gestione API con SSL da KeyVault

Distribuire in Azure 		Questo modello distribuisce un servizio Gestione API configurato con identità assegnata dall'utente. Usa questa identità per recuperare il certificato SSL da KeyVault e lo mantiene aggiornato controllando ogni 4 ore.
Creare e monitorare l'istanza di Gestione API

Distribuire in Azure 		Questo modello crea un'istanza del servizio Gestione API di Azure e dell'area di lavoro Log Analytics e configura il monitoraggio per il servizio Gestione API con Log Analytics
Creare Gestione API nella rete virtuale interna con il gateway app

Distribuire in Azure 		Questo modello illustra come creare un'istanza di Gestione API di Azure in una rete privata protetta dal gateway applicazione di Azure.
Creare Gestione API con ssl proxy personalizzato con KeyVault

Distribuire in Azure 		Questo modello illustra come creare un'istanza di Gestione API di Azure e configurare il nome host personalizzato per il proxy con certificato SSL dall'insieme di credenziali delle chiavi.
Creare frontdoor di Azure davanti a Gestione API di Azure

Distribuire in Azure 		Questo esempio illustra come usare Frontdoor di Azure come servizio di bilanciamento del carico globale davanti a Gestione API di Azure.
Distribuire Gestione API in una rete virtuale esterna con IP pubblico

Distribuire in Azure 		Questo modello illustra come creare un'istanza di Gestione API di Azure nel livello Premium all'interno della subnet della rete virtuale in modalità esterna e configurare le regole del gruppo di sicurezza di rete consigliate nella subnet. L'istanza viene distribuita in due zone di disponibilità. Il modello configura anche un indirizzo IP pubblico dalla sottoscrizione.
Distribuire Gestione API nella rete virtuale interna con ip pubblico

Distribuire in Azure 		Questo modello illustra come creare un'istanza di Gestione API di Azure nel livello Premium all'interno della subnet della rete virtuale in modalità interna e configurare le regole del gruppo di sicurezza di rete consigliate nella subnet. L'istanza viene distribuita in due zone di disponibilità. Il modello configura anche un indirizzo IP pubblico dalla sottoscrizione.
Distribuire Gestione API in zone di disponibilità

Distribuire in Azure 		Questo modello crea un'istanza Premium di Gestione API di Azure e viene distribuita in una zona di disponibilità
Distribuire Gestione API con un'istanza esterna di Cache Redis di Azure

Distribuire in Azure 		Questo modello illustra come creare un'istanza di Gestione API di Azure nel livello a consumo con un'istanza esterna di Cache Redis di Azure come cache esterna di Gestione API.
Frontdoor Standard/Premium con di origine di Gestione API

Distribuire in Azure 		Questo modello crea un'istanza di Frontdoor Premium e di Gestione API e usa un gruppo di sicurezza di rete e un criterio di Gestione API globale per verificare che il traffico provenga dall'origine di Frontdoor.

Definizione di risorsa Terraform (provider AzAPI)

Il tipo di risorsa del servizio 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, aggiungere il codice Terraform seguente al modello.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service@2016-10-10"
  name = "string"
  location = "string"
  sku = {
    capacity = int
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      additionalLocations = [
        {
          location = "string"
          skuType = "string"
          skuUnitCount = int
          vpnconfiguration = {
            location = "string"
            subnetResourceId = "string"
          }
        }
      ]
      addresserEmail = "string"
      customProperties = {
        {customized property} = "string"
      }
      hostnameConfigurations = [
        {
          certificate = {
            expiry = "string"
            subject = "string"
            thumbprint = "string"
          }
          hostname = "string"
          type = "string"
        }
      ]
      publisherEmail = "string"
      publisherName = "string"
      vpnconfiguration = {
        location = "string"
        subnetResourceId = "string"
      }
      vpnType = "string"
    }
  })
}

Valori delle proprietà

Area aggiuntiva

Nome Descrizione Valore
ubicazione Nome della località dell'area aggiuntiva tra le aree del data center di Azure. stringa (obbligatorio)
skuType Tipo di SKU nella posizione. 'Developer'
'Premium'
'Standard' (obbligatorio)
skuUnitCount Numero di unità SKU nella posizione. Il numero massimo di unità SKU dipende dallo SkuType. Il valore massimo consentito per lo SKU per sviluppatori è 1, per lo SKU Standard è 4 e per lo SKU Premium è 10, in una posizione. Int

Vincoli:
Valore massimo = 10
vpnconfiguration Configurazione della rete virtuale per il percorso. VirtualNetworkConfiguration

ApiManagementServiceProperties

Nome Descrizione Valore
additionalLocations Località del data center aggiuntive del servizio Gestione API. AdditionalRegion []
addresserEmail Indirizzo di posta elettronica del destinatario. corda
customProperties Proprietà personalizzate del servizio Gestione API, ad esempio la disabilitazione di TLS 1.0. ApiManagementServicePropertiesProprietà personalizzate
hostnameConfigurations Configurazione del nome host personalizzato del servizio Gestione API. HostnameConfiguration[]
publisherEmail Posta elettronica dell'editore. corda

Vincoli:
Lunghezza massima = 100 (obbligatorio)
publisherName Nome server di pubblicazione. stringa (obbligatorio)
vpnconfiguration Configurazione della rete virtuale del servizio Gestione API. VirtualNetworkConfiguration
vpnType Tipo di VPN in cui deve essere configurato il servizio Gestione API. Nessuno (valore predefinito) significa che il servizio Gestione API non fa parte di alcuna rete virtuale, esternamente indica che la distribuzione di Gestione API è configurata all'interno di una rete virtuale con un endpoint con connessione Internet e internal significa che la distribuzione di Gestione API è configurata solo all'interno di una rete virtuale con un endpoint intranet. 'External'
'Interno'
'Nessuno'

ApiManagementServicePropertiesProprietà personalizzate

Nome Descrizione Valore

ApiManagementServiceSkuProperties

Nome Descrizione Valore
capacità Capacità dello SKU (numero di unità distribuite dello SKU). Il valore predefinito è 1. Int
nome Nome dello SKU. 'Developer'
'Premium'
'Standard' (obbligatorio)

CertificateInformation

Nome Descrizione Valore
scadenza Data di scadenza del certificato. La data è conforme al formato seguente: yyyy-MM-ddTHH:mm:ssZ come specificato dallo standard ISO 8601. stringa (obbligatorio)
Oggetto Oggetto del certificato. stringa (obbligatorio)
Identificazione personale Identificazione personale del certificato. stringa (obbligatorio)

HostnameConfiguration

Nome Descrizione Valore
certificato Informazioni sul certificato. CertificateInformation (obbligatorio)
hostname Nome host. stringa (obbligatorio)
digitare Tipo nome host. 'Gestione'
'Portal'
'Proxy'
'Scm' (obbligatorio)

Microsoft.ApiManagement/service

Nome Descrizione Valore
ubicazione Percorso della risorsa. stringa (obbligatorio)
nome Nome della risorsa corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 50
Pattern = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (obbligatorio)
proprietà Proprietà del servizio Gestione API. ApiManagementServiceProperties (obbligatorio)
Sku Proprietà SKU del servizio Gestione API. ApiManagementServiceSkuProperties (obbligatorio)
Tag Tag delle risorse Dizionario di nomi e valori di tag.
digitare Tipo di risorsa "Microsoft.ApiManagement/service@2016-10-10"

ResourceTags

Nome Descrizione Valore

VirtualNetworkConfiguration

Nome Descrizione Valore
ubicazione Percorso della rete virtuale. corda
subnetResourceId ID risorsa completo di una subnet in una rete virtuale in cui distribuire il servizio Gestione API. corda

Vincoli:
Pattern = ^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$