Condividi tramite

ApiManagementServiceBaseProperties interface

  • Riferimento
Pacchetto:
@azure/arm-apimanagement

Proprietà di base di una descrizione della risorsa del servizio Gestione API.

Proprietà

additionalLocations

Località del data center aggiuntive del servizio Gestione API.
apiVersionConstraint

Vincolo di versione api del piano di controllo per il servizio Gestione API.
certificates

Elenco di certificati che devono essere installati nel servizio Gestione API. Il numero massimo di certificati supportati che è possibile installare è 10.
createdAtUtc

Data UTC di creazione del servizio Gestione API. La data è conforme al formato seguente: yyyy-MM-ddTHH:mm:ssZ come specificato dallo standard ISO 8601. NOTA: questa proprietà non verrà serializzata. Può essere popolata solo dal server.
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 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 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
developerPortalUrl

URL dell'endpoint del portale DEveloper del servizio Gestione API. NOTA: questa proprietà non verrà serializzata. Può essere popolata solo dal server.
disableGateway

Proprietà valida solo per un servizio Gestione API distribuito in più posizioni. Può essere usato per disabilitare il gateway nell'area master.
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.
gatewayRegionalUrl

URL del gateway del servizio Gestione API nell'area predefinita. NOTA: questa proprietà non verrà serializzata. Può essere popolata solo dal server.
gatewayUrl

URL del gateway del servizio Gestione API. NOTA: questa proprietà non verrà serializzata. Può essere popolata solo dal server.
hostnameConfigurations

Configurazione personalizzata del nome host del servizio di Gestione API.
managementApiUrl

URL dell'endpoint dell'API di gestione del servizio Gestione API. NOTA: questa proprietà non verrà serializzata. Può essere popolata solo dal server.
natGatewayState

La proprietà può essere usata per abilitare il gateway NAT per questo servizio Gestione API.
notificationSenderEmail

Email indirizzo da cui verrà inviata la notifica.
outboundPublicIPAddresses

Prefissi di indirizzi IPV4 pubblici in uscita associati al servizio distribuito gateway NAT. Disponibile solo per lo SKU Premium nella piattaforma stv2. NOTA: questa proprietà non verrà serializzata. Può essere popolata solo dal server.
platformVersion

Versione della piattaforma di calcolo che esegue il servizio in questa posizione. NOTA: questa proprietà non verrà serializzata. Può essere popolata solo dal server.
portalUrl

URL dell'endpoint del portale di pubblicazione del servizio Gestione API. NOTA: questa proprietà non verrà serializzata. Può essere popolata solo dal server.
privateEndpointConnections

Elenco delle connessioni endpoint privato di questo servizio.
privateIPAddresses

Indirizzi IP con carico bilanciato statico privato del servizio Gestione API nell'area primaria distribuita in un Rete virtuale interno. Disponibile solo per SKU Basic, Standard, Premium e Isolato. NOTA: questa proprietà non verrà serializzata. Può essere popolata solo dal server.
provisioningState

Stato di provisioning corrente del servizio di Gestione API che può essere uno dei seguenti: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted. NOTA: questa proprietà non verrà serializzata. Può essere popolata solo dal server.
publicIPAddresses

Indirizzi IP con carico bilanciato statico pubblico del servizio Gestione API nell'area primaria. Disponibile solo per SKU Basic, Standard, Premium e Isolato. NOTA: questa proprietà non verrà serializzata. Può essere popolata solo dal server.
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.
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'
restore

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

URL dell'endpoint SCM del servizio Gestione API. NOTA: questa proprietà non verrà serializzata. Può essere popolata solo dal server.
targetProvisioningState

Stato di provisioning del servizio Gestione API, destinato all'operazione a esecuzione prolungata avviata nel servizio. NOTA: questa proprietà non verrà serializzata. Può essere popolata solo dal server.
virtualNetworkConfiguration

Configurazione della rete virtuale del servizio Gestione API.
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.

Dettagli proprietà

additionalLocations

Località del data center aggiuntive del servizio Gestione API.

additionalLocations?: AdditionalLocation[]

Valore della proprietà

AdditionalLocation[]

apiVersionConstraint

Vincolo di versione api del piano di controllo per il servizio Gestione API.

apiVersionConstraint?: ApiVersionConstraint

Valore della proprietà

ApiVersionConstraint

certificates

Elenco di certificati che devono essere installati nel servizio Gestione API. Il numero massimo di certificati supportati che è possibile installare è 10.

certificates?: CertificateConfiguration[]

Valore della proprietà

CertificateConfiguration[]

createdAtUtc

Data UTC di creazione del servizio Gestione API. La data è conforme al formato seguente: yyyy-MM-ddTHH:mm:ssZ come specificato dallo standard ISO 8601. NOTA: questa proprietà non verrà serializzata. Può essere popolata solo dal server.

