Backend - Update

Layanan:

API Management

Versi API:

2022-08-01

Updates backend yang ada.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
backendId	path	True	string	Pengidentifikasi entitas Backend. Harus unik dalam instans layanan API Management saat ini.
resourceGroupName	path	True	string	Nama grup sumber daya. Nama tidak peka huruf besar/kecil.
serviceName	path	True	string	Nama layanan API Management. Pola regex: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	ID langganan target.
api-version	query	True	string	Versi API yang digunakan untuk operasi ini.

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
If-Match	True	string	ETag Entitas. ETag harus cocok dengan status entitas saat ini dari respons header permintaan GET atau harus * untuk pembaruan tanpa syarat.

Isi Permintaan

Nama	Jenis	Deskripsi
properties.credentials	BackendCredentialsContract	Properti Kontrak Kredensial Backend
properties.description	string	Deskripsi Backend.
properties.properties	BackendProperties	Kontrak Properti Backend
properties.protocol	BackendProtocol	Protokol komunikasi backend.
properties.proxy	BackendProxyContract	Properti Kontrak gateway backend
properties.resourceId	string	Uri Manajemen Sumber Daya di Sistem Eksternal. URL ini dapat menjadi Id Sumber Daya Arm dari Logic Apps, Aplikasi Fungsi, atau Aplikasi API.
properties.title	string	Judul Backend.
properties.tls	BackendTlsProperties	Properti TLS Backend
properties.url	string	Runtime Url of the Backend.

Respons

Nama	Jenis	Deskripsi
200 OK	BackendContract	Backend yang ada berhasil diperbarui. Header ETag: string
Other Status Codes	ErrorResponse	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

ApiManagementUpdateBackend

Permintaan sampel

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

dotnet

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

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-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://learn.microsoft.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

Respon sampel

Kode status:

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

Definisi

Nama	Deskripsi
BackendAuthorizationHeaderCredentials	Informasi header otorisasi.
BackendContract	Detail backend.
BackendCredentialsContract	Detail Kredensial yang digunakan untuk menyambungkan ke Backend.
BackendProperties	Properti khusus untuk Jenis Backend.
BackendProtocol	Protokol komunikasi backend.
BackendProxyContract	Detail Server WebProxy Backend untuk digunakan dalam Permintaan ke Backend.
BackendServiceFabricClusterProperties	Properti Dari Service Fabric Type Backend.
BackendTlsProperties	Properti yang mengontrol Validasi Sertifikat TLS.
BackendUpdateParameters	Parameter pembaruan backend.
ErrorFieldContract	Kontrak Bidang Kesalahan.
ErrorResponse	Respons Kesalahan.
X509CertificateName	Properti server X509Names.

BackendAuthorizationHeaderCredentials

Informasi header otorisasi.

Nama	Jenis	Deskripsi
parameter	string	Nilai Parameter Autentikasi.
scheme	string	Nama Skema Autentikasi.

BackendContract

Detail backend.

Nama	Jenis	Deskripsi
id	string	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nama sumber daya.
properties.credentials	BackendCredentialsContract	Properti Kontrak Kredensial Backend
properties.description	string	Deskripsi Backend.
properties.properties	BackendProperties	Kontrak Properti Backend
properties.protocol	BackendProtocol	Protokol komunikasi backend.
properties.proxy	BackendProxyContract	Properti Kontrak gateway backend
properties.resourceId	string	Uri Manajemen Sumber Daya di Sistem Eksternal. URL ini dapat menjadi Id Sumber Daya Arm dari Logic Apps, Aplikasi Fungsi, atau Aplikasi API.
properties.title	string	Judul Backend.
properties.tls	BackendTlsProperties	Properti TLS Backend
properties.url	string	Runtime Url of the Backend.
type	string	Jenis sumber daya. Misalnya, "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

BackendCredentialsContract

Detail Kredensial yang digunakan untuk menyambungkan ke Backend.

Nama	Jenis	Deskripsi
authorization	BackendAuthorizationHeaderCredentials	Autentikasi header otorisasi
certificate	string[]	Daftar Thumbprint Sertifikat Klien. Akan diabaikan jika certificatesIds disediakan.
certificateIds	string[]	Daftar Id Sertifikat Klien.
header	object	Deskripsi Parameter Header.
query	object	Deskripsi Parameter Kueri.

