Backend - Update

참조

서비스:: API Management

API 버전:: 2024-05-01

기존 백 엔드를 업데이트합니다.

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

URI 매개 변수

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

요청 헤더

Name	필수	형식	Description
If-Match	True	string	엔터티의 ETag입니다. ETag는 GET 요청의 헤더 응답에서 현재 엔터티 상태와 일치해야 합니다. 그렇지 않으면 무조건 업데이트의 경우 *여야 합니다.

요청 본문

Name	형식	Description
properties.circuitBreaker	BackendCircuitBreaker	백 엔드 회로 차단기 구성
properties.credentials	BackendCredentialsContract	백 엔드 자격 증명 계약 속성
properties.description	string minLength: 1 maxLength: 2000	백 엔드 설명입니다.
properties.pool	Pool
properties.properties	BackendProperties	백 엔드 속성 계약
properties.protocol	BackendProtocol	백 엔드 통신 프로토콜입니다.
properties.proxy	BackendProxyContract	백 엔드 게이트웨이 계약 속성
properties.resourceId	string minLength: 1 maxLength: 2000	외부 시스템의 리소스 관리 URI입니다. 이 URL은 Logic Apps, Function Apps 또는 API Apps의 Arm 리소스 ID일 수 있습니다.
properties.title	string minLength: 1 maxLength: 300	백 엔드 제목입니다.
properties.tls	BackendTlsProperties	백 엔드 TLS 속성
properties.type	BackendType	백 엔드의 형식입니다. 백 엔드는 단일 또는 풀일 수 있습니다.
properties.url	string minLength: 1 maxLength: 2000	백 엔드의 런타임 URL입니다.

응답

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

Name

형식

Description

200 OK

BackendContract

기존 백 엔드가 성공적으로 업데이트되었습니다.

헤더

ETag: string

Other Status Codes

ErrorResponse

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

보안

azure_auth

Azure Active Directory OAuth2 Flow.

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

ApiManagementUpdateBackend

샘플 요청

HTTP

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/proxybackend?api-version=2024-05-01


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

샘플 응답

상태 코드:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/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
    }
  }
}

정의

Name	Description
BackendAuthorizationHeaderCredentials	권한 부여 헤더 정보입니다.
BackendCircuitBreaker	백 엔드 회로 차단기의 구성
BackendContract	백 엔드 세부 정보입니다.
BackendCredentialsContract	백 엔드에 연결하는 데 사용되는 자격 증명의 세부 정보입니다.
BackendPoolItem	백 엔드 풀 서비스 정보
BackendProperties	백 엔드 형식과 관련된 속성입니다.
BackendProtocol	백 엔드 통신 프로토콜입니다.
BackendProxyContract	백 엔드 요청에서 사용할 백 엔드 WebProxy 서버의 세부 정보입니다.
BackendServiceFabricClusterProperties	Service Fabric 형식 백 엔드의 속성입니다.
BackendTlsProperties	TLS 인증서 유효성 검사를 제어하는 속성입니다.
BackendType	백 엔드의 형식입니다. 백 엔드는 단일 또는 풀일 수 있습니다.
BackendUpdateParameters	백 엔드 업데이트 매개 변수입니다.
CircuitBreakerFailureCondition	회로 차단기의 주행 조건
CircuitBreakerRule	백 엔드를 이동하도록 규칙 구성입니다.
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorDetail	오류 세부 정보입니다.
ErrorResponse	오류 응답
FailureStatusCodeRange	오류 http 상태 코드 범위
Pool
X509CertificateName	서버 X509Names의 속성입니다.

BackendAuthorizationHeaderCredentials

Object

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

Name	형식	Description
parameter	string minLength: 1 maxLength: 300	인증 매개 변수 값입니다.
scheme	string minLength: 1 maxLength: 100	인증 체계 이름입니다.

BackendCircuitBreaker

Object

백 엔드 회로 차단기의 구성

Name	형식	Description
rules	CircuitBreakerRule[]	백 엔드를 트립하는 규칙입니다.

BackendContract

Object

백 엔드 세부 정보입니다.

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

BackendCredentialsContract

Object

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

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

BackendPoolItem

Object

백 엔드 풀 서비스 정보

Name	형식	Description
id	string (arm-id)	백 엔드 엔터티의 고유한 ARM ID입니다. ARM ID는 이미 존재하는 백 엔드 엔터티를 참조해야 합니다.
priority	integer (int32) minimum: 0 maximum: 100	백 엔드 풀에서 백 엔드 엔터티의 우선 순위입니다. 0에서 100 사이여야 합니다. 값을 지정하지 않은 경우에도 null일 수 있습니다.
weight	integer (int32) minimum: 0 maximum: 100	백 엔드 풀에 있는 백 엔드 엔터티의 가중치입니다. 0에서 100 사이여야 합니다. 값을 지정하지 않은 경우에도 null일 수 있습니다.

