Partager via

Api Management Service - MigrateToStv2

  • Référence
Service:
API Management
Version d'API:
2024-05-01

Met à niveau un service Gestion des API vers la plateforme Stv2. Pour plus d’informations, reportez-vous à https://aka.ms/apim-migrate-stv2. Ce changement n’est pas réversible. Il s’agit d’une opération longue et peut prendre plusieurs minutes.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/migrateToStv2?api-version=2024-05-01

Paramètres URI

Nom Dans Obligatoire Type Description
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Nom du groupe de ressources. Le nom ne respecte pas la casse.
serviceName
 path True

string

minLength: 1
maxLength: 50
pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

Nom du service Gestion des API.
subscriptionId
 path True

string (uuid)

ID de l’abonnement cible. La valeur doit être un UUID.
api-version
 query True

string

minLength: 1

Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom Type Description
mode

MigrateToStv2Mode

Mode de migration vers stv2. La valeur par défaut est PreserveIp.

Réponses

Nom Type Description
200 OK

ApiManagementServiceResource

Le service a été correctement migré.
202 Accepted

Demande de migration envoyée.

En-têtes

location: string
Other Status Codes

ErrorResponse

Réponse d’erreur décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation emprunter l’identité de votre compte d’utilisateur

Exemples

ApiManagementMigrateService

Exemple de requête

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/migrateToStv2?api-version=2024-05-01

{
  "mode": "PreserveIp"
}

Exemple de réponse

Code d’état:
202 
location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2024-05-01
Code d’état:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimservice1",
  "name": "apimservice1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {},
  "location": "West US",
  "etag": "AAAAAADqC0c=",
  "properties": {
    "publisherEmail": "abcs@contoso.com",
    "publisherName": "contoso publisher",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2019-12-02T01:42:09.1268424Z",
    "gatewayUrl": "https://apimservice1.azure-api.net",
    "gatewayRegionalUrl": "https://apimservice1-westus-01.regional.azure-api.net",
    "portalUrl": "https://apimservice1.portal.azure-api.net",
    "developerPortalUrl": "https://apimService1.developer.azure-api.net",
    "managementApiUrl": "https://apimservice1.management.azure-api.net",
    "scmUrl": "https://apimservice1.scm.azure-api.net",
    "hostnameConfigurations": [
      {
        "type": "Proxy",
        "hostName": "apimService1.azure-api.net",
        "negotiateClientCertificate": false,
        "defaultSslBinding": false,
        "certificateSource": "BuiltIn"
      },
      {
        "type": "Proxy",
        "hostName": "apimgatewaytest.preview.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2019-08-16T16:51:34+00:00",
          "thumbprint": "B4330123DBAXXXXXXXXX1F35E84493476",
          "subject": "CN=*.preview.net"
        },
        "defaultSslBinding": true,
        "certificateSource": "Custom"
      }
    ],
    "publicIPAddresses": [
      "137.XXX.11.74"
    ],
    "privateIPAddresses": [
      "172.XX.0.5"
    ],
    "additionalLocations": [
      {
        "location": "West US 2",
        "sku": {
          "name": "Premium",
          "capacity": 1
        },
        "publicIPAddresses": [
          "40.XXX.79.187"
        ],
        "privateIPAddresses": [
          "10.0.X.6"
        ],
        "virtualNetworkConfiguration": {
          "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/APIMVNet/subnets/apim-internal-sub"
        },
        "gatewayRegionalUrl": "https://apimservice1-westus2-01.regional.azure-api.net",
        "disableGateway": false
      }
    ],
    "virtualNetworkConfiguration": {
      "subnetResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/apim-appGateway-vnet/subnets/apim-subnet"
    },
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "True",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False"
    },
    "virtualNetworkType": "Internal",
    "disableGateway": false,
    "apiVersionConstraint": {},
    "platformVersion": "stv2"
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  }
}

Définitions

Nom Description
AdditionalLocation

Description d’un autre emplacement de ressource Gestion des API.
ApiManagementServiceIdentity

Propriétés d’identité de la ressource du service Gestion des API.
ApiManagementServiceResource

Ressource de service Gestion des API unique dans Liste ou Obtenir une réponse.
ApiManagementServiceSkuProperties

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

Type d’identité utilisé pour la ressource. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité créée implicitement et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toutes les identités du service.
ApiVersionConstraint

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

