다음을 통해 공유

ApiContract interface

  • 참조
패키지:
@azure/arm-apimanagement

API 세부 정보.

Extends
ProxyResource

속성

apiRevision

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

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

API 유형입니다.
apiVersion

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

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

버전 집합 세부 정보
apiVersionSetId

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

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

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

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

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

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

게이트웨이를 통해 API 수정 버전에 액세스할 수 있는지를 나타냅니다. 참고: 이 속성은 serialize되지 않습니다. 서버에서만 채울 수 있습니다.
license

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

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

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

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

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

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

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

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

상속된 속성

id

리소스에 대한 정규화된 리소스 ID입니다. 예 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} 참고: 이 속성은 직렬화되지 않습니다. 서버에서만 채울 수 있습니다.
name

리소스의 이름 참고: 이 속성은 직렬화되지 않습니다. 서버에서만 채울 수 있습니다.
type

리소스 형식입니다. 예: "Microsoft.Compute/virtualMachines" 또는 "Microsoft.Storage/storageAccounts" 참고: 이 속성은 직렬화되지 않습니다. 서버에서만 채울 수 있습니다.

속성 세부 정보

apiRevision

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

apiRevision?: string

속성 값

string

apiRevisionDescription

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

apiRevisionDescription?: string

속성 값

string

apiType

API 유형입니다.

apiType?: string

속성 값

string

apiVersion

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

apiVersion?: string

속성 값

string

apiVersionDescription

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

apiVersionDescription?: string

속성 값

string

apiVersionSet

버전 집합 세부 정보

apiVersionSet?: ApiVersionSetContractDetails

속성 값

ApiVersionSetContractDetails

apiVersionSetId

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

apiVersionSetId?: string

속성 값

string

authenticationSettings

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

authenticationSettings?: AuthenticationSettingsContract

속성 값

AuthenticationSettingsContract

contact

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

contact?: ApiContactInformation

속성 값

ApiContactInformation

description

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

description?: string

속성 값

string

displayName

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

displayName?: string

속성 값

string

isCurrent

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

isCurrent?: boolean

속성 값

boolean

isOnline

게이트웨이를 통해 API 수정 버전에 액세스할 수 있는지를 나타냅니다. 참고: 이 속성은 serialize되지 않습니다. 서버에서만 채울 수 있습니다.

isOnline?: boolean

속성 값

boolean

license

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

license?: ApiLicenseInformation

속성 값

ApiLicenseInformation

path

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

path?: string

속성 값

string

protocols

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

protocols?: string[]

속성 값

string[]

serviceUrl

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

serviceUrl?: string

속성 값

string

sourceApiId

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

sourceApiId?: string

속성 값

string

subscriptionKeyParameterNames

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

subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContract

속성 값

SubscriptionKeyParameterNamesContract

subscriptionRequired

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

subscriptionRequired?: boolean

속성 값

boolean

termsOfServiceUrl

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

termsOfServiceUrl?: string

속성 값

string

상속된 속성 세부 정보

id

리소스에 대한 정규화된 리소스 ID입니다. 예 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} 참고: 이 속성은 직렬화되지 않습니다. 서버에서만 채울 수 있습니다.

id?: string

속성 값

string

상속된ProxyResource.id

name

리소스의 이름 참고: 이 속성은 직렬화되지 않습니다. 서버에서만 채울 수 있습니다.

name?: string

속성 값

string

ProxyResource.name 상속됨

type

리소스 형식입니다. 예: "Microsoft.Compute/virtualMachines" 또는 "Microsoft.Storage/storageAccounts" 참고: 이 속성은 직렬화되지 않습니다. 서버에서만 채울 수 있습니다.

type?: string

속성 값

string

ProxyResource.type에서 상속됨