Backend - Get

Servicio:

API Management

Versión de la API:

2022-08-01

Obtiene los detalles del back-end especificado por su identificador.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends/{backendId}?api-version=2022-08-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
backendId	path	True	string	Identificador de la entidad back-end. Debe ser único en la instancia de servicio de API Management actual.
resourceGroupName	path	True	string	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
serviceName	path	True	string	Nombre del servicio API Management. Patrón de Regex: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	Identificador de la suscripción de destino.
api-version	query	True	string	Versión de API que se usará para la operación.

Respuestas

Nombre	Tipo	Description
200 OK	BackendContract	El cuerpo de la respuesta contiene la entidad back-end especificada. Encabezados ETag: string
Other Status Codes	ErrorResponse	Respuesta de error que describe el motivo del error de 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	suplantación de su cuenta de usuario

Ejemplos

ApiManagementGetBackend

Solicitud de ejemplo

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/sfbackend?api-version=2022-08-01

Java

/** Samples for Backend Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGetBackend.json
     */
    /**
     * Sample code: ApiManagementGetBackend.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementGetBackend(com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager.backends().getWithResponse("rg1", "apimService1", "sfbackend", 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_backend.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.backend.get(
        resource_group_name="rg1",
        service_name="apimService1",
        backend_id="sfbackend",
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGetBackend.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/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/ApiManagementGetBackend.json
func ExampleBackendClient_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.NewBackendClient().Get(ctx, "rg1", "apimService1", "sfbackend", 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.BackendContract = armapimanagement.BackendContract{
	// 	Name: to.Ptr("sfbackend"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service/backends"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/sfbackend"),
	// 	Properties: &armapimanagement.BackendContractProperties{
	// 		Description: to.Ptr("Service Fabric Test App 1"),
	// 		Properties: &armapimanagement.BackendProperties{
	// 			ServiceFabricCluster: &armapimanagement.BackendServiceFabricClusterProperties{
	// 				ClientCertificateID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1"),
	// 				ManagementEndpoints: []*string{
	// 					to.Ptr("https://somecluster.com")},
	// 					MaxPartitionResolutionRetries: to.Ptr[int32](5),
	// 					ServerX509Names: []*armapimanagement.X509CertificateName{
	// 						{
	// 							Name: to.Ptr("ServerCommonName1"),
	// 							IssuerCertificateThumbprint: to.Ptr("IssuerCertificateThumbprint1"),
	// 					}},
	// 				},
	// 			},
	// 			URL: to.Ptr("fabric:/mytestapp/mytestservice"),
	// 			Protocol: to.Ptr(armapimanagement.BackendProtocolHTTP),
	// 		},
	// 	}
}

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 Gets the details of the backend specified by its identifier.
 *
 * @summary Gets the details of the backend specified by its identifier.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGetBackend.json
 */
async function apiManagementGetBackend() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const backendId = "sfbackend";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.backend.get(resourceGroupName, serviceName, backendId);
  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/ApiManagementGetBackend.json
// this example is just showing the usage of "Backend_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 ApiManagementServiceResource created on azure
// for more information of creating ApiManagementServiceResource, please refer to the document of ApiManagementServiceResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
ResourceIdentifier apiManagementServiceResourceId = ApiManagementServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName);
ApiManagementServiceResource apiManagementService = client.GetApiManagementServiceResource(apiManagementServiceResourceId);

// get the collection of this ApiManagementBackendResource
ApiManagementBackendCollection collection = apiManagementService.GetApiManagementBackends();

// invoke the operation
string backendId = "sfbackend";
NullableResponse<ApiManagementBackendResource> response = await collection.GetIfExistsAsync(backendId);
ApiManagementBackendResource 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
    ApiManagementBackendData 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:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/sfbackend",
  "type": "Microsoft.ApiManagement/service/backends",
  "name": "sfbackend",
  "properties": {
    "description": "Service Fabric Test App 1",
    "url": "fabric:/mytestapp/mytestservice",
    "protocol": "http",
    "properties": {
      "serviceFabricCluster": {
        "managementEndpoints": [
          "https://somecluster.com"
        ],
        "clientCertificateId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1",
        "serverX509Names": [
          {
            "name": "ServerCommonName1",
            "issuerCertificateThumbprint": "IssuerCertificateThumbprint1"
          }
        ],
        "maxPartitionResolutionRetries": 5
      }
    }
  }
}

Definiciones

Nombre	Description
BackendAuthorizationHeaderCredentials	Información del encabezado de autorización.
BackendContract	Detalles del back-end.
BackendCredentialsContract	Detalles de las credenciales usadas para conectarse al back-end.
BackendProperties	Propiedades específicas del tipo de back-end.
BackendProtocol	Protocolo de comunicación de back-end.
BackendProxyContract	Detalles del servidor WebProxy de back-end que se va a usar en la solicitud al back-end.
BackendServiceFabricClusterProperties	Propiedades del back-end de tipo de Service Fabric.
BackendTlsProperties	Propiedades que controlan la validación de certificados TLS.
ErrorFieldContract	Contrato de campo de error.
ErrorResponse	Respuesta de error.
X509CertificateName	Propiedades del servidor X509Names.

BackendAuthorizationHeaderCredentials

Información del encabezado de autorización.

Nombre	Tipo	Description
parameter	string	Valor del parámetro de autenticación.
scheme	string	Nombre del esquema de autenticación.

BackendContract

Detalles del back-end.

Nombre	Tipo	Description
id	string	Identificador de recurso completo del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nombre del recurso.
properties.credentials	BackendCredentialsContract	Propiedades del contrato de credenciales de back-end
properties.description	string	Descripción del back-end.
properties.properties	BackendProperties	Contrato de propiedades de back-end
properties.protocol	BackendProtocol	Protocolo de comunicación de back-end.
properties.proxy	BackendProxyContract	Propiedades del contrato de puerta de enlace de back-end
properties.resourceId	string	URI de administración del recurso en sistema externo. Esta dirección URL puede ser el identificador de recurso arm de Logic Apps, Function Apps o API Apps.
properties.title	string	Título del back-end.
properties.tls	BackendTlsProperties	Propiedades de TLS de back-end
properties.url	string	Dirección URL del entorno de ejecución del back-end.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

BackendCredentialsContract

Detalles de las credenciales usadas para conectarse al back-end.

Nombre	Tipo	Description
authorization	BackendAuthorizationHeaderCredentials	Autenticación del encabezado de autorización
certificate	string[]	Lista de huellas digitales de certificado de cliente. Se omitirá si se proporcionan certificatesIds.
certificateIds	string[]	Lista de identificadores de certificado de cliente.
header	object	Descripción del parámetro de encabezado.
query	object	Descripción del parámetro de consulta.

BackendProperties

Propiedades específicas del tipo de back-end.

Nombre	Tipo	Description
serviceFabricCluster	BackendServiceFabricClusterProperties	Propiedades del clúster de Service Fabric de back-end

BackendProtocol

Protocolo de comunicación de back-end.

Nombre	Tipo	Description
http	string	El back-end es un servicio RESTful.
soap	string	El back-end es un servicio SOAP.

BackendProxyContract

Detalles del servidor WebProxy de back-end que se va a usar en la solicitud al back-end.

Nombre	Tipo	Description
password	string	Contraseña para conectarse al servidor WebProxy
url	string	Propiedad AbsoluteUri del servidor WebProxy que incluye todo el URI almacenado en la instancia de Uri, incluidos todos los fragmentos y cadenas de consulta.
username	string	Nombre de usuario para conectarse al servidor WebProxy

BackendServiceFabricClusterProperties

Propiedades del back-end de tipo de Service Fabric.

Nombre	Tipo	Description
clientCertificateId	string	Identificador de certificado de cliente para el punto de conexión de administración.
clientCertificatethumbprint	string	Huella digital del certificado de cliente para el punto de conexión de administración. Se omitirá si se proporcionan certificatesIds.
managementEndpoints	string[]	Punto de conexión de administración del clúster.
maxPartitionResolutionRetries	integer	Número máximo de reintentos al intentar resolver la partición.
serverCertificateThumbprints	string[]	Huellas digitales del servicio de administración de clústeres de certificados usa para la comunicación tls
serverX509Names	X509CertificateName[]	Colección Server X509 Certificate Names

BackendTlsProperties

Propiedades que controlan la validación de certificados TLS.

Nombre	Tipo	Valor predeterminado	Description
validateCertificateChain	boolean	True	Marca que indica si se debe realizar la validación de la cadena de certificados SSL al usar certificados autofirmados para este host de back-end.
validateCertificateName	boolean	True	Marca que indica si se debe realizar la validación del nombre del certificado SSL al usar certificados autofirmados para este host de back-end.

ErrorFieldContract

Contrato de campo de error.

Nombre	Tipo	Description
code	string	Código de error de nivel de propiedad.
message	string	Representación legible del error de nivel de propiedad.
target	string	Nombre de propiedad.

ErrorResponse

Respuesta de error.

Nombre	Tipo	Description
error.code	string	Código del error definido por el servicio. Este código funciona como estado secundario del código de error HTTP especificado en la respuesta.
error.details	ErrorFieldContract[]	La lista de campos no válidos que se envían en la solicitud, en caso de error de validación.
error.message	string	Representación legible del error.

X509CertificateName

Propiedades del servidor X509Names.

Nombre	Tipo	Description
issuerCertificateThumbprint	string	Huella digital del emisor del certificado.
name	string	Nombre común del certificado.