ApiManagementServiceResource interface

Paquet:

@azure/arm-apimanagement

Une ressource de service Gestion des API unique dans la réponse List ou Get.

Extends

ApimResource

Propriétés

additionalLocations	Emplacements de centre de données supplémentaires du service Gestion des API.
apiVersionConstraint	Contrainte de version des API du plan de contrôle pour le service Gestion des API.
certificates	Liste des certificats qui doivent être installés dans le service Gestion des API. Le nombre maximal de certificats pris en charge pouvant être installés est de 10.
createdAtUtc	Date de création UTC du service Gestion des API. La date est conforme au format suivant : yyyy-MM-ddTHH:mm:ssZ tel que spécifié par la norme ISO 8601. REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.
customProperties	Propriétés personnalisées du service Gestion des API. Le paramètre Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 désactive le TLS_RSA_WITH_3DES_EDE_CBC_SHA de chiffrement pour tous les TLS(1.0, 1.1 et 1.2). Le paramètre Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 peut être utilisé pour désactiver uniquement TLS 1.1. Le paramètre Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 peut être utilisé pour désactiver TLS 1.0 sur un service Gestion des API. Le paramètre Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 peut être utilisé pour désactiver uniquement TLS 1.1 pour les communications avec les back-ends. Le paramètre Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 peut être utilisé pour désactiver TLS 1.0 pour les communications avec les back-ends. Le paramètre Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 peut être utilisé pour activer le protocole HTTP2 sur un service Gestion des API. Si vous ne spécifiez aucune de ces propriétés lors de l’opération PATCH, les valeurs par défaut des propriétés omises sont réinitialisées. Pour tous les paramètres à l’exception de Http2, la valeur par défaut est True si le service a été créé le 1er avril 2018 ou avant le 1er avril 2018, sinon False . La valeur par défaut du paramètre Http2 est False. Vous pouvez désactiver l’un des chiffrements suivants à l’aide des paramètres Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]suivants : 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. Par exemple, Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. La valeur par défaut est true pour eux. Remarque : Les chiffrements suivants ne peuvent pas être désactivés, car ils sont requis par les composants de plateforme internes : 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 du point de terminaison du portail DEveloper du service Gestion des API. REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.
disableGateway	Propriété valide uniquement pour un service Gestion des API déployé dans plusieurs emplacements. Vous pouvez l’utiliser pour désactiver la passerelle dans master région.
enableClientCertificate	Propriété destinée uniquement à être utilisée pour le service SKU Consommation. Cela applique un certificat client à présenter à chaque demande à la passerelle. Cela permet également d’authentifier le certificat dans la stratégie sur la passerelle.
etag	ETag de la ressource. REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.
gatewayRegionalUrl	URL de passerelle du service Gestion des API dans la région par défaut. REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.
gatewayUrl	URL de passerelle du service Gestion des API. REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.
hostnameConfigurations	Configuration de nom d’hôte personnalisée du service Gestion des API.
identity	Identité de service managée du service Gestion des API.
location	Emplacement de la ressource.
managementApiUrl	URL du point de terminaison de l’API de gestion du service Gestion des API. REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.
natGatewayState	La propriété peut être utilisée pour activer la passerelle NAT pour ce service Gestion des API.
notificationSenderEmail	Email adresse à partir de laquelle la notification sera envoyée.
outboundPublicIPAddresses	Préfixes d’adresse IPV4 publics sortants associés au service déployé de passerelle NAT. Disponible uniquement pour la référence SKU Premium sur la plateforme stv2. REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.
platformVersion	Version de la plateforme de calcul exécutant le service à cet emplacement. REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.
portalUrl	Url du point de terminaison du portail de publication du service Gestion des API. REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.
privateEndpointConnections	Liste des connexions de point de terminaison privé de ce service.
privateIPAddresses	Adresses IP à charge statique équilibrée privée du service Gestion des API dans la région principale qui est déployé dans un Réseau virtuel interne. Disponible uniquement pour les références SKU De base, Standard, Premium et Isolé. REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.
provisioningState	État d’approvisionnement actuel du service Gestion des API qui peut être l’un des suivants : Créé/Activation/Réussi/Mise à jour/Échec/Arrêté/Fin/TerminationFailed/Deleted. REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.
publicIPAddresses	Adresses IP publiques statiques équilibrées du service Gestion des API dans la région principale. Disponible uniquement pour les références SKU De base, Standard, Premium et Isolé. REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.
publicIpAddressId	Adresse IP V4 de la référence SKU SKU publique à associer à Réseau virtuel service déployé dans la région. Pris en charge uniquement pour les références SKU Développeur et Premium déployées dans Réseau virtuel.
publicNetworkAccess	Indique si l’accès au point de terminaison public est autorisé ou non pour ce service Gestion des API. La valeur est facultative, mais si elle est transmise, doit être « Enabled » ou « Disabled ». Si « Désactivé », les points de terminaison privés sont la méthode d’accès exclusif. La valeur par défaut est « Enabled »
publisherEmail	E-mail de l’éditeur.
publisherName	Nom de l’éditeur.
restore	Annulez la suppression du service de gestion des API s’il a été précédemment supprimé de manière réversible. Si cet indicateur est spécifié et défini sur True, toutes les autres propriétés seront ignorées.
scmUrl	URL du point de terminaison SCM du service Gestion des API. REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.
sku	Propriétés de la référence SKU du service Gestion des API.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource. REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.
targetProvisioningState	État d’approvisionnement du service Gestion des API, qui est ciblé par l’opération de longue durée démarrée sur le service. REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.
virtualNetworkConfiguration	Configuration du réseau virtuel du service Gestion des API.
virtualNetworkType	Type de VPN dans lequel Gestion des API service doit être configuré. None (Valeur par défaut) signifie que le service Gestion des API ne fait partie d’aucun Réseau virtuel, External signifie que le déploiement Gestion des API est configuré à l’intérieur d’un Réseau virtuel disposant d’un point de terminaison internet, et Interne signifie que Gestion des API le déploiement est configuré à l’intérieur d’un Réseau virtuel disposant d’un point de terminaison intranet uniquement.
zones	Liste des zones de disponibilité indiquant d’où doit provenir la ressource.

