Backend - Update

Szolgáltatás:

API Management

API-verzió:

2022-08-01

Frissítések egy meglévő háttérrendszert.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
backendId	path	True	string	A Háttérentitás azonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.
resourceGroupName	path	True	string	Az erőforráscsoport neve. A név megkülönbözteti a kis- és nagybetűket.
serviceName	path	True	string	A API Management szolgáltatás neve. Reguláris kifejezési minta: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	A cél-előfizetés azonosítója.
api-version	query	True	string	A művelethez használandó API-verzió.

Kérelem fejléce

Name	Kötelező	Típus	Description
If-Match	True	string	Az entitás ETagje. Az ETagnek meg kell egyeznie a GET-kérés fejlécválaszában szereplő aktuális entitásállapotmal, vagy * értékűnek kell lennie a feltétel nélküli frissítéshez.

Kérelem törzse

Name	Típus	Description
properties.credentials	BackendCredentialsContract	Háttérbeli hitelesítő adatok szerződésének tulajdonságai
properties.description	string	Háttér leírása.
properties.properties	BackendProperties	Háttértulajdonságok szerződése
properties.protocol	BackendProtocol	Háttérrendszeri kommunikációs protokoll.
properties.proxy	BackendProxyContract	Háttérbeli átjáró szerződésének tulajdonságai
properties.resourceId	string	Az erőforrás felügyeleti URI-ja a külső rendszerben. Ez az URL-cím lehet a Logic Apps, a Függvényalkalmazások vagy az API-alkalmazások ARM-erőforrás-azonosítója.
properties.title	string	Háttércím.
properties.tls	BackendTlsProperties	Háttérbeli TLS-tulajdonságok
properties.url	string	A háttérrendszer futtatókörnyezeti URL-címe.

Válaszok

Name	Típus	Description
200 OK	BackendContract	A meglévő háttérrendszer frissítése sikerült. Fejlécek ETag: string
Other Status Codes	ErrorResponse	Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	felhasználói fiók megszemélyesítése

Példák

ApiManagementUpdateBackend

Mintakérelem

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

Mintaválasz

Állapotkód:

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

Definíciók

Name	Description
BackendAuthorizationHeaderCredentials	Engedélyezési fejléc adatai.
BackendContract	Háttéradatok.
BackendCredentialsContract	A háttérrendszerhez való csatlakozáshoz használt hitelesítő adatok részletei.
BackendProperties	A háttértípusra jellemző tulajdonságok.
BackendProtocol	Háttérrendszeri kommunikációs protokoll.
BackendProxyContract	A háttérbeli WebProxy-kiszolgáló részletei, amelyet a Háttéralkalmazás kérése szolgáltatásban kell használni.
BackendServiceFabricClusterProperties	A Service Fabric típusú háttérrendszer tulajdonságai.
BackendTlsProperties	TLS-tanúsítványérvényesítést vezérlő tulajdonságok.
BackendUpdateParameters	Háttérfrissítési paraméterek.
ErrorFieldContract	Hibamező-szerződés.
ErrorResponse	Hibaválasz.
X509CertificateName	Az X509Names kiszolgáló tulajdonságai.

BackendAuthorizationHeaderCredentials

Engedélyezési fejléc adatai.

Name	Típus	Description
parameter	string	Hitelesítési paraméter értéke.
scheme	string	Hitelesítési séma neve.

BackendContract

Háttéradatok.

Name	Típus	Description
id	string	Az erőforrás teljes erőforrás-azonosítója. Például : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Az erőforrás neve
properties.credentials	BackendCredentialsContract	Háttérbeli hitelesítő adatok szerződésének tulajdonságai
properties.description	string	Háttér leírása.
properties.properties	BackendProperties	Háttértulajdonságok szerződése
properties.protocol	BackendProtocol	Háttérrendszeri kommunikációs protokoll.
properties.proxy	BackendProxyContract	Háttérbeli átjáró szerződésének tulajdonságai
properties.resourceId	string	Az erőforrás felügyeleti URI-ja a külső rendszerben. Ez az URL-cím lehet a Logic Apps, a Függvényalkalmazások vagy az API-alkalmazások ARM-erőforrás-azonosítója.
properties.title	string	Háttércím.
properties.tls	BackendTlsProperties	Háttérbeli TLS-tulajdonságok
properties.url	string	A háttérrendszer futtatókörnyezeti URL-címe.
type	string	Az erőforrás típusa. Például"Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

BackendCredentialsContract

A háttérrendszerhez való csatlakozáshoz használt hitelesítő adatok részletei.

