Partager via

Api Management Service - Restore

  • Référence
Service:
API Management
Version d'API:
2021-08-01

Restaure une sauvegarde d’un service Gestion des API créé à l’aide de l’opération de ApiManagementService_Backup sur le service actuel. Il s’agit d’une opération de longue durée qui peut prendre plusieurs minutes.

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

Paramètres URI

Nom Dans Obligatoire Type Description
resourceGroupName
 path True

string

Nom du groupe de ressources.
serviceName
 path True

string

Nom du service Gestion des API.

Modèle d’expression régulière: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId
 path True

string

Informations d’identification d’abonnement qui identifient de manière unique l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.
api-version
 query True

string

Version de l’API à utiliser avec la demande cliente.

Corps de la demande

Nom Obligatoire Type Description
backupName True

string

Nom du fichier de sauvegarde à créer/récupérer.
containerName True

string

Nom du conteneur d’objets blob (utilisé pour placer/récupérer la sauvegarde).
storageAccount True

string

Nom du compte de stockage Azure (utilisé pour placer/récupérer la sauvegarde).
accessKey

string

Clé d’accès au compte de stockage. Obligatoire uniquement si accessType est défini sur AccessKey.
accessType

AccessType

Type d’accès à utiliser pour le compte de stockage.
clientId

string

ID client de l’identité managée affectée par l’utilisateur. Obligatoire uniquement si accessType est défini sur UserAssignedManagedIdentity.

Réponses

Nom Type Description
200 OK

ApiManagementServiceResource

Restauration de la sauvegarde sur le service Gestion des API.
202 Accepted

Accepté : l’en-tête Emplacement contient l’URL dans laquelle les status de l’opération de longue durée peuvent être vérifiées.
Other Status Codes

ErrorResponse

Réponse d’erreur décrivant la raison de l’échec de l’opération.

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

ApiManagementRestoreService

Exemple de requête

POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/restore?api-version=2021-08-01

{
  "storageAccount": "teststorageaccount",
  "containerName": "backupContainer",
  "backupName": "apimService1backup_2017_03_19",
  "accessType": "AccessKey",
  "accessKey": "**************************************************"
}

Exemple de réponse

Code d’état:
202 
location: https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/operationresults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2021-08-01
Code d’état:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1",
  "name": "apimService1",
  "type": "Microsoft.ApiManagement/service",
  "tags": {
    "tag1": "value1",
    "tag2": "value2",
    "tag3": "value3"
  },
  "location": "West US",
  "etag": "AAAAAAACXok=",
  "properties": {
    "publisherEmail": "apim@autorestsdk.com",
    "publisherName": "autorestsdk",
    "notificationSenderEmail": "apimgmt-noreply@mail.windowsazure.com",
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2019-12-18T06:26:20.3348609Z",
    "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
      },
      {
        "type": "Proxy",
        "hostName": "gateway1.msitesting.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2036-01-01T07:00:00+00:00",
          "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": true
      },
      {
        "type": "Management",
        "hostName": "mgmt.msitesting.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2036-01-01T07:00:00+00:00",
          "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": false
      },
      {
        "type": "Portal",
        "hostName": "portal1.msitesting.net",
        "negotiateClientCertificate": false,
        "certificate": {
          "expiry": "2036-01-01T07:00:00+00:00",
          "thumbprint": "8E989XXXXXXXXXXXXXXXXB9C2C91F1D174FDB3A2",
          "subject": "CN=*.msitesting.net"
        },
        "defaultSslBinding": false
      }
    ],
    "publicIPAddresses": [
      "13.91.32.113"
    ],
    "additionalLocations": [
      {
        "location": "East US",
        "sku": {
          "name": "Premium",
          "capacity": 1
        },
        "publicIPAddresses": [
          "23.101.138.153"
        ],
        "gatewayRegionalUrl": "https://apimService1-eastus-01.regional.azure-api.net",
        "disableGateway": true
      }
    ],
    "customProperties": {
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30": "False",
      "Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2": "False"
    },
    "virtualNetworkType": "None",
    "disableGateway": false,
    "apiVersionConstraint": {
      "minApiVersion": "2019-01-01"
    }
  },
  "sku": {
    "name": "Premium",
    "capacity": 1
  }
}

Définitions

Nom Description
AccessType

Type d’accès à utiliser pour le compte de stockage.
AdditionalLocation

Description d’un emplacement de ressource Gestion des API supplémentaire.
ApiManagementServiceBackupRestoreParameters