Wrapper pour un ID de ressource ARM
CertificateConfiguration

Configuration des certificats qui se composent d’intermédiaires non approuvés et de certificats racines.
CertificateInformation

Informations sur le certificat SSL.
CertificateSource

Source du certificat.
CertificateStatus

État du certificat.
ConfigurationApi

Informations relatives à l’API Configuration du service Gestion des API.
createdByType

Type d’identité qui a créé la ressource.
developerPortalStatus

État du portail des développeurs dans ce service Gestion des API.
ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail

Détail de l’erreur.
ErrorResponse

Réponse d’erreur
HostnameConfiguration

Configuration personnalisée du nom d’hôte.
HostnameType

Type de nom d’hôte.
LegacyApiState

Indique si l’API de configuration héritée (v1) doit être exposée sur le service Gestion des API. La valeur est facultative, mais doit être « Activé » ou « Désactivé ». Si elle est désactivée, l’API de configuration héritée (v1) n’est pas disponible pour les passerelles auto-hébergées. La valeur par défaut est « Enabled »
LegacyPortalStatus

État du portail hérité dans le service Gestion des API.
MigrateToStv2Contract

Décrit une référence SKU Gestion des API disponible.
MigrateToStv2Mode

Mode de migration vers stv2. La valeur par défaut est PreserveIp.
NatGatewayState

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

Version de la plateforme de calcul exécutant le service.
PrivateEndpointServiceConnectionStatus

État de la connexion de point de terminaison privé.
PrivateLinkServiceConnectionState

Collection d’informations sur l’état de la connexion entre le consommateur de services et le fournisseur.
PublicNetworkAccess

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

Ressource de connexion de point de terminaison privé distant.
SkuType

Nom de la référence SKU.
systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.
UserIdentityProperties
VirtualNetworkConfiguration

Configuration d’un réseau virtuel sur lequel le service Gestion des API est déployé.
VirtualNetworkType

Type de VPN dans lequel le service Gestion des API doit être configuré. Aucune (valeur par défaut) signifie que le service Gestion des API ne fait pas partie d’un réseau virtuel, externe signifie que le déploiement gestion des API est configuré à l’intérieur d’un réseau virtuel disposant d’un point de terminaison accessible sur Internet, et que le déploiement interne de gestion des API est configuré à l’intérieur d’un réseau virtuel disposant d’un point de terminaison intranet uniquement.

AdditionalLocation

Object

Description d’un autre emplacement de ressource Gestion des API.

Nom Type Valeur par défaut Description
disableGateway

boolean

False

Propriété valide uniquement pour un service Gestion des API déployé à plusieurs emplacements. Cela peut être utilisé pour désactiver la passerelle dans cet emplacement supplémentaire.
gatewayRegionalUrl

string

URL de passerelle du service Gestion des API dans la région.
location

string

Nom de l’emplacement de la région supplémentaire parmi les régions du centre de données Azure.
natGatewayState

NatGatewayState

Disabled

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

string[]

Préfixes d’adresses IPV4 publics sortants associés au service déployé par la passerelle NAT. Disponible uniquement pour la référence SKU Premium sur la plateforme stv2.
platformVersion

PlatformVersion

Version de la plateforme de calcul exécutant le service.
privateIPAddresses

string[]

Adresses IP d’équilibrage de charge statique privée du service Gestion des API qui est déployé dans un réseau virtuel interne dans un emplacement supplémentaire particulier. Disponible uniquement pour la référence SKU De base, Standard, Premium et Isolé.
publicIPAddresses

string[]

Adresses IP publiques à charge statique équilibrée du service Gestion des API dans l’emplacement supplémentaire. Disponible uniquement pour la référence SKU De base, Standard, Premium et Isolé.
publicIpAddressId

string

Adresse IP V4 de référence SKU standard publique à associer au service déployé par le réseau virtuel à l’emplacement. Prise en charge uniquement pour la référence SKU Premium déployée dans un réseau virtuel.
sku

ApiManagementServiceSkuProperties

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

VirtualNetworkConfiguration

Configuration du réseau virtuel pour l’emplacement.
zones

string[]

Liste des zones de disponibilité indiquant à partir de laquelle la ressource doit provenir.

ApiManagementServiceIdentity

Object

Propriétés d’identité de la ressource du service Gestion des API.

Nom Type Description
principalId

string (uuid)

ID principal de l’identité.
tenantId