Propriétés héritées

id	ID de la ressource REMARQUE : Cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.
name	Nom de la ressource. REMARQUE : Cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.
tags	Balises de ressource.
type	Type de ressource pour Gestion des API ressource est défini sur Microsoft.ApiManagement. REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.

Détails de la propriété

additionalLocations

Emplacements de centre de données supplémentaires du service Gestion des API.

additionalLocations?: AdditionalLocation[]

Valeur de propriété

AdditionalLocation[]

apiVersionConstraint

Contrainte de version des API du plan de contrôle pour le service Gestion des API.

apiVersionConstraint?: ApiVersionConstraint

Valeur de propriété

ApiVersionConstraint

certificates

Liste des certificats qui doivent être installés dans le service Gestion des API. Le nombre maximal de certificats pris en charge pouvant être installés est de 10.

certificates?: CertificateConfiguration[]

Valeur de propriété

CertificateConfiguration[]

createdAtUtc

Date de création UTC du service Gestion des API. La date est conforme au format suivant : yyyy-MM-ddTHH:mm:ssZ tel que spécifié par la norme ISO 8601. REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.

createdAtUtc?: Date

Valeur de propriété

Date

customProperties

Propriétés personnalisées du service Gestion des API.
Le paramètre Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 désactive le TLS_RSA_WITH_3DES_EDE_CBC_SHA de chiffrement pour tous les TLS(1.0, 1.1 et 1.2).
Le paramètre Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 peut être utilisé pour désactiver uniquement TLS 1.1.
Le paramètre Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 peut être utilisé pour désactiver TLS 1.0 sur un service Gestion des API.
Le paramètre Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 peut être utilisé pour désactiver uniquement TLS 1.1 pour les communications avec les back-ends.
Le paramètre Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 peut être utilisé pour désactiver TLS 1.0 pour les communications avec les back-ends.
Le paramètre Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 peut être utilisé pour activer le protocole HTTP2 sur un service Gestion des API.
Si vous ne spécifiez aucune de ces propriétés lors de l’opération PATCH, les valeurs par défaut des propriétés omises sont réinitialisées. Pour tous les paramètres à l’exception de Http2, la valeur par défaut est True si le service a été créé le 1er avril 2018 ou avant le 1er avril 2018, sinon False . La valeur par défaut du paramètre Http2 est False.

