Backend - Update

Service:

API Management

API Version:

2022-08-01

Uppdateringar en befintlig serverdel.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
backendId	path	True	string	Identifierare för serverdelsentiteten. Måste vara unikt i den aktuella API Management tjänstinstansen.
resourceGroupName	path	True	string	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
serviceName	path	True	string	Namnet på API Management-tjänsten. Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	ID för målprenumerationen.
api-version	query	True	string	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Name	Obligatorisk	Typ	Description
If-Match	True	string	ETag för entiteten. ETag ska matcha det aktuella entitetstillståndet från huvudsvaret för GET-begäran eller * för ovillkorlig uppdatering.

Begärandetext

Name	Typ	Description
properties.credentials	BackendCredentialsContract	Egenskaper för kontrakt för serverdelsautentiseringsuppgifter
properties.description	string	Beskrivning av serverdelen.
properties.properties	BackendProperties	Kontrakt för serverdelsegenskaper
properties.protocol	BackendProtocol	Protokoll för serverdelskommunikation.
properties.proxy	BackendProxyContract	Egenskaper för serverdelsgatewaykontrakt
properties.resourceId	string	Hanterings-URI för resursen i det externa systemet. Den här URL:en kan vara armresurs-ID för Logic Apps, Function Apps eller API Apps.
properties.title	string	Serverdelsrubrik.
properties.tls	BackendTlsProperties	Egenskaper för serverdels-TLS
properties.url	string	Körnings-URL för serverdelen.

Svar

Name	Typ	Description
200 OK	BackendContract	Den befintliga serverdelen har uppdaterats. Headers ETag: string
Other Status Codes	ErrorResponse	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

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

Definitioner

Name	Description
BackendAuthorizationHeaderCredentials	Information om auktoriseringshuvud.
BackendContract	Serverdelsinformation.
BackendCredentialsContract	Information om de autentiseringsuppgifter som används för att ansluta till serverdelen.
BackendProperties	Egenskaper som är specifika för serverdelstypen.
BackendProtocol	Protokoll för serverdelskommunikation.
BackendProxyContract	Information om serverdelswebbproxyservern som ska användas i begäran till serverdelen.
BackendServiceFabricClusterProperties	Egenskaper för Serverdelen av Service Fabric-typ.
BackendTlsProperties	Egenskaper som styr TLS-certifikatvalidering.
BackendUpdateParameters	Parametrar för serverdelsuppdatering.
ErrorFieldContract	Fel Fältkontrakt.
ErrorResponse	Felsvar.
X509CertificateName	Egenskaper för servern X509Names.

BackendAuthorizationHeaderCredentials

Information om auktoriseringshuvud.

Name	Typ	Description
parameter	string	Autentiseringsparametervärde.
scheme	string	Namn på autentiseringsschema.

BackendContract

Serverdelsinformation.

Name	Typ	Description
id	string	Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Namnet på resursen
properties.credentials	BackendCredentialsContract	Egenskaper för kontrakt för serverdelsautentiseringsuppgifter
properties.description	string	Beskrivning av serverdelen.
properties.properties	BackendProperties	Kontrakt för serverdelsegenskaper
properties.protocol	BackendProtocol	Protokoll för serverdelskommunikation.
properties.proxy	BackendProxyContract	Egenskaper för serverdelsgatewaykontrakt
properties.resourceId	string	Hanterings-URI för resursen i det externa systemet. Den här URL:en kan vara armresurs-ID för Logic Apps, Function Apps eller API Apps.
properties.title	string	Serverdelsrubrik.
properties.tls	BackendTlsProperties	Egenskaper för serverdels-TLS
properties.url	string	Körnings-URL för serverdelen.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

BackendCredentialsContract

Information om de autentiseringsuppgifter som används för att ansluta till serverdelen.

Name	Typ	Description
authorization	BackendAuthorizationHeaderCredentials	Autentisering med auktoriseringshuvud
certificate	string[]	Lista över tumavtryck för klientcertifikat. Ignoreras om certificatesIds tillhandahålls.
certificateIds	string[]	Lista över klientcertifikat-ID:t.
header	object	Beskrivning av rubrikparameter.
query	object	Beskrivning av frågeparameter.

