Servizio Microsoft.ApiManagement
Definizione di risorsa Bicep
Il tipo di risorsa del servizio 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, aggiungere il modello Bicep seguente.
resource symbolicname 'Microsoft.ApiManagement/service@2023-05-01-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
{customized property}: 'string'
sku: {
capacity: int
name: 'string'
}
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {
clientId: 'string'
principalId: 'string'
}
}
}
properties: {
additionalLocations: [
{
disableGateway: bool
location: 'string'
natGatewayState: 'string'
publicIpAddressId: 'string'
sku: {
capacity: int
name: 'string'
}
virtualNetworkConfiguration: {
subnetResourceId: 'string'
}
zones: [
'string'
]
}
]
apiVersionConstraint: {
minApiVersion: 'string'
}
certificates: [
{
certificate: {
expiry: 'string'
subject: 'string'
thumbprint: 'string'
}
certificatePassword: 'string'
encodedCertificate: 'string'
storeName: 'string'
}
]
configurationApi: {
legacyApi: 'string'
}
customProperties: {
{customized property}: 'string'
}
developerPortalStatus: 'string'
disableGateway: bool
enableClientCertificate: bool
hostnameConfigurations: [
{
certificate: {
expiry: 'string'
subject: 'string'
thumbprint: 'string'
}
certificatePassword: 'string'
certificateSource: 'string'
certificateStatus: 'string'
defaultSslBinding: bool
encodedCertificate: 'string'
hostName: 'string'
identityClientId: 'string'
keyVaultId: 'string'
negotiateClientCertificate: bool
type: 'string'
}
]
legacyPortalStatus: 'string'
natGatewayState: 'string'
notificationSenderEmail: 'string'
privateEndpointConnections: [
{
id: 'string'
name: 'string'
properties: {
privateEndpoint: {}
privateLinkServiceConnectionState: {
actionsRequired: 'string'
description: 'string'
status: 'string'
}
}
type: 'string'
}
]
publicIpAddressId: 'string'
publicNetworkAccess: 'string'
publisherEmail: 'string'
publisherName: 'string'
restore: bool
virtualNetworkConfiguration: {
subnetResourceId: 'string'
}
virtualNetworkType: 'string'
}
zones: [
'string'
]
}
Valori delle proprietà
service
Nome | Descrizione | valore |
---|---|---|
name | Nome della risorsa | stringa (obbligatoria) Limite di caratteri: 1-50 Caratteri validi: Caratteri alfanumerici e trattini. Inizia con la lettera e termina con alfanumerico. Il nome della risorsa deve essere univoco in Azure. |
posizione | Percorso della risorsa. | stringa (obbligatoria) |
tags | Tag di risorse. | Dizionario dei nomi e dei valori dei tag. Vedere Tag nei modelli |
sku | Proprietà SKU del servizio Gestione API. | ApiManagementServiceSkuProperties (obbligatorio) |
identity | Identità del servizio gestito del servizio Gestione API. | ApiManagementServiceIdentity |
properties | Proprietà del servizio Gestione API. | ApiManagementServiceProperties (obbligatorio) |
zone | Elenco delle zone di disponibilità che denonono dove deve venire la risorsa. | string[] |
ApiManagementServiceIdentity
Nome | Descrizione | Valore |
---|---|---|
tipo | Tipo di identità utilizzata per la risorsa. Il tipo 'SystemAssigned, UserAssigned' include sia un'identità creata in modo implicito che un set di identità assegnate dall'utente. Il tipo 'Nessuno' rimuoverà le identità dal servizio. | 'Nessuno' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' (obbligatorio) |
userAssignedIdentities | Elenco delle identità utente associate alla risorsa. Identità utente i riferimenti alle chiavi dizionario saranno ID risorsa ARM nel formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. |
ApiManagementServiceIdentityUserAssignedIdentities |
ApiManagementServiceIdentityUserAssignedIdentities
Nome | Descrizione | Valore |
---|---|---|
{proprietà personalizzata} | UserIdentityProperties |
UserIdentityProperties
Nome | Descrizione | Valore |
---|---|---|
clientId | ID client dell'identità assegnata dall'utente. | string |
principalId | ID principale dell'identità assegnata dall'utente. | string |
ApiManagementServiceProperties
Nome | Descrizione | Valore |
---|---|---|
additionalLocations | Località del data center aggiuntive del servizio Gestione API. | AdditionalLocation[] |
apiVersionConstraint | Vincolo di versione api piano di controllo per il servizio Gestione API. | ApiVersionConstraint |
certificates | Elenco di certificati che devono essere installati nel servizio Gestione API. Il numero massimo di certificati supportati che possono essere installati è 10. | CertificateConfiguration[] |
configurationApi | Configurazione dell'API di configurazione del servizio Gestione API. | ConfigurationApi |
Customproperties | Proprietà personalizzate del servizio Gestione API. L'impostazione Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 disabilita la crittografia TLS_RSA_WITH_3DES_EDE_CBC_SHA per tutti i protocolli TLS(1.0, 1.1 e 1.2).L'impostazione Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 può essere usata per disabilitare solo TLS 1.1.L'impostazione Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 può essere usata per disabilitare TLS 1.0 in un servizio di Gestione API.L'impostazione Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 può essere usata per disabilitare solo TLS 1.1 per le comunicazioni con back-end.L'impostazione Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 può essere usata per disabilitare TLS 1.0 per le comunicazioni con back-end.L'impostazione Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 può essere usata per abilitare il protocollo HTTP2 in un servizio Gestione API.Se non si specifica alcuna di queste proprietà nell'operazione PATCH, i valori delle proprietà verranno reimpostati sui valori predefiniti. Per tutte le impostazioni ad eccezione di Http2, il valore predefinito è True se il servizio è stato creato il 1° aprile 2018 e False in caso contrario. Il valore predefinito dell'impostazione Http2 è False .È possibile disabilitare una delle crittografie seguenti usando le impostazioni Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name] : TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. Ad esempio, Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256 :false . Il valore predefinito è true per loro.Nota: le crittografie seguenti non possono essere disabilitate perché sono richieste dai componenti interni della piattaforma: TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 |
ApiManagementServiceBasePropertiesProprietà personalizzate |
developerPortalStatus | Stato del portale per sviluppatori in questo servizio di Gestione API. | 'Disabilitato' 'Enabled' |
disableGateway | Proprietà valida solo per un servizio Gestione API distribuito in più posizioni. Può essere usato per disabilitare il gateway nell'area master. | bool |
enableClientCertificate | La proprietà deve essere usata solo per il servizio SKU a consumo. In questo modo viene applicato un certificato client da presentare a ogni richiesta al gateway. In questo modo è anche possibile autenticare il certificato nei criteri nel gateway. | bool |
hostnameConfigurations | Configurazione personalizzata del nome host del servizio di Gestione API. | HostnameConfiguration[] |
legacyPortalStatus | Stato del portale legacy nel servizio Gestione API. | 'Disabilitato' 'Enabled' |
natGatewayState | La proprietà può essere usata per abilitare il gateway NAT per questo servizio Gestione API. | 'Disabilitato' 'Enabled' |
notificationSenderEmail | Email indirizzo da cui verrà inviata la notifica. | string |
privateEndpointConnections | Elenco delle connessioni endpoint privato di questo servizio. | RemotePrivateEndpointConnectionWrapper[] |
publicIpAddressId | Indirizzo IP pubblico standard basato su IP V4 da associare a Rete virtuale servizio distribuito nell'area. Supportato solo per lo SKU Developer e Premium distribuito in Rete virtuale. | string |
publicNetworkAccess | Indica se l'accesso all'endpoint pubblico è consentito per questo servizio Gestione API. Il valore è facoltativo, ma se passato, deve essere 'Enabled' o 'Disabled'. Se "Disabilitato", gli endpoint privati sono il metodo di accesso esclusivo. Il valore predefinito è 'Enabled' | 'Disabilitato' 'Enabled' |
publisherEmail | Indirizzo di posta elettronica dell'editore. | stringa (obbligatorio) |
publisherName | Nome del server di pubblicazione. | stringa (obbligatorio) |
ripristinare | Annullare l'eliminazione del servizio Gestione API se è stato eliminato soft in precedenza. Se questo flag viene specificato e impostato su True, tutte le altre proprietà verranno ignorate. | bool |
virtualNetworkConfiguration | Configurazione della rete virtuale del servizio Gestione API. | VirtualNetworkConfiguration |
virtualNetworkType | Tipo di VPN in cui Gestione API servizio deve essere configurato. Nessuno (valore predefinito) indica che il servizio Gestione API non fa parte di alcuna Rete virtuale, external indica che la distribuzione Gestione API è configurata all'interno di un Rete virtuale con un endpoint con connessione Internet e internal significa che Gestione API distribuzione è configurata all'interno di un Rete virtuale avere solo un endpoint con connessione Intranet. | 'External' 'Interno' 'Nessuno' |
AdditionalLocation
Nome | Descrizione | Valore |
---|---|---|
disableGateway | Proprietà valida solo per un servizio Gestione API distribuito in più posizioni. Questa opzione può essere usata per disabilitare il gateway in questo percorso aggiuntivo. | bool |
posizione | Nome della località dell'area aggiuntiva tra le aree del data center di Azure. | stringa (obbligatorio) |
natGatewayState | La proprietà può essere usata per abilitare il gateway NAT per questo servizio Gestione API. | 'Disabilitato' 'Enabled' |
publicIpAddressId | Indirizzo IP pubblico standard basato su IP V4 da associare a Rete virtuale servizio distribuito nel percorso. Supportato solo per lo SKU Premium distribuito in Rete virtuale. | string |
sku | Proprietà SKU del servizio Gestione API. | ApiManagementServiceSkuProperties (obbligatorio) |
virtualNetworkConfiguration | Configurazione della rete virtuale per il percorso. | VirtualNetworkConfiguration |
zone | Elenco di zone di disponibilità che indicano da cui deve provenire la risorsa. | string[] |
ApiManagementServiceSkuProperties
Nome | Descrizione | Valore |
---|---|---|
capacità | Capacità dello SKU (numero di unità distribuite dello SKU). Per la capacità SKU a consumo deve essere specificato come 0. | int (obbligatorio) |
name | Nome dello SKU. | 'Basic' 'BasicV2' 'Consumo' 'Developer' 'Isolato' 'Premium' 'Standard' 'StandardV2' (obbligatorio) |
VirtualNetworkConfiguration
Nome | Descrizione | Valore |
---|---|---|
subnetResourceId | ID risorsa completo di una subnet in una rete virtuale in cui distribuire il servizio Gestione API. | string |
ApiVersionConstraint
Nome | Descrizione | Valore |
---|---|---|
minApiVersion | Limitare le chiamate API del piano di controllo a Gestione API servizio con versione uguale o successiva a questo valore. | string |
CertificateConfiguration
Nome | Descrizione | Valore |
---|---|---|
certificato | Informazioni sul certificato. | CertificateInformation |
certificatePassword | Password del certificato. | string |
encodedCertificate | Certificato con codifica Base64. | string |
storeName | Percorso dell'archivio certificati System.Security.Cryptography.x509certificates.StoreName. Solo Root e CertificateAuthority sono percorsi validi. | 'CertificateAuthority' 'Root' (obbligatorio) |
CertificateInformation
Nome | Descrizione | Valore |
---|---|---|
expiry | Data di scadenza del certificato. La data è conforme al formato seguente: yyyy-MM-ddTHH:mm:ssZ come specificato dallo standard ISO 8601. |
stringa (obbligatorio) |
subject | Oggetto del certificato. | stringa (obbligatorio) |
thumbprint | Identificazione personale del certificato. | stringa (obbligatorio) |
ConfigurationApi
Nome | Descrizione | Valore |
---|---|---|
legacyApi | Indica se l'API di configurazione legacy (v1) deve essere esposta nel servizio Gestione API. Il valore è facoltativo, ma deve essere "Abilitato" o "Disabilitato". Se "Disabilitato", l'API di configurazione legacy (v1) non sarà disponibile per i gateway self-hosted. Il valore predefinito è 'Enabled' | 'Disabilitato' 'Enabled' |
ApiManagementServiceBasePropertiesProprietà personalizzate
Nome | Descrizione | Valore |
---|---|---|
{proprietà personalizzata} | string |
HostnameConfiguration
Nome | Descrizione | Valore |
---|---|---|
certificato | Informazioni sul certificato. | CertificateInformation |
certificatePassword | Password del certificato. | string |
certificateSource | Origine certificato. | 'BuiltIn' 'Custom' 'KeyVault' 'Gestito' |
certificateStatus | Stato certificato. | 'Completed' 'Failed' 'InProgress' |
defaultSslBinding | Specificare true per configurare il certificato associato a questo nome host come certificato SSL predefinito. Se un client non invia l'intestazione SNI, questo sarà il certificato che verrà contestato. La proprietà è utile se un servizio dispone di più nomi host personalizzati abilitati e deve decidere il certificato SSL predefinito. L'impostazione viene applicata solo al tipo di nome host del gateway. | bool |
encodedCertificate | Certificato con codifica Base64. | string |
hostName | Nome host da configurare nel servizio Gestione API. | stringa (obbligatorio) |
identityClientId | ClientId identità gestita assegnata dal sistema o dall'utente generato da Azure AD, che ha accesso GET all'insieme di credenziali delle chiavi contenente il certificato SSL. | string |
keyVaultId | URL del segreto KeyVault contenente il certificato SSL. Se viene fornito l'URL assoluto contenente la versione, l'aggiornamento automatico del certificato SSL non funzionerà. Ciò richiede che il servizio Gestione API sia configurato con aka.ms/apimmsi. Il segreto deve essere di tipo application/x-pkcs12 | string |
negotiateClientCertificate | Specificare true per negoziare sempre il certificato client nel nome host. Il valore predefinito è false. | bool |
tipo | Tipo nome host. | 'ConfigurationApi' 'DeveloperPortal' 'Gestione' 'Portal' 'Proxy' 'Scm' (obbligatorio) |
RemotePrivateEndpointConnectionWrapper
Nome | Descrizione | Valore |
---|---|---|
id | ID risorsa connessione endpoint privato | string |
name | Nome connessione endpoint privato | string |
properties | Proprietà delle risorse. | PrivateEndpointConnectionWrapperProperties |
tipo | Tipo di risorsa connessione endpoint privato | string |
PrivateEndpointConnectionWrapperProperties
Nome | Descrizione | Valore |
---|---|---|
privateEndpoint | Risorsa dell'endpoint privato. | ArmIdWrapper |
privateLinkServiceConnectionState | Raccolta di informazioni sullo stato della connessione tra il consumer del servizio e il provider. | PrivateLinkServiceConnectionState (obbligatorio) |
ArmIdWrapper
Questo oggetto non contiene proprietà da impostare durante la distribuzione. Tutte le proprietà sono ReadOnly.
PrivateLinkServiceConnectionState
Nome | Descrizione | Valore |
---|---|---|
actionsRequired | Messaggio che indica se le modifiche apportate al provider di servizi richiedono aggiornamenti nel consumer. | string |
description | Motivo dell'approvazione/rifiuto della connessione. | string |
status | Indica se la connessione è stata approvata/rifiutata/rimossa dal proprietario del servizio. | 'Approvato' 'In sospeso' 'Rifiutato' |
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à |
Distribuire Gestione API con un cache di Azure per Redis esterno |
Questo modello illustra come creare un'istanza di Azure Gestione API nel livello a consumo con un'istanza esterna di cache di Azure per Redis come cache esterna Gestione API. |
Distribuire Gestione API in una rete virtuale esterna con indirizzo IP pubblico |
Questo modello illustra come creare un'istanza di Azure Gestione API 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. |
Creare un'istanza di Gestione API con nomi host personalizzati |
Questo modello illustra come creare un'istanza di Azure Gestione API con nome host personalizzato per il portale e più nomi host personalizzati per il proxy |
Creare Gestione API nella rete virtuale interna con il gateway app |
Questo modello illustra come creare un'istanza di Azure Gestione API in una rete privata protetta da gateway applicazione di Azure. |
Distribuire Gestione API nella rete virtuale interna con l'indirizzo IP pubblico |
Questo modello illustra come creare un'istanza di Azure Gestione API 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. |
Creare un'istanza di Gestione API con identità MSI |
Questo modello crea un'istanza per sviluppatori di Azure Gestione API con un'identità MSI |
Creare un'istanza di livello Premium multiregion Gestione API |
Questo modello illustra come creare un'istanza di Gestione API con percorsi aggiuntivi. La posizione primaria corrisponde alla posizione del gruppo di risorse. Per altre posizioni, il modello mostra NorthCentralUs e Stati Uniti orientali2. La posizione primaria deve essere diversa da posizioni aggiuntive. |
Creare Gestione API con ssl proxy personalizzato usando KeyVault |
Questo modello illustra come creare un'istanza di Azure Gestione API e configurare il nome host personalizzato per il proxy con certificato SSL dall'insieme di credenziali delle chiavi. |
Creare un servizio di Gestione API con SSL da KeyVault |
Questo modello distribuisce un servizio Gestione API configurato con l'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 Gestione API'istanza |
Questo modello crea un'istanza del servizio azure Gestione API e dell'area di lavoro Log Analytics e configura il monitoraggio per il servizio Gestione API con Log Analytics |
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. |
Distribuire Gestione API in zone di disponibilità |
Questo modello crea un'istanza Premium di Azure Gestione API e viene distribuita in una zona di disponibilità |
Creare un'istanza di Gestione API tramite un modello |
Questo modello crea un'istanza per sviluppatori di Azure Gestione API |
Frontdoor Standard/Premium con origine Gestione API |
Questo modello crea un'istanza di Frontdoor Premium e un'istanza di Gestione API e usa un gruppo di sicurezza di rete e un criterio di Gestione API globale per verificare che il traffico provengano dall'origine di Frontdoor. |
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. |
gateway applicazione con Gestione API interno e app Web |
gateway applicazione instradare il traffico Internet a una rete virtuale (modalità interna) Gestione API'istanza che servizi un'API Web ospitata in un'app Web di Azure. |
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 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, aggiungere il codice JSON seguente al modello.
{
"type": "Microsoft.ApiManagement/service",
"apiVersion": "2023-05-01-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"{customized property}": "string"
"sku": {
"capacity": "int",
"name": "string"
},
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
"clientId": "string",
"principalId": "string"
}
}
},
"properties": {
"additionalLocations": [
{
"disableGateway": "bool",
"location": "string",
"natGatewayState": "string",
"publicIpAddressId": "string",
"sku": {
"capacity": "int",
"name": "string"
},
"virtualNetworkConfiguration": {
"subnetResourceId": "string"
},
"zones": [ "string" ]
}
],
"apiVersionConstraint": {
"minApiVersion": "string"
},
"certificates": [
{
"certificate": {
"expiry": "string",
"subject": "string",
"thumbprint": "string"
},
"certificatePassword": "string",
"encodedCertificate": "string",
"storeName": "string"
}
],
"configurationApi": {
"legacyApi": "string"
},
"customProperties": {
"{customized property}": "string"
},
"developerPortalStatus": "string",
"disableGateway": "bool",
"enableClientCertificate": "bool",
"hostnameConfigurations": [
{
"certificate": {
"expiry": "string",
"subject": "string",
"thumbprint": "string"
},
"certificatePassword": "string",
"certificateSource": "string",
"certificateStatus": "string",
"defaultSslBinding": "bool",
"encodedCertificate": "string",
"hostName": "string",
"identityClientId": "string",
"keyVaultId": "string",
"negotiateClientCertificate": "bool",
"type": "string"
}
],
"legacyPortalStatus": "string",
"natGatewayState": "string",
"notificationSenderEmail": "string",
"privateEndpointConnections": [
{
"id": "string",
"name": "string",
"properties": {
"privateEndpoint": {},
"privateLinkServiceConnectionState": {
"actionsRequired": "string",
"description": "string",
"status": "string"
}
},
"type": "string"
}
],
"publicIpAddressId": "string",
"publicNetworkAccess": "string",
"publisherEmail": "string",
"publisherName": "string",
"restore": "bool",
"virtualNetworkConfiguration": {
"subnetResourceId": "string"
},
"virtualNetworkType": "string"
},
"zones": [ "string" ]
}
Valori delle proprietà
service
Nome | Descrizione | Valore |
---|---|---|
tipo | Tipo di risorsa | 'Microsoft.ApiManagement/service' |
apiVersion | Versione dell'API della risorsa | '2023-05-01-preview' |
name | Nome della risorsa | stringa (obbligatorio) Limite di caratteri: 1-50 Caratteri validi: Caratteri alfanumerici e trattini. Inizia con la lettera e termina con alfanumerico. Il nome della risorsa deve essere univoco in Azure. |
posizione | Percorso della risorsa. | stringa (obbligatorio) |
tags | Tag delle risorse. | Dizionario di nomi e valori di tag. Vedere Tag nei modelli |
sku | Proprietà SKU del servizio Gestione API. | ApiManagementServiceSkuProperties (obbligatorio) |
identity | Identità del servizio gestito del servizio Gestione API. | ApiManagementServiceIdentity |
properties | Proprietà del servizio Gestione API. | ApiManagementServiceProperties (obbligatorio) |
zone | Elenco di zone di disponibilità che indicano da cui deve provenire la risorsa. | string[] |
ApiManagementServiceIdentity
Nome | Descrizione | Valore |
---|---|---|
tipo | Tipo di identità usata per la risorsa. Il tipo "SystemAssigned, UserAssigned" include sia un'identità creata in modo implicito che un set di identità assegnate dall'utente. Il tipo "Nessuno" rimuoverà le identità dal servizio. | 'Nessuno' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned' (obbligatorio) |
userAssignedIdentities | Elenco di identità utente associate alla risorsa. Identità dell'utente I riferimenti alle chiavi del dizionario saranno ID risorsa ARM nel formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. |
ApiManagementServiceIdentityUserAssignedIdentities |
ApiManagementServiceIdentityUserAssignedIdentities
Nome | Descrizione | Valore |
---|---|---|
{proprietà personalizzata} | UserIdentityProperties |
UserIdentityProperties
Nome | Descrizione | Valore |
---|---|---|
clientId | ID client dell'identità assegnata dall'utente. | string |
principalId | ID principale dell'identità assegnata dall'utente. | string |
ApiManagementServiceProperties
Nome | Descrizione | Valore |
---|---|---|
additionalLocations | Località del data center aggiuntive del servizio Gestione API. | AdditionalLocation[] |
apiVersionConstraint | Vincolo di versione api del piano di controllo per il servizio Gestione API. | ApiVersionConstraint |
certificates | Elenco di certificati che devono essere installati nel servizio Gestione API. Il numero massimo di certificati supportati che è possibile installare è 10. | CertificateConfiguration[] |
configurationApi | Configurazione dell'API di configurazione del servizio Gestione API. | ConfigurationApi |
Customproperties | Proprietà personalizzate del servizio Gestione API. L'impostazione Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 disabilita la crittografia TLS_RSA_WITH_3DES_EDE_CBC_SHA per tutti i protocolli TLS(1.0, 1.1 e 1.2).L'impostazione Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 può essere usata per disabilitare solo TLS 1.1.L'impostazione Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 può essere usata per disabilitare TLS 1.0 in un servizio di Gestione API.L'impostazione Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 può essere usata per disabilitare solo TLS 1.1 per le comunicazioni con back-end.L'impostazione Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 può essere usata per disabilitare TLS 1.0 per le comunicazioni con back-end.L'impostazione Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 può essere usata per abilitare il protocollo HTTP2 in un servizio Gestione API.Se non si specifica alcuna di queste proprietà nell'operazione PATCH, i valori delle proprietà verranno reimpostati sui valori predefiniti. Per tutte le impostazioni ad eccezione di Http2, il valore predefinito è True se il servizio è stato creato il 1° aprile 2018 e False in caso contrario. Il valore predefinito dell'impostazione Http2 è False .È possibile disabilitare una delle crittografie seguenti usando le impostazioni Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name] : TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. Ad esempio, Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256 :false . Il valore predefinito è true per loro.Nota: le crittografie seguenti non possono essere disabilitate perché sono richieste dai componenti interni della piattaforma: TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 |
ApiManagementServiceBasePropertiesProprietà personalizzate |
developerPortalStatus | Stato del portale per sviluppatori in questo servizio di Gestione API. | 'Disabilitato' 'Enabled' |
disableGateway | Proprietà valida solo per un servizio Gestione API distribuito in più posizioni. Può essere usato per disabilitare il gateway nell'area master. | bool |
enableClientCertificate | La proprietà deve essere usata solo per il servizio SKU a consumo. In questo modo viene applicato un certificato client da presentare a ogni richiesta al gateway. In questo modo è anche possibile autenticare il certificato nei criteri nel gateway. | bool |
hostnameConfigurations | Configurazione personalizzata del nome host del servizio di Gestione API. | HostnameConfiguration[] |
legacyPortalStatus | Stato del portale legacy nel servizio Gestione API. | 'Disabilitato' 'Enabled' |
natGatewayState | La proprietà può essere usata per abilitare il gateway NAT per questo servizio Gestione API. | 'Disabilitato' 'Enabled' |
notificationSenderEmail | Email indirizzo da cui verrà inviata la notifica. | string |
privateEndpointConnections | Elenco delle connessioni endpoint privato di questo servizio. | RemotePrivateEndpointConnectionWrapper[] |
publicIpAddressId | Indirizzo IP pubblico standard basato su IP V4 da associare a Rete virtuale servizio distribuito nell'area. Supportato solo per lo SKU Developer e Premium distribuito in Rete virtuale. | string |
publicNetworkAccess | Indica se l'accesso all'endpoint pubblico è consentito per questo servizio Gestione API. Il valore è facoltativo, ma se passato, deve essere 'Enabled' o 'Disabled'. Se "Disabilitato", gli endpoint privati sono il metodo di accesso esclusivo. Il valore predefinito è 'Enabled' | 'Disabilitato' 'Enabled' |
publisherEmail | Posta elettronica del server di pubblicazione. | stringa (obbligatoria) |
publisherName | Nome del server di pubblicazione. | stringa (obbligatoria) |
ripristinare | Annullare l'eliminazione temporanea del servizio Gestione API. Se questo flag viene specificato e impostato su True tutte le altre proprietà verranno ignorate. | bool |
virtualNetworkConfiguration | Configurazione della rete virtuale del servizio di Gestione API. | VirtualNetworkConfiguration |
virtualNetworkType | Tipo di VPN in cui è necessario configurare Gestione API servizio. Nessuna (valore predefinito) indica che il servizio Gestione API non fa parte di alcun Rete virtuale, external significa che la distribuzione Gestione API viene configurata all'interno di un Rete virtuale che ha un endpoint con connessione Internet e che la distribuzione interna Gestione API è configurata all'interno di un Rete virtuale solo un endpoint con connessione Intranet. | 'External' 'Internal' 'Nessuno' |
Spostamento aggiuntivo
Nome | Descrizione | Valore |
---|---|---|
disableGateway | Proprietà valida solo per un servizio Gestione API distribuito in più posizioni. Questa operazione può essere usata per disabilitare il gateway in questa posizione aggiuntiva. | bool |
posizione | Nome della posizione dell'area aggiuntiva tra le aree del data center di Azure. | stringa (obbligatoria) |
natGatewayState | La proprietà può essere usata per abilitare il gateway NAT per questo servizio Gestione API. | 'Disabilitato' 'Enabled' |
publicIpAddressId | Indirizzo IP basato su SKU standard pubblico V4 da associare a Rete virtuale servizio distribuito nel percorso. Supportato solo per lo SKU Premium distribuito in Rete virtuale. | string |
sku | Proprietà SKU del servizio Gestione API. | ApiManagementServiceSkuProperties (obbligatorio) |
virtualNetworkConfiguration | Configurazione della rete virtuale per il percorso. | VirtualNetworkConfiguration |
zone | Elenco delle zone di disponibilità che denonono dove deve venire la risorsa. | string[] |
ApiManagementServiceSkuProperties
Nome | Descrizione | Valore |
---|---|---|
capacità | Capacità dello SKU (numero di unità distribuite dello SKU). Per la capacità SKU consumo deve essere specificato come 0. | int (obbligatorio) |
name | Nome dello Sku. | 'Basic' 'BasicV2' 'Consumo' 'Developer' 'Isolato' 'Premium' 'Standard' 'StandardV2' (obbligatorio) |
VirtualNetworkConfiguration
Nome | Descrizione | Valore |
---|---|---|
subnetResourceId | ID risorsa completo di una subnet in una rete virtuale per distribuire il servizio Gestione API in. | string |
ApiVersionConstraint
Nome | Descrizione | Valore |
---|---|---|
minApiVersion | Limitare le chiamate API del piano di controllo a Gestione API servizio con versione uguale o successiva a questo valore. | string |
CertificateConfiguration
Nome | Descrizione | Valore |
---|---|---|
certificato | Informazioni sul certificato. | CertificateInformation |
certificatePassword | Password del certificato. | string |
codificadCertificate | Certificato codificato base64. | string |
storeName | Percorso dell'archivio certificati System.Security.Cryptography.x509certificates.StoreName. Solo Root e CertificateAuthority sono posizioni valide. | 'CertificateAuthority' 'Root' (obbligatorio) |
CertificateInformation
Nome | Descrizione | Valore |
---|---|---|
expiry | Data di scadenza del certificato. La data è conforme al formato seguente: yyyy-MM-ddTHH:mm:ssZ come specificato dallo standard ISO 8601. |
stringa (obbligatoria) |
subject | Oggetto del certificato. | stringa (obbligatoria) |
thumbprint | Identificazione personale del certificato. | stringa (obbligatoria) |
ConfigurationApi
Nome | Descrizione | Valore |
---|---|---|
legacyApi | Indica se l'API di configurazione legacy (v1) deve essere esposta nel servizio Gestione API. Il valore è facoltativo, ma deve essere "Abilitato" o "Disabilitato". Se 'Disabilitato', l'API di configurazione legacy (v1) non sarà disponibile per i gateway self-hosted. Il valore predefinito è 'Enabled' | 'Disabilitato' 'Enabled' |
ApiManagementServiceBasePropertiesCustomProperties
Nome | Descrizione | Valore |
---|---|---|
{proprietà personalizzata} | string |
HostnameConfiguration
Nome | Descrizione | Valore |
---|---|---|
certificato | Informazioni sul certificato. | CertificateInformation |
certificatePassword | Password del certificato. | string |
CertificateSource | Origine certificati. | 'BuiltIn' 'Personalizzato' 'KeyVault' 'Gestito' |
certificateStatus | Stato certificato. | 'Completato' 'Non riuscito' 'InProgress' |
defaultSslBinding | Specificare true per configurare il certificato associato a questo nome host come certificato SSL predefinito. Se un client non invia l'intestazione SNI, questo sarà il certificato che verrà contestato. La proprietà è utile se un servizio dispone di più nomi host personalizzati abilitati e deve decidere sul certificato ssl predefinito. L'impostazione applicata solo al tipo host del gateway. | bool |
codificadCertificate | Certificato codificato base64. | string |
hostName | Nome host da configurare nel servizio Gestione API. | stringa (obbligatoria) |
identityClientId | Client dell'identità gestita assegnata dall'utente o del sistema come generato da Azure AD, che ha accesso GET alla chiaveVault contenente il certificato SSL. | string |
keyVaultId | Url del segreto KeyVault contenente il certificato SSL. Se viene fornito l'URL assoluto contenente la versione, l'aggiornamento automatico del certificato ssl non funzionerà. Ciò richiede la configurazione del servizio Gestione API con aka.ms/apimmsi. Il segreto deve essere di tipo application/x-pkcs12 | string |
negotiateClientCertificate | Specificare true per negoziare sempre il certificato client nel nome host. Valore predefinito è false. | bool |
tipo | Tipo hostname. | 'ConfigurationApi' 'DeveloperPortal' 'Gestione' 'Portal' 'Proxy' 'Scm' (obbligatorio) |
RemotePrivateEndpointConnectionWrapper
Nome | Descrizione | Valore |
---|---|---|
id | ID risorsa connessione endpoint privato | string |
name | Nome connessione endpoint privato | string |
properties | Proprietà delle risorse. | PrivateEndpointConnectionWrapperProperties |
tipo | Tipo di risorsa connessione endpoint privato | string |
PrivateEndpointConnectionWrapperProperties
Nome | Descrizione | Valore |
---|---|---|
privateEndpoint | Risorsa dell'endpoint privato. | ArmIdWrapper |
privateLinkServiceConnectionState | Raccolta di informazioni sullo stato della connessione tra il consumer del servizio e il provider. | PrivateLinkServiceConnectionState (obbligatorio) |
ArmIdWrapper
Questo oggetto non contiene proprietà da impostare durante la distribuzione. Tutte le proprietà sono ReadOnly.
PrivateLinkServiceConnectionState
Nome | Descrizione | Valore |
---|---|---|
actionsRequired | Messaggio che indica se le modifiche apportate al provider di servizi richiedono aggiornamenti nel consumer. | string |
description | Motivo dell'approvazione/rifiuto della connessione. | string |
status | Indica se la connessione è stata approvata/rifiutata/rimossa dal proprietario del servizio. | 'Approvato' 'In sospeso' 'Rifiutato' |
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à |
Distribuire Gestione API con un cache di Azure per Redis esterno |
Questo modello illustra come creare un'istanza di Azure Gestione API nel livello a consumo con un'istanza esterna di cache di Azure per Redis come cache esterna Gestione API. |
Distribuire Gestione API in una rete virtuale esterna con indirizzo IP pubblico |
Questo modello illustra come creare un'istanza di Azure Gestione API 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. |
Creare un'istanza di Gestione API con nomi host personalizzati |
Questo modello illustra come creare un'istanza di Azure Gestione API con nome host personalizzato per il portale e più nomi host personalizzati per il proxy |
Creare Gestione API nella rete virtuale interna con il gateway app |
Questo modello illustra come creare un'istanza di Azure Gestione API in una rete privata protetta da gateway applicazione di Azure. |
Distribuire Gestione API nella rete virtuale interna con l'indirizzo IP pubblico |
Questo modello illustra come creare un'istanza di Azure Gestione API 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. |
Creare un'istanza di Gestione API con identità MSI |
Questo modello crea un'istanza per sviluppatori di Azure Gestione API con un'identità MSI |
Creare un'istanza di livello Premium multiregion Gestione API |
Questo modello illustra come creare un'istanza di Gestione API con percorsi aggiuntivi. La posizione primaria corrisponde alla posizione del gruppo di risorse. Per altre posizioni, il modello mostra NorthCentralUs e Stati Uniti orientali2. La posizione primaria deve essere diversa da posizioni aggiuntive. |
Creare Gestione API con ssl proxy personalizzato usando KeyVault |
Questo modello illustra come creare un'istanza di Azure Gestione API e configurare il nome host personalizzato per il proxy con certificato SSL dall'insieme di credenziali delle chiavi. |
Creare un servizio di Gestione API con SSL da KeyVault |
Questo modello distribuisce un servizio Gestione API configurato con l'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 Gestione API'istanza |
Questo modello crea un'istanza del servizio azure Gestione API e dell'area di lavoro Log Analytics e configura il monitoraggio per il servizio Gestione API con Log Analytics |
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. |
Distribuire Gestione API in zone di disponibilità |
Questo modello crea un'istanza Premium di Azure Gestione API e viene distribuita in una zona di disponibilità |
Creare un'istanza di Gestione API tramite un modello |
Questo modello crea un'istanza per sviluppatori di Azure Gestione API |
Frontdoor Standard/Premium con origine Gestione API |
Questo modello crea un'istanza di Frontdoor Premium e un'istanza di Gestione API e usa un gruppo di sicurezza di rete e un criterio di Gestione API globale per verificare che il traffico provengano dall'origine di Frontdoor. |
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. |
gateway applicazione con Gestione API interno e app Web |
gateway applicazione instradare il traffico Internet a una rete virtuale (modalità interna) Gestione API'istanza che servizi un'API Web ospitata in un'app Web di Azure. |
Definizione della 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 di risorsa
Per creare una risorsa Microsoft.ApiManagement/service, aggiungere il codice Terraform seguente al modello.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service@2023-05-01-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
{customized property} = "string"
identity {
type = "string"
identity_ids = []
}
body = jsonencode({
properties = {
additionalLocations = [
{
disableGateway = bool
location = "string"
natGatewayState = "string"
publicIpAddressId = "string"
sku = {
capacity = int
name = "string"
}
virtualNetworkConfiguration = {
subnetResourceId = "string"
}
zones = [
"string"
]
}
]
apiVersionConstraint = {
minApiVersion = "string"
}
certificates = [
{
certificate = {
expiry = "string"
subject = "string"
thumbprint = "string"
}
certificatePassword = "string"
encodedCertificate = "string"
storeName = "string"
}
]
configurationApi = {
legacyApi = "string"
}
customProperties = {
{customized property} = "string"
}
developerPortalStatus = "string"
disableGateway = bool
enableClientCertificate = bool
hostnameConfigurations = [
{
certificate = {
expiry = "string"
subject = "string"
thumbprint = "string"
}
certificatePassword = "string"
certificateSource = "string"
certificateStatus = "string"
defaultSslBinding = bool
encodedCertificate = "string"
hostName = "string"
identityClientId = "string"
keyVaultId = "string"
negotiateClientCertificate = bool
type = "string"
}
]
legacyPortalStatus = "string"
natGatewayState = "string"
notificationSenderEmail = "string"
privateEndpointConnections = [
{
id = "string"
name = "string"
properties = {
privateEndpoint = {}
privateLinkServiceConnectionState = {
actionsRequired = "string"
description = "string"
status = "string"
}
}
type = "string"
}
]
publicIpAddressId = "string"
publicNetworkAccess = "string"
publisherEmail = "string"
publisherName = "string"
restore = bool
virtualNetworkConfiguration = {
subnetResourceId = "string"
}
virtualNetworkType = "string"
}
zones = [
"string"
]
sku = {
capacity = int
name = "string"
}
})
}
Valori delle proprietà
service
Nome | Descrizione | Valore |
---|---|---|
tipo | Tipo di risorsa | "Microsoft.ApiManagement/service@2023-05-01-preview" |
name | Nome della risorsa | stringa (obbligatoria) Limite di caratteri: 1-50 Caratteri validi: Caratteri alfanumerici e trattini. Inizia con la lettera e termina con alfanumerico. Il nome della risorsa deve essere univoco in Azure. |
posizione | Percorso della risorsa. | stringa (obbligatoria) |
parent_id | Per distribuire in un gruppo di risorse, usare l'ID del gruppo di risorse. | stringa (obbligatoria) |
tags | Tag di risorse. | Dizionario dei nomi e dei valori dei tag. |
sku | Proprietà SKU del servizio Gestione API. | ApiManagementServiceSkuProperties (obbligatorio) |
identity | Identità del servizio gestito del servizio Gestione API. | ApiManagementServiceIdentity |
properties | Proprietà del servizio Gestione API. | ApiManagementServiceProperties (obbligatorio) |
zone | Elenco delle zone di disponibilità che denonono dove deve venire la risorsa. | string[] |
ApiManagementServiceIdentity
Nome | Descrizione | Valore |
---|---|---|
tipo | Tipo di identità utilizzata per la risorsa. Il tipo 'SystemAssigned, UserAssigned' include sia un'identità creata in modo implicito che un set di identità assegnate dall'utente. Il tipo 'Nessuno' rimuoverà le identità dal servizio. | "SystemAssigned" "SystemAssigned, UserAssigned" "UserAssigned" (obbligatorio) |
identity_ids | Elenco delle identità utente associate alla risorsa. Identità utente i riferimenti alle chiavi dizionario saranno ID risorsa ARM nel formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. |
Matrice di ID identità utente. |
ApiManagementServiceIdentityUserAssignedIdentities
Nome | Descrizione | Valore |
---|---|---|
{proprietà personalizzata} | UserIdentityProperties |
UserIdentityProperties
Nome | Descrizione | Valore |
---|---|---|
clientId | ID client dell'identità assegnata dall'utente. | string |
principalId | ID principale dell'identità assegnata dall'utente. | string |
ApiManagementServiceProperties
Nome | Descrizione | Valore |
---|---|---|
additionalLocations | Località del data center aggiuntive del servizio Gestione API. | AdditionalLocation[] |
apiVersionConstraint | Vincolo di versione api piano di controllo per il servizio Gestione API. | ApiVersionConstraint |
certificates | Elenco di certificati che devono essere installati nel servizio Gestione API. Il numero massimo di certificati supportati che possono essere installati è 10. | CertificateConfiguration[] |
configurationApi | Configurazione dell'API di configurazione del servizio Gestione API. | ConfigurationApi |
Customproperties | Proprietà personalizzate del servizio Gestione API. L'impostazione Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 disabilita il TLS_RSA_WITH_3DES_EDE_CBC_SHA di crittografia per tutti i file TLS(1.0, 1.1 e 1.2).L'impostazione Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 può essere usata per disabilitare solo TLS 1.1.L'impostazione Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 può essere usata per disabilitare TLS 1.0 in un servizio di Gestione API.L'impostazione Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 può essere usata per disabilitare solo TLS 1.1 per le comunicazioni con back-end.L'impostazione Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 può essere usata per disabilitare TLS 1.0 per le comunicazioni con back-end.L'impostazione Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 può essere usata per abilitare il protocollo HTTP2 in un servizio di Gestione API.Non specificando alcuna di queste proprietà nell'operazione PATCH, i valori delle proprietà verranno ripristinati nei valori predefiniti. Per tutte le impostazioni tranne Http2 il valore predefinito è True se il servizio è stato creato o prima del 1° aprile 2018 e False in caso contrario. Il valore predefinito dell'impostazione Http2 è False .È possibile disabilitare una delle crittografia seguenti usando le impostazioni Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name] : TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. Ad esempio, Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256 :false . Il valore predefinito è true per loro.Nota: le crittografia seguenti non possono essere disabilitate poiché sono necessarie dai componenti della piattaforma interna: TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 |
ApiManagementServiceBasePropertiesProprietà personalizzate |
developerPortalStatus | Stato del portale per sviluppatori in questo servizio di Gestione API. | "Disabilitato" "Abilitato" |
disableGateway | Proprietà valida solo per un servizio Gestione API distribuito in più posizioni. Può essere usato per disabilitare il gateway nell'area master. | bool |
enableClientCertificate | La proprietà deve essere usata solo per il servizio SKU a consumo. In questo modo viene applicato un certificato client da presentare a ogni richiesta al gateway. In questo modo è anche possibile autenticare il certificato nei criteri nel gateway. | bool |
hostnameConfigurations | Configurazione personalizzata del nome host del servizio di Gestione API. | HostnameConfiguration[] |
legacyPortalStatus | Stato del portale legacy nel servizio Gestione API. | "Disabilitato" "Abilitato" |
natGatewayState | La proprietà può essere usata per abilitare il gateway NAT per questo servizio Gestione API. | "Disabilitato" "Abilitato" |
notificationSenderEmail | Email indirizzo da cui verrà inviata la notifica. | string |
privateEndpointConnections | Elenco delle connessioni endpoint privato di questo servizio. | RemotePrivateEndpointConnectionWrapper[] |
publicIpAddressId | Indirizzo IP pubblico standard basato su IP V4 da associare a Rete virtuale servizio distribuito nell'area. Supportato solo per lo SKU Developer e Premium distribuito in Rete virtuale. | string |
publicNetworkAccess | Indica se l'accesso all'endpoint pubblico è consentito per questo servizio Gestione API. Il valore è facoltativo, ma se passato, deve essere 'Enabled' o 'Disabled'. Se "Disabilitato", gli endpoint privati sono il metodo di accesso esclusivo. Il valore predefinito è 'Enabled' | "Disabilitato" "Abilitato" |
publisherEmail | Indirizzo di posta elettronica dell'editore. | stringa (obbligatorio) |
publisherName | Nome del server di pubblicazione. | stringa (obbligatorio) |
ripristinare | Annullare l'eliminazione del servizio Gestione API se è stato eliminato soft in precedenza. Se questo flag viene specificato e impostato su True, tutte le altre proprietà verranno ignorate. | bool |
virtualNetworkConfiguration | Configurazione della rete virtuale del servizio Gestione API. | VirtualNetworkConfiguration |
virtualNetworkType | Tipo di VPN in cui Gestione API servizio deve essere configurato. Nessuno (valore predefinito) indica che il servizio Gestione API non fa parte di alcuna Rete virtuale, external indica che la distribuzione Gestione API è configurata all'interno di un Rete virtuale con un endpoint con connessione Internet e internal significa che Gestione API distribuzione è configurata all'interno di un Rete virtuale avere solo un endpoint con connessione Intranet. | "Esterno" "Interno" "None" |
AdditionalLocation
Nome | Descrizione | Valore |
---|---|---|
disableGateway | Proprietà valida solo per un servizio Gestione API distribuito in più posizioni. Questa opzione può essere usata per disabilitare il gateway in questo percorso aggiuntivo. | bool |
posizione | Nome della località dell'area aggiuntiva tra le aree del data center di Azure. | stringa (obbligatorio) |
natGatewayState | La proprietà può essere usata per abilitare il gateway NAT per questo servizio Gestione API. | "Disabilitato" "Abilitato" |
publicIpAddressId | Indirizzo IP pubblico standard basato su IP V4 da associare a Rete virtuale servizio distribuito nel percorso. Supportato solo per lo SKU Premium distribuito in Rete virtuale. | string |
sku | Proprietà SKU del servizio Gestione API. | ApiManagementServiceSkuProperties (obbligatorio) |
virtualNetworkConfiguration | Configurazione della rete virtuale per il percorso. | VirtualNetworkConfiguration |
zone | Elenco di zone di disponibilità che indicano da cui deve provenire la risorsa. | string[] |
ApiManagementServiceSkuProperties
Nome | Descrizione | Valore |
---|---|---|
capacità | Capacità dello SKU (numero di unità distribuite dello SKU). Per la capacità SKU a consumo deve essere specificato come 0. | int (obbligatorio) |
name | Nome dello SKU. | "Basic" "BasicV2" "Consumo" "Sviluppatore" "Isolato" "Premium" "Standard" "StandardV2" (obbligatorio) |
VirtualNetworkConfiguration
Nome | Descrizione | Valore |
---|---|---|
subnetResourceId | ID risorsa completo di una subnet in una rete virtuale in cui distribuire il servizio Gestione API. | string |
ApiVersionConstraint
Nome | Descrizione | Valore |
---|---|---|
minApiVersion | Limitare le chiamate API del piano di controllo a Gestione API servizio con versione uguale o successiva a questo valore. | string |
CertificateConfiguration
Nome | Descrizione | Valore |
---|---|---|
certificato | Informazioni sul certificato. | CertificateInformation |
certificatePassword | Password del certificato. | string |
encodedCertificate | Certificato con codifica Base64. | string |
storeName | Percorso dell'archivio certificati System.Security.Cryptography.x509certificates.StoreName. Solo Root e CertificateAuthority sono percorsi validi. | "CertificateAuthority" "Root" (obbligatorio) |
CertificateInformation
Nome | Descrizione | Valore |
---|---|---|
expiry | Data di scadenza del certificato. La data è conforme al formato seguente: yyyy-MM-ddTHH:mm:ssZ come specificato dallo standard ISO 8601. |
stringa (obbligatorio) |
subject | Oggetto del certificato. | stringa (obbligatorio) |
thumbprint | Identificazione personale del certificato. | stringa (obbligatorio) |
ConfigurationApi
Nome | Descrizione | Valore |
---|---|---|
legacyApi | Indica se l'API di configurazione legacy (v1) deve essere esposta nel servizio Gestione API. Il valore è facoltativo, ma deve essere "Abilitato" o "Disabilitato". Se "Disabilitato", l'API di configurazione legacy (v1) non sarà disponibile per i gateway self-hosted. Il valore predefinito è 'Enabled' | "Disabilitato" "Abilitato" |
ApiManagementServiceBasePropertiesProprietà personalizzate
Nome | Descrizione | Valore |
---|---|---|
{proprietà personalizzata} | string |
HostnameConfiguration
Nome | Descrizione | Valore |
---|---|---|
certificato | Informazioni sul certificato. | CertificateInformation |
certificatePassword | Password del certificato. | string |
certificateSource | Origine certificato. | "BuiltIn" "Custom" "KeyVault" "Gestito" |
certificateStatus | Stato certificato. | "Completato" "Failed" "InProgress" |
defaultSslBinding | Specificare true per configurare il certificato associato a questo nome host come certificato SSL predefinito. Se un client non invia l'intestazione SNI, questo sarà il certificato che verrà contestato. La proprietà è utile se un servizio dispone di più nomi host personalizzati abilitati e deve decidere il certificato SSL predefinito. L'impostazione viene applicata solo al tipo di nome host del gateway. | bool |
encodedCertificate | Certificato con codifica Base64. | string |
hostName | Nome host da configurare nel servizio Gestione API. | stringa (obbligatorio) |
identityClientId | ClientId identità gestita assegnata dal sistema o dall'utente generato da Azure AD, che ha accesso GET all'insieme di credenziali delle chiavi contenente il certificato SSL. | string |
keyVaultId | URL del segreto KeyVault contenente il certificato SSL. Se viene fornito l'URL assoluto contenente la versione, l'aggiornamento automatico del certificato SSL non funzionerà. Ciò richiede che il servizio Gestione API sia configurato con aka.ms/apimmsi. Il segreto deve essere di tipo application/x-pkcs12 | string |
negotiateClientCertificate | Specificare true per negoziare sempre il certificato client nel nome host. Il valore predefinito è false. | bool |
tipo | Tipo nome host. | "ConfigurationApi" "DeveloperPortal" "Gestione" "Portale" "Proxy" "Scm" (obbligatorio) |
RemotePrivateEndpointConnectionWrapper
Nome | Descrizione | Valore |
---|---|---|
id | ID risorsa connessione endpoint privato | string |
name | Nome connessione endpoint privato | string |
properties | Proprietà delle risorse. | PrivateEndpointConnectionWrapperProperties |
tipo | Tipo di risorsa connessione endpoint privato | string |
PrivateEndpointConnectionWrapperProperties
Nome | Descrizione | Valore |
---|---|---|
privateEndpoint | Risorsa dell'endpoint privato. | ArmIdWrapper |
privateLinkServiceConnectionState | Raccolta di informazioni sullo stato della connessione tra il consumer del servizio e il provider. | PrivateLinkServiceConnectionState (obbligatorio) |
ArmIdWrapper
Questo oggetto non contiene proprietà da impostare durante la distribuzione. Tutte le proprietà sono ReadOnly.
PrivateLinkServiceConnectionState
Nome | Descrizione | Valore |
---|---|---|
actionsRequired | Messaggio che indica se le modifiche apportate al provider di servizi richiedono aggiornamenti nel consumer. | string |
description | Motivo dell'approvazione/rifiuto della connessione. | string |
status | Indica se la connessione è stata approvata/rifiutata/rimossa dal proprietario del servizio. | "Approvato" "In sospeso" "Rifiutato" |
Commenti e suggerimenti
https://aka.ms/ContentUserFeedback.
Presto disponibile: Nel corso del 2024 verranno gradualmente disattivati i problemi di GitHub come meccanismo di feedback per il contenuto e ciò verrà sostituito con un nuovo sistema di feedback. Per altre informazioni, vedereInvia e visualizza il feedback per