Gateway Api - Create Or Update

Service:

API Management

Version d'API:

2021-08-01

Ajoute une API à la passerelle spécifiée.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
apiId	path	True	string	Identificateur d'API. Doit être unique dans le instance de service Gestion des API actuel.
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.
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 du client.

Corps de la demande

Nom	Type	Description
properties.provisioningState	ProvisioningState	État d’approvisionnement.

Réponses

Nom	Type	Description
200 OK	ApiContract	L’API spécifiée est déjà ajoutée à la passerelle.
201 Created	ApiContract	L’API a été ajoutée à la passerelle.
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

ApiManagementCreateGatewayApi

Exemple de requête

HTTP

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

{
  "properties": {
    "provisioningState": "created"
  }
}

Java

import com.azure.core.util.Context;
import com.azure.resourcemanager.apimanagement.models.AssociationContract;
import com.azure.resourcemanager.apimanagement.models.ProvisioningState;

/** Samples for GatewayApi CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementCreateGatewayApi.json
     */
    /**
     * Sample code: ApiManagementCreateGatewayApi.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementCreateGatewayApi(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .gatewayApis()
            .createOrUpdateWithResponse(
                "rg1",
                "apimService1",
                "gw1",
                "echo-api",
                new AssociationContract().withProvisioningState(ProvisioningState.CREATED),
                Context.NONE);
    }
}

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 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_api.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_api.create_or_update(
        resource_group_name="rg1",
        service_name="apimService1",
        gateway_id="gw1",
        api_id="echo-api",
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementCreateGatewayApi.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"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c767823fdfd9d5e96bad245e3ea4d14d94a716bb/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementCreateGatewayApi.json
func ExampleGatewayAPIClient_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.NewGatewayAPIClient().CreateOrUpdate(ctx, "rg1", "apimService1", "gw1", "echo-api", &armapimanagement.GatewayAPIClientCreateOrUpdateOptions{Parameters: &armapimanagement.AssociationContract{
		Properties: &armapimanagement.AssociationContractProperties{
			ProvisioningState: to.Ptr("created"),
		},
	},
	})
	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.APIContract = armapimanagement.APIContract{
	// 	Name: to.Ptr("echo-api"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service/gateways/apis"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/apis/echo-api"),
	// 	Properties: &armapimanagement.APIContractProperties{
	// 		APIRevision: to.Ptr("1"),
	// 		IsCurrent: to.Ptr(true),
	// 		SubscriptionKeyParameterNames: &armapimanagement.SubscriptionKeyParameterNamesContract{
	// 			Header: to.Ptr("Ocp-Apim-Subscription-Key"),
	// 			Query: to.Ptr("subscription-key"),
	// 		},
	// 		Path: to.Ptr(""),
	// 		DisplayName: to.Ptr("EchoApi"),
	// 		Protocols: []*armapimanagement.Protocol{
	// 			to.Ptr(armapimanagement.ProtocolHTTP),
	// 			to.Ptr(armapimanagement.ProtocolHTTPS)},
	// 			ServiceURL: to.Ptr("https://contoso.com/apis/echo"),
	// 		},
	// 	}
}

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 Adds an API to the specified Gateway.
 *
 * @summary Adds an API to the specified Gateway.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementCreateGatewayApi.json
 */
async function apiManagementCreateGatewayApi() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const gatewayId = "gw1";
  const apiId = "echo-api";
  const parameters = { provisioningState: "created" };
  const options = { parameters };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.gatewayApi.createOrUpdate(
    resourceGroupName,
    serviceName,
    gatewayId,
    apiId,
    options
  );
  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

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.ApiManagement;
using Azure.ResourceManager.ApiManagement.Models;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementCreateGatewayApi.json
// this example is just showing the usage of "GatewayApi_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ApiManagementGatewayResource created on azure
// for more information of creating ApiManagementGatewayResource, please refer to the document of ApiManagementGatewayResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
string gatewayId = "gw1";
ResourceIdentifier apiManagementGatewayResourceId = ApiManagementGatewayResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName, gatewayId);
ApiManagementGatewayResource apiManagementGateway = client.GetApiManagementGatewayResource(apiManagementGatewayResourceId);

