Api Gateway - Create Or Update

Service:: API Management

Version d'API:: 2024-05-01

Crée ou met à jour une passerelle Gestion des API. Il s’agit d’une opération longue et peut prendre plusieurs minutes.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/gateways/{gatewayName}?api-version=2024-05-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
gatewayName	path	True	string minLength: 1 maxLength: 45 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nom de la passerelle Gestion des API.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
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	Obligatoire	Type	Description
location	True	string	Emplacement des ressources.
sku	True	ApiManagementGatewaySkuProperties	Propriétés de référence SKU de la passerelle Gestion des API.
properties.backend		BackendConfiguration	Informations sur la façon dont la passerelle doit s’intégrer aux systèmes principaux.
properties.configurationApi		GatewayConfigurationApi	Informations relatives à l’API Configuration de la passerelle Gestion des API. Cela s’applique uniquement à la passerelle d’API avec une référence SKU Standard.
properties.frontend		FrontendConfiguration	Informations sur la façon dont la passerelle doit être exposée.
properties.virtualNetworkType		VirtualNetworkType	Type de VPN dans lequel la passerelle Gestion des API doit être configurée.
tags		object	Balises de ressource.

Réponses

Nom	Type	Description
200 OK	ApiManagementGatewayResource	La passerelle a été correctement configurée.
201 Created	ApiManagementGatewayResource	Créé
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

ApiManagementCreateStandardGateway

ApiManagementCreateWorkspacePremiumGateway

ApiManagementCreateStandardGateway

Exemple de requête

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1?api-version=2024-05-01

{
  "properties": {
    "backend": {
      "subnet": {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1"
      }
    }
  },
  "sku": {
    "name": "Standard",
    "capacity": 1
  },
  "location": "South Central US",
  "tags": {
    "Name": "Contoso",
    "Test": "User"
  }
}

Exemple de réponse

Code d’état:: 201

Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1",
  "name": "apimGateway1",
  "type": "Microsoft.ApiManagement/gateway",
  "tags": {
    "api-version": "2024-05-01"
  },
  "location": "East US",
  "etag": "AAAAAAAmRAM=",
  "properties": {
    "provisioningState": "Created",
    "targetProvisioningState": "Activating",
    "createdAtUtc": "2022-07-11T18:41:01.2506031Z",
    "backend": {
      "subnet": {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1"
      }
    }
  },
  "sku": {
    "name": "Standard",
    "capacity": 1
  },
  "systemData": {
    "createdBy": "user@contoso.com",
    "createdByType": "User",
    "createdAt": "2022-07-11T18:41:00.9390609Z",
    "lastModifiedBy": "user@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2022-07-11T18:41:00.9390609Z"
  }
}

Code d’état:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1",
  "name": "apimGateway1",
  "type": "Microsoft.ApiManagement/gateways",
  "tags": {
    "api-version": "2024-05-01"
  },
  "location": "East US",
  "etag": "AAAAAAAmREI=",
  "properties": {
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2022-07-11T18:41:01.2506031Z",
    "frontend": {
      "defaultHostname": "apimGateway1.eastus.gateway.azure-api.net"
    },
    "backend": {
      "subnet": {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1"
      }
    },
    "configurationApi": {
      "hostname": "apimGateway1.eastus.configuration.gateway.azure-api.net"
    }
  },
  "sku": {
    "name": "Standard",
    "capacity": 1
  },
  "systemData": {
    "createdBy": "user@contoso.com",
    "createdByType": "User",
    "createdAt": "2022-07-11T18:41:00.9390609Z",
    "lastModifiedBy": "user@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2022-07-11T18:41:00.9390609Z"
  }
}

ApiManagementCreateWorkspacePremiumGateway

Exemple de requête

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1?api-version=2024-05-01

{
  "properties": {
    "backend": {
      "subnet": {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1"
      }
    },
    "virtualNetworkType": "External"
  },
  "sku": {
    "name": "WorkspaceGatewayPremium",
    "capacity": 1
  },
  "location": "South Central US",
  "tags": {
    "Name": "Contoso",
    "Test": "User"
  }
}

Exemple de réponse

Code d’état:: 201

Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1/operationresults/ZWFzdHVzOmFuZHktdGVzdGluZy0yMDIyLTA0LTAxLXByZXZpZXctNF9BY3RfODQ2ZWE4Ng==?api-version=2024-05-01&asyncResponse

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1",
  "name": "apimGateway1",
  "type": "Microsoft.ApiManagement/gateway",
  "tags": {
    "api-version": "2024-05-01"
  },
  "location": "East US",
  "etag": "AAAAAAAmRAM=",
  "properties": {
    "provisioningState": "Created",
    "targetProvisioningState": "Activating",
    "createdAtUtc": "2022-07-11T18:41:01.2506031Z",
    "backend": {
      "subnet": {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1"
      }
    },
    "virtualNetworkType": "External"
  },
  "sku": {
    "name": "WorkspaceGatewayPremium",
    "capacity": 1
  },
  "systemData": {
    "createdBy": "user@contoso.com",
    "createdByType": "User",
    "createdAt": "2022-07-11T18:41:00.9390609Z",
    "lastModifiedBy": "user@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2022-07-11T18:41:00.9390609Z"
  }
}

Code d’état:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/apimGateway1",
  "name": "apimGateway1",
  "type": "Microsoft.ApiManagement/gateways",
  "tags": {
    "api-version": "2024-05-01"
  },
  "location": "East US",
  "etag": "AAAAAAAmREI=",
  "properties": {
    "provisioningState": "Succeeded",
    "targetProvisioningState": "",
    "createdAtUtc": "2022-07-11T18:41:01.2506031Z",
    "backend": {
      "subnet": {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vn1/subnets/sn1"
      }
    },
    "virtualNetworkType": "External"
  },
  "sku": {
    "name": "WorkspaceGatewayPremium",
    "capacity": 1
  },
  "systemData": {
    "createdBy": "user@contoso.com",
    "createdByType": "User",
    "createdAt": "2022-07-11T18:41:00.9390609Z",
    "lastModifiedBy": "user@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2022-07-11T18:41:00.9390609Z"
  }
}

Définitions

Nom	Description
ApiGatewaySkuType	Nom de la référence SKU.
ApiManagementGatewayResource	Ressource de passerelle Gestion des API unique dans Liste ou Obtenir une réponse.
ApiManagementGatewaySkuProperties	Propriétés de la référence SKU des ressources de la passerelle Gestion des API.
BackendConfiguration	Informations sur la façon dont la passerelle doit s’intégrer aux systèmes principaux.
BackendSubnetConfiguration	Informations sur la façon dont le sous-réseau auquel la passerelle doit être injectée.
createdByType	Type d’identité qui a créé la ressource.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
FrontendConfiguration	Informations sur la façon dont la passerelle doit être exposée.
GatewayConfigurationApi	Informations relatives à l’API Configuration de la passerelle Gestion des API. Cela s’applique uniquement à la passerelle d’API avec une référence SKU Standard.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
VirtualNetworkType	Type de VPN dans lequel la passerelle Gestion des API doit être configurée.

ApiGatewaySkuType

Énumération

Nom de la référence SKU.

Valeur	Description
Standard	Référence SKU standard de la passerelle d’API.
WorkspaceGatewayStandard	Référence SKU standard de la passerelle d’API à utiliser dans les espaces de travail.
WorkspaceGatewayPremium	Référence SKU Premium de la passerelle d’API à utiliser dans les espaces de travail.

ApiManagementGatewayResource

Object

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

Nom	Type	Description
etag	string	ETag de la ressource.
id	string	ID de ressource.
location	string	Emplacement des ressources.
name	string	Nom de la ressource.
properties.backend	BackendConfiguration	Informations sur la façon dont la passerelle doit s’intégrer aux systèmes principaux.
properties.configurationApi	GatewayConfigurationApi	Informations relatives à l’API Configuration de la passerelle Gestion des API. Cela s’applique uniquement à la passerelle d’API avec une référence SKU Standard.
properties.createdAtUtc	string (date-time)	Date UTC de création de la passerelle Gestion des API. La date est conforme au format suivant : `yyyy-MM-ddTHH:mm:ssZ` comme spécifié par la norme ISO 8601.
properties.frontend	FrontendConfiguration	Informations sur la façon dont la passerelle doit être exposée.
properties.provisioningState	string	État d’approvisionnement actuel de la passerelle Gestion des API qui peut être l’un des éléments suivants : Created/Activateing/Succeeded/Updating/Failed/Stop/Terminateting/TerminateFailed/Deleted.
properties.targetProvisioningState	string	État d’approvisionnement de la passerelle Gestion des API, ciblé par l’opération de longue durée démarrée sur la passerelle.
properties.virtualNetworkType	VirtualNetworkType	Type de VPN dans lequel la passerelle Gestion des API doit être configurée.
sku	ApiManagementGatewaySkuProperties	Propriétés de référence SKU de la passerelle 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.

ApiManagementGatewaySkuProperties

Object

Propriétés de la référence SKU des ressources de la passerelle 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)
name	ApiGatewaySkuType	Nom de la référence SKU.

BackendConfiguration

Object

Informations sur la façon dont la passerelle doit s’intégrer aux systèmes principaux.

Nom	Type	Description
subnet	BackendSubnetConfiguration	Nom d’hôte par défaut de la passerelle de plan de données vers laquelle les requêtes peuvent être envoyées.

BackendSubnetConfiguration

Object

Informations sur la façon dont le sous-réseau auquel la passerelle doit être injectée.

Nom	Type	Description
id	string	ID ARM du sous-réseau dans lequel les systèmes principaux sont hébergés.

createdByType

Énumération

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

Valeur	Description
User
Application
ManagedIdentity
Key

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.

FrontendConfiguration

Object

Informations sur la façon dont la passerelle doit être exposée.

Nom	Type	Description
defaultHostname	string	Nom d’hôte par défaut de la passerelle de plan de données vers laquelle les requêtes peuvent être envoyées. Cela s’applique uniquement à la passerelle d’API avec une référence SKU Standard.

GatewayConfigurationApi

Object

Informations relatives à l’API Configuration de la passerelle Gestion des API. Cela s’applique uniquement à la passerelle d’API avec une référence SKU Standard.

Nom	Type	Description
hostname	string	Nom d’hôte auquel l’agent se connecte pour propager la configuration vers le cloud.

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.

VirtualNetworkType

Énumération

Type de VPN dans lequel la passerelle Gestion des API doit être configurée.

Valeur	Description
None	La passerelle Gestion des API ne fait pas partie d’un réseau virtuel.
External	La passerelle Gestion des API fait partie du réseau virtuel et est accessible à partir d’Internet.
Internal	La passerelle Gestion des API fait partie du réseau virtuel et n’est accessible qu’à partir du réseau virtuel.

Partager via

Api Gateway - Create Or Update

Paramètres URI

Corps de la demande

Réponses

Sécurité

azure_auth

Étendues

Exemples

ApiManagementCreateStandardGateway

Exemple de requête

Exemple de réponse

ApiManagementCreateWorkspacePremiumGateway

Exemple de requête

Exemple de réponse

Définitions

ApiGatewaySkuType

ApiManagementGatewayResource

ApiManagementGatewaySkuProperties

BackendConfiguration

BackendSubnetConfiguration

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FrontendConfiguration

GatewayConfigurationApi

systemData

VirtualNetworkType