Backend - Create Or Update

참조

Service:: API Management

API Version:: 2022-08-01

백엔드를 만들거나 업데이트합니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
backendId	path	True	string	백 엔드 엔터티의 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다.
resourceGroupName	path	True	string	리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
serviceName	path	True	string	API Management 서비스의 이름입니다. Regex pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string	대상 구독의 ID입니다.
api-version	query	True	string	이 작업에 사용할 API 버전입니다.

요청 헤더

Name	필수	형식	Description
If-Match		string	엔터티의 ETag입니다. 엔터티를 만들 때는 필요하지 않지만 엔터티를 업데이트할 때 필요합니다.

요청 본문

Name	필수	형식	Description
properties.protocol	True	BackendProtocol	백 엔드 통신 프로토콜.
properties.url	True	string	백 엔드의 런타임 URL입니다.
properties.credentials		BackendCredentialsContract	백 엔드 자격 증명 계약 속성
properties.description		string	백 엔드 설명입니다.
properties.properties		BackendProperties	백 엔드 속성 계약
properties.proxy		BackendProxyContract	백 엔드 게이트웨이 계약 속성
properties.resourceId		string	외부 시스템의 리소스 관리 URI입니다. 이 URL은 Logic Apps, Function Apps 또는 API Apps의 Arm 리소스 ID일 수 있습니다.
properties.title		string	백 엔드 제목.
properties.tls		BackendTlsProperties	백 엔드 TLS 속성

응답

Name	형식	Description
200 OK	BackendContract	기존 백 엔드가 업데이트되었습니다. Headers ETag: string
201 Created	BackendContract	백 엔드가 성공적으로 만들어졌습니다. Headers ETag: string
Other Status Codes	ErrorResponse	작업이 실패한 이유를 설명하는 오류 응답입니다.

Name

형식

Description

200 OK

BackendContract

기존 백 엔드가 업데이트되었습니다.

Headers

ETag: string

201 Created

BackendContract

백 엔드가 성공적으로 만들어졌습니다.

Headers

ETag: string

Other Status Codes

ErrorResponse

작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

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	사용자 계정 가장

예제

ApiManagementCreateBackendProxyBackend

ApiManagementCreateBackendServiceFabric

ApiManagementCreateBackendProxyBackend

Sample Request

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

{
  "properties": {
    "description": "description5308",
    "url": "https://backendname2644/",
    "protocol": "http",
    "tls": {
      "validateCertificateChain": true,
      "validateCertificateName": true
    },
    "proxy": {
      "url": "http://192.168.1.1:8080",
      "username": "Contoso\\admin",
      "password": "<password>"
    },
    "credentials": {
      "query": {
        "sv": [
          "xx",
          "bb",
          "cc"
        ]
      },
      "header": {
        "x-my-1": [
          "val1",
          "val2"
        ]
      },
      "authorization": {
        "scheme": "Basic",
        "parameter": "opensesma"
      }
    }
  }
}

import com.azure.resourcemanager.apimanagement.models.BackendAuthorizationHeaderCredentials;
import com.azure.resourcemanager.apimanagement.models.BackendCredentialsContract;
import com.azure.resourcemanager.apimanagement.models.BackendProtocol;
import com.azure.resourcemanager.apimanagement.models.BackendProxyContract;
import com.azure.resourcemanager.apimanagement.models.BackendTlsProperties;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