Paramètres fournis à la sauvegarde/restauration d’une opération de service Gestion des API.
ApiManagementServiceIdentity

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

Une ressource de service Gestion des API unique dans la réponse Liste ou Obtenir.
ApiManagementServiceSkuProperties

Gestion des API propriétés de la référence SKU de ressource de service.
ApimIdentityType

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

Contrainte de version des API du 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 de certificat SSL.
CertificateSource

Source de certificat.
CertificateStatus

État du certificat.
createdByType

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

Contrat champ d’erreur.
ErrorResponse

Réponse d’erreur.
HostnameConfiguration

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

Type de nom d’hôte.
PlatformVersion

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

La connexion de point de terminaison privé status.
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é 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 »
RemotePrivateEndpointConnectionWrapper

Ressource 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 Gestion des API service est déployé.
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.

AccessType

Type d’accès à utiliser pour le compte de stockage.

Nom Type Description
AccessKey

string

Utilisez la clé d’accès.
SystemAssignedManagedIdentity

string

Utilisez l’identité managée affectée par le système.
UserAssignedManagedIdentity

string

Utilisez l’identité managée affectée par l’utilisateur.

AdditionalLocation

Description d’un emplacement de ressource Gestion des API supplémentaire.

Nom Type Valeur par défaut Description
disableGateway

boolean

False

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

PlatformVersion

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

string[]

Les adresses IP privées statiques équilibrées du service Gestion des API qui est déployé dans un Réseau virtuel interne à un emplacement supplémentaire particulier. Disponible uniquement pour les références SKU De base, Standard, Premium et Isolé.
publicIPAddresses

string[]

Adresses IP publiques statiques équilibrées du service Gestion des API à l’emplacement supplémentaire. Disponible uniquement pour les références SKU De base, Standard, Premium et Isolé.
publicIpAddressId

string

Adresse IP V4 de la référence SKU SKU publique à associer à Réseau virtuel service déployé à l’emplacement. Pris en charge uniquement pour la référence SKU Premium déployée dans Réseau virtuel.
sku

ApiManagementServiceSkuProperties

Propriétés de la 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 d’où doit provenir la ressource.

ApiManagementServiceBackupRestoreParameters

Paramètres fournis à la sauvegarde/restauration d’une opération de service Gestion des API.

Nom Type Valeur par défaut Description
accessKey

string

Clé d’accès au compte de stockage. Obligatoire uniquement si accessType a la valeur AccessKey.
accessType

AccessType

AccessKey

Type d’accès à utiliser pour le compte de stockage.
backupName

string

Nom du fichier de sauvegarde à créer/récupérer.
clientId

string

ID client de l’identité managée affectée par l’utilisateur. Obligatoire uniquement si accessType a la valeur UserAssignedManagedIdentity.
containerName

string

Nom du conteneur d’objets blob (utilisé pour placer/récupérer la sauvegarde).
storageAccount

string

Nom du compte de stockage Azure (utilisé pour placer/récupérer la sauvegarde).

ApiManagementServiceIdentity

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

Nom Type Description
principalId

string

ID principal de l’identité.
tenantId

string

ID de locataire client de l’identité.
type

ApimIdentityType

Type d’identité utilisé pour la ressource. Le type « SystemAssigned, UserAssigned » comprend à la fois une identité créée implicitement et un ensemble d’identités attribué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 sont des ID de ressource ARM au format « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ».

ApiManagementServiceResource

Une ressource de service Gestion des API unique dans la réponse Liste ou Obtenir.

Nom Type Valeur par défaut Description
etag

string

ETag de la ressource.
id

string

ID de la ressource
identity

ApiManagementServiceIdentity

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

string

Emplacement de la ressource.
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 du 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.createdAtUtc

string

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

object

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
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é dans plusieurs emplacements. Vous pouvez l’utiliser pour désactiver la passerelle dans master région.
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 à 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 de nom d’hôte personnalisée du service Gestion des API.
properties.managementApiUrl

string

URL du point de terminaison de l’API de gestion du service Gestion des API.
properties.notificationSenderEmail

string

Email adresse à partir de laquelle la notification sera envoyée.
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 de publication du service Gestion des API.
properties.privateEndpointConnections

RemotePrivateEndpointConnectionWrapper[]

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

string[]

Adresses IP à charge statique privée équilibrée du service Gestion des API dans la région primaire qui est déployé dans un Réseau virtuel interne. Disponible uniquement pour les références 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 suivants : Created/Activateing/Succeeded/Updating/Failed/Stopped/TerminateFailed/Deleted.
properties.publicIPAddresses