BackendProperties

Properti khusus untuk Jenis Backend.

Nama	Jenis	Deskripsi
serviceFabricCluster	BackendServiceFabricClusterProperties	Properti Kluster Backend Service Fabric

BackendProtocol

Protokol komunikasi backend.

Nama	Jenis	Deskripsi
http	string	Backend adalah layanan RESTful.
soap	string	Backend adalah layanan SOAP.

BackendProxyContract

Detail Server WebProxy Backend untuk digunakan dalam Permintaan ke Backend.

Nama	Jenis	Deskripsi
password	string	Kata sandi untuk menyambungkan ke Server WebProxy
url	string	Properti WebProxy Server AbsoluteUri yang mencakup seluruh URI yang disimpan dalam instans Uri, termasuk semua fragmen dan string kueri.
username	string	Nama pengguna untuk menyambungkan ke server WebProxy

BackendServiceFabricClusterProperties

Properti Dari Service Fabric Type Backend.

Nama	Jenis	Deskripsi
clientCertificateId	string	Id sertifikat klien untuk titik akhir manajemen.
clientCertificatethumbprint	string	Thumbprint sertifikat klien untuk titik akhir manajemen. Akan diabaikan jika certificatesIds disediakan
managementEndpoints	string[]	Titik akhir manajemen kluster.
maxPartitionResolutionRetries	integer	Jumlah maksimum percobaan ulang saat mencoba menyelesaikan partisi.
serverCertificateThumbprints	string[]	Thumbprints layanan manajemen kluster sertifikat yang digunakan untuk komunikasi tls
serverX509Names	X509CertificateName[]	Kumpulan Nama Sertifikat Server X509

BackendTlsProperties

Properti yang mengontrol Validasi Sertifikat TLS.

Nama	Jenis	Nilai default	Deskripsi
validateCertificateChain	boolean	True	Bendera yang menunjukkan apakah validasi rantai sertifikat SSL harus dilakukan saat menggunakan sertifikat yang ditandatangani sendiri untuk host backend ini.
validateCertificateName	boolean	True	Bendera yang menunjukkan apakah validasi nama sertifikat SSL harus dilakukan saat menggunakan sertifikat yang ditandatangani sendiri untuk host backend ini.

BackendUpdateParameters

Parameter pembaruan backend.

Nama	Jenis	Deskripsi
properties.credentials	BackendCredentialsContract	Properti Kontrak Kredensial Backend
properties.description	string	Deskripsi Backend.
properties.properties	BackendProperties	Kontrak Properti Backend
properties.protocol	BackendProtocol	Protokol komunikasi backend.
properties.proxy	BackendProxyContract	Properti Kontrak gateway backend
properties.resourceId	string	Uri Manajemen Sumber Daya di Sistem Eksternal. URL ini dapat menjadi Id Sumber Daya Arm dari Logic Apps, Aplikasi Fungsi, atau Aplikasi API.
properties.title	string	Judul Backend.
properties.tls	BackendTlsProperties	Properti TLS Backend
properties.url	string	Runtime Url of the Backend.

ErrorFieldContract

Kontrak Bidang Kesalahan.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan tingkat properti.
message	string	Representasi kesalahan tingkat properti yang dapat dibaca manusia.
target	string	Nama properti.

ErrorResponse

Respons Kesalahan.

Nama	Jenis	Deskripsi
error.code	string	Kode kesalahan yang ditentukan layanan. Kode ini berfungsi sebagai sub-status untuk kode kesalahan HTTP yang ditentukan dalam respons.
error.details	ErrorFieldContract[]	Daftar bidang yang tidak valid dikirim dalam permintaan, jika terjadi kesalahan validasi.
error.message	string	Representasi kesalahan yang dapat dibaca manusia.

X509CertificateName

Properti server X509Names.

Nama	Jenis	Deskripsi
issuerCertificateThumbprint	string	Thumbprint untuk Penerbit Sertifikat.
name	string	Nama Umum Sertifikat.