string (uuid)

ID de locataire client de l’identité.
type

ApimIdentityType

Type d’identité utilisé pour la ressource. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité créée implicitement et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toutes les identités du service.
userAssignedIdentities

<string,  UserIdentityProperties>

Liste des identités utilisateur associées à la ressource. Les références de clé de dictionnaire d’identité utilisateur seront des ID de ressource ARM sous la forme : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ».

ApiManagementServiceResource

Object

Ressource de service Gestion des API unique dans Liste ou Obtenir une réponse.

Nom Type Valeur par défaut Description
etag

string

ETag de la ressource.
id

string

ID de ressource.
identity

ApiManagementServiceIdentity

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

string

Emplacement des ressources.
name

string

Nom de la ressource.
properties.additionalLocations

AdditionalLocation[]

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

ApiVersionConstraint

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

CertificateConfiguration[]

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.
properties.configurationApi

ConfigurationApi

Configuration de la configuration de la configuration du service Gestion des API.
properties.createdAtUtc

string (date-time)

Date UTC de création du service Gestion des API. La date est conforme au format suivant : yyyy-MM-ddTHH:mm:ssZ comme spécifié par la norme ISO 8601.
properties.customProperties

object

Propriétés personnalisées du service Gestion des API.
paramètre Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 désactive la TLS_RSA_WITH_3DES_EDE_CBC_SHA de chiffrement pour toutes les TLS_RSA_WITH_3DES_EDE_CBC_SHA TLS(1.0, 1.1 et 1.2).
paramètre Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 pouvez être utilisé pour désactiver uniquement TLS 1.1.
paramètre Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 pouvez être utilisé pour désactiver TLS 1.0 sur un service Gestion des API.
paramètre Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 pouvez être utilisé pour désactiver uniquement TLS 1.1 pour les communications avec des back-ends.
paramètre Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 pouvez être utilisé pour désactiver TLS 1.0 pour les communications avec des back-ends.
paramètre Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 pouvez être utilisé pour activer le protocole HTTP2 sur un service Gestion des API.
Ne pas spécifier ces propriétés sur l’opération PATCH réinitialise les valeurs des propriétés omises à leurs valeurs par défaut. Pour tous les paramètres, à l’exception de Http2, la valeur par défaut est True si le service a été créé avant le 1er avril 2018 et False sinon. 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]: 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
properties.developerPortalStatus

developerPortalStatus

Enabled

État du portail des développeurs dans ce service Gestion des API.
properties.developerPortalUrl

string

URL du point de terminaison du portail DEveloper du service Gestion des API.
properties.disableGateway

boolean

False

Propriété valide uniquement pour un service Gestion des API déployé à plusieurs emplacements. Cela peut être utilisé pour désactiver la passerelle dans la région maître.
properties.enableClientCertificate

boolean

False

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

string

URL de passerelle du service Gestion des API dans la région par défaut.
properties.gatewayUrl

string

URL de passerelle du service Gestion des API.
properties.hostnameConfigurations

HostnameConfiguration[]

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

LegacyPortalStatus

Enabled

État du portail hérité dans le service Gestion des API.
properties.managementApiUrl

string

URL du point de terminaison d’API de gestion du service Gestion des API.
properties.natGatewayState

NatGatewayState

Disabled

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

string

maxLength: 100

Adresse e-mail à partir de laquelle la notification sera envoyée.
properties.outboundPublicIPAddresses

string[]

Préfixes d’adresses IPV4 publics sortants associés au service déployé par la passerelle NAT. Disponible uniquement pour la référence SKU Premium sur la plateforme stv2.
properties.platformVersion

PlatformVersion

Version de la plateforme de calcul exécutant le service à cet emplacement.
properties.portalUrl

string

URL du point de terminaison du portail d’éditeur du service Gestion des API.
properties.privateEndpointConnections

RemotePrivateEndpointConnectionWrapper[]

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

string[]

Adresses IP d’équilibrage de charge statique privée du service Gestion des API dans la région primaire déployée dans un réseau virtuel interne. Disponible uniquement pour la référence SKU De base, Standard, Premium et Isolé.
properties.provisioningState

string

État d’approvisionnement actuel du service Gestion des API qui peut être l’un des éléments suivants : Created/Activateing/Succeeded/Updating/Failed/Stop/Terminateting/TerminateFailed/Deleted.
properties.publicIPAddresses

string[]

