ApiTagResourceContractProperties interface

패키지:

@azure/arm-apimanagement

태그 리소스에 대한 API 계약 속성입니다.

Extends

ApiEntityBaseContract

속성

id	/api/{apiId} 형식의 API 식별자입니다.
name	API 이름입니다.
path	이 API 및 API Management 서비스 인스턴스 내의 모든 리소스 경로를 고유하게 식별하는 상대 URL입니다. 서비스 인스턴스를 만드는 동안 지정된 API 엔드포인트 기본 URL에 추가되어 이 API에 대한 공용 URL을 형성합니다.
protocols	이 API의 작업을 호출할 수 있는 프로토콜에 대해 설명합니다.
serviceUrl	이 API를 구현하는 백 엔드 서비스의 절대 URL입니다.

상속된 속성

apiRevision	API의 수정 버전에 대해 설명합니다. 값이 제공되지 않으면 기본 수정 버전 1이 생성됩니다.
apiRevisionDescription	API 수정 버전에 대한 설명입니다.
apiType	API의 유형입니다.
apiVersion	API 버전이 지정된 경우 API의 버전 식별자를 나타냅니다.
apiVersionDescription	API 버전에 대한 설명입니다.
apiVersionSetId	관련 ApiVersionSet에 대한 리소스 식별자입니다.
authenticationSettings	이 API에 포함된 인증 설정의 컬렉션입니다.
contact	API에 대한 연락처 정보입니다.
description	API에 대한 설명입니다. HTML 서식 태그를 포함할 수 있습니다.
isCurrent	API 수정 버전이 현재 API 수정 버전인지를 나타냅니다.
isOnline	게이트웨이를 통해 API 수정 버전에 액세스할 수 있는지를 나타냅니다. 참고: 이 속성은 serialize되지 않습니다. 서버에서만 채울 수 있습니다.
license	API에 대한 라이선스 정보입니다.
subscriptionKeyParameterNames	API를 사용할 수 있는 프로토콜입니다.
subscriptionRequired	API에 액세스하는 데 API 또는 제품 구독이 필요한지 여부를 지정합니다.
termsOfServiceUrl	API에 대한 서비스 약관에 대한 URL입니다. URL 형식이어야 합니다.

속성 세부 정보

id

/api/{apiId} 형식의 API 식별자입니다.

id?: string

속성 값

string

name

API 이름입니다.

name?: string

속성 값

string

path

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

path?: string

속성 값

string

protocols

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

protocols?: string[]

속성 값

string[]

serviceUrl

이 API를 구현하는 백 엔드 서비스의 절대 URL입니다.

serviceUrl?: string

속성 값

string

상속된 속성 세부 정보

apiRevision

API의 수정 버전에 대해 설명합니다. 값이 제공되지 않으면 기본 수정 버전 1이 생성됩니다.

apiRevision?: string

속성 값

string

ApiEntityBaseContract.apiRevision 상속된

apiRevisionDescription

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

apiRevisionDescription?: string

속성 값

string

ApiEntityBaseContract.apiRevisionDescription 상속된

apiType

API의 유형입니다.

apiType?: string

속성 값

string

ApiEntityBaseContract.apiType 상속된

apiVersion

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

apiVersion?: string

속성 값

string

ApiEntityBaseContract.apiVersion 상속된

apiVersionDescription

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

apiVersionDescription?: string

속성 값

string

ApiEntityBaseContract.apiVersionDescription 상속된

apiVersionSetId

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

apiVersionSetId?: string

속성 값

string

ApiEntityBaseContract.apiVersionSetId 상속된

authenticationSettings

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

authenticationSettings?: AuthenticationSettingsContract

속성 값

AuthenticationSettingsContract

ApiEntityBaseContract.authenticationSettings 상속된

contact

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

contact?: ApiContactInformation

속성 값

ApiContactInformation

ApiEntityBaseContract.contact 상속된

description

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

description?: string

속성 값

string

ApiEntityBaseContract.description 상속된

isCurrent

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

isCurrent?: boolean

속성 값

boolean

ApiEntityBaseContract.isCurrent 상속된

isOnline

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

isOnline?: boolean

속성 값

boolean

ApiEntityBaseContract.isOnline 상속된

license

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

license?: ApiLicenseInformation

속성 값

ApiLicenseInformation

ApiEntityBaseContract.license 상속된

subscriptionKeyParameterNames

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

subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContract

속성 값

SubscriptionKeyParameterNamesContract

ApiEntityBaseContract.subscriptionKeyParameterNames 상속된

subscriptionRequired

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

subscriptionRequired?: boolean

속성 값

boolean

ApiEntityBaseContract.subscriptionRequired 상속된

termsOfServiceUrl

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

termsOfServiceUrl?: string

속성 값

string

ApiEntityBaseContract.termsOfServiceUrl 상속된