ApiContract interface
Сведения об API.
- Extends
Свойства
| api |
Описывает редакцию API. Если значение не указано, создается редакция 1 по умолчанию |
| api |
Описание редакции API. |
| api |
Тип API. |
| api |
Указывает идентификатор версии API, если API имеет версию |
| api |
Описание версии API. |
| api |
Сведения о наборе версий |
| api |
Идентификатор ресурса для связанного ApiVersionSet. |
| authentication |
Коллекция параметров проверки подлинности, включенных в этот API. |
| contact | Контактные данные ДЛЯ API. |
| description | Описание API. Может содержать теги форматирования HTML. |
| display |
Имя API. Должен содержать от 1 до 300 символов. |
| is |
Указывает, является ли редакция API текущей редакцией API. |
| is |
Указывает, доступна ли редакция API через шлюз. ПРИМЕЧАНИЕ. Это свойство не сериализуется. Он может быть заполнен только сервером. |
| license | Сведения о лицензии для API. |
| path | Относительный URL-адрес, однозначно идентифицирующий этот API и все его пути к ресурсам в пределах экземпляра службы управления API. Он добавляется к базовому URL-адресу конечной точки API, указанному во время создания экземпляра службы, чтобы сформировать общедоступный URL-адрес для этого API. |
| protocols | Описывает, на каких протоколах могут вызываться операции в данном API. |
| service |
Абсолютный URL-адрес внутренней службы, реализующей этот API. Не может содержать более 2000 символов. |
| source |
Идентификатор API исходного API. |
| subscription |
Протоколы, по которым становится доступным API. |
| subscription |
Указывает, требуется ли api или подписка на продукт для доступа к API. |
| terms |
URL-адрес условий предоставления услуг для API. ДОЛЖЕН быть в формате URL-адреса. |
Унаследованные свойства
| 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Значение свойства
apiVersionSetId
Идентификатор ресурса для связанного ApiVersionSet.
apiVersionSetId?: stringЗначение свойства
string
authenticationSettings
Коллекция параметров проверки подлинности, включенных в этот API.
authenticationSettings?: AuthenticationSettingsContractЗначение свойства
contact
description
Описание API. Может содержать теги форматирования HTML.
description?: stringЗначение свойства
string
displayName
Имя API. Должен содержать от 1 до 300 символов.
displayName?: stringЗначение свойства
string
isCurrent
Указывает, является ли редакция API текущей редакцией API.
isCurrent?: booleanЗначение свойства
boolean
isOnline
Указывает, доступна ли редакция API через шлюз. ПРИМЕЧАНИЕ. Это свойство не сериализуется. Он может быть заполнен только сервером.
isOnline?: booleanЗначение свойства
boolean
license
Сведения о лицензии для API.
license?: ApiLicenseInformationЗначение свойства
path
Относительный URL-адрес, однозначно идентифицирующий этот API и все его пути к ресурсам в пределах экземпляра службы управления API. Он добавляется к базовому URL-адресу конечной точки API, указанному во время создания экземпляра службы, чтобы сформировать общедоступный URL-адрес для этого API.
path?: stringЗначение свойства
string
protocols
Описывает, на каких протоколах могут вызываться операции в данном API.
protocols?: string[]Значение свойства
string[]
serviceUrl
Абсолютный URL-адрес внутренней службы, реализующей этот API. Не может содержать более 2000 символов.
serviceUrl?: stringЗначение свойства
string
sourceApiId
Идентификатор API исходного API.
sourceApiId?: stringЗначение свойства
string
subscriptionKeyParameterNames
Протоколы, по которым становится доступным API.
subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContractЗначение свойства
subscriptionRequired
Указывает, требуется ли api или подписка на продукт для доступа к API.
subscriptionRequired?: booleanЗначение свойства
boolean
termsOfServiceUrl
URL-адрес условий предоставления услуг для API. ДОЛЖЕН быть в формате URL-адреса.
termsOfServiceUrl?: stringЗначение свойства
string
Сведения об унаследованном свойстве
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