BackendProperties

Object

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

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

BackendProtocol

열거형

백 엔드 통신 프로토콜입니다.

값	Description
http	백 엔드는 RESTful 서비스입니다.
soap	백 엔드는 SOAP 서비스입니다.

BackendProxyContract

Object

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

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

BackendServiceFabricClusterProperties

Object

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

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

BackendTlsProperties

Object

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

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

BackendType

열거형

백 엔드의 형식입니다. 백 엔드는 단일 또는 풀일 수 있습니다.

값	Description
Pool	는 풀 백 엔드를 지원합니다.
Single	는 단일 백 엔드를 지원합니다.

BackendUpdateParameters

Object

백 엔드 업데이트 매개 변수입니다.

Name	형식	Description
properties.circuitBreaker	BackendCircuitBreaker	백 엔드 회로 차단기 구성
properties.credentials	BackendCredentialsContract	백 엔드 자격 증명 계약 속성
properties.description	string minLength: 1 maxLength: 2000	백 엔드 설명입니다.
properties.pool	Pool
properties.properties	BackendProperties	백 엔드 속성 계약
properties.protocol	BackendProtocol	백 엔드 통신 프로토콜입니다.
properties.proxy	BackendProxyContract	백 엔드 게이트웨이 계약 속성
properties.resourceId	string minLength: 1 maxLength: 2000	외부 시스템의 리소스 관리 URI입니다. 이 URL은 Logic Apps, Function Apps 또는 API Apps의 Arm 리소스 ID일 수 있습니다.
properties.title	string minLength: 1 maxLength: 300	백 엔드 제목입니다.
properties.tls	BackendTlsProperties	백 엔드 TLS 속성
properties.type	BackendType	백 엔드의 형식입니다. 백 엔드는 단일 또는 풀일 수 있습니다.
properties.url	string minLength: 1 maxLength: 2000	백 엔드의 런타임 URL입니다.

CircuitBreakerFailureCondition

Object

회로 차단기의 주행 조건

Name	형식	Description
count	integer (int64)	회로를 여는 임계값입니다.
errorReasons	string[] maxLength: 200	오류로 간주되는 오류 이유입니다.
interval	string (duration)	실패가 계산되는 간격입니다.
percentage	integer (int64)	회로를 여는 임계값입니다.
statusCodeRanges	FailureStatusCodeRange[]	실패로 간주되는 상태 코드 범위입니다.

CircuitBreakerRule

Object

백 엔드를 이동하도록 규칙 구성입니다.

Name	형식	Description
acceptRetryAfter	boolean	백 엔드에서 Retry-After 헤더를 수락하는 플래그입니다.
failureCondition	CircuitBreakerFailureCondition	회로 차단기를 트립하기 위한 조건입니다.
name	string	규칙 이름입니다.
tripDuration	string (duration)	회로가 트립되는 기간입니다.

ErrorAdditionalInfo

Object

리소스 관리 오류 추가 정보입니다.

Name	형식	Description
info	object	추가 정보입니다.
type	string	추가 정보 유형입니다.

ErrorDetail

Object

오류 세부 정보입니다.

Name	형식	Description
additionalInfo	ErrorAdditionalInfo[]	오류 추가 정보입니다.
code	string	오류 코드입니다.
details	ErrorDetail[]	오류 세부 정보입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

ErrorResponse

Object

오류 응답

Name	형식	Description
error	ErrorDetail	오류 개체입니다.

FailureStatusCodeRange

Object

오류 http 상태 코드 범위

Name	형식	Description
max	integer (int32) minimum: 200 maximum: 599	최대 http 상태 코드입니다.
min	integer (int32) minimum: 200 maximum: 599	최소 http 상태 코드입니다.

Pool

Object

Name	형식	Description
services	BackendPoolItem[]	풀에 속하는 백 엔드 엔터티 목록입니다.

X509CertificateName

Object

서버 X509Names의 속성입니다.

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

다음을 통해 공유

Backend - Update

URI 매개 변수

요청 헤더

요청 본문

응답

보안

azure_auth

범위

예제

ApiManagementUpdateBackend

샘플 요청

샘플 응답

정의

BackendAuthorizationHeaderCredentials

BackendCircuitBreaker

BackendContract

BackendCredentialsContract

BackendPoolItem

BackendProperties

BackendProtocol

BackendProxyContract

BackendServiceFabricClusterProperties

BackendTlsProperties

BackendType

BackendUpdateParameters

CircuitBreakerFailureCondition

CircuitBreakerRule

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FailureStatusCodeRange

Pool

X509CertificateName

추가 리소스