다음을 통해 공유

ApiCreateOrUpdateProperties interface

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

API 속성을 만들거나 업데이트합니다.

Extends
ApiContractProperties

속성

format

API를 가져오는 콘텐츠의 형식입니다.
soapApiType

만들 API의 유형입니다.

  • http REST API를 만듭니다.
  • soap SOAP 통과 API 만들기
  • websocket websocket API를 만듭니다.
  • graphql는 GraphQL API를 만듭니다.
translateRequiredQueryParametersConduct

필요한 쿼리 매개 변수를 템플릿 매개 변수로 변환하는 전략입니다. 기본적으로 값은 'template'입니다. 가능한 값: 'template', 'query'
value

API를 가져올 때의 콘텐츠 값입니다.
wsdlSelector

WSDL의 가져오기를 문서의 하위 집합으로 제한하는 조건입니다.

상속된 속성

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 형식이어야 합니다.

속성 세부 정보

format

API를 가져오는 콘텐츠의 형식입니다.

format?: string

속성 값

string

soapApiType

만들 API의 유형입니다.

  • http REST API를 만듭니다.
  • soap SOAP 통과 API 만들기
  • websocket websocket API를 만듭니다.
  • graphql는 GraphQL API를 만듭니다.
soapApiType?: string

속성 값

string

translateRequiredQueryParametersConduct

필요한 쿼리 매개 변수를 템플릿 매개 변수로 변환하는 전략입니다. 기본적으로 값은 'template'입니다. 가능한 값: 'template', 'query'

translateRequiredQueryParametersConduct?: string

속성 값

string

value

API를 가져올 때의 콘텐츠 값입니다.

value?: string

속성 값

string

wsdlSelector

WSDL의 가져오기를 문서의 하위 집합으로 제한하는 조건입니다.

wsdlSelector?: ApiCreateOrUpdatePropertiesWsdlSelector

속성 값

ApiCreateOrUpdatePropertiesWsdlSelector

상속된 속성 세부 정보

apiRevision

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

apiRevision?: string

속성 값

string

ApiContractProperties.apiRevision에서 상속됨

apiRevisionDescription

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

apiRevisionDescription?: string

속성 값

string

ApiContractProperties.apiRevisionDescription에서 상속됨

apiType

API의 유형입니다.

apiType?: string

속성 값

string

ApiContractProperties.apiType에서 상속됨

apiVersion

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

apiVersion?: string

속성 값

string

ApiContractProperties.apiVersion에서 상속됨

apiVersionDescription

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

apiVersionDescription?: string

속성 값

string

ApiContractProperties.apiVersionDescription에서 상속됨

apiVersionSet

버전 집합 세부 정보

apiVersionSet?: ApiVersionSetContractDetails

속성 값

ApiVersionSetContractDetails

ApiContractProperties.apiVersionSet에서 상속됨

apiVersionSetId

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

apiVersionSetId?: string

속성 값

string

ApiContractProperties.apiVersionSetId에서 상속됨

authenticationSettings

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

authenticationSettings?: AuthenticationSettingsContract

속성 값

AuthenticationSettingsContract

ApiContractProperties.authenticationSettings에서 상속됨

contact

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

contact?: ApiContactInformation

속성 값

ApiContactInformation

ApiContractProperties.contact에서 상속됨

description

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

description?: string

속성 값

string

ApiContractProperties.description에서 상속됨

displayName

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

displayName?: string

속성 값

string

ApiContractProperties.displayName에서 상속됨

isCurrent

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

isCurrent?: boolean

속성 값

boolean

ApiContractProperties.isCurrent에서 상속됨

isOnline

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

isOnline?: boolean

속성 값

boolean

ApiContractProperties.isOnline에서 상속됨

license

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

license?: ApiLicenseInformation

속성 값

ApiLicenseInformation

ApiContractProperties.license에서 상속됨

path

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

path: string

속성 값

string

ApiContractProperties.path에서 상속됨

protocols

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

protocols?: string[]

속성 값

string[]

ApiContractProperties.protocols에서 상속됨

serviceUrl

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

serviceUrl?: string

속성 값

string

ApiContractProperties.serviceUrl에서 상속됨

sourceApiId

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

sourceApiId?: string

속성 값

string

ApiContractProperties.sourceApiId에서 상속됨

subscriptionKeyParameterNames

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

subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContract

속성 값

SubscriptionKeyParameterNamesContract

ApiContractProperties.subscriptionKeyParameterNames에서 상속됨

subscriptionRequired

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

subscriptionRequired?: boolean

속성 값

boolean

ApiContractProperties.subscriptionRequired에서 상속됨

termsOfServiceUrl

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

termsOfServiceUrl?: string

속성 값

string

ApiContractProperties.termsOfServiceUrl에서 상속됨