ServiceFabricClientGetApplicationInfoListOptionalParams interface

Пакет:
@azure/servicefabric

Необязательные параметры.

Extends
RequestOptionsBase

Свойства

applicationDefinitionKindFilter

Используется для фильтрации по ApplicationDefinitionKind, который является механизмом, используемым для определения приложения Service Fabric.

  • По умолчанию — значение по умолчанию, которое выполняет ту же функцию, что и при выборе "Все". Значение равно
  • All — фильтр, соответствующий входным данным с любым значением ApplicationDefinitionKind. Значение равно
  • ServiceFabricApplicationDescription — фильтр, соответствующий входным данным с значением ApplicationDefinitionKind ServiceFabricApplicationDescription. Значение равно 1.
  • Compose — фильтр, соответствующий входным данным с значением Compose ApplicationDefinitionKind. Значение равно 2. Значение по умолчанию: 0.
applicationTypeName

Имя типа приложения, используемое для фильтрации приложений для запроса. Это значение не должно содержать версию типа приложения.
continuationToken

Параметр маркера продолжения используется для получения следующего набора результатов. Маркер продолжения с непустыми значениями включается в ответ API, когда результаты из системы не помещаются в один ответ. Когда это значение передается следующему вызову API, API возвращает следующий набор результатов. Если дальнейших результатов нет, маркер продолжения не содержит значения. Значение этого параметра не должно быть закодировано URL-адресом.
excludeApplicationParameters

Флаг, указывающий, будут ли параметры приложения исключены из результата. Значение по умолчанию: false.
maxResults

Максимальное количество результатов, возвращаемых в рамках страничных запросов. Этот параметр определяет верхнюю границу числа возвращаемых результатов. Возвращаемые результаты могут быть меньше указанных максимальных результатов, если они не соответствуют максимальным ограничениям размера сообщения, определенным в конфигурации. Если этот параметр равен нулю или не указан, запрос на страницы содержит как можно больше результатов, которые помещаются в возвращаемое сообщение. Значение по умолчанию: 0.
timeoutParameter

Время ожидания сервера для выполнения операции в секундах. Это время ожидания указывает длительность времени, которую клиент готов ждать завершения запрошенной операции. Значение по умолчанию для этого параметра составляет 60 секунд. Значение по умолчанию: 60.

Унаследованные свойства

abortSignal

Сигнал, который можно использовать для прерывания запросов.
customHeaders

Пользовательские заголовки запросов, которые будут применены перед отправкой запроса.
onDownloadProgress

Обратный вызов, который запускается при выполнении скачивания.
onUploadProgress

Обратный вызов, который запускается при выполнении отправки.
timeout

Число миллисекундах запроса может приниматься перед автоматическим завершением.

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

applicationDefinitionKindFilter

Используется для фильтрации по ApplicationDefinitionKind, который является механизмом, используемым для определения приложения Service Fabric.

  • По умолчанию — значение по умолчанию, которое выполняет ту же функцию, что и при выборе "Все". Значение равно
  • All — фильтр, соответствующий входным данным с любым значением ApplicationDefinitionKind. Значение равно
  • ServiceFabricApplicationDescription — фильтр, соответствующий входным данным с значением ApplicationDefinitionKind ServiceFabricApplicationDescription. Значение равно 1.
  • Compose — фильтр, соответствующий входным данным с значением Compose ApplicationDefinitionKind. Значение равно 2. Значение по умолчанию: 0.
applicationDefinitionKindFilter?: number

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

number

applicationTypeName

Имя типа приложения, используемое для фильтрации приложений для запроса. Это значение не должно содержать версию типа приложения.

applicationTypeName?: string

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

string

continuationToken

Параметр маркера продолжения используется для получения следующего набора результатов. Маркер продолжения с непустыми значениями включается в ответ API, когда результаты из системы не помещаются в один ответ. Когда это значение передается следующему вызову API, API возвращает следующий набор результатов. Если дальнейших результатов нет, маркер продолжения не содержит значения. Значение этого параметра не должно быть закодировано URL-адресом.

continuationToken?: string

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

string

excludeApplicationParameters

Флаг, указывающий, будут ли параметры приложения исключены из результата. Значение по умолчанию: false.

excludeApplicationParameters?: boolean

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

boolean

maxResults

Максимальное количество результатов, возвращаемых в рамках страничных запросов. Этот параметр определяет верхнюю границу числа возвращаемых результатов. Возвращаемые результаты могут быть меньше указанных максимальных результатов, если они не соответствуют максимальным ограничениям размера сообщения, определенным в конфигурации. Если этот параметр равен нулю или не указан, запрос на страницы содержит как можно больше результатов, которые помещаются в возвращаемое сообщение. Значение по умолчанию: 0.

maxResults?: number

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

number

timeoutParameter

Время ожидания сервера для выполнения операции в секундах. Это время ожидания указывает длительность времени, которую клиент готов ждать завершения запрошенной операции. Значение по умолчанию для этого параметра составляет 60 секунд. Значение по умолчанию: 60.

timeoutParameter?: number

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

number

Сведения об унаследованном свойстве

abortSignal

Сигнал, который можно использовать для прерывания запросов.

abortSignal?: AbortSignalLike

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

AbortSignalLike

наследуется от msRest.RequestOptionsBase.abortSignal

customHeaders

Пользовательские заголовки запросов, которые будут применены перед отправкой запроса.

customHeaders?: {[key: string]: string}

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

{[key: string]: string}

наследуется от msRest.RequestOptionsBase.customHeaders

onDownloadProgress

Обратный вызов, который запускается при выполнении скачивания.

onDownloadProgress?: (progress: TransferProgressEvent) => void

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

(progress: TransferProgressEvent) => void

наследуется от msRest.RequestOptionsBase.onDownloadProgress

onUploadProgress

Обратный вызов, который запускается при выполнении отправки.

onUploadProgress?: (progress: TransferProgressEvent) => void

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

(progress: TransferProgressEvent) => void

наследуется от msRest.RequestOptionsBase.onUploadProgress

timeout

Число миллисекундах запроса может приниматься перед автоматическим завершением.

timeout?: number

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

number

наследуется от msRest.RequestOptionsBase.timeout