Adresses IP publiques à charge statique équilibrée du service Gestion des API dans la région primaire. Disponible uniquement pour la référence SKU De base, Standard, Premium et Isolé.
properties.publicIpAddressId

string

Adresse IP V4 de référence SKU standard publique à associer au service déployé de réseau virtuel dans la région. Prise en charge uniquement pour le déploiement de la référence SKU Développeur et Premium dans un réseau virtuel.
properties.publicNetworkAccess

PublicNetworkAccess

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

string

maxLength: 100

E-mail de l’éditeur.
properties.publisherName

string

maxLength: 100

Nom du serveur de publication.
properties.restore

boolean

False

Annuler la suppression réversible du service Gestion des API s’il était 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 sont ignorées.
properties.scmUrl

string

URL du point de terminaison SCM du service Gestion des API.
properties.targetProvisioningState

string

État d’approvisionnement du service Gestion des API, ciblé par l’opération de longue durée démarrée sur le service.
properties.virtualNetworkConfiguration

VirtualNetworkConfiguration

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

VirtualNetworkType

None

Type de VPN dans lequel le service Gestion des API doit être configuré. Aucune (valeur par défaut) signifie que le service Gestion des API ne fait pas partie d’un réseau virtuel, externe signifie que le déploiement gestion des API est configuré à l’intérieur d’un réseau virtuel disposant d’un point de terminaison accessible sur Internet, et que le déploiement interne de gestion des API est configuré à l’intérieur d’un réseau virtuel disposant d’un point de terminaison intranet uniquement.
sku

ApiManagementServiceSkuProperties

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

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.
tags

object

Balises de ressource.
type

string

Le type de ressource pour la ressource Gestion des API est défini sur Microsoft.ApiManagement.
zones

string[]

Liste des zones de disponibilité indiquant à partir de laquelle la ressource doit provenir.

ApiManagementServiceSkuProperties

Object

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

Nom Type Description
capacity

integer (int32)

Capacité de la référence SKU (nombre d’unités déployées de la référence SKU). Pour la capacité de référence SKU Consommation, vous devez spécifier la valeur 0.
name

SkuType

Nom de la référence SKU.

ApimIdentityType

Énumération

Type d’identité utilisé pour la ressource. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité créée implicitement et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toutes les identités du service.

Valeur Description
None
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned

ApiVersionConstraint

Object

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

Nom Type Description
minApiVersion

string

Limitez les appels d’API du plan de contrôle au service Gestion des API avec une version égale ou ultérieure à cette valeur.

ArmIdWrapper

Object

Wrapper pour un ID de ressource ARM

Nom Type Description
id

string

CertificateConfiguration

Object

Configuration des certificats qui se composent d’intermédiaires non approuvés et de certificats racines.

Nom Type Description
certificate

CertificateInformation

Informations sur le certificat.
certificatePassword

string

Mot de passe du certificat.
encodedCertificate

string

Certificat codé en base64.
storeName enum:
  • CertificateAuthority
  • Root

Emplacement du magasin de certificats System.Security.Cryptography.x509certificates.StoreName. Seules les emplacements Root et CertificateAuthority sont des emplacements valides.

CertificateInformation

Object

Informations sur le certificat SSL.

Nom Type Description
expiry

string (date-time)

Date d’expiration du certificat. La date est conforme au format suivant : yyyy-MM-ddTHH:mm:ssZ comme spécifié par la norme ISO 8601.
subject

string

Objet du certificat.
thumbprint

string

Empreinte numérique du certificat.

CertificateSource

Énumération

Source du certificat.

Valeur Description
BuiltIn
Custom
KeyVault
Managed

CertificateStatus

Énumération

État du certificat.

Valeur Description
Completed
Failed
InProgress

ConfigurationApi

Object

Informations relatives à l’API Configuration du service Gestion des API.

Nom Type Valeur par défaut Description
legacyApi

LegacyApiState

Enabled

Indique si l’API de configuration héritée (v1) doit être exposée sur le service Gestion des API. La valeur est facultative, mais doit être « Activé » ou « Désactivé ». Si elle est désactivée, l’API de configuration héritée (v1) n’est pas disponible pour les passerelles auto-hébergées. La valeur par défaut est « Enabled »

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur Description
Application
Key
ManagedIdentity
User

developerPortalStatus

Énumération

État du portail des développeurs dans ce service Gestion des API.

