Apis - Get

식별자가 지정한 API의 세부 정보를 가져옵니다.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}?api-version=2021-12-01-preview

URI 매개 변수

Name In Required Type Description
apiId
path True
  • string

API 수정 식별자입니다. 현재 API Management 서비스 인스턴스에서 고유해야 합니다. 현재가 아닌 수정 버전에는 ;rev=n이 접미사로 있으며 여기서 n은 수정 번호입니다.

Regex pattern: ^[^*#&+:<>?]+$

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

Microsoft Azure 구독을 고유하게 식별하는 구독 자격 증명입니다. 구독 ID는 모든 서비스 호출에 대한 URI의 파트를 형성합니다.

api-version
query True
  • string

클라이언트 요청과 함께 사용할 API의 버전입니다.

응답

Name Type Description
200 OK

응답 본문에는 지정된 API 엔터티가 포함되어 있습니다.

Headers

  • ETag: string
Other Status Codes

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

보안

azure_auth

OAuth2 Flow Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation 사용자 계정 가장

예제

ApiManagementGetApiContract
ApiManagementGetApiRevisionContract

ApiManagementGetApiContract

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a?api-version=2021-12-01-preview

Sample Response

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a",
  "type": "Microsoft.ApiManagement/service/apis",
  "name": "57d1f7558aa04f15146d9d8a",
  "properties": {
    "displayName": "Service",
    "apiRevision": "1",
    "serviceUrl": "https://api.plexonline.com/DataSource/Service.asmx",
    "path": "schulte",
    "protocols": [
      "https"
    ],
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    },
    "type": "soap",
    "isCurrent": true,
    "isOnline": true
  }
}

ApiManagementGetApiRevisionContract

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api;rev=3?api-version=2021-12-01-preview

Sample Response

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api;rev=3",
  "type": "Microsoft.ApiManagement/service/apis",
  "name": "echo-api;rev=3",
  "properties": {
    "displayName": "Service",
    "apiRevision": "3",
    "serviceUrl": "https://api.plexonline.com/DataSource/Service.asmx",
    "path": "schulte",
    "protocols": [
      "https"
    ],
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    },
    "apiRevisionDescription": "fixed bug in contract"
  }
}

정의

ApiContactInformation

API 연락처 정보

ApiContract

API 세부 정보입니다.

ApiLicenseInformation

API 라이선스 정보

ApiType

API의 유형입니다.

ApiVersionSetContractDetails

API 버전 집합에는 관련된 API 버전 집합에 대한 일반적인 구성이 포함되어 있습니다.

AuthenticationSettingsContract

API 인증 설정.

ErrorFieldContract

오류 필드 계약입니다.

ErrorResponse

오류 응답입니다.

OAuth2AuthenticationSettingsContract

API OAuth2 인증 설정 세부 정보입니다.

OpenIdAuthenticationSettingsContract

API OAuth2 인증 설정 세부 정보입니다.

SubscriptionKeyParameterNamesContract

구독 키 매개 변수 이름 세부 정보입니다.

ApiContactInformation

API 연락처 정보

Name Type Description
email
  • string

연락처 사용자/조직의 전자 메일 주소입니다. 전자 메일 주소 형식이어야 합니다.

name
  • string

연락처 사용자/조직의 식별 이름

url
  • string

연락처 정보를 가리키는 URL입니다. URL 형식이어야 합니다.

ApiContract

API 세부 정보입니다.

Name Type Description
id
  • string

리소스에 대한 정규화된 리소스 ID입니다. 예 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name
  • string

리소스의 이름입니다.

properties.apiRevision
  • string

API의 수정 버전에 대해 설명합니다. 값이 제공되지 않으면 기본 수정 버전 1이 만들어집니다.

properties.apiRevisionDescription
  • string

API 수정 버전에 대한 설명입니다.

properties.apiVersion
  • string

API 버전이 지정된 경우 API의 버전 식별자를 나타냅니다.

properties.apiVersionDescription
  • string

API 버전에 대한 설명입니다.

properties.apiVersionSet

버전 집합 세부 정보

properties.apiVersionSetId
  • string

관련 ApiVersionSet에 대한 리소스 식별자입니다.

properties.authenticationSettings

이 API에 포함된 인증 설정의 컬렉션입니다.

properties.contact

API에 대한 연락처 정보입니다.

properties.description
  • string

API에 대한 설명입니다. HTML 서식 지정 태그를 포함할 수 있습니다.

properties.displayName
  • string

API 이름입니다. 길이는 1~300자여야 합니다.