string[]

Adresses IP publiques statiques équilibrées du service Gestion des API dans la région primaire. Disponible uniquement pour les références SKU De base, Standard, Premium et Isolé.
properties.publicIpAddressId

string

Adresse IP V4 de la référence SKU Standard 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.
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 transmise, 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

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

string

Nom de l’éditeur.
properties.restore

boolean

False

Annulez la suppression du service 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 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, qui est ciblé par l’opération de longue durée démarrée sur le service.
properties.virtualNetworkConfiguration

VirtualNetworkConfiguration

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

VirtualNetworkType

None

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

ApiManagementServiceSkuProperties

Propriétés de la 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

Type de ressource pour Gestion des API ressource est défini sur Microsoft.ApiManagement.
zones

string[]

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

ApiManagementServiceSkuProperties

Gestion des API propriétés de la référence SKU de ressource de service.

Nom Type Description
capacity

integer

Capacité de la référence SKU (nombre d’unités déployées de la référence SKU). Pour Consommation, la capacité de référence SKU doit être spécifiée comme étant 0.
name

SkuType

Nom de la référence SKU.

ApimIdentityType

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

Nom Type Description
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

ApiVersionConstraint

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

Nom Type Description
minApiVersion

string

Limitez les appels d’API de plan de contrôle à Gestion des API service dont la version est égale ou supérieure à cette valeur.

ArmIdWrapper

Wrapper pour un ID de ressource ARM

Nom Type Description
id

string

CertificateConfiguration

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 encodé en Base64.
storeName enum:
  • CertificateAuthority
  • Root

Emplacement du magasin de certificats System.Security.Cryptography.x509certificates.StoreName. Seuls root et CertificateAuthority sont des emplacements valides.

CertificateInformation

Informations de certificat SSL.

Nom Type Description
expiry

string

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

string

Objet du certificat.
thumbprint

string

Empreinte numérique du certificat.

CertificateSource

Source de certificat.

Nom Type Description
BuiltIn

string

Custom

string

KeyVault

string

Managed

string

CertificateStatus

État du certificat.

Nom Type Description
Completed

string

Failed

string

InProgress

string

createdByType

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

Nom Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorFieldContract

Contrat champ d’erreur.

Nom Type Description
code

string

Code d'erreur de niveau propriété.
message

string

Représentation lisible par l’homme de l’erreur au niveau de la propriété.
target

string

Nom de propriété.

ErrorResponse

Réponse d’erreur.

Nom Type Description
error.code

string

Code d'erreur défini par le service. Ce code sert de sous-état pour le code d'erreur HTTP spécifié dans la réponse.
error.details

ErrorFieldContract[]

Liste des champs non valides envoyés dans la demande, en cas d’erreur de validation.
error.message

string

Représentation contrôlable de visu de l’erreur.

HostnameConfiguration

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

Nom Type Valeur par défaut Description
certificate

CertificateInformation

Informations sur le certificat.
certificatePassword

string

Mot de passe du certificat.
certificateSource

CertificateSource

Source de 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 du proxy.
encodedCertificate

string

Certificat codé en base64.
hostName

string

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

string

ClientId d’identité managée affectée par le système ou par l’utilisateur, tel que généré par Azure AD, qui dispose d’un 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

Type de nom d’hôte.

Nom Type Description
DeveloperPortal

string

Management

string

Portal

string

Proxy

string

Scm

string

PlatformVersion

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

Nom Type Description
mtv1

string

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

string

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

string

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

string

Impossible de déterminer la version de la plateforme, car la plateforme de calcul n’est pas déployée.

PrivateEndpointServiceConnectionStatus

La connexion de point de terminaison privé status.

Nom Type Description
Approved

string

Pending

string

Rejected

string

PrivateLinkServiceConnectionState

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

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 »

Nom Type Description
Disabled

string

Enabled

string

RemotePrivateEndpointConnectionWrapper

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

Nom de la référence SKU.

Nom Type Description
Basic

string

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

string

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

string

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

string

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

string

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

string

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

systemData

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

Nom Type Description
createdAt

string

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

Horodatage de la dernière modification de la 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

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

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

Nom Type Description
subnetResourceId

string

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

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.

Nom Type Description
External

string

Le service fait partie de Réseau virtuel et il est accessible à partir d’Internet.
Internal

string

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

string

Le service ne fait partie d’aucune Réseau virtuel.