Valeur Description
Disabled

Le portail des développeurs est désactivé pour le service.
Enabled

Le portail des développeurs est activé pour le service.

ErrorAdditionalInfo

Object

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom Type Description
info

object

Informations supplémentaires.
type

string

Type d’informations supplémentaire.

ErrorDetail

Object

Détail de l’erreur.

Nom Type Description
additionalInfo

ErrorAdditionalInfo[]

Informations supplémentaires sur l’erreur.
code

string

Code d’erreur.
details

ErrorDetail[]

Détails de l’erreur.
message

string

Message d’erreur.
target

string

Cible d’erreur.

ErrorResponse

Object

Réponse d’erreur

Nom Type Description
error

ErrorDetail

Objet d’erreur.

HostnameConfiguration

Object

Configuration personnalisée du nom d’hôte.

Nom Type Valeur par défaut Description
certificate

CertificateInformation

Informations sur le certificat.
certificatePassword

string

Mot de passe du certificat.
certificateSource

CertificateSource

Source du certificat.
certificateStatus

CertificateStatus

État du certificat.
defaultSslBinding

boolean

False

Spécifiez true pour configurer le certificat associé à ce nom d’hôte en tant que certificat SSL par défaut. Si un client n’envoie pas l’en-tête SNI, il s’agit du certificat qui sera contesté. La propriété est utile si un service a plusieurs noms d’hôte personnalisés activés et qu’il doit décider du certificat ssl par défaut. Paramètre appliqué uniquement au type de nom d’hôte de la passerelle.
encodedCertificate

string

Certificat codé en base64.
hostName

string

Nom d’hôte à configurer sur le service Gestion des API.
identityClientId

string

Id client d’identité managée affectée par le système ou l’utilisateur généré par Azure AD, qui a accès GET au coffre de clés contenant le certificat SSL.
keyVaultId

string

URL du secret KeyVault contenant le certificat SSL. Si l’URL absolue contenant la version est fournie, la mise à jour automatique du certificat SSL ne fonctionnera pas. Cela nécessite que le service Gestion des API soit configuré avec aka.ms/apimmsi. Le secret doit être de type application/x-pkcs12
negotiateClientCertificate

boolean

False

Spécifiez true pour toujours négocier le certificat client sur le nom d’hôte. La valeur par défaut est false.
type

HostnameType

Type de nom d’hôte.

HostnameType

Énumération

Type de nom d’hôte.

Valeur Description
ConfigurationApi
DeveloperPortal
Management
Portal
Proxy
Scm

LegacyApiState

Énumération

Indique si l’API de configuration héritée (v1) doit être exposée sur le service Gestion des API. La valeur est facultative, mais doit être « Activé » ou « Désactivé ». Si elle est désactivée, l’API de configuration héritée (v1) n’est pas disponible pour les passerelles auto-hébergées. La valeur par défaut est « Enabled »

Valeur Description
Disabled

L’API de configuration héritée (v1) est désactivée pour le service et les passerelles auto-hébergées ne peuvent pas se connecter à celui-ci.
Enabled

L’API de configuration héritée (v1) est activée pour le service et les passerelles auto-hébergées peuvent s’y connecter.

LegacyPortalStatus

Énumération

État du portail hérité dans le service Gestion des API.

Valeur Description
Disabled

Le portail hérité est désactivé pour le service.
Enabled

Le portail hérité est activé pour le service.

MigrateToStv2Contract

Object

Décrit une référence SKU Gestion des API disponible.

Nom Type Description
mode

MigrateToStv2Mode

Mode de migration vers stv2. La valeur par défaut est PreserveIp.

MigrateToStv2Mode

Énumération

Mode de migration vers stv2. La valeur par défaut est PreserveIp.

Valeur Description
NewIP

Migrez le service Gestion des API vers stv2 à partir de stv1. Cela n’aura aucun temps d’arrêt, car la configuration du service sera migrée vers une nouvelle infrastructure, mais l’adresse IP sera modifiée.
PreserveIp

Migrez le service Gestion des API vers stv2 à partir de stv1, en réservant l’adresse IP du service. Cela aura un temps d’arrêt allant jusqu’à 15 minutes, tandis que l’adresse IP est migrée vers une nouvelle infrastructure.

NatGatewayState

Énumération

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

Valeur Description
Disabled

La passerelle Nat est désactivée pour le service.
Enabled

