Backend - Update

Referenz

Dienst:: API Management

API-Version:: 2021-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=2021-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.
serviceName	path	True	string	Der Name des API Management-Diensts. RegEx-Muster: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string	Abonnementanmeldeinformationen, die das Microsoft Azure-Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.
api-version	query	True	string	Version der API, die mit der Clientanforderung verwendet werden soll.

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 die bedingungslose Aktualisierung sein.

Anforderungstext

Name	Typ	Beschreibung
properties.credentials	BackendCredentialsContract	Eigenschaften des Back-End-Anmeldeinformationsvertrags
properties.description	string	Back-End-Beschreibung.
properties.properties	BackendProperties	Vertrag für Back-End-Eigenschaften
properties.protocol	BackendProtocol	Back-End-Kommunikationsprotokoll.
properties.proxy	BackendProxyContract	Eigenschaften des Back-End-Proxyvertrags
properties.resourceId	string	Verwaltungs-URI der Ressource im externen System. Bei dieser URL kann es sich um die Arm-Ressourcen-ID von Logic Apps, Funktions-Apps oder API-Apps handeln.
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.

Header

ETag: string

Other Status Codes

Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

ApiManagementUpdateBackend

Beispielanforderung

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


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

import com.azure.core.util.Context;
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/2021-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", 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

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/2021-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

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"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c767823fdfd9d5e96bad245e3ea4d14d94a716bb/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-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

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/2021-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

using System;
using System.Threading.Tasks;
using System.Xml;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.ApiManagement;
using Azure.ResourceManager.ApiManagement.Models;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementUpdateBackend.json
// this example is just showing the usage of "Backend_Update" 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://video2.skills-academy.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 ApiManagementBackendResource created on azure
// for more information of creating ApiManagementBackendResource, please refer to the document of ApiManagementBackendResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
string backendId = "proxybackend";
ResourceIdentifier apiManagementBackendResourceId = ApiManagementBackendResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName, backendId);
ApiManagementBackendResource apiManagementBackend = client.GetApiManagementBackendResource(apiManagementBackendResourceId);

// invoke the operation
ETag ifMatch = new ETag("*");
ApiManagementBackendPatch patch = new ApiManagementBackendPatch()
{
    Description = "description5308",
    Tls = new BackendTlsProperties()
    {
        ShouldValidateCertificateChain = false,
        ShouldValidateCertificateName = true,
    },
};
ApiManagementBackendResource result = await apiManagementBackend.UpdateAsync(ifMatch, patch);

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

Beispiel für eine Antwort

Statuscode:: 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	Spezifische Eigenschaften für den Back-End-Typ.
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	Fehler Feldvertrag.
ErrorResponse	Fehlerantwort.
X509CertificateName	Eigenschaften des Servers 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	Eigenschaften des Back-End-Anmeldeinformationsvertrags
properties.description	string	Back-End-Beschreibung.
properties.properties	BackendProperties	Vertrag für Back-End-Eigenschaften
properties.protocol	BackendProtocol	Back-End-Kommunikationsprotokoll.
properties.proxy	BackendProxyContract	Eigenschaften des Back-End-Proxyvertrags
properties.resourceId	string	Verwaltungs-URI der Ressource im externen System. Bei dieser URL kann es sich um die Arm-Ressourcen-ID von Logic Apps, Funktions-Apps oder API-Apps handeln.
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	Autorisierungsheaderauthentifizierung
certificate	string[]	Liste der Clientzertifikatfingerabdrücke. Wird ignoriert, wenn certificatesIds bereitgestellt werden.
certificateIds	string[]	Liste der Clientzertifikat-IDs.
header	object	Beschreibung des Headerparameters.
query	object	Beschreibung des Abfrageparameters.

BackendProperties

Spezifische Eigenschaften für den Back-End-Typ.

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 Fingerabdruck des Clientzertifikats für den Verwaltungsendpunkt. Wird ignoriert, wenn certificatesIds bereitgestellt werden.
managementEndpoints	string[]	Der Clusterverwaltungsendpunkt.
maxPartitionResolutionRetries	integer	Maximale Anzahl von Wiederholungsversuchen beim Auflösen der Partition.
serverCertificateThumbprints	string[]	Fingerabdruck von Zertifikaten, die der Clusterverwaltungsdienst für die TLS-Kommunikation verwendet
serverX509Names	X509CertificateName[]	Server X509-Zertifikatnamenauflistung

BackendTlsProperties

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

Name	Typ	Standardwert	Beschreibung
validateCertificateChain	boolean	True	Flag, das angibt, ob die SSL-Zertifikatkette überprüft werden soll, wenn selbstsignierte Zertifikate für diesen Back-End-Host verwendet werden sollen.
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	Eigenschaften des Back-End-Anmeldeinformationsvertrags
properties.description	string	Back-End-Beschreibung.
properties.properties	BackendProperties	Vertrag für Back-End-Eigenschaften
properties.protocol	BackendProtocol	Back-End-Kommunikationsprotokoll.
properties.proxy	BackendProxyContract	Eigenschaften des Back-End-Proxyvertrags
properties.resourceId	string	Verwaltungs-URI der Ressource im externen System. Bei dieser URL kann es sich um die Arm-Ressourcen-ID von Logic Apps, Funktions-Apps oder API-Apps handeln.
properties.title	string	Back-End-Titel.
properties.tls	BackendTlsProperties	Back-End-TLS-Eigenschaften
properties.url	string	Laufzeit-URL des Back-Ends.

ErrorFieldContract

Fehler Feldvertrag.

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 in der Anforderung gesendet werden, im Falle eines Validierungsfehlers.
error.message	string	Lesbare Darstellung des Fehlers.

X509CertificateName

Eigenschaften des Servers X509Names.

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