Partager via

ApiManagementServiceProperties interface

  • Référence
Paquet:
@azure/arm-apimanagement

Propriétés d’une description de ressource de service Gestion des API.

Extends
ApiManagementServiceBaseProperties

Propriétés

publisherEmail

E-mail de l’éditeur.
publisherName

Nom de l’éditeur.

Propriétés héritées

additionalLocations

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

Contrainte de version 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 UTC de création 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 chiffrement TLS_RSA_WITH_3DES_EDE_CBC_SHA 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établies. Pour tous les paramètres sauf Http2, la valeur par défaut est True si le service a été créé le 1er avril 2018 ou False avant. 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 de référence 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.
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.
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 la 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 »
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.
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.

Détails de la propriété

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

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

additionalLocations

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

additionalLocations?: AdditionalLocation[]

Valeur de propriété

AdditionalLocation[]

Héritéd’ApiManagementServiceBaseProperties.additionalLocations

apiVersionConstraint

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

apiVersionConstraint?: ApiVersionConstraint

Valeur de propriété

ApiVersionConstraint

Héritéd’ApiManagementServiceBaseProperties.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[]

Héritéd’ApiManagementServiceBaseProperties.certificates

createdAtUtc

Date UTC de création 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

Héritéd’ApiManagementServiceBaseProperties.createdAtUtc

customProperties

Propriétés personnalisées du service Gestion des API.
Le paramètre Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 désactive le chiffrement TLS_RSA_WITH_3DES_EDE_CBC_SHA 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établies. Pour tous les paramètres sauf Http2, la valeur par défaut est True si le service a été créé le 1er avril 2018 ou False avant. 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}

Héritéd’ApiManagementServiceBaseProperties.customProperties

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

Héritéd’ApiManagementServiceBaseProperties.developerPortalUrl

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

Héritéd’ApiManagementServiceBaseProperties.disableGateway

enableClientCertificate

Propriété destinée uniquement à être utilisée pour le service de référence 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

Héritéd’ApiManagementServiceBaseProperties.enableClientCertificate

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

Héritéd’ApiManagementServiceBaseProperties.gatewayRegionalUrl

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

Héritéd’ApiManagementServiceBaseProperties.gatewayUrl

hostnameConfigurations

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

hostnameConfigurations?: HostnameConfiguration[]

Valeur de propriété

HostnameConfiguration[]

Héritéd’ApiManagementServiceBaseProperties.hostnameConfigurations

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

Héritéd’ApiManagementServiceBaseProperties.managementApiUrl

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

Héritéd’ApiManagementServiceBaseProperties.natGatewayState

notificationSenderEmail

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

notificationSenderEmail?: string

Valeur de propriété

string

Héritéd’ApiManagementServiceBaseProperties.notificationSenderEmail

outboundPublicIPAddresses

Préfixes d’adresse IPV4 publics sortants associés au service déployé de la 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[]

Héritéd’ApiManagementServiceBaseProperties.outboundPublicIPAddresses

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

Héritéd’ApiManagementServiceBaseProperties.platformVersion

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

Héritéd’ApiManagementServiceBaseProperties.portalUrl

privateEndpointConnections

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

privateEndpointConnections?: RemotePrivateEndpointConnectionWrapper[]

Valeur de propriété

RemotePrivateEndpointConnectionWrapper[]

Héritéd’ApiManagementServiceBaseProperties.privateEndpointConnections

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

Héritéd’ApiManagementServiceBaseProperties.privateIPAddresses

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

Héritéd’ApiManagementServiceBaseProperties.provisioningState

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

Héritéd’ApiManagementServiceBaseProperties.publicIPAddresses

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

Héritéd’ApiManagementServiceBaseProperties.publicIpAddressId

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

Héritéd’ApiManagementServiceBaseProperties.publicNetworkAccess

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

Héritéd’ApiManagementServiceBaseProperties.restore

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

Héritéd’ApiManagementServiceBaseProperties.scmUrl

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

Héritéd’ApiManagementServiceBaseProperties.targetProvisioningState

virtualNetworkConfiguration

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

virtualNetworkConfiguration?: VirtualNetworkConfiguration

Valeur de propriété

VirtualNetworkConfiguration

Héritéd’ApiManagementServiceBaseProperties.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

Héritéd’ApiManagementServiceBaseProperties.virtualNetworkType