BackendProperties

Egenskaper som är specifika för serverdelstypen.

Name	Typ	Description
serviceFabricCluster	BackendServiceFabricClusterProperties	Egenskaper för Service Fabric-kluster i serverdelen

BackendProtocol

Protokoll för serverdelskommunikation.

Name	Typ	Description
http	string	Serverdelen är en RESTful-tjänst.
soap	string	Serverdelen är en SOAP-tjänst.

BackendProxyContract

Information om serverdelswebbproxyservern som ska användas i begäran till serverdelen.

Name	Typ	Description
password	string	Lösenord för att ansluta till WebProxy Server
url	string	Egenskapen WebProxy Server AbsoluteUri som innehåller hela URI:n som lagras i URI-instansen, inklusive alla fragment och frågesträngar.
username	string	Användarnamn för att ansluta till WebProxy-servern

BackendServiceFabricClusterProperties

Egenskaper för Serverdelen av Service Fabric-typ.

Name	Typ	Description
clientCertificateId	string	Klientcertifikat-ID för hanteringsslutpunkten.
clientCertificatethumbprint	string	Tumavtrycket för klientcertifikatet för hanteringsslutpunkten. Ignoreras om certificatesIds tillhandahålls
managementEndpoints	string[]	Slutpunkten för klusterhantering.
maxPartitionResolutionRetries	integer	Maximalt antal återförsök vid försök att lösa partitionen.
serverCertificateThumbprints	string[]	Tumavtryck för certifikat som klusterhanteringstjänsten använder för tls-kommunikation
serverX509Names	X509CertificateName[]	Server X509-certifikatnamnsamling

BackendTlsProperties

Egenskaper som styr TLS-certifikatvalidering.

Name	Typ	Standardvärde	Description
validateCertificateChain	boolean	True	Flagga som anger om validering av SSL-certifikatkedja ska utföras när du använder självsignerade certifikat för den här serverdelsvärden.
validateCertificateName	boolean	True	Flagga som anger om validering av SSL-certifikatnamn ska göras när du använder självsignerade certifikat för den här serverdelsvärden.

BackendUpdateParameters

Parametrar för serverdelsuppdatering.

Name	Typ	Description
properties.credentials	BackendCredentialsContract	Egenskaper för kontrakt för serverdelsautentiseringsuppgifter
properties.description	string	Beskrivning av serverdelen.
properties.properties	BackendProperties	Kontrakt för serverdelsegenskaper
properties.protocol	BackendProtocol	Protokoll för serverdelskommunikation.
properties.proxy	BackendProxyContract	Egenskaper för serverdelsgatewaykontrakt
properties.resourceId	string	Hanterings-URI för resursen i det externa systemet. Den här URL:en kan vara armresurs-ID för Logic Apps, Function Apps eller API Apps.
properties.title	string	Serverdelsrubrik.
properties.tls	BackendTlsProperties	Egenskaper för serverdels-TLS
properties.url	string	Körnings-URL för serverdelen.

ErrorFieldContract

Fel Fältkontrakt.

Name	Typ	Description
code	string	Felkod på egenskapsnivå.
message	string	Mänsklig läsbar representation av fel på egenskapsnivå.
target	string	Egenskapsnamn.

ErrorResponse

Felsvar.

Name	Typ	Description
error.code	string	Tjänstdefinierad felkod. Den här koden fungerar som en understatus för HTTP-felkoden som anges i svaret.
error.details	ErrorFieldContract[]	Listan över ogiltiga fält som skickas i begäran, om verifieringsfel uppstår.
error.message	string	Mänsklig läsbar representation av felet.

X509CertificateName

Egenskaper för servern X509Names.

Name	Typ	Description
issuerCertificateThumbprint	string	Tumavtryck för certifikatutfärdaren.
name	string	Eget namn på certifikatet.