Name	Típus	Description
authorization	BackendAuthorizationHeaderCredentials	Engedélyezési fejléc hitelesítése
certificate	string[]	Ügyféltanúsítvány ujjlenyomatainak listája. A rendszer figyelmen kívül hagyja, ha a tanúsítványazonosítók meg vannak adva.
certificateIds	string[]	Ügyféltanúsítvány-azonosítók listája.
header	object	Fejlécparaméter leírása.
query	object	Lekérdezési paraméter leírása.

BackendProperties

A háttértípusra jellemző tulajdonságok.

Name	Típus	Description
serviceFabricCluster	BackendServiceFabricClusterProperties	Háttérbeli Service Fabric-fürt tulajdonságai

BackendProtocol

Háttérrendszeri kommunikációs protokoll.

Name	Típus	Description
http	string	A háttérrendszer egy RESTful szolgáltatás.
soap	string	A háttérrendszer egy SOAP-szolgáltatás.

BackendProxyContract

A háttérbeli WebProxy-kiszolgáló részletei, amelyet a Háttéralkalmazás kérése szolgáltatásban kell használni.

Name	Típus	Description
password	string	Jelszó a WebProxy-kiszolgálóhoz való csatlakozáshoz
url	string	WebProxy Server AbsoluteUri tulajdonság, amely tartalmazza az URI-példányban tárolt teljes URI-t, beleértve az összes töredéket és lekérdezési sztringet.
username	string	Felhasználónév a WebProxy-kiszolgálóhoz való csatlakozáshoz

BackendServiceFabricClusterProperties

A Service Fabric típusú háttérrendszer tulajdonságai.

Name	Típus	Description
clientCertificateId	string	A felügyeleti végpont ügyféltanúsítvány-azonosítója.
clientCertificatethumbprint	string	A felügyeleti végpont ügyféltanúsítvány-ujjlenyomata. A rendszer figyelmen kívül hagyja, ha a tanúsítványazonosítók meg vannak adva
managementEndpoints	string[]	A fürtkezelési végpont.
maxPartitionResolutionRetries	integer	A partíció feloldása során az újrapróbálkozások maximális száma.
serverCertificateThumbprints	string[]	A fürtkezelési szolgáltatás által a tls-kommunikációhoz használt tanúsítványok ujjlenyomatai
serverX509Names	X509CertificateName[]	Server X509-tanúsítványnévgyűjtemény

BackendTlsProperties

TLS-tanúsítványérvényesítést vezérlő tulajdonságok.

Name	Típus	Alapértelmezett érték	Description
validateCertificateChain	boolean	True	Jelölő, amely jelzi, hogy az SSL-tanúsítványlánc érvényesítését el kell-e végezni, amikor önaláírt tanúsítványokat használ ehhez a háttér gazdagéphez.
validateCertificateName	boolean	True	Jelölő, amely azt jelzi, hogy az SSL-tanúsítvány nevének érvényesítését el kell-e végezni, amikor önaláírt tanúsítványokat használ ehhez a háttér gazdagéphez.

BackendUpdateParameters

Háttérfrissítési paraméterek.

Name	Típus	Description
properties.credentials	BackendCredentialsContract	Háttérbeli hitelesítő adatok szerződésének tulajdonságai
properties.description	string	Háttér leírása.
properties.properties	BackendProperties	Háttértulajdonságok szerződése
properties.protocol	BackendProtocol	Háttérrendszeri kommunikációs protokoll.
properties.proxy	BackendProxyContract	Háttérbeli átjáró szerződésének tulajdonságai
properties.resourceId	string	Az erőforrás felügyeleti URI-ja a külső rendszerben. Ez az URL-cím lehet a Logic Apps, a Függvényalkalmazások vagy az API-alkalmazások ARM-erőforrás-azonosítója.
properties.title	string	Háttércím.
properties.tls	BackendTlsProperties	Háttérbeli TLS-tulajdonságok
properties.url	string	A háttérrendszer futtatókörnyezeti URL-címe.

ErrorFieldContract

Hibamező-szerződés.

Name	Típus	Description
code	string	Tulajdonságszintű hibakód.
message	string	A tulajdonságszintű hiba emberi olvasásra alkalmas ábrázolása.
target	string	Tulajdonság neve.

ErrorResponse

Hibaválasz.

Name	Típus	Description
error.code	string	Szolgáltatás által definiált hibakód. Ez a kód a válaszban megadott HTTP-hibakód alállapotaként szolgál.
error.details	ErrorFieldContract[]	Érvényesítési hiba esetén a kérelemben küldött érvénytelen mezők listája.
error.message	string	A hiba emberi olvasásra alkalmas ábrázolása.

X509CertificateName

Az X509Names kiszolgáló tulajdonságai.

Name	Típus	Description
issuerCertificateThumbprint	string	A tanúsítvány kiállítójának ujjlenyomata.
name	string	A tanúsítvány köznapi neve.