Gateway Api - Create Or Update

Servizio:

API Management

Versione API:

2021-08-01

Aggiunge un'API al gateway specificato.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
apiId	path	True	string	Identificatore API. Deve essere univoco nell'istanza corrente del servizio di Gestione API.
gatewayId	path	True	string	Identificatore di entità del gateway. Deve essere univoco nell'istanza corrente del servizio di Gestione API. Non deve avere il valore 'managed'
resourceGroupName	path	True	string	Nome del gruppo di risorse.
serviceName	path	True	string	Nome del servizio di Gestione API. Criterio di espressione regolare: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	Credenziali di sottoscrizione che identificano in modo univoco la sottoscrizione di Microsoft Azure. L'ID sottoscrizione fa parte dell'URI per ogni chiamata di servizio.
api-version	query	True	string	Versione dell'API da usare con la richiesta client.

Corpo della richiesta

Nome	Tipo	Descrizione
properties.provisioningState	ProvisioningState	Stato del provisioning.

Risposte

Nome	Tipo	Descrizione
200 OK	ApiContract	L'API specificata è già stata aggiunta al gateway.
201 Created	ApiContract	L'API è stata aggiunta correttamente al gateway.
Other Status Codes	ErrorResponse	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

ApiManagementCreateGatewayApi

Esempio di richiesta

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

Risposta di esempio

Codice di stato:

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
  }
}

Codice di stato:

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
  }
}

Definizioni

Nome	Descrizione
ApiContactInformation	Informazioni di contatto dell'API
ApiContract	Dettagli dell'API.
ApiLicenseInformation	Informazioni sulle licenze API
ApiType	Tipo di API.
ApiVersionSetContractDetails	Un set di versioni dell'API contiene la configurazione comune per un set di versioni API correlate
AssociationContract	Dettagli dell'entità di associazione.
AuthenticationSettingsContract	Impostazioni di autenticazione API.
bearerTokenSendingMethods	Come inviare il token al server.
ErrorFieldContract	Contratto campo di errore.
ErrorResponse	Risposta errore.
OAuth2AuthenticationSettingsContract	Dettagli delle impostazioni di autenticazione OAuth2 dell'API.
OpenIdAuthenticationSettingsContract	Dettagli delle impostazioni di autenticazione OAuth2 dell'API.
Protocol	Descrive su quali protocolli è possibile richiamare le operazioni in questa API.
ProvisioningState	Stato del provisioning.
SubscriptionKeyParameterNamesContract	Dettagli dei nomi dei parametri della chiave di sottoscrizione.

ApiContactInformation

Informazioni di contatto dell'API

Nome	Tipo	Descrizione
email	string	Indirizzo di posta elettronica della persona o dell'organizzazione di contatto. DEVE essere nel formato di un indirizzo di posta elettronica
name	string	Nome di identificazione della persona o dell'organizzazione di contatto
url	string	URL che punta alle informazioni di contatto. DEVE essere nel formato di un URL

ApiContract

Dettagli dell'API.

Nome	Tipo	Descrizione
id	string	ID di risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	nome della risorsa.
properties.apiRevision	string	Descrive la revisione dell'API. Se non viene specificato alcun valore, viene creata la revisione predefinita 1
properties.apiRevisionDescription	string	Descrizione della revisione dell'API.
properties.apiVersion	string	Indica l'identificatore della versione dell'API se l'API è con versione
properties.apiVersionDescription	string	Descrizione della versione dell'API.
properties.apiVersionSet	ApiVersionSetContractDetails	Dettagli del set di versioni
properties.apiVersionSetId	string	Identificatore di risorsa per l'ApiVersionSet correlato.
properties.authenticationSettings	AuthenticationSettingsContract	Raccolta di impostazioni di autenticazione incluse in questa API.
properties.contact	ApiContactInformation	Informazioni di contatto per l'API.
properties.description	string	Descrizione dell'API. Può includere tag di formattazione HTML.
properties.displayName	string	Nome API. Deve contenere da 1 a 300 caratteri.
properties.isCurrent	boolean	Indica se la revisione dell'API è la revisione api corrente.
properties.isOnline	boolean	Indica se la revisione dell'API è accessibile tramite il gateway.
properties.license	ApiLicenseInformation	Informazioni sulla licenza per l'API.
properties.path	string	URL relativo che identifica in modo univoco questa API e tutti i relativi percorsi delle risorse all'interno dell'istanza del servizio Gestione API. Viene aggiunto all'URL di base dell'endpoint API specificato durante la creazione dell'istanza del servizio in modo da formare un URL pubblico per questa API.
properties.protocols	Protocol[]	Descrive su quali protocolli è possibile richiamare le operazioni in questa API.
properties.serviceUrl	string	URL assoluto del servizio back-end che implementa questa API. Non può contenere più di 2000 caratteri.
properties.sourceApiId	string	Identificatore API dell'API di origine.
properties.subscriptionKeyParameterNames	SubscriptionKeyParameterNamesContract	Protocolli su cui viene resa disponibile l'API.
properties.subscriptionRequired	boolean	Specifica se è necessaria una sottoscrizione API o Product per l'accesso all'API.
properties.termsOfServiceUrl	string	URL delle Condizioni per il servizio per l'API. DEVE essere nel formato di un URL.
properties.type	ApiType	Tipo di API.
type	string	Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