// invoke the operation
string apiId = "echo-api";
AssociationContract associationContract = new AssociationContract()
{
    ProvisioningState = AssociationEntityProvisioningState.Created,
};
GatewayApiData result = await apiManagementGateway.CreateOrUpdateGatewayApiAsync(apiId, associationContract: associationContract);

Console.WriteLine($"Succeeded: {result}");

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

Exemple de réponse

Code d’état:

201

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/apis/echo-api",
  "type": "Microsoft.ApiManagement/service/gateways/apis",
  "name": "echo-api",
  "properties": {
    "displayName": "EchoApi",
    "apiRevision": "1",
    "serviceUrl": "https://contoso.com/apis/echo",
    "path": "",
    "protocols": [
      "http",
      "https"
    ],
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    },
    "isCurrent": true
  }
}

Code d’état:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/apis/echo-api",
  "type": "Microsoft.ApiManagement/service/gateways/apis",
  "name": "echo-api",
  "properties": {
    "displayName": "EchoApi",
    "apiRevision": "1",
    "serviceUrl": "https://contoso.com/apis/echo",
    "path": "",
    "protocols": [
      "http",
      "https"
    ],
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    },
    "isCurrent": true
  }
}

Définitions

Nom	Description
ApiContactInformation	Informations de contact de l’API
ApiContract	Détails de l’API.
ApiLicenseInformation	Informations de licence d’API
ApiType	Type d’API.
ApiVersionSetContractDetails	Un jeu de versions d’API contient la configuration courante d’un ensemble de versions d’API associées
AssociationContract	Détails de l’entité d’association.
AuthenticationSettingsContract	Paramètres d’authentification de l’API.
bearerTokenSendingMethods	Comment envoyer un jeton au serveur.
ErrorFieldContract	Contrat de champ d’erreur.
ErrorResponse	Réponse d’erreur.
OAuth2AuthenticationSettingsContract	Détails des paramètres d’authentification OAuth2 de l’API.
OpenIdAuthenticationSettingsContract	Détails des paramètres d’authentification OAuth2 de l’API.
Protocol	Indique sur quels protocoles les opérations dans cette API peuvent être appelées.
ProvisioningState	État d’approvisionnement.
SubscriptionKeyParameterNamesContract	Détails des noms de paramètres de clé d’abonnement.

ApiContactInformation

Informations de contact de l’API

Nom	Type	Description
email	string	Adresse e-mail de la personne/organization de contact. DOIT être au format d’une adresse e-mail
name	string	Nom d’identification de la personne/organization contact
url	string	URL pointant vers les informations de contact. DOIT être au format d’une URL

ApiContract

Détails de l’API.

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.apiRevision	string	Décrit la révision de l’API. Si aucune valeur n’est fournie, la révision par défaut 1 est créée
properties.apiRevisionDescription	string	Description de la révision de l’API.
properties.apiVersion	string	Indique l’identificateur de version de l’API si l’API est avec version
properties.apiVersionDescription	string	Description de la version de l’API.
properties.apiVersionSet	ApiVersionSetContractDetails	Détails du jeu de versions
properties.apiVersionSetId	string	Identificateur de ressource pour l’ApiVersionSet associé.
properties.authenticationSettings	AuthenticationSettingsContract	Collection de paramètres d’authentification inclus dans cette API.
properties.contact	ApiContactInformation	Informations de contact pour l’API.
properties.description	string	Description de l’API. Peut comporter des balises de mise en forme.
properties.displayName	string	Nom de l’API. Doit comporter entre 1 et 300 caractères.
properties.isCurrent	boolean	Indique si la révision de l’API est la révision actuelle de l’API.
properties.isOnline	boolean	Indique si la révision de l’API est accessible via la passerelle.
properties.license	ApiLicenseInformation	Informations de licence pour l’API.
properties.path	string	URL relative identifiant exclusivement cette API et tous les chemins d’accès à ses ressources au sein de l’instance de service Gestion des API. Elle est ajoutée à l’URL de base du point de terminaison d’API spécifiée lors de la création de l’instance de service pour former l’URL publique de cette API.
properties.protocols	Protocol[]	Indique sur quels protocoles les opérations dans cette API peuvent être appelées.
properties.serviceUrl	string	URL absolue du service principal qui implémente cette API. Ne peut pas avoir plus de 2 000 caractères.
properties.sourceApiId	string	Identificateur d’API de l’API source.
properties.subscriptionKeyParameterNames	SubscriptionKeyParameterNamesContract	Protocoles sur lesquels l’API est mise à disposition.
properties.subscriptionRequired	boolean	Spécifie si un abonnement d’API ou de produit est requis pour accéder à l’API.
properties.termsOfServiceUrl	string	URL des conditions d’utilisation de l’API. DOIT être au format d’une URL.
properties.type	ApiType	Type d’API.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

