Backend - Update

Service:

API Management

API Version:

2022-08-01

Aktualizace existujícího back-endu.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
backendId	path	True	string	Identifikátor entity Back-end. Musí být v aktuální instanci služby API Management jedinečná.
resourceGroupName	path	True	string	Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.
serviceName	path	True	string	Název služby API Management. Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	ID cílového předplatného.
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
If-Match	True	string	Značka ETag entity. Značka ETag by měla odpovídat aktuálnímu stavu entity z odpovědi hlavičky požadavku GET nebo by měla být * pro bezpodmínečnou aktualizaci.

Text požadavku

Name	Typ	Description
properties.credentials	BackendCredentialsContract	Vlastnosti kontraktu přihlašovacích údajů back-endu
properties.description	string	Popis back-endu.
properties.properties	BackendProperties	Kontrakt vlastností back-endu
properties.protocol	BackendProtocol	Komunikační protokol back-endu.
properties.proxy	BackendProxyContract	Vlastnosti kontraktu back-endové brány
properties.resourceId	string	Identifikátor URI správy prostředku v externím systému. Tato adresa URL může být ID prostředku ARM pro Logic Apps, Function Apps nebo API Apps.
properties.title	string	Název back-endu.
properties.tls	BackendTlsProperties	Vlastnosti protokolu TLS back-endu
properties.url	string	Adresa URL modulu runtime back-endu

Odpovědi

Name	Typ	Description
200 OK	BackendContract	Existující back-end se úspěšně aktualizoval. Headers ETag: string
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

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

Scopes

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

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

Definice

Name	Description
BackendAuthorizationHeaderCredentials	Informace o autorizační hlavičce.
BackendContract	Podrobnosti o back-endu
BackendCredentialsContract	Podrobnosti o přihlašovacích údajích použitých k připojení k back-endu
BackendProperties	Vlastnosti specifické pro typ back-endu.
BackendProtocol	Komunikační protokol back-endu.
BackendProxyContract	Podrobnosti o serveru WebProxy back-endu, který se má použít v požadavku na back-end.
BackendServiceFabricClusterProperties	Vlastnosti back-endu typu Service Fabric.
BackendTlsProperties	Vlastnosti, které řídí ověření certifikátu TLS.
BackendUpdateParameters	Parametry aktualizace back-endu
ErrorFieldContract	Chyba Kontrakt pole.
ErrorResponse	Odpověď na chybu.
X509CertificateName	Vlastnosti serveru X509Names.

BackendAuthorizationHeaderCredentials

Informace o autorizační hlavičce.

Name	Typ	Description
parameter	string	Hodnota parametru ověřování.
scheme	string	Název schématu ověřování.

BackendContract

Podrobnosti o back-endu

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku. Příklad – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Název prostředku
properties.credentials	BackendCredentialsContract	Vlastnosti kontraktu přihlašovacích údajů back-endu
properties.description	string	Popis back-endu.
properties.properties	BackendProperties	Kontrakt vlastností back-endu
properties.protocol	BackendProtocol	Komunikační protokol back-endu.
properties.proxy	BackendProxyContract	Vlastnosti kontraktu back-endové brány
properties.resourceId	string	Identifikátor URI správy prostředku v externím systému. Tato adresa URL může být ID prostředku ARM pro Logic Apps, Function Apps nebo API Apps.
properties.title	string	Název back-endu.
properties.tls	BackendTlsProperties	Vlastnosti protokolu TLS back-endu
properties.url	string	Adresa URL modulu runtime back-endu
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

BackendCredentialsContract

Podrobnosti o přihlašovacích údajích použitých k připojení k back-endu

Name	Typ	Description
authorization	BackendAuthorizationHeaderCredentials	Ověřování autorizační hlavičky
certificate	string[]	Seznam kryptografických otisků klientských certifikátů Pokud jsou k dispozici identifikátory certificatesId, budou ignorovány.
certificateIds	string[]	Seznam ID klientských certifikátů
header	object	Popis parametru záhlaví.
query	object	Popis parametru dotazu

