Api Gateway Config Connection - Get

Service:

API Management

Version d'API:

2024-05-01

Obtient une description de la ressource de connexion de la passerelle Gestion des API.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
configConnectionName	path	True	string minLength: 1 maxLength: 30 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nom de la connexion de configuration de la passerelle Gestion des API.
gatewayName	path	True	string minLength: 1 maxLength: 45 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nom de la passerelle Gestion des API.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	ApiManagementGatewayConfigConnectionResource	La ressource de connexion de la passerelle Gestion des API a réussi.
Other Status Codes	ErrorResponse	Réponse d’erreur décrivant pourquoi l’opération a échoué.

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

ApiManagementGetGatewayConfigConnection

Exemple de requête

HTTP

GET 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

Java

/**
 * Samples for ApiGatewayConfigConnection Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/
     * ApiManagementGetGatewayConfigConnection.json
     */
    /**
     * Sample code: ApiManagementGetGatewayConfigConnection.
     * 
     * @param manager Entry point to ApiManagementManager.
     */
    public static void
        apiManagementGetGatewayConfigConnection(com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager.apiGatewayConfigConnections().getWithResponse("rg1", "standard-gw-01", "gcc-01",
            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_get_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.get(
        resource_group_name="rg1",
        gateway_name="standard-gw-01",
        config_connection_name="gcc-01",
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementGetGatewayConfigConnection.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/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/ApiManagementGetGatewayConfigConnection.json
func ExampleAPIGatewayConfigConnectionClient_Get() {
	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.NewAPIGatewayConfigConnectionClient().Get(ctx, "rg1", "standard-gw-01", "gcc-01", 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.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 Gets an API Management gateway config connection resource description.
 *
 * @summary Gets an API Management gateway config connection resource description.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementGetGatewayConfigConnection.json
 */
async function apiManagementGetGatewayConfigConnection() {
  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 credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.apiGatewayConfigConnection.get(
    resourceGroupName,
    gatewayName,
    configConnectionName,
  );
  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/ApiManagementGetGatewayConfigConnection.json
// this example is just showing the usage of "ApiGatewayConfigConnection_Get" 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";
NullableResponse<ApiGatewayConfigConnectionResource> response = await collection.GetIfExistsAsync(configConnectionName);
ApiGatewayConfigConnectionResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine("Succeeded with null as result");
}
else
{
    // 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

Exemple de réponse

Code d’état:

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

Définitions

Nom	Description
ApiManagementGatewayConfigConnectionResource	Ressource de passerelle Gestion des API unique dans Liste ou Obtenir une réponse.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur

ApiManagementGatewayConfigConnectionResource

Object

Ressource de passerelle Gestion des API unique dans Liste ou Obtenir une réponse.

Nom	Type	Description
etag	string	ETag de la ressource.
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.defaultHostname	string	Nom d’hôte par défaut de la passerelle de plan de données.
properties.hostnames	string[]	Noms d’hôte de la passerelle de plan de données vers laquelle les requêtes peuvent être envoyées.
properties.provisioningState	string	État d’approvisionnement actuel de la connexion de configuration de la passerelle Gestion des API
properties.sourceId	string (arm-id)	Lien vers l’espace de travail du service Gestion des API.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

ErrorAdditionalInfo

Object

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Object

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Object

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.