/** Samples for Backend CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateBackendProxyBackend.json
     */
    /**
     * Sample code: ApiManagementCreateBackendProxyBackend.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementCreateBackendProxyBackend(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .backends()
            .define("proxybackend")
            .withExistingService("rg1", "apimService1")
            .withUrl("https://backendname2644/")
            .withProtocol(BackendProtocol.HTTP)
            .withDescription("description5308")
            .withCredentials(
                new BackendCredentialsContract()
                    .withQuery(mapOf("sv", Arrays.asList("xx", "bb", "cc")))
                    .withHeaderProperty(mapOf("x-my-1", Arrays.asList("val1", "val2")))
                    .withAuthorization(
                        new BackendAuthorizationHeaderCredentials().withScheme("Basic").withParameter("opensesma")))
            .withProxy(
                new BackendProxyContract()
                    .withUrl("http://192.168.1.1:8080")
                    .withUsername("Contoso\\admin")
                    .withPassword("fakeTokenPlaceholder"))
            .withTls(new BackendTlsProperties().withValidateCertificateChain(true).withValidateCertificateName(true))
            .create();
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

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_create_backend_proxy_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.create_or_update(
        resource_group_name="rg1",
        service_name="apimService1",
        backend_id="proxybackend",
        parameters={
            "properties": {
                "credentials": {
                    "authorization": {"parameter": "opensesma", "scheme": "Basic"},
                    "header": {"x-my-1": ["val1", "val2"]},
                    "query": {"sv": ["xx", "bb", "cc"]},
                },
                "description": "description5308",
                "protocol": "http",
                "proxy": {"password": "<password>", "url": "http://192.168.1.1:8080", "username": "Contoso\\admin"},
                "tls": {"validateCertificateChain": True, "validateCertificateName": True},
                "url": "https://backendname2644/",
            }
        },
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateBackendProxyBackend.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/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/ApiManagementCreateBackendProxyBackend.json
func ExampleBackendClient_CreateOrUpdate_apiManagementCreateBackendProxyBackend() {
	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().CreateOrUpdate(ctx, "rg1", "apimService1", "proxybackend", armapimanagement.BackendContract{
		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": {
						to.Ptr("val1"),
						to.Ptr("val2")},
				},
				Query: map[string][]*string{
					"sv": {
						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(true),
				ValidateCertificateName:  to.Ptr(true),
			},
			URL:      to.Ptr("https://backendname2644/"),
			Protocol: to.Ptr(armapimanagement.BackendProtocolHTTP),
		},
	}, &armapimanagement.BackendClientCreateOrUpdateOptions{IfMatch: 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(false),
	// 				},
	// 				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 Creates or Updates a backend.
 *
 * @summary Creates or Updates a backend.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateBackendProxyBackend.json
 */
async function apiManagementCreateBackendProxyBackend() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const backendId = "proxybackend";
  const parameters = {
    description: "description5308",
    credentials: {
      authorization: { parameter: "opensesma", scheme: "Basic" },
      header: { xMy1: ["val1", "val2"] },
      query: { sv: ["xx", "bb", "cc"] },
    },
    proxy: {
      password: "<password>",
      url: "http://192.168.1.1:8080",
      username: "Contoso\\admin",
    },
    tls: { validateCertificateChain: true, validateCertificateName: true },
    url: "https://backendname2644/",
    protocol: "http",
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.backend.createOrUpdate(
    resourceGroupName,
    serviceName,
    backendId,
    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:: 201

{
  "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": false
    }
  }
}

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": false
    }
  }
}

ApiManagementCreateBackendServiceFabric

Sample Request

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

{
  "properties": {
    "description": "Service Fabric Test App 1",
    "protocol": "http",
    "url": "fabric:/mytestapp/mytestservice",
    "properties": {
      "serviceFabricCluster": {
        "managementEndpoints": [
          "https://somecluster.com"
        ],
        "clientCertificateId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1",
        "serverX509Names": [
          {
            "name": "ServerCommonName1",
            "issuerCertificateThumbprint": "IssuerCertificateThumbprint1"
          }
        ],
        "maxPartitionResolutionRetries": 5
      }
    }
  }
}

import com.azure.resourcemanager.apimanagement.models.BackendProperties;
import com.azure.resourcemanager.apimanagement.models.BackendProtocol;
import com.azure.resourcemanager.apimanagement.models.BackendServiceFabricClusterProperties;
import com.azure.resourcemanager.apimanagement.models.X509CertificateName;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

