Gateway Api - Create Or Update

Dienst:

API Management

API-Version:

2022-08-01

Fügt dem angegebenen Gateway eine API hinzu.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
apiId	path	True	string	API-Bezeichner. Muss im aktuellen API Management-Dienst instance eindeutig sein.
gatewayId	path	True	string	Gatewayentitätsbezeichner. Muss im aktuellen API Management-Dienst instance eindeutig sein. Darf nicht über den Wert "managed" verfügen.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
serviceName	path	True	string	Der Name des API Management-Diensts. RegEx-Muster: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	Hierbei handelt es sich um die ID des Zielabonnements.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungstext

Name	Typ	Beschreibung
properties.provisioningState	ProvisioningState	Bereitstellungsstatus.

Antworten

Name	Typ	Beschreibung
200 OK	ApiContract	Die angegebene API wurde dem Gateway bereits hinzugefügt.
201 Created	ApiContract	Die API wurde dem Gateway erfolgreich hinzugefügt.
Other Status Codes	ErrorResponse	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

ApiManagementCreateGatewayApi

Beispielanforderung

HTTP

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

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

Java

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/2022-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),
                com.azure.core.util.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/2022-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/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/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/2022-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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ApiManagement.Models;
using Azure.ResourceManager.ApiManagement;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-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

Beispiel für eine Antwort

Statuscode:

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

Statuscode:

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

Definitionen

Name	Beschreibung
ApiContactInformation	API-Kontaktinformationen
ApiContract	API-Details.
ApiLicenseInformation	API-Lizenzinformationen
ApiType	Art der API.
ApiVersionSetContractDetails	Ein API-Versionssatz enthält die allgemeine Konfiguration für eine Reihe von API-Versionen, die sich auf
AssociationContract	Zuordnungsentitätsdetails.
AuthenticationSettingsContract	API-Authentifizierungseinstellungen.
bearerTokenSendingMethods	So senden Sie ein Token an den Server.
ErrorFieldContract	Fehlerfeldvertrag.
ErrorResponse	Fehlerantwort.
OAuth2AuthenticationSettingsContract	Details zu API OAuth2-Authentifizierungseinstellungen.
OpenIdAuthenticationSettingsContract	Details zu API OAuth2-Authentifizierungseinstellungen.
Protocol	Beschreibt, über welche Protokolle die Vorgänge in dieser API aufgerufen werden können.
ProvisioningState	Bereitstellungsstatus.
SubscriptionKeyParameterNamesContract	Details zu Abonnementschlüsselparametern.
versioningScheme	Ein Wert, der bestimmt, wo sich der API-Versionsbezeichner in einer HTTP-Anforderung befindet.

ApiContactInformation

API-Kontaktinformationen

Name	Typ	Beschreibung
email	string	Die E-Mail-Adresse des Ansprechpartners/organization. MUSS im Format einer E-Mail-Adresse vorliegen
name	string	Der identifizierende Name der Kontaktperson/organization
url	string	Die URL, die auf die Kontaktinformationen verweist. MUSS im Format einer URL vorliegen

ApiContract

API-Details.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Der Name der Ressource
properties.apiRevision	string	Beschreibt die Überarbeitung der API. Wenn kein Wert angegeben wird, wird die Standardrevision 1 erstellt.
properties.apiRevisionDescription	string	Beschreibung der API-Revision.
properties.apiVersion	string	Gibt den Versionsbezeichner der API an, wenn die API versioniert ist.
properties.apiVersionDescription	string	Beschreibung der API-Version.
properties.apiVersionSet	ApiVersionSetContractDetails	Versionssatzdetails
properties.apiVersionSetId	string	Ein Ressourcenbezeichner für das zugehörige ApiVersionSet.
properties.authenticationSettings	AuthenticationSettingsContract	Sammlung von Authentifizierungseinstellungen, die in dieser API enthalten sind.
properties.contact	ApiContactInformation	Kontaktinformationen für die API.
properties.description	string	Beschreibung der API. Kann HTML-Formatierungstags umfassen.
properties.displayName	string	API-Name. Muss 1 bis 300 Zeichen lang sein.
properties.isCurrent	boolean	Gibt an, ob die API-Revision die aktuelle API-Revision ist.
properties.isOnline	boolean	Gibt an, ob auf die API-Revision über das Gateway zugegriffen werden kann.
properties.license	ApiLicenseInformation	Lizenzinformationen für die API.
properties.path	string	Relative URL, die diese API und all ihre Ressourcenpfade in der Instanz des API Management-Diensts eindeutig identifiziert. Sie wird an die Basis-URL des API-Endpunkts angehängt, die während der Dienstinstanzerstellung angegeben wurde, um eine öffentliche URL für diese API zu erstellen.
properties.protocols	Protocol[]	Beschreibt, über welche Protokolle die Vorgänge in dieser API aufgerufen werden können.
properties.serviceUrl	string	Absolute URL des Back-End-Diensts, der diese API implementiert. Darf nicht mehr als 2000 Zeichen lang sein.
properties.sourceApiId	string	API-Bezeichner der Quell-API.
properties.subscriptionKeyParameterNames	SubscriptionKeyParameterNamesContract	Protokolle, für die die API verfügbar gemacht wird.
properties.subscriptionRequired	boolean	Gibt an, ob ein API- oder Produktabonnement für den Zugriff auf die API erforderlich ist.
properties.termsOfServiceUrl	string	Eine URL zu den Nutzungsbedingungen für die API. MUSS im Format einer URL vorliegen.
properties.type	ApiType	Art der API.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