createdAtUtc?: Date

Valore della proprietà

Date

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

customProperties?: {[propertyName: string]: string}

Valore della proprietà

{[propertyName: string]: string}

developerPortalUrl

URL dell'endpoint del portale DEveloper del servizio Gestione API. NOTA: questa proprietà non verrà serializzata. Può essere popolata solo dal server.

developerPortalUrl?: string

Valore della proprietà

string

disableGateway

Proprietà valida solo per un servizio Gestione API distribuito in più posizioni. Può essere usato per disabilitare il gateway nell'area master.

disableGateway?: boolean

Valore della proprietà

boolean

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.

enableClientCertificate?: boolean

Valore della proprietà

boolean

gatewayRegionalUrl

URL del gateway del servizio Gestione API nell'area predefinita. NOTA: questa proprietà non verrà serializzata. Può essere popolata solo dal server.

gatewayRegionalUrl?: string

Valore della proprietà

string

gatewayUrl

URL del gateway del servizio Gestione API. NOTA: questa proprietà non verrà serializzata. Può essere popolata solo dal server.

gatewayUrl?: string

Valore della proprietà

string

hostnameConfigurations

Configurazione personalizzata del nome host del servizio di Gestione API.

hostnameConfigurations?: HostnameConfiguration[]

Valore della proprietà

HostnameConfiguration[]

managementApiUrl

URL dell'endpoint dell'API di gestione del servizio Gestione API. NOTA: questa proprietà non verrà serializzata. Può essere popolata solo dal server.

managementApiUrl?: string

Valore della proprietà

string

natGatewayState

La proprietà può essere usata per abilitare il gateway NAT per questo servizio Gestione API.

natGatewayState?: string

Valore della proprietà

string

notificationSenderEmail

Email indirizzo da cui verrà inviata la notifica.

notificationSenderEmail?: string

Valore della proprietà

string

outboundPublicIPAddresses

Prefissi di indirizzi IPV4 pubblici in uscita associati al servizio distribuito gateway NAT. Disponibile solo per lo SKU Premium nella piattaforma stv2. NOTA: questa proprietà non verrà serializzata. Può essere popolata solo dal server.

outboundPublicIPAddresses?: string[]

Valore della proprietà

string[]

platformVersion

Versione della piattaforma di calcolo che esegue il servizio in questa posizione. NOTA: questa proprietà non verrà serializzata. Può essere popolata solo dal server.

platformVersion?: string

Valore della proprietà

string

portalUrl

URL dell'endpoint del portale di pubblicazione del servizio Gestione API. NOTA: questa proprietà non verrà serializzata. Può essere popolata solo dal server.

portalUrl?: string

Valore della proprietà

string

privateEndpointConnections

Elenco delle connessioni endpoint privato di questo servizio.

privateEndpointConnections?: RemotePrivateEndpointConnectionWrapper[]

Valore della proprietà

RemotePrivateEndpointConnectionWrapper[]

privateIPAddresses

Indirizzi IP con carico bilanciato statico privato del servizio Gestione API nell'area primaria distribuita in un Rete virtuale interno. Disponibile solo per SKU Basic, Standard, Premium e Isolato. NOTA: questa proprietà non verrà serializzata. Può essere popolata solo dal server.

privateIPAddresses?: string[]

Valore della proprietà

string[]

provisioningState

Stato di provisioning corrente del servizio di Gestione API che può essere uno dei seguenti: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted. NOTA: questa proprietà non verrà serializzata. Può essere popolata solo dal server.

provisioningState?: string

Valore della proprietà

string

publicIPAddresses

Indirizzi IP con carico bilanciato statico pubblico del servizio Gestione API nell'area primaria. Disponibile solo per SKU Basic, Standard, Premium e Isolato. NOTA: questa proprietà non verrà serializzata. Può essere popolata solo dal server.

publicIPAddresses?: string[]

Valore della proprietà

string[]

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.

publicIpAddressId?: string

Valore della proprietà

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'

publicNetworkAccess?: string

Valore della proprietà

string

restore

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.

restore?: boolean

Valore della proprietà

boolean

scmUrl

URL dell'endpoint SCM del servizio Gestione API. NOTA: questa proprietà non verrà serializzata. Può essere popolata solo dal server.

scmUrl?: string

Valore della proprietà

string

targetProvisioningState

Stato di provisioning del servizio Gestione API, destinato all'operazione a esecuzione prolungata avviata nel servizio. NOTA: questa proprietà non verrà serializzata. Può essere popolata solo dal server.

targetProvisioningState?: string

Valore della proprietà

string

virtualNetworkConfiguration

Configurazione della rete virtuale del servizio Gestione API.

virtualNetworkConfiguration?: VirtualNetworkConfiguration

Valore della proprietà

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.

virtualNetworkType?: string

Valore della proprietà

string