/** Samples for Backend CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateBackendServiceFabric.json
     */
    /**
     * Sample code: ApiManagementCreateBackendServiceFabric.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementCreateBackendServiceFabric(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .backends()
            .define("sfbackend")
            .withExistingService("rg1", "apimService1")
            .withUrl("fabric:/mytestapp/mytestservice")
            .withProtocol(BackendProtocol.HTTP)
            .withDescription("Service Fabric Test App 1")
            .withProperties(
                new BackendProperties()
                    .withServiceFabricCluster(
                        new BackendServiceFabricClusterProperties()
                            .withClientCertificateId(
                                "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1")
                            .withMaxPartitionResolutionRetries(5)
                            .withManagementEndpoints(Arrays.asList("https://somecluster.com"))
                            .withServerX509Names(
                                Arrays
                                    .asList(
                                        new X509CertificateName()
                                            .withName("ServerCommonName1")
                                            .withIssuerCertificateThumbprint("IssuerCertificateThumbprint1")))))
            .create();
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

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_create_backend_service_fabric.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.create_or_update(
        resource_group_name="rg1",
        service_name="apimService1",
        backend_id="sfbackend",
        parameters={
            "properties": {
                "description": "Service Fabric Test App 1",
                "properties": {
                    "serviceFabricCluster": {
                        "clientCertificateId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1",
                        "managementEndpoints": ["https://somecluster.com"],
                        "maxPartitionResolutionRetries": 5,
                        "serverX509Names": [
                            {"issuerCertificateThumbprint": "IssuerCertificateThumbprint1", "name": "ServerCommonName1"}
                        ],
                    }
                },
                "protocol": "http",
                "url": "fabric:/mytestapp/mytestservice",
            }
        },
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateBackendServiceFabric.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/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/ApiManagementCreateBackendServiceFabric.json
func ExampleBackendClient_CreateOrUpdate_apiManagementCreateBackendServiceFabric() {
	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().CreateOrUpdate(ctx, "rg1", "apimService1", "sfbackend", armapimanagement.BackendContract{
		Properties: &armapimanagement.BackendContractProperties{
			Description: to.Ptr("Service Fabric Test App 1"),
			Properties: &armapimanagement.BackendProperties{
				ServiceFabricCluster: &armapimanagement.BackendServiceFabricClusterProperties{
					ClientCertificateID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1"),
					ManagementEndpoints: []*string{
						to.Ptr("https://somecluster.com")},
					MaxPartitionResolutionRetries: to.Ptr[int32](5),
					ServerX509Names: []*armapimanagement.X509CertificateName{
						{
							Name:                        to.Ptr("ServerCommonName1"),
							IssuerCertificateThumbprint: to.Ptr("IssuerCertificateThumbprint1"),
						}},
				},
			},
			URL:      to.Ptr("fabric:/mytestapp/mytestservice"),
			Protocol: to.Ptr(armapimanagement.BackendProtocolHTTP),
		},
	}, &armapimanagement.BackendClientCreateOrUpdateOptions{IfMatch: 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("sfbackend"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service/backends"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/sfbackend"),
	// 	Properties: &armapimanagement.BackendContractProperties{
	// 		Description: to.Ptr("Service Fabric Test App 1"),
	// 		Properties: &armapimanagement.BackendProperties{
	// 			ServiceFabricCluster: &armapimanagement.BackendServiceFabricClusterProperties{
	// 				ClientCertificateID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1"),
	// 				ManagementEndpoints: []*string{
	// 					to.Ptr("https://somecluster.com")},
	// 					MaxPartitionResolutionRetries: to.Ptr[int32](5),
	// 					ServerX509Names: []*armapimanagement.X509CertificateName{
	// 						{
	// 							Name: to.Ptr("ServerCommonName1"),
	// 							IssuerCertificateThumbprint: to.Ptr("IssuerCertificateThumbprint1"),
	// 					}},
	// 				},
	// 			},
	// 			URL: to.Ptr("fabric:/mytestapp/mytestservice"),
	// 			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 Creates or Updates a backend.
 *
 * @summary Creates or Updates a backend.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateBackendServiceFabric.json
 */
