Backend - Get

Serviço:

API Management

Versão da API:

2022-08-01

Obtém os detalhes do back-end especificado por seu 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 URI

Nome	Em	Obrigatório	Tipo	Description
backendId	path	True	string	Identificador da entidade Back-end. Deve ser exclusivo na instância de serviço Gerenciamento de API atual.
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
serviceName	path	True	string	O nome do serviço Gerenciamento de API. Padrão Regex: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	A ID da assinatura de destino.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Respostas

Nome	Tipo	Description
200 OK	BackendContract	O corpo da resposta contém a entidade back-end especificada. Cabeçalhos ETag: string
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

ApiManagementGetBackend

Solicitação de exemplo

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

Resposta de exemplo

Código de status:

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

Definições

Nome	Description
BackendAuthorizationHeaderCredentials	Informações de cabeçalho de autorização.
BackendContract	Detalhes do back-end.
BackendCredentialsContract	Detalhes das Credenciais usadas para se conectar ao Back-end.
BackendProperties	Propriedades específicas para o Tipo de Back-end.
BackendProtocol	Protocolo de comunicação de back-end.
BackendProxyContract	Detalhes do Servidor WebProxy de Back-end a ser usado na Solicitação para Back-end.
BackendServiceFabricClusterProperties	Propriedades do back-end de tipo do Service Fabric.
BackendTlsProperties	Propriedades que controlam a validação do certificado TLS.
ErrorFieldContract	Contrato de campo de erro.
ErrorResponse	Resposta de erro.
X509CertificateName	Propriedades do servidor X509Names.

BackendAuthorizationHeaderCredentials

Informações de cabeçalho de autorização.

Nome	Tipo	Description
parameter	string	Valor do parâmetro de autenticação.
scheme	string	Nome do esquema de autenticação.

BackendContract

Detalhes do back-end.

Nome	Tipo	Description
id	string	ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O nome do recurso
properties.credentials	BackendCredentialsContract	Propriedades do contrato de credenciais de back-end
properties.description	string	Descrição do back-end.
properties.properties	BackendProperties	Contrato de propriedades de back-end
properties.protocol	BackendProtocol	Protocolo de comunicação de back-end.
properties.proxy	BackendProxyContract	Propriedades do contrato do gateway de back-end
properties.resourceId	string	Uri de gerenciamento do recurso no sistema externo. Essa URL pode ser a ID de Recurso arm de Aplicativos Lógicos, Aplicativos de Funções ou Aplicativos de API.
properties.title	string	Título de back-end.
properties.tls	BackendTlsProperties	Propriedades do TLS de back-end
properties.url	string	Url de runtime do back-end.
type	string	Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

BackendCredentialsContract

Detalhes das Credenciais usadas para se conectar ao Back-end.

Nome	Tipo	Description
authorization	BackendAuthorizationHeaderCredentials	Autenticação de cabeçalho de autorização
certificate	string[]	Lista de impressões digitais do certificado do cliente. Serão ignorados se certificatesIds forem fornecidos.
certificateIds	string[]	Lista de IDs de certificado do cliente.
header	object	Descrição do parâmetro de cabeçalho.
query	object	Descrição do parâmetro de consulta.

BackendProperties

Propriedades específicas para o Tipo de Back-end.

Nome	Tipo	Description
serviceFabricCluster	BackendServiceFabricClusterProperties	Propriedades do cluster do Service Fabric de back-end

BackendProtocol

Protocolo de comunicação de back-end.

Nome	Tipo	Description
http	string	O back-end é um serviço RESTful.
soap	string	O back-end é um serviço SOAP.

BackendProxyContract

Detalhes do Servidor WebProxy de Back-end a ser usado na Solicitação para Back-end.

Nome	Tipo	Description
password	string	Senha para se conectar ao Servidor WebProxy
url	string	Propriedade AbsoluteUri do Servidor WebProxy, que inclui todo o URI armazenado na instância de Uri, incluindo todos os fragmentos e cadeias de caracteres de consulta.
username	string	Nome de usuário para se conectar ao servidor WebProxy

BackendServiceFabricClusterProperties

Propriedades do back-end de tipo do Service Fabric.

Nome	Tipo	Description
clientCertificateId	string	A ID do certificado do cliente para o ponto de extremidade de gerenciamento.
clientCertificatethumbprint	string	A impressão digital do certificado do cliente para o ponto de extremidade de gerenciamento. Serão ignorados se certificatesIds forem fornecidos
managementEndpoints	string[]	O ponto de extremidade de gerenciamento de cluster.
maxPartitionResolutionRetries	integer	Número máximo de repetições ao tentar resolve a partição.
serverCertificateThumbprints	string[]	Impressões digitais dos certificados que o serviço de gerenciamento de cluster usa para comunicação tls
serverX509Names	X509CertificateName[]	Coleção De Nomes de Certificado X509 do Servidor

BackendTlsProperties

Propriedades que controlam a validação do certificado TLS.

Nome	Tipo	Valor padrão	Description
validateCertificateChain	boolean	True	Sinalizador que indica se a validação da cadeia de certificados SSL deve ser feita ao usar certificados autoassinados para esse host de back-end.
validateCertificateName	boolean	True	Sinalizador que indica se a validação do nome do certificado SSL deve ser feita ao usar certificados autoassinados para esse host de back-end.

ErrorFieldContract

Contrato de campo de erro.

Nome	Tipo	Description
code	string	Código de erro no nível da propriedade.
message	string	Representação legível por humanos do erro no nível da propriedade.
target	string	Nome da propriedade.

ErrorResponse

Resposta de erro.

Nome	Tipo	Description
error.code	string	Código de erro definido pelo serviço. Esse código atua como um substatus do código de erro HTTP especificado na resposta.
error.details	ErrorFieldContract[]	A lista de campos inválidos enviados na solicitação, em caso de erro de validação.
error.message	string	Representação legível ao olho humano do erro.

X509CertificateName

Propriedades do servidor X509Names.

Nome	Tipo	Description
issuerCertificateThumbprint	string	Impressão digital para o emissor do certificado.
name	string	Nome Comum do Certificado.