Backend - Update

Service:

API Management

API Version:

2022-08-01

Updates ein vorhandenes Back-End.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
backendId	path	True	string	Bezeichner der Back-End-Entität. Muss im aktuellen API Management Dienst instance eindeutig sein.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
serviceName	path	True	string	Der Name des API Management-Diensts. Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	Hierbei handelt es sich um die ID des Zielabonnements.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
If-Match	True	string	ETag der Entität. ETag sollte mit dem aktuellen Entitätsstatus aus der Headerantwort der GET-Anforderung übereinstimmen, oder es sollte * für bedingungslose Aktualisierung sein.

Anforderungstext

Name	Typ	Beschreibung
properties.credentials	BackendCredentialsContract	Vertragseigenschaften für Back-End-Anmeldeinformationen
properties.description	string	Back-End-Beschreibung.
properties.properties	BackendProperties	Back-End-Eigenschaften-Vertrag
properties.protocol	BackendProtocol	Back-End-Kommunikationsprotokoll.
properties.proxy	BackendProxyContract	Vertragseigenschaften des Back-End-Gateways
properties.resourceId	string	Verwaltungs-URI der Ressource im externen System. Diese URL kann die Arm-Ressourcen-ID von Logik-Apps, Funktions-Apps oder API-Apps sein.
properties.title	string	Back-End-Titel.
properties.tls	BackendTlsProperties	Back-End-TLS-Eigenschaften
properties.url	string	Laufzeit-URL des Back-Ends.

Antworten

Name	Typ	Beschreibung
200 OK	BackendContract	Das vorhandene Back-End wurde erfolgreich aktualisiert. Headers ETag: string
Other Status Codes	ErrorResponse	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

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

Definitionen

Name	Beschreibung
BackendAuthorizationHeaderCredentials	Informationen zum Autorisierungsheader.
BackendContract	Back-End-Details.
BackendCredentialsContract	Details zu den Anmeldeinformationen, die zum Herstellen einer Verbindung mit dem Back-End verwendet werden.
BackendProperties	Eigenschaften, die für den Back-End-Typ spezifisch sind.
BackendProtocol	Back-End-Kommunikationsprotokoll.
BackendProxyContract	Details zum Back-End-WebProxy-Server, der in der Anforderung an das Back-End verwendet werden soll.
BackendServiceFabricClusterProperties	Eigenschaften des Service Fabric-Typ-Back-Ends.
BackendTlsProperties	Eigenschaften, die die TLS-Zertifikatüberprüfung steuern.
BackendUpdateParameters	Back-End-Updateparameter.
ErrorFieldContract	Fehlerfeldvertrag.
ErrorResponse	Fehlerantwort.
X509CertificateName	Eigenschaften von Server X509Names.

BackendAuthorizationHeaderCredentials

Informationen zum Autorisierungsheader.

Name	Typ	Beschreibung
parameter	string	Authentifizierungsparameterwert.
scheme	string	Name des Authentifizierungsschemas.

BackendContract

Back-End-Details.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Der Name der Ressource
properties.credentials	BackendCredentialsContract	Vertragseigenschaften für Back-End-Anmeldeinformationen
properties.description	string	Back-End-Beschreibung.
properties.properties	BackendProperties	Back-End-Eigenschaften-Vertrag
properties.protocol	BackendProtocol	Back-End-Kommunikationsprotokoll.
properties.proxy	BackendProxyContract	Vertragseigenschaften des Back-End-Gateways
properties.resourceId	string	Verwaltungs-URI der Ressource im externen System. Diese URL kann die Arm-Ressourcen-ID von Logik-Apps, Funktions-Apps oder API-Apps sein.
properties.title	string	Back-End-Titel.
properties.tls	BackendTlsProperties	Back-End-TLS-Eigenschaften
properties.url	string	Laufzeit-URL des Back-Ends.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

BackendCredentialsContract

Details zu den Anmeldeinformationen, die zum Herstellen einer Verbindung mit dem Back-End verwendet werden.

Name	Typ	Beschreibung
authorization	BackendAuthorizationHeaderCredentials	Authentifizierung des Autorisierungsheaders
certificate	string[]	Liste der Clientzertifikatfingerabdrücke. Wird ignoriert, wenn certificatesIds angegeben werden.
certificateIds	string[]	Liste der Clientzertifikat-IDs.
header	object	Beschreibung des Headerparameters.
query	object	Beschreibung des Abfrageparameters.