async function apiManagementCreateBackendServiceFabric() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const backendId = "sfbackend";
  const parameters = {
    description: "Service Fabric Test App 1",
    properties: {
      serviceFabricCluster: {
        clientCertificateId:
          "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1",
        managementEndpoints: ["https://somecluster.com"],
        maxPartitionResolutionRetries: 5,
        serverX509Names: [
          {
            name: "ServerCommonName1",
            issuerCertificateThumbprint: "IssuerCertificateThumbprint1",
          },
        ],
      },
    },
    url: "fabric:/mytestapp/mytestservice",
    protocol: "http",
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.backend.createOrUpdate(
    resourceGroupName,
    serviceName,
    backendId,
    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:: 201

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/sfbackend",
  "type": "Microsoft.ApiManagement/service/backends",
  "name": "sfbackend",
  "properties": {
    "description": "Service Fabric Test App 1",
    "url": "fabric:/mytestapp/mytestservice",
    "protocol": "http",
    "properties": {
      "serviceFabricCluster": {
        "managementEndpoints": [
          "https://somecluster.com"
        ],
        "clientCertificateId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1",
        "serverX509Names": [
          {
            "name": "ServerCommonName1",
            "issuerCertificateThumbprint": "IssuerCertificateThumbprint1"
          }
        ],
        "maxPartitionResolutionRetries": 5
      }
    }
  }
}

Status code:: 200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/sfbackend",
  "type": "Microsoft.ApiManagement/service/backends",
  "name": "sfbackend",
  "properties": {
    "description": "Service Fabric Test App 1",
    "url": "fabric:/mytestapp/mytestservice",
    "protocol": "http",
    "properties": {
      "serviceFabricCluster": {
        "managementEndpoints": [
          "https://somecluster.com"
        ],
        "clientCertificateId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1",
        "serverX509Names": [
          {
            "name": "ServerCommonName1",
            "issuerCertificateThumbprint": "IssuerCertificateThumbprint1"
          }
        ],
        "maxPartitionResolutionRetries": 5
      }
    }
  }
}

정의

Name	Description
BackendAuthorizationHeaderCredentials	권한 부여 헤더 정보입니다.
BackendContract	백 엔드 세부 정보입니다.
BackendCredentialsContract	백 엔드에 연결하는 데 사용되는 자격 증명의 세부 정보입니다.
BackendProperties	백 엔드 형식과 관련된 속성입니다.
BackendProtocol	백 엔드 통신 프로토콜.
BackendProxyContract	백 엔드 요청에서 사용할 백 엔드 WebProxy 서버의 세부 정보입니다.
BackendServiceFabricClusterProperties	Service Fabric 형식 백 엔드의 속성입니다.
BackendTlsProperties	TLS 인증서 유효성 검사를 제어하는 속성입니다.
ErrorFieldContract	오류 필드 계약입니다.
ErrorResponse	오류 응답.
X509CertificateName	서버 X509Names의 속성입니다.

BackendAuthorizationHeaderCredentials

권한 부여 헤더 정보입니다.

Name	형식	Description
parameter	string	인증 매개 변수 값입니다.
scheme	string	인증 체계 이름입니다.

BackendContract

백 엔드 세부 정보입니다.

Name	형식	Description
id	string	리소스에 대한 정규화된 리소스 ID입니다. 예 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	리소스의 이름입니다.
properties.credentials	BackendCredentialsContract	백 엔드 자격 증명 계약 속성
properties.description	string	백 엔드 설명입니다.
properties.properties	BackendProperties	백 엔드 속성 계약
properties.protocol	BackendProtocol	백 엔드 통신 프로토콜.
properties.proxy	BackendProxyContract	백 엔드 게이트웨이 계약 속성
properties.resourceId	string	외부 시스템의 리소스 관리 URI입니다. 이 URL은 Logic Apps, Function Apps 또는 API Apps의 Arm 리소스 ID일 수 있습니다.
properties.title	string	백 엔드 제목.
properties.tls	BackendTlsProperties	백 엔드 TLS 속성
properties.url	string	백 엔드의 런타임 URL입니다.
type	string	리소스 형식입니다. 예: "Microsoft.Compute/virtualMachines" 또는 "Microsoft.Storage/storageAccounts"

BackendCredentialsContract

백 엔드에 연결하는 데 사용되는 자격 증명의 세부 정보입니다.

