Backend - Get
식별자가 지정한 백 엔드의 세부 정보를 가져옵니다.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends/{backendId}?api-version=2022-08-01
URI 매개 변수
Name | In(다음 안에) | 필수 | 형식 | Description |
---|---|---|---|---|
backend
|
path | True |
string |
백 엔드 엔터티의 식별자입니다. 현재 API Management 서비스 instance 고유해야 합니다. |
resource
|
path | True |
string |
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다. |
service
|
path | True |
string |
API Management 서비스의 이름입니다. regex 패턴: |
subscription
|
path | True |
string |
대상 구독의 ID입니다. |
api-version
|
query | True |
string |
이 작업에 사용할 API 버전입니다. |
응답
Name | 형식 | Description |
---|---|---|
200 OK |
응답 본문에는 지정된 백 엔드 엔터티가 포함됩니다. 헤더 ETag: string |
|
Other Status Codes |
작업이 실패한 이유를 설명하는 오류 응답입니다. |
보안
azure_auth
Azure Active Directory OAuth2 Flow.
형식:
oauth2
Flow:
implicit
권한 부여 URL:
https://login.microsoftonline.com/common/oauth2/authorize
범위
Name | Description |
---|---|
user_impersonation | 사용자 계정 가장 |
예제
ApiManagementGetBackend
샘플 요청
샘플 응답
{
"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 |
---|---|
Backend |
권한 부여 헤더 정보입니다. |
Backend |
백 엔드 세부 정보. |
Backend |
백 엔드에 연결하는 데 사용되는 자격 증명의 세부 정보입니다. |
Backend |
백 엔드 형식과 관련된 속성입니다. |
Backend |
백 엔드 통신 프로토콜. |
Backend |
백 엔드 요청에서 사용할 백 엔드 WebProxy 서버의 세부 정보입니다. |
Backend |
Service Fabric 형식 백 엔드의 속성입니다. |
Backend |
TLS 인증서 유효성 검사를 제어하는 속성입니다. |
Error |
오류 필드 계약. |
Error |
오류 응답. |
X509Certificate |
서버 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 |
백 엔드 자격 증명 계약 속성 |
|
properties.description |
string |
백 엔드 설명입니다. |
properties.properties |
백 엔드 속성 계약 |
|
properties.protocol |
백 엔드 통신 프로토콜. |
|
properties.proxy |
백 엔드 게이트웨이 계약 속성 |
|
properties.resourceId |
string |
외부 시스템의 리소스 관리 URI입니다. 이 URL은 Logic Apps, Function Apps 또는 API Apps의 Arm 리소스 ID일 수 있습니다. |
properties.title |
string |
백 엔드 제목입니다. |
properties.tls |
백 엔드 TLS 속성 |
|
properties.url |
string |
백 엔드의 런타임 URL입니다. |
type |
string |
리소스 형식입니다. 예: "Microsoft.Compute/virtualMachines" 또는 "Microsoft.Storage/storageAccounts" |
BackendCredentialsContract
백 엔드에 연결하는 데 사용되는 자격 증명의 세부 정보입니다.
Name | 형식 | Description |
---|---|---|
authorization |
권한 부여 헤더 인증 |
|
certificate |
string[] |
클라이언트 인증서 지문 목록입니다. certificatesId가 제공되면 무시됩니다. |
certificateIds |
string[] |
클라이언트 인증서 ID 목록입니다. |
header |
object |
헤더 매개 변수 설명입니다. |
query |
object |
쿼리 매개 변수 설명입니다. |
BackendProperties
백 엔드 형식과 관련된 속성입니다.
Name | 형식 | Description |
---|---|---|
serviceFabricCluster |
백 엔드 Service Fabric 클러스터 속성 |
BackendProtocol
백 엔드 통신 프로토콜.
Name | 형식 | Description |
---|---|---|
http |
string |
백 엔드는 RESTful 서비스입니다. |
soap |
string |
백 엔드는 SOAP 서비스입니다. |
BackendProxyContract
백 엔드 요청에서 사용할 백 엔드 WebProxy 서버의 세부 정보입니다.
Name | 형식 | Description |
---|---|---|
password |
string |
WebProxy 서버에 연결하는 암호 |
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 |
서버 X509 인증서 이름 컬렉션 |
BackendTlsProperties
TLS 인증서 유효성 검사를 제어하는 속성입니다.
Name | 형식 | Default value | 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 |
유효성 검사 오류가 발생한 경우 요청에 잘못된 필드가 전송됩니다. |
|
error.message |
string |
사람이 읽을 수 있는 오류 표현입니다. |
X509CertificateName
서버 X509Names의 속성입니다.
Name | 형식 | Description |
---|---|---|
issuerCertificateThumbprint |
string |
인증서 발급자의 지문입니다. |
name |
string |
인증서의 일반 이름입니다. |