Api Gateway Config Connection - Create Or Update

Servicio:

API Management

Versión de la API:

2024-05-01

Crea o actualiza una conexión de configuración de puerta de enlace de API Management. Se trata de una operación de larga duración y puede tardar varios minutos en completarse.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
configConnectionName	path	True	string minLength: 1 maxLength: 30 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nombre de la conexión de configuración de puerta de enlace de API Management.
gatewayName	path	True	string minLength: 1 maxLength: 45 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nombre de la puerta de enlace de API Management.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
subscriptionId	path	True	string (uuid)	Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Cuerpo de la solicitud

Nombre	Tipo	Description
properties.hostnames	string[]	Nombres de host de la puerta de enlace del plano de datos a la que se pueden enviar solicitudes.
properties.sourceId	string (arm-id)	Vínculo al área de trabajo del servicio API Management.

Respuestas

Nombre	Tipo	Description
200 OK	ApiManagementGatewayConfigConnectionResource	La conexión de configuración de la puerta de enlace se actualizó correctamente.
201 Created	ApiManagementGatewayConfigConnectionResource	La conexión de configuración de la puerta de enlace se creó correctamente.
Other Status Codes	ErrorResponse	Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

ApiManagementCreateGatewayConfigConnection

Solicitud de ejemplo

HTTP

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

{
  "properties": {
    "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/services/apim-service-1/workspaces/ws-001"
  }
}

Java

/**
 * Samples for ApiGatewayConfigConnection CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/
     * ApiManagementCreateGatewayConfigConnection.json
     */
    /**
     * Sample code: ApiManagementCreateGatewayConfigConnection.
     * 
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementCreateGatewayConfigConnection(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager.apiGatewayConfigConnections().define("gcc-01").withExistingGateway("rg1", "standard-gw-01")
            .withSourceId(
                "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/services/apim-service-1/workspaces/ws-001")
            .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 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_config_connection.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="00000000-0000-0000-0000-000000000000",
    )

    response = client.api_gateway_config_connection.begin_create_or_update(
        resource_group_name="rg1",
        gateway_name="standard-gw-01",
        config_connection_name="gcc-01",
        parameters={
            "properties": {
                "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/services/apim-service-1/workspaces/ws-001"
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementCreateGatewayConfigConnection.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/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e436160e64c0f8d7fb20d662be2712f71f0a7ef5/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementCreateGatewayConfigConnection.json
func ExampleAPIGatewayConfigConnectionClient_BeginCreateOrUpdate() {
	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)
	}
	poller, err := clientFactory.NewAPIGatewayConfigConnectionClient().BeginCreateOrUpdate(ctx, "rg1", "standard-gw-01", "gcc-01", armapimanagement.GatewayConfigConnectionResource{
		Properties: &armapimanagement.GatewayConfigConnectionBaseProperties{
			SourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/services/apim-service-1/workspaces/ws-001"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %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.GatewayConfigConnectionResource = armapimanagement.GatewayConfigConnectionResource{
	// 	Name: to.Ptr("gcc-1"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/gateways/configConnections"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/standard-gw-1/configConnections/gcc-1"),
	// 	Etag: to.Ptr("AAAAAAAWN/4="),
	// 	Properties: &armapimanagement.GatewayConfigConnectionBaseProperties{
	// 		DefaultHostname: to.Ptr("gcc-1-amf2h5hpf7gafbeu.standard-gw-1.gateway.eastus.azure-api.net"),
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		SourceID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/services/apim-service-1/workspaces/ws-001"),
	// 	},
	// }
}

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");
require("dotenv/config");

/**
 * This sample demonstrates how to Creates or updates an API Management gateway config connection. This is long running operation and could take several minutes to complete.
 *
 * @summary Creates or updates an API Management gateway config connection. This is long running operation and could take several minutes to complete.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementCreateGatewayConfigConnection.json
 */
async function apiManagementCreateGatewayConfigConnection() {
  const subscriptionId =
    process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const gatewayName = "standard-gw-01";
  const configConnectionName = "gcc-01";
  const parameters = {
    sourceId:
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/services/apim-service-1/workspaces/ws-001",
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.apiGatewayConfigConnection.beginCreateOrUpdateAndWait(
    resourceGroupName,
    gatewayName,
    configConnectionName,
    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

dotnet

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

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementCreateGatewayConfigConnection.json
// this example is just showing the usage of "ApiGatewayConfigConnection_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 ApiGatewayResource created on azure
// for more information of creating ApiGatewayResource, please refer to the document of ApiGatewayResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "rg1";
string gatewayName = "standard-gw-01";
ResourceIdentifier apiGatewayResourceId = ApiGatewayResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, gatewayName);
ApiGatewayResource apiGateway = client.GetApiGatewayResource(apiGatewayResourceId);

// get the collection of this ApiGatewayConfigConnectionResource
ApiGatewayConfigConnectionCollection collection = apiGateway.GetApiGatewayConfigConnections();

// invoke the operation
string configConnectionName = "gcc-01";
ApiGatewayConfigConnectionData data = new ApiGatewayConfigConnectionData
{
    SourceId = new ResourceIdentifier("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/services/apim-service-1/workspaces/ws-001"),
};
ArmOperation<ApiGatewayConfigConnectionResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, configConnectionName, data);
ApiGatewayConfigConnectionResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
ApiGatewayConfigConnectionData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Respuesta de muestra

status code:

201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/standard-gw-1/configConnections/gcc-1",
  "name": "gcc-1",
  "type": "Microsoft.ApiManagement/gateways/configConnections",
  "etag": "AAAAAAAWN/4=",
  "properties": {
    "provisioningState": "Succeeded",
    "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/services/apim-service-1/workspaces/ws-001",
    "defaultHostname": "gcc-1-amf2h5hpf7gafbeu.standard-gw-1.gateway.eastus.azure-api.net"
  }
}

status code:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/gateways/standard-gw-1/configConnections/gcc-1",
  "name": "gcc-1",
  "type": "Microsoft.ApiManagement/gateways/configConnections",
  "etag": "AAAAAAAWN/4=",
  "properties": {
    "provisioningState": "Succeeded",
    "sourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/services/apim-service-1/workspaces/ws-001",
    "defaultHostname": "gcc-1-amf2h5hpf7gafbeu.standard-gw-1.gateway.eastus.azure-api.net"
  }
}

Definiciones

Nombre	Description
ApiManagementGatewayConfigConnectionResource	Un único recurso de puerta de enlace de API Management en Lista o Obtención de respuesta.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error

ApiManagementGatewayConfigConnectionResource

Object

Un único recurso de puerta de enlace de API Management en Lista o Obtención de respuesta.

Nombre	Tipo	Description
etag	string	ETag del recurso.
id	string	Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nombre del recurso
properties.defaultHostname	string	Nombre de host predeterminado de la puerta de enlace del plano de datos.
properties.hostnames	string[]	Nombres de host de la puerta de enlace del plano de datos a la que se pueden enviar solicitudes.
properties.provisioningState	string	Estado de aprovisionamiento actual de la conexión de configuración de puerta de enlace de API Management
properties.sourceId	string (arm-id)	Vínculo al área de trabajo del servicio API Management.
type	string	Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.