ApiLicenseInformation

Informations de licence d’API

Nom	Type	Description
name	string	Nom de licence utilisé pour l’API
url	string	URL de la licence utilisée pour l’API. DOIT être au format d’une URL

ApiType

Type d’API.

Nom	Type	Description
graphql	string
http	string
soap	string
websocket	string

ApiVersionSetContractDetails

Un jeu de versions d’API contient la configuration courante d’un ensemble de versions d’API associées

Nom	Type	Description
description	string	Description de l’ensemble de versions d’API.
id	string	Identificateur de l’ensemble de versions d’API existant. Omettez cette valeur pour créer un jeu de versions.
name	string	Nom complet de l’ensemble de versions de l’API.
versionHeaderName	string	Nom du paramètre d’en-tête HTTP qui indique la version de l’API si versioningScheme est défini sur header.
versionQueryName	string	Nom du paramètre de requête qui indique la version de l’API si versioningScheme a la valeur query.
versioningScheme	enum: Header Query Segment	Valeur qui détermine l’emplacement de l’identificateur de version de l’API dans une requête HTTP.

AssociationContract

Détails de l’entité d’association.

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.provisioningState	ProvisioningState	État d’approvisionnement.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

AuthenticationSettingsContract

Paramètres d’authentification de l’API.

Nom	Type	Description
oAuth2	OAuth2AuthenticationSettingsContract	Paramètres d’authentification OAuth2
openid	OpenIdAuthenticationSettingsContract	Paramètres d’authentification OpenID Connect

bearerTokenSendingMethods

Comment envoyer un jeton au serveur.

Nom	Type	Description
authorizationHeader	string	Le jeton d’accès sera transmis dans l’en-tête d’autorisation à l’aide du schéma du porteur
query	string	Le jeton d’accès est transmis en tant que paramètres de requête.

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.

OAuth2AuthenticationSettingsContract

Détails des paramètres d’authentification OAuth2 de l’API.

Nom	Type	Description
authorizationServerId	string	Identificateur du serveur d'autorisation OAuth.
scope	string	étendue des opérations.

OpenIdAuthenticationSettingsContract

Détails des paramètres d’authentification OAuth2 de l’API.

Nom	Type	Description
bearerTokenSendingMethods	bearerTokenSendingMethods[]	Comment envoyer un jeton au serveur.
openidProviderId	string	Identificateur du serveur d'autorisation OAuth.

Protocol

Indique sur quels protocoles les opérations dans cette API peuvent être appelées.

Nom	Type	Description
http	string
https	string
ws	string
wss	string

ProvisioningState

État d’approvisionnement.

Nom	Type	Description
created	string

SubscriptionKeyParameterNamesContract

Détails des noms de paramètres de clé d’abonnement.

Nom	Type	Description
header	string	Nom de l’en-tête de clé d’abonnement.
query	string	Nom du paramètre de chaîne de requête de clé d’abonnement.