Vous pouvez désactiver l’un des chiffrements suivants à l’aide des paramètres Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]suivants : 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. Par exemple, Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256:false. La valeur par défaut est true pour eux.
Remarque : Les chiffrements suivants ne peuvent pas être désactivés, car ils sont requis par les composants de plateforme internes : 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}

Valeur de propriété

{[propertyName: string]: string}

developerPortalUrl

URL du point de terminaison du portail DEveloper du service Gestion des API. REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.

developerPortalUrl?: string

Valeur de propriété

string

disableGateway

Propriété valide uniquement pour un service Gestion des API déployé dans plusieurs emplacements. Vous pouvez l’utiliser pour désactiver la passerelle dans master région.

disableGateway?: boolean

Valeur de propriété

boolean

enableClientCertificate

Propriété destinée uniquement à être utilisée pour le service SKU Consommation. Cela applique un certificat client à présenter à chaque demande à la passerelle. Cela permet également d’authentifier le certificat dans la stratégie sur la passerelle.

enableClientCertificate?: boolean

Valeur de propriété

boolean

etag

ETag de la ressource. REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.

etag?: string

Valeur de propriété

string

gatewayRegionalUrl

URL de passerelle du service Gestion des API dans la région par défaut. REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.

gatewayRegionalUrl?: string

Valeur de propriété

string

gatewayUrl

URL de passerelle du service Gestion des API. REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.

gatewayUrl?: string

Valeur de propriété

string

hostnameConfigurations

Configuration de nom d’hôte personnalisée du service Gestion des API.

hostnameConfigurations?: HostnameConfiguration[]

Valeur de propriété

HostnameConfiguration[]

identity

Identité de service managée du service Gestion des API.

identity?: ApiManagementServiceIdentity

Valeur de propriété

ApiManagementServiceIdentity

location

Emplacement de la ressource.

location: string

Valeur de propriété

string

managementApiUrl

URL du point de terminaison de l’API de gestion du service Gestion des API. REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.

managementApiUrl?: string

Valeur de propriété

string

natGatewayState

La propriété peut être utilisée pour activer la passerelle NAT pour ce service Gestion des API.

natGatewayState?: string

Valeur de propriété

string

notificationSenderEmail

Email adresse à partir de laquelle la notification sera envoyée.

notificationSenderEmail?: string

Valeur de propriété

string

outboundPublicIPAddresses

Préfixes d’adresse IPV4 publics sortants associés au service déployé de passerelle NAT. Disponible uniquement pour la référence SKU Premium sur la plateforme stv2. REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.

outboundPublicIPAddresses?: string[]

Valeur de propriété

string[]

platformVersion

Version de la plateforme de calcul exécutant le service à cet emplacement. REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.

platformVersion?: string

Valeur de propriété

string

portalUrl

Url du point de terminaison du portail de publication du service Gestion des API. REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.

portalUrl?: string

Valeur de propriété

string

privateEndpointConnections

Liste des connexions de point de terminaison privé de ce service.

privateEndpointConnections?: RemotePrivateEndpointConnectionWrapper[]

Valeur de propriété

RemotePrivateEndpointConnectionWrapper[]

privateIPAddresses