ApiLicenseInformation

Informazioni sulle licenze API

Nome	Tipo	Descrizione
name	string	Nome della licenza usato per l'API
url	string	URL della licenza usata per l'API. DEVE essere nel formato di un URL

ApiType

Tipo di API.

Nome	Tipo	Descrizione
graphql	string
http	string
soap	string
websocket	string

ApiVersionSetContractDetails

Un set di versioni dell'API contiene la configurazione comune per un set di versioni API correlate

Nome	Tipo	Descrizione
description	string	Descrizione del set di versioni dell'API.
id	string	Identificatore per il set di versioni dell'API esistente. Omettere questo valore per creare un nuovo set di versioni.
name	string	Nome visualizzato del set di versioni dell'API.
versionHeaderName	string	Nome del parametro di intestazione HTTP che indica la versione dell'API se versioningScheme è impostato su header.
versionQueryName	string	Nome del parametro di query che indica la versione dell'API se versioningScheme è impostato su query.
versioningScheme	enum: Header Query Segment	Valore che determina dove si troverà l'identificatore della versione dell'API in una richiesta HTTP.

AssociationContract

Dettagli dell'entità di associazione.

Nome	Tipo	Descrizione
id	string	ID di risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	nome della risorsa.
properties.provisioningState	ProvisioningState	Stato del provisioning.
type	string	Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

AuthenticationSettingsContract

Impostazioni di autenticazione API.

Nome	Tipo	Descrizione
oAuth2	OAuth2AuthenticationSettingsContract	Impostazioni di autenticazione OAuth2
openid	OpenIdAuthenticationSettingsContract	Impostazioni di autenticazione openID Connect

bearerTokenSendingMethods

Come inviare il token al server.

Nome	Tipo	Descrizione
authorizationHeader	string	Il token di accesso verrà trasmesso nell'intestazione authorization usando lo schema Bearer
query	string	Il token di accesso verrà trasmesso come parametri di query.

ErrorFieldContract

Contratto campo di errore.

Nome	Tipo	Descrizione
code	string	Codice di errore a livello di proprietà.
message	string	Rappresentazione leggibile dell'errore a livello di proprietà.
target	string	Nome della proprietà.

ErrorResponse

Risposta errore.

Nome	Tipo	Descrizione
error.code	string	Codice di errore definito dal servizio. Questo codice svolge la funzione di stato secondario per il codice di errore HTTP specificato nella risposta.
error.details	ErrorFieldContract[]	Elenco di campi non validi inviati nella richiesta, in caso di errore di convalida.
error.message	string	Rappresentazione leggibile dell'errore.

OAuth2AuthenticationSettingsContract

Dettagli delle impostazioni di autenticazione OAuth2 dell'API.

Nome	Tipo	Descrizione
authorizationServerId	string	Identificatore del server di autorizzazione OAuth.
scope	string	ambito delle operazioni.

OpenIdAuthenticationSettingsContract

Dettagli delle impostazioni di autenticazione OAuth2 dell'API.

Nome	Tipo	Descrizione
bearerTokenSendingMethods	bearerTokenSendingMethods[]	Come inviare il token al server.
openidProviderId	string	Identificatore del server di autorizzazione OAuth.

Protocol

Descrive su quali protocolli è possibile richiamare le operazioni in questa API.

Nome	Tipo	Descrizione
http	string
https	string
ws	string
wss	string

ProvisioningState

Stato del provisioning.

Nome	Tipo	Descrizione
created	string

SubscriptionKeyParameterNamesContract

Dettagli dei nomi dei parametri della chiave di sottoscrizione.

Nome	Tipo	Descrizione
header	string	Nome dell'intestazione della chiave di sottoscrizione.
query	string	Nome del parametro della stringa di query della chiave di sottoscrizione.