ApiLicenseInformation

API-Lizenzinformationen

Name	Typ	Beschreibung
name	string	Der für die API verwendete Lizenzname
url	string	Eine URL für die Lizenz, die für die API verwendet wird. MUSS im Format einer URL vorliegen

ApiType

Art der API.

Name	Typ	Beschreibung
graphql	string
http	string
soap	string
websocket	string

ApiVersionSetContractDetails

Ein API-Versionssatz enthält die allgemeine Konfiguration für eine Reihe von API-Versionen, die sich auf

Name	Typ	Beschreibung
description	string	Beschreibung des API-Versionssatzes.
id	string	Bezeichner für vorhandene API-Versionssätze. Lassen Sie diesen Wert weg, um einen neuen Versionssatz zu erstellen.
name	string	Der Anzeigename des API-Versionssatzes.
versionHeaderName	string	Name des HTTP-Headerparameters, der die API-Version angibt, wenn versioningScheme auf headerfestgelegt ist.
versionQueryName	string	Name des Abfrageparameters, der die API-Version angibt, wenn versioningScheme auf queryfestgelegt ist.
versioningScheme	versioningScheme	Ein Wert, der bestimmt, wo sich der API-Versionsbezeichner in einer HTTP-Anforderung befindet.

AssociationContract

Zuordnungsentitätsdetails.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Der Name der Ressource
properties.provisioningState	ProvisioningState	Bereitstellungsstatus.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

AuthenticationSettingsContract

API-Authentifizierungseinstellungen.

Name	Typ	Beschreibung
oAuth2	OAuth2AuthenticationSettingsContract	OAuth2-Authentifizierungseinstellungen
oAuth2AuthenticationSettings	OAuth2AuthenticationSettingsContract[]	Sammlung von OAuth2-Authentifizierungseinstellungen, die in dieser API enthalten sind.
openid	OpenIdAuthenticationSettingsContract	OpenID Connect-Authentifizierungseinstellungen
openidAuthenticationSettings	OpenIdAuthenticationSettingsContract[]	Sammlung von Open ID Connect-Authentifizierungseinstellungen, die in dieser API enthalten sind.

bearerTokenSendingMethods

So senden Sie ein Token an den Server.

Name	Typ	Beschreibung
authorizationHeader	string	Das Zugriffstoken wird im Autorisierungsheader mithilfe des Bearerschemas übertragen.
query	string	Zugriffstoken werden als Abfrageparameter übertragen.

ErrorFieldContract

Fehlerfeldvertrag.

Name	Typ	Beschreibung
code	string	Fehlercode auf Eigenschaftsebene.
message	string	Für Menschen lesbare Darstellung eines Fehlers auf Eigenschaftsebene.
target	string	Der Eigenschaftsname.

ErrorResponse

Fehlerantwort.

Name	Typ	Beschreibung
error.code	string	Der vom Dienst definierte Fehlercode. Dieser Code dient als Unterstatus für den in der Antwort angegebenen HTTP-Fehlercode.
error.details	ErrorFieldContract[]	Die Liste der ungültigen Felder, die im Falle eines Überprüfungsfehlers gesendet werden.
error.message	string	Lesbare Darstellung des Fehlers.

OAuth2AuthenticationSettingsContract

Details zu API OAuth2-Authentifizierungseinstellungen.

Name	Typ	Beschreibung
authorizationServerId	string	Bezeichner (ID) des OAuth-Autorisierungsservers.
scope	string	Operations-Bereich.

OpenIdAuthenticationSettingsContract

Details zu API OAuth2-Authentifizierungseinstellungen.

Name	Typ	Beschreibung
bearerTokenSendingMethods	bearerTokenSendingMethods[]	So senden Sie ein Token an den Server.
openidProviderId	string	Bezeichner (ID) des OAuth-Autorisierungsservers.

Protocol

Beschreibt, über welche Protokolle die Vorgänge in dieser API aufgerufen werden können.

Name	Typ	Beschreibung
http	string
https	string
ws	string
wss	string

ProvisioningState

Bereitstellungsstatus.

Name	Typ	Beschreibung
created	string

SubscriptionKeyParameterNamesContract

Details zu Abonnementschlüsselparametern.

Name	Typ	Beschreibung
header	string	Name des Abonnementschlüsselheaders.
query	string	Name des Abonnementschlüsselabfragezeichenfolgenparameters.

versioningScheme

Ein Wert, der bestimmt, wo sich der API-Versionsbezeichner in einer HTTP-Anforderung befindet.

Name	Typ	Beschreibung
Header	string	Die API-Version wird in einem HTTP-Header übergeben.
Query	string	Die API-Version wird in einem Abfrageparameter übergeben.
Segment	string	Die API-Version wird in einem Pfadsegment übergeben.