BackendProperties

Vlastnosti specifické pro typ back-endu.

Name	Typ	Description
serviceFabricCluster	BackendServiceFabricClusterProperties	Vlastnosti back-endu clusteru Service Fabric

BackendProtocol

Komunikační protokol back-endu.

Name	Typ	Description
http	string	Back-end je služba RESTful.
soap	string	Back-end je služba SOAP.

BackendProxyContract

Podrobnosti o serveru WebProxy back-endu, který se má použít v požadavku na back-end.

Name	Typ	Description
password	string	Heslo pro připojení k serveru WebProxy
url	string	Vlastnost AbsoluteUri serveru WebProxy, která zahrnuje celý identifikátor URI uložený v instanci URI, včetně všech fragmentů a řetězců dotazů.
username	string	Uživatelské jméno pro připojení k serveru WebProxy

BackendServiceFabricClusterProperties

Vlastnosti back-endu typu Service Fabric.

Name	Typ	Description
clientCertificateId	string	ID klientského certifikátu pro koncový bod správy
clientCertificatethumbprint	string	Kryptografický otisk klientského certifikátu pro koncový bod správy. Pokud jsou k dispozici identifikátory certificatesId, budou ignorovány.
managementEndpoints	string[]	Koncový bod správy clusteru.
maxPartitionResolutionRetries	integer	Maximální počet opakování při pokusu o vyřešení oddílu
serverCertificateThumbprints	string[]	Kryptografické otisky certifikátů, které služba pro správu clusteru používá ke komunikaci tls
serverX509Names	X509CertificateName[]	Kolekce názvů certifikátů serveru X509

BackendTlsProperties

Vlastnosti, které řídí ověření certifikátu TLS.

Name	Typ	Výchozí hodnota	Description
validateCertificateChain	boolean	True	Příznak označující, jestli se má při použití certifikátů podepsaných svým držitelem pro tohoto back-endového hostitele provést ověření řetězu certifikátů SSL.
validateCertificateName	boolean	True	Příznak označující, jestli se má při použití certifikátů podepsaných svým držitelem pro tohoto back-endového hostitele provést ověření názvu certifikátu SSL.

BackendUpdateParameters

Parametry aktualizace back-endu

Name	Typ	Description
properties.credentials	BackendCredentialsContract	Vlastnosti kontraktu přihlašovacích údajů back-endu
properties.description	string	Popis back-endu.
properties.properties	BackendProperties	Kontrakt vlastností back-endu
properties.protocol	BackendProtocol	Komunikační protokol back-endu.
properties.proxy	BackendProxyContract	Vlastnosti kontraktu back-endové brány
properties.resourceId	string	Identifikátor URI správy prostředku v externím systému. Tato adresa URL může být ID prostředku ARM pro Logic Apps, Function Apps nebo API Apps.
properties.title	string	Název back-endu.
properties.tls	BackendTlsProperties	Vlastnosti protokolu TLS back-endu
properties.url	string	Adresa URL modulu runtime back-endu

ErrorFieldContract

Chyba Kontrakt pole.

Name	Typ	Description
code	string	Kód chyby na úrovni vlastnosti.
message	string	Čitelné znázornění chyby na úrovni vlastností.
target	string	Název vlastnosti.

ErrorResponse

Odpověď na chybu.

Name	Typ	Description
error.code	string	Kód chyby definované službou Tento kód slouží jako dílčí stav pro kód chyby HTTP zadaný v odpovědi.
error.details	ErrorFieldContract[]	Seznam neplatných polí se odešle v žádosti v případě chyby ověření.
error.message	string	Znázornění chyby čitelné pro člověka

X509CertificateName

Vlastnosti serveru X509Names.

Name	Typ	Description
issuerCertificateThumbprint	string	Kryptografický otisk vystavitele certifikátu.
name	string	Běžný název certifikátu.