properties.isCurrent
  • boolean

API 수정 버전이 현재 API 수정 버전인지를 나타냅니다.

properties.isOnline
  • boolean

게이트웨이를 통해 API 수정 버전에 액세스할 수 있는지를 나타냅니다.

properties.license

API에 대한 라이선스 정보입니다.

properties.path
  • string

API Management 서비스 인스턴스 내의 이 API 및 모든 해당 리소스 경로를 고유하게 식별하는 상대 URL입니다. 이 API에 대한 공용 URL을 형성하는 서비스 인스턴스를 만드는 동안 지정된 API 엔드포인트 기준 URL에 추가됩니다.

properties.protocols
  • string[]

이 API의 작업을 호출할 수 있는 프로토콜을 설명합니다.

properties.serviceUrl
  • string

이 API를 구현하는 백 엔드 서비스의 절대 URL입니다. 2000자를 초과할 수 없습니다.

properties.sourceApiId
  • string

원본 API의 API 식별자입니다.

properties.subscriptionKeyParameterNames

API를 사용할 수 있는 프로토콜입니다.

properties.subscriptionRequired
  • boolean

API에 액세스하는 데 API 또는 제품 구독이 필요한지 여부를 지정합니다.

properties.termsOfServiceUrl
  • string

API에 대한 서비스 약관에 대한 URL입니다. URL 형식이어야 합니다.

properties.type

API의 유형입니다.

type
  • string

리소스 형식입니다. 예: "Microsoft.Compute/virtualMachines" 또는 "Microsoft. Storage/storageAccounts"

ApiLicenseInformation

API 라이선스 정보

Name Type Description
name
  • string

API에 사용되는 라이선스 이름

url
  • string

API에 사용되는 라이선스에 대한 URL입니다. URL 형식이어야 합니다.

ApiType

API의 유형입니다.

Name Type Description
graphql
  • string
http
  • string
soap
  • string
websocket
  • string

ApiVersionSetContractDetails

API 버전 집합에는 관련된 API 버전 집합에 대한 일반적인 구성이 포함되어 있습니다.

Name Type Description
description
  • string

API 버전 집합에 대한 설명입니다.

id
  • string

기존 API 버전 집합의 식별자입니다. 새 버전 집합을 만들려면 이 값을 생략합니다.

name
  • string

API 버전 집합의 표시 이름입니다.

versionHeaderName
  • string

versioningScheme이 .로 설정된 header경우 API 버전을 나타내는 HTTP 헤더 매개 변수의 이름입니다.

versionQueryName
  • string

versioningScheme이 .로 설정된 query경우 API 버전을 나타내는 쿼리 매개 변수의 이름입니다.

versioningScheme enum:
  • Header
  • Query
  • Segment

API 버전 식별자를 HTTP 요청에 배치할 위치를 결정하는 값입니다.

AuthenticationSettingsContract

API 인증 설정.

Name Type Description
oAuth2

OAuth2 인증 설정

openid

OpenID 커넥트 인증 설정

ErrorFieldContract

오류 필드 계약입니다.

Name Type Description
code
  • string

속성 수준 오류 코드입니다.

message
  • string

사람이 읽을 수 있는 속성 수준 오류 표현입니다.

target
  • string

속성 이름입니다.

ErrorResponse

오류 응답입니다.

Name Type Description
error.code
  • string

서비스에서 정의한 오류 코드입니다. 이 코드는 응답에 지정된 HTTP 오류 코드의 하위 상태로 사용됩니다.

error.details

유효성 검사 오류가 발생할 경우 잘못된 필드 목록이 요청에 전송됩니다.

error.message
  • string

사람이 읽을 수 있는 오류 표현입니다.

OAuth2AuthenticationSettingsContract

API OAuth2 인증 설정 세부 정보입니다.

Name Type Description
authorizationServerId
  • string

OAuth 권한 부여 서버 식별자입니다.

scope
  • string

작업 범위입니다.

OpenIdAuthenticationSettingsContract

API OAuth2 인증 설정 세부 정보입니다.

Name Type Description
bearerTokenSendingMethods
  • string[]

서버에 토큰을 보내는 방법입니다.

openidProviderId
  • string

OAuth 권한 부여 서버 식별자입니다.

SubscriptionKeyParameterNamesContract

구독 키 매개 변수 이름 세부 정보입니다.

Name Type Description
header
  • string

구독 키 헤더 이름입니다.

query
  • string

구독 키 쿼리 문자열 매개 변수 이름입니다.