BackendProperties

Eigenschaften, die für den Back-End-Typ spezifisch sind.

Name	Typ	Beschreibung
serviceFabricCluster	BackendServiceFabricClusterProperties	Back-End Service Fabric-Clustereigenschaften

BackendProtocol

Back-End-Kommunikationsprotokoll.

Name	Typ	Beschreibung
http	string	Das Back-End ist ein RESTful-Dienst.
soap	string	Das Back-End ist ein SOAP-Dienst.

BackendProxyContract

Details zum Back-End-WebProxy-Server, der in der Anforderung an das Back-End verwendet werden soll.

Name	Typ	Beschreibung
password	string	Kennwort zum Herstellen einer Verbindung mit dem WebProxy-Server
url	string	WebProxy Server AbsoluteUri-Eigenschaft, die den gesamten URI enthält, der im Uri instance gespeichert ist, einschließlich aller Fragmente und Abfragezeichenfolgen.
username	string	Benutzername zum Herstellen einer Verbindung mit dem WebProxy-Server

BackendServiceFabricClusterProperties

Eigenschaften des Service Fabric-Typ-Back-Ends.

Name	Typ	Beschreibung
clientCertificateId	string	Die Clientzertifikat-ID für den Verwaltungsendpunkt.
clientCertificatethumbprint	string	Der Clientzertifikatfingerabdruck für den Verwaltungsendpunkt. Wird ignoriert, wenn certificatesIds angegeben werden.
managementEndpoints	string[]	Der Clusterverwaltungsendpunkt.
maxPartitionResolutionRetries	integer	Maximale Anzahl von Wiederholungsversuchen beim Auflösen der Partition.
serverCertificateThumbprints	string[]	Fingerabdrucke von Zertifikaten, die der Clusterverwaltungsdienst für die TLS-Kommunikation verwendet
serverX509Names	X509CertificateName[]	Server X509-Zertifikatnamensammlung

BackendTlsProperties

Eigenschaften, die die TLS-Zertifikatüberprüfung steuern.

Name	Typ	Standardwert	Beschreibung
validateCertificateChain	boolean	True	Flag, das angibt, ob die SSL-Zertifikatkettenüberprüfung durchgeführt werden soll, wenn selbstsignierte Zertifikate für diesen Back-End-Host verwendet werden.
validateCertificateName	boolean	True	Flag, das angibt, ob die SSL-Zertifikatnamenüberprüfung durchgeführt werden soll, wenn selbstsignierte Zertifikate für diesen Back-End-Host verwendet werden sollen.

BackendUpdateParameters

Back-End-Updateparameter.

Name	Typ	Beschreibung
properties.credentials	BackendCredentialsContract	Vertragseigenschaften für Back-End-Anmeldeinformationen
properties.description	string	Back-End-Beschreibung.
properties.properties	BackendProperties	Back-End-Eigenschaften-Vertrag
properties.protocol	BackendProtocol	Back-End-Kommunikationsprotokoll.
properties.proxy	BackendProxyContract	Vertragseigenschaften des Back-End-Gateways
properties.resourceId	string	Verwaltungs-URI der Ressource im externen System. Diese URL kann die Arm-Ressourcen-ID von Logik-Apps, Funktions-Apps oder API-Apps sein.
properties.title	string	Back-End-Titel.
properties.tls	BackendTlsProperties	Back-End-TLS-Eigenschaften
properties.url	string	Laufzeit-URL des Back-Ends.

ErrorFieldContract

Fehlerfeldvertrag.

Name	Typ	Beschreibung
code	string	Fehlercode auf Eigenschaftsebene.
message	string	Für Menschen lesbare Darstellung eines Fehlers auf Eigenschaftsebene.
target	string	Der Eigenschaftsname.

ErrorResponse

Fehlerantwort.

Name	Typ	Beschreibung
error.code	string	Der vom Dienst definierte Fehlercode. Dieser Code dient als Unterstatus für den in der Antwort angegebenen HTTP-Fehlercode.
error.details	ErrorFieldContract[]	Die Liste der ungültigen Felder, die im Falle eines Überprüfungsfehlers gesendet werden.
error.message	string	Lesbare Darstellung des Fehlers.

X509CertificateName

Eigenschaften von Server X509Names.

Name	Typ	Beschreibung
issuerCertificateThumbprint	string	Fingerabdruck für den Aussteller des Zertifikats.
name	string	Allgemeiner Name des Zertifikats.