Backend - Update

Service:

API Management

API Version:

2022-08-01

Atualizações um back-end existente.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
backendId	path	True	string	Identificador da entidade back-end. Tem de ser exclusivo na instância de serviço do Gestão de API atual.
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
serviceName	path	True	string	O nome do serviço Gestão de API. Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	O ID da subscrição de destino.
api-version	query	True	string	A versão da API a utilizar para esta operação.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
If-Match	True	string	ETag da Entidade. A ETag deve corresponder ao estado da entidade atual da resposta de cabeçalho do pedido GET ou deve ser * para atualização incondicional.

Corpo do Pedido

Name	Tipo	Description
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 Gestão do Recurso no Sistema Externo. Este URL pode ser o ID de Recurso do Arm do Logic Apps, das Aplicações de Funções ou das API Apps.
properties.title	string	Título do back-end.
properties.tls	BackendTlsProperties	Propriedades do TLS de back-end
properties.url	string	Url de runtime do Back-end.

Respostas

Name	Tipo	Description
200 OK	BackendContract	O back-end existente foi atualizado com êxito. Headers ETag: string
Other Status Codes	ErrorResponse	Resposta de erro que descreve o motivo pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

ApiManagementUpdateBackend

Sample Request

HTTP

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


{
  "properties": {
    "description": "description5308",
    "tls": {
      "validateCertificateChain": false,
      "validateCertificateName": true
    }
  }
}

Java

import com.azure.resourcemanager.apimanagement.models.BackendContract;
import com.azure.resourcemanager.apimanagement.models.BackendTlsProperties;

/** Samples for Backend Update. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateBackend.json
     */
    /**
     * Sample code: ApiManagementUpdateBackend.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementUpdateBackend(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        BackendContract resource =
            manager
                .backends()
                .getWithResponse("rg1", "apimService1", "proxybackend", com.azure.core.util.Context.NONE)
                .getValue();
        resource
            .update()
            .withDescription("description5308")
            .withTls(new BackendTlsProperties().withValidateCertificateChain(false).withValidateCertificateName(true))
            .withIfMatch("*")
            .apply();
    }
}

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 typing import Any, IO, Union

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_update_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.update(
        resource_group_name="rg1",
        service_name="apimService1",
        backend_id="proxybackend",
        if_match="*",
        parameters={
            "properties": {
                "description": "description5308",
                "tls": {"validateCertificateChain": False, "validateCertificateName": True},
            }
        },
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateBackend.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/ApiManagementUpdateBackend.json
func ExampleBackendClient_Update() {
	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().Update(ctx, "rg1", "apimService1", "proxybackend", "*", armapimanagement.BackendUpdateParameters{
		Properties: &armapimanagement.BackendUpdateParameterProperties{
			Description: to.Ptr("description5308"),
			TLS: &armapimanagement.BackendTLSProperties{
				ValidateCertificateChain: to.Ptr(false),
				ValidateCertificateName:  to.Ptr(true),
			},
		},
	}, 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("proxybackend"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service/backends"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/proxybackend"),
	// 	Properties: &armapimanagement.BackendContractProperties{
	// 		Description: to.Ptr("description5308"),
	// 		Credentials: &armapimanagement.BackendCredentialsContract{
	// 			Authorization: &armapimanagement.BackendAuthorizationHeaderCredentials{
	// 				Parameter: to.Ptr("opensesma"),
	// 				Scheme: to.Ptr("Basic"),
	// 			},
	// 			Header: map[string][]*string{
	// 				"x-my-1": []*string{
	// 					to.Ptr("val1"),
	// 					to.Ptr("val2")},
	// 				},
	// 				Query: map[string][]*string{
	// 					"sv": []*string{
	// 						to.Ptr("xx"),
	// 						to.Ptr("bb"),
	// 						to.Ptr("cc")},
	// 					},
	// 				},
	// 				Proxy: &armapimanagement.BackendProxyContract{
	// 					Password: to.Ptr("<password>"),
	// 					URL: to.Ptr("http://192.168.1.1:8080"),
	// 					Username: to.Ptr("Contoso\\admin"),
	// 				},
	// 				TLS: &armapimanagement.BackendTLSProperties{
	// 					ValidateCertificateChain: to.Ptr(false),
	// 					ValidateCertificateName: to.Ptr(true),
	// 				},
	// 				URL: to.Ptr("https://backendname2644/"),
	// 				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 Updates an existing backend.
 *
 * @summary Updates an existing backend.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateBackend.json
 */