Name	형식	Description
authorization	BackendAuthorizationHeaderCredentials	권한 부여 헤더 인증
certificate	string[]	클라이언트 인증서 지문 목록입니다. certificatesId가 제공되면 무시됩니다.
certificateIds	string[]	클라이언트 인증서 ID 목록입니다.
header	object	헤더 매개 변수 설명입니다.
query	object	쿼리 매개 변수 설명입니다.

BackendProperties

백 엔드 형식과 관련된 속성입니다.

Name	형식	Description
serviceFabricCluster	BackendServiceFabricClusterProperties	백 엔드 Service Fabric 클러스터 속성

BackendProtocol

백 엔드 통신 프로토콜.

Name	형식	Description
http	string	백 엔드는 RESTful 서비스입니다.
soap	string	백 엔드는 SOAP 서비스입니다.

BackendProxyContract

백 엔드 요청에서 사용할 백 엔드 WebProxy 서버의 세부 정보입니다.

Name	형식	Description
password	string	WebProxy Server에 연결할 암호
url	string	모든 조각 및 쿼리 문자열을 포함하여 Uri instance 저장된 전체 URI를 포함하는 WebProxy Server AbsoluteUri 속성입니다.
username	string	WebProxy 서버에 연결할 사용자 이름

BackendServiceFabricClusterProperties

Service Fabric 형식 백 엔드의 속성입니다.

Name	형식	Description
clientCertificateId	string	관리 엔드포인트의 클라이언트 인증서 ID입니다.
clientCertificatethumbprint	string	관리 엔드포인트에 대한 클라이언트 인증서 지문입니다. certificatesId가 제공되면 무시됩니다.
managementEndpoints	string[]	클러스터 관리 엔드포인트입니다.
maxPartitionResolutionRetries	integer	파티션을 resolve 동안 최대 재시도 횟수입니다.
serverCertificateThumbprints	string[]	tls 통신에 사용되는 인증서 클러스터 관리 서비스의 지문
serverX509Names	X509CertificateName[]	서버 X509 인증서 이름 컬렉션

BackendTlsProperties

TLS 인증서 유효성 검사를 제어하는 속성입니다.

Name	형식	기본값	Description
validateCertificateChain	boolean	True	이 백 엔드 호스트에 대해 자체 서명된 인증서를 사용할 때 SSL 인증서 체인 유효성 검사를 수행해야 하는지 여부를 나타내는 플래그입니다.
validateCertificateName	boolean	True	이 백 엔드 호스트에 대해 자체 서명된 인증서를 사용할 때 SSL 인증서 이름 유효성 검사를 수행해야 하는지 여부를 나타내는 플래그입니다.

ErrorFieldContract

오류 필드 계약입니다.

Name	형식	Description
code	string	속성 수준 오류 코드입니다.
message	string	사람이 읽을 수 있는 속성 수준 오류 표현입니다.
target	string	속성 이름입니다.

ErrorResponse

오류 응답.

Name	형식	Description
error.code	string	서비스에서 정의한 오류 코드입니다. 이 코드는 응답에 지정된 HTTP 오류 코드의 하위 상태로 사용됩니다.
error.details	ErrorFieldContract[]	유효성 검사 오류가 발생할 경우 잘못된 필드 목록이 요청에 전송됩니다.
error.message	string	사람이 읽을 수 있는 오류 표현입니다.

X509CertificateName

서버 X509Names의 속성입니다.

Name	형식	Description
issuerCertificateThumbprint	string	인증서 발급자의 지문입니다.
name	string	인증서의 일반 이름입니다.

Share via

Backend - Create Or Update

URI 매개 변수

요청 헤더

요청 본문

응답

보안

azure_auth

Scopes

예제

ApiManagementCreateBackendProxyBackend

Sample Request

Sample Response

ApiManagementCreateBackendServiceFabric

Sample Request

Sample Response

정의

BackendAuthorizationHeaderCredentials

BackendContract

BackendCredentialsContract

BackendProperties

BackendProtocol

BackendProxyContract

BackendServiceFabricClusterProperties

BackendTlsProperties

ErrorFieldContract

ErrorResponse

X509CertificateName

추가 리소스