Adresses IP à charge statique équilibrée privée du service Gestion des API dans la région principale qui est déployé dans un Réseau virtuel interne. Disponible uniquement pour les références SKU De base, Standard, Premium et Isolé. REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.

privateIPAddresses?: string[]

Valeur de propriété

string[]

provisioningState

État d’approvisionnement actuel du service Gestion des API qui peut être l’un des suivants : Créé/Activation/Réussi/Mise à jour/Échec/Arrêté/Fin/TerminationFailed/Deleted. REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.

provisioningState?: string

Valeur de propriété

string

publicIPAddresses

Adresses IP publiques statiques équilibrées du service Gestion des API dans la région principale. Disponible uniquement pour les références SKU De base, Standard, Premium et Isolé. REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.

publicIPAddresses?: string[]

Valeur de propriété

string[]

publicIpAddressId

Adresse IP V4 de la référence SKU SKU publique à associer à Réseau virtuel service déployé dans la région. Pris en charge uniquement pour les références SKU Développeur et Premium déployées dans Réseau virtuel.

publicIpAddressId?: string

Valeur de propriété

string

publicNetworkAccess

Indique si l’accès au point de terminaison public est autorisé ou non pour ce service Gestion des API. La valeur est facultative, mais si elle est transmise, doit être « Enabled » ou « Disabled ». Si « Désactivé », les points de terminaison privés sont la méthode d’accès exclusif. La valeur par défaut est « Enabled »

publicNetworkAccess?: string

Valeur de propriété

string

publisherEmail

E-mail de l’éditeur.

publisherEmail: string

Valeur de propriété

string

publisherName

Nom de l’éditeur.

publisherName: string

Valeur de propriété

string

restore

Annulez la suppression du service de gestion des API s’il a été précédemment supprimé de manière réversible. Si cet indicateur est spécifié et défini sur True, toutes les autres propriétés seront ignorées.

restore?: boolean

Valeur de propriété

boolean

scmUrl

URL du point de terminaison SCM du service Gestion des API. REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.

scmUrl?: string

Valeur de propriété

string

sku

Propriétés de la référence SKU du service Gestion des API.

sku: ApiManagementServiceSkuProperties

Valeur de propriété

ApiManagementServiceSkuProperties

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource. REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.

systemData?: SystemData

Valeur de propriété

SystemData

targetProvisioningState

État d’approvisionnement du service Gestion des API, qui est ciblé par l’opération de longue durée démarrée sur le service. REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.

targetProvisioningState?: string

Valeur de propriété

string

virtualNetworkConfiguration

Configuration du réseau virtuel du service Gestion des API.

virtualNetworkConfiguration?: VirtualNetworkConfiguration

Valeur de propriété

VirtualNetworkConfiguration

virtualNetworkType

Type de VPN dans lequel Gestion des API service doit être configuré. None (Valeur par défaut) signifie que le service Gestion des API ne fait partie d’aucun Réseau virtuel, External signifie que le déploiement Gestion des API est configuré à l’intérieur d’un Réseau virtuel disposant d’un point de terminaison internet, et Interne signifie que Gestion des API le déploiement est configuré à l’intérieur d’un Réseau virtuel disposant d’un point de terminaison intranet uniquement.

virtualNetworkType?: string

Valeur de propriété

string

zones

Liste des zones de disponibilité indiquant d’où doit provenir la ressource.

zones?: string[]

Valeur de propriété

string[]

Détails de la propriété héritée

id

ID de la ressource REMARQUE : Cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.

id?: string

Valeur de propriété

string

Hérité deApimResource.id

name

Nom de la ressource. REMARQUE : Cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.

name?: string

Valeur de propriété

string

Héritée deApimResource.name

tags

Balises de ressource.

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

Valeur de propriété

{[propertyName: string]: string}

Héritéd’ApimResource.tags

type

Type de ressource pour Gestion des API ressource est défini sur Microsoft.ApiManagement. REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.

type?: string

Valeur de propriété

string

Héritéd’ApimResource.type