La passerelle Nat est activée pour le service.

PlatformVersion

Énumération

Version de la plateforme de calcul exécutant le service.

Valeur Description
mtv1

Plateforme exécutant le service sur la plateforme multilocataire V1.
stv1

Plateforme exécutant le service sur la plateforme V1 à locataire unique.
stv2

Plateforme exécutant le service sur la plateforme V2 à locataire unique.
stv2.1

Plateforme exécutant le service sur la plateforme V2 à locataire unique sur un matériel plus récent.
undetermined

La version de la plateforme ne peut pas être déterminée, car la plateforme de calcul n’est pas déployée.

PrivateEndpointServiceConnectionStatus

Énumération

État de la connexion de point de terminaison privé.

Valeur Description
Approved
Pending
Rejected

PrivateLinkServiceConnectionState

Object

Collection d’informations sur l’état de la connexion entre le consommateur de services et le fournisseur.

Nom Type Description
actionsRequired

string

Message indiquant si les modifications apportées au fournisseur de services nécessitent des mises à jour sur le consommateur.
description

string

Raison de l’approbation/rejet de la connexion.
status

PrivateEndpointServiceConnectionStatus

Indique si la connexion a été approuvée/rejetée/supprimée par le propriétaire du service.

PublicNetworkAccess

Énumération

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

Valeur Description
Disabled
Enabled

RemotePrivateEndpointConnectionWrapper

Object

Ressource de connexion de point de terminaison privé distant.

Nom Type Description
id

string

ID de ressource de connexion de point de terminaison privé
name

string

Nom de la connexion de point de terminaison privé
properties.groupIds

string[]

Tous les ID de groupe.
properties.privateEndpoint

ArmIdWrapper

Ressource du point de terminaison privé.
properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Collection d’informations sur l’état de la connexion entre le consommateur de services et le fournisseur.
properties.provisioningState

string

État d’approvisionnement de la ressource de connexion de point de terminaison privé.
type

string

Type de ressource de connexion de point de terminaison privé

SkuType

Énumération

Nom de la référence SKU.

Valeur Description
Basic

Référence SKU de base de Gestion des API.
BasicV2

Référence SKU BasicV2 de Gestion des API.
Consumption

Référence SKU consommation de Gestion des API.
Developer

Référence SKU du développeur de gestion des API.
Isolated

Référence SKU isolée de Gestion des API.
Premium

Référence SKU Premium de Gestion des API.
Standard

Référence SKU standard de gestion des API.
StandardV2

Référence SKU StandardV2 de Gestion des API.

systemData

Object

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom Type Description
createdAt

string (date-time)

Horodatage de la création de ressources (UTC).
createdBy

string

Identité qui a créé la ressource.
createdByType

createdByType

Type d’identité qui a créé la ressource.
lastModifiedAt

string (date-time)

Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy

string

Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType

createdByType

Type d’identité qui a modifié la ressource pour la dernière fois.

UserIdentityProperties

Object
Nom Type Description
clientId

string

ID client de l’identité affectée par l’utilisateur.
principalId

string

ID principal de l’identité affectée par l’utilisateur.

VirtualNetworkConfiguration

Object

Configuration d’un réseau virtuel sur lequel le service Gestion des API est déployé.

Nom Type Description
subnetResourceId

string

pattern: ^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$

ID de ressource complet d’un sous-réseau dans un réseau virtuel dans lequel déployer le service Gestion des API.
subnetname

string

Nom du sous-réseau.
vnetid

string

ID de réseau virtuel. Il s’agit généralement d’un GUID. Attendez-vous à un GUID Null par défaut.

VirtualNetworkType

Énumération

Type de VPN dans lequel le service Gestion des API doit être configuré. Aucune (valeur par défaut) signifie que le service Gestion des API ne fait pas partie d’un réseau virtuel, externe signifie que le déploiement gestion des API est configuré à l’intérieur d’un réseau virtuel disposant d’un point de terminaison accessible sur Internet, et que le déploiement interne de gestion des API est configuré à l’intérieur d’un réseau virtuel disposant d’un point de terminaison intranet uniquement.

Valeur Description
External

Le service fait partie du réseau virtuel et est accessible à partir d’Internet.
Internal

Le service fait partie du réseau virtuel et n’est accessible qu’à partir du réseau virtuel.
None

Le service ne fait pas partie d’un réseau virtuel.