Поделиться через

ApiUpdateContract interface

  • Ссылка
Пакет:
@azure/arm-apimanagement

Сведения о контракте обновления API.

Свойства

apiRevision

Описывает редакцию API. Если значение не указано, создается редакция по умолчанию 1.
apiRevisionDescription

Описание редакции API.
apiType

Тип API.
apiVersion

Указывает идентификатор версии API, если API имеет управление версиями.
apiVersionDescription

Описание версии API.
apiVersionSetId

Идентификатор ресурса для связанного ApiVersionSet.
authenticationSettings

Коллекция параметров проверки подлинности, включенных в этот API.
contact

Контактные данные API.
description

Описание API. Может содержать теги форматирования HTML.
displayName

Имя API.
isCurrent

Указывает, является ли редакция API текущей редакцией API.
isOnline

Указывает, доступна ли редакция API через шлюз. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его может заполнить только сервер.
license

Сведения о лицензии для API.
path

Относительный URL-адрес, однозначно идентифицирующий этот API и все его пути к ресурсам в пределах экземпляра службы управления API. Он добавляется к базовому URL-адресу конечной точки API, указанному во время создания экземпляра службы, чтобы сформировать общедоступный URL-адрес для этого API.
protocols

Описывает, на каких протоколах могут вызываться операции в данном API.
serviceUrl

Абсолютный URL-адрес внутренней службы, реализующей этот API.
subscriptionKeyParameterNames

Протоколы, по которым api становится доступным.
subscriptionRequired

Указывает, требуется ли для доступа к API подписка на API или продукт.
termsOfServiceUrl

URL-адрес условий предоставления услуг для API. ДОЛЖЕН быть в формате URL-адреса.

Сведения о свойстве

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

apiVersionSetId

Идентификатор ресурса для связанного ApiVersionSet.

apiVersionSetId?: string

Значение свойства

string

authenticationSettings

Коллекция параметров проверки подлинности, включенных в этот API.

authenticationSettings?: AuthenticationSettingsContract

Значение свойства

AuthenticationSettingsContract

contact

Контактные данные API.

contact?: ApiContactInformation

Значение свойства

ApiContactInformation

description

Описание API. Может содержать теги форматирования HTML.

description?: string

Значение свойства

string

displayName

Имя API.

displayName?: string

Значение свойства

string

isCurrent

Указывает, является ли редакция API текущей редакцией API.

isCurrent?: boolean

Значение свойства

boolean

isOnline

Указывает, доступна ли редакция API через шлюз. ПРИМЕЧАНИЕ. Это свойство не будет сериализовано. Его может заполнить только сервер.

isOnline?: boolean

Значение свойства

boolean

license

Сведения о лицензии для API.

license?: ApiLicenseInformation

Значение свойства

ApiLicenseInformation

path

Относительный URL-адрес, однозначно идентифицирующий этот API и все его пути к ресурсам в пределах экземпляра службы управления API. Он добавляется к базовому URL-адресу конечной точки API, указанному во время создания экземпляра службы, чтобы сформировать общедоступный URL-адрес для этого API.

path?: string

Значение свойства

string

protocols

Описывает, на каких протоколах могут вызываться операции в данном API.

protocols?: string[]

Значение свойства

string[]

serviceUrl

Абсолютный URL-адрес внутренней службы, реализующей этот API.

serviceUrl?: string

Значение свойства

string

subscriptionKeyParameterNames

Протоколы, по которым api становится доступным.

subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContract

Значение свойства

SubscriptionKeyParameterNamesContract

subscriptionRequired

Указывает, требуется ли для доступа к API подписка на API или продукт.

subscriptionRequired?: boolean

Значение свойства

boolean

termsOfServiceUrl

URL-адрес условий предоставления услуг для API. ДОЛЖЕН быть в формате URL-адреса.

termsOfServiceUrl?: string

Значение свойства

string