Gateway - Create Or Update

Service:

API Management

API Version:

2022-08-01

Crée ou met à jour une passerelle à utiliser dans gestion des API instance.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/gateways/{gatewayId}?api-version=2022-08-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
gatewayId	path	True	string	Identificateur d’entité de passerelle. Doit être unique dans le instance de service Gestion des API actuel. Ne doit pas avoir la valeur 'managed'
resourceGroupName	path	True	string	Nom du groupe de ressources. Le nom ne respecte pas la casse.
serviceName	path	True	string	Nom du service Gestion des API. Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	ID de l’abonnement cible.
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

En-tête de la demande

Nom	Obligatoire	Type	Description
If-Match		string	ETag de l’entité. Non obligatoire lors de la création d’une entité, mais obligatoire lors de la mise à jour d’une entité.

Corps de la demande

Nom	Type	Description
properties.description	string	Description de la passerelle
properties.locationData	ResourceLocationDataContract	Emplacement de la passerelle.

Réponses

Nom	Type	Description
200 OK	GatewayContract	Les détails de la passerelle ont été correctement mis à jour. Headers ETag: string
201 Created	GatewayContract	La nouvelle passerelle a été ajoutée avec succès. Headers ETag: string
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
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Exemples

ApiManagementCreateGateway

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1?api-version=2022-08-01

{
  "properties": {
    "description": "my gateway 1",
    "locationData": {
      "name": "my location"
    }
  }
}

Java

import com.azure.resourcemanager.apimanagement.models.ResourceLocationDataContract;

/** Samples for Gateway CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateGateway.json
     */
    /**
     * Sample code: ApiManagementCreateGateway.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementCreateGateway(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .gateways()
            .define("gw1")
            .withExistingService("rg1", "apimService1")
            .withLocationData(new ResourceLocationDataContract().withName("my location"))
            .withDescription("my gateway 1")
            .create();
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from typing import Any, IO, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_create_gateway.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.gateway.create_or_update(
        resource_group_name="rg1",
        service_name="apimService1",
        gateway_id="gw1",
        parameters={"properties": {"description": "my gateway 1", "locationData": {"name": "my location"}}},
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateGateway.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armapimanagement_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateGateway.json
func ExampleGatewayClient_CreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewGatewayClient().CreateOrUpdate(ctx, "rg1", "apimService1", "gw1", armapimanagement.GatewayContract{
		Properties: &armapimanagement.GatewayContractProperties{
			Description: to.Ptr("my gateway 1"),
			LocationData: &armapimanagement.ResourceLocationDataContract{
				Name: to.Ptr("my location"),
			},
		},
	}, &armapimanagement.GatewayClientCreateOrUpdateOptions{IfMatch: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.GatewayContract = armapimanagement.GatewayContract{
	// 	Name: to.Ptr("a1"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service/gateways"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1"),
	// 	Properties: &armapimanagement.GatewayContractProperties{
	// 		Description: to.Ptr("my gateway 1"),
	// 		LocationData: &armapimanagement.ResourceLocationDataContract{
	// 			Name: to.Ptr("my location"),
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Creates or updates a Gateway to be used in Api Management instance.
 *
 * @summary Creates or updates a Gateway to be used in Api Management instance.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateGateway.json
 */
async function apiManagementCreateGateway() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const gatewayId = "gw1";
  const parameters = {
    description: "my gateway 1",
    locationData: { name: "my location" },
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.gateway.createOrUpdate(
    resourceGroupName,
    serviceName,
    gatewayId,
    parameters
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

201

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1",
  "type": "Microsoft.ApiManagement/service/gateways",
  "name": "a1",
  "properties": {
    "description": "my gateway 1",
    "locationData": {
      "name": "my location"
    }
  }
}

Status code:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1",
  "type": "Microsoft.ApiManagement/service/gateways",
  "name": "a1",
  "properties": {
    "description": "my gateway 1",
    "locationData": {
      "name": "my location"
    }
  }
}

Définitions

Nom	Description
ErrorFieldContract	Contrat de champ d’erreur.
ErrorResponse	Réponse d’erreur.
GatewayContract	Détails de la passerelle.
ResourceLocationDataContract	Propriétés des données de l’emplacement des ressources.

ErrorFieldContract

Contrat de 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 des propriétés.
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.

GatewayContract

Détails de la passerelle.

Nom	Type	Description
id	string	ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	nom de la ressource.
properties.description	string	Description de la passerelle
properties.locationData	ResourceLocationDataContract	Emplacement de la passerelle.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

ResourceLocationDataContract

Propriétés des données de l’emplacement des ressources.

Nom	Type	Description
city	string	Ville ou localité où se trouve la ressource.
countryOrRegion	string	Pays ou région où se trouve la ressource.
district	string	Le district, l’état ou la province où se trouve la ressource.
name	string	Nom canonique pour l’emplacement géographique ou physique.