async function apiManagementUpdateBackend() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const backendId = "proxybackend";
  const ifMatch = "*";
  const parameters = {
    description: "description5308",
    tls: { validateCertificateChain: false, validateCertificateName: true },
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.backend.update(
    resourceGroupName,
    serviceName,
    backendId,
    ifMatch,
    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

Sample Response

Status code:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/proxybackend",
  "type": "Microsoft.ApiManagement/service/backends",
  "name": "proxybackend",
  "properties": {
    "description": "description5308",
    "url": "https://backendname2644/",
    "protocol": "http",
    "credentials": {
      "query": {
        "sv": [
          "xx",
          "bb",
          "cc"
        ]
      },
      "header": {
        "x-my-1": [
          "val1",
          "val2"
        ]
      },
      "authorization": {
        "scheme": "Basic",
        "parameter": "opensesma"
      }
    },
    "proxy": {
      "url": "http://192.168.1.1:8080",
      "username": "Contoso\\admin",
      "password": "<password>"
    },
    "tls": {
      "validateCertificateChain": false,
      "validateCertificateName": true
    }
  }
}

Definições

Name	Description
BackendAuthorizationHeaderCredentials	Informações do cabeçalho de autorização.
BackendContract	Detalhes do back-end.
BackendCredentialsContract	Detalhes das Credenciais utilizadas para ligar ao Back-end.
BackendProperties	Propriedades específicas do Tipo de Back-end.
BackendProtocol	Protocolo de comunicação de back-end.
BackendProxyContract	Detalhes do Servidor WebProxy de Back-end a utilizar no Pedido de Back-end.
BackendServiceFabricClusterProperties	Propriedades do Back-end do Tipo do Service Fabric.
BackendTlsProperties	Propriedades que controlam a Validação do Certificado TLS.
BackendUpdateParameters	Parâmetros de atualização de back-end.
ErrorFieldContract	Contrato de Campo de Erro.
ErrorResponse	Resposta do Erro.
X509CertificateName	Propriedades do servidor X509Names.

BackendAuthorizationHeaderCredentials

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

Name	Tipo	Description
parameter	string	Valor do Parâmetro de Autenticação.
scheme	string	Nome do Esquema de Autenticação.

BackendContract

Detalhes do back-end.

Name	Tipo	Description
id	string	ID de recurso completamente qualificado 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 Gestão do Recurso no Sistema Externo. Este URL pode ser o ID de Recurso do Arm do Logic Apps, das Aplicações de Funções ou das API Apps.
properties.title	string	Título do back-end.
properties.tls	BackendTlsProperties	Propriedades do TLS de back-end
properties.url	string	Url de runtime do Back-end.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

BackendCredentialsContract

Detalhes das Credenciais utilizadas para ligar ao Back-end.

Name	Tipo	Description
authorization	BackendAuthorizationHeaderCredentials	Autenticação do cabeçalho de autorização
certificate	string[]	Lista de Thumbprints do Certificado de Cliente. Será ignorado se forem fornecidos certificatesIds.
certificateIds	string[]	Lista de IDs de Certificado de Cliente.
header	object	Descrição do Parâmetro de Cabeçalho.
query	object	Descrição do Parâmetro de Consulta.

BackendProperties

Propriedades específicas do Tipo de Back-end.

Name	Tipo	Description
serviceFabricCluster	BackendServiceFabricClusterProperties	Propriedades do Cluster do Service Fabric de Back-end

BackendProtocol

Protocolo de comunicação de back-end.

Name	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 utilizar no Pedido de Back-end.

Name	Tipo	Description
password	string	Palavra-passe para ligar ao Servidor WebProxy
url	string	Propriedade AbsoluteUri do Servidor WebProxy, que inclui todo o URI armazenado na instância do Uri, incluindo todos os fragmentos e cadeias de consulta.
username	string	Nome de utilizador para ligar ao servidor WebProxy

BackendServiceFabricClusterProperties

Propriedades do Back-end do Tipo do Service Fabric.

Name	Tipo	Description
clientCertificateId	string	O ID do certificado de cliente do ponto final de gestão.
clientCertificatethumbprint	string	O thumbprint do certificado de cliente para o ponto final de gestão. Será ignorado se forem fornecidos certificatesIds
managementEndpoints	string[]	O ponto final de gestão do cluster.
maxPartitionResolutionRetries	integer	Número máximo de tentativas ao tentar resolver a partição.
serverCertificateThumbprints	string[]	Thumbprints of certificates cluster management service uses for tls communication (Thumbprints of certificates cluster management service uses for tls communication)
serverX509Names	X509CertificateName[]	Coleção de Nomes de Certificados X509 do Servidor

BackendTlsProperties

Propriedades que controlam a Validação do Certificado TLS.

Name	Tipo	Valor Predefinido	Description
validateCertificateChain	boolean	True	Sinalizador que indica se a validação da cadeia de certificados SSL deve ser feita ao utilizar certificados autoassinados para este anfitrião de back-end.
validateCertificateName	boolean	True	Sinalizador que indica se a validação do nome do certificado SSL deve ser feita ao utilizar certificados autoassinados para este anfitrião de back-end.

BackendUpdateParameters

Parâmetros de atualização de back-end.

Name	Tipo	Description
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 Gestão do Recurso no Sistema Externo. Este URL pode ser o ID de Recurso do Arm do Logic Apps, das Aplicações de Funções ou das API Apps.
properties.title	string	Título do back-end.
properties.tls	BackendTlsProperties	Propriedades do TLS de back-end
properties.url	string	Url de runtime do Back-end.

ErrorFieldContract

Contrato de Campo de Erro.

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

ErrorResponse

Resposta do Erro.

Name	Tipo	Description
error.code	string	Código de erro definido pelo serviço. Este código serve como um subestado para o código de erro HTTP especificado na resposta.
error.details	ErrorFieldContract[]	A lista de campos inválidos enviados no pedido, em caso de erro de validação.
error.message	string	Representação legível por humanos do erro.

X509CertificateName

Propriedades do servidor X509Names.

Name	Tipo	Description
issuerCertificateThumbprint	string	Thumbprint para o Emissor do Certificado.
name	string	Nome Comum do Certificado.