ApiManagementServiceResource interface

Pacchetto:

@azure/arm-apimanagement

Una singola risorsa del servizio Gestione API in Elenco o Ottieni risposta.

Extends

ApimResource

Proprietà

additionalLocations	Località del data center aggiuntive del servizio Gestione API.
apiVersionConstraint	Vincolo di versione delle 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 popolato solo dal server.
customProperties	Proprietà personalizzate del servizio Gestione API. Impostazione Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 disabiliterà 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. 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. Non specificare alcuna di queste proprietà nell'operazione PATCH reimposta i valori delle proprietà omessi nei valori predefiniti. Per tutte le impostazioni tranne 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. 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 popolato 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.
etag	ETag della risorsa. NOTA: questa proprietà non verrà serializzata. Può essere popolato solo dal server.
gatewayRegionalUrl	URL del gateway del servizio Gestione API nell'area predefinita. NOTA: questa proprietà non verrà serializzata. Può essere popolato solo dal server.
gatewayUrl	URL del gateway del servizio Gestione API. NOTA: questa proprietà non verrà serializzata. Può essere popolato solo dal server.
hostnameConfigurations	Configurazione del nome host personalizzato del servizio Gestione API.
identity	Identità del servizio gestito del servizio Gestione API.
location	Percorso della risorsa.
managementApiUrl	URL dell'endpoint dell'API di gestione del servizio Gestione API. NOTA: questa proprietà non verrà serializzata. Può essere popolato solo dal server.
natGatewayState	La proprietà può essere usata per abilitare il gateway NAT per questo servizio Gestione API.
notificationSenderEmail	Indirizzo di posta elettronica da cui verrà inviata la notifica.
outboundPublicIPAddresses	Prefissi di indirizzi IPV4 pubblici in uscita associati al servizio distribuito del gateway NAT. Disponibile solo per sku Premium nella piattaforma stv2. NOTA: questa proprietà non verrà serializzata. Può essere popolato solo dal server.
platformVersion	Versione della piattaforma di calcolo che esegue il servizio in questa posizione. NOTA: questa proprietà non verrà serializzata. Può essere popolato solo dal server.
portalUrl	URL dell'endpoint del portale di pubblicazione del servizio Gestione API. NOTA: questa proprietà non verrà serializzata. Può essere popolato solo dal server.
privateEndpointConnections	Elenco delle connessioni endpoint private di questo servizio.
privateIPAddresses	Indirizzi IP statici con carico bilanciato privato del servizio Gestione API nell'area primaria distribuita in una rete virtuale interna. Disponibile solo per SKU Basic, Standard, Premium e Isolato. NOTA: questa proprietà non verrà serializzata. Può essere popolato solo dal server.
provisioningState	Stato di provisioning corrente del servizio 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 popolato solo dal server.
publicIPAddresses	Indirizzi IP statici statici pubblici con carico bilanciato del servizio Gestione API nell'area primaria. Disponibile solo per SKU Basic, Standard, Premium e Isolato. NOTA: questa proprietà non verrà serializzata. Può essere popolato solo dal server.
publicIpAddressId	Indirizzo IP V4 basato su SKU standard pubblico da associare al servizio distribuito di rete virtuale nell'area. Supportato solo per gli SKU Developer e Premium distribuiti nella rete virtuale.
publicNetworkAccess	Indica se l'accesso all'endpoint pubblico è consentito per questo servizio Gestione API. Il valore è facoltativo, ma se passato, deve essere "Abilitato" o "Disabilitato". Se 'Disabled', gli endpoint privati sono il metodo di accesso esclusivo. Il valore predefinito è 'Enabled'
publisherEmail	Posta elettronica dell'editore.
publisherName	Nome server di pubblicazione.
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 popolato solo dal server.
sku	Proprietà SKU del servizio Gestione API.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa. NOTA: questa proprietà non verrà serializzata. Può essere popolato 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 popolato solo dal server.
virtualNetworkConfiguration	Configurazione della rete virtuale del servizio Gestione API.
virtualNetworkType	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.
zones	Elenco delle zone di disponibilità che denota la provenienza della risorsa.

Proprietà ereditate

id	ID risorsa. NOTA: questa proprietà non verrà serializzata. Può essere popolato solo dal server.
name	Nome risorsa. NOTA: questa proprietà non verrà serializzata. Può essere popolato solo dal server.
tags	Tag di risorsa.
type	Il tipo di risorsa di Gestione API è impostato su Microsoft.ApiManagement. NOTA: questa proprietà non verrà serializzata. Può essere popolato solo dal server.

Dettagli proprietà

additionalLocations

Località del data center aggiuntive del servizio Gestione API.

additionalLocations?: AdditionalLocation[]

Valore della proprietà

AdditionalLocation[]

apiVersionConstraint

Vincolo di versione delle 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 popolato solo dal server.

createdAtUtc?: Date

Valore della proprietà

Date

customProperties

Proprietà personalizzate del servizio Gestione API.
Impostazione Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 disabiliterà 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.
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.
Non specificare alcuna di queste proprietà nell'operazione PATCH reimposta i valori delle proprietà omessi nei valori predefiniti. Per tutte le impostazioni tranne 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.
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 popolato 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

etag

ETag della risorsa. NOTA: questa proprietà non verrà serializzata. Può essere popolato solo dal server.

etag?: string

Valore della proprietà

string

gatewayRegionalUrl

URL del gateway del servizio Gestione API nell'area predefinita. NOTA: questa proprietà non verrà serializzata. Può essere popolato 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 popolato solo dal server.

gatewayUrl?: string

Valore della proprietà

string

hostnameConfigurations

Configurazione del nome host personalizzato del servizio Gestione API.

hostnameConfigurations?: HostnameConfiguration[]

Valore della proprietà

HostnameConfiguration[]

identity

Identità del servizio gestito del servizio Gestione API.

identity?: ApiManagementServiceIdentity

Valore della proprietà

ApiManagementServiceIdentity

location

Percorso della risorsa.

location: string

Valore della proprietà

string

managementApiUrl

URL dell'endpoint dell'API di gestione del servizio Gestione API. NOTA: questa proprietà non verrà serializzata. Può essere popolato 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

Indirizzo di posta elettronica da cui verrà inviata la notifica.

notificationSenderEmail?: string

Valore della proprietà

string

outboundPublicIPAddresses

Prefissi di indirizzi IPV4 pubblici in uscita associati al servizio distribuito del gateway NAT. Disponibile solo per sku Premium nella piattaforma stv2. NOTA: questa proprietà non verrà serializzata. Può essere popolato 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 popolato 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 popolato solo dal server.

portalUrl?: string

Valore della proprietà

string

privateEndpointConnections

Elenco delle connessioni endpoint private di questo servizio.

privateEndpointConnections?: RemotePrivateEndpointConnectionWrapper[]

Valore della proprietà

RemotePrivateEndpointConnectionWrapper[]

privateIPAddresses

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

privateIPAddresses?: string[]

Valore della proprietà

string[]

provisioningState

Stato di provisioning corrente del servizio 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 popolato solo dal server.

provisioningState?: string

Valore della proprietà

string

publicIPAddresses

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

publicIPAddresses?: string[]

Valore della proprietà

string[]

publicIpAddressId

Indirizzo IP V4 basato su SKU standard pubblico da associare al servizio distribuito di rete virtuale nell'area. Supportato solo per gli SKU Developer e Premium distribuiti nella 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 "Abilitato" o "Disabilitato". Se 'Disabled', gli endpoint privati sono il metodo di accesso esclusivo. Il valore predefinito è 'Enabled'

publicNetworkAccess?: string

Valore della proprietà

string

publisherEmail

Posta elettronica dell'editore.

publisherEmail: string

Valore della proprietà

string

publisherName

Nome server di pubblicazione.

publisherName: 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 popolato solo dal server.

scmUrl?: string

Valore della proprietà

string

sku

Proprietà SKU del servizio Gestione API.

sku: ApiManagementServiceSkuProperties

Valore della proprietà

ApiManagementServiceSkuProperties

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa. NOTA: questa proprietà non verrà serializzata. Può essere popolato solo dal server.

systemData?: SystemData

Valore della proprietà

SystemData

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

virtualNetworkType?: string

Valore della proprietà

string

zones

Elenco delle zone di disponibilità che denota la provenienza della risorsa.

zones?: string[]

Valore della proprietà

string[]

Dettagli proprietà ereditate

id

ID risorsa. NOTA: questa proprietà non verrà serializzata. Può essere popolato solo dal server.

id?: string

Valore della proprietà

string

ereditato daApimResource.id

name

Nome risorsa. NOTA: questa proprietà non verrà serializzata. Può essere popolato solo dal server.

name?: string

Valore della proprietà

string

ereditato daApimResource.name

tags

Tag di risorsa.

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

Valore della proprietà

{[propertyName: string]: string}

ereditato daApimResource.tags

type

Il tipo di risorsa di Gestione API è impostato su Microsoft.ApiManagement. NOTA: questa proprietà non verrà serializzata. Può essere popolato solo dal server.

type?: string

Valore della proprietà

string

Ereditato daApimResource.type