Servizio Microsoft.ApiManagement 2018-01-01

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@2018-01-01' = {
  identity: {
    type: 'string'
  }
  location: 'string'
  name: 'string'
  properties: {
    additionalLocations: [
      {
        location: 'string'
        sku: {
          capacity: int
          name: 'string'
        }
        virtualNetworkConfiguration: {
          subnetResourceId: 'string'
        }
      }
    ]
    certificates: [
      {
        certificate: {
          expiry: 'string'
          subject: 'string'
          thumbprint: 'string'
        }
        certificatePassword: 'string'
        encodedCertificate: 'string'
        storeName: 'string'
      }
    ]
    customProperties: {
      {customized property}: 'string'
    }
    hostnameConfigurations: [
      {
        certificate: {
          expiry: 'string'
          subject: 'string'
          thumbprint: 'string'
        }
        certificatePassword: 'string'
        defaultSslBinding: bool
        encodedCertificate: 'string'
        hostName: 'string'
        keyVaultId: 'string'
        negotiateClientCertificate: bool
        type: 'string'
      }
    ]
    notificationSenderEmail: 'string'
    publisherEmail: 'string'
    publisherName: 'string'
    virtualNetworkConfiguration: {
      subnetResourceId: 'string'
    }
    virtualNetworkType: 'string'
  }
  sku: {
    capacity: int
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Valori delle proprietà

AdditionalLocation

ApiManagementServiceBasePropertiesProprietà personalizzate

ApiManagementServiceIdentity

ApiManagementServiceProperties

ApiManagementServiceSkuProperties

ApimResourceTags

CertificateConfiguration

CertificateInformation

HostnameConfiguration

Microsoft.ApiManagement/service

VirtualNetworkConfiguration

Esempi di avvio rapido

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

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": "2018-01-01",
  "name": "string",
  "identity": {
    "type": "string"
  },
  "location": "string",
  "properties": {
    "additionalLocations": [
      {
        "location": "string",
        "sku": {
          "capacity": "int",
          "name": "string"
        },
        "virtualNetworkConfiguration": {
          "subnetResourceId": "string"
        }
      }
    ],
    "certificates": [
      {
        "certificate": {
          "expiry": "string",
          "subject": "string",
          "thumbprint": "string"
        },
        "certificatePassword": "string",
        "encodedCertificate": "string",
        "storeName": "string"
      }
    ],
    "customProperties": {
      "{customized property}": "string"
    },
    "hostnameConfigurations": [
      {
        "certificate": {
          "expiry": "string",
          "subject": "string",
          "thumbprint": "string"
        },
        "certificatePassword": "string",
        "defaultSslBinding": "bool",
        "encodedCertificate": "string",
        "hostName": "string",
        "keyVaultId": "string",
        "negotiateClientCertificate": "bool",
        "type": "string"
      }
    ],
    "notificationSenderEmail": "string",
    "publisherEmail": "string",
    "publisherName": "string",
    "virtualNetworkConfiguration": {
      "subnetResourceId": "string"
    },
    "virtualNetworkType": "string"
  },
  "sku": {
    "capacity": "int",
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valori delle proprietà

AdditionalLocation

ApiManagementServiceBasePropertiesProprietà personalizzate

ApiManagementServiceIdentity

ApiManagementServiceProperties

ApiManagementServiceSkuProperties

ApimResourceTags

CertificateConfiguration

CertificateInformation

HostnameConfiguration

Microsoft.ApiManagement/service

VirtualNetworkConfiguration

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	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 e tutte le risorse secondarie usando modello	Questo modello illustra come creare un servizio Gestione API e configurare le sottoentità
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'istanza di Gestione API con nomi host personalizzati	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	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 e monitorare l'istanza di Gestione API	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	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	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	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	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 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@2018-01-01"
  name = "string"
  identity = {
    type = "string"
  }
  location = "string"
  sku = {
    capacity = int
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      additionalLocations = [
        {
          location = "string"
          sku = {
            capacity = int
            name = "string"
          }
          virtualNetworkConfiguration = {
            subnetResourceId = "string"
          }
        }
      ]
      certificates = [
        {
          certificate = {
            expiry = "string"
            subject = "string"
            thumbprint = "string"
          }
          certificatePassword = "string"
          encodedCertificate = "string"
          storeName = "string"
        }
      ]
      customProperties = {
        {customized property} = "string"
      }
      hostnameConfigurations = [
        {
          certificate = {
            expiry = "string"
            subject = "string"
            thumbprint = "string"
          }
          certificatePassword = "string"
          defaultSslBinding = bool
          encodedCertificate = "string"
          hostName = "string"
          keyVaultId = "string"
          negotiateClientCertificate = bool
          type = "string"
        }
      ]
      notificationSenderEmail = "string"
      publisherEmail = "string"
      publisherName = "string"
      virtualNetworkConfiguration = {
        subnetResourceId = "string"
      }
      virtualNetworkType = "string"
    }
  })
}

Valori delle proprietà

AdditionalLocation

ApiManagementServiceBasePropertiesProprietà personalizzate

ApiManagementServiceIdentity

ApiManagementServiceProperties

ApiManagementServiceSkuProperties

ApimResourceTags

CertificateConfiguration

CertificateInformation

HostnameConfiguration

Microsoft.ApiManagement/service

VirtualNetworkConfiguration