ServiceFabricClient class

Extends

Конструкторы

ServiceFabricClient(ServiceFabricClientOptions)

Инициализирует новый экземпляр класса ServiceFabricClient.

Свойства

meshApplication
meshCodePackage
meshGateway
meshNetwork
meshSecret
meshSecretValue
meshService
meshServiceReplica
meshVolume

Методы

addConfigurationParameterOverrides(string, ConfigParameterOverride[], ServiceCallback<void>)
addConfigurationParameterOverrides(string, ConfigParameterOverride[], ServiceFabricClientAddConfigurationParameterOverridesOptionalParams)

Этот API позволяет добавлять все существующие переопределения конфигурации на указанном узле.

addConfigurationParameterOverrides(string, ConfigParameterOverride[], ServiceFabricClientAddConfigurationParameterOverridesOptionalParams, ServiceCallback<void>)
backupPartition(string, ServiceCallback<void>)
backupPartition(string, ServiceFabricClientBackupPartitionOptionalParams)

Создает резервную копию состояния сохраняемого раздела с отслеживанием состояния. Если секции уже периодически создаются резервные копии, по умолчанию создается новая резервная копия в том же хранилище резервных копий. Можно также переопределить то же самое, указав сведения о хранилище резервных копий в составе текста запроса. После запуска резервной копии его ход выполнения можно отслеживать с помощью операции GetBackupProgress. В случае ожидания операции укажите большее значение времени ожидания резервного копирования в параметре запроса.

backupPartition(string, ServiceFabricClientBackupPartitionOptionalParams, ServiceCallback<void>)
cancelOperation(string, boolean, ServiceCallback<void>)
cancelOperation(string, boolean, ServiceFabricClientCancelOperationOptionalParams)

Следующие API запускают операции сбоя, которые могут быть отменены с помощью CancelOperation: StartDataLoss, StartQuorumLoss, StartPartitionRestart, StartNodeTransition.

Если принудительное значение равно false, то указанная пользовательская операция будет корректно остановлена и очищена. Если принудительно задано значение true, команда будет прервана, а некоторые внутренние состояния могут быть оставлены позади. Указание принудительного значения true должно использоваться с осторожностью. Вызов этого API с значением true не допускается, пока этот API еще не был вызван в той же тестовой команде с принудительной настройкой значение false первым или если у тестовой команды уже есть OperationState.RollingBack. Уточнение: OperationState.RollingBack означает, что система будет или очищает внутреннее состояние системы, вызванное выполнением команды. Он не восстановит данные, если тестовая команда была причиной потери данных. Например, при вызове StartDataLoss вызовите этот API, система будет очищать только внутреннее состояние от выполнения команды. Он не восстановит данные целевой секции, если команда выполняется достаточно далеко, чтобы привести к потере данных.

Важно отметить: если этот API вызывается с помощью force==true, внутреннее состояние может остаться позади.

cancelOperation(string, boolean, ServiceFabricClientCancelOperationOptionalParams, ServiceCallback<void>)
cancelRepairTask(RepairTaskCancelDescription, RequestOptionsBase)

Этот API поддерживает платформу Service Fabric; Он не предназначен для использования непосредственно из кода.

cancelRepairTask(RepairTaskCancelDescription, RequestOptionsBase, ServiceCallback<RepairTaskUpdateInfo>)
cancelRepairTask(RepairTaskCancelDescription, ServiceCallback<RepairTaskUpdateInfo>)
commitImageStoreUploadSession(string, ServiceCallback<void>)
commitImageStoreUploadSession(string, ServiceFabricClientCommitImageStoreUploadSessionOptionalParams)

Когда все блоки файлов были отправлены, сеанс отправки должен быть зафиксирован явным образом для завершения отправки. Хранилище образов сохраняет сеанс отправки до истечения срока действия, которое составляет 30 минут после получения последнего блока.

commitImageStoreUploadSession(string, ServiceFabricClientCommitImageStoreUploadSessionOptionalParams, ServiceCallback<void>)
copyImageStoreContent(ImageStoreCopyDescription, ServiceCallback<void>)
copyImageStoreContent(ImageStoreCopyDescription, ServiceFabricClientCopyImageStoreContentOptionalParams)

Копирует содержимое хранилища изображений из исходного хранилища образов относительного пути к целевому хранилищу образов.

copyImageStoreContent(ImageStoreCopyDescription, ServiceFabricClientCopyImageStoreContentOptionalParams, ServiceCallback<void>)
createApplication(ApplicationDescription, ServiceCallback<void>)
createApplication(ApplicationDescription, ServiceFabricClientCreateApplicationOptionalParams)

Создает приложение Service Fabric с помощью указанного описания.

createApplication(ApplicationDescription, ServiceFabricClientCreateApplicationOptionalParams, ServiceCallback<void>)
createBackupPolicy(BackupPolicyDescription, ServiceCallback<void>)
createBackupPolicy(BackupPolicyDescription, ServiceFabricClientCreateBackupPolicyOptionalParams)

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

createBackupPolicy(BackupPolicyDescription, ServiceFabricClientCreateBackupPolicyOptionalParams, ServiceCallback<void>)
createComposeDeployment(CreateComposeDeploymentDescription, ServiceCallback<void>)
createComposeDeployment(CreateComposeDeploymentDescription, ServiceFabricClientCreateComposeDeploymentOptionalParams)

Создание — это формат файла, описывающий многоконтейнерные приложения. Этот API позволяет развертывать приложения на основе контейнеров, определенные в формате создания в кластере Service Fabric. После создания развертывания его состояние можно отслеживать с помощью API GetComposeDeploymentStatus.

createComposeDeployment(CreateComposeDeploymentDescription, ServiceFabricClientCreateComposeDeploymentOptionalParams, ServiceCallback<void>)
createName(NameDescription, ServiceCallback<void>)
createName(NameDescription, ServiceFabricClientCreateNameOptionalParams)

Создает указанное имя Service Fabric.

createName(NameDescription, ServiceFabricClientCreateNameOptionalParams, ServiceCallback<void>)
createRepairTask(RepairTask, RequestOptionsBase)

Для кластеров, на которых настроена служба Repair Manager, этот API позволяет создавать задачи восстановления, которые выполняются автоматически или вручную. Для задач восстановления, которые выполняются автоматически, соответствующий исполнитель восстановления должен выполняться для каждого действия восстановления, чтобы выполняться автоматически. Сейчас они доступны только в специально настроенных облачных службах Azure.

Чтобы создать задачу восстановления вручную, укажите набор затронутых имен узлов и ожидаемое влияние. Когда состояние созданной задачи восстановления изменяется на утвержденный, можно безопасно выполнять действия по восстановлению на этих узлах.

Этот API поддерживает платформу Service Fabric; Он не предназначен для использования непосредственно из кода.

createRepairTask(RepairTask, RequestOptionsBase, ServiceCallback<RepairTaskUpdateInfo>)
createRepairTask(RepairTask, ServiceCallback<RepairTaskUpdateInfo>)
createService(string, ServiceDescriptionUnion, ServiceCallback<void>)
createService(string, ServiceDescriptionUnion, ServiceFabricClientCreateServiceOptionalParams)

Этот API позволяет создать новую службу без отслеживания состояния или службы с отслеживанием состояния в указанном приложении Service Fabric. Описание создания службы включает сведения о секционировании и необязательные свойства для размещения и балансировки нагрузки. Некоторые свойства можно изменить позже с помощью API UpdateService.

createService(string, ServiceDescriptionUnion, ServiceFabricClientCreateServiceOptionalParams, ServiceCallback<void>)
createServiceFromTemplate(string, ServiceFromTemplateDescription, ServiceCallback<void>)
createServiceFromTemplate(string, ServiceFromTemplateDescription, ServiceFabricClientCreateServiceFromTemplateOptionalParams)

Создает службу Service Fabric из шаблона службы, определенного в манифесте приложения. Шаблон службы содержит свойства, которые будут одинаковыми для экземпляра службы одного типа. API позволяет переопределить свойства, которые обычно отличаются для разных служб одного типа службы.

createServiceFromTemplate(string, ServiceFromTemplateDescription, ServiceFabricClientCreateServiceFromTemplateOptionalParams, ServiceCallback<void>)
deleteApplication(string, ServiceCallback<void>)
deleteApplication(string, ServiceFabricClientDeleteApplicationOptionalParams)

Прежде чем его можно удалить, необходимо создать приложение. При удалении приложения будут удалены все службы, которые являются частью этого приложения. По умолчанию Service Fabric попытается закрыть реплики служб корректно, а затем удалить службу. Однако если служба имеет проблемы с закрытием реплики корректно, операция удаления может занять много времени или застрять. Используйте необязательный флаг ForceRemove, чтобы пропустить правильную последовательность закрытия и принудительно удалить приложение и все его службы.

deleteApplication(string, ServiceFabricClientDeleteApplicationOptionalParams, ServiceCallback<void>)
deleteBackupPolicy(string, ServiceCallback<void>)
deleteBackupPolicy(string, ServiceFabricClientDeleteBackupPolicyOptionalParams)

Удаляет существующую политику резервного копирования. Прежде чем его можно удалить, необходимо создать политику резервного копирования. В настоящее время активная политика резервного копирования, связанная с любым приложением Service Fabric, службой или секцией, не может быть удалена без первого удаления сопоставления.

deleteBackupPolicy(string, ServiceFabricClientDeleteBackupPolicyOptionalParams, ServiceCallback<void>)
deleteImageStoreContent(string, ServiceCallback<void>)
deleteImageStoreContent(string, ServiceFabricClientDeleteImageStoreContentOptionalParams)

Удаляет существующее содержимое хранилища образов, найденное в указанном пути к хранилищу образов. Эта команда может использоваться для удаления отправленных пакетов приложений после их подготовки.

deleteImageStoreContent(string, ServiceFabricClientDeleteImageStoreContentOptionalParams, ServiceCallback<void>)
deleteImageStoreUploadSession(string, ServiceCallback<void>)
deleteImageStoreUploadSession(string, ServiceFabricClientDeleteImageStoreUploadSessionOptionalParams)

Запрос DELETE приведет к истечению срока действия существующего сеанса отправки и удалению всех ранее отправленных фрагментов файлов.

deleteImageStoreUploadSession(string, ServiceFabricClientDeleteImageStoreUploadSessionOptionalParams, ServiceCallback<void>)
deleteName(string, ServiceCallback<void>)
deleteName(string, ServiceFabricClientDeleteNameOptionalParams)

Удаляет указанное имя Service Fabric. Прежде чем его можно удалить, необходимо создать имя. Удаление имени с дочерними свойствами завершится ошибкой.

deleteName(string, ServiceFabricClientDeleteNameOptionalParams, ServiceCallback<void>)
deleteProperty(string, string, ServiceCallback<void>)
deleteProperty(string, string, ServiceFabricClientDeletePropertyOptionalParams)

Удаляет указанное свойство Service Fabric под заданным именем. Прежде чем его можно удалить, необходимо создать свойство.

deleteProperty(string, string, ServiceFabricClientDeletePropertyOptionalParams, ServiceCallback<void>)
deleteRepairTask(RepairTaskDeleteDescription, RequestOptionsBase)

Этот API поддерживает платформу Service Fabric; Он не предназначен для использования непосредственно из кода.

deleteRepairTask(RepairTaskDeleteDescription, RequestOptionsBase, ServiceCallback<void>)
deleteRepairTask(RepairTaskDeleteDescription, ServiceCallback<void>)
deleteService(string, ServiceCallback<void>)
deleteService(string, ServiceFabricClientDeleteServiceOptionalParams)

Прежде чем ее можно удалить, необходимо создать службу. По умолчанию Service Fabric попытается закрыть реплики служб корректно, а затем удалить службу. Однако если служба имеет проблемы с закрытием реплики корректно, операция удаления может занять много времени или застрять. Используйте необязательный флаг ForceRemove, чтобы пропустить грациозную последовательность закрытия и принудительно удалить службу.

deleteService(string, ServiceFabricClientDeleteServiceOptionalParams, ServiceCallback<void>)
deployServicePackageToNode(string, DeployServicePackageToNodeDescription, ServiceCallback<void>)
deployServicePackageToNode(string, DeployServicePackageToNodeDescription, ServiceFabricClientDeployServicePackageToNodeOptionalParams)

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

deployServicePackageToNode(string, DeployServicePackageToNodeDescription, ServiceFabricClientDeployServicePackageToNodeOptionalParams, ServiceCallback<void>)
disableApplicationBackup(string, ServiceCallback<void>)
disableApplicationBackup(string, ServiceFabricClientDisableApplicationBackupOptionalParams)

Отключает периодическое резервное копирование приложения Service Fabric, которое ранее было включено.

disableApplicationBackup(string, ServiceFabricClientDisableApplicationBackupOptionalParams, ServiceCallback<void>)
disableNode(string, DeactivationIntentDescription, ServiceCallback<void>)
disableNode(string, DeactivationIntentDescription, ServiceFabricClientDisableNodeOptionalParams)

Отключите узел кластера Service Fabric с указанным намерением деактивации. После завершения деактивации можно увеличить намерение деактивации, но не уменьшить (например, узел, деактивированный с намерением Приостановки, можно отключить дальше с помощью перезапуска, но не наоборот. Узлы могут быть повторно активированы с помощью операции активации узла в любое время после отключения. Если деактивация не завершена, это отменит деактивацию. Узел, который выходит из строя и выполняет резервное копирование во время деактивации, по-прежнему необходимо повторно активировать, прежде чем службы будут помещены на этот узел.

disableNode(string, DeactivationIntentDescription, ServiceFabricClientDisableNodeOptionalParams, ServiceCallback<void>)
disablePartitionBackup(string, ServiceCallback<void>)
disablePartitionBackup(string, ServiceFabricClientDisablePartitionBackupOptionalParams)

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

disablePartitionBackup(string, ServiceFabricClientDisablePartitionBackupOptionalParams, ServiceCallback<void>)
disableServiceBackup(string, ServiceCallback<void>)
disableServiceBackup(string, ServiceFabricClientDisableServiceBackupOptionalParams)

Отключает периодическое резервное копирование службы Service Fabric, которая была включена ранее. Перед отключением резервного копирования необходимо явно включить. Если резервное копирование включено для приложения Service Fabric, в котором эта служба является частью, эта служба будет периодически создавать резервные копии в отношении политики, сопоставленной на уровне приложения.

disableServiceBackup(string, ServiceFabricClientDisableServiceBackupOptionalParams, ServiceCallback<void>)
enableApplicationBackup(string, EnableBackupDescription, ServiceCallback<void>)
enableApplicationBackup(string, EnableBackupDescription, ServiceFabricClientEnableApplicationBackupOptionalParams)

Включает периодическое резервное копирование секций с отслеживанием состояния, которые являются частью этого приложения Service Fabric. Каждая секция выполняет резервное копирование по отдельности в соответствии с указанным описанием политики резервного копирования. Обратите внимание, что для периодического резервного копирования в настоящее время поддерживаются только службы надежных субъектов на основе C# и надежных служб с отслеживанием состояния.

enableApplicationBackup(string, EnableBackupDescription, ServiceFabricClientEnableApplicationBackupOptionalParams, ServiceCallback<void>)
enableNode(string, ServiceCallback<void>)
enableNode(string, ServiceFabricClientEnableNodeOptionalParams)

Активирует узел кластера Service Fabric, который в настоящее время деактивирован. После активации узел снова станет жизнеспособным объектом для размещения новых реплик, и все деактивированные реплики, оставшиеся на узле, будут повторно активированы.

enableNode(string, ServiceFabricClientEnableNodeOptionalParams, ServiceCallback<void>)
enablePartitionBackup(string, EnableBackupDescription, ServiceCallback<void>)
enablePartitionBackup(string, EnableBackupDescription, ServiceFabricClientEnablePartitionBackupOptionalParams)

Включает периодическое резервное копирование сохраняемой секции с отслеживанием состояния. Каждая секция выполняет резервное копирование в соответствии с указанным описанием политики резервного копирования. Если приложение или служба, которая является частью секции, уже включена для резервного копирования, эта операция переопределит политику, используемую для периодического резервного копирования этой секции. Обратите внимание, что для периодического резервного копирования в настоящее время поддерживаются только службы надежных субъектов на основе C# и надежных служб с отслеживанием состояния.

enablePartitionBackup(string, EnableBackupDescription, ServiceFabricClientEnablePartitionBackupOptionalParams, ServiceCallback<void>)
enableServiceBackup(string, EnableBackupDescription, ServiceCallback<void>)
enableServiceBackup(string, EnableBackupDescription, ServiceFabricClientEnableServiceBackupOptionalParams)

Включает периодическое резервное копирование секций с отслеживанием состояния, которые являются частью этой службы Service Fabric. Каждая секция выполняет резервное копирование по отдельности в соответствии с указанным описанием политики резервного копирования. Если приложение, которое является частью службы, уже включено для резервного копирования, эта операция переопределит политику, используемую для периодического резервного копирования для этой службы и ее секций (если только явно переопределено на уровне секции). Обратите внимание, что для периодического резервного копирования в настоящее время поддерживаются только службы надежных субъектов на основе C# и надежных служб с отслеживанием состояния.

enableServiceBackup(string, EnableBackupDescription, ServiceFabricClientEnableServiceBackupOptionalParams, ServiceCallback<void>)
forceApproveRepairTask(RepairTaskApproveDescription, RequestOptionsBase)

Этот API поддерживает платформу Service Fabric; Он не предназначен для использования непосредственно из кода.

forceApproveRepairTask(RepairTaskApproveDescription, RequestOptionsBase, ServiceCallback<RepairTaskUpdateInfo>)
forceApproveRepairTask(RepairTaskApproveDescription, ServiceCallback<RepairTaskUpdateInfo>)
getAadMetadata(ServiceCallback<AadMetadataObject>)
getAadMetadata(ServiceFabricClientGetAadMetadataOptionalParams)

Возвращает метаданные Azure Active Directory, используемые для защищенного подключения к кластеру. Этот API не должен вызываться отдельно. Он предоставляет сведения, необходимые для настройки защищенного подключения Azure Active Directory с кластером Service Fabric.

getAadMetadata(ServiceFabricClientGetAadMetadataOptionalParams, ServiceCallback<AadMetadataObject>)
getAllEntitiesBackedUpByPolicy(string, ServiceCallback<PagedBackupEntityList>)
getAllEntitiesBackedUpByPolicy(string, ServiceFabricClientGetAllEntitiesBackedUpByPolicyOptionalParams)

Возвращает список приложений, служб или секций Service Fabric, связанных с этой политикой резервного копирования.

getAllEntitiesBackedUpByPolicy(string, ServiceFabricClientGetAllEntitiesBackedUpByPolicyOptionalParams, ServiceCallback<PagedBackupEntityList>)
getApplicationBackupConfigurationInfo(string, ServiceCallback<PagedBackupConfigurationInfoList>)
getApplicationBackupConfigurationInfo(string, ServiceFabricClientGetApplicationBackupConfigurationInfoOptionalParams)

Возвращает сведения о конфигурации резервного копирования Service Fabric для приложения и служб и секций в этом приложении.

getApplicationBackupConfigurationInfo(string, ServiceFabricClientGetApplicationBackupConfigurationInfoOptionalParams, ServiceCallback<PagedBackupConfigurationInfoList>)
getApplicationBackupList(string, ServiceCallback<PagedBackupInfoList>)
getApplicationBackupList(string, ServiceFabricClientGetApplicationBackupListOptionalParams)

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

getApplicationBackupList(string, ServiceFabricClientGetApplicationBackupListOptionalParams, ServiceCallback<PagedBackupInfoList>)
getApplicationEventList(string, string, string, ServiceCallback<ApplicationEventUnion[]>)
getApplicationEventList(string, string, string, ServiceFabricClientGetApplicationEventListOptionalParams)

Ответ — это список объектов ApplicationEvent.

getApplicationEventList(string, string, string, ServiceFabricClientGetApplicationEventListOptionalParams, ServiceCallback<ApplicationEventUnion[]>)
getApplicationHealth(string, ServiceCallback<ApplicationHealth>)
getApplicationHealth(string, ServiceFabricClientGetApplicationHealthOptionalParams)

Возвращает состояние хита приложения Service Fabric. Ответ сообщает о состоянии работоспособности "ОК", "Ошибка" или "Предупреждение". Если сущность не найдена в хранилище работоспособности, она вернет ошибку.

getApplicationHealth(string, ServiceFabricClientGetApplicationHealthOptionalParams, ServiceCallback<ApplicationHealth>)
getApplicationHealthUsingPolicy(string, ServiceCallback<ApplicationHealth>)
getApplicationHealthUsingPolicy(string, ServiceFabricClientGetApplicationHealthUsingPolicyOptionalParams)

Возвращает работоспособность приложения Service Fabric. Используйте EventsHealthStateFilter, чтобы отфильтровать коллекцию событий работоспособности, сообщаемых на узле на основе состояния работоспособности. Используйте ClusterHealthPolicies для переопределения политик работоспособности, используемых для оценки работоспособности.

getApplicationHealthUsingPolicy(string, ServiceFabricClientGetApplicationHealthUsingPolicyOptionalParams, ServiceCallback<ApplicationHealth>)
getApplicationInfo(string, ServiceCallback<ApplicationInfo>)
getApplicationInfo(string, ServiceFabricClientGetApplicationInfoOptionalParams)

Возвращает сведения о приложении, созданном или в процессе создания в кластере Service Fabric, и имя которого совпадает с именем, указанным в качестве параметра. Ответ содержит имя, тип, состояние, параметры и другие сведения о приложении.

getApplicationInfo(string, ServiceFabricClientGetApplicationInfoOptionalParams, ServiceCallback<ApplicationInfo>)
getApplicationInfoList(ServiceCallback<PagedApplicationInfoList>)
getApplicationInfoList(ServiceFabricClientGetApplicationInfoListOptionalParams)

Возвращает сведения о приложениях, созданных или в процессе создания в кластере Service Fabric, и соответствует указанным фильтрам. Ответ содержит имя, тип, состояние, параметры и другие сведения о приложении. Если приложения не помещаются на страницу, возвращается одна страница результатов, а также маркер продолжения, который можно использовать для получения следующей страницы. Фильтры ApplicationTypeName и ApplicationDefinitionKindFilter нельзя указать одновременно.

getApplicationInfoList(ServiceFabricClientGetApplicationInfoListOptionalParams, ServiceCallback<PagedApplicationInfoList>)
getApplicationLoadInfo(string, ServiceCallback<ApplicationLoadInfo>)
getApplicationLoadInfo(string, ServiceFabricClientGetApplicationLoadInfoOptionalParams)

Возвращает сведения о загрузке приложения, созданного или в процессе создания в кластере Service Fabric, и имя которого совпадает с именем, указанным в качестве параметра. Ответ содержит имя, минимальные узлы, максимальные узлы, количество узлов, которые приложение занимает в настоящее время, и сведения о метриках загрузки приложения.

getApplicationLoadInfo(string, ServiceFabricClientGetApplicationLoadInfoOptionalParams, ServiceCallback<ApplicationLoadInfo>)
getApplicationManifest(string, string, ServiceCallback<ApplicationTypeManifest>)
getApplicationManifest(string, string, ServiceFabricClientGetApplicationManifestOptionalParams)

Ответ содержит XML манифеста приложения в виде строки.

getApplicationManifest(string, string, ServiceFabricClientGetApplicationManifestOptionalParams, ServiceCallback<ApplicationTypeManifest>)
getApplicationNameInfo(string, ServiceCallback<ApplicationNameInfo>)
getApplicationNameInfo(string, ServiceFabricClientGetApplicationNameInfoOptionalParams)

Возвращает имя приложения для указанной службы. Ошибка 404 FABRIC_E_SERVICE_DOES_NOT_EXIST возвращается, если служба с предоставленным идентификатором службы не существует.

getApplicationNameInfo(string, ServiceFabricClientGetApplicationNameInfoOptionalParams, ServiceCallback<ApplicationNameInfo>)
getApplicationsEventList(string, string, ServiceCallback<ApplicationEventUnion[]>)
getApplicationsEventList(string, string, ServiceFabricClientGetApplicationsEventListOptionalParams)

Ответ — это список объектов ApplicationEvent.

getApplicationsEventList(string, string, ServiceFabricClientGetApplicationsEventListOptionalParams, ServiceCallback<ApplicationEventUnion[]>)
getApplicationTypeInfoList(ServiceCallback<PagedApplicationTypeInfoList>)
getApplicationTypeInfoList(ServiceFabricClientGetApplicationTypeInfoListOptionalParams)

Возвращает сведения о типах приложений, подготовленных или подготовленных в процессе подготовки в кластере Service Fabric. Каждая версия типа приложения возвращается как один тип приложения. Ответ содержит имя, версию, состояние и другие сведения о типе приложения. Это запрос на страницу, т. е. если не все типы приложений помещаются на страницу, возвращается одна страница результатов, а также маркер продолжения, который можно использовать для получения следующей страницы. Например, если существует 10 типов приложений, но страница соответствует только первым трем типам приложений или если максимальный результат имеет значение 3, то возвращается три. Чтобы получить доступ к остальным результатам, получите последующие страницы с помощью возвращаемого маркера продолжения в следующем запросе. Пустой маркер продолжения возвращается, если последующие страницы отсутствуют.

getApplicationTypeInfoList(ServiceFabricClientGetApplicationTypeInfoListOptionalParams, ServiceCallback<PagedApplicationTypeInfoList>)
getApplicationTypeInfoListByName(string, ServiceCallback<PagedApplicationTypeInfoList>)
getApplicationTypeInfoListByName(string, ServiceFabricClientGetApplicationTypeInfoListByNameOptionalParams)

Возвращает сведения о типах приложений, подготовленных или подготовленных в процессе подготовки в кластере Service Fabric. Эти результаты относятся к типам приложений, имя которых совпадает с именем, указанным в качестве параметра, и которые соответствуют заданным параметрам запроса. Возвращаются все версии типа приложения, соответствующие имени типа приложения, с каждой версией, возвращаемой в качестве одного типа приложения. Ответ содержит имя, версию, состояние и другие сведения о типе приложения. Это запрос на страницу, т. е. если не все типы приложений помещаются на страницу, возвращается одна страница результатов, а также маркер продолжения, который можно использовать для получения следующей страницы. Например, если существует 10 типов приложений, но страница соответствует только первым трем типам приложений или если максимальный результат имеет значение 3, то возвращается три. Чтобы получить доступ к остальным результатам, получите последующие страницы с помощью возвращаемого маркера продолжения в следующем запросе. Пустой маркер продолжения возвращается, если последующие страницы отсутствуют.

getApplicationTypeInfoListByName(string, ServiceFabricClientGetApplicationTypeInfoListByNameOptionalParams, ServiceCallback<PagedApplicationTypeInfoList>)
getApplicationUpgrade(string, ServiceCallback<ApplicationUpgradeProgressInfo>)
getApplicationUpgrade(string, ServiceFabricClientGetApplicationUpgradeOptionalParams)

Возвращает сведения о состоянии последнего обновления приложения, а также сведения об отладке проблем с работоспособностью приложений.

getApplicationUpgrade(string, ServiceFabricClientGetApplicationUpgradeOptionalParams, ServiceCallback<ApplicationUpgradeProgressInfo>)
getBackupPolicyByName(string, ServiceCallback<BackupPolicyDescription>)
getBackupPolicyByName(string, ServiceFabricClientGetBackupPolicyByNameOptionalParams)

Возвращает определенную политику резервного копирования, определяемую {backupPolicyName}

getBackupPolicyByName(string, ServiceFabricClientGetBackupPolicyByNameOptionalParams, ServiceCallback<BackupPolicyDescription>)
getBackupPolicyList(ServiceCallback<PagedBackupPolicyDescriptionList>)
getBackupPolicyList(ServiceFabricClientGetBackupPolicyListOptionalParams)

Получите список всех настроенных политик резервного копирования.

getBackupPolicyList(ServiceFabricClientGetBackupPolicyListOptionalParams, ServiceCallback<PagedBackupPolicyDescriptionList>)
getBackupsFromBackupLocation(GetBackupByStorageQueryDescription, ServiceCallback<PagedBackupInfoList>)
getBackupsFromBackupLocation(GetBackupByStorageQueryDescription, ServiceFabricClientGetBackupsFromBackupLocationOptionalParams)

Возвращает список резервных копий, доступных для указанной сущности резервного копирования (приложения, службы или секции) в указанном расположении резервного копирования (FileShare или хранилище BLOB-объектов Azure).

getBackupsFromBackupLocation(GetBackupByStorageQueryDescription, ServiceFabricClientGetBackupsFromBackupLocationOptionalParams, ServiceCallback<PagedBackupInfoList>)
getChaos(ServiceCallback<Chaos>)
getChaos(ServiceFabricClientGetChaosOptionalParams)

Получите состояние Хаоса, указывающее, работает ли Хаос, параметры Хаоса, используемые для выполнения хаоса и состояния расписания хаоса.

getChaos(ServiceFabricClientGetChaosOptionalParams, ServiceCallback<Chaos>)
getChaosEvents(ServiceCallback<ChaosEventsSegment>)
getChaosEvents(ServiceFabricClientGetChaosEventsOptionalParams)

Чтобы получить следующий сегмент событий Chaos, можно указать Элемент "ПродолжениеToken". Чтобы получить начало нового сегмента событий Chaos, можно указать диапазон времени через StartTimeUtc и EndTimeUtc. В одном вызове нельзя указать значение ContinuationToken и диапазон времени. Если существует более 100 событий Хаоса, события Chaos возвращаются в нескольких сегментах, где сегмент содержит не более 100 событий Хаоса и получить следующий сегмент, который вы вызываете этот API с маркером продолжения.

getChaosEvents(ServiceFabricClientGetChaosEventsOptionalParams, ServiceCallback<ChaosEventsSegment>)
getChaosSchedule(ServiceCallback<ChaosScheduleDescription>)
getChaosSchedule(ServiceFabricClientGetChaosScheduleOptionalParams)

Возвращает версию расписания хаоса, используемого и расписание хаоса, определяющее, когда и как запускать Хаос.

getChaosSchedule(ServiceFabricClientGetChaosScheduleOptionalParams, ServiceCallback<ChaosScheduleDescription>)
getClusterConfiguration(string, ServiceCallback<ClusterConfiguration>)
getClusterConfiguration(string, ServiceFabricClientGetClusterConfigurationOptionalParams)

Конфигурация кластера содержит свойства кластера, которые включают различные типы узлов в кластере, конфигурации безопасности, отказоустойчивость и топологии домена обновления и т. д.

getClusterConfiguration(string, ServiceFabricClientGetClusterConfigurationOptionalParams, ServiceCallback<ClusterConfiguration>)
getClusterConfigurationUpgradeStatus(ServiceCallback<ClusterConfigurationUpgradeStatusInfo>)
getClusterConfigurationUpgradeStatus(ServiceFabricClientGetClusterConfigurationUpgradeStatusOptionalParams)

Получите сведения о состоянии обновления конфигурации кластера автономного кластера Service Fabric.

getClusterConfigurationUpgradeStatus(ServiceFabricClientGetClusterConfigurationUpgradeStatusOptionalParams, ServiceCallback<ClusterConfigurationUpgradeStatusInfo>)
getClusterEventList(string, string, ServiceCallback<ClusterEventUnion[]>)
getClusterEventList(string, string, ServiceFabricClientGetClusterEventListOptionalParams)

Ответ — это список объектов ClusterEvent.

getClusterEventList(string, string, ServiceFabricClientGetClusterEventListOptionalParams, ServiceCallback<ClusterEventUnion[]>)
getClusterHealth(ServiceCallback<ClusterHealth>)
getClusterHealth(ServiceFabricClientGetClusterHealthOptionalParams)

Используйте EventsHealthStateFilter, чтобы отфильтровать коллекцию событий работоспособности, сообщаемых в кластере на основе состояния работоспособности. Аналогичным образом используйте NodesHealthStateFilter и ApplicationHealthStateFilter для фильтрации коллекции узлов и приложений, возвращаемых на основе их агрегированного состояния работоспособности.

getClusterHealth(ServiceFabricClientGetClusterHealthOptionalParams, ServiceCallback<ClusterHealth>)
getClusterHealthChunk(ServiceCallback<ClusterHealthChunk>)
getClusterHealthChunk(ServiceFabricClientGetClusterHealthChunkOptionalParams)

Возвращает работоспособность кластера Service Fabric с помощью блоков работоспособности. Включает агрегированное состояние работоспособности кластера, но ни одно из сущностей кластера. Чтобы развернуть работоспособность кластера и получить состояние работоспособности всех или некоторых сущностей, используйте URI POST и укажите описание запроса блока работоспособности кластера.

getClusterHealthChunk(ServiceFabricClientGetClusterHealthChunkOptionalParams, ServiceCallback<ClusterHealthChunk>)
getClusterHealthChunkUsingPolicyAndAdvancedFilters(ServiceCallback<ClusterHealthChunk>)
getClusterHealthChunkUsingPolicyAndAdvancedFilters(ServiceFabricClientGetClusterHealthChunkUsingPolicyAndAdvancedFiltersOptionalParams)

Возвращает работоспособность кластера Service Fabric с помощью блоков работоспособности. Оценка работоспособности выполняется на основе описания запроса блока работоспособности входного кластера. Описание запроса позволяет пользователям указывать политики работоспособности для оценки кластера и его дочерних элементов. Пользователи могут указать очень гибкие фильтры для выбора возвращаемых сущностей кластера. Выбор можно выполнить на основе состояния работоспособности сущностей и на основе иерархии. Запрос может возвращать дочерние элементы нескольких уровней сущностей на основе указанных фильтров. Например, он может возвращать одно приложение с указанным именем, а для этого приложения — только службы, которые находятся в разделе "Ошибка" или "Предупреждение", а также все разделы и реплики для одной из этих служб.

getClusterHealthChunkUsingPolicyAndAdvancedFilters(ServiceFabricClientGetClusterHealthChunkUsingPolicyAndAdvancedFiltersOptionalParams, ServiceCallback<ClusterHealthChunk>)
getClusterHealthUsingPolicy(ServiceCallback<ClusterHealth>)
getClusterHealthUsingPolicy(ServiceFabricClientGetClusterHealthUsingPolicyOptionalParams)

Используйте EventsHealthStateFilter, чтобы отфильтровать коллекцию событий работоспособности, сообщаемых в кластере на основе состояния работоспособности. Аналогичным образом используйте NodesHealthStateFilter и ApplicationHealthStateFilter для фильтрации коллекции узлов и приложений, возвращаемых на основе их агрегированного состояния работоспособности. Используйте ClusterHealthPolicies для переопределения политик работоспособности, используемых для оценки работоспособности.

getClusterHealthUsingPolicy(ServiceFabricClientGetClusterHealthUsingPolicyOptionalParams, ServiceCallback<ClusterHealth>)
getClusterLoad(ServiceCallback<ClusterLoadInfo>)
getClusterLoad(ServiceFabricClientGetClusterLoadOptionalParams)

Извлекает сведения о нагрузке кластера Service Fabric для всех метрик, которые имеют определенную нагрузку или емкость.

getClusterLoad(ServiceFabricClientGetClusterLoadOptionalParams, ServiceCallback<ClusterLoadInfo>)
getClusterManifest(ServiceCallback<ClusterManifest>)
getClusterManifest(ServiceFabricClientGetClusterManifestOptionalParams)

Получите манифест кластера Service Fabric. Манифест кластера содержит свойства кластера, включающих различные типы узлов в кластере, конфигурации безопасности, топологии домена сбоя и обновления и т. д.

Эти свойства указываются как часть файла ClusterConfig.JSON при развертывании автономного кластера. Однако большая часть информации в манифесте кластера создается внутри service fabric во время развертывания кластера в других сценариях развертывания (например, при использовании портала Azure).

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

getClusterManifest(ServiceFabricClientGetClusterManifestOptionalParams, ServiceCallback<ClusterManifest>)
getClusterUpgradeProgress(ServiceCallback<ClusterUpgradeProgressObject>)
getClusterUpgradeProgress(ServiceFabricClientGetClusterUpgradeProgressOptionalParams)

Возвращает текущий ход выполнения текущего обновления кластера. Если обновление в настоящее время не выполняется, получите последнее состояние предыдущего обновления кластера.

getClusterUpgradeProgress(ServiceFabricClientGetClusterUpgradeProgressOptionalParams, ServiceCallback<ClusterUpgradeProgressObject>)
getClusterVersion(ServiceCallback<ClusterVersion>)
getClusterVersion(ServiceFabricClientGetClusterVersionOptionalParams)

Если происходит обновление кластера, этот API вернет самую низкую (старую) версию текущей и целевой версий среды выполнения кластера.

getClusterVersion(ServiceFabricClientGetClusterVersionOptionalParams, ServiceCallback<ClusterVersion>)
getComposeDeploymentStatus(string, ServiceCallback<ComposeDeploymentStatusInfo>)
getComposeDeploymentStatus(string, ServiceFabricClientGetComposeDeploymentStatusOptionalParams)

Возвращает состояние развертывания создания, созданного или в процессе создания в кластере Service Fabric, имя которого совпадает с именем, указанным в качестве параметра. Ответ содержит имя, состояние и другие сведения о развертывании.

getComposeDeploymentStatus(string, ServiceFabricClientGetComposeDeploymentStatusOptionalParams, ServiceCallback<ComposeDeploymentStatusInfo>)
getComposeDeploymentStatusList(ServiceCallback<PagedComposeDeploymentStatusInfoList>)
getComposeDeploymentStatusList(ServiceFabricClientGetComposeDeploymentStatusListOptionalParams)

Получает состояние о развертываниях создания, созданных или в процессе создания в кластере Service Fabric. Ответ содержит имя, состояние и другие сведения о развертываниях создания. Если список развертываний не помещается на страницу, возвращается одна страница результатов, а также маркер продолжения, который можно использовать для получения следующей страницы.

getComposeDeploymentStatusList(ServiceFabricClientGetComposeDeploymentStatusListOptionalParams, ServiceCallback<PagedComposeDeploymentStatusInfoList>)
getComposeDeploymentUpgradeProgress(string, ServiceCallback<ComposeDeploymentUpgradeProgressInfo>)
getComposeDeploymentUpgradeProgress(string, ServiceFabricClientGetComposeDeploymentUpgradeProgressOptionalParams)

Возвращает сведения о состоянии обновления развертывания создания вместе с подробными сведениями для устранения проблем с работоспособностью приложений.

getComposeDeploymentUpgradeProgress(string, ServiceFabricClientGetComposeDeploymentUpgradeProgressOptionalParams, ServiceCallback<ComposeDeploymentUpgradeProgressInfo>)
getConfigurationOverrides(string, ServiceCallback<ConfigParameterOverride[]>)
getConfigurationOverrides(string, ServiceFabricClientGetConfigurationOverridesOptionalParams)

Этот API позволяет получать все существующие переопределения конфигурации на указанном узле.

getConfigurationOverrides(string, ServiceFabricClientGetConfigurationOverridesOptionalParams, ServiceCallback<ConfigParameterOverride[]>)
getContainerLogsDeployedOnNode(string, string, string, string, ServiceCallback<ContainerLogs>)
getContainerLogsDeployedOnNode(string, string, string, string, ServiceFabricClientGetContainerLogsDeployedOnNodeOptionalParams)

Возвращает журналы контейнеров для контейнера, развернутого на узле Service Fabric для заданного пакета кода.

getContainerLogsDeployedOnNode(string, string, string, string, ServiceFabricClientGetContainerLogsDeployedOnNodeOptionalParams, ServiceCallback<ContainerLogs>)
getContainersEventList(string, string, ServiceCallback<ContainerInstanceEvent[]>)
getContainersEventList(string, string, ServiceFabricClientGetContainersEventListOptionalParams)

Ответ — это список объектов ContainerInstanceEvent.

getContainersEventList(string, string, ServiceFabricClientGetContainersEventListOptionalParams, ServiceCallback<ContainerInstanceEvent[]>)
getCorrelatedEventList(string, ServiceCallback<FabricEventUnion[]>)
getCorrelatedEventList(string, ServiceFabricClientGetCorrelatedEventListOptionalParams)

Ответ — это список FabricEvents.

getCorrelatedEventList(string, ServiceFabricClientGetCorrelatedEventListOptionalParams, ServiceCallback<FabricEventUnion[]>)
getDataLossProgress(string, string, string, ServiceCallback<PartitionDataLossProgress>)
getDataLossProgress(string, string, string, ServiceFabricClientGetDataLossProgressOptionalParams)

Возвращает ход операции потери данных, запущенной с StartDataLoss, с помощью OperationId.

getDataLossProgress(string, string, string, ServiceFabricClientGetDataLossProgressOptionalParams, ServiceCallback<PartitionDataLossProgress>)
getDeployedApplicationHealth(string, string, ServiceCallback<DeployedApplicationHealth>)
getDeployedApplicationHealth(string, string, ServiceFabricClientGetDeployedApplicationHealthOptionalParams)

Возвращает сведения о работоспособности приложения, развернутого на узле Service Fabric. Используйте EventsHealthStateFilter, чтобы при необходимости отфильтровать коллекцию объектов HealthEvent, сообщаемых в развернутом приложении на основе состояния работоспособности. Используйте DeployedServicePackagesHealthStateFilter, чтобы при необходимости фильтровать дочерние элементы DeployedServicePackageHealth на основе состояния работоспособности.

getDeployedApplicationHealth(string, string, ServiceFabricClientGetDeployedApplicationHealthOptionalParams, ServiceCallback<DeployedApplicationHealth>)
getDeployedApplicationHealthUsingPolicy(string, string, ServiceCallback<DeployedApplicationHealth>)
getDeployedApplicationHealthUsingPolicy(string, string, ServiceFabricClientGetDeployedApplicationHealthUsingPolicyOptionalParams)

Возвращает сведения о работоспособности приложения, развернутого на узле Service Fabric с помощью указанной политики. Используйте EventsHealthStateFilter, чтобы при необходимости отфильтровать коллекцию объектов HealthEvent, сообщаемых в развернутом приложении на основе состояния работоспособности. Используйте DeployedServicePackagesHealthStateFilter, чтобы при необходимости фильтровать дочерние элементы DeployedServicePackageHealth на основе состояния работоспособности. Используйте ApplicationHealthPolicy, чтобы при необходимости переопределить политики работоспособности, используемые для оценки работоспособности. Этот API использует только поле "ConsiderWarningAsError" приложения ApplicationHealthPolicy. Остальные поля игнорируются при оценке работоспособности развернутого приложения.

getDeployedApplicationHealthUsingPolicy(string, string, ServiceFabricClientGetDeployedApplicationHealthUsingPolicyOptionalParams, ServiceCallback<DeployedApplicationHealth>)
getDeployedApplicationInfo(string, string, ServiceCallback<DeployedApplicationInfo>)
getDeployedApplicationInfo(string, string, ServiceFabricClientGetDeployedApplicationInfoOptionalParams)

Этот запрос возвращает системные сведения о приложении, если идентификатор приложения указан для системного приложения. Результаты включают развернутые приложения в активных, активациях и скачивании состояний. Этот запрос требует, чтобы имя узла соответствовало узлу в кластере. Запрос завершается ошибкой, если предоставленное имя узла не указывает на активные узлы Service Fabric в кластере.

getDeployedApplicationInfo(string, string, ServiceFabricClientGetDeployedApplicationInfoOptionalParams, ServiceCallback<DeployedApplicationInfo>)
getDeployedApplicationInfoList(string, ServiceCallback<PagedDeployedApplicationInfoList>)
getDeployedApplicationInfoList(string, ServiceFabricClientGetDeployedApplicationInfoListOptionalParams)

Возвращает список приложений, развернутых на узле Service Fabric. Результаты не содержат сведения о развернутых системных приложениях, если явно не запрашиваются по идентификатору. Результаты включают развернутые приложения в активных, активациях и скачивании состояний. Этот запрос требует, чтобы имя узла соответствовало узлу в кластере. Запрос завершается ошибкой, если предоставленное имя узла не указывает на активные узлы Service Fabric в кластере.

getDeployedApplicationInfoList(string, ServiceFabricClientGetDeployedApplicationInfoListOptionalParams, ServiceCallback<PagedDeployedApplicationInfoList>)
getDeployedCodePackageInfoList(string, string, ServiceCallback<DeployedCodePackageInfo[]>)
getDeployedCodePackageInfoList(string, string, ServiceFabricClientGetDeployedCodePackageInfoListOptionalParams)

Возвращает список пакетов кода, развернутых на узле Service Fabric для данного приложения.

getDeployedCodePackageInfoList(string, string, ServiceFabricClientGetDeployedCodePackageInfoListOptionalParams, ServiceCallback<DeployedCodePackageInfo[]>)
getDeployedServicePackageHealth(string, string, string, ServiceCallback<DeployedServicePackageHealth>)
getDeployedServicePackageHealth(string, string, string, ServiceFabricClientGetDeployedServicePackageHealthOptionalParams)

Возвращает сведения о работоспособности пакета службы для конкретного приложения, развернутого на узле Service Fabric. Используйте EventsHealthStateFilter, чтобы при необходимости фильтровать коллекцию объектов HealthEvent, сообщаемых о развернутом пакете службы на основе состояния работоспособности.

getDeployedServicePackageHealth(string, string, string, ServiceFabricClientGetDeployedServicePackageHealthOptionalParams, ServiceCallback<DeployedServicePackageHealth>)
getDeployedServicePackageHealthUsingPolicy(string, string, string, ServiceCallback<DeployedServicePackageHealth>)
getDeployedServicePackageHealthUsingPolicy(string, string, string, ServiceFabricClientGetDeployedServicePackageHealthUsingPolicyOptionalParams)

Возвращает сведения о работоспособности пакета службы для конкретного приложения, развернутого на узле Service Fabric. с помощью указанной политики. Используйте EventsHealthStateFilter, чтобы при необходимости фильтровать коллекцию объектов HealthEvent, сообщаемых о развернутом пакете службы на основе состояния работоспособности. Используйте ApplicationHealthPolicy, чтобы при необходимости переопределить политики работоспособности, используемые для оценки работоспособности. Этот API использует только поле "ConsiderWarningAsError" приложения ApplicationHealthPolicy. Остальные поля игнорируются при оценке работоспособности развернутого пакета службы.

getDeployedServicePackageHealthUsingPolicy(string, string, string, ServiceFabricClientGetDeployedServicePackageHealthUsingPolicyOptionalParams, ServiceCallback<DeployedServicePackageHealth>)
getDeployedServicePackageInfoList(string, string, ServiceCallback<DeployedServicePackageInfo[]>)
getDeployedServicePackageInfoList(string, string, ServiceFabricClientGetDeployedServicePackageInfoListOptionalParams)

Возвращает сведения о пакетах служб, развернутых на узле Service Fabric для данного приложения.

getDeployedServicePackageInfoList(string, string, ServiceFabricClientGetDeployedServicePackageInfoListOptionalParams, ServiceCallback<DeployedServicePackageInfo[]>)
getDeployedServicePackageInfoListByName(string, string, string, ServiceCallback<DeployedServicePackageInfo[]>)
getDeployedServicePackageInfoListByName(string, string, string, ServiceFabricClientGetDeployedServicePackageInfoListByNameOptionalParams)

Возвращает сведения о пакетах служб, развернутых на узле Service Fabric для данного приложения. Эти результаты представляют собой пакеты служб, имя которых совпадает с именем пакета службы, указанным в качестве параметра.

getDeployedServicePackageInfoListByName(string, string, string, ServiceFabricClientGetDeployedServicePackageInfoListByNameOptionalParams, ServiceCallback<DeployedServicePackageInfo[]>)
getDeployedServiceReplicaDetailInfo(string, string, string, ServiceCallback<DeployedServiceReplicaDetailInfoUnion>)
getDeployedServiceReplicaDetailInfo(string, string, string, ServiceFabricClientGetDeployedServiceReplicaDetailInfoOptionalParams)

Возвращает сведения о реплике, развернутой на узле Service Fabric. Сведения включают тип службы, имя службы, текущую операцию службы, время начала текущей операции службы, идентификатор секции, идентификатор реплики и экземпляра, сообщаемую нагрузку и другие сведения.

getDeployedServiceReplicaDetailInfo(string, string, string, ServiceFabricClientGetDeployedServiceReplicaDetailInfoOptionalParams, ServiceCallback<DeployedServiceReplicaDetailInfoUnion>)
getDeployedServiceReplicaDetailInfoByPartitionId(string, string, ServiceCallback<DeployedServiceReplicaDetailInfoUnion>)
getDeployedServiceReplicaDetailInfoByPartitionId(string, string, ServiceFabricClientGetDeployedServiceReplicaDetailInfoByPartitionIdOptionalParams)

Возвращает сведения о реплике, развернутой на узле Service Fabric. Сведения включают тип службы, имя службы, текущую операцию службы, время начала текущей операции службы, идентификатор секции, идентификатор реплики и экземпляра, сообщаемую нагрузку и другие сведения.

getDeployedServiceReplicaDetailInfoByPartitionId(string, string, ServiceFabricClientGetDeployedServiceReplicaDetailInfoByPartitionIdOptionalParams, ServiceCallback<DeployedServiceReplicaDetailInfoUnion>)
getDeployedServiceReplicaInfoList(string, string, ServiceCallback<DeployedServiceReplicaInfoUnion[]>)
getDeployedServiceReplicaInfoList(string, string, ServiceFabricClientGetDeployedServiceReplicaInfoListOptionalParams)

Возвращает список, содержащий сведения о репликах, развернутых на узле Service Fabric. Сведения включают идентификатор секции, идентификатор реплики, состояние реплики, имя службы, имя типа службы и другие сведения. Используйте параметры запроса PartitionId или ServiceManifestName для возврата сведений о развернутых репликах, соответствующих указанным значениям этих параметров.

getDeployedServiceReplicaInfoList(string, string, ServiceFabricClientGetDeployedServiceReplicaInfoListOptionalParams, ServiceCallback<DeployedServiceReplicaInfoUnion[]>)
getDeployedServiceTypeInfoByName(string, string, string, ServiceCallback<DeployedServiceTypeInfo[]>)
getDeployedServiceTypeInfoByName(string, string, string, ServiceFabricClientGetDeployedServiceTypeInfoByNameOptionalParams)

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

getDeployedServiceTypeInfoByName(string, string, string, ServiceFabricClientGetDeployedServiceTypeInfoByNameOptionalParams, ServiceCallback<DeployedServiceTypeInfo[]>)
getDeployedServiceTypeInfoList(string, string, ServiceCallback<DeployedServiceTypeInfo[]>)
getDeployedServiceTypeInfoList(string, string, ServiceFabricClientGetDeployedServiceTypeInfoListOptionalParams)

Возвращает список, содержащий сведения о типах служб из приложений, развернутых на узле в кластере Service Fabric. Ответ содержит имя типа службы, его состояние регистрации, пакет кода, который зарегистрировал его и идентификатор активации пакета службы.

getDeployedServiceTypeInfoList(string, string, ServiceFabricClientGetDeployedServiceTypeInfoListOptionalParams, ServiceCallback<DeployedServiceTypeInfo[]>)
getFaultOperationList(number, number, ServiceCallback<OperationStatus[]>)
getFaultOperationList(number, number, ServiceFabricClientGetFaultOperationListOptionalParams)

Возвращает список операций сбоя, вызванных пользователем, отфильтрованных по предоставленным входным данным.

getFaultOperationList(number, number, ServiceFabricClientGetFaultOperationListOptionalParams, ServiceCallback<OperationStatus[]>)
getImageStoreContent(string, ServiceCallback<ImageStoreContent>)
getImageStoreContent(string, ServiceFabricClientGetImageStoreContentOptionalParams)

Возвращает сведения о содержимом хранилища изображений в указанном contentPath. ContentPath относится к корню хранилища образов.

getImageStoreContent(string, ServiceFabricClientGetImageStoreContentOptionalParams, ServiceCallback<ImageStoreContent>)
getImageStoreFolderSize(string, ServiceCallback<FolderSizeInfo>)
getImageStoreFolderSize(string, ServiceFabricClientGetImageStoreFolderSizeOptionalParams)

Возвращает общий размер файла в папке хранилища изображений, указанной contentPath. ContentPath относится к корню хранилища образов.

getImageStoreFolderSize(string, ServiceFabricClientGetImageStoreFolderSizeOptionalParams, ServiceCallback<FolderSizeInfo>)
getImageStoreInfo(ServiceCallback<ImageStoreInfo>)
getImageStoreInfo(ServiceFabricClientGetImageStoreInfoOptionalParams)

Возвращает сведения о первичной реплике ImageStore, такой как емкость диска и доступное место на узле, и несколько категорий использования файловой системы ImageStore.

getImageStoreInfo(ServiceFabricClientGetImageStoreInfoOptionalParams, ServiceCallback<ImageStoreInfo>)
getImageStoreRootContent(ServiceCallback<ImageStoreContent>)
getImageStoreRootContent(ServiceFabricClientGetImageStoreRootContentOptionalParams)

Возвращает сведения о содержимом хранилища изображений в корне хранилища образов.

getImageStoreRootContent(ServiceFabricClientGetImageStoreRootContentOptionalParams, ServiceCallback<ImageStoreContent>)
getImageStoreRootFolderSize(ServiceCallback<FolderSizeInfo>)
getImageStoreRootFolderSize(ServiceFabricClientGetImageStoreRootFolderSizeOptionalParams)

Возвращает общий размер файлов в корневой папке и дочерних папках в хранилище образов.

getImageStoreRootFolderSize(ServiceFabricClientGetImageStoreRootFolderSizeOptionalParams, ServiceCallback<FolderSizeInfo>)
getImageStoreUploadSessionById(string, ServiceCallback<UploadSession>)
getImageStoreUploadSessionById(string, ServiceFabricClientGetImageStoreUploadSessionByIdOptionalParams)

Возвращает сеанс отправки хранилища образов, определенный заданным идентификатором. Пользователь может запрашивать сеанс отправки в любое время во время отправки.

getImageStoreUploadSessionById(string, ServiceFabricClientGetImageStoreUploadSessionByIdOptionalParams, ServiceCallback<UploadSession>)
getImageStoreUploadSessionByPath(string, ServiceCallback<UploadSession>)
getImageStoreUploadSessionByPath(string, ServiceFabricClientGetImageStoreUploadSessionByPathOptionalParams)

Получает сеанс отправки хранилища образов, связанный с заданным относительным путем хранилища образов. Пользователь может запрашивать сеанс отправки в любое время во время отправки.

getImageStoreUploadSessionByPath(string, ServiceFabricClientGetImageStoreUploadSessionByPathOptionalParams, ServiceCallback<UploadSession>)
getNameExistsInfo(string, ServiceCallback<void>)
getNameExistsInfo(string, ServiceFabricClientGetNameExistsInfoOptionalParams)

Возвращает значение, существует ли указанное имя Service Fabric.

getNameExistsInfo(string, ServiceFabricClientGetNameExistsInfoOptionalParams, ServiceCallback<void>)
getNodeEventList(string, string, string, ServiceCallback<NodeEventUnion[]>)
getNodeEventList(string, string, string, ServiceFabricClientGetNodeEventListOptionalParams)

Ответ — это список объектов NodeEvent.

getNodeEventList(string, string, string, ServiceFabricClientGetNodeEventListOptionalParams, ServiceCallback<NodeEventUnion[]>)
getNodeHealth(string, ServiceCallback<NodeHealth>)
getNodeHealth(string, ServiceFabricClientGetNodeHealthOptionalParams)

Возвращает работоспособность узла Service Fabric. Используйте EventsHealthStateFilter, чтобы отфильтровать коллекцию событий работоспособности, сообщаемых на узле на основе состояния работоспособности. Если узел, указанный по имени, не существует в хранилище работоспособности, это возвращает ошибку.

getNodeHealth(string, ServiceFabricClientGetNodeHealthOptionalParams, ServiceCallback<NodeHealth>)
getNodeHealthUsingPolicy(string, ServiceCallback<NodeHealth>)
getNodeHealthUsingPolicy(string, ServiceFabricClientGetNodeHealthUsingPolicyOptionalParams)

Возвращает работоспособность узла Service Fabric. Используйте EventsHealthStateFilter, чтобы отфильтровать коллекцию событий работоспособности, сообщаемых на узле на основе состояния работоспособности. Используйте ClusterHealthPolicy в теле POST для переопределения политик работоспособности, используемых для оценки работоспособности. Если узел, указанный по имени, не существует в хранилище работоспособности, это возвращает ошибку.

getNodeHealthUsingPolicy(string, ServiceFabricClientGetNodeHealthUsingPolicyOptionalParams, ServiceCallback<NodeHealth>)
getNodeInfo(string, ServiceCallback<NodeInfo>)
getNodeInfo(string, ServiceFabricClientGetNodeInfoOptionalParams)

Ответ содержит имя, состояние, идентификатор, работоспособности, время простоя и другие сведения о узле.

getNodeInfo(string, ServiceFabricClientGetNodeInfoOptionalParams, ServiceCallback<NodeInfo>)
getNodeInfoList(ServiceCallback<PagedNodeInfoList>)
getNodeInfoList(ServiceFabricClientGetNodeInfoListOptionalParams)

Ответ содержит имя, состояние, идентификатор, работоспособности, время простоя и другие сведения о узлах.

getNodeInfoList(ServiceFabricClientGetNodeInfoListOptionalParams, ServiceCallback<PagedNodeInfoList>)
getNodeLoadInfo(string, ServiceCallback<NodeLoadInfo>)
getNodeLoadInfo(string, ServiceFabricClientGetNodeLoadInfoOptionalParams)

Извлекает сведения о загрузке узла Service Fabric для всех метрик, которые имеют определенную нагрузку или емкость.

getNodeLoadInfo(string, ServiceFabricClientGetNodeLoadInfoOptionalParams, ServiceCallback<NodeLoadInfo>)
getNodesEventList(string, string, ServiceCallback<NodeEventUnion[]>)
getNodesEventList(string, string, ServiceFabricClientGetNodesEventListOptionalParams)

Ответ — это список объектов NodeEvent.

getNodesEventList(string, string, ServiceFabricClientGetNodesEventListOptionalParams, ServiceCallback<NodeEventUnion[]>)
getNodeTransitionProgress(string, string, ServiceCallback<NodeTransitionProgress>)
getNodeTransitionProgress(string, string, ServiceFabricClientGetNodeTransitionProgressOptionalParams)

Возвращает ход выполнения операции, запущенной с StartNodeTransition, с помощью предоставленного operationId.

getNodeTransitionProgress(string, string, ServiceFabricClientGetNodeTransitionProgressOptionalParams, ServiceCallback<NodeTransitionProgress>)
getPartitionBackupConfigurationInfo(string, ServiceCallback<PartitionBackupConfigurationInfo>)
getPartitionBackupConfigurationInfo(string, ServiceFabricClientGetPartitionBackupConfigurationInfoOptionalParams)

Возвращает сведения о конфигурации резервного копирования Service Fabric для указанной секции.

getPartitionBackupConfigurationInfo(string, ServiceFabricClientGetPartitionBackupConfigurationInfoOptionalParams, ServiceCallback<PartitionBackupConfigurationInfo>)
getPartitionBackupList(string, ServiceCallback<PagedBackupInfoList>)
getPartitionBackupList(string, ServiceFabricClientGetPartitionBackupListOptionalParams)

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

getPartitionBackupList(string, ServiceFabricClientGetPartitionBackupListOptionalParams, ServiceCallback<PagedBackupInfoList>)
getPartitionBackupProgress(string, ServiceCallback<BackupProgressInfo>)
getPartitionBackupProgress(string, ServiceFabricClientGetPartitionBackupProgressOptionalParams)

Возвращает сведения о состоянии последней резервной копии вместе с подробными сведениями или причиной сбоя в случае завершения.

getPartitionBackupProgress(string, ServiceFabricClientGetPartitionBackupProgressOptionalParams, ServiceCallback<BackupProgressInfo>)
getPartitionEventList(string, string, string, ServiceCallback<PartitionEventUnion[]>)
getPartitionEventList(string, string, string, ServiceFabricClientGetPartitionEventListOptionalParams)

Ответ — это список объектов PartitionEvent.

getPartitionEventList(string, string, string, ServiceFabricClientGetPartitionEventListOptionalParams, ServiceCallback<PartitionEventUnion[]>)
getPartitionHealth(string, ServiceCallback<PartitionHealth>)
getPartitionHealth(string, ServiceFabricClientGetPartitionHealthOptionalParams)

Используйте EventsHealthStateFilter, чтобы отфильтровать коллекцию событий работоспособности, сообщаемых в службе на основе состояния работоспособности. Используйте ReplicasHealthStateFilter для фильтрации коллекции объектов ReplicaHealthState в разделе. Если указать секцию, которая не существует в хранилище работоспособности, этот запрос возвращает ошибку.

getPartitionHealth(string, ServiceFabricClientGetPartitionHealthOptionalParams, ServiceCallback<PartitionHealth>)
getPartitionHealthUsingPolicy(string, ServiceCallback<PartitionHealth>)
getPartitionHealthUsingPolicy(string, ServiceFabricClientGetPartitionHealthUsingPolicyOptionalParams)

Возвращает сведения о работоспособности указанной секции. Если указана политика работоспособности приложения, оценка работоспособности использует ее для получения агрегированного состояния работоспособности. Если политика не указана, оценка работоспособности использует политику работоспособности приложения, определенную в манифесте приложения, или политику работоспособности по умолчанию, если политика не определена в манифесте. Используйте EventsHealthStateFilter, чтобы отфильтровать коллекцию событий работоспособности, сообщаемых по разделу на основе состояния работоспособности. Используйте ReplicasHealthStateFilter для фильтрации коллекции объектов ReplicaHealthState в разделе. Используйте ApplicationHealthPolicy в теле POST для переопределения политик работоспособности, используемых для оценки работоспособности. Если указать секцию, которая не существует в хранилище работоспособности, этот запрос возвращает ошибку.

getPartitionHealthUsingPolicy(string, ServiceFabricClientGetPartitionHealthUsingPolicyOptionalParams, ServiceCallback<PartitionHealth>)
getPartitionInfo(string, ServiceCallback<ServicePartitionInfoUnion>)
getPartitionInfo(string, ServiceFabricClientGetPartitionInfoOptionalParams)

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

getPartitionInfo(string, ServiceFabricClientGetPartitionInfoOptionalParams, ServiceCallback<ServicePartitionInfoUnion>)
getPartitionInfoList(string, ServiceCallback<PagedServicePartitionInfoList>)
getPartitionInfoList(string, ServiceFabricClientGetPartitionInfoListOptionalParams)

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

getPartitionInfoList(string, ServiceFabricClientGetPartitionInfoListOptionalParams, ServiceCallback<PagedServicePartitionInfoList>)
getPartitionLoadInformation(string, ServiceCallback<PartitionLoadInformation>)
getPartitionLoadInformation(string, ServiceFabricClientGetPartitionLoadInformationOptionalParams)

Возвращает сведения о загрузке указанной секции. Ответ содержит список отчетов о нагрузке для раздела Service Fabric. Каждый отчет включает имя, значение и последнее время загрузки в формате UTC.

getPartitionLoadInformation(string, ServiceFabricClientGetPartitionLoadInformationOptionalParams, ServiceCallback<PartitionLoadInformation>)
getPartitionReplicaEventList(string, string, string, string, ServiceCallback<ReplicaEventUnion[]>)
getPartitionReplicaEventList(string, string, string, string, ServiceFabricClientGetPartitionReplicaEventListOptionalParams)

Ответ — это список объектов ReplicaEvent.

getPartitionReplicaEventList(string, string, string, string, ServiceFabricClientGetPartitionReplicaEventListOptionalParams, ServiceCallback<ReplicaEventUnion[]>)
getPartitionReplicasEventList(string, string, string, ServiceCallback<ReplicaEventUnion[]>)
getPartitionReplicasEventList(string, string, string, ServiceFabricClientGetPartitionReplicasEventListOptionalParams)

Ответ — это список объектов ReplicaEvent.

getPartitionReplicasEventList(string, string, string, ServiceFabricClientGetPartitionReplicasEventListOptionalParams, ServiceCallback<ReplicaEventUnion[]>)
getPartitionRestartProgress(string, string, string, ServiceCallback<PartitionRestartProgress>)
getPartitionRestartProgress(string, string, string, ServiceFabricClientGetPartitionRestartProgressOptionalParams)

Возвращает ход выполнения секционирования, запущенного с StartPartitionRestart с помощью предоставленного OperationId.

getPartitionRestartProgress(string, string, string, ServiceFabricClientGetPartitionRestartProgressOptionalParams, ServiceCallback<PartitionRestartProgress>)
getPartitionRestoreProgress(string, ServiceCallback<RestoreProgressInfo>)
getPartitionRestoreProgress(string, ServiceFabricClientGetPartitionRestoreProgressOptionalParams)

Возвращает сведения о состоянии последней операции восстановления вместе с подробными сведениями или причиной сбоя в случае завершения.

getPartitionRestoreProgress(string, ServiceFabricClientGetPartitionRestoreProgressOptionalParams, ServiceCallback<RestoreProgressInfo>)
getPartitionsEventList(string, string, ServiceCallback<PartitionEventUnion[]>)
getPartitionsEventList(string, string, ServiceFabricClientGetPartitionsEventListOptionalParams)

Ответ — это список объектов PartitionEvent.

getPartitionsEventList(string, string, ServiceFabricClientGetPartitionsEventListOptionalParams, ServiceCallback<PartitionEventUnion[]>)
getPropertyInfo(string, string, ServiceCallback<PropertyInfo>)
getPropertyInfo(string, string, ServiceFabricClientGetPropertyInfoOptionalParams)

Возвращает указанное свойство Service Fabric под заданным именем. Это всегда будет возвращать как значение, так и метаданные.

getPropertyInfo(string, string, ServiceFabricClientGetPropertyInfoOptionalParams, ServiceCallback<PropertyInfo>)
getPropertyInfoList(string, ServiceCallback<PagedPropertyInfoList>)
getPropertyInfoList(string, ServiceFabricClientGetPropertyInfoListOptionalParams)

Имя Service Fabric может содержать одно или несколько именованных свойств, в которых хранятся пользовательские сведения. Эта операция получает сведения об этих свойствах в списке страниц. Сведения включают имя, значение и метаданные о каждом из свойств.

getPropertyInfoList(string, ServiceFabricClientGetPropertyInfoListOptionalParams, ServiceCallback<PagedPropertyInfoList>)
getProvisionedFabricCodeVersionInfoList(ServiceCallback<FabricCodeVersionInfo[]>)
getProvisionedFabricCodeVersionInfoList(ServiceFabricClientGetProvisionedFabricCodeVersionInfoListOptionalParams)

Возвращает список сведений о версиях кода структуры, подготовленных в кластере. Параметр CodeVersion можно использовать для фильтрации выходных данных только в этой конкретной версии.

getProvisionedFabricCodeVersionInfoList(ServiceFabricClientGetProvisionedFabricCodeVersionInfoListOptionalParams, ServiceCallback<FabricCodeVersionInfo[]>)
getProvisionedFabricConfigVersionInfoList(ServiceCallback<FabricConfigVersionInfo[]>)
getProvisionedFabricConfigVersionInfoList(ServiceFabricClientGetProvisionedFabricConfigVersionInfoListOptionalParams)

Возвращает список сведений о версиях конфигурации структуры, подготовленных в кластере. Параметр ConfigVersion можно использовать для фильтрации выходных данных только в этой конкретной версии.

getProvisionedFabricConfigVersionInfoList(ServiceFabricClientGetProvisionedFabricConfigVersionInfoListOptionalParams, ServiceCallback<FabricConfigVersionInfo[]>)
getQuorumLossProgress(string, string, string, ServiceCallback<PartitionQuorumLossProgress>)
getQuorumLossProgress(string, string, string, ServiceFabricClientGetQuorumLossProgressOptionalParams)

Возвращает ход выполнения операции потери кворума, запущенной с StartQuorumLoss, используя предоставленный OperationId.

getQuorumLossProgress(string, string, string, ServiceFabricClientGetQuorumLossProgressOptionalParams, ServiceCallback<PartitionQuorumLossProgress>)
getRepairTaskList(ServiceCallback<RepairTask[]>)
getRepairTaskList(ServiceFabricClientGetRepairTaskListOptionalParams)

Этот API поддерживает платформу Service Fabric; Он не предназначен для использования непосредственно из кода.

getRepairTaskList(ServiceFabricClientGetRepairTaskListOptionalParams, ServiceCallback<RepairTask[]>)
getReplicaHealth(string, string, ServiceCallback<ReplicaHealthUnion>)
getReplicaHealth(string, string, ServiceFabricClientGetReplicaHealthOptionalParams)

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

getReplicaHealth(string, string, ServiceFabricClientGetReplicaHealthOptionalParams, ServiceCallback<ReplicaHealthUnion>)
getReplicaHealthUsingPolicy(string, string, ServiceCallback<ReplicaHealthUnion>)
getReplicaHealthUsingPolicy(string, string, ServiceFabricClientGetReplicaHealthUsingPolicyOptionalParams)

Возвращает работоспособность реплики службы с отслеживанием состояния Service Fabric или экземпляра службы без отслеживания состояния. Используйте EventsHealthStateFilter, чтобы отфильтровать коллекцию событий работоспособности, сообщаемых в кластере на основе состояния работоспособности. Используйте ApplicationHealthPolicy, чтобы при необходимости переопределить политики работоспособности, используемые для оценки работоспособности. Этот API использует только поле "ConsiderWarningAsError" приложения ApplicationHealthPolicy. Остальные поля игнорируются при оценке работоспособности реплики.

getReplicaHealthUsingPolicy(string, string, ServiceFabricClientGetReplicaHealthUsingPolicyOptionalParams, ServiceCallback<ReplicaHealthUnion>)
getReplicaInfo(string, string, ServiceCallback<ReplicaInfoUnion>)
getReplicaInfo(string, string, ServiceFabricClientGetReplicaInfoOptionalParams)

Ответ включает идентификатор, роль, состояние, состояние, имя узла, время ожидания и другие сведения о реплике.

getReplicaInfo(string, string, ServiceFabricClientGetReplicaInfoOptionalParams, ServiceCallback<ReplicaInfoUnion>)
getReplicaInfoList(string, ServiceCallback<PagedReplicaInfoList>)
getReplicaInfoList(string, ServiceFabricClientGetReplicaInfoListOptionalParams)

Конечная точка GetReplicas возвращает сведения о репликах указанной секции. Ответ включает идентификатор, роль, состояние, состояние, имя узла, время ожидания и другие сведения о реплике.

getReplicaInfoList(string, ServiceFabricClientGetReplicaInfoListOptionalParams, ServiceCallback<PagedReplicaInfoList>)
getServiceBackupConfigurationInfo(string, ServiceCallback<PagedBackupConfigurationInfoList>)
getServiceBackupConfigurationInfo(string, ServiceFabricClientGetServiceBackupConfigurationInfoOptionalParams)

Возвращает сведения о конфигурации резервного копирования Service Fabric для службы и секций в этой службе.

getServiceBackupConfigurationInfo(string, ServiceFabricClientGetServiceBackupConfigurationInfoOptionalParams, ServiceCallback<PagedBackupConfigurationInfoList>)
getServiceBackupList(string, ServiceCallback<PagedBackupInfoList>)
getServiceBackupList(string, ServiceFabricClientGetServiceBackupListOptionalParams)

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

getServiceBackupList(string, ServiceFabricClientGetServiceBackupListOptionalParams, ServiceCallback<PagedBackupInfoList>)
getServiceDescription(string, ServiceCallback<ServiceDescriptionUnion>)
getServiceDescription(string, ServiceFabricClientGetServiceDescriptionOptionalParams)

Возвращает описание существующей службы Service Fabric. Прежде чем его описание можно получить, необходимо создать службу.

getServiceDescription(string, ServiceFabricClientGetServiceDescriptionOptionalParams, ServiceCallback<ServiceDescriptionUnion>)
getServiceEventList(string, string, string, ServiceCallback<ServiceEventUnion[]>)
getServiceEventList(string, string, string, ServiceFabricClientGetServiceEventListOptionalParams)

Ответ — это список объектов ServiceEvent.

getServiceEventList(string, string, string, ServiceFabricClientGetServiceEventListOptionalParams, ServiceCallback<ServiceEventUnion[]>)
getServiceHealth(string, ServiceCallback<ServiceHealth>)
getServiceHealth(string, ServiceFabricClientGetServiceHealthOptionalParams)

Возвращает сведения о работоспособности указанной службы. Используйте EventsHealthStateFilter, чтобы отфильтровать коллекцию событий работоспособности, сообщаемых в службе на основе состояния работоспособности. Используйте PartitionsHealthStateFilter, чтобы отфильтровать коллекцию возвращаемых секций. Если указать службу, которая не существует в хранилище работоспособности, этот запрос возвращает ошибку.

getServiceHealth(string, ServiceFabricClientGetServiceHealthOptionalParams, ServiceCallback<ServiceHealth>)
getServiceHealthUsingPolicy(string, ServiceCallback<ServiceHealth>)
getServiceHealthUsingPolicy(string, ServiceFabricClientGetServiceHealthUsingPolicyOptionalParams)

Возвращает сведения о работоспособности указанной службы. Если указана политика работоспособности приложения, оценка работоспособности использует ее для получения агрегированного состояния работоспособности. Если политика не указана, оценка работоспособности использует политику работоспособности приложения, определенную в манифесте приложения, или политику работоспособности по умолчанию, если политика не определена в манифесте. Используйте EventsHealthStateFilter, чтобы отфильтровать коллекцию событий работоспособности, сообщаемых в службе на основе состояния работоспособности. Используйте PartitionsHealthStateFilter, чтобы отфильтровать коллекцию возвращаемых секций. Если указать службу, которая не существует в хранилище работоспособности, этот запрос возвращает ошибку.

getServiceHealthUsingPolicy(string, ServiceFabricClientGetServiceHealthUsingPolicyOptionalParams, ServiceCallback<ServiceHealth>)
getServiceInfo(string, string, ServiceCallback<ServiceInfoUnion>)
getServiceInfo(string, string, ServiceFabricClientGetServiceInfoOptionalParams)

Возвращает сведения о указанной службе, принадлежащей указанному приложению Service Fabric.

getServiceInfo(string, string, ServiceFabricClientGetServiceInfoOptionalParams, ServiceCallback<ServiceInfoUnion>)
getServiceInfoList(string, ServiceCallback<PagedServiceInfoList>)
getServiceInfoList(string, ServiceFabricClientGetServiceInfoListOptionalParams)

Возвращает сведения обо всех службах, принадлежащих приложению, указанному идентификатором приложения.

getServiceInfoList(string, ServiceFabricClientGetServiceInfoListOptionalParams, ServiceCallback<PagedServiceInfoList>)
getServiceManifest(string, string, string, ServiceCallback<ServiceTypeManifest>)
getServiceManifest(string, string, string, ServiceFabricClientGetServiceManifestOptionalParams)

Возвращает манифест, описывающий тип службы. Ответ содержит XML-код манифеста службы в виде строки.

getServiceManifest(string, string, string, ServiceFabricClientGetServiceManifestOptionalParams, ServiceCallback<ServiceTypeManifest>)
getServiceNameInfo(string, ServiceCallback<ServiceNameInfo>)
getServiceNameInfo(string, ServiceFabricClientGetServiceNameInfoOptionalParams)

Возвращает имя службы для указанной секции. Возвращается ошибка 404, если идентификатор секции не существует в кластере.

getServiceNameInfo(string, ServiceFabricClientGetServiceNameInfoOptionalParams, ServiceCallback<ServiceNameInfo>)
getServicesEventList(string, string, ServiceCallback<ServiceEventUnion[]>)
getServicesEventList(string, string, ServiceFabricClientGetServicesEventListOptionalParams)

Ответ — это список объектов ServiceEvent.

getServicesEventList(string, string, ServiceFabricClientGetServicesEventListOptionalParams, ServiceCallback<ServiceEventUnion[]>)
getServiceTypeInfoByName(string, string, string, ServiceCallback<ServiceTypeInfo>)
getServiceTypeInfoByName(string, string, string, ServiceFabricClientGetServiceTypeInfoByNameOptionalParams)

Возвращает сведения о конкретном типе службы, поддерживаемом подготовленным типом приложения в кластере Service Fabric. Указанный тип приложения должен существовать. В противном случае возвращается состояние 404. Ответ 204 возвращается, если указанный тип службы не найден в кластере.

getServiceTypeInfoByName(string, string, string, ServiceFabricClientGetServiceTypeInfoByNameOptionalParams, ServiceCallback<ServiceTypeInfo>)
getServiceTypeInfoList(string, string, ServiceCallback<ServiceTypeInfo[]>)
getServiceTypeInfoList(string, string, ServiceFabricClientGetServiceTypeInfoListOptionalParams)

Возвращает список, содержащий сведения о типах служб, поддерживаемых подготовленным типом приложения в кластере Service Fabric. Указанный тип приложения должен существовать. В противном случае возвращается состояние 404.

getServiceTypeInfoList(string, string, ServiceFabricClientGetServiceTypeInfoListOptionalParams, ServiceCallback<ServiceTypeInfo[]>)
getSubNameInfoList(string, ServiceCallback<PagedSubNameInfoList>)
getSubNameInfoList(string, ServiceFabricClientGetSubNameInfoListOptionalParams)

Перечисляет все имена Service Fabric под заданным именем. Если вложенные имена не помещаются на страницу, возвращается одна страница результатов, а также маркер продолжения, который можно использовать для получения следующей страницы. Запрос имени, который не существует, завершится ошибкой.

getSubNameInfoList(string, ServiceFabricClientGetSubNameInfoListOptionalParams, ServiceCallback<PagedSubNameInfoList>)
getUnplacedReplicaInformation(string, ServiceCallback<UnplacedReplicaInformation>)
getUnplacedReplicaInformation(string, ServiceFabricClientGetUnplacedReplicaInformationOptionalParams)

Возвращает сведения о неуправляемых репликах службы. Если параметр PartitionId указан, результат будет содержать сведения только о неуправляемых репликах для этой секции. Если PartitionId не указан, результат будет содержать сведения о незаместенных репликах для всех секций этой службы. Если для OnlyQueryPrimaries задано значение true, результат будет содержать сведения только о первичных репликах и будет игнорировать неуправляемые вторичные реплики.

getUnplacedReplicaInformation(string, ServiceFabricClientGetUnplacedReplicaInformationOptionalParams, ServiceCallback<UnplacedReplicaInformation>)
getUpgradeOrchestrationServiceState(ServiceCallback<UpgradeOrchestrationServiceState>)
getUpgradeOrchestrationServiceState(ServiceFabricClientGetUpgradeOrchestrationServiceStateOptionalParams)

Получите состояние службы service Fabric Upgrade Orchestration Service. Этот API используется во внутренней среде для поддержки.

getUpgradeOrchestrationServiceState(ServiceFabricClientGetUpgradeOrchestrationServiceStateOptionalParams, ServiceCallback<UpgradeOrchestrationServiceState>)
invokeContainerApi(string, string, string, string, string, ContainerApiRequestBody, ServiceCallback<ContainerApiResponse>)
invokeContainerApi(string, string, string, string, string, ContainerApiRequestBody, ServiceFabricClientInvokeContainerApiOptionalParams)

Вызов API контейнера в контейнере, развернутом на узле Service Fabric для данного пакета кода.

invokeContainerApi(string, string, string, string, string, ContainerApiRequestBody, ServiceFabricClientInvokeContainerApiOptionalParams, ServiceCallback<ContainerApiResponse>)
invokeInfrastructureCommand(string, ServiceCallback<string>)
invokeInfrastructureCommand(string, ServiceFabricClientInvokeInfrastructureCommandOptionalParams)

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

Доступные команды и соответствующие форматы ответов зависят от инфраструктуры, в которой выполняется кластер.

Этот API поддерживает платформу Service Fabric; Он не предназначен для использования непосредственно из кода.

invokeInfrastructureCommand(string, ServiceFabricClientInvokeInfrastructureCommandOptionalParams, ServiceCallback<string>)
invokeInfrastructureQuery(string, ServiceCallback<string>)
invokeInfrastructureQuery(string, ServiceFabricClientInvokeInfrastructureQueryOptionalParams)

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

Доступные команды и соответствующие форматы ответов зависят от инфраструктуры, в которой выполняется кластер.

Этот API поддерживает платформу Service Fabric; Он не предназначен для использования непосредственно из кода.

invokeInfrastructureQuery(string, ServiceFabricClientInvokeInfrastructureQueryOptionalParams, ServiceCallback<string>)
movePrimaryReplica(string, ServiceCallback<void>)
movePrimaryReplica(string, ServiceFabricClientMovePrimaryReplicaOptionalParams)

Эта команда перемещает основную реплику секции службы с отслеживанием состояния, учитывая все ограничения. Если задан параметр NodeName, первичный объект будет перемещен на указанный узел (если ограничения позволяют ему). Если параметр NodeName не указан, первичная реплика будет перемещена на случайный узел в кластере. Если параметр IgnoreConstraints указан и задано значение true, основной объект будет перемещен независимо от ограничений.

movePrimaryReplica(string, ServiceFabricClientMovePrimaryReplicaOptionalParams, ServiceCallback<void>)
moveSecondaryReplica(string, string, ServiceCallback<void>)
moveSecondaryReplica(string, string, ServiceFabricClientMoveSecondaryReplicaOptionalParams)

Эта команда перемещает вторичную реплику секции службы с отслеживанием состояния, уважая все ограничения. Для идентификации перемещаемой реплики необходимо указать параметр CurrentNodeName. Имя исходного узла должно быть указано, но новое имя узла может быть пропущено, и в этом случае реплика перемещается на случайный узел. Если параметр IgnoreConstraints указан и задано значение true, то вторичный будет перемещен независимо от ограничений.

moveSecondaryReplica(string, string, ServiceFabricClientMoveSecondaryReplicaOptionalParams, ServiceCallback<void>)
postChaosSchedule(ChaosScheduleDescription, ServiceCallback<void>)
postChaosSchedule(ChaosScheduleDescription, ServiceFabricClientPostChaosScheduleOptionalParams)

Хаос автоматически запланирует запуски на основе расписания хаоса. Расписание хаоса будет обновлено, если указанная версия соответствует версии на сервере. При обновлении расписания хаоса версия на сервере увеличивается на 1. Версия на сервере будет отключать до 0 после достижения большого числа. Если хаос выполняется при выполнении этого вызова, вызов завершится ошибкой.

postChaosSchedule(ChaosScheduleDescription, ServiceFabricClientPostChaosScheduleOptionalParams, ServiceCallback<void>)
provisionApplicationType(ProvisionApplicationTypeDescriptionBaseUnion, ServiceCallback<void>)
provisionApplicationType(ProvisionApplicationTypeDescriptionBaseUnion, ServiceFabricClientProvisionApplicationTypeOptionalParams)

Подготавливает тип приложения Service Fabric к кластеру. Подготовка требуется перед созданием экземпляров новых приложений. Операция подготовки может выполняться либо в пакете приложения, заданном относительнымPathInImageStore, либо с помощью URI внешнего sfpkg.

provisionApplicationType(ProvisionApplicationTypeDescriptionBaseUnion, ServiceFabricClientProvisionApplicationTypeOptionalParams, ServiceCallback<void>)
provisionCluster(ProvisionFabricDescription, ServiceCallback<void>)
provisionCluster(ProvisionFabricDescription, ServiceFabricClientProvisionClusterOptionalParams)

Проверьте и подготовьте код или пакеты конфигурации кластера Service Fabric.

provisionCluster(ProvisionFabricDescription, ServiceFabricClientProvisionClusterOptionalParams, ServiceCallback<void>)
putProperty(string, PropertyDescription, ServiceCallback<void>)
putProperty(string, PropertyDescription, ServiceFabricClientPutPropertyOptionalParams)

Создает или обновляет указанное свойство Service Fabric под заданным именем.

putProperty(string, PropertyDescription, ServiceFabricClientPutPropertyOptionalParams, ServiceCallback<void>)
recoverAllPartitions(ServiceCallback<void>)
recoverAllPartitions(ServiceFabricClientRecoverAllPartitionsOptionalParams)

Эта операция должна выполняться только в том случае, если известно, что реплики, которые находятся вниз, не могут быть восстановлены. Неправильное использование этого API может привести к потенциальной потере данных.

recoverAllPartitions(ServiceFabricClientRecoverAllPartitionsOptionalParams, ServiceCallback<void>)
recoverPartition(string, ServiceCallback<void>)
recoverPartition(string, ServiceFabricClientRecoverPartitionOptionalParams)

Эта операция должна выполняться только в том случае, если известно, что реплики, которые находятся вниз, не могут быть восстановлены. Неправильное использование этого API может привести к потенциальной потере данных.

recoverPartition(string, ServiceFabricClientRecoverPartitionOptionalParams, ServiceCallback<void>)
recoverServicePartitions(string, ServiceCallback<void>)
recoverServicePartitions(string, ServiceFabricClientRecoverServicePartitionsOptionalParams)

Указывает кластеру Service Fabric, что он должен попытаться восстановить указанную службу, которая в настоящее время зависла в потере кворума. Эта операция должна выполняться только в том случае, если известно, что реплики, которые находятся вниз, не могут быть восстановлены. Неправильное использование этого API может привести к потенциальной потере данных.

recoverServicePartitions(string, ServiceFabricClientRecoverServicePartitionsOptionalParams, ServiceCallback<void>)
recoverSystemPartitions(ServiceCallback<void>)
recoverSystemPartitions(ServiceFabricClientRecoverSystemPartitionsOptionalParams)

Указывает кластеру Service Fabric, что он должен попытаться восстановить системные службы, которые в настоящее время застряли в потере кворума. Эта операция должна выполняться только в том случае, если известно, что реплики, которые находятся вниз, не могут быть восстановлены. Неправильное использование этого API может привести к потенциальной потере данных.

recoverSystemPartitions(ServiceFabricClientRecoverSystemPartitionsOptionalParams, ServiceCallback<void>)
removeComposeDeployment(string, ServiceCallback<void>)
removeComposeDeployment(string, ServiceFabricClientRemoveComposeDeploymentOptionalParams)

Удаляет существующее развертывание Создания Service Fabric.

removeComposeDeployment(string, ServiceFabricClientRemoveComposeDeploymentOptionalParams, ServiceCallback<void>)
removeConfigurationOverrides(string, ServiceCallback<void>)
removeConfigurationOverrides(string, ServiceFabricClientRemoveConfigurationOverridesOptionalParams)

Этот API позволяет удалить все существующие переопределения конфигурации на указанном узле.

removeConfigurationOverrides(string, ServiceFabricClientRemoveConfigurationOverridesOptionalParams, ServiceCallback<void>)
removeNodeState(string, ServiceCallback<void>)
removeNodeState(string, ServiceFabricClientRemoveNodeStateOptionalParams)

Это означает, что восстановление сохраняемого состояния этого узла невозможно. Как правило, это происходит, если жесткий диск был очисткой или если жесткий диск завершается сбоем. Узел должен быть отключен, чтобы эта операция была успешной. Эта операция позволяет Service Fabric знать, что реплики на этом узле больше не существуют, и что Service Fabric должен перестать ожидать резервного копирования этих реплик. Не выполняйте этот командлет, если состояние на узле не было удалено, и узел может вернуться с его состоянием без изменений. Начиная с Service Fabric 6.5, чтобы использовать этот API для начальных узлов, измените начальные узлы на обычные (не начальные) узлы, а затем вызовите этот API, чтобы удалить состояние узла. Если кластер запущен в Azure, после перехода начального узла Service Fabric попытается автоматически изменить его на незатратовый узел. Чтобы это произошло, убедитесь, что количество узлов, отличных от начального значения, в типе первичного узла не меньше числа начальных узлов вниз. При необходимости добавьте дополнительные узлы в тип основного узла, чтобы добиться этого. Если автономному кластеру не ожидается резервное копирование с его состоянием, удалите узел из кластера, см. https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-cluster-windows-server-add-remove-nodes

removeNodeState(string, ServiceFabricClientRemoveNodeStateOptionalParams, ServiceCallback<void>)
removeReplica(string, string, string, ServiceCallback<void>)
removeReplica(string, string, string, ServiceFabricClientRemoveReplicaOptionalParams)

Этот API имитирует сбой реплики Service Fabric, удалив реплику из кластера Service Fabric. Удаление закрывает реплику, перемещает реплику на роль None, а затем удаляет все сведения о состоянии реплики из кластера. Этот API проверяет путь удаления состояния реплики и имитирует постоянный путь отчета через клиентские API. Предупреждение. При использовании этого API не выполняются проверки безопасности. Неправильное использование этого API может привести к потере данных для служб с отслеживанием состояния. Кроме того, флаг forceRemove влияет на все остальные реплики, размещенные в одном процессе.

removeReplica(string, string, string, ServiceFabricClientRemoveReplicaOptionalParams, ServiceCallback<void>)
reportApplicationHealth(string, HealthInformation, ServiceCallback<void>)
reportApplicationHealth(string, HealthInformation, ServiceFabricClientReportApplicationHealthOptionalParams)

Сообщает о состоянии работоспособности указанного приложения Service Fabric. Отчет должен содержать сведения о источнике отчета о работоспособности и свойстве, на котором он сообщается. Отчет отправляется в приложение шлюза Service Fabric, которое передается в хранилище работоспособности. Отчет может быть принят шлюзом, но отклонен хранилищем работоспособности после дополнительной проверки. Например, хранилище работоспособности может отклонить отчет из-за недопустимого параметра, например устаревший порядковый номер. Чтобы узнать, был ли отчет применен в хранилище работоспособности, получите работоспособность приложения и проверьте, отображается ли отчет в разделе HealthEvents.

reportApplicationHealth(string, HealthInformation, ServiceFabricClientReportApplicationHealthOptionalParams, ServiceCallback<void>)
reportClusterHealth(HealthInformation, ServiceCallback<void>)
reportClusterHealth(HealthInformation, ServiceFabricClientReportClusterHealthOptionalParams)

Отправляет отчет о работоспособности в кластере Service Fabric. Отчет должен содержать сведения о источнике отчета о работоспособности и свойстве, на котором он сообщается. Отчет отправляется на узел шлюза Service Fabric, который пересылается в хранилище работоспособности. Отчет может быть принят шлюзом, но отклонен хранилищем работоспособности после дополнительной проверки. Например, хранилище работоспособности может отклонить отчет из-за недопустимого параметра, например устаревший порядковый номер. Чтобы узнать, был ли отчет применен в хранилище работоспособности, запустите GetClusterHealth и убедитесь, что отчет отображается в разделе HealthEvents.

reportClusterHealth(HealthInformation, ServiceFabricClientReportClusterHealthOptionalParams, ServiceCallback<void>)
reportDeployedApplicationHealth(string, string, HealthInformation, ServiceCallback<void>)
reportDeployedApplicationHealth(string, string, HealthInformation, ServiceFabricClientReportDeployedApplicationHealthOptionalParams)

Сообщает о состоянии работоспособности приложения, развернутого на узле Service Fabric. Отчет должен содержать сведения о источнике отчета о работоспособности и свойстве, на котором он сообщается. Отчет отправляется в службу шлюза Service Fabric, которая пересылается в хранилище работоспособности. Отчет может быть принят шлюзом, но отклонен хранилищем работоспособности после дополнительной проверки. Например, хранилище работоспособности может отклонить отчет из-за недопустимого параметра, например устаревший порядковый номер. Чтобы узнать, был ли отчет применен в хранилище работоспособности, получите развернутое приложение работоспособности и убедитесь, что отчет отображается в разделе HealthEvents.

reportDeployedApplicationHealth(string, string, HealthInformation, ServiceFabricClientReportDeployedApplicationHealthOptionalParams, ServiceCallback<void>)
reportDeployedServicePackageHealth(string, string, string, HealthInformation, ServiceCallback<void>)
reportDeployedServicePackageHealth(string, string, string, HealthInformation, ServiceFabricClientReportDeployedServicePackageHealthOptionalParams)

Сообщает о состоянии работоспособности пакета службы приложения, развернутого на узле Service Fabric. Отчет должен содержать сведения о источнике отчета о работоспособности и свойстве, на котором он сообщается. Отчет отправляется в службу шлюза Service Fabric, которая пересылается в хранилище работоспособности. Отчет может быть принят шлюзом, но отклонен хранилищем работоспособности после дополнительной проверки. Например, хранилище работоспособности может отклонить отчет из-за недопустимого параметра, например устаревший порядковый номер. Чтобы узнать, был ли отчет применен в хранилище работоспособности, получите развернутый пакет службы работоспособности и проверьте, отображается ли отчет в разделе HealthEvents.

reportDeployedServicePackageHealth(string, string, string, HealthInformation, ServiceFabricClientReportDeployedServicePackageHealthOptionalParams, ServiceCallback<void>)
reportNodeHealth(string, HealthInformation, ServiceCallback<void>)
reportNodeHealth(string, HealthInformation, ServiceFabricClientReportNodeHealthOptionalParams)

Сообщает о состоянии работоспособности указанного узла Service Fabric. Отчет должен содержать сведения о источнике отчета о работоспособности и свойстве, на котором он сообщается. Отчет отправляется на узел шлюза Service Fabric, который пересылается в хранилище работоспособности. Отчет может быть принят шлюзом, но отклонен хранилищем работоспособности после дополнительной проверки. Например, хранилище работоспособности может отклонить отчет из-за недопустимого параметра, например устаревший порядковый номер. Чтобы узнать, был ли отчет применен в хранилище работоспособности, запустите GetNodeHealth и убедитесь, что отчет отображается в разделе HealthEvents.

reportNodeHealth(string, HealthInformation, ServiceFabricClientReportNodeHealthOptionalParams, ServiceCallback<void>)
reportPartitionHealth(string, HealthInformation, ServiceCallback<void>)
reportPartitionHealth(string, HealthInformation, ServiceFabricClientReportPartitionHealthOptionalParams)

Сообщает о состоянии работоспособности указанной секции Service Fabric. Отчет должен содержать сведения о источнике отчета о работоспособности и свойстве, на котором он сообщается. Отчет отправляется в раздел шлюза Service Fabric, который пересылается в хранилище работоспособности. Отчет может быть принят шлюзом, но отклонен хранилищем работоспособности после дополнительной проверки. Например, хранилище работоспособности может отклонить отчет из-за недопустимого параметра, например устаревший порядковый номер. Чтобы узнать, был ли отчет применен в хранилище работоспособности, запустите GetPartitionHealth и убедитесь, что отчет отображается в разделе HealthEvents.

reportPartitionHealth(string, HealthInformation, ServiceFabricClientReportPartitionHealthOptionalParams, ServiceCallback<void>)
reportReplicaHealth(string, string, ReplicaHealthReportServiceKind, HealthInformation, ServiceCallback<void>)
reportReplicaHealth(string, string, ReplicaHealthReportServiceKind, HealthInformation, ServiceFabricClientReportReplicaHealthOptionalParams)

Сообщает о состоянии работоспособности указанной реплики Service Fabric. Отчет должен содержать сведения о источнике отчета о работоспособности и свойстве, на котором он сообщается. Отчет отправляется в реплику шлюза Service Fabric, которая пересылается в хранилище работоспособности. Отчет может быть принят шлюзом, но отклонен хранилищем работоспособности после дополнительной проверки. Например, хранилище работоспособности может отклонить отчет из-за недопустимого параметра, например устаревший порядковый номер. Чтобы узнать, был ли отчет применен в хранилище работоспособности, запустите GetReplicaHealth и убедитесь, что отчет отображается в разделе HealthEvents.

reportReplicaHealth(string, string, ReplicaHealthReportServiceKind, HealthInformation, ServiceFabricClientReportReplicaHealthOptionalParams, ServiceCallback<void>)
reportServiceHealth(string, HealthInformation, ServiceCallback<void>)
reportServiceHealth(string, HealthInformation, ServiceFabricClientReportServiceHealthOptionalParams)

Сообщает о состоянии работоспособности указанной службы Service Fabric. Отчет должен содержать сведения о источнике отчета о работоспособности и свойстве, на котором он сообщается. Отчет отправляется в службу шлюза Service Fabric, которая пересылается в хранилище работоспособности. Отчет может быть принят шлюзом, но отклонен хранилищем работоспособности после дополнительной проверки. Например, хранилище работоспособности может отклонить отчет из-за недопустимого параметра, например устаревший порядковый номер. Чтобы узнать, был ли отчет применен в хранилище работоспособности, запустите GetServiceHealth и убедитесь, что отчет отображается в разделе HealthEvents.

reportServiceHealth(string, HealthInformation, ServiceFabricClientReportServiceHealthOptionalParams, ServiceCallback<void>)
resetPartitionLoad(string, ServiceCallback<void>)
resetPartitionLoad(string, ServiceFabricClientResetPartitionLoadOptionalParams)

Сбрасывает текущую нагрузку секции Service Fabric на загрузку по умолчанию для службы.

resetPartitionLoad(string, ServiceFabricClientResetPartitionLoadOptionalParams, ServiceCallback<void>)
resolveService(string, ServiceCallback<ResolvedServicePartition>)
resolveService(string, ServiceFabricClientResolveServiceOptionalParams)

Разрешите раздел службы Service Fabric, чтобы получить конечные точки реплик службы.

resolveService(string, ServiceFabricClientResolveServiceOptionalParams, ServiceCallback<ResolvedServicePartition>)
restartDeployedCodePackage(string, string, RestartDeployedCodePackageDescription, ServiceCallback<void>)
restartDeployedCodePackage(string, string, RestartDeployedCodePackageDescription, ServiceFabricClientRestartDeployedCodePackageOptionalParams)

Перезапуск пакета кода, развернутого на узле Service Fabric в кластере. Этот процесс прерывает процесс пакета кода, который перезагрузит все реплики службы пользователей, размещенные в этом процессе.

restartDeployedCodePackage(string, string, RestartDeployedCodePackageDescription, ServiceFabricClientRestartDeployedCodePackageOptionalParams, ServiceCallback<void>)
restartNode(string, RestartNodeDescription, ServiceCallback<void>)
restartNode(string, RestartNodeDescription, ServiceFabricClientRestartNodeOptionalParams)

Перезапускает узел кластера Service Fabric, который уже запущен.

restartNode(string, RestartNodeDescription, ServiceFabricClientRestartNodeOptionalParams, ServiceCallback<void>)
restartReplica(string, string, string, ServiceCallback<void>)
restartReplica(string, string, string, ServiceFabricClientRestartReplicaOptionalParams)

Перезапускает реплику службы сохраняемой службы, работающей на узле. Предупреждение. При использовании этого API не выполняются проверки безопасности. Неправильное использование этого API может привести к потере доступности для служб с отслеживанием состояния.

restartReplica(string, string, string, ServiceFabricClientRestartReplicaOptionalParams, ServiceCallback<void>)
restorePartition(string, RestorePartitionDescription, ServiceCallback<void>)
restorePartition(string, RestorePartitionDescription, ServiceFabricClientRestorePartitionOptionalParams)

Восстанавливает состояние сохраняемой секции с отслеживанием состояния с помощью указанной точки резервного копирования. Если секция уже периодически выполняется резервное копирование, то по умолчанию точка резервного копирования ищется в хранилище, указанном в политике резервного копирования. Можно также переопределить то же самое, указав сведения о хранилище резервных копий в рамках описания раздела восстановления в тексте. После запуска восстановления его ход выполнения можно отслеживать с помощью операции GetRestoreProgress. В случае ожидания операции укажите большее значение времени ожидания восстановления в параметре запроса.

restorePartition(string, RestorePartitionDescription, ServiceFabricClientRestorePartitionOptionalParams, ServiceCallback<void>)
resumeApplicationBackup(string, ServiceCallback<void>)
resumeApplicationBackup(string, ServiceFabricClientResumeApplicationBackupOptionalParams)

Ранее приостановленное приложение Service Fabric возобновляет периодическое резервное копирование в соответствии с политикой резервного копирования, настроенной в настоящее время для той же.

resumeApplicationBackup(string, ServiceFabricClientResumeApplicationBackupOptionalParams, ServiceCallback<void>)
resumeApplicationUpgrade(string, ResumeApplicationUpgradeDescription, ServiceCallback<void>)
resumeApplicationUpgrade(string, ResumeApplicationUpgradeDescription, ServiceFabricClientResumeApplicationUpgradeOptionalParams)

Возобновляет обновление приложения Service Fabric без мониторинга вручную. Service Fabric обновляет один домен обновления за раз. При немониторедных обновлениях вручную после завершения обновления Service Fabric ожидает вызова этого API, прежде чем переходить к следующему домену обновления.

resumeApplicationUpgrade(string, ResumeApplicationUpgradeDescription, ServiceFabricClientResumeApplicationUpgradeOptionalParams, ServiceCallback<void>)
resumeClusterUpgrade(ResumeClusterUpgradeDescription, ServiceCallback<void>)
resumeClusterUpgrade(ResumeClusterUpgradeDescription, ServiceFabricClientResumeClusterUpgradeOptionalParams)

При необходимости перейдите к следующему домену обновления кластера или конфигурации.

resumeClusterUpgrade(ResumeClusterUpgradeDescription, ServiceFabricClientResumeClusterUpgradeOptionalParams, ServiceCallback<void>)
resumePartitionBackup(string, ServiceCallback<void>)
resumePartitionBackup(string, ServiceFabricClientResumePartitionBackupOptionalParams)

Ранее приостановленная секция возобновляет периодическое резервное копирование в соответствии с политикой резервного копирования, настроенной в настоящее время для той же.

resumePartitionBackup(string, ServiceFabricClientResumePartitionBackupOptionalParams, ServiceCallback<void>)
resumeServiceBackup(string, ServiceCallback<void>)
resumeServiceBackup(string, ServiceFabricClientResumeServiceBackupOptionalParams)

Ранее приостановленная служба Service Fabric возобновляет периодическое резервное копирование в соответствии с политикой резервного копирования, настроенной в настоящее время для той же.

resumeServiceBackup(string, ServiceFabricClientResumeServiceBackupOptionalParams, ServiceCallback<void>)
rollbackApplicationUpgrade(string, ServiceCallback<void>)
rollbackApplicationUpgrade(string, ServiceFabricClientRollbackApplicationUpgradeOptionalParams)

Начинает откат текущего обновления приложения до предыдущей версии. Этот API можно использовать только для отката текущего обновления во время выполнения, который выполняется переход к новой версии. Если приложение в настоящее время не обновляется, используйте API StartApplicationUpgrade для обновления до требуемой версии, включая откат до предыдущей версии.

rollbackApplicationUpgrade(string, ServiceFabricClientRollbackApplicationUpgradeOptionalParams, ServiceCallback<void>)
rollbackClusterUpgrade(ServiceCallback<void>)
rollbackClusterUpgrade(ServiceFabricClientRollbackClusterUpgradeOptionalParams)

Откат кода или обновления конфигурации кластера Service Fabric.

rollbackClusterUpgrade(ServiceFabricClientRollbackClusterUpgradeOptionalParams, ServiceCallback<void>)
setUpgradeOrchestrationServiceState(UpgradeOrchestrationServiceState, ServiceCallback<UpgradeOrchestrationServiceStateSummary>)
setUpgradeOrchestrationServiceState(UpgradeOrchestrationServiceState, ServiceFabricClientSetUpgradeOrchestrationServiceStateOptionalParams)

Обновите состояние службы service Fabric Upgrade Orchestration Service. Этот API используется во внутренней среде для поддержки.

setUpgradeOrchestrationServiceState(UpgradeOrchestrationServiceState, ServiceFabricClientSetUpgradeOrchestrationServiceStateOptionalParams, ServiceCallback<UpgradeOrchestrationServiceStateSummary>)
startApplicationUpgrade(string, ApplicationUpgradeDescription, ServiceCallback<void>)
startApplicationUpgrade(string, ApplicationUpgradeDescription, ServiceFabricClientStartApplicationUpgradeOptionalParams)

Проверяет указанные параметры обновления приложения и начинает обновление приложения, если параметры допустимы.

startApplicationUpgrade(string, ApplicationUpgradeDescription, ServiceFabricClientStartApplicationUpgradeOptionalParams, ServiceCallback<void>)
startChaos(ChaosParameters, ServiceCallback<void>)
startChaos(ChaosParameters, ServiceFabricClientStartChaosOptionalParams)

Если хаос еще не запущен в кластере, он запускает Chaos с переданными параметрами Chaos. Если хаос уже выполняется при выполнении этого вызова, вызов завершается сбоем с кодом ошибки FABRIC_E_CHAOS_ALREADY_RUNNING. Дополнительные сведения см. в статье "Вызвать управляемый хаос" в кластерах Service Fabric.

startChaos(ChaosParameters, ServiceFabricClientStartChaosOptionalParams, ServiceCallback<void>)
startClusterConfigurationUpgrade(ClusterConfigurationUpgradeDescription, ServiceCallback<void>)
startClusterConfigurationUpgrade(ClusterConfigurationUpgradeDescription, ServiceFabricClientStartClusterConfigurationUpgradeOptionalParams)

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

startClusterConfigurationUpgrade(ClusterConfigurationUpgradeDescription, ServiceFabricClientStartClusterConfigurationUpgradeOptionalParams, ServiceCallback<void>)
startClusterUpgrade(StartClusterUpgradeDescription, ServiceCallback<void>)
startClusterUpgrade(StartClusterUpgradeDescription, ServiceFabricClientStartClusterUpgradeOptionalParams)

Проверьте указанные параметры обновления и запустите обновление кода или версии конфигурации кластера Service Fabric, если параметры допустимы.

startClusterUpgrade(StartClusterUpgradeDescription, ServiceFabricClientStartClusterUpgradeOptionalParams, ServiceCallback<void>)
startComposeDeploymentUpgrade(string, ComposeDeploymentUpgradeDescription, ServiceCallback<void>)
startComposeDeploymentUpgrade(string, ComposeDeploymentUpgradeDescription, ServiceFabricClientStartComposeDeploymentUpgradeOptionalParams)

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

startComposeDeploymentUpgrade(string, ComposeDeploymentUpgradeDescription, ServiceFabricClientStartComposeDeploymentUpgradeOptionalParams, ServiceCallback<void>)
startDataLoss(string, string, string, DataLossMode, ServiceCallback<void>)
startDataLoss(string, string, string, DataLossMode, ServiceFabricClientStartDataLossOptionalParams)

Этот API вызывает потерю данных для указанной секции. Он активирует вызов API OnDataLoss секции. Фактическая потеря данных зависит от указанного DataLossMode.

  • PartialDataLoss — удаляется только кворум реплик, и для секции активируется OnDataLoss, но фактическая потеря данных зависит от наличия репликации во время выполнения.
  • FullDataLoss — все реплики удаляются, поэтому все данные будут потеряны и активируются OnDataLoss.

Этот API должен вызываться только с помощью службы с отслеживанием состояния в качестве целевого объекта.

Вызов этого API с системной службой в качестве целевого объекта не рекомендуется.

Примечание. После вызова этого API его нельзя отменить. Вызов CancelOperation приведет только к остановке выполнения и очистке внутреннего состояния системы. Он не восстановит данные, если команда выполнена достаточно далеко, чтобы привести к потере данных.

Вызовите API GetDataLossProgress с тем же идентификатором operationId, чтобы вернуть сведения об операции, запущенной с этого API.

startDataLoss(string, string, string, DataLossMode, ServiceFabricClientStartDataLossOptionalParams, ServiceCallback<void>)
startNodeTransition(string, string, NodeTransitionType, string, number, ServiceCallback<void>)
startNodeTransition(string, string, NodeTransitionType, string, number, ServiceFabricClientStartNodeTransitionOptionalParams)

Запускает или останавливает узел кластера. Узел кластера — это процесс, а не сам экземпляр ОС. Чтобы запустить узел, передайте "Пуск" для параметра NodeTransitionType. Чтобы остановить узел, передайте значение Stop для параметра NodeTransitionType. Этот API запускает операцию— когда API возвращает узел, возможно, еще не завершил переход. Вызовите GetNodeTransitionProgress с тем же идентификатором operationId, чтобы получить ход выполнения операции.

startNodeTransition(string, string, NodeTransitionType, string, number, ServiceFabricClientStartNodeTransitionOptionalParams, ServiceCallback<void>)
startPartitionRestart(string, string, string, RestartPartitionMode, ServiceCallback<void>)
startPartitionRestart(string, string, string, RestartPartitionMode, ServiceFabricClientStartPartitionRestartOptionalParams)

Этот API полезен для тестирования отработки отказа.

Если используется для целевой секции службы без отслеживания состояния, перезапускPartitionMode должен иметь значение AllReplicasOrInstances.

Вызовите API GetPartitionRestartProgress, используя тот же идентификатор OperationId, чтобы получить ход выполнения.

startPartitionRestart(string, string, string, RestartPartitionMode, ServiceFabricClientStartPartitionRestartOptionalParams, ServiceCallback<void>)
startQuorumLoss(string, string, string, QuorumLossMode, number, ServiceCallback<void>)
startQuorumLoss(string, string, string, QuorumLossMode, number, ServiceFabricClientStartQuorumLossOptionalParams)

Этот API полезен для временной ситуации потери кворума в службе.

Вызовите API GetQuorumLossProgress с тем же идентификатором OperationId, чтобы вернуть сведения об операции, запущенной с этим API.

Это можно вызвать только для сохраненных служб с отслеживанием состояния (HasPersistedState=true). Не используйте этот API в службах без отслеживания состояния или только службах с отслеживанием состояния в памяти.

startQuorumLoss(string, string, string, QuorumLossMode, number, ServiceFabricClientStartQuorumLossOptionalParams, ServiceCallback<void>)
startRollbackComposeDeploymentUpgrade(string, ServiceCallback<void>)
startRollbackComposeDeploymentUpgrade(string, ServiceFabricClientStartRollbackComposeDeploymentUpgradeOptionalParams)

Откат обновления развертывания Service Fabric.

startRollbackComposeDeploymentUpgrade(string, ServiceFabricClientStartRollbackComposeDeploymentUpgradeOptionalParams, ServiceCallback<void>)
stopChaos(ServiceCallback<void>)
stopChaos(ServiceFabricClientStopChaosOptionalParams)

Останавливает Хаос от выполнения новых ошибок. Ошибки во время полета будут продолжать выполняться до тех пор, пока они не будут завершены. Текущее расписание хаоса помещается в остановленное состояние. После остановки расписания он будет оставаться в остановленном состоянии и не будет использоваться для создания расписания хаоса новых запусков Хаоса. Для возобновления планирования необходимо задать новое расписание хаоса.

stopChaos(ServiceFabricClientStopChaosOptionalParams, ServiceCallback<void>)
submitPropertyBatch(string, PropertyBatchDescriptionList, ServiceCallback<PropertyBatchInfoUnion>)
submitPropertyBatch(string, PropertyBatchDescriptionList, ServiceFabricClientSubmitPropertyBatchOptionalParams)

Отправляет пакет операций свойств. Все или ни одна из операций не будет зафиксирована.

submitPropertyBatch(string, PropertyBatchDescriptionList, ServiceFabricClientSubmitPropertyBatchOptionalParams, ServiceCallback<PropertyBatchInfoUnion>)
suspendApplicationBackup(string, ServiceCallback<void>)
suspendApplicationBackup(string, ServiceFabricClientSuspendApplicationBackupOptionalParams)

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

suspendApplicationBackup(string, ServiceFabricClientSuspendApplicationBackupOptionalParams, ServiceCallback<void>)
suspendPartitionBackup(string, ServiceCallback<void>)
suspendPartitionBackup(string, ServiceFabricClientSuspendPartitionBackupOptionalParams)

Секция, настроенная для периодического резервного копирования, приостановлена для получения дополнительных резервных копий до возобновления.

suspendPartitionBackup(string, ServiceFabricClientSuspendPartitionBackupOptionalParams, ServiceCallback<void>)
suspendServiceBackup(string, ServiceCallback<void>)
suspendServiceBackup(string, ServiceFabricClientSuspendServiceBackupOptionalParams)

Служба, настроенная для периодического резервного копирования, приостановлена для получения дополнительных резервных копий до возобновления работы. Эта операция применяется ко всей иерархии службы. Это означает, что все секции в этой службе теперь приостановлены для резервного копирования.

suspendServiceBackup(string, ServiceFabricClientSuspendServiceBackupOptionalParams, ServiceCallback<void>)
toggleVerboseServicePlacementHealthReporting(boolean, ServiceCallback<void>)
toggleVerboseServicePlacementHealthReporting(boolean, ServiceFabricClientToggleVerboseServicePlacementHealthReportingOptionalParams)

Если задано значение true, то подробные отчеты о работоспособности создаются, когда реплики не могут быть помещены или удалены. Если для детализации задано значение false, то отчеты о работоспособности не будут создаваться, когда реплики не могут быть размещены или удалены.

toggleVerboseServicePlacementHealthReporting(boolean, ServiceFabricClientToggleVerboseServicePlacementHealthReportingOptionalParams, ServiceCallback<void>)
unprovisionApplicationType(string, UnprovisionApplicationTypeDescriptionInfo, ServiceCallback<void>)
unprovisionApplicationType(string, UnprovisionApplicationTypeDescriptionInfo, ServiceFabricClientUnprovisionApplicationTypeOptionalParams)

Эту операцию можно выполнить только в том случае, если все экземпляры приложения типа приложения были удалены. После отмены регистрации типа приложения новые экземпляры приложений не могут быть созданы для этого конкретного типа приложения.

unprovisionApplicationType(string, UnprovisionApplicationTypeDescriptionInfo, ServiceFabricClientUnprovisionApplicationTypeOptionalParams, ServiceCallback<void>)
unprovisionCluster(UnprovisionFabricDescription, ServiceCallback<void>)
unprovisionCluster(UnprovisionFabricDescription, ServiceFabricClientUnprovisionClusterOptionalParams)

Она поддерживается для отмены подготовки кода и конфигурации отдельно.

unprovisionCluster(UnprovisionFabricDescription, ServiceFabricClientUnprovisionClusterOptionalParams, ServiceCallback<void>)
updateApplicationUpgrade(string, ApplicationUpgradeUpdateDescription, ServiceCallback<void>)
updateApplicationUpgrade(string, ApplicationUpgradeUpdateDescription, ServiceFabricClientUpdateApplicationUpgradeOptionalParams)

Обновляет параметры текущего обновления приложения, указанные во время запуска обновления приложения. Это может потребоваться для устранения зависнутых обновлений приложений из-за неправильных параметров или проблем в приложении для выполнения выполнения.

updateApplicationUpgrade(string, ApplicationUpgradeUpdateDescription, ServiceFabricClientUpdateApplicationUpgradeOptionalParams, ServiceCallback<void>)
updateBackupPolicy(BackupPolicyDescription, string, ServiceCallback<void>)
updateBackupPolicy(BackupPolicyDescription, string, ServiceFabricClientUpdateBackupPolicyOptionalParams)

Обновляет политику резервного копирования, определяемую {backupPolicyName}

updateBackupPolicy(BackupPolicyDescription, string, ServiceFabricClientUpdateBackupPolicyOptionalParams, ServiceCallback<void>)
updateClusterUpgrade(UpdateClusterUpgradeDescription, ServiceCallback<void>)
updateClusterUpgrade(UpdateClusterUpgradeDescription, ServiceFabricClientUpdateClusterUpgradeOptionalParams)

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

updateClusterUpgrade(UpdateClusterUpgradeDescription, ServiceFabricClientUpdateClusterUpgradeOptionalParams, ServiceCallback<void>)
updateRepairExecutionState(RepairTask, RequestOptionsBase)

Этот API поддерживает платформу Service Fabric; Он не предназначен для использования непосредственно из кода.

updateRepairExecutionState(RepairTask, RequestOptionsBase, ServiceCallback<RepairTaskUpdateInfo>)
updateRepairExecutionState(RepairTask, ServiceCallback<RepairTaskUpdateInfo>)
updateRepairTaskHealthPolicy(RepairTaskUpdateHealthPolicyDescription, RequestOptionsBase)

Этот API поддерживает платформу Service Fabric; Он не предназначен для использования непосредственно из кода.

updateRepairTaskHealthPolicy(RepairTaskUpdateHealthPolicyDescription, RequestOptionsBase, ServiceCallback<RepairTaskUpdateInfo>)
updateRepairTaskHealthPolicy(RepairTaskUpdateHealthPolicyDescription, ServiceCallback<RepairTaskUpdateInfo>)
updateService(string, ServiceUpdateDescriptionUnion, ServiceCallback<void>)
updateService(string, ServiceUpdateDescriptionUnion, ServiceFabricClientUpdateServiceOptionalParams)

Этот API позволяет обновлять свойства запущенной службы Service Fabric. Набор свойств, которые можно обновить, — это подмножество свойств, указанных во время создания службы. Текущий набор свойств можно получить с помощью API GetServiceDescription. Обратите внимание, что обновление свойств запущенной службы отличается от обновления приложения с помощью API StartApplicationUpgrade. Обновление — это длительная фоновая операция, которая включает перемещение приложения из одной версии в другую, один домен обновления за раз, а обновление применяет новые свойства немедленно к службе.

updateService(string, ServiceUpdateDescriptionUnion, ServiceFabricClientUpdateServiceOptionalParams, ServiceCallback<void>)
uploadFile(string, ServiceCallback<void>)
uploadFile(string, ServiceFabricClientUploadFileOptionalParams)

Отправляет содержимое файла в хранилище образов. Используйте этот API, если файл достаточно мал, чтобы отправить еще раз, если подключение завершается ошибкой. Данные файла необходимо добавить в текст запроса. Содержимое будет отправлено в указанный путь. Служба хранилища изображений использует файл метки для указания доступности папки. Файл метки — пустой файл с именем _.dir. Файл метки создается службой хранилища образов при отправке всех файлов в папку. При использовании подхода "Файл по файлам" для отправки пакета приложения в REST служба хранилища образов не знает о иерархии файлов пакета приложения; Необходимо создать файл пометки для каждой папки и отправить его последнее, чтобы сообщить службе хранилища образов, что папка завершена.

uploadFile(string, ServiceFabricClientUploadFileOptionalParams, ServiceCallback<void>)
uploadFileChunk(string, string, string, ServiceCallback<void>)
uploadFileChunk(string, string, string, ServiceFabricClientUploadFileChunkOptionalParams)

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

Чтобы выполнить повторную отправку файлов, пользователю необходимо разбить файл на несколько блоков и отправить эти блоки в хранилище образов по одному. Блоки не нужно отправлять по порядку. Если файл, представленный относительным путем хранилища образов, уже существует, он будет перезаписан при фиксации сеанса отправки.

uploadFileChunk(string, string, string, ServiceFabricClientUploadFileChunkOptionalParams, ServiceCallback<void>)

Наследуемые методы

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

Отправьте HTTP-запрос, заполненный с помощью предоставленной операцииSpec.

sendRequest(RequestPrepareOptions | WebResourceLike)

Отправьте предоставленный httpRequest.

Сведения о конструкторе

ServiceFabricClient(ServiceFabricClientOptions)

Инициализирует новый экземпляр класса ServiceFabricClient.

new ServiceFabricClient(options?: ServiceFabricClientOptions)

Параметры

options
ServiceFabricClientOptions

Параметры параметра

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

meshApplication

meshApplication: MeshApplication

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

meshCodePackage

meshCodePackage: MeshCodePackage

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

meshGateway

meshGateway: MeshGateway

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

meshNetwork

meshNetwork: MeshNetwork

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

meshSecret

meshSecret: MeshSecret

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

meshSecretValue

meshSecretValue: MeshSecretValue

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

meshService

meshService: MeshService

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

meshServiceReplica

meshServiceReplica: MeshServiceReplica

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

meshVolume

meshVolume: MeshVolume

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

Сведения о методе

addConfigurationParameterOverrides(string, ConfigParameterOverride[], ServiceCallback<void>)

function addConfigurationParameterOverrides(nodeName: string, configParameterOverrideList: ConfigParameterOverride[], callback: ServiceCallback<void>)

Параметры

nodeName

string

Имя узла.

configParameterOverrideList

ConfigParameterOverride[]

Описание добавления списка переопределения конфигурации.

callback

ServiceCallback<void>

Обратный вызов

addConfigurationParameterOverrides(string, ConfigParameterOverride[], ServiceFabricClientAddConfigurationParameterOverridesOptionalParams)

Этот API позволяет добавлять все существующие переопределения конфигурации на указанном узле.

function addConfigurationParameterOverrides(nodeName: string, configParameterOverrideList: ConfigParameterOverride[], options?: ServiceFabricClientAddConfigurationParameterOverridesOptionalParams): Promise<RestResponse>

Параметры

nodeName

string

Имя узла.

configParameterOverrideList

ConfigParameterOverride[]

Описание добавления списка переопределения конфигурации.

options
ServiceFabricClientAddConfigurationParameterOverridesOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

addConfigurationParameterOverrides(string, ConfigParameterOverride[], ServiceFabricClientAddConfigurationParameterOverridesOptionalParams, ServiceCallback<void>)

function addConfigurationParameterOverrides(nodeName: string, configParameterOverrideList: ConfigParameterOverride[], options: ServiceFabricClientAddConfigurationParameterOverridesOptionalParams, callback: ServiceCallback<void>)

Параметры

nodeName

string

Имя узла.

configParameterOverrideList

ConfigParameterOverride[]

Описание добавления списка переопределения конфигурации.

options
ServiceFabricClientAddConfigurationParameterOverridesOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

backupPartition(string, ServiceCallback<void>)

function backupPartition(partitionId: string, callback: ServiceCallback<void>)

Параметры

partitionId

string

Удостоверение секции.

callback

ServiceCallback<void>

Обратный вызов

backupPartition(string, ServiceFabricClientBackupPartitionOptionalParams)

Создает резервную копию состояния сохраняемого раздела с отслеживанием состояния. Если секции уже периодически создаются резервные копии, по умолчанию создается новая резервная копия в том же хранилище резервных копий. Можно также переопределить то же самое, указав сведения о хранилище резервных копий в составе текста запроса. После запуска резервной копии его ход выполнения можно отслеживать с помощью операции GetBackupProgress. В случае ожидания операции укажите большее значение времени ожидания резервного копирования в параметре запроса.

function backupPartition(partitionId: string, options?: ServiceFabricClientBackupPartitionOptionalParams): Promise<RestResponse>

Параметры

partitionId

string

Удостоверение секции.

options
ServiceFabricClientBackupPartitionOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

backupPartition(string, ServiceFabricClientBackupPartitionOptionalParams, ServiceCallback<void>)

function backupPartition(partitionId: string, options: ServiceFabricClientBackupPartitionOptionalParams, callback: ServiceCallback<void>)

Параметры

partitionId

string

Удостоверение секции.

options
ServiceFabricClientBackupPartitionOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

cancelOperation(string, boolean, ServiceCallback<void>)

function cancelOperation(operationId: string, force: boolean, callback: ServiceCallback<void>)

Параметры

operationId

string

ИДЕНТИФИКАТОР GUID, определяющий вызов этого API. Это передается в соответствующий API GetProgress

force

boolean

Указывает, следует ли корректно откатить и очистить внутреннее состояние системы, измененное путем выполнения операции, вызываемой пользователем.

callback

ServiceCallback<void>

Обратный вызов

cancelOperation(string, boolean, ServiceFabricClientCancelOperationOptionalParams)

Следующие API запускают операции сбоя, которые могут быть отменены с помощью CancelOperation: StartDataLoss, StartQuorumLoss, StartPartitionRestart, StartNodeTransition.

Если принудительное значение равно false, то указанная пользовательская операция будет корректно остановлена и очищена. Если принудительно задано значение true, команда будет прервана, а некоторые внутренние состояния могут быть оставлены позади. Указание принудительного значения true должно использоваться с осторожностью. Вызов этого API с значением true не допускается, пока этот API еще не был вызван в той же тестовой команде с принудительной настройкой значение false первым или если у тестовой команды уже есть OperationState.RollingBack. Уточнение: OperationState.RollingBack означает, что система будет или очищает внутреннее состояние системы, вызванное выполнением команды. Он не восстановит данные, если тестовая команда была причиной потери данных. Например, при вызове StartDataLoss вызовите этот API, система будет очищать только внутреннее состояние от выполнения команды. Он не восстановит данные целевой секции, если команда выполняется достаточно далеко, чтобы привести к потере данных.

Важно отметить: если этот API вызывается с помощью force==true, внутреннее состояние может остаться позади.

function cancelOperation(operationId: string, force: boolean, options?: ServiceFabricClientCancelOperationOptionalParams): Promise<RestResponse>

Параметры

operationId

string

ИДЕНТИФИКАТОР GUID, определяющий вызов этого API. Это передается в соответствующий API GetProgress

force

boolean

Указывает, следует ли корректно откатить и очистить внутреннее состояние системы, измененное путем выполнения операции, вызываемой пользователем.

options
ServiceFabricClientCancelOperationOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

cancelOperation(string, boolean, ServiceFabricClientCancelOperationOptionalParams, ServiceCallback<void>)

function cancelOperation(operationId: string, force: boolean, options: ServiceFabricClientCancelOperationOptionalParams, callback: ServiceCallback<void>)

Параметры

operationId

string

ИДЕНТИФИКАТОР GUID, определяющий вызов этого API. Это передается в соответствующий API GetProgress

force

boolean

Указывает, следует ли корректно откатить и очистить внутреннее состояние системы, измененное путем выполнения операции, вызываемой пользователем.

options
ServiceFabricClientCancelOperationOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

cancelRepairTask(RepairTaskCancelDescription, RequestOptionsBase)

Этот API поддерживает платформу Service Fabric; Он не предназначен для использования непосредственно из кода.

function cancelRepairTask(repairTaskCancelDescription: RepairTaskCancelDescription, options?: RequestOptionsBase): Promise<CancelRepairTaskResponse>

Параметры

repairTaskCancelDescription
RepairTaskCancelDescription

Описывает задачу восстановления для отмены.

options
RequestOptionsBase

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

Возвращаемое значение

Обещание<Models.CancelRepairTaskResponse>

cancelRepairTask(RepairTaskCancelDescription, RequestOptionsBase, ServiceCallback<RepairTaskUpdateInfo>)

function cancelRepairTask(repairTaskCancelDescription: RepairTaskCancelDescription, options: RequestOptionsBase, callback: ServiceCallback<RepairTaskUpdateInfo>)

Параметры

repairTaskCancelDescription
RepairTaskCancelDescription

Описывает задачу восстановления для отмены.

options
RequestOptionsBase

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

callback

ServiceCallback<RepairTaskUpdateInfo>

Обратный вызов

cancelRepairTask(RepairTaskCancelDescription, ServiceCallback<RepairTaskUpdateInfo>)

function cancelRepairTask(repairTaskCancelDescription: RepairTaskCancelDescription, callback: ServiceCallback<RepairTaskUpdateInfo>)

Параметры

repairTaskCancelDescription
RepairTaskCancelDescription

Описывает задачу восстановления для отмены.

callback

ServiceCallback<RepairTaskUpdateInfo>

Обратный вызов

commitImageStoreUploadSession(string, ServiceCallback<void>)

function commitImageStoreUploadSession(sessionId: string, callback: ServiceCallback<void>)

Параметры

sessionId

string

GUID, созданный пользователем для отправки файла. Он определяет сеанс отправки хранилища образов, который отслеживает все блоки файлов, пока не будет зафиксировано.

callback

ServiceCallback<void>

Обратный вызов

commitImageStoreUploadSession(string, ServiceFabricClientCommitImageStoreUploadSessionOptionalParams)

Когда все блоки файлов были отправлены, сеанс отправки должен быть зафиксирован явным образом для завершения отправки. Хранилище образов сохраняет сеанс отправки до истечения срока действия, которое составляет 30 минут после получения последнего блока.

function commitImageStoreUploadSession(sessionId: string, options?: ServiceFabricClientCommitImageStoreUploadSessionOptionalParams): Promise<RestResponse>

Параметры

sessionId

string

GUID, созданный пользователем для отправки файла. Он определяет сеанс отправки хранилища образов, который отслеживает все блоки файлов, пока не будет зафиксировано.

options
ServiceFabricClientCommitImageStoreUploadSessionOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

commitImageStoreUploadSession(string, ServiceFabricClientCommitImageStoreUploadSessionOptionalParams, ServiceCallback<void>)

function commitImageStoreUploadSession(sessionId: string, options: ServiceFabricClientCommitImageStoreUploadSessionOptionalParams, callback: ServiceCallback<void>)

Параметры

sessionId

string

GUID, созданный пользователем для отправки файла. Он определяет сеанс отправки хранилища образов, который отслеживает все блоки файлов, пока не будет зафиксировано.

options
ServiceFabricClientCommitImageStoreUploadSessionOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

copyImageStoreContent(ImageStoreCopyDescription, ServiceCallback<void>)

function copyImageStoreContent(imageStoreCopyDescription: ImageStoreCopyDescription, callback: ServiceCallback<void>)

Параметры

imageStoreCopyDescription
ImageStoreCopyDescription

Описывает описание копирования для хранилища образов.

callback

ServiceCallback<void>

Обратный вызов

copyImageStoreContent(ImageStoreCopyDescription, ServiceFabricClientCopyImageStoreContentOptionalParams)

Копирует содержимое хранилища изображений из исходного хранилища образов относительного пути к целевому хранилищу образов.

function copyImageStoreContent(imageStoreCopyDescription: ImageStoreCopyDescription, options?: ServiceFabricClientCopyImageStoreContentOptionalParams): Promise<RestResponse>

Параметры

imageStoreCopyDescription
ImageStoreCopyDescription

Описывает описание копирования для хранилища образов.

options
ServiceFabricClientCopyImageStoreContentOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

copyImageStoreContent(ImageStoreCopyDescription, ServiceFabricClientCopyImageStoreContentOptionalParams, ServiceCallback<void>)

function copyImageStoreContent(imageStoreCopyDescription: ImageStoreCopyDescription, options: ServiceFabricClientCopyImageStoreContentOptionalParams, callback: ServiceCallback<void>)

Параметры

imageStoreCopyDescription
ImageStoreCopyDescription

Описывает описание копирования для хранилища образов.

options
ServiceFabricClientCopyImageStoreContentOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

createApplication(ApplicationDescription, ServiceCallback<void>)

function createApplication(applicationDescription: ApplicationDescription, callback: ServiceCallback<void>)

Параметры

applicationDescription
ApplicationDescription

Описание создания приложения.

callback

ServiceCallback<void>

Обратный вызов

createApplication(ApplicationDescription, ServiceFabricClientCreateApplicationOptionalParams)

Создает приложение Service Fabric с помощью указанного описания.

function createApplication(applicationDescription: ApplicationDescription, options?: ServiceFabricClientCreateApplicationOptionalParams): Promise<RestResponse>

Параметры

applicationDescription
ApplicationDescription

Описание создания приложения.

options
ServiceFabricClientCreateApplicationOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

createApplication(ApplicationDescription, ServiceFabricClientCreateApplicationOptionalParams, ServiceCallback<void>)

function createApplication(applicationDescription: ApplicationDescription, options: ServiceFabricClientCreateApplicationOptionalParams, callback: ServiceCallback<void>)

Параметры

applicationDescription
ApplicationDescription

Описание создания приложения.

options
ServiceFabricClientCreateApplicationOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

createBackupPolicy(BackupPolicyDescription, ServiceCallback<void>)

function createBackupPolicy(backupPolicyDescription: BackupPolicyDescription, callback: ServiceCallback<void>)

Параметры

backupPolicyDescription
BackupPolicyDescription

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

callback

ServiceCallback<void>

Обратный вызов

createBackupPolicy(BackupPolicyDescription, ServiceFabricClientCreateBackupPolicyOptionalParams)

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

function createBackupPolicy(backupPolicyDescription: BackupPolicyDescription, options?: ServiceFabricClientCreateBackupPolicyOptionalParams): Promise<RestResponse>

Параметры

backupPolicyDescription
BackupPolicyDescription

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

options
ServiceFabricClientCreateBackupPolicyOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

createBackupPolicy(BackupPolicyDescription, ServiceFabricClientCreateBackupPolicyOptionalParams, ServiceCallback<void>)

function createBackupPolicy(backupPolicyDescription: BackupPolicyDescription, options: ServiceFabricClientCreateBackupPolicyOptionalParams, callback: ServiceCallback<void>)

Параметры

backupPolicyDescription
BackupPolicyDescription

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

options
ServiceFabricClientCreateBackupPolicyOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

createComposeDeployment(CreateComposeDeploymentDescription, ServiceCallback<void>)

function createComposeDeployment(createComposeDeploymentDescription: CreateComposeDeploymentDescription, callback: ServiceCallback<void>)

Параметры

createComposeDeploymentDescription
CreateComposeDeploymentDescription

Описывает развертывание создания, которое необходимо создать.

callback

ServiceCallback<void>

Обратный вызов

createComposeDeployment(CreateComposeDeploymentDescription, ServiceFabricClientCreateComposeDeploymentOptionalParams)

Создание — это формат файла, описывающий многоконтейнерные приложения. Этот API позволяет развертывать приложения на основе контейнеров, определенные в формате создания в кластере Service Fabric. После создания развертывания его состояние можно отслеживать с помощью API GetComposeDeploymentStatus.

function createComposeDeployment(createComposeDeploymentDescription: CreateComposeDeploymentDescription, options?: ServiceFabricClientCreateComposeDeploymentOptionalParams): Promise<RestResponse>

Параметры

createComposeDeploymentDescription
CreateComposeDeploymentDescription

Описывает развертывание создания, которое необходимо создать.

options
ServiceFabricClientCreateComposeDeploymentOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

createComposeDeployment(CreateComposeDeploymentDescription, ServiceFabricClientCreateComposeDeploymentOptionalParams, ServiceCallback<void>)

function createComposeDeployment(createComposeDeploymentDescription: CreateComposeDeploymentDescription, options: ServiceFabricClientCreateComposeDeploymentOptionalParams, callback: ServiceCallback<void>)

Параметры

createComposeDeploymentDescription
CreateComposeDeploymentDescription

Описывает развертывание создания, которое необходимо создать.

options
ServiceFabricClientCreateComposeDeploymentOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

createName(NameDescription, ServiceCallback<void>)

function createName(nameDescription: NameDescription, callback: ServiceCallback<void>)

Параметры

nameDescription
NameDescription

Описывает созданное имя Service Fabric.

callback

ServiceCallback<void>

Обратный вызов

createName(NameDescription, ServiceFabricClientCreateNameOptionalParams)

Создает указанное имя Service Fabric.

function createName(nameDescription: NameDescription, options?: ServiceFabricClientCreateNameOptionalParams): Promise<RestResponse>

Параметры

nameDescription
NameDescription

Описывает созданное имя Service Fabric.

options
ServiceFabricClientCreateNameOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

createName(NameDescription, ServiceFabricClientCreateNameOptionalParams, ServiceCallback<void>)

function createName(nameDescription: NameDescription, options: ServiceFabricClientCreateNameOptionalParams, callback: ServiceCallback<void>)

Параметры

nameDescription
NameDescription

Описывает созданное имя Service Fabric.

options
ServiceFabricClientCreateNameOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

createRepairTask(RepairTask, RequestOptionsBase)

Для кластеров, на которых настроена служба Repair Manager, этот API позволяет создавать задачи восстановления, которые выполняются автоматически или вручную. Для задач восстановления, которые выполняются автоматически, соответствующий исполнитель восстановления должен выполняться для каждого действия восстановления, чтобы выполняться автоматически. Сейчас они доступны только в специально настроенных облачных службах Azure.

Чтобы создать задачу восстановления вручную, укажите набор затронутых имен узлов и ожидаемое влияние. Когда состояние созданной задачи восстановления изменяется на утвержденный, можно безопасно выполнять действия по восстановлению на этих узлах.

Этот API поддерживает платформу Service Fabric; Он не предназначен для использования непосредственно из кода.

function createRepairTask(repairTask: RepairTask, options?: RequestOptionsBase): Promise<CreateRepairTaskResponse>

Параметры

repairTask
RepairTask

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

options
RequestOptionsBase

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

Возвращаемое значение

Обещание<Models.CreateRepairTaskResponse>

createRepairTask(RepairTask, RequestOptionsBase, ServiceCallback<RepairTaskUpdateInfo>)

function createRepairTask(repairTask: RepairTask, options: RequestOptionsBase, callback: ServiceCallback<RepairTaskUpdateInfo>)

Параметры

repairTask
RepairTask

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

options
RequestOptionsBase

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

callback

ServiceCallback<RepairTaskUpdateInfo>

Обратный вызов

createRepairTask(RepairTask, ServiceCallback<RepairTaskUpdateInfo>)

function createRepairTask(repairTask: RepairTask, callback: ServiceCallback<RepairTaskUpdateInfo>)

Параметры

repairTask
RepairTask

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

callback

ServiceCallback<RepairTaskUpdateInfo>

Обратный вызов

createService(string, ServiceDescriptionUnion, ServiceCallback<void>)

function createService(applicationId: string, serviceDescription: ServiceDescriptionUnion, callback: ServiceCallback<void>)

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

serviceDescription
ServiceDescriptionUnion

Сведения, необходимые для создания службы.

callback

ServiceCallback<void>

Обратный вызов

createService(string, ServiceDescriptionUnion, ServiceFabricClientCreateServiceOptionalParams)

Этот API позволяет создать новую службу без отслеживания состояния или службы с отслеживанием состояния в указанном приложении Service Fabric. Описание создания службы включает сведения о секционировании и необязательные свойства для размещения и балансировки нагрузки. Некоторые свойства можно изменить позже с помощью API UpdateService.

function createService(applicationId: string, serviceDescription: ServiceDescriptionUnion, options?: ServiceFabricClientCreateServiceOptionalParams): Promise<RestResponse>

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

serviceDescription
ServiceDescriptionUnion

Сведения, необходимые для создания службы.

options
ServiceFabricClientCreateServiceOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

createService(string, ServiceDescriptionUnion, ServiceFabricClientCreateServiceOptionalParams, ServiceCallback<void>)

function createService(applicationId: string, serviceDescription: ServiceDescriptionUnion, options: ServiceFabricClientCreateServiceOptionalParams, callback: ServiceCallback<void>)

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

serviceDescription
ServiceDescriptionUnion

Сведения, необходимые для создания службы.

options
ServiceFabricClientCreateServiceOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

createServiceFromTemplate(string, ServiceFromTemplateDescription, ServiceCallback<void>)

function createServiceFromTemplate(applicationId: string, serviceFromTemplateDescription: ServiceFromTemplateDescription, callback: ServiceCallback<void>)

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

serviceFromTemplateDescription
ServiceFromTemplateDescription

Описывает службу, которую необходимо создать из шаблона, определенного в манифесте приложения.

callback

ServiceCallback<void>

Обратный вызов

createServiceFromTemplate(string, ServiceFromTemplateDescription, ServiceFabricClientCreateServiceFromTemplateOptionalParams)

Создает службу Service Fabric из шаблона службы, определенного в манифесте приложения. Шаблон службы содержит свойства, которые будут одинаковыми для экземпляра службы одного типа. API позволяет переопределить свойства, которые обычно отличаются для разных служб одного типа службы.

function createServiceFromTemplate(applicationId: string, serviceFromTemplateDescription: ServiceFromTemplateDescription, options?: ServiceFabricClientCreateServiceFromTemplateOptionalParams): Promise<RestResponse>

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

serviceFromTemplateDescription
ServiceFromTemplateDescription

Описывает службу, которую необходимо создать из шаблона, определенного в манифесте приложения.

options
ServiceFabricClientCreateServiceFromTemplateOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

createServiceFromTemplate(string, ServiceFromTemplateDescription, ServiceFabricClientCreateServiceFromTemplateOptionalParams, ServiceCallback<void>)

function createServiceFromTemplate(applicationId: string, serviceFromTemplateDescription: ServiceFromTemplateDescription, options: ServiceFabricClientCreateServiceFromTemplateOptionalParams, callback: ServiceCallback<void>)

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

serviceFromTemplateDescription
ServiceFromTemplateDescription

Описывает службу, которую необходимо создать из шаблона, определенного в манифесте приложения.

options
ServiceFabricClientCreateServiceFromTemplateOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

deleteApplication(string, ServiceCallback<void>)

function deleteApplication(applicationId: string, callback: ServiceCallback<void>)

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

callback

ServiceCallback<void>

Обратный вызов

deleteApplication(string, ServiceFabricClientDeleteApplicationOptionalParams)

Прежде чем его можно удалить, необходимо создать приложение. При удалении приложения будут удалены все службы, которые являются частью этого приложения. По умолчанию Service Fabric попытается закрыть реплики служб корректно, а затем удалить службу. Однако если служба имеет проблемы с закрытием реплики корректно, операция удаления может занять много времени или застрять. Используйте необязательный флаг ForceRemove, чтобы пропустить правильную последовательность закрытия и принудительно удалить приложение и все его службы.

function deleteApplication(applicationId: string, options?: ServiceFabricClientDeleteApplicationOptionalParams): Promise<RestResponse>

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

options
ServiceFabricClientDeleteApplicationOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

deleteApplication(string, ServiceFabricClientDeleteApplicationOptionalParams, ServiceCallback<void>)

function deleteApplication(applicationId: string, options: ServiceFabricClientDeleteApplicationOptionalParams, callback: ServiceCallback<void>)

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

options
ServiceFabricClientDeleteApplicationOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

deleteBackupPolicy(string, ServiceCallback<void>)

function deleteBackupPolicy(backupPolicyName: string, callback: ServiceCallback<void>)

Параметры

backupPolicyName

string

Имя политики резервного копирования.

callback

ServiceCallback<void>

Обратный вызов

deleteBackupPolicy(string, ServiceFabricClientDeleteBackupPolicyOptionalParams)

Удаляет существующую политику резервного копирования. Прежде чем его можно удалить, необходимо создать политику резервного копирования. В настоящее время активная политика резервного копирования, связанная с любым приложением Service Fabric, службой или секцией, не может быть удалена без первого удаления сопоставления.

function deleteBackupPolicy(backupPolicyName: string, options?: ServiceFabricClientDeleteBackupPolicyOptionalParams): Promise<RestResponse>

Параметры

backupPolicyName

string

Имя политики резервного копирования.

options
ServiceFabricClientDeleteBackupPolicyOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

deleteBackupPolicy(string, ServiceFabricClientDeleteBackupPolicyOptionalParams, ServiceCallback<void>)

function deleteBackupPolicy(backupPolicyName: string, options: ServiceFabricClientDeleteBackupPolicyOptionalParams, callback: ServiceCallback<void>)

Параметры

backupPolicyName

string

Имя политики резервного копирования.

options
ServiceFabricClientDeleteBackupPolicyOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

deleteImageStoreContent(string, ServiceCallback<void>)

function deleteImageStoreContent(contentPath: string, callback: ServiceCallback<void>)

Параметры

contentPath

string

Относительный путь к файлу или папке в хранилище образов из корневого каталога.

callback

ServiceCallback<void>

Обратный вызов

deleteImageStoreContent(string, ServiceFabricClientDeleteImageStoreContentOptionalParams)

Удаляет существующее содержимое хранилища образов, найденное в указанном пути к хранилищу образов. Эта команда может использоваться для удаления отправленных пакетов приложений после их подготовки.

function deleteImageStoreContent(contentPath: string, options?: ServiceFabricClientDeleteImageStoreContentOptionalParams): Promise<RestResponse>

Параметры

contentPath

string

Относительный путь к файлу или папке в хранилище образов из корневого каталога.

options
ServiceFabricClientDeleteImageStoreContentOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

deleteImageStoreContent(string, ServiceFabricClientDeleteImageStoreContentOptionalParams, ServiceCallback<void>)

function deleteImageStoreContent(contentPath: string, options: ServiceFabricClientDeleteImageStoreContentOptionalParams, callback: ServiceCallback<void>)

Параметры

contentPath

string

Относительный путь к файлу или папке в хранилище образов из корневого каталога.

options
ServiceFabricClientDeleteImageStoreContentOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

deleteImageStoreUploadSession(string, ServiceCallback<void>)

function deleteImageStoreUploadSession(sessionId: string, callback: ServiceCallback<void>)

Параметры

sessionId

string

GUID, созданный пользователем для отправки файла. Он определяет сеанс отправки хранилища образов, который отслеживает все блоки файлов, пока не будет зафиксировано.

callback

ServiceCallback<void>

Обратный вызов

deleteImageStoreUploadSession(string, ServiceFabricClientDeleteImageStoreUploadSessionOptionalParams)

Запрос DELETE приведет к истечению срока действия существующего сеанса отправки и удалению всех ранее отправленных фрагментов файлов.

function deleteImageStoreUploadSession(sessionId: string, options?: ServiceFabricClientDeleteImageStoreUploadSessionOptionalParams): Promise<RestResponse>

Параметры

sessionId

string

GUID, созданный пользователем для отправки файла. Он определяет сеанс отправки хранилища образов, который отслеживает все блоки файлов, пока не будет зафиксировано.

options
ServiceFabricClientDeleteImageStoreUploadSessionOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

deleteImageStoreUploadSession(string, ServiceFabricClientDeleteImageStoreUploadSessionOptionalParams, ServiceCallback<void>)

function deleteImageStoreUploadSession(sessionId: string, options: ServiceFabricClientDeleteImageStoreUploadSessionOptionalParams, callback: ServiceCallback<void>)

Параметры

sessionId

string

GUID, созданный пользователем для отправки файла. Он определяет сеанс отправки хранилища образов, который отслеживает все блоки файлов, пока не будет зафиксировано.

options
ServiceFabricClientDeleteImageStoreUploadSessionOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

deleteName(string, ServiceCallback<void>)

function deleteName(nameId: string, callback: ServiceCallback<void>)

Параметры

nameId

string

Имя Service Fabric без схемы URI fabric:.

callback

ServiceCallback<void>

Обратный вызов

deleteName(string, ServiceFabricClientDeleteNameOptionalParams)

Удаляет указанное имя Service Fabric. Прежде чем его можно удалить, необходимо создать имя. Удаление имени с дочерними свойствами завершится ошибкой.

function deleteName(nameId: string, options?: ServiceFabricClientDeleteNameOptionalParams): Promise<RestResponse>

Параметры

nameId

string

Имя Service Fabric без схемы URI fabric:.

options
ServiceFabricClientDeleteNameOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

deleteName(string, ServiceFabricClientDeleteNameOptionalParams, ServiceCallback<void>)

function deleteName(nameId: string, options: ServiceFabricClientDeleteNameOptionalParams, callback: ServiceCallback<void>)

Параметры

nameId

string

Имя Service Fabric без схемы URI fabric:.

options
ServiceFabricClientDeleteNameOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

deleteProperty(string, string, ServiceCallback<void>)

function deleteProperty(nameId: string, propertyName: string, callback: ServiceCallback<void>)

Параметры

nameId

string

Имя Service Fabric без схемы URI fabric:.

propertyName

string

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

callback

ServiceCallback<void>

Обратный вызов

deleteProperty(string, string, ServiceFabricClientDeletePropertyOptionalParams)

Удаляет указанное свойство Service Fabric под заданным именем. Прежде чем его можно удалить, необходимо создать свойство.

function deleteProperty(nameId: string, propertyName: string, options?: ServiceFabricClientDeletePropertyOptionalParams): Promise<RestResponse>

Параметры

nameId

string

Имя Service Fabric без схемы URI fabric:.

propertyName

string

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

options
ServiceFabricClientDeletePropertyOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

deleteProperty(string, string, ServiceFabricClientDeletePropertyOptionalParams, ServiceCallback<void>)

function deleteProperty(nameId: string, propertyName: string, options: ServiceFabricClientDeletePropertyOptionalParams, callback: ServiceCallback<void>)

Параметры

nameId

string

Имя Service Fabric без схемы URI fabric:.

propertyName

string

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

options
ServiceFabricClientDeletePropertyOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

deleteRepairTask(RepairTaskDeleteDescription, RequestOptionsBase)

Этот API поддерживает платформу Service Fabric; Он не предназначен для использования непосредственно из кода.

function deleteRepairTask(repairTaskDeleteDescription: RepairTaskDeleteDescription, options?: RequestOptionsBase): Promise<RestResponse>

Параметры

repairTaskDeleteDescription
RepairTaskDeleteDescription

Описывает задачу восстановления, удаляемую.

options
RequestOptionsBase

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

deleteRepairTask(RepairTaskDeleteDescription, RequestOptionsBase, ServiceCallback<void>)

function deleteRepairTask(repairTaskDeleteDescription: RepairTaskDeleteDescription, options: RequestOptionsBase, callback: ServiceCallback<void>)

Параметры

repairTaskDeleteDescription
RepairTaskDeleteDescription

Описывает задачу восстановления, удаляемую.

options
RequestOptionsBase

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

callback

ServiceCallback<void>

Обратный вызов

deleteRepairTask(RepairTaskDeleteDescription, ServiceCallback<void>)

function deleteRepairTask(repairTaskDeleteDescription: RepairTaskDeleteDescription, callback: ServiceCallback<void>)

Параметры

repairTaskDeleteDescription
RepairTaskDeleteDescription

Описывает задачу восстановления, удаляемую.

callback

ServiceCallback<void>

Обратный вызов

deleteService(string, ServiceCallback<void>)

function deleteService(serviceId: string, callback: ServiceCallback<void>)

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

callback

ServiceCallback<void>

Обратный вызов

deleteService(string, ServiceFabricClientDeleteServiceOptionalParams)

Прежде чем ее можно удалить, необходимо создать службу. По умолчанию Service Fabric попытается закрыть реплики служб корректно, а затем удалить службу. Однако если служба имеет проблемы с закрытием реплики корректно, операция удаления может занять много времени или застрять. Используйте необязательный флаг ForceRemove, чтобы пропустить грациозную последовательность закрытия и принудительно удалить службу.

function deleteService(serviceId: string, options?: ServiceFabricClientDeleteServiceOptionalParams): Promise<RestResponse>

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

options
ServiceFabricClientDeleteServiceOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

deleteService(string, ServiceFabricClientDeleteServiceOptionalParams, ServiceCallback<void>)

function deleteService(serviceId: string, options: ServiceFabricClientDeleteServiceOptionalParams, callback: ServiceCallback<void>)

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

options
ServiceFabricClientDeleteServiceOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

deployServicePackageToNode(string, DeployServicePackageToNodeDescription, ServiceCallback<void>)

function deployServicePackageToNode(nodeName: string, deployServicePackageToNodeDescription: DeployServicePackageToNodeDescription, callback: ServiceCallback<void>)

Параметры

nodeName

string

Имя узла.

deployServicePackageToNodeDescription
DeployServicePackageToNodeDescription

Описание сведений о развертывании пакета службы на узле Service Fabric.

callback

ServiceCallback<void>

Обратный вызов

deployServicePackageToNode(string, DeployServicePackageToNodeDescription, ServiceFabricClientDeployServicePackageToNodeOptionalParams)

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

function deployServicePackageToNode(nodeName: string, deployServicePackageToNodeDescription: DeployServicePackageToNodeDescription, options?: ServiceFabricClientDeployServicePackageToNodeOptionalParams): Promise<RestResponse>

Параметры

nodeName

string

Имя узла.

deployServicePackageToNodeDescription
DeployServicePackageToNodeDescription

Описание сведений о развертывании пакета службы на узле Service Fabric.

options
ServiceFabricClientDeployServicePackageToNodeOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

deployServicePackageToNode(string, DeployServicePackageToNodeDescription, ServiceFabricClientDeployServicePackageToNodeOptionalParams, ServiceCallback<void>)

function deployServicePackageToNode(nodeName: string, deployServicePackageToNodeDescription: DeployServicePackageToNodeDescription, options: ServiceFabricClientDeployServicePackageToNodeOptionalParams, callback: ServiceCallback<void>)

Параметры

nodeName

string

Имя узла.

deployServicePackageToNodeDescription
DeployServicePackageToNodeDescription

Описание сведений о развертывании пакета службы на узле Service Fabric.

options
ServiceFabricClientDeployServicePackageToNodeOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

disableApplicationBackup(string, ServiceCallback<void>)

function disableApplicationBackup(applicationId: string, callback: ServiceCallback<void>)

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

callback

ServiceCallback<void>

Обратный вызов

disableApplicationBackup(string, ServiceFabricClientDisableApplicationBackupOptionalParams)

Отключает периодическое резервное копирование приложения Service Fabric, которое ранее было включено.

function disableApplicationBackup(applicationId: string, options?: ServiceFabricClientDisableApplicationBackupOptionalParams): Promise<RestResponse>

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

options
ServiceFabricClientDisableApplicationBackupOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

disableApplicationBackup(string, ServiceFabricClientDisableApplicationBackupOptionalParams, ServiceCallback<void>)

function disableApplicationBackup(applicationId: string, options: ServiceFabricClientDisableApplicationBackupOptionalParams, callback: ServiceCallback<void>)

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

options
ServiceFabricClientDisableApplicationBackupOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

disableNode(string, DeactivationIntentDescription, ServiceCallback<void>)

function disableNode(nodeName: string, deactivationIntentDescription: DeactivationIntentDescription, callback: ServiceCallback<void>)

Параметры

nodeName

string

Имя узла.

deactivationIntentDescription
DeactivationIntentDescription

Описывает намерение или причину деактивации узла.

callback

ServiceCallback<void>

Обратный вызов

disableNode(string, DeactivationIntentDescription, ServiceFabricClientDisableNodeOptionalParams)

Отключите узел кластера Service Fabric с указанным намерением деактивации. После завершения деактивации можно увеличить намерение деактивации, но не уменьшить (например, узел, деактивированный с намерением Приостановки, можно отключить дальше с помощью перезапуска, но не наоборот. Узлы могут быть повторно активированы с помощью операции активации узла в любое время после отключения. Если деактивация не завершена, это отменит деактивацию. Узел, который выходит из строя и выполняет резервное копирование во время деактивации, по-прежнему необходимо повторно активировать, прежде чем службы будут помещены на этот узел.

function disableNode(nodeName: string, deactivationIntentDescription: DeactivationIntentDescription, options?: ServiceFabricClientDisableNodeOptionalParams): Promise<RestResponse>

Параметры

nodeName

string

Имя узла.

deactivationIntentDescription
DeactivationIntentDescription

Описывает намерение или причину деактивации узла.

options
ServiceFabricClientDisableNodeOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

disableNode(string, DeactivationIntentDescription, ServiceFabricClientDisableNodeOptionalParams, ServiceCallback<void>)

function disableNode(nodeName: string, deactivationIntentDescription: DeactivationIntentDescription, options: ServiceFabricClientDisableNodeOptionalParams, callback: ServiceCallback<void>)

Параметры

nodeName

string

Имя узла.

deactivationIntentDescription
DeactivationIntentDescription

Описывает намерение или причину деактивации узла.

options
ServiceFabricClientDisableNodeOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

disablePartitionBackup(string, ServiceCallback<void>)

function disablePartitionBackup(partitionId: string, callback: ServiceCallback<void>)

Параметры

partitionId

string

Удостоверение секции.

callback

ServiceCallback<void>

Обратный вызов

disablePartitionBackup(string, ServiceFabricClientDisablePartitionBackupOptionalParams)

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

function disablePartitionBackup(partitionId: string, options?: ServiceFabricClientDisablePartitionBackupOptionalParams): Promise<RestResponse>

Параметры

partitionId

string

Удостоверение секции.

options
ServiceFabricClientDisablePartitionBackupOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

disablePartitionBackup(string, ServiceFabricClientDisablePartitionBackupOptionalParams, ServiceCallback<void>)

function disablePartitionBackup(partitionId: string, options: ServiceFabricClientDisablePartitionBackupOptionalParams, callback: ServiceCallback<void>)

Параметры

partitionId

string

Удостоверение секции.

options
ServiceFabricClientDisablePartitionBackupOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

disableServiceBackup(string, ServiceCallback<void>)

function disableServiceBackup(serviceId: string, callback: ServiceCallback<void>)

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

callback

ServiceCallback<void>

Обратный вызов

disableServiceBackup(string, ServiceFabricClientDisableServiceBackupOptionalParams)

Отключает периодическое резервное копирование службы Service Fabric, которая была включена ранее. Перед отключением резервного копирования необходимо явно включить. Если резервное копирование включено для приложения Service Fabric, в котором эта служба является частью, эта служба будет периодически создавать резервные копии в отношении политики, сопоставленной на уровне приложения.

function disableServiceBackup(serviceId: string, options?: ServiceFabricClientDisableServiceBackupOptionalParams): Promise<RestResponse>

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

options
ServiceFabricClientDisableServiceBackupOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

disableServiceBackup(string, ServiceFabricClientDisableServiceBackupOptionalParams, ServiceCallback<void>)

function disableServiceBackup(serviceId: string, options: ServiceFabricClientDisableServiceBackupOptionalParams, callback: ServiceCallback<void>)

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

options
ServiceFabricClientDisableServiceBackupOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

enableApplicationBackup(string, EnableBackupDescription, ServiceCallback<void>)

function enableApplicationBackup(applicationId: string, enableBackupDescription: EnableBackupDescription, callback: ServiceCallback<void>)

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

enableBackupDescription
EnableBackupDescription

Задает параметры для включения резервного копирования.

callback

ServiceCallback<void>

Обратный вызов

enableApplicationBackup(string, EnableBackupDescription, ServiceFabricClientEnableApplicationBackupOptionalParams)

Включает периодическое резервное копирование секций с отслеживанием состояния, которые являются частью этого приложения Service Fabric. Каждая секция выполняет резервное копирование по отдельности в соответствии с указанным описанием политики резервного копирования. Обратите внимание, что для периодического резервного копирования в настоящее время поддерживаются только службы надежных субъектов на основе C# и надежных служб с отслеживанием состояния.

function enableApplicationBackup(applicationId: string, enableBackupDescription: EnableBackupDescription, options?: ServiceFabricClientEnableApplicationBackupOptionalParams): Promise<RestResponse>

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

enableBackupDescription
EnableBackupDescription

Задает параметры для включения резервного копирования.

options
ServiceFabricClientEnableApplicationBackupOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

enableApplicationBackup(string, EnableBackupDescription, ServiceFabricClientEnableApplicationBackupOptionalParams, ServiceCallback<void>)

function enableApplicationBackup(applicationId: string, enableBackupDescription: EnableBackupDescription, options: ServiceFabricClientEnableApplicationBackupOptionalParams, callback: ServiceCallback<void>)

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

enableBackupDescription
EnableBackupDescription

Задает параметры для включения резервного копирования.

options
ServiceFabricClientEnableApplicationBackupOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

enableNode(string, ServiceCallback<void>)

function enableNode(nodeName: string, callback: ServiceCallback<void>)

Параметры

nodeName

string

Имя узла.

callback

ServiceCallback<void>

Обратный вызов

enableNode(string, ServiceFabricClientEnableNodeOptionalParams)

Активирует узел кластера Service Fabric, который в настоящее время деактивирован. После активации узел снова станет жизнеспособным объектом для размещения новых реплик, и все деактивированные реплики, оставшиеся на узле, будут повторно активированы.

function enableNode(nodeName: string, options?: ServiceFabricClientEnableNodeOptionalParams): Promise<RestResponse>

Параметры

nodeName

string

Имя узла.

options
ServiceFabricClientEnableNodeOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

enableNode(string, ServiceFabricClientEnableNodeOptionalParams, ServiceCallback<void>)

function enableNode(nodeName: string, options: ServiceFabricClientEnableNodeOptionalParams, callback: ServiceCallback<void>)

Параметры

nodeName

string

Имя узла.

options
ServiceFabricClientEnableNodeOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

enablePartitionBackup(string, EnableBackupDescription, ServiceCallback<void>)

function enablePartitionBackup(partitionId: string, enableBackupDescription: EnableBackupDescription, callback: ServiceCallback<void>)

Параметры

partitionId

string

Удостоверение секции.

enableBackupDescription
EnableBackupDescription

Задает параметры для включения резервного копирования.

callback

ServiceCallback<void>

Обратный вызов

enablePartitionBackup(string, EnableBackupDescription, ServiceFabricClientEnablePartitionBackupOptionalParams)

Включает периодическое резервное копирование сохраняемой секции с отслеживанием состояния. Каждая секция выполняет резервное копирование в соответствии с указанным описанием политики резервного копирования. Если приложение или служба, которая является частью секции, уже включена для резервного копирования, эта операция переопределит политику, используемую для периодического резервного копирования этой секции. Обратите внимание, что для периодического резервного копирования в настоящее время поддерживаются только службы надежных субъектов на основе C# и надежных служб с отслеживанием состояния.

function enablePartitionBackup(partitionId: string, enableBackupDescription: EnableBackupDescription, options?: ServiceFabricClientEnablePartitionBackupOptionalParams): Promise<RestResponse>

Параметры

partitionId

string

Удостоверение секции.

enableBackupDescription
EnableBackupDescription

Задает параметры для включения резервного копирования.

options
ServiceFabricClientEnablePartitionBackupOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

enablePartitionBackup(string, EnableBackupDescription, ServiceFabricClientEnablePartitionBackupOptionalParams, ServiceCallback<void>)

function enablePartitionBackup(partitionId: string, enableBackupDescription: EnableBackupDescription, options: ServiceFabricClientEnablePartitionBackupOptionalParams, callback: ServiceCallback<void>)

Параметры

partitionId

string

Удостоверение секции.

enableBackupDescription
EnableBackupDescription

Задает параметры для включения резервного копирования.

options
ServiceFabricClientEnablePartitionBackupOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

enableServiceBackup(string, EnableBackupDescription, ServiceCallback<void>)

function enableServiceBackup(serviceId: string, enableBackupDescription: EnableBackupDescription, callback: ServiceCallback<void>)

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

enableBackupDescription
EnableBackupDescription

Задает параметры для включения резервного копирования.

callback

ServiceCallback<void>

Обратный вызов

enableServiceBackup(string, EnableBackupDescription, ServiceFabricClientEnableServiceBackupOptionalParams)

Включает периодическое резервное копирование секций с отслеживанием состояния, которые являются частью этой службы Service Fabric. Каждая секция выполняет резервное копирование по отдельности в соответствии с указанным описанием политики резервного копирования. Если приложение, которое является частью службы, уже включено для резервного копирования, эта операция переопределит политику, используемую для периодического резервного копирования для этой службы и ее секций (если только явно переопределено на уровне секции). Обратите внимание, что для периодического резервного копирования в настоящее время поддерживаются только службы надежных субъектов на основе C# и надежных служб с отслеживанием состояния.

function enableServiceBackup(serviceId: string, enableBackupDescription: EnableBackupDescription, options?: ServiceFabricClientEnableServiceBackupOptionalParams): Promise<RestResponse>

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

enableBackupDescription
EnableBackupDescription

Задает параметры для включения резервного копирования.

options
ServiceFabricClientEnableServiceBackupOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

enableServiceBackup(string, EnableBackupDescription, ServiceFabricClientEnableServiceBackupOptionalParams, ServiceCallback<void>)

function enableServiceBackup(serviceId: string, enableBackupDescription: EnableBackupDescription, options: ServiceFabricClientEnableServiceBackupOptionalParams, callback: ServiceCallback<void>)

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

enableBackupDescription
EnableBackupDescription

Задает параметры для включения резервного копирования.

options
ServiceFabricClientEnableServiceBackupOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

forceApproveRepairTask(RepairTaskApproveDescription, RequestOptionsBase)

Этот API поддерживает платформу Service Fabric; Он не предназначен для использования непосредственно из кода.

function forceApproveRepairTask(repairTaskApproveDescription: RepairTaskApproveDescription, options?: RequestOptionsBase): Promise<ForceApproveRepairTaskResponse>

Параметры

repairTaskApproveDescription
RepairTaskApproveDescription

Описывает задачу восстановления, утвержденную.

options
RequestOptionsBase

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

Возвращаемое значение

Обещание<Models.ForceApproveRepairTaskResponse>

forceApproveRepairTask(RepairTaskApproveDescription, RequestOptionsBase, ServiceCallback<RepairTaskUpdateInfo>)

function forceApproveRepairTask(repairTaskApproveDescription: RepairTaskApproveDescription, options: RequestOptionsBase, callback: ServiceCallback<RepairTaskUpdateInfo>)

Параметры

repairTaskApproveDescription
RepairTaskApproveDescription

Описывает задачу восстановления, утвержденную.

options
RequestOptionsBase

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

callback

ServiceCallback<RepairTaskUpdateInfo>

Обратный вызов

forceApproveRepairTask(RepairTaskApproveDescription, ServiceCallback<RepairTaskUpdateInfo>)

function forceApproveRepairTask(repairTaskApproveDescription: RepairTaskApproveDescription, callback: ServiceCallback<RepairTaskUpdateInfo>)

Параметры

repairTaskApproveDescription
RepairTaskApproveDescription

Описывает задачу восстановления, утвержденную.

callback

ServiceCallback<RepairTaskUpdateInfo>

Обратный вызов

getAadMetadata(ServiceCallback<AadMetadataObject>)

function getAadMetadata(callback: ServiceCallback<AadMetadataObject>)

Параметры

callback

ServiceCallback<AadMetadataObject>

Обратный вызов

getAadMetadata(ServiceFabricClientGetAadMetadataOptionalParams)

Возвращает метаданные Azure Active Directory, используемые для защищенного подключения к кластеру. Этот API не должен вызываться отдельно. Он предоставляет сведения, необходимые для настройки защищенного подключения Azure Active Directory с кластером Service Fabric.

function getAadMetadata(options?: ServiceFabricClientGetAadMetadataOptionalParams): Promise<GetAadMetadataResponse>

Параметры

options
ServiceFabricClientGetAadMetadataOptionalParams

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

Возвращаемое значение

Обещание<Models.GetAadMetadataResponse>

getAadMetadata(ServiceFabricClientGetAadMetadataOptionalParams, ServiceCallback<AadMetadataObject>)

function getAadMetadata(options: ServiceFabricClientGetAadMetadataOptionalParams, callback: ServiceCallback<AadMetadataObject>)

Параметры

options
ServiceFabricClientGetAadMetadataOptionalParams

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

callback

ServiceCallback<AadMetadataObject>

Обратный вызов

getAllEntitiesBackedUpByPolicy(string, ServiceCallback<PagedBackupEntityList>)

function getAllEntitiesBackedUpByPolicy(backupPolicyName: string, callback: ServiceCallback<PagedBackupEntityList>)

Параметры

backupPolicyName

string

Имя политики резервного копирования.

callback

ServiceCallback<PagedBackupEntityList>

Обратный вызов

getAllEntitiesBackedUpByPolicy(string, ServiceFabricClientGetAllEntitiesBackedUpByPolicyOptionalParams)

Возвращает список приложений, служб или секций Service Fabric, связанных с этой политикой резервного копирования.

function getAllEntitiesBackedUpByPolicy(backupPolicyName: string, options?: ServiceFabricClientGetAllEntitiesBackedUpByPolicyOptionalParams): Promise<GetAllEntitiesBackedUpByPolicyResponse>

Параметры

backupPolicyName

string

Имя политики резервного копирования.

options
ServiceFabricClientGetAllEntitiesBackedUpByPolicyOptionalParams

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

Возвращаемое значение

Обещание<Models.GetAllEntitiesBackedUpByPolicyResponse>

getAllEntitiesBackedUpByPolicy(string, ServiceFabricClientGetAllEntitiesBackedUpByPolicyOptionalParams, ServiceCallback<PagedBackupEntityList>)

function getAllEntitiesBackedUpByPolicy(backupPolicyName: string, options: ServiceFabricClientGetAllEntitiesBackedUpByPolicyOptionalParams, callback: ServiceCallback<PagedBackupEntityList>)

Параметры

backupPolicyName

string

Имя политики резервного копирования.

options
ServiceFabricClientGetAllEntitiesBackedUpByPolicyOptionalParams

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

callback

ServiceCallback<PagedBackupEntityList>

Обратный вызов

getApplicationBackupConfigurationInfo(string, ServiceCallback<PagedBackupConfigurationInfoList>)

function getApplicationBackupConfigurationInfo(applicationId: string, callback: ServiceCallback<PagedBackupConfigurationInfoList>)

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

callback

ServiceCallback<PagedBackupConfigurationInfoList>

Обратный вызов

getApplicationBackupConfigurationInfo(string, ServiceFabricClientGetApplicationBackupConfigurationInfoOptionalParams)

Возвращает сведения о конфигурации резервного копирования Service Fabric для приложения и служб и секций в этом приложении.

function getApplicationBackupConfigurationInfo(applicationId: string, options?: ServiceFabricClientGetApplicationBackupConfigurationInfoOptionalParams): Promise<GetApplicationBackupConfigurationInfoResponse>

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

options
ServiceFabricClientGetApplicationBackupConfigurationInfoOptionalParams

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

Возвращаемое значение

Обещание<Models.GetApplicationBackupConfigurationInfoResponse>

getApplicationBackupConfigurationInfo(string, ServiceFabricClientGetApplicationBackupConfigurationInfoOptionalParams, ServiceCallback<PagedBackupConfigurationInfoList>)

function getApplicationBackupConfigurationInfo(applicationId: string, options: ServiceFabricClientGetApplicationBackupConfigurationInfoOptionalParams, callback: ServiceCallback<PagedBackupConfigurationInfoList>)

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

options
ServiceFabricClientGetApplicationBackupConfigurationInfoOptionalParams

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

callback

ServiceCallback<PagedBackupConfigurationInfoList>

Обратный вызов

getApplicationBackupList(string, ServiceCallback<PagedBackupInfoList>)

function getApplicationBackupList(applicationId: string, callback: ServiceCallback<PagedBackupInfoList>)

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

callback

ServiceCallback<PagedBackupInfoList>

Обратный вызов

getApplicationBackupList(string, ServiceFabricClientGetApplicationBackupListOptionalParams)

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

function getApplicationBackupList(applicationId: string, options?: ServiceFabricClientGetApplicationBackupListOptionalParams): Promise<GetApplicationBackupListResponse>

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

options
ServiceFabricClientGetApplicationBackupListOptionalParams

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

Возвращаемое значение

Обещание<Models.GetApplicationBackupListResponse>

getApplicationBackupList(string, ServiceFabricClientGetApplicationBackupListOptionalParams, ServiceCallback<PagedBackupInfoList>)

function getApplicationBackupList(applicationId: string, options: ServiceFabricClientGetApplicationBackupListOptionalParams, callback: ServiceCallback<PagedBackupInfoList>)

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

options
ServiceFabricClientGetApplicationBackupListOptionalParams

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

callback

ServiceCallback<PagedBackupInfoList>

Обратный вызов

getApplicationEventList(string, string, string, ServiceCallback<ApplicationEventUnion[]>)

function getApplicationEventList(applicationId: string, startTimeUtc: string, endTimeUtc: string, callback: ServiceCallback<ApplicationEventUnion[]>)

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

startTimeUtc

string

Время начала запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

endTimeUtc

string

Время окончания запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

callback

ServiceCallback<ApplicationEventUnion[]>

Обратный вызов

getApplicationEventList(string, string, string, ServiceFabricClientGetApplicationEventListOptionalParams)

Ответ — это список объектов ApplicationEvent.

function getApplicationEventList(applicationId: string, startTimeUtc: string, endTimeUtc: string, options?: ServiceFabricClientGetApplicationEventListOptionalParams): Promise<GetApplicationEventListResponse>

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

startTimeUtc

string

Время начала запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

endTimeUtc

string

Время окончания запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

options
ServiceFabricClientGetApplicationEventListOptionalParams

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

Возвращаемое значение

Обещание<Models.GetApplicationEventListResponse>

getApplicationEventList(string, string, string, ServiceFabricClientGetApplicationEventListOptionalParams, ServiceCallback<ApplicationEventUnion[]>)

function getApplicationEventList(applicationId: string, startTimeUtc: string, endTimeUtc: string, options: ServiceFabricClientGetApplicationEventListOptionalParams, callback: ServiceCallback<ApplicationEventUnion[]>)

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

startTimeUtc

string

Время начала запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

endTimeUtc

string

Время окончания запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

options
ServiceFabricClientGetApplicationEventListOptionalParams

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

callback

ServiceCallback<ApplicationEventUnion[]>

Обратный вызов

getApplicationHealth(string, ServiceCallback<ApplicationHealth>)

function getApplicationHealth(applicationId: string, callback: ServiceCallback<ApplicationHealth>)

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

callback

ServiceCallback<ApplicationHealth>

Обратный вызов

getApplicationHealth(string, ServiceFabricClientGetApplicationHealthOptionalParams)

Возвращает состояние хита приложения Service Fabric. Ответ сообщает о состоянии работоспособности "ОК", "Ошибка" или "Предупреждение". Если сущность не найдена в хранилище работоспособности, она вернет ошибку.

function getApplicationHealth(applicationId: string, options?: ServiceFabricClientGetApplicationHealthOptionalParams): Promise<GetApplicationHealthResponse>

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

options
ServiceFabricClientGetApplicationHealthOptionalParams

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

Возвращаемое значение

Обещание<Models.GetApplicationHealthResponse>

getApplicationHealth(string, ServiceFabricClientGetApplicationHealthOptionalParams, ServiceCallback<ApplicationHealth>)

function getApplicationHealth(applicationId: string, options: ServiceFabricClientGetApplicationHealthOptionalParams, callback: ServiceCallback<ApplicationHealth>)

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

options
ServiceFabricClientGetApplicationHealthOptionalParams

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

callback

ServiceCallback<ApplicationHealth>

Обратный вызов

getApplicationHealthUsingPolicy(string, ServiceCallback<ApplicationHealth>)

function getApplicationHealthUsingPolicy(applicationId: string, callback: ServiceCallback<ApplicationHealth>)

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

callback

ServiceCallback<ApplicationHealth>

Обратный вызов

getApplicationHealthUsingPolicy(string, ServiceFabricClientGetApplicationHealthUsingPolicyOptionalParams)

Возвращает работоспособность приложения Service Fabric. Используйте EventsHealthStateFilter, чтобы отфильтровать коллекцию событий работоспособности, сообщаемых на узле на основе состояния работоспособности. Используйте ClusterHealthPolicies для переопределения политик работоспособности, используемых для оценки работоспособности.

function getApplicationHealthUsingPolicy(applicationId: string, options?: ServiceFabricClientGetApplicationHealthUsingPolicyOptionalParams): Promise<GetApplicationHealthUsingPolicyResponse>

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

options
ServiceFabricClientGetApplicationHealthUsingPolicyOptionalParams

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

Возвращаемое значение

Обещание<Models.GetApplicationHealthUsingPolicyResponse>

getApplicationHealthUsingPolicy(string, ServiceFabricClientGetApplicationHealthUsingPolicyOptionalParams, ServiceCallback<ApplicationHealth>)

function getApplicationHealthUsingPolicy(applicationId: string, options: ServiceFabricClientGetApplicationHealthUsingPolicyOptionalParams, callback: ServiceCallback<ApplicationHealth>)

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

options
ServiceFabricClientGetApplicationHealthUsingPolicyOptionalParams

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

callback

ServiceCallback<ApplicationHealth>

Обратный вызов

getApplicationInfo(string, ServiceCallback<ApplicationInfo>)

function getApplicationInfo(applicationId: string, callback: ServiceCallback<ApplicationInfo>)

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

callback

ServiceCallback<ApplicationInfo>

Обратный вызов

getApplicationInfo(string, ServiceFabricClientGetApplicationInfoOptionalParams)

Возвращает сведения о приложении, созданном или в процессе создания в кластере Service Fabric, и имя которого совпадает с именем, указанным в качестве параметра. Ответ содержит имя, тип, состояние, параметры и другие сведения о приложении.

function getApplicationInfo(applicationId: string, options?: ServiceFabricClientGetApplicationInfoOptionalParams): Promise<GetApplicationInfoResponse>

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

options
ServiceFabricClientGetApplicationInfoOptionalParams

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

Возвращаемое значение

Обещание<Models.GetApplicationInfoResponse>

getApplicationInfo(string, ServiceFabricClientGetApplicationInfoOptionalParams, ServiceCallback<ApplicationInfo>)

function getApplicationInfo(applicationId: string, options: ServiceFabricClientGetApplicationInfoOptionalParams, callback: ServiceCallback<ApplicationInfo>)

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

options
ServiceFabricClientGetApplicationInfoOptionalParams

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

callback

ServiceCallback<ApplicationInfo>

Обратный вызов

getApplicationInfoList(ServiceCallback<PagedApplicationInfoList>)

function getApplicationInfoList(callback: ServiceCallback<PagedApplicationInfoList>)

Параметры

callback

ServiceCallback<PagedApplicationInfoList>

Обратный вызов

getApplicationInfoList(ServiceFabricClientGetApplicationInfoListOptionalParams)

Возвращает сведения о приложениях, созданных или в процессе создания в кластере Service Fabric, и соответствует указанным фильтрам. Ответ содержит имя, тип, состояние, параметры и другие сведения о приложении. Если приложения не помещаются на страницу, возвращается одна страница результатов, а также маркер продолжения, который можно использовать для получения следующей страницы. Фильтры ApplicationTypeName и ApplicationDefinitionKindFilter нельзя указать одновременно.

function getApplicationInfoList(options?: ServiceFabricClientGetApplicationInfoListOptionalParams): Promise<GetApplicationInfoListResponse>

Параметры

options
ServiceFabricClientGetApplicationInfoListOptionalParams

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

Возвращаемое значение

Обещание<Models.GetApplicationInfoListResponse>

getApplicationInfoList(ServiceFabricClientGetApplicationInfoListOptionalParams, ServiceCallback<PagedApplicationInfoList>)

function getApplicationInfoList(options: ServiceFabricClientGetApplicationInfoListOptionalParams, callback: ServiceCallback<PagedApplicationInfoList>)

Параметры

options
ServiceFabricClientGetApplicationInfoListOptionalParams

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

callback

ServiceCallback<PagedApplicationInfoList>

Обратный вызов

getApplicationLoadInfo(string, ServiceCallback<ApplicationLoadInfo>)

function getApplicationLoadInfo(applicationId: string, callback: ServiceCallback<ApplicationLoadInfo>)

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

callback

ServiceCallback<ApplicationLoadInfo>

Обратный вызов

getApplicationLoadInfo(string, ServiceFabricClientGetApplicationLoadInfoOptionalParams)

Возвращает сведения о загрузке приложения, созданного или в процессе создания в кластере Service Fabric, и имя которого совпадает с именем, указанным в качестве параметра. Ответ содержит имя, минимальные узлы, максимальные узлы, количество узлов, которые приложение занимает в настоящее время, и сведения о метриках загрузки приложения.

function getApplicationLoadInfo(applicationId: string, options?: ServiceFabricClientGetApplicationLoadInfoOptionalParams): Promise<GetApplicationLoadInfoResponse>

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

options
ServiceFabricClientGetApplicationLoadInfoOptionalParams

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

Возвращаемое значение

Обещание<Models.GetApplicationLoadInfoResponse>

getApplicationLoadInfo(string, ServiceFabricClientGetApplicationLoadInfoOptionalParams, ServiceCallback<ApplicationLoadInfo>)

function getApplicationLoadInfo(applicationId: string, options: ServiceFabricClientGetApplicationLoadInfoOptionalParams, callback: ServiceCallback<ApplicationLoadInfo>)

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

options
ServiceFabricClientGetApplicationLoadInfoOptionalParams

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

callback

ServiceCallback<ApplicationLoadInfo>

Обратный вызов

getApplicationManifest(string, string, ServiceCallback<ApplicationTypeManifest>)

function getApplicationManifest(applicationTypeName: string, applicationTypeVersion: string, callback: ServiceCallback<ApplicationTypeManifest>)

Параметры

applicationTypeName

string

Имя типа приложения.

applicationTypeVersion

string

Версия типа приложения.

callback

ServiceCallback<ApplicationTypeManifest>

Обратный вызов

getApplicationManifest(string, string, ServiceFabricClientGetApplicationManifestOptionalParams)

Ответ содержит XML манифеста приложения в виде строки.

function getApplicationManifest(applicationTypeName: string, applicationTypeVersion: string, options?: ServiceFabricClientGetApplicationManifestOptionalParams): Promise<GetApplicationManifestResponse>

Параметры

applicationTypeName

string

Имя типа приложения.

applicationTypeVersion

string

Версия типа приложения.

options
ServiceFabricClientGetApplicationManifestOptionalParams

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

Возвращаемое значение

Обещание<Models.GetApplicationManifestResponse>

getApplicationManifest(string, string, ServiceFabricClientGetApplicationManifestOptionalParams, ServiceCallback<ApplicationTypeManifest>)

function getApplicationManifest(applicationTypeName: string, applicationTypeVersion: string, options: ServiceFabricClientGetApplicationManifestOptionalParams, callback: ServiceCallback<ApplicationTypeManifest>)

Параметры

applicationTypeName

string

Имя типа приложения.

applicationTypeVersion

string

Версия типа приложения.

options
ServiceFabricClientGetApplicationManifestOptionalParams

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

callback

ServiceCallback<ApplicationTypeManifest>

Обратный вызов

getApplicationNameInfo(string, ServiceCallback<ApplicationNameInfo>)

function getApplicationNameInfo(serviceId: string, callback: ServiceCallback<ApplicationNameInfo>)

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

callback

ServiceCallback<ApplicationNameInfo>

Обратный вызов

getApplicationNameInfo(string, ServiceFabricClientGetApplicationNameInfoOptionalParams)

Возвращает имя приложения для указанной службы. Ошибка 404 FABRIC_E_SERVICE_DOES_NOT_EXIST возвращается, если служба с предоставленным идентификатором службы не существует.

function getApplicationNameInfo(serviceId: string, options?: ServiceFabricClientGetApplicationNameInfoOptionalParams): Promise<GetApplicationNameInfoResponse>

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

options
ServiceFabricClientGetApplicationNameInfoOptionalParams

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

Возвращаемое значение

Обещание<Models.GetApplicationNameInfoResponse>

getApplicationNameInfo(string, ServiceFabricClientGetApplicationNameInfoOptionalParams, ServiceCallback<ApplicationNameInfo>)

function getApplicationNameInfo(serviceId: string, options: ServiceFabricClientGetApplicationNameInfoOptionalParams, callback: ServiceCallback<ApplicationNameInfo>)

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

options
ServiceFabricClientGetApplicationNameInfoOptionalParams

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

callback

ServiceCallback<ApplicationNameInfo>

Обратный вызов

getApplicationsEventList(string, string, ServiceCallback<ApplicationEventUnion[]>)

function getApplicationsEventList(startTimeUtc: string, endTimeUtc: string, callback: ServiceCallback<ApplicationEventUnion[]>)

Параметры

startTimeUtc

string

Время начала запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

endTimeUtc

string

Время окончания запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

callback

ServiceCallback<ApplicationEventUnion[]>

Обратный вызов

getApplicationsEventList(string, string, ServiceFabricClientGetApplicationsEventListOptionalParams)

Ответ — это список объектов ApplicationEvent.

function getApplicationsEventList(startTimeUtc: string, endTimeUtc: string, options?: ServiceFabricClientGetApplicationsEventListOptionalParams): Promise<GetApplicationsEventListResponse>

Параметры

startTimeUtc

string

Время начала запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

endTimeUtc

string

Время окончания запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

options
ServiceFabricClientGetApplicationsEventListOptionalParams

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

Возвращаемое значение

Обещание<Models.GetApplicationsEventListResponse>

getApplicationsEventList(string, string, ServiceFabricClientGetApplicationsEventListOptionalParams, ServiceCallback<ApplicationEventUnion[]>)

function getApplicationsEventList(startTimeUtc: string, endTimeUtc: string, options: ServiceFabricClientGetApplicationsEventListOptionalParams, callback: ServiceCallback<ApplicationEventUnion[]>)

Параметры

startTimeUtc

string

Время начала запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

endTimeUtc

string

Время окончания запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

options
ServiceFabricClientGetApplicationsEventListOptionalParams

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

callback

ServiceCallback<ApplicationEventUnion[]>

Обратный вызов

getApplicationTypeInfoList(ServiceCallback<PagedApplicationTypeInfoList>)

function getApplicationTypeInfoList(callback: ServiceCallback<PagedApplicationTypeInfoList>)

Параметры

callback

ServiceCallback<PagedApplicationTypeInfoList>

Обратный вызов

getApplicationTypeInfoList(ServiceFabricClientGetApplicationTypeInfoListOptionalParams)

Возвращает сведения о типах приложений, подготовленных или подготовленных в процессе подготовки в кластере Service Fabric. Каждая версия типа приложения возвращается как один тип приложения. Ответ содержит имя, версию, состояние и другие сведения о типе приложения. Это запрос на страницу, т. е. если не все типы приложений помещаются на страницу, возвращается одна страница результатов, а также маркер продолжения, который можно использовать для получения следующей страницы. Например, если существует 10 типов приложений, но страница соответствует только первым трем типам приложений или если максимальный результат имеет значение 3, то возвращается три. Чтобы получить доступ к остальным результатам, получите последующие страницы с помощью возвращаемого маркера продолжения в следующем запросе. Пустой маркер продолжения возвращается, если последующие страницы отсутствуют.

function getApplicationTypeInfoList(options?: ServiceFabricClientGetApplicationTypeInfoListOptionalParams): Promise<GetApplicationTypeInfoListResponse>

Параметры

options
ServiceFabricClientGetApplicationTypeInfoListOptionalParams

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

Возвращаемое значение

Обещание<Models.GetApplicationTypeInfoListResponse>

getApplicationTypeInfoList(ServiceFabricClientGetApplicationTypeInfoListOptionalParams, ServiceCallback<PagedApplicationTypeInfoList>)

function getApplicationTypeInfoList(options: ServiceFabricClientGetApplicationTypeInfoListOptionalParams, callback: ServiceCallback<PagedApplicationTypeInfoList>)

Параметры

options
ServiceFabricClientGetApplicationTypeInfoListOptionalParams

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

callback

ServiceCallback<PagedApplicationTypeInfoList>

Обратный вызов

getApplicationTypeInfoListByName(string, ServiceCallback<PagedApplicationTypeInfoList>)

function getApplicationTypeInfoListByName(applicationTypeName: string, callback: ServiceCallback<PagedApplicationTypeInfoList>)

Параметры

applicationTypeName

string

Имя типа приложения.

callback

ServiceCallback<PagedApplicationTypeInfoList>

Обратный вызов

getApplicationTypeInfoListByName(string, ServiceFabricClientGetApplicationTypeInfoListByNameOptionalParams)

Возвращает сведения о типах приложений, подготовленных или подготовленных в процессе подготовки в кластере Service Fabric. Эти результаты относятся к типам приложений, имя которых совпадает с именем, указанным в качестве параметра, и которые соответствуют заданным параметрам запроса. Возвращаются все версии типа приложения, соответствующие имени типа приложения, с каждой версией, возвращаемой в качестве одного типа приложения. Ответ содержит имя, версию, состояние и другие сведения о типе приложения. Это запрос на страницу, т. е. если не все типы приложений помещаются на страницу, возвращается одна страница результатов, а также маркер продолжения, который можно использовать для получения следующей страницы. Например, если существует 10 типов приложений, но страница соответствует только первым трем типам приложений или если максимальный результат имеет значение 3, то возвращается три. Чтобы получить доступ к остальным результатам, получите последующие страницы с помощью возвращаемого маркера продолжения в следующем запросе. Пустой маркер продолжения возвращается, если последующие страницы отсутствуют.

function getApplicationTypeInfoListByName(applicationTypeName: string, options?: ServiceFabricClientGetApplicationTypeInfoListByNameOptionalParams): Promise<GetApplicationTypeInfoListByNameResponse>

Параметры

applicationTypeName

string

Имя типа приложения.

options
ServiceFabricClientGetApplicationTypeInfoListByNameOptionalParams

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

Возвращаемое значение

Обещание<Models.GetApplicationTypeInfoListByNameResponse>

getApplicationTypeInfoListByName(string, ServiceFabricClientGetApplicationTypeInfoListByNameOptionalParams, ServiceCallback<PagedApplicationTypeInfoList>)

function getApplicationTypeInfoListByName(applicationTypeName: string, options: ServiceFabricClientGetApplicationTypeInfoListByNameOptionalParams, callback: ServiceCallback<PagedApplicationTypeInfoList>)

Параметры

applicationTypeName

string

Имя типа приложения.

options
ServiceFabricClientGetApplicationTypeInfoListByNameOptionalParams

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

callback

ServiceCallback<PagedApplicationTypeInfoList>

Обратный вызов

getApplicationUpgrade(string, ServiceCallback<ApplicationUpgradeProgressInfo>)

function getApplicationUpgrade(applicationId: string, callback: ServiceCallback<ApplicationUpgradeProgressInfo>)

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

callback

ServiceCallback<ApplicationUpgradeProgressInfo>

Обратный вызов

getApplicationUpgrade(string, ServiceFabricClientGetApplicationUpgradeOptionalParams)

Возвращает сведения о состоянии последнего обновления приложения, а также сведения об отладке проблем с работоспособностью приложений.

function getApplicationUpgrade(applicationId: string, options?: ServiceFabricClientGetApplicationUpgradeOptionalParams): Promise<GetApplicationUpgradeResponse>

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

options
ServiceFabricClientGetApplicationUpgradeOptionalParams

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

Возвращаемое значение

Обещание<Models.GetApplicationUpgradeResponse>

getApplicationUpgrade(string, ServiceFabricClientGetApplicationUpgradeOptionalParams, ServiceCallback<ApplicationUpgradeProgressInfo>)

function getApplicationUpgrade(applicationId: string, options: ServiceFabricClientGetApplicationUpgradeOptionalParams, callback: ServiceCallback<ApplicationUpgradeProgressInfo>)

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

options
ServiceFabricClientGetApplicationUpgradeOptionalParams

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

callback

ServiceCallback<ApplicationUpgradeProgressInfo>

Обратный вызов

getBackupPolicyByName(string, ServiceCallback<BackupPolicyDescription>)

function getBackupPolicyByName(backupPolicyName: string, callback: ServiceCallback<BackupPolicyDescription>)

Параметры

backupPolicyName

string

Имя политики резервного копирования.

callback

ServiceCallback<BackupPolicyDescription>

Обратный вызов

getBackupPolicyByName(string, ServiceFabricClientGetBackupPolicyByNameOptionalParams)

Возвращает определенную политику резервного копирования, определяемую {backupPolicyName}

function getBackupPolicyByName(backupPolicyName: string, options?: ServiceFabricClientGetBackupPolicyByNameOptionalParams): Promise<GetBackupPolicyByNameResponse>

Параметры

backupPolicyName

string

Имя политики резервного копирования.

options
ServiceFabricClientGetBackupPolicyByNameOptionalParams

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

Возвращаемое значение

Обещание<Models.GetBackupPolicyByNameResponse>

getBackupPolicyByName(string, ServiceFabricClientGetBackupPolicyByNameOptionalParams, ServiceCallback<BackupPolicyDescription>)

function getBackupPolicyByName(backupPolicyName: string, options: ServiceFabricClientGetBackupPolicyByNameOptionalParams, callback: ServiceCallback<BackupPolicyDescription>)

Параметры

backupPolicyName

string

Имя политики резервного копирования.

options
ServiceFabricClientGetBackupPolicyByNameOptionalParams

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

callback

ServiceCallback<BackupPolicyDescription>

Обратный вызов

getBackupPolicyList(ServiceCallback<PagedBackupPolicyDescriptionList>)

function getBackupPolicyList(callback: ServiceCallback<PagedBackupPolicyDescriptionList>)

Параметры

callback

ServiceCallback<PagedBackupPolicyDescriptionList>

Обратный вызов

getBackupPolicyList(ServiceFabricClientGetBackupPolicyListOptionalParams)

Получите список всех настроенных политик резервного копирования.

function getBackupPolicyList(options?: ServiceFabricClientGetBackupPolicyListOptionalParams): Promise<GetBackupPolicyListResponse>

Параметры

options
ServiceFabricClientGetBackupPolicyListOptionalParams

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

Возвращаемое значение

Обещание<Models.GetBackupPolicyListResponse>

getBackupPolicyList(ServiceFabricClientGetBackupPolicyListOptionalParams, ServiceCallback<PagedBackupPolicyDescriptionList>)

function getBackupPolicyList(options: ServiceFabricClientGetBackupPolicyListOptionalParams, callback: ServiceCallback<PagedBackupPolicyDescriptionList>)

Параметры

options
ServiceFabricClientGetBackupPolicyListOptionalParams

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

callback

ServiceCallback<PagedBackupPolicyDescriptionList>

Обратный вызов

getBackupsFromBackupLocation(GetBackupByStorageQueryDescription, ServiceCallback<PagedBackupInfoList>)

function getBackupsFromBackupLocation(getBackupByStorageQueryDescription: GetBackupByStorageQueryDescription, callback: ServiceCallback<PagedBackupInfoList>)

Параметры

getBackupByStorageQueryDescription
GetBackupByStorageQueryDescription

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

callback

ServiceCallback<PagedBackupInfoList>

Обратный вызов

getBackupsFromBackupLocation(GetBackupByStorageQueryDescription, ServiceFabricClientGetBackupsFromBackupLocationOptionalParams)

Возвращает список резервных копий, доступных для указанной сущности резервного копирования (приложения, службы или секции) в указанном расположении резервного копирования (FileShare или хранилище BLOB-объектов Azure).

function getBackupsFromBackupLocation(getBackupByStorageQueryDescription: GetBackupByStorageQueryDescription, options?: ServiceFabricClientGetBackupsFromBackupLocationOptionalParams): Promise<GetBackupsFromBackupLocationResponse>

Параметры

getBackupByStorageQueryDescription
GetBackupByStorageQueryDescription

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

options
ServiceFabricClientGetBackupsFromBackupLocationOptionalParams

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

Возвращаемое значение

Обещание<Models.GetBackupsFromBackupLocationResponse>

getBackupsFromBackupLocation(GetBackupByStorageQueryDescription, ServiceFabricClientGetBackupsFromBackupLocationOptionalParams, ServiceCallback<PagedBackupInfoList>)

function getBackupsFromBackupLocation(getBackupByStorageQueryDescription: GetBackupByStorageQueryDescription, options: ServiceFabricClientGetBackupsFromBackupLocationOptionalParams, callback: ServiceCallback<PagedBackupInfoList>)

Параметры

getBackupByStorageQueryDescription
GetBackupByStorageQueryDescription

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

options
ServiceFabricClientGetBackupsFromBackupLocationOptionalParams

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

callback

ServiceCallback<PagedBackupInfoList>

Обратный вызов

getChaos(ServiceCallback<Chaos>)

function getChaos(callback: ServiceCallback<Chaos>)

Параметры

callback

ServiceCallback<Chaos>

Обратный вызов

getChaos(ServiceFabricClientGetChaosOptionalParams)

Получите состояние Хаоса, указывающее, работает ли Хаос, параметры Хаоса, используемые для выполнения хаоса и состояния расписания хаоса.

function getChaos(options?: ServiceFabricClientGetChaosOptionalParams): Promise<GetChaosResponse>

Параметры

options
ServiceFabricClientGetChaosOptionalParams

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

Возвращаемое значение

Promise<GetChaosResponse>

Обещание<Models.GetChaosResponse>

getChaos(ServiceFabricClientGetChaosOptionalParams, ServiceCallback<Chaos>)

function getChaos(options: ServiceFabricClientGetChaosOptionalParams, callback: ServiceCallback<Chaos>)

Параметры

options
ServiceFabricClientGetChaosOptionalParams

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

callback

ServiceCallback<Chaos>

Обратный вызов

getChaosEvents(ServiceCallback<ChaosEventsSegment>)

function getChaosEvents(callback: ServiceCallback<ChaosEventsSegment>)

Параметры

callback

ServiceCallback<ChaosEventsSegment>

Обратный вызов

getChaosEvents(ServiceFabricClientGetChaosEventsOptionalParams)

Чтобы получить следующий сегмент событий Chaos, можно указать Элемент "ПродолжениеToken". Чтобы получить начало нового сегмента событий Chaos, можно указать диапазон времени через StartTimeUtc и EndTimeUtc. В одном вызове нельзя указать значение ContinuationToken и диапазон времени. Если существует более 100 событий Хаоса, события Chaos возвращаются в нескольких сегментах, где сегмент содержит не более 100 событий Хаоса и получить следующий сегмент, который вы вызываете этот API с маркером продолжения.

function getChaosEvents(options?: ServiceFabricClientGetChaosEventsOptionalParams): Promise<GetChaosEventsResponse>

Параметры

options
ServiceFabricClientGetChaosEventsOptionalParams

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

Возвращаемое значение

Обещание<Models.GetChaosEventsResponse>

getChaosEvents(ServiceFabricClientGetChaosEventsOptionalParams, ServiceCallback<ChaosEventsSegment>)

function getChaosEvents(options: ServiceFabricClientGetChaosEventsOptionalParams, callback: ServiceCallback<ChaosEventsSegment>)

Параметры

options
ServiceFabricClientGetChaosEventsOptionalParams

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

callback

ServiceCallback<ChaosEventsSegment>

Обратный вызов

getChaosSchedule(ServiceCallback<ChaosScheduleDescription>)

function getChaosSchedule(callback: ServiceCallback<ChaosScheduleDescription>)

Параметры

callback

ServiceCallback<ChaosScheduleDescription>

Обратный вызов

getChaosSchedule(ServiceFabricClientGetChaosScheduleOptionalParams)

Возвращает версию расписания хаоса, используемого и расписание хаоса, определяющее, когда и как запускать Хаос.

function getChaosSchedule(options?: ServiceFabricClientGetChaosScheduleOptionalParams): Promise<GetChaosScheduleResponse>

Параметры

options
ServiceFabricClientGetChaosScheduleOptionalParams

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

Возвращаемое значение

Обещание<Models.GetChaosScheduleResponse>

getChaosSchedule(ServiceFabricClientGetChaosScheduleOptionalParams, ServiceCallback<ChaosScheduleDescription>)

function getChaosSchedule(options: ServiceFabricClientGetChaosScheduleOptionalParams, callback: ServiceCallback<ChaosScheduleDescription>)

Параметры

options
ServiceFabricClientGetChaosScheduleOptionalParams

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

callback

ServiceCallback<ChaosScheduleDescription>

Обратный вызов

getClusterConfiguration(string, ServiceCallback<ClusterConfiguration>)

function getClusterConfiguration(configurationApiVersion: string, callback: ServiceCallback<ClusterConfiguration>)

Параметры

configurationApiVersion

string

Версия API конфигурации автономного кластера JSON.

callback

ServiceCallback<ClusterConfiguration>

Обратный вызов

getClusterConfiguration(string, ServiceFabricClientGetClusterConfigurationOptionalParams)

Конфигурация кластера содержит свойства кластера, которые включают различные типы узлов в кластере, конфигурации безопасности, отказоустойчивость и топологии домена обновления и т. д.

function getClusterConfiguration(configurationApiVersion: string, options?: ServiceFabricClientGetClusterConfigurationOptionalParams): Promise<GetClusterConfigurationResponse>

Параметры

configurationApiVersion

string

Версия API конфигурации автономного кластера JSON.

options
ServiceFabricClientGetClusterConfigurationOptionalParams

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

Возвращаемое значение

Обещание<Models.GetClusterConfigurationResponse>

getClusterConfiguration(string, ServiceFabricClientGetClusterConfigurationOptionalParams, ServiceCallback<ClusterConfiguration>)

function getClusterConfiguration(configurationApiVersion: string, options: ServiceFabricClientGetClusterConfigurationOptionalParams, callback: ServiceCallback<ClusterConfiguration>)

Параметры

configurationApiVersion

string

Версия API конфигурации автономного кластера JSON.

options
ServiceFabricClientGetClusterConfigurationOptionalParams

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

callback

ServiceCallback<ClusterConfiguration>

Обратный вызов

getClusterConfigurationUpgradeStatus(ServiceCallback<ClusterConfigurationUpgradeStatusInfo>)

function getClusterConfigurationUpgradeStatus(callback: ServiceCallback<ClusterConfigurationUpgradeStatusInfo>)

Параметры

callback

ServiceCallback<ClusterConfigurationUpgradeStatusInfo>

Обратный вызов

getClusterConfigurationUpgradeStatus(ServiceFabricClientGetClusterConfigurationUpgradeStatusOptionalParams)

Получите сведения о состоянии обновления конфигурации кластера автономного кластера Service Fabric.

function getClusterConfigurationUpgradeStatus(options?: ServiceFabricClientGetClusterConfigurationUpgradeStatusOptionalParams): Promise<GetClusterConfigurationUpgradeStatusResponse>

Параметры

options
ServiceFabricClientGetClusterConfigurationUpgradeStatusOptionalParams

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

Возвращаемое значение

Обещание<Models.GetClusterConfigurationUpgradeStatusResponse>

getClusterConfigurationUpgradeStatus(ServiceFabricClientGetClusterConfigurationUpgradeStatusOptionalParams, ServiceCallback<ClusterConfigurationUpgradeStatusInfo>)

function getClusterConfigurationUpgradeStatus(options: ServiceFabricClientGetClusterConfigurationUpgradeStatusOptionalParams, callback: ServiceCallback<ClusterConfigurationUpgradeStatusInfo>)

Параметры

options
ServiceFabricClientGetClusterConfigurationUpgradeStatusOptionalParams

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

callback

ServiceCallback<ClusterConfigurationUpgradeStatusInfo>

Обратный вызов

getClusterEventList(string, string, ServiceCallback<ClusterEventUnion[]>)

function getClusterEventList(startTimeUtc: string, endTimeUtc: string, callback: ServiceCallback<ClusterEventUnion[]>)

Параметры

startTimeUtc

string

Время начала запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

endTimeUtc

string

Время окончания запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

callback

ServiceCallback<ClusterEventUnion[]>

Обратный вызов

getClusterEventList(string, string, ServiceFabricClientGetClusterEventListOptionalParams)

Ответ — это список объектов ClusterEvent.

function getClusterEventList(startTimeUtc: string, endTimeUtc: string, options?: ServiceFabricClientGetClusterEventListOptionalParams): Promise<GetClusterEventListResponse>

Параметры

startTimeUtc

string

Время начала запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

endTimeUtc

string

Время окончания запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

options
ServiceFabricClientGetClusterEventListOptionalParams

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

Возвращаемое значение

Обещание<Models.GetClusterEventListResponse>

getClusterEventList(string, string, ServiceFabricClientGetClusterEventListOptionalParams, ServiceCallback<ClusterEventUnion[]>)

function getClusterEventList(startTimeUtc: string, endTimeUtc: string, options: ServiceFabricClientGetClusterEventListOptionalParams, callback: ServiceCallback<ClusterEventUnion[]>)

Параметры

startTimeUtc

string

Время начала запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

endTimeUtc

string

Время окончания запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

options
ServiceFabricClientGetClusterEventListOptionalParams

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

callback

ServiceCallback<ClusterEventUnion[]>

Обратный вызов

getClusterHealth(ServiceCallback<ClusterHealth>)

function getClusterHealth(callback: ServiceCallback<ClusterHealth>)

Параметры

callback

ServiceCallback<ClusterHealth>

Обратный вызов

getClusterHealth(ServiceFabricClientGetClusterHealthOptionalParams)

Используйте EventsHealthStateFilter, чтобы отфильтровать коллекцию событий работоспособности, сообщаемых в кластере на основе состояния работоспособности. Аналогичным образом используйте NodesHealthStateFilter и ApplicationHealthStateFilter для фильтрации коллекции узлов и приложений, возвращаемых на основе их агрегированного состояния работоспособности.

function getClusterHealth(options?: ServiceFabricClientGetClusterHealthOptionalParams): Promise<GetClusterHealthResponse>

Параметры

options
ServiceFabricClientGetClusterHealthOptionalParams

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

Возвращаемое значение

Обещание<Models.GetClusterHealthResponse>

getClusterHealth(ServiceFabricClientGetClusterHealthOptionalParams, ServiceCallback<ClusterHealth>)

function getClusterHealth(options: ServiceFabricClientGetClusterHealthOptionalParams, callback: ServiceCallback<ClusterHealth>)

Параметры

options
ServiceFabricClientGetClusterHealthOptionalParams

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

callback

ServiceCallback<ClusterHealth>

Обратный вызов

getClusterHealthChunk(ServiceCallback<ClusterHealthChunk>)

function getClusterHealthChunk(callback: ServiceCallback<ClusterHealthChunk>)

Параметры

callback

ServiceCallback<ClusterHealthChunk>

Обратный вызов

getClusterHealthChunk(ServiceFabricClientGetClusterHealthChunkOptionalParams)

Возвращает работоспособность кластера Service Fabric с помощью блоков работоспособности. Включает агрегированное состояние работоспособности кластера, но ни одно из сущностей кластера. Чтобы развернуть работоспособность кластера и получить состояние работоспособности всех или некоторых сущностей, используйте URI POST и укажите описание запроса блока работоспособности кластера.

function getClusterHealthChunk(options?: ServiceFabricClientGetClusterHealthChunkOptionalParams): Promise<GetClusterHealthChunkResponse>

Параметры

options
ServiceFabricClientGetClusterHealthChunkOptionalParams

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

Возвращаемое значение

Обещание<Models.GetClusterHealthChunkResponse>

getClusterHealthChunk(ServiceFabricClientGetClusterHealthChunkOptionalParams, ServiceCallback<ClusterHealthChunk>)

function getClusterHealthChunk(options: ServiceFabricClientGetClusterHealthChunkOptionalParams, callback: ServiceCallback<ClusterHealthChunk>)

Параметры

options
ServiceFabricClientGetClusterHealthChunkOptionalParams

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

callback

ServiceCallback<ClusterHealthChunk>

Обратный вызов

getClusterHealthChunkUsingPolicyAndAdvancedFilters(ServiceCallback<ClusterHealthChunk>)

function getClusterHealthChunkUsingPolicyAndAdvancedFilters(callback: ServiceCallback<ClusterHealthChunk>)

Параметры

callback

ServiceCallback<ClusterHealthChunk>

Обратный вызов

getClusterHealthChunkUsingPolicyAndAdvancedFilters(ServiceFabricClientGetClusterHealthChunkUsingPolicyAndAdvancedFiltersOptionalParams)

Возвращает работоспособность кластера Service Fabric с помощью блоков работоспособности. Оценка работоспособности выполняется на основе описания запроса блока работоспособности входного кластера. Описание запроса позволяет пользователям указывать политики работоспособности для оценки кластера и его дочерних элементов. Пользователи могут указать очень гибкие фильтры для выбора возвращаемых сущностей кластера. Выбор можно выполнить на основе состояния работоспособности сущностей и на основе иерархии. Запрос может возвращать дочерние элементы нескольких уровней сущностей на основе указанных фильтров. Например, он может возвращать одно приложение с указанным именем, а для этого приложения — только службы, которые находятся в разделе "Ошибка" или "Предупреждение", а также все разделы и реплики для одной из этих служб.

function getClusterHealthChunkUsingPolicyAndAdvancedFilters(options?: ServiceFabricClientGetClusterHealthChunkUsingPolicyAndAdvancedFiltersOptionalParams): Promise<GetClusterHealthChunkUsingPolicyAndAdvancedFiltersResponse>

Параметры

options
ServiceFabricClientGetClusterHealthChunkUsingPolicyAndAdvancedFiltersOptionalParams

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

Возвращаемое значение

Обещание<Models.GetClusterHealthChunkUsingPolicyAndAdvancedFiltersResponse>

getClusterHealthChunkUsingPolicyAndAdvancedFilters(ServiceFabricClientGetClusterHealthChunkUsingPolicyAndAdvancedFiltersOptionalParams, ServiceCallback<ClusterHealthChunk>)

function getClusterHealthChunkUsingPolicyAndAdvancedFilters(options: ServiceFabricClientGetClusterHealthChunkUsingPolicyAndAdvancedFiltersOptionalParams, callback: ServiceCallback<ClusterHealthChunk>)

Параметры

options
ServiceFabricClientGetClusterHealthChunkUsingPolicyAndAdvancedFiltersOptionalParams

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

callback

ServiceCallback<ClusterHealthChunk>

Обратный вызов

getClusterHealthUsingPolicy(ServiceCallback<ClusterHealth>)

function getClusterHealthUsingPolicy(callback: ServiceCallback<ClusterHealth>)

Параметры

callback

ServiceCallback<ClusterHealth>

Обратный вызов

getClusterHealthUsingPolicy(ServiceFabricClientGetClusterHealthUsingPolicyOptionalParams)

Используйте EventsHealthStateFilter, чтобы отфильтровать коллекцию событий работоспособности, сообщаемых в кластере на основе состояния работоспособности. Аналогичным образом используйте NodesHealthStateFilter и ApplicationHealthStateFilter для фильтрации коллекции узлов и приложений, возвращаемых на основе их агрегированного состояния работоспособности. Используйте ClusterHealthPolicies для переопределения политик работоспособности, используемых для оценки работоспособности.

function getClusterHealthUsingPolicy(options?: ServiceFabricClientGetClusterHealthUsingPolicyOptionalParams): Promise<GetClusterHealthUsingPolicyResponse>

Параметры

options
ServiceFabricClientGetClusterHealthUsingPolicyOptionalParams

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

Возвращаемое значение

Обещание<Models.GetClusterHealthUsingPolicyResponse>

getClusterHealthUsingPolicy(ServiceFabricClientGetClusterHealthUsingPolicyOptionalParams, ServiceCallback<ClusterHealth>)

function getClusterHealthUsingPolicy(options: ServiceFabricClientGetClusterHealthUsingPolicyOptionalParams, callback: ServiceCallback<ClusterHealth>)

Параметры

options
ServiceFabricClientGetClusterHealthUsingPolicyOptionalParams

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

callback

ServiceCallback<ClusterHealth>

Обратный вызов

getClusterLoad(ServiceCallback<ClusterLoadInfo>)

function getClusterLoad(callback: ServiceCallback<ClusterLoadInfo>)

Параметры

callback

ServiceCallback<ClusterLoadInfo>

Обратный вызов

getClusterLoad(ServiceFabricClientGetClusterLoadOptionalParams)

Извлекает сведения о нагрузке кластера Service Fabric для всех метрик, которые имеют определенную нагрузку или емкость.

function getClusterLoad(options?: ServiceFabricClientGetClusterLoadOptionalParams): Promise<GetClusterLoadResponse>

Параметры

options
ServiceFabricClientGetClusterLoadOptionalParams

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

Возвращаемое значение

Обещание<Models.GetClusterLoadResponse>

getClusterLoad(ServiceFabricClientGetClusterLoadOptionalParams, ServiceCallback<ClusterLoadInfo>)

function getClusterLoad(options: ServiceFabricClientGetClusterLoadOptionalParams, callback: ServiceCallback<ClusterLoadInfo>)

Параметры

options
ServiceFabricClientGetClusterLoadOptionalParams

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

callback

ServiceCallback<ClusterLoadInfo>

Обратный вызов

getClusterManifest(ServiceCallback<ClusterManifest>)

function getClusterManifest(callback: ServiceCallback<ClusterManifest>)

Параметры

callback

ServiceCallback<ClusterManifest>

Обратный вызов

getClusterManifest(ServiceFabricClientGetClusterManifestOptionalParams)

Получите манифест кластера Service Fabric. Манифест кластера содержит свойства кластера, включающих различные типы узлов в кластере, конфигурации безопасности, топологии домена сбоя и обновления и т. д.

Эти свойства указываются как часть файла ClusterConfig.JSON при развертывании автономного кластера. Однако большая часть информации в манифесте кластера создается внутри service fabric во время развертывания кластера в других сценариях развертывания (например, при использовании портала Azure).

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

function getClusterManifest(options?: ServiceFabricClientGetClusterManifestOptionalParams): Promise<GetClusterManifestResponse>

Параметры

options
ServiceFabricClientGetClusterManifestOptionalParams

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

Возвращаемое значение

Обещание<Models.GetClusterManifestResponse>

getClusterManifest(ServiceFabricClientGetClusterManifestOptionalParams, ServiceCallback<ClusterManifest>)

function getClusterManifest(options: ServiceFabricClientGetClusterManifestOptionalParams, callback: ServiceCallback<ClusterManifest>)

Параметры

options
ServiceFabricClientGetClusterManifestOptionalParams

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

callback

ServiceCallback<ClusterManifest>

Обратный вызов

getClusterUpgradeProgress(ServiceCallback<ClusterUpgradeProgressObject>)

function getClusterUpgradeProgress(callback: ServiceCallback<ClusterUpgradeProgressObject>)

Параметры

callback

ServiceCallback<ClusterUpgradeProgressObject>

Обратный вызов

getClusterUpgradeProgress(ServiceFabricClientGetClusterUpgradeProgressOptionalParams)

Возвращает текущий ход выполнения текущего обновления кластера. Если обновление в настоящее время не выполняется, получите последнее состояние предыдущего обновления кластера.

function getClusterUpgradeProgress(options?: ServiceFabricClientGetClusterUpgradeProgressOptionalParams): Promise<GetClusterUpgradeProgressResponse>

Параметры

options
ServiceFabricClientGetClusterUpgradeProgressOptionalParams

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

Возвращаемое значение

Обещание<Models.GetClusterUpgradeProgressResponse>

getClusterUpgradeProgress(ServiceFabricClientGetClusterUpgradeProgressOptionalParams, ServiceCallback<ClusterUpgradeProgressObject>)

function getClusterUpgradeProgress(options: ServiceFabricClientGetClusterUpgradeProgressOptionalParams, callback: ServiceCallback<ClusterUpgradeProgressObject>)

Параметры

options
ServiceFabricClientGetClusterUpgradeProgressOptionalParams

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

callback

ServiceCallback<ClusterUpgradeProgressObject>

Обратный вызов

getClusterVersion(ServiceCallback<ClusterVersion>)

function getClusterVersion(callback: ServiceCallback<ClusterVersion>)

Параметры

callback

ServiceCallback<ClusterVersion>

Обратный вызов

getClusterVersion(ServiceFabricClientGetClusterVersionOptionalParams)

Если происходит обновление кластера, этот API вернет самую низкую (старую) версию текущей и целевой версий среды выполнения кластера.

function getClusterVersion(options?: ServiceFabricClientGetClusterVersionOptionalParams): Promise<GetClusterVersionResponse>

Параметры

options
ServiceFabricClientGetClusterVersionOptionalParams

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

Возвращаемое значение

Обещание<Models.GetClusterVersionResponse>

getClusterVersion(ServiceFabricClientGetClusterVersionOptionalParams, ServiceCallback<ClusterVersion>)

function getClusterVersion(options: ServiceFabricClientGetClusterVersionOptionalParams, callback: ServiceCallback<ClusterVersion>)

Параметры

options
ServiceFabricClientGetClusterVersionOptionalParams

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

callback

ServiceCallback<ClusterVersion>

Обратный вызов

getComposeDeploymentStatus(string, ServiceCallback<ComposeDeploymentStatusInfo>)

function getComposeDeploymentStatus(deploymentName: string, callback: ServiceCallback<ComposeDeploymentStatusInfo>)

Параметры

deploymentName

string

Удостоверение развертывания.

callback

ServiceCallback<ComposeDeploymentStatusInfo>

Обратный вызов

getComposeDeploymentStatus(string, ServiceFabricClientGetComposeDeploymentStatusOptionalParams)

Возвращает состояние развертывания создания, созданного или в процессе создания в кластере Service Fabric, имя которого совпадает с именем, указанным в качестве параметра. Ответ содержит имя, состояние и другие сведения о развертывании.

function getComposeDeploymentStatus(deploymentName: string, options?: ServiceFabricClientGetComposeDeploymentStatusOptionalParams): Promise<GetComposeDeploymentStatusResponse>

Параметры

deploymentName

string

Удостоверение развертывания.

options
ServiceFabricClientGetComposeDeploymentStatusOptionalParams

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

Возвращаемое значение

Обещание<Models.GetComposeDeploymentStatusResponse>

getComposeDeploymentStatus(string, ServiceFabricClientGetComposeDeploymentStatusOptionalParams, ServiceCallback<ComposeDeploymentStatusInfo>)

function getComposeDeploymentStatus(deploymentName: string, options: ServiceFabricClientGetComposeDeploymentStatusOptionalParams, callback: ServiceCallback<ComposeDeploymentStatusInfo>)

Параметры

deploymentName

string

Удостоверение развертывания.

options
ServiceFabricClientGetComposeDeploymentStatusOptionalParams

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

callback

ServiceCallback<ComposeDeploymentStatusInfo>

Обратный вызов

getComposeDeploymentStatusList(ServiceCallback<PagedComposeDeploymentStatusInfoList>)

function getComposeDeploymentStatusList(callback: ServiceCallback<PagedComposeDeploymentStatusInfoList>)

Параметры

callback

ServiceCallback<PagedComposeDeploymentStatusInfoList>

Обратный вызов

getComposeDeploymentStatusList(ServiceFabricClientGetComposeDeploymentStatusListOptionalParams)

Получает состояние о развертываниях создания, созданных или в процессе создания в кластере Service Fabric. Ответ содержит имя, состояние и другие сведения о развертываниях создания. Если список развертываний не помещается на страницу, возвращается одна страница результатов, а также маркер продолжения, который можно использовать для получения следующей страницы.

function getComposeDeploymentStatusList(options?: ServiceFabricClientGetComposeDeploymentStatusListOptionalParams): Promise<GetComposeDeploymentStatusListResponse>

Параметры

options
ServiceFabricClientGetComposeDeploymentStatusListOptionalParams

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

Возвращаемое значение

Обещание<Models.GetComposeDeploymentStatusListResponse>

getComposeDeploymentStatusList(ServiceFabricClientGetComposeDeploymentStatusListOptionalParams, ServiceCallback<PagedComposeDeploymentStatusInfoList>)

function getComposeDeploymentStatusList(options: ServiceFabricClientGetComposeDeploymentStatusListOptionalParams, callback: ServiceCallback<PagedComposeDeploymentStatusInfoList>)

Параметры

options
ServiceFabricClientGetComposeDeploymentStatusListOptionalParams

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

callback

ServiceCallback<PagedComposeDeploymentStatusInfoList>

Обратный вызов

getComposeDeploymentUpgradeProgress(string, ServiceCallback<ComposeDeploymentUpgradeProgressInfo>)

function getComposeDeploymentUpgradeProgress(deploymentName: string, callback: ServiceCallback<ComposeDeploymentUpgradeProgressInfo>)

Параметры

deploymentName

string

Удостоверение развертывания.

callback

ServiceCallback<ComposeDeploymentUpgradeProgressInfo>

Обратный вызов

getComposeDeploymentUpgradeProgress(string, ServiceFabricClientGetComposeDeploymentUpgradeProgressOptionalParams)

Возвращает сведения о состоянии обновления развертывания создания вместе с подробными сведениями для устранения проблем с работоспособностью приложений.

function getComposeDeploymentUpgradeProgress(deploymentName: string, options?: ServiceFabricClientGetComposeDeploymentUpgradeProgressOptionalParams): Promise<GetComposeDeploymentUpgradeProgressResponse>

Параметры

deploymentName

string

Удостоверение развертывания.

options
ServiceFabricClientGetComposeDeploymentUpgradeProgressOptionalParams

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

Возвращаемое значение

Обещание<Models.GetComposeDeploymentUpgradeProgressResponse>

getComposeDeploymentUpgradeProgress(string, ServiceFabricClientGetComposeDeploymentUpgradeProgressOptionalParams, ServiceCallback<ComposeDeploymentUpgradeProgressInfo>)

function getComposeDeploymentUpgradeProgress(deploymentName: string, options: ServiceFabricClientGetComposeDeploymentUpgradeProgressOptionalParams, callback: ServiceCallback<ComposeDeploymentUpgradeProgressInfo>)

Параметры

deploymentName

string

Удостоверение развертывания.

options
ServiceFabricClientGetComposeDeploymentUpgradeProgressOptionalParams

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

callback

ServiceCallback<ComposeDeploymentUpgradeProgressInfo>

Обратный вызов

getConfigurationOverrides(string, ServiceCallback<ConfigParameterOverride[]>)

function getConfigurationOverrides(nodeName: string, callback: ServiceCallback<ConfigParameterOverride[]>)

Параметры

nodeName

string

Имя узла.

callback

ServiceCallback<ConfigParameterOverride[]>

Обратный вызов

getConfigurationOverrides(string, ServiceFabricClientGetConfigurationOverridesOptionalParams)

Этот API позволяет получать все существующие переопределения конфигурации на указанном узле.

function getConfigurationOverrides(nodeName: string, options?: ServiceFabricClientGetConfigurationOverridesOptionalParams): Promise<GetConfigurationOverridesResponse>

Параметры

nodeName

string

Имя узла.

options
ServiceFabricClientGetConfigurationOverridesOptionalParams

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

Возвращаемое значение

Обещание<Models.GetConfigurationOverridesResponse>

getConfigurationOverrides(string, ServiceFabricClientGetConfigurationOverridesOptionalParams, ServiceCallback<ConfigParameterOverride[]>)

function getConfigurationOverrides(nodeName: string, options: ServiceFabricClientGetConfigurationOverridesOptionalParams, callback: ServiceCallback<ConfigParameterOverride[]>)

Параметры

nodeName

string

Имя узла.

options
ServiceFabricClientGetConfigurationOverridesOptionalParams

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

callback

ServiceCallback<ConfigParameterOverride[]>

Обратный вызов

getContainerLogsDeployedOnNode(string, string, string, string, ServiceCallback<ContainerLogs>)

function getContainerLogsDeployedOnNode(nodeName: string, applicationId: string, serviceManifestName: string, codePackageName: string, callback: ServiceCallback<ContainerLogs>)

Параметры

nodeName

string

Имя узла.

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

serviceManifestName

string

Имя манифеста службы, зарегистрированного в составе типа приложения в кластере Service Fabric.

codePackageName

string

Имя пакета кода, указанного в манифесте службы, зарегистрированном в составе типа приложения в кластере Service Fabric.

callback

ServiceCallback<ContainerLogs>

Обратный вызов

getContainerLogsDeployedOnNode(string, string, string, string, ServiceFabricClientGetContainerLogsDeployedOnNodeOptionalParams)

Возвращает журналы контейнеров для контейнера, развернутого на узле Service Fabric для заданного пакета кода.

function getContainerLogsDeployedOnNode(nodeName: string, applicationId: string, serviceManifestName: string, codePackageName: string, options?: ServiceFabricClientGetContainerLogsDeployedOnNodeOptionalParams): Promise<GetContainerLogsDeployedOnNodeResponse>

Параметры

nodeName

string

Имя узла.

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

serviceManifestName

string

Имя манифеста службы, зарегистрированного в составе типа приложения в кластере Service Fabric.

codePackageName

string

Имя пакета кода, указанного в манифесте службы, зарегистрированном в составе типа приложения в кластере Service Fabric.

options
ServiceFabricClientGetContainerLogsDeployedOnNodeOptionalParams

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

Возвращаемое значение

Обещание<Models.GetContainerLogsDeployedOnNodeResponse>

getContainerLogsDeployedOnNode(string, string, string, string, ServiceFabricClientGetContainerLogsDeployedOnNodeOptionalParams, ServiceCallback<ContainerLogs>)

function getContainerLogsDeployedOnNode(nodeName: string, applicationId: string, serviceManifestName: string, codePackageName: string, options: ServiceFabricClientGetContainerLogsDeployedOnNodeOptionalParams, callback: ServiceCallback<ContainerLogs>)

Параметры

nodeName

string

Имя узла.

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

serviceManifestName

string

Имя манифеста службы, зарегистрированного в составе типа приложения в кластере Service Fabric.

codePackageName

string

Имя пакета кода, указанного в манифесте службы, зарегистрированном в составе типа приложения в кластере Service Fabric.

options
ServiceFabricClientGetContainerLogsDeployedOnNodeOptionalParams

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

callback

ServiceCallback<ContainerLogs>

Обратный вызов

getContainersEventList(string, string, ServiceCallback<ContainerInstanceEvent[]>)

function getContainersEventList(startTimeUtc: string, endTimeUtc: string, callback: ServiceCallback<ContainerInstanceEvent[]>)

Параметры

startTimeUtc

string

Время начала запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

endTimeUtc

string

Время окончания запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

callback

ServiceCallback<ContainerInstanceEvent[]>

Обратный вызов

getContainersEventList(string, string, ServiceFabricClientGetContainersEventListOptionalParams)

Ответ — это список объектов ContainerInstanceEvent.

function getContainersEventList(startTimeUtc: string, endTimeUtc: string, options?: ServiceFabricClientGetContainersEventListOptionalParams): Promise<GetContainersEventListResponse>

Параметры

startTimeUtc

string

Время начала запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

endTimeUtc

string

Время окончания запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

options
ServiceFabricClientGetContainersEventListOptionalParams

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

Возвращаемое значение

Обещание<Models.GetContainersEventListResponse>

getContainersEventList(string, string, ServiceFabricClientGetContainersEventListOptionalParams, ServiceCallback<ContainerInstanceEvent[]>)

function getContainersEventList(startTimeUtc: string, endTimeUtc: string, options: ServiceFabricClientGetContainersEventListOptionalParams, callback: ServiceCallback<ContainerInstanceEvent[]>)

Параметры

startTimeUtc

string

Время начала запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

endTimeUtc

string

Время окончания запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

options
ServiceFabricClientGetContainersEventListOptionalParams

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

callback

ServiceCallback<ContainerInstanceEvent[]>

Обратный вызов

getCorrelatedEventList(string, ServiceCallback<FabricEventUnion[]>)

function getCorrelatedEventList(eventInstanceId: string, callback: ServiceCallback<FabricEventUnion[]>)

Параметры

eventInstanceId

string

Идентификатор EventInstanceId.

callback

ServiceCallback<FabricEventUnion[]>

Обратный вызов

getCorrelatedEventList(string, ServiceFabricClientGetCorrelatedEventListOptionalParams)

Ответ — это список FabricEvents.

function getCorrelatedEventList(eventInstanceId: string, options?: ServiceFabricClientGetCorrelatedEventListOptionalParams): Promise<GetCorrelatedEventListResponse>

Параметры

eventInstanceId

string

Идентификатор EventInstanceId.

options
ServiceFabricClientGetCorrelatedEventListOptionalParams

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

Возвращаемое значение

Обещание<Models.GetCorrelatedEventListResponse>

getCorrelatedEventList(string, ServiceFabricClientGetCorrelatedEventListOptionalParams, ServiceCallback<FabricEventUnion[]>)

function getCorrelatedEventList(eventInstanceId: string, options: ServiceFabricClientGetCorrelatedEventListOptionalParams, callback: ServiceCallback<FabricEventUnion[]>)

Параметры

eventInstanceId

string

Идентификатор EventInstanceId.

options
ServiceFabricClientGetCorrelatedEventListOptionalParams

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

callback

ServiceCallback<FabricEventUnion[]>

Обратный вызов

getDataLossProgress(string, string, string, ServiceCallback<PartitionDataLossProgress>)

function getDataLossProgress(serviceId: string, partitionId: string, operationId: string, callback: ServiceCallback<PartitionDataLossProgress>)

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

partitionId

string

Удостоверение секции.

operationId

string

ИДЕНТИФИКАТОР GUID, определяющий вызов этого API. Это передается в соответствующий API GetProgress

callback

ServiceCallback<PartitionDataLossProgress>

Обратный вызов

getDataLossProgress(string, string, string, ServiceFabricClientGetDataLossProgressOptionalParams)

Возвращает ход операции потери данных, запущенной с StartDataLoss, с помощью OperationId.

function getDataLossProgress(serviceId: string, partitionId: string, operationId: string, options?: ServiceFabricClientGetDataLossProgressOptionalParams): Promise<GetDataLossProgressResponse>

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

partitionId

string

Удостоверение секции.

operationId

string

ИДЕНТИФИКАТОР GUID, определяющий вызов этого API. Это передается в соответствующий API GetProgress

options
ServiceFabricClientGetDataLossProgressOptionalParams

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

Возвращаемое значение

Обещание<Models.GetDataLossProgressResponse>

getDataLossProgress(string, string, string, ServiceFabricClientGetDataLossProgressOptionalParams, ServiceCallback<PartitionDataLossProgress>)

function getDataLossProgress(serviceId: string, partitionId: string, operationId: string, options: ServiceFabricClientGetDataLossProgressOptionalParams, callback: ServiceCallback<PartitionDataLossProgress>)

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

partitionId

string

Удостоверение секции.

operationId

string

ИДЕНТИФИКАТОР GUID, определяющий вызов этого API. Это передается в соответствующий API GetProgress

options
ServiceFabricClientGetDataLossProgressOptionalParams

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

callback

ServiceCallback<PartitionDataLossProgress>

Обратный вызов

getDeployedApplicationHealth(string, string, ServiceCallback<DeployedApplicationHealth>)

function getDeployedApplicationHealth(nodeName: string, applicationId: string, callback: ServiceCallback<DeployedApplicationHealth>)

Параметры

nodeName

string

Имя узла.

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

callback

ServiceCallback<DeployedApplicationHealth>

Обратный вызов

getDeployedApplicationHealth(string, string, ServiceFabricClientGetDeployedApplicationHealthOptionalParams)

Возвращает сведения о работоспособности приложения, развернутого на узле Service Fabric. Используйте EventsHealthStateFilter, чтобы при необходимости отфильтровать коллекцию объектов HealthEvent, сообщаемых в развернутом приложении на основе состояния работоспособности. Используйте DeployedServicePackagesHealthStateFilter, чтобы при необходимости фильтровать дочерние элементы DeployedServicePackageHealth на основе состояния работоспособности.

function getDeployedApplicationHealth(nodeName: string, applicationId: string, options?: ServiceFabricClientGetDeployedApplicationHealthOptionalParams): Promise<GetDeployedApplicationHealthResponse>

Параметры

nodeName

string

Имя узла.

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

options
ServiceFabricClientGetDeployedApplicationHealthOptionalParams

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

Возвращаемое значение

Обещание<Models.GetDeployedApplicationHealthResponse>

getDeployedApplicationHealth(string, string, ServiceFabricClientGetDeployedApplicationHealthOptionalParams, ServiceCallback<DeployedApplicationHealth>)

function getDeployedApplicationHealth(nodeName: string, applicationId: string, options: ServiceFabricClientGetDeployedApplicationHealthOptionalParams, callback: ServiceCallback<DeployedApplicationHealth>)

Параметры

nodeName

string

Имя узла.

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

options
ServiceFabricClientGetDeployedApplicationHealthOptionalParams

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

callback

ServiceCallback<DeployedApplicationHealth>

Обратный вызов

getDeployedApplicationHealthUsingPolicy(string, string, ServiceCallback<DeployedApplicationHealth>)

function getDeployedApplicationHealthUsingPolicy(nodeName: string, applicationId: string, callback: ServiceCallback<DeployedApplicationHealth>)

Параметры

nodeName

string

Имя узла.

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

callback

ServiceCallback<DeployedApplicationHealth>

Обратный вызов

getDeployedApplicationHealthUsingPolicy(string, string, ServiceFabricClientGetDeployedApplicationHealthUsingPolicyOptionalParams)

Возвращает сведения о работоспособности приложения, развернутого на узле Service Fabric с помощью указанной политики. Используйте EventsHealthStateFilter, чтобы при необходимости отфильтровать коллекцию объектов HealthEvent, сообщаемых в развернутом приложении на основе состояния работоспособности. Используйте DeployedServicePackagesHealthStateFilter, чтобы при необходимости фильтровать дочерние элементы DeployedServicePackageHealth на основе состояния работоспособности. Используйте ApplicationHealthPolicy, чтобы при необходимости переопределить политики работоспособности, используемые для оценки работоспособности. Этот API использует только поле "ConsiderWarningAsError" приложения ApplicationHealthPolicy. Остальные поля игнорируются при оценке работоспособности развернутого приложения.

function getDeployedApplicationHealthUsingPolicy(nodeName: string, applicationId: string, options?: ServiceFabricClientGetDeployedApplicationHealthUsingPolicyOptionalParams): Promise<GetDeployedApplicationHealthUsingPolicyResponse>

Параметры

nodeName

string

Имя узла.

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

options
ServiceFabricClientGetDeployedApplicationHealthUsingPolicyOptionalParams

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

Возвращаемое значение

Обещание<Models.GetDeployedApplicationHealthUsingPolicyResponse>

getDeployedApplicationHealthUsingPolicy(string, string, ServiceFabricClientGetDeployedApplicationHealthUsingPolicyOptionalParams, ServiceCallback<DeployedApplicationHealth>)

function getDeployedApplicationHealthUsingPolicy(nodeName: string, applicationId: string, options: ServiceFabricClientGetDeployedApplicationHealthUsingPolicyOptionalParams, callback: ServiceCallback<DeployedApplicationHealth>)

Параметры

nodeName

string

Имя узла.

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

options
ServiceFabricClientGetDeployedApplicationHealthUsingPolicyOptionalParams

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

callback

ServiceCallback<DeployedApplicationHealth>

Обратный вызов

getDeployedApplicationInfo(string, string, ServiceCallback<DeployedApplicationInfo>)

function getDeployedApplicationInfo(nodeName: string, applicationId: string, callback: ServiceCallback<DeployedApplicationInfo>)

Параметры

nodeName

string

Имя узла.

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

callback

ServiceCallback<DeployedApplicationInfo>

Обратный вызов

getDeployedApplicationInfo(string, string, ServiceFabricClientGetDeployedApplicationInfoOptionalParams)

Этот запрос возвращает системные сведения о приложении, если идентификатор приложения указан для системного приложения. Результаты включают развернутые приложения в активных, активациях и скачивании состояний. Этот запрос требует, чтобы имя узла соответствовало узлу в кластере. Запрос завершается ошибкой, если предоставленное имя узла не указывает на активные узлы Service Fabric в кластере.

function getDeployedApplicationInfo(nodeName: string, applicationId: string, options?: ServiceFabricClientGetDeployedApplicationInfoOptionalParams): Promise<GetDeployedApplicationInfoResponse>

Параметры

nodeName

string

Имя узла.

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

options
ServiceFabricClientGetDeployedApplicationInfoOptionalParams

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

Возвращаемое значение

Обещание<Models.GetDeployedApplicationInfoResponse>

getDeployedApplicationInfo(string, string, ServiceFabricClientGetDeployedApplicationInfoOptionalParams, ServiceCallback<DeployedApplicationInfo>)

function getDeployedApplicationInfo(nodeName: string, applicationId: string, options: ServiceFabricClientGetDeployedApplicationInfoOptionalParams, callback: ServiceCallback<DeployedApplicationInfo>)

Параметры

nodeName

string

Имя узла.

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

options
ServiceFabricClientGetDeployedApplicationInfoOptionalParams

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

callback

ServiceCallback<DeployedApplicationInfo>

Обратный вызов

getDeployedApplicationInfoList(string, ServiceCallback<PagedDeployedApplicationInfoList>)

function getDeployedApplicationInfoList(nodeName: string, callback: ServiceCallback<PagedDeployedApplicationInfoList>)

Параметры

nodeName

string

Имя узла.

callback

ServiceCallback<PagedDeployedApplicationInfoList>

Обратный вызов

getDeployedApplicationInfoList(string, ServiceFabricClientGetDeployedApplicationInfoListOptionalParams)

Возвращает список приложений, развернутых на узле Service Fabric. Результаты не содержат сведения о развернутых системных приложениях, если явно не запрашиваются по идентификатору. Результаты включают развернутые приложения в активных, активациях и скачивании состояний. Этот запрос требует, чтобы имя узла соответствовало узлу в кластере. Запрос завершается ошибкой, если предоставленное имя узла не указывает на активные узлы Service Fabric в кластере.

function getDeployedApplicationInfoList(nodeName: string, options?: ServiceFabricClientGetDeployedApplicationInfoListOptionalParams): Promise<GetDeployedApplicationInfoListResponse>

Параметры

nodeName

string

Имя узла.

options
ServiceFabricClientGetDeployedApplicationInfoListOptionalParams

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

Возвращаемое значение

Обещание<Models.GetDeployedApplicationInfoListResponse>

getDeployedApplicationInfoList(string, ServiceFabricClientGetDeployedApplicationInfoListOptionalParams, ServiceCallback<PagedDeployedApplicationInfoList>)

function getDeployedApplicationInfoList(nodeName: string, options: ServiceFabricClientGetDeployedApplicationInfoListOptionalParams, callback: ServiceCallback<PagedDeployedApplicationInfoList>)

Параметры

nodeName

string

Имя узла.

options
ServiceFabricClientGetDeployedApplicationInfoListOptionalParams

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

callback

ServiceCallback<PagedDeployedApplicationInfoList>

Обратный вызов

getDeployedCodePackageInfoList(string, string, ServiceCallback<DeployedCodePackageInfo[]>)

function getDeployedCodePackageInfoList(nodeName: string, applicationId: string, callback: ServiceCallback<DeployedCodePackageInfo[]>)

Параметры

nodeName

string

Имя узла.

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

callback

ServiceCallback<DeployedCodePackageInfo[]>

Обратный вызов

getDeployedCodePackageInfoList(string, string, ServiceFabricClientGetDeployedCodePackageInfoListOptionalParams)

Возвращает список пакетов кода, развернутых на узле Service Fabric для данного приложения.

function getDeployedCodePackageInfoList(nodeName: string, applicationId: string, options?: ServiceFabricClientGetDeployedCodePackageInfoListOptionalParams): Promise<GetDeployedCodePackageInfoListResponse>

Параметры

nodeName

string

Имя узла.

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

options
ServiceFabricClientGetDeployedCodePackageInfoListOptionalParams

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

Возвращаемое значение

Обещание<Models.GetDeployedCodePackageInfoListResponse>

getDeployedCodePackageInfoList(string, string, ServiceFabricClientGetDeployedCodePackageInfoListOptionalParams, ServiceCallback<DeployedCodePackageInfo[]>)

function getDeployedCodePackageInfoList(nodeName: string, applicationId: string, options: ServiceFabricClientGetDeployedCodePackageInfoListOptionalParams, callback: ServiceCallback<DeployedCodePackageInfo[]>)

Параметры

nodeName

string

Имя узла.

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

options
ServiceFabricClientGetDeployedCodePackageInfoListOptionalParams

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

callback

ServiceCallback<DeployedCodePackageInfo[]>

Обратный вызов

getDeployedServicePackageHealth(string, string, string, ServiceCallback<DeployedServicePackageHealth>)

function getDeployedServicePackageHealth(nodeName: string, applicationId: string, servicePackageName: string, callback: ServiceCallback<DeployedServicePackageHealth>)

Параметры

nodeName

string

Имя узла.

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

servicePackageName

string

Имя пакета службы.

callback

ServiceCallback<DeployedServicePackageHealth>

Обратный вызов

getDeployedServicePackageHealth(string, string, string, ServiceFabricClientGetDeployedServicePackageHealthOptionalParams)

Возвращает сведения о работоспособности пакета службы для конкретного приложения, развернутого на узле Service Fabric. Используйте EventsHealthStateFilter, чтобы при необходимости фильтровать коллекцию объектов HealthEvent, сообщаемых о развернутом пакете службы на основе состояния работоспособности.

function getDeployedServicePackageHealth(nodeName: string, applicationId: string, servicePackageName: string, options?: ServiceFabricClientGetDeployedServicePackageHealthOptionalParams): Promise<GetDeployedServicePackageHealthResponse>

Параметры

nodeName

string

Имя узла.

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

servicePackageName

string

Имя пакета службы.

options
ServiceFabricClientGetDeployedServicePackageHealthOptionalParams

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

Возвращаемое значение

Обещание<Models.GetDeployedServicePackageHealthResponse>

getDeployedServicePackageHealth(string, string, string, ServiceFabricClientGetDeployedServicePackageHealthOptionalParams, ServiceCallback<DeployedServicePackageHealth>)

function getDeployedServicePackageHealth(nodeName: string, applicationId: string, servicePackageName: string, options: ServiceFabricClientGetDeployedServicePackageHealthOptionalParams, callback: ServiceCallback<DeployedServicePackageHealth>)

Параметры

nodeName

string

Имя узла.

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

servicePackageName

string

Имя пакета службы.

options
ServiceFabricClientGetDeployedServicePackageHealthOptionalParams

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

callback

ServiceCallback<DeployedServicePackageHealth>

Обратный вызов

getDeployedServicePackageHealthUsingPolicy(string, string, string, ServiceCallback<DeployedServicePackageHealth>)

function getDeployedServicePackageHealthUsingPolicy(nodeName: string, applicationId: string, servicePackageName: string, callback: ServiceCallback<DeployedServicePackageHealth>)

Параметры

nodeName

string

Имя узла.

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

servicePackageName

string

Имя пакета службы.

callback

ServiceCallback<DeployedServicePackageHealth>

Обратный вызов

getDeployedServicePackageHealthUsingPolicy(string, string, string, ServiceFabricClientGetDeployedServicePackageHealthUsingPolicyOptionalParams)

Возвращает сведения о работоспособности пакета службы для конкретного приложения, развернутого на узле Service Fabric. с помощью указанной политики. Используйте EventsHealthStateFilter, чтобы при необходимости фильтровать коллекцию объектов HealthEvent, сообщаемых о развернутом пакете службы на основе состояния работоспособности. Используйте ApplicationHealthPolicy, чтобы при необходимости переопределить политики работоспособности, используемые для оценки работоспособности. Этот API использует только поле "ConsiderWarningAsError" приложения ApplicationHealthPolicy. Остальные поля игнорируются при оценке работоспособности развернутого пакета службы.

function getDeployedServicePackageHealthUsingPolicy(nodeName: string, applicationId: string, servicePackageName: string, options?: ServiceFabricClientGetDeployedServicePackageHealthUsingPolicyOptionalParams): Promise<GetDeployedServicePackageHealthUsingPolicyResponse>

Параметры

nodeName

string

Имя узла.

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

servicePackageName

string

Имя пакета службы.

options
ServiceFabricClientGetDeployedServicePackageHealthUsingPolicyOptionalParams

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

Возвращаемое значение

Обещание<Models.GetDeployedServicePackageHealthUsingPolicyResponse>

getDeployedServicePackageHealthUsingPolicy(string, string, string, ServiceFabricClientGetDeployedServicePackageHealthUsingPolicyOptionalParams, ServiceCallback<DeployedServicePackageHealth>)

function getDeployedServicePackageHealthUsingPolicy(nodeName: string, applicationId: string, servicePackageName: string, options: ServiceFabricClientGetDeployedServicePackageHealthUsingPolicyOptionalParams, callback: ServiceCallback<DeployedServicePackageHealth>)

Параметры

nodeName

string

Имя узла.

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

servicePackageName

string

Имя пакета службы.

options
ServiceFabricClientGetDeployedServicePackageHealthUsingPolicyOptionalParams

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

callback

ServiceCallback<DeployedServicePackageHealth>

Обратный вызов

getDeployedServicePackageInfoList(string, string, ServiceCallback<DeployedServicePackageInfo[]>)

function getDeployedServicePackageInfoList(nodeName: string, applicationId: string, callback: ServiceCallback<DeployedServicePackageInfo[]>)

Параметры

nodeName

string

Имя узла.

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

callback

ServiceCallback<DeployedServicePackageInfo[]>

Обратный вызов

getDeployedServicePackageInfoList(string, string, ServiceFabricClientGetDeployedServicePackageInfoListOptionalParams)

Возвращает сведения о пакетах служб, развернутых на узле Service Fabric для данного приложения.

function getDeployedServicePackageInfoList(nodeName: string, applicationId: string, options?: ServiceFabricClientGetDeployedServicePackageInfoListOptionalParams): Promise<GetDeployedServicePackageInfoListResponse>

Параметры

nodeName

string

Имя узла.

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

options
ServiceFabricClientGetDeployedServicePackageInfoListOptionalParams

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

Возвращаемое значение

Обещание<Models.GetDeployedServicePackageInfoListResponse>

getDeployedServicePackageInfoList(string, string, ServiceFabricClientGetDeployedServicePackageInfoListOptionalParams, ServiceCallback<DeployedServicePackageInfo[]>)

function getDeployedServicePackageInfoList(nodeName: string, applicationId: string, options: ServiceFabricClientGetDeployedServicePackageInfoListOptionalParams, callback: ServiceCallback<DeployedServicePackageInfo[]>)

Параметры

nodeName

string

Имя узла.

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

options
ServiceFabricClientGetDeployedServicePackageInfoListOptionalParams

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

callback

ServiceCallback<DeployedServicePackageInfo[]>

Обратный вызов

getDeployedServicePackageInfoListByName(string, string, string, ServiceCallback<DeployedServicePackageInfo[]>)

function getDeployedServicePackageInfoListByName(nodeName: string, applicationId: string, servicePackageName: string, callback: ServiceCallback<DeployedServicePackageInfo[]>)

Параметры

nodeName

string

Имя узла.

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

servicePackageName

string

Имя пакета службы.

callback

ServiceCallback<DeployedServicePackageInfo[]>

Обратный вызов

getDeployedServicePackageInfoListByName(string, string, string, ServiceFabricClientGetDeployedServicePackageInfoListByNameOptionalParams)

Возвращает сведения о пакетах служб, развернутых на узле Service Fabric для данного приложения. Эти результаты представляют собой пакеты служб, имя которых совпадает с именем пакета службы, указанным в качестве параметра.

function getDeployedServicePackageInfoListByName(nodeName: string, applicationId: string, servicePackageName: string, options?: ServiceFabricClientGetDeployedServicePackageInfoListByNameOptionalParams): Promise<GetDeployedServicePackageInfoListByNameResponse>

Параметры

nodeName

string

Имя узла.

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

servicePackageName

string

Имя пакета службы.

options
ServiceFabricClientGetDeployedServicePackageInfoListByNameOptionalParams

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

Возвращаемое значение

Обещание<Models.GetDeployedServicePackageInfoListByNameResponse>

getDeployedServicePackageInfoListByName(string, string, string, ServiceFabricClientGetDeployedServicePackageInfoListByNameOptionalParams, ServiceCallback<DeployedServicePackageInfo[]>)

function getDeployedServicePackageInfoListByName(nodeName: string, applicationId: string, servicePackageName: string, options: ServiceFabricClientGetDeployedServicePackageInfoListByNameOptionalParams, callback: ServiceCallback<DeployedServicePackageInfo[]>)

Параметры

nodeName

string

Имя узла.

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

servicePackageName

string

Имя пакета службы.

options
ServiceFabricClientGetDeployedServicePackageInfoListByNameOptionalParams

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

callback

ServiceCallback<DeployedServicePackageInfo[]>

Обратный вызов

getDeployedServiceReplicaDetailInfo(string, string, string, ServiceCallback<DeployedServiceReplicaDetailInfoUnion>)

function getDeployedServiceReplicaDetailInfo(nodeName: string, partitionId: string, replicaId: string, callback: ServiceCallback<DeployedServiceReplicaDetailInfoUnion>)

Параметры

nodeName

string

Имя узла.

partitionId

string

Удостоверение секции.

replicaId

string

Идентификатор реплики.

callback

ServiceCallback<DeployedServiceReplicaDetailInfoUnion>

Обратный вызов

getDeployedServiceReplicaDetailInfo(string, string, string, ServiceFabricClientGetDeployedServiceReplicaDetailInfoOptionalParams)

Возвращает сведения о реплике, развернутой на узле Service Fabric. Сведения включают тип службы, имя службы, текущую операцию службы, время начала текущей операции службы, идентификатор секции, идентификатор реплики и экземпляра, сообщаемую нагрузку и другие сведения.

function getDeployedServiceReplicaDetailInfo(nodeName: string, partitionId: string, replicaId: string, options?: ServiceFabricClientGetDeployedServiceReplicaDetailInfoOptionalParams): Promise<GetDeployedServiceReplicaDetailInfoResponse>

Параметры

nodeName

string

Имя узла.

partitionId

string

Удостоверение секции.

replicaId

string

Идентификатор реплики.

options
ServiceFabricClientGetDeployedServiceReplicaDetailInfoOptionalParams

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

Возвращаемое значение

Обещание<Models.GetDeployedServiceReplicaDetailInfoResponse>

getDeployedServiceReplicaDetailInfo(string, string, string, ServiceFabricClientGetDeployedServiceReplicaDetailInfoOptionalParams, ServiceCallback<DeployedServiceReplicaDetailInfoUnion>)

function getDeployedServiceReplicaDetailInfo(nodeName: string, partitionId: string, replicaId: string, options: ServiceFabricClientGetDeployedServiceReplicaDetailInfoOptionalParams, callback: ServiceCallback<DeployedServiceReplicaDetailInfoUnion>)

Параметры

nodeName

string

Имя узла.

partitionId

string

Удостоверение секции.

replicaId

string

Идентификатор реплики.

options
ServiceFabricClientGetDeployedServiceReplicaDetailInfoOptionalParams

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

callback

ServiceCallback<DeployedServiceReplicaDetailInfoUnion>

Обратный вызов

getDeployedServiceReplicaDetailInfoByPartitionId(string, string, ServiceCallback<DeployedServiceReplicaDetailInfoUnion>)

function getDeployedServiceReplicaDetailInfoByPartitionId(nodeName: string, partitionId: string, callback: ServiceCallback<DeployedServiceReplicaDetailInfoUnion>)

Параметры

nodeName

string

Имя узла.

partitionId

string

Удостоверение секции.

callback

ServiceCallback<DeployedServiceReplicaDetailInfoUnion>

Обратный вызов

getDeployedServiceReplicaDetailInfoByPartitionId(string, string, ServiceFabricClientGetDeployedServiceReplicaDetailInfoByPartitionIdOptionalParams)

Возвращает сведения о реплике, развернутой на узле Service Fabric. Сведения включают тип службы, имя службы, текущую операцию службы, время начала текущей операции службы, идентификатор секции, идентификатор реплики и экземпляра, сообщаемую нагрузку и другие сведения.

function getDeployedServiceReplicaDetailInfoByPartitionId(nodeName: string, partitionId: string, options?: ServiceFabricClientGetDeployedServiceReplicaDetailInfoByPartitionIdOptionalParams): Promise<GetDeployedServiceReplicaDetailInfoByPartitionIdResponse>

Параметры

nodeName

string

Имя узла.

partitionId

string

Удостоверение секции.

options
ServiceFabricClientGetDeployedServiceReplicaDetailInfoByPartitionIdOptionalParams

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

Возвращаемое значение

Обещание<Models.GetDeployedServiceReplicaDetailInfoByPartitionIdResponse>

getDeployedServiceReplicaDetailInfoByPartitionId(string, string, ServiceFabricClientGetDeployedServiceReplicaDetailInfoByPartitionIdOptionalParams, ServiceCallback<DeployedServiceReplicaDetailInfoUnion>)

function getDeployedServiceReplicaDetailInfoByPartitionId(nodeName: string, partitionId: string, options: ServiceFabricClientGetDeployedServiceReplicaDetailInfoByPartitionIdOptionalParams, callback: ServiceCallback<DeployedServiceReplicaDetailInfoUnion>)

Параметры

nodeName

string

Имя узла.

partitionId

string

Удостоверение секции.

options
ServiceFabricClientGetDeployedServiceReplicaDetailInfoByPartitionIdOptionalParams

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

callback

ServiceCallback<DeployedServiceReplicaDetailInfoUnion>

Обратный вызов

getDeployedServiceReplicaInfoList(string, string, ServiceCallback<DeployedServiceReplicaInfoUnion[]>)

function getDeployedServiceReplicaInfoList(nodeName: string, applicationId: string, callback: ServiceCallback<DeployedServiceReplicaInfoUnion[]>)

Параметры

nodeName

string

Имя узла.

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

callback

ServiceCallback<DeployedServiceReplicaInfoUnion[]>

Обратный вызов

getDeployedServiceReplicaInfoList(string, string, ServiceFabricClientGetDeployedServiceReplicaInfoListOptionalParams)

Возвращает список, содержащий сведения о репликах, развернутых на узле Service Fabric. Сведения включают идентификатор секции, идентификатор реплики, состояние реплики, имя службы, имя типа службы и другие сведения. Используйте параметры запроса PartitionId или ServiceManifestName для возврата сведений о развернутых репликах, соответствующих указанным значениям этих параметров.

function getDeployedServiceReplicaInfoList(nodeName: string, applicationId: string, options?: ServiceFabricClientGetDeployedServiceReplicaInfoListOptionalParams): Promise<GetDeployedServiceReplicaInfoListResponse>

Параметры

nodeName

string

Имя узла.

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

options
ServiceFabricClientGetDeployedServiceReplicaInfoListOptionalParams

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

Возвращаемое значение

Обещание<Models.GetDeployedServiceReplicaInfoListResponse>

getDeployedServiceReplicaInfoList(string, string, ServiceFabricClientGetDeployedServiceReplicaInfoListOptionalParams, ServiceCallback<DeployedServiceReplicaInfoUnion[]>)

function getDeployedServiceReplicaInfoList(nodeName: string, applicationId: string, options: ServiceFabricClientGetDeployedServiceReplicaInfoListOptionalParams, callback: ServiceCallback<DeployedServiceReplicaInfoUnion[]>)

Параметры

nodeName

string

Имя узла.

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

options
ServiceFabricClientGetDeployedServiceReplicaInfoListOptionalParams

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

callback

ServiceCallback<DeployedServiceReplicaInfoUnion[]>

Обратный вызов

getDeployedServiceTypeInfoByName(string, string, string, ServiceCallback<DeployedServiceTypeInfo[]>)

function getDeployedServiceTypeInfoByName(nodeName: string, applicationId: string, serviceTypeName: string, callback: ServiceCallback<DeployedServiceTypeInfo[]>)

Параметры

nodeName

string

Имя узла.

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

serviceTypeName

string

Указывает имя типа службы Service Fabric.

callback

ServiceCallback<DeployedServiceTypeInfo[]>

Обратный вызов

getDeployedServiceTypeInfoByName(string, string, string, ServiceFabricClientGetDeployedServiceTypeInfoByNameOptionalParams)

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

function getDeployedServiceTypeInfoByName(nodeName: string, applicationId: string, serviceTypeName: string, options?: ServiceFabricClientGetDeployedServiceTypeInfoByNameOptionalParams): Promise<GetDeployedServiceTypeInfoByNameResponse>

Параметры

nodeName

string

Имя узла.

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

serviceTypeName

string

Указывает имя типа службы Service Fabric.

options
ServiceFabricClientGetDeployedServiceTypeInfoByNameOptionalParams

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

Возвращаемое значение

Обещание<Models.GetDeployedServiceTypeInfoByNameResponse>

getDeployedServiceTypeInfoByName(string, string, string, ServiceFabricClientGetDeployedServiceTypeInfoByNameOptionalParams, ServiceCallback<DeployedServiceTypeInfo[]>)

function getDeployedServiceTypeInfoByName(nodeName: string, applicationId: string, serviceTypeName: string, options: ServiceFabricClientGetDeployedServiceTypeInfoByNameOptionalParams, callback: ServiceCallback<DeployedServiceTypeInfo[]>)

Параметры

nodeName

string

Имя узла.

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

serviceTypeName

string

Указывает имя типа службы Service Fabric.

options
ServiceFabricClientGetDeployedServiceTypeInfoByNameOptionalParams

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

callback

ServiceCallback<DeployedServiceTypeInfo[]>

Обратный вызов

getDeployedServiceTypeInfoList(string, string, ServiceCallback<DeployedServiceTypeInfo[]>)

function getDeployedServiceTypeInfoList(nodeName: string, applicationId: string, callback: ServiceCallback<DeployedServiceTypeInfo[]>)

Параметры

nodeName

string

Имя узла.

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

callback

ServiceCallback<DeployedServiceTypeInfo[]>

Обратный вызов

getDeployedServiceTypeInfoList(string, string, ServiceFabricClientGetDeployedServiceTypeInfoListOptionalParams)

Возвращает список, содержащий сведения о типах служб из приложений, развернутых на узле в кластере Service Fabric. Ответ содержит имя типа службы, его состояние регистрации, пакет кода, который зарегистрировал его и идентификатор активации пакета службы.

function getDeployedServiceTypeInfoList(nodeName: string, applicationId: string, options?: ServiceFabricClientGetDeployedServiceTypeInfoListOptionalParams): Promise<GetDeployedServiceTypeInfoListResponse>

Параметры

nodeName

string

Имя узла.

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

options
ServiceFabricClientGetDeployedServiceTypeInfoListOptionalParams

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

Возвращаемое значение

Обещание<Models.GetDeployedServiceTypeInfoListResponse>

getDeployedServiceTypeInfoList(string, string, ServiceFabricClientGetDeployedServiceTypeInfoListOptionalParams, ServiceCallback<DeployedServiceTypeInfo[]>)

function getDeployedServiceTypeInfoList(nodeName: string, applicationId: string, options: ServiceFabricClientGetDeployedServiceTypeInfoListOptionalParams, callback: ServiceCallback<DeployedServiceTypeInfo[]>)

Параметры

nodeName

string

Имя узла.

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

options
ServiceFabricClientGetDeployedServiceTypeInfoListOptionalParams

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

callback

ServiceCallback<DeployedServiceTypeInfo[]>

Обратный вызов

getFaultOperationList(number, number, ServiceCallback<OperationStatus[]>)

function getFaultOperationList(typeFilter: number, stateFilter: number, callback: ServiceCallback<OperationStatus[]>)

Параметры

typeFilter

number

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

  • 65535 — выберите все
  • 1 — выберите PartitionDataLoss.
  • 2 — выберите PartitionQuorumLoss.
  • 4. Выберите PartitionRestart.
  • 8 — выберите NodeTransition.
stateFilter

number

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

  • 65535 — выберите "Все"
  • 1. Выберите "Запуск"
  • 2. Выбор rollingBack
  • 8. Выберите "Завершено"
  • 16— выбор ошибки
  • 32— выберите "Отменено"
  • 64 — выбор ForceCancelled
callback

ServiceCallback<OperationStatus[]>

Обратный вызов

getFaultOperationList(number, number, ServiceFabricClientGetFaultOperationListOptionalParams)

Возвращает список операций сбоя, вызванных пользователем, отфильтрованных по предоставленным входным данным.

function getFaultOperationList(typeFilter: number, stateFilter: number, options?: ServiceFabricClientGetFaultOperationListOptionalParams): Promise<GetFaultOperationListResponse>

Параметры

typeFilter

number

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

  • 65535 — выберите все
  • 1 — выберите PartitionDataLoss.
  • 2 — выберите PartitionQuorumLoss.
  • 4. Выберите PartitionRestart.
  • 8 — выберите NodeTransition.
stateFilter

number

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

  • 65535 — выберите "Все"
  • 1. Выберите "Запуск"
  • 2. Выбор rollingBack
  • 8. Выберите "Завершено"
  • 16— выбор ошибки
  • 32— выберите "Отменено"
  • 64 — выбор ForceCancelled
options
ServiceFabricClientGetFaultOperationListOptionalParams

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

Возвращаемое значение

Обещание<Models.GetFaultOperationListResponse>

getFaultOperationList(number, number, ServiceFabricClientGetFaultOperationListOptionalParams, ServiceCallback<OperationStatus[]>)

function getFaultOperationList(typeFilter: number, stateFilter: number, options: ServiceFabricClientGetFaultOperationListOptionalParams, callback: ServiceCallback<OperationStatus[]>)

Параметры

typeFilter

number

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

  • 65535 — выберите все
  • 1 — выберите PartitionDataLoss.
  • 2 — выберите PartitionQuorumLoss.
  • 4. Выберите PartitionRestart.
  • 8 — выберите NodeTransition.
stateFilter

number

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

  • 65535 — выберите "Все"
  • 1. Выберите "Запуск"
  • 2. Выбор rollingBack
  • 8. Выберите "Завершено"
  • 16— выбор ошибки
  • 32— выберите "Отменено"
  • 64 — выбор ForceCancelled
options
ServiceFabricClientGetFaultOperationListOptionalParams

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

callback

ServiceCallback<OperationStatus[]>

Обратный вызов

getImageStoreContent(string, ServiceCallback<ImageStoreContent>)

function getImageStoreContent(contentPath: string, callback: ServiceCallback<ImageStoreContent>)

Параметры

contentPath

string

Относительный путь к файлу или папке в хранилище образов из корневого каталога.

callback

ServiceCallback<ImageStoreContent>

Обратный вызов

getImageStoreContent(string, ServiceFabricClientGetImageStoreContentOptionalParams)

Возвращает сведения о содержимом хранилища изображений в указанном contentPath. ContentPath относится к корню хранилища образов.

function getImageStoreContent(contentPath: string, options?: ServiceFabricClientGetImageStoreContentOptionalParams): Promise<GetImageStoreContentResponse>

Параметры

contentPath

string

Относительный путь к файлу или папке в хранилище образов из корневого каталога.

options
ServiceFabricClientGetImageStoreContentOptionalParams

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

Возвращаемое значение

Обещание<Models.GetImageStoreContentResponse>

getImageStoreContent(string, ServiceFabricClientGetImageStoreContentOptionalParams, ServiceCallback<ImageStoreContent>)

function getImageStoreContent(contentPath: string, options: ServiceFabricClientGetImageStoreContentOptionalParams, callback: ServiceCallback<ImageStoreContent>)

Параметры

contentPath

string

Относительный путь к файлу или папке в хранилище образов из корневого каталога.

options
ServiceFabricClientGetImageStoreContentOptionalParams

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

callback

ServiceCallback<ImageStoreContent>

Обратный вызов

getImageStoreFolderSize(string, ServiceCallback<FolderSizeInfo>)

function getImageStoreFolderSize(contentPath: string, callback: ServiceCallback<FolderSizeInfo>)

Параметры

contentPath

string

Относительный путь к файлу или папке в хранилище образов из корневого каталога.

callback

ServiceCallback<FolderSizeInfo>

Обратный вызов

getImageStoreFolderSize(string, ServiceFabricClientGetImageStoreFolderSizeOptionalParams)

Возвращает общий размер файла в папке хранилища изображений, указанной contentPath. ContentPath относится к корню хранилища образов.

function getImageStoreFolderSize(contentPath: string, options?: ServiceFabricClientGetImageStoreFolderSizeOptionalParams): Promise<GetImageStoreFolderSizeResponse>

Параметры

contentPath

string

Относительный путь к файлу или папке в хранилище образов из корневого каталога.

options
ServiceFabricClientGetImageStoreFolderSizeOptionalParams

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

Возвращаемое значение

Обещание<Models.GetImageStoreFolderSizeResponse>

getImageStoreFolderSize(string, ServiceFabricClientGetImageStoreFolderSizeOptionalParams, ServiceCallback<FolderSizeInfo>)

function getImageStoreFolderSize(contentPath: string, options: ServiceFabricClientGetImageStoreFolderSizeOptionalParams, callback: ServiceCallback<FolderSizeInfo>)

Параметры

contentPath

string

Относительный путь к файлу или папке в хранилище образов из корневого каталога.

options
ServiceFabricClientGetImageStoreFolderSizeOptionalParams

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

callback

ServiceCallback<FolderSizeInfo>

Обратный вызов

getImageStoreInfo(ServiceCallback<ImageStoreInfo>)

function getImageStoreInfo(callback: ServiceCallback<ImageStoreInfo>)

Параметры

callback

ServiceCallback<ImageStoreInfo>

Обратный вызов

getImageStoreInfo(ServiceFabricClientGetImageStoreInfoOptionalParams)

Возвращает сведения о первичной реплике ImageStore, такой как емкость диска и доступное место на узле, и несколько категорий использования файловой системы ImageStore.

function getImageStoreInfo(options?: ServiceFabricClientGetImageStoreInfoOptionalParams): Promise<GetImageStoreInfoResponse>

Параметры

options
ServiceFabricClientGetImageStoreInfoOptionalParams

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

Возвращаемое значение

Обещание<Models.GetImageStoreInfoResponse>

getImageStoreInfo(ServiceFabricClientGetImageStoreInfoOptionalParams, ServiceCallback<ImageStoreInfo>)

function getImageStoreInfo(options: ServiceFabricClientGetImageStoreInfoOptionalParams, callback: ServiceCallback<ImageStoreInfo>)

Параметры

options
ServiceFabricClientGetImageStoreInfoOptionalParams

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

callback

ServiceCallback<ImageStoreInfo>

Обратный вызов

getImageStoreRootContent(ServiceCallback<ImageStoreContent>)

function getImageStoreRootContent(callback: ServiceCallback<ImageStoreContent>)

Параметры

callback

ServiceCallback<ImageStoreContent>

Обратный вызов

getImageStoreRootContent(ServiceFabricClientGetImageStoreRootContentOptionalParams)

Возвращает сведения о содержимом хранилища изображений в корне хранилища образов.

function getImageStoreRootContent(options?: ServiceFabricClientGetImageStoreRootContentOptionalParams): Promise<GetImageStoreRootContentResponse>

Параметры

options
ServiceFabricClientGetImageStoreRootContentOptionalParams

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

Возвращаемое значение

Обещание<Models.GetImageStoreRootContentResponse>

getImageStoreRootContent(ServiceFabricClientGetImageStoreRootContentOptionalParams, ServiceCallback<ImageStoreContent>)

function getImageStoreRootContent(options: ServiceFabricClientGetImageStoreRootContentOptionalParams, callback: ServiceCallback<ImageStoreContent>)

Параметры

options
ServiceFabricClientGetImageStoreRootContentOptionalParams

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

callback

ServiceCallback<ImageStoreContent>

Обратный вызов

getImageStoreRootFolderSize(ServiceCallback<FolderSizeInfo>)

function getImageStoreRootFolderSize(callback: ServiceCallback<FolderSizeInfo>)

Параметры

callback

ServiceCallback<FolderSizeInfo>

Обратный вызов

getImageStoreRootFolderSize(ServiceFabricClientGetImageStoreRootFolderSizeOptionalParams)

Возвращает общий размер файлов в корневой папке и дочерних папках в хранилище образов.

function getImageStoreRootFolderSize(options?: ServiceFabricClientGetImageStoreRootFolderSizeOptionalParams): Promise<GetImageStoreRootFolderSizeResponse>

Параметры

options
ServiceFabricClientGetImageStoreRootFolderSizeOptionalParams

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

Возвращаемое значение

Обещание<Models.GetImageStoreRootFolderSizeResponse>

getImageStoreRootFolderSize(ServiceFabricClientGetImageStoreRootFolderSizeOptionalParams, ServiceCallback<FolderSizeInfo>)

function getImageStoreRootFolderSize(options: ServiceFabricClientGetImageStoreRootFolderSizeOptionalParams, callback: ServiceCallback<FolderSizeInfo>)

Параметры

options
ServiceFabricClientGetImageStoreRootFolderSizeOptionalParams

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

callback

ServiceCallback<FolderSizeInfo>

Обратный вызов

getImageStoreUploadSessionById(string, ServiceCallback<UploadSession>)

function getImageStoreUploadSessionById(sessionId: string, callback: ServiceCallback<UploadSession>)

Параметры

sessionId

string

GUID, созданный пользователем для отправки файла. Он определяет сеанс отправки хранилища образов, который отслеживает все блоки файлов, пока не будет зафиксировано.

callback

ServiceCallback<UploadSession>

Обратный вызов

getImageStoreUploadSessionById(string, ServiceFabricClientGetImageStoreUploadSessionByIdOptionalParams)

Возвращает сеанс отправки хранилища образов, определенный заданным идентификатором. Пользователь может запрашивать сеанс отправки в любое время во время отправки.

function getImageStoreUploadSessionById(sessionId: string, options?: ServiceFabricClientGetImageStoreUploadSessionByIdOptionalParams): Promise<GetImageStoreUploadSessionByIdResponse>

Параметры

sessionId

string

GUID, созданный пользователем для отправки файла. Он определяет сеанс отправки хранилища образов, который отслеживает все блоки файлов, пока не будет зафиксировано.

options
ServiceFabricClientGetImageStoreUploadSessionByIdOptionalParams

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

Возвращаемое значение

Обещание<Models.GetImageStoreUploadSessionByIdResponse>

getImageStoreUploadSessionById(string, ServiceFabricClientGetImageStoreUploadSessionByIdOptionalParams, ServiceCallback<UploadSession>)

function getImageStoreUploadSessionById(sessionId: string, options: ServiceFabricClientGetImageStoreUploadSessionByIdOptionalParams, callback: ServiceCallback<UploadSession>)

Параметры

sessionId

string

GUID, созданный пользователем для отправки файла. Он определяет сеанс отправки хранилища образов, который отслеживает все блоки файлов, пока не будет зафиксировано.

options
ServiceFabricClientGetImageStoreUploadSessionByIdOptionalParams

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

callback

ServiceCallback<UploadSession>

Обратный вызов

getImageStoreUploadSessionByPath(string, ServiceCallback<UploadSession>)

function getImageStoreUploadSessionByPath(contentPath: string, callback: ServiceCallback<UploadSession>)

Параметры

contentPath

string

Относительный путь к файлу или папке в хранилище образов из корневого каталога.

callback

ServiceCallback<UploadSession>

Обратный вызов

getImageStoreUploadSessionByPath(string, ServiceFabricClientGetImageStoreUploadSessionByPathOptionalParams)

Получает сеанс отправки хранилища образов, связанный с заданным относительным путем хранилища образов. Пользователь может запрашивать сеанс отправки в любое время во время отправки.

function getImageStoreUploadSessionByPath(contentPath: string, options?: ServiceFabricClientGetImageStoreUploadSessionByPathOptionalParams): Promise<GetImageStoreUploadSessionByPathResponse>

Параметры

contentPath

string

Относительный путь к файлу или папке в хранилище образов из корневого каталога.

options
ServiceFabricClientGetImageStoreUploadSessionByPathOptionalParams

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

Возвращаемое значение

Обещание<Models.GetImageStoreUploadSessionByPathResponse>

getImageStoreUploadSessionByPath(string, ServiceFabricClientGetImageStoreUploadSessionByPathOptionalParams, ServiceCallback<UploadSession>)

function getImageStoreUploadSessionByPath(contentPath: string, options: ServiceFabricClientGetImageStoreUploadSessionByPathOptionalParams, callback: ServiceCallback<UploadSession>)

Параметры

contentPath

string

Относительный путь к файлу или папке в хранилище образов из корневого каталога.

options
ServiceFabricClientGetImageStoreUploadSessionByPathOptionalParams

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

callback

ServiceCallback<UploadSession>

Обратный вызов

getNameExistsInfo(string, ServiceCallback<void>)

function getNameExistsInfo(nameId: string, callback: ServiceCallback<void>)

Параметры

nameId

string

Имя Service Fabric без схемы URI fabric:.

callback

ServiceCallback<void>

Обратный вызов

getNameExistsInfo(string, ServiceFabricClientGetNameExistsInfoOptionalParams)

Возвращает значение, существует ли указанное имя Service Fabric.

function getNameExistsInfo(nameId: string, options?: ServiceFabricClientGetNameExistsInfoOptionalParams): Promise<RestResponse>

Параметры

nameId

string

Имя Service Fabric без схемы URI fabric:.

options
ServiceFabricClientGetNameExistsInfoOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

getNameExistsInfo(string, ServiceFabricClientGetNameExistsInfoOptionalParams, ServiceCallback<void>)

function getNameExistsInfo(nameId: string, options: ServiceFabricClientGetNameExistsInfoOptionalParams, callback: ServiceCallback<void>)

Параметры

nameId

string

Имя Service Fabric без схемы URI fabric:.

options
ServiceFabricClientGetNameExistsInfoOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

getNodeEventList(string, string, string, ServiceCallback<NodeEventUnion[]>)

function getNodeEventList(nodeName: string, startTimeUtc: string, endTimeUtc: string, callback: ServiceCallback<NodeEventUnion[]>)

Параметры

nodeName

string

Имя узла.

startTimeUtc

string

Время начала запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

endTimeUtc

string

Время окончания запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

callback

ServiceCallback<NodeEventUnion[]>

Обратный вызов

getNodeEventList(string, string, string, ServiceFabricClientGetNodeEventListOptionalParams)

Ответ — это список объектов NodeEvent.

function getNodeEventList(nodeName: string, startTimeUtc: string, endTimeUtc: string, options?: ServiceFabricClientGetNodeEventListOptionalParams): Promise<GetNodeEventListResponse>

Параметры

nodeName

string

Имя узла.

startTimeUtc

string

Время начала запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

endTimeUtc

string

Время окончания запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

options
ServiceFabricClientGetNodeEventListOptionalParams

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

Возвращаемое значение

Обещание<Models.GetNodeEventListResponse>

getNodeEventList(string, string, string, ServiceFabricClientGetNodeEventListOptionalParams, ServiceCallback<NodeEventUnion[]>)

function getNodeEventList(nodeName: string, startTimeUtc: string, endTimeUtc: string, options: ServiceFabricClientGetNodeEventListOptionalParams, callback: ServiceCallback<NodeEventUnion[]>)

Параметры

nodeName

string

Имя узла.

startTimeUtc

string

Время начала запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

endTimeUtc

string

Время окончания запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

options
ServiceFabricClientGetNodeEventListOptionalParams

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

callback

ServiceCallback<NodeEventUnion[]>

Обратный вызов

getNodeHealth(string, ServiceCallback<NodeHealth>)

function getNodeHealth(nodeName: string, callback: ServiceCallback<NodeHealth>)

Параметры

nodeName

string

Имя узла.

callback

ServiceCallback<NodeHealth>

Обратный вызов

getNodeHealth(string, ServiceFabricClientGetNodeHealthOptionalParams)

Возвращает работоспособность узла Service Fabric. Используйте EventsHealthStateFilter, чтобы отфильтровать коллекцию событий работоспособности, сообщаемых на узле на основе состояния работоспособности. Если узел, указанный по имени, не существует в хранилище работоспособности, это возвращает ошибку.

function getNodeHealth(nodeName: string, options?: ServiceFabricClientGetNodeHealthOptionalParams): Promise<GetNodeHealthResponse>

Параметры

nodeName

string

Имя узла.

options
ServiceFabricClientGetNodeHealthOptionalParams

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

Возвращаемое значение

Обещание<Models.GetNodeHealthResponse>

getNodeHealth(string, ServiceFabricClientGetNodeHealthOptionalParams, ServiceCallback<NodeHealth>)

function getNodeHealth(nodeName: string, options: ServiceFabricClientGetNodeHealthOptionalParams, callback: ServiceCallback<NodeHealth>)

Параметры

nodeName

string

Имя узла.

options
ServiceFabricClientGetNodeHealthOptionalParams

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

callback

ServiceCallback<NodeHealth>

Обратный вызов

getNodeHealthUsingPolicy(string, ServiceCallback<NodeHealth>)

function getNodeHealthUsingPolicy(nodeName: string, callback: ServiceCallback<NodeHealth>)

Параметры

nodeName

string

Имя узла.

callback

ServiceCallback<NodeHealth>

Обратный вызов

getNodeHealthUsingPolicy(string, ServiceFabricClientGetNodeHealthUsingPolicyOptionalParams)

Возвращает работоспособность узла Service Fabric. Используйте EventsHealthStateFilter, чтобы отфильтровать коллекцию событий работоспособности, сообщаемых на узле на основе состояния работоспособности. Используйте ClusterHealthPolicy в теле POST для переопределения политик работоспособности, используемых для оценки работоспособности. Если узел, указанный по имени, не существует в хранилище работоспособности, это возвращает ошибку.

function getNodeHealthUsingPolicy(nodeName: string, options?: ServiceFabricClientGetNodeHealthUsingPolicyOptionalParams): Promise<GetNodeHealthUsingPolicyResponse>

Параметры

nodeName

string

Имя узла.

options
ServiceFabricClientGetNodeHealthUsingPolicyOptionalParams

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

Возвращаемое значение

Обещание<Models.GetNodeHealthUsingPolicyResponse>

getNodeHealthUsingPolicy(string, ServiceFabricClientGetNodeHealthUsingPolicyOptionalParams, ServiceCallback<NodeHealth>)

function getNodeHealthUsingPolicy(nodeName: string, options: ServiceFabricClientGetNodeHealthUsingPolicyOptionalParams, callback: ServiceCallback<NodeHealth>)

Параметры

nodeName

string

Имя узла.

options
ServiceFabricClientGetNodeHealthUsingPolicyOptionalParams

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

callback

ServiceCallback<NodeHealth>

Обратный вызов

getNodeInfo(string, ServiceCallback<NodeInfo>)

function getNodeInfo(nodeName: string, callback: ServiceCallback<NodeInfo>)

Параметры

nodeName

string

Имя узла.

callback

ServiceCallback<NodeInfo>

Обратный вызов

getNodeInfo(string, ServiceFabricClientGetNodeInfoOptionalParams)

Ответ содержит имя, состояние, идентификатор, работоспособности, время простоя и другие сведения о узле.

function getNodeInfo(nodeName: string, options?: ServiceFabricClientGetNodeInfoOptionalParams): Promise<GetNodeInfoResponse>

Параметры

nodeName

string

Имя узла.

options
ServiceFabricClientGetNodeInfoOptionalParams

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

Возвращаемое значение

Обещание<Models.GetNodeInfoResponse>

getNodeInfo(string, ServiceFabricClientGetNodeInfoOptionalParams, ServiceCallback<NodeInfo>)

function getNodeInfo(nodeName: string, options: ServiceFabricClientGetNodeInfoOptionalParams, callback: ServiceCallback<NodeInfo>)

Параметры

nodeName

string

Имя узла.

options
ServiceFabricClientGetNodeInfoOptionalParams

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

callback

ServiceCallback<NodeInfo>

Обратный вызов

getNodeInfoList(ServiceCallback<PagedNodeInfoList>)

function getNodeInfoList(callback: ServiceCallback<PagedNodeInfoList>)

Параметры

callback

ServiceCallback<PagedNodeInfoList>

Обратный вызов

getNodeInfoList(ServiceFabricClientGetNodeInfoListOptionalParams)

Ответ содержит имя, состояние, идентификатор, работоспособности, время простоя и другие сведения о узлах.

function getNodeInfoList(options?: ServiceFabricClientGetNodeInfoListOptionalParams): Promise<GetNodeInfoListResponse>

Параметры

options
ServiceFabricClientGetNodeInfoListOptionalParams

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

Возвращаемое значение

Обещание<Models.GetNodeInfoListResponse>

getNodeInfoList(ServiceFabricClientGetNodeInfoListOptionalParams, ServiceCallback<PagedNodeInfoList>)

function getNodeInfoList(options: ServiceFabricClientGetNodeInfoListOptionalParams, callback: ServiceCallback<PagedNodeInfoList>)

Параметры

options
ServiceFabricClientGetNodeInfoListOptionalParams

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

callback

ServiceCallback<PagedNodeInfoList>

Обратный вызов

getNodeLoadInfo(string, ServiceCallback<NodeLoadInfo>)

function getNodeLoadInfo(nodeName: string, callback: ServiceCallback<NodeLoadInfo>)

Параметры

nodeName

string

Имя узла.

callback

ServiceCallback<NodeLoadInfo>

Обратный вызов

getNodeLoadInfo(string, ServiceFabricClientGetNodeLoadInfoOptionalParams)

Извлекает сведения о загрузке узла Service Fabric для всех метрик, которые имеют определенную нагрузку или емкость.

function getNodeLoadInfo(nodeName: string, options?: ServiceFabricClientGetNodeLoadInfoOptionalParams): Promise<GetNodeLoadInfoResponse>

Параметры

nodeName

string

Имя узла.

options
ServiceFabricClientGetNodeLoadInfoOptionalParams

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

Возвращаемое значение

Обещание<Models.GetNodeLoadInfoResponse>

getNodeLoadInfo(string, ServiceFabricClientGetNodeLoadInfoOptionalParams, ServiceCallback<NodeLoadInfo>)

function getNodeLoadInfo(nodeName: string, options: ServiceFabricClientGetNodeLoadInfoOptionalParams, callback: ServiceCallback<NodeLoadInfo>)

Параметры

nodeName

string

Имя узла.

options
ServiceFabricClientGetNodeLoadInfoOptionalParams

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

callback

ServiceCallback<NodeLoadInfo>

Обратный вызов

getNodesEventList(string, string, ServiceCallback<NodeEventUnion[]>)

function getNodesEventList(startTimeUtc: string, endTimeUtc: string, callback: ServiceCallback<NodeEventUnion[]>)

Параметры

startTimeUtc

string

Время начала запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

endTimeUtc

string

Время окончания запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

callback

ServiceCallback<NodeEventUnion[]>

Обратный вызов

getNodesEventList(string, string, ServiceFabricClientGetNodesEventListOptionalParams)

Ответ — это список объектов NodeEvent.

function getNodesEventList(startTimeUtc: string, endTimeUtc: string, options?: ServiceFabricClientGetNodesEventListOptionalParams): Promise<GetNodesEventListResponse>

Параметры

startTimeUtc

string

Время начала запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

endTimeUtc

string

Время окончания запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

options
ServiceFabricClientGetNodesEventListOptionalParams

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

Возвращаемое значение

Обещание<Models.GetNodesEventListResponse>

getNodesEventList(string, string, ServiceFabricClientGetNodesEventListOptionalParams, ServiceCallback<NodeEventUnion[]>)

function getNodesEventList(startTimeUtc: string, endTimeUtc: string, options: ServiceFabricClientGetNodesEventListOptionalParams, callback: ServiceCallback<NodeEventUnion[]>)

Параметры

startTimeUtc

string

Время начала запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

endTimeUtc

string

Время окончания запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

options
ServiceFabricClientGetNodesEventListOptionalParams

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

callback

ServiceCallback<NodeEventUnion[]>

Обратный вызов

getNodeTransitionProgress(string, string, ServiceCallback<NodeTransitionProgress>)

function getNodeTransitionProgress(nodeName: string, operationId: string, callback: ServiceCallback<NodeTransitionProgress>)

Параметры

nodeName

string

Имя узла.

operationId

string

ИДЕНТИФИКАТОР GUID, определяющий вызов этого API. Это передается в соответствующий API GetProgress

callback

ServiceCallback<NodeTransitionProgress>

Обратный вызов

getNodeTransitionProgress(string, string, ServiceFabricClientGetNodeTransitionProgressOptionalParams)

Возвращает ход выполнения операции, запущенной с StartNodeTransition, с помощью предоставленного operationId.

function getNodeTransitionProgress(nodeName: string, operationId: string, options?: ServiceFabricClientGetNodeTransitionProgressOptionalParams): Promise<GetNodeTransitionProgressResponse>

Параметры

nodeName

string

Имя узла.

operationId

string

ИДЕНТИФИКАТОР GUID, определяющий вызов этого API. Это передается в соответствующий API GetProgress

options
ServiceFabricClientGetNodeTransitionProgressOptionalParams

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

Возвращаемое значение

Обещание<Models.GetNodeTransitionProgresssResponse>

getNodeTransitionProgress(string, string, ServiceFabricClientGetNodeTransitionProgressOptionalParams, ServiceCallback<NodeTransitionProgress>)

function getNodeTransitionProgress(nodeName: string, operationId: string, options: ServiceFabricClientGetNodeTransitionProgressOptionalParams, callback: ServiceCallback<NodeTransitionProgress>)

Параметры

nodeName

string

Имя узла.

operationId

string

ИДЕНТИФИКАТОР GUID, определяющий вызов этого API. Это передается в соответствующий API GetProgress

options
ServiceFabricClientGetNodeTransitionProgressOptionalParams

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

callback

ServiceCallback<NodeTransitionProgress>

Обратный вызов

getPartitionBackupConfigurationInfo(string, ServiceCallback<PartitionBackupConfigurationInfo>)

function getPartitionBackupConfigurationInfo(partitionId: string, callback: ServiceCallback<PartitionBackupConfigurationInfo>)

Параметры

partitionId

string

Удостоверение секции.

callback

ServiceCallback<PartitionBackupConfigurationInfo>

Обратный вызов

getPartitionBackupConfigurationInfo(string, ServiceFabricClientGetPartitionBackupConfigurationInfoOptionalParams)

Возвращает сведения о конфигурации резервного копирования Service Fabric для указанной секции.

function getPartitionBackupConfigurationInfo(partitionId: string, options?: ServiceFabricClientGetPartitionBackupConfigurationInfoOptionalParams): Promise<GetPartitionBackupConfigurationInfoResponse>

Параметры

partitionId

string

Удостоверение секции.

options
ServiceFabricClientGetPartitionBackupConfigurationInfoOptionalParams

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

Возвращаемое значение

Обещание<Models.GetPartitionBackupConfigurationInfoResponse>

getPartitionBackupConfigurationInfo(string, ServiceFabricClientGetPartitionBackupConfigurationInfoOptionalParams, ServiceCallback<PartitionBackupConfigurationInfo>)

function getPartitionBackupConfigurationInfo(partitionId: string, options: ServiceFabricClientGetPartitionBackupConfigurationInfoOptionalParams, callback: ServiceCallback<PartitionBackupConfigurationInfo>)

Параметры

partitionId

string

Удостоверение секции.

options
ServiceFabricClientGetPartitionBackupConfigurationInfoOptionalParams

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

callback

ServiceCallback<PartitionBackupConfigurationInfo>

Обратный вызов

getPartitionBackupList(string, ServiceCallback<PagedBackupInfoList>)

function getPartitionBackupList(partitionId: string, callback: ServiceCallback<PagedBackupInfoList>)

Параметры

partitionId

string

Удостоверение секции.

callback

ServiceCallback<PagedBackupInfoList>

Обратный вызов

getPartitionBackupList(string, ServiceFabricClientGetPartitionBackupListOptionalParams)

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

function getPartitionBackupList(partitionId: string, options?: ServiceFabricClientGetPartitionBackupListOptionalParams): Promise<GetPartitionBackupListResponse>

Параметры

partitionId

string

Удостоверение секции.

options
ServiceFabricClientGetPartitionBackupListOptionalParams

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

Возвращаемое значение

Обещание<Models.GetPartitionBackupListResponse>

getPartitionBackupList(string, ServiceFabricClientGetPartitionBackupListOptionalParams, ServiceCallback<PagedBackupInfoList>)

function getPartitionBackupList(partitionId: string, options: ServiceFabricClientGetPartitionBackupListOptionalParams, callback: ServiceCallback<PagedBackupInfoList>)

Параметры

partitionId

string

Удостоверение секции.

options
ServiceFabricClientGetPartitionBackupListOptionalParams

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

callback

ServiceCallback<PagedBackupInfoList>

Обратный вызов

getPartitionBackupProgress(string, ServiceCallback<BackupProgressInfo>)

function getPartitionBackupProgress(partitionId: string, callback: ServiceCallback<BackupProgressInfo>)

Параметры

partitionId

string

Удостоверение секции.

callback

ServiceCallback<BackupProgressInfo>

Обратный вызов

getPartitionBackupProgress(string, ServiceFabricClientGetPartitionBackupProgressOptionalParams)

Возвращает сведения о состоянии последней резервной копии вместе с подробными сведениями или причиной сбоя в случае завершения.

function getPartitionBackupProgress(partitionId: string, options?: ServiceFabricClientGetPartitionBackupProgressOptionalParams): Promise<GetPartitionBackupProgressResponse>

Параметры

partitionId

string

Удостоверение секции.

options
ServiceFabricClientGetPartitionBackupProgressOptionalParams

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

Возвращаемое значение

Обещание<Models.GetPartitionBackupProgresssResponse>

getPartitionBackupProgress(string, ServiceFabricClientGetPartitionBackupProgressOptionalParams, ServiceCallback<BackupProgressInfo>)

function getPartitionBackupProgress(partitionId: string, options: ServiceFabricClientGetPartitionBackupProgressOptionalParams, callback: ServiceCallback<BackupProgressInfo>)

Параметры

partitionId

string

Удостоверение секции.

options
ServiceFabricClientGetPartitionBackupProgressOptionalParams

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

callback

ServiceCallback<BackupProgressInfo>

Обратный вызов

getPartitionEventList(string, string, string, ServiceCallback<PartitionEventUnion[]>)

function getPartitionEventList(partitionId: string, startTimeUtc: string, endTimeUtc: string, callback: ServiceCallback<PartitionEventUnion[]>)

Параметры

partitionId

string

Удостоверение секции.

startTimeUtc

string

Время начала запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

endTimeUtc

string

Время окончания запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

callback

ServiceCallback<PartitionEventUnion[]>

Обратный вызов

getPartitionEventList(string, string, string, ServiceFabricClientGetPartitionEventListOptionalParams)

Ответ — это список объектов PartitionEvent.

function getPartitionEventList(partitionId: string, startTimeUtc: string, endTimeUtc: string, options?: ServiceFabricClientGetPartitionEventListOptionalParams): Promise<GetPartitionEventListResponse>

Параметры

partitionId

string

Удостоверение секции.

startTimeUtc

string

Время начала запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

endTimeUtc

string

Время окончания запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

options
ServiceFabricClientGetPartitionEventListOptionalParams

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

Возвращаемое значение

Обещание<Models.GetPartitionEventListResponse>

getPartitionEventList(string, string, string, ServiceFabricClientGetPartitionEventListOptionalParams, ServiceCallback<PartitionEventUnion[]>)

function getPartitionEventList(partitionId: string, startTimeUtc: string, endTimeUtc: string, options: ServiceFabricClientGetPartitionEventListOptionalParams, callback: ServiceCallback<PartitionEventUnion[]>)

Параметры

partitionId

string

Удостоверение секции.

startTimeUtc

string

Время начала запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

endTimeUtc

string

Время окончания запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

options
ServiceFabricClientGetPartitionEventListOptionalParams

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

callback

ServiceCallback<PartitionEventUnion[]>

Обратный вызов

getPartitionHealth(string, ServiceCallback<PartitionHealth>)

function getPartitionHealth(partitionId: string, callback: ServiceCallback<PartitionHealth>)

Параметры

partitionId

string

Удостоверение секции.

callback

ServiceCallback<PartitionHealth>

Обратный вызов

getPartitionHealth(string, ServiceFabricClientGetPartitionHealthOptionalParams)

Используйте EventsHealthStateFilter, чтобы отфильтровать коллекцию событий работоспособности, сообщаемых в службе на основе состояния работоспособности. Используйте ReplicasHealthStateFilter для фильтрации коллекции объектов ReplicaHealthState в разделе. Если указать секцию, которая не существует в хранилище работоспособности, этот запрос возвращает ошибку.

function getPartitionHealth(partitionId: string, options?: ServiceFabricClientGetPartitionHealthOptionalParams): Promise<GetPartitionHealthResponse>

Параметры

partitionId

string

Удостоверение секции.

options
ServiceFabricClientGetPartitionHealthOptionalParams

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

Возвращаемое значение

Обещание<Models.GetPartitionHealthResponse>

getPartitionHealth(string, ServiceFabricClientGetPartitionHealthOptionalParams, ServiceCallback<PartitionHealth>)

function getPartitionHealth(partitionId: string, options: ServiceFabricClientGetPartitionHealthOptionalParams, callback: ServiceCallback<PartitionHealth>)

Параметры

partitionId

string

Удостоверение секции.

options
ServiceFabricClientGetPartitionHealthOptionalParams

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

callback

ServiceCallback<PartitionHealth>

Обратный вызов

getPartitionHealthUsingPolicy(string, ServiceCallback<PartitionHealth>)

function getPartitionHealthUsingPolicy(partitionId: string, callback: ServiceCallback<PartitionHealth>)

Параметры

partitionId

string

Удостоверение секции.

callback

ServiceCallback<PartitionHealth>

Обратный вызов

getPartitionHealthUsingPolicy(string, ServiceFabricClientGetPartitionHealthUsingPolicyOptionalParams)

Возвращает сведения о работоспособности указанной секции. Если указана политика работоспособности приложения, оценка работоспособности использует ее для получения агрегированного состояния работоспособности. Если политика не указана, оценка работоспособности использует политику работоспособности приложения, определенную в манифесте приложения, или политику работоспособности по умолчанию, если политика не определена в манифесте. Используйте EventsHealthStateFilter, чтобы отфильтровать коллекцию событий работоспособности, сообщаемых по разделу на основе состояния работоспособности. Используйте ReplicasHealthStateFilter для фильтрации коллекции объектов ReplicaHealthState в разделе. Используйте ApplicationHealthPolicy в теле POST для переопределения политик работоспособности, используемых для оценки работоспособности. Если указать секцию, которая не существует в хранилище работоспособности, этот запрос возвращает ошибку.

function getPartitionHealthUsingPolicy(partitionId: string, options?: ServiceFabricClientGetPartitionHealthUsingPolicyOptionalParams): Promise<GetPartitionHealthUsingPolicyResponse>

Параметры

partitionId

string

Удостоверение секции.

options
ServiceFabricClientGetPartitionHealthUsingPolicyOptionalParams

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

Возвращаемое значение

Обещание<Models.GetPartitionHealthUsingPolicyResponse>

getPartitionHealthUsingPolicy(string, ServiceFabricClientGetPartitionHealthUsingPolicyOptionalParams, ServiceCallback<PartitionHealth>)

function getPartitionHealthUsingPolicy(partitionId: string, options: ServiceFabricClientGetPartitionHealthUsingPolicyOptionalParams, callback: ServiceCallback<PartitionHealth>)

Параметры

partitionId

string

Удостоверение секции.

options
ServiceFabricClientGetPartitionHealthUsingPolicyOptionalParams

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

callback

ServiceCallback<PartitionHealth>

Обратный вызов

getPartitionInfo(string, ServiceCallback<ServicePartitionInfoUnion>)

function getPartitionInfo(partitionId: string, callback: ServiceCallback<ServicePartitionInfoUnion>)

Параметры

partitionId

string

Удостоверение секции.

callback

ServiceCallback<ServicePartitionInfoUnion>

Обратный вызов

getPartitionInfo(string, ServiceFabricClientGetPartitionInfoOptionalParams)

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

function getPartitionInfo(partitionId: string, options?: ServiceFabricClientGetPartitionInfoOptionalParams): Promise<GetPartitionInfoResponse>

Параметры

partitionId

string

Удостоверение секции.

options
ServiceFabricClientGetPartitionInfoOptionalParams

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

Возвращаемое значение

Обещание<Models.GetPartitionInfoResponse>

getPartitionInfo(string, ServiceFabricClientGetPartitionInfoOptionalParams, ServiceCallback<ServicePartitionInfoUnion>)

function getPartitionInfo(partitionId: string, options: ServiceFabricClientGetPartitionInfoOptionalParams, callback: ServiceCallback<ServicePartitionInfoUnion>)

Параметры

partitionId

string

Удостоверение секции.

options
ServiceFabricClientGetPartitionInfoOptionalParams

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

callback

ServiceCallback<ServicePartitionInfoUnion>

Обратный вызов

getPartitionInfoList(string, ServiceCallback<PagedServicePartitionInfoList>)

function getPartitionInfoList(serviceId: string, callback: ServiceCallback<PagedServicePartitionInfoList>)

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

callback

ServiceCallback<PagedServicePartitionInfoList>

Обратный вызов

getPartitionInfoList(string, ServiceFabricClientGetPartitionInfoListOptionalParams)

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

function getPartitionInfoList(serviceId: string, options?: ServiceFabricClientGetPartitionInfoListOptionalParams): Promise<GetPartitionInfoListResponse>

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

options
ServiceFabricClientGetPartitionInfoListOptionalParams

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

Возвращаемое значение

Обещание<Models.GetPartitionInfoListResponse>

getPartitionInfoList(string, ServiceFabricClientGetPartitionInfoListOptionalParams, ServiceCallback<PagedServicePartitionInfoList>)

function getPartitionInfoList(serviceId: string, options: ServiceFabricClientGetPartitionInfoListOptionalParams, callback: ServiceCallback<PagedServicePartitionInfoList>)

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

options
ServiceFabricClientGetPartitionInfoListOptionalParams

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

callback

ServiceCallback<PagedServicePartitionInfoList>

Обратный вызов

getPartitionLoadInformation(string, ServiceCallback<PartitionLoadInformation>)

function getPartitionLoadInformation(partitionId: string, callback: ServiceCallback<PartitionLoadInformation>)

Параметры

partitionId

string

Удостоверение секции.

callback

ServiceCallback<PartitionLoadInformation>

Обратный вызов

getPartitionLoadInformation(string, ServiceFabricClientGetPartitionLoadInformationOptionalParams)

Возвращает сведения о загрузке указанной секции. Ответ содержит список отчетов о нагрузке для раздела Service Fabric. Каждый отчет включает имя, значение и последнее время загрузки в формате UTC.

function getPartitionLoadInformation(partitionId: string, options?: ServiceFabricClientGetPartitionLoadInformationOptionalParams): Promise<GetPartitionLoadInformationResponse>

Параметры

partitionId

string

Удостоверение секции.

options
ServiceFabricClientGetPartitionLoadInformationOptionalParams

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

Возвращаемое значение

Обещание<Models.GetPartitionLoadInformationResponse>

getPartitionLoadInformation(string, ServiceFabricClientGetPartitionLoadInformationOptionalParams, ServiceCallback<PartitionLoadInformation>)

function getPartitionLoadInformation(partitionId: string, options: ServiceFabricClientGetPartitionLoadInformationOptionalParams, callback: ServiceCallback<PartitionLoadInformation>)

Параметры

partitionId

string

Удостоверение секции.

options
ServiceFabricClientGetPartitionLoadInformationOptionalParams

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

callback

ServiceCallback<PartitionLoadInformation>

Обратный вызов

getPartitionReplicaEventList(string, string, string, string, ServiceCallback<ReplicaEventUnion[]>)

function getPartitionReplicaEventList(partitionId: string, replicaId: string, startTimeUtc: string, endTimeUtc: string, callback: ServiceCallback<ReplicaEventUnion[]>)

Параметры

partitionId

string

Удостоверение секции.

replicaId

string

Идентификатор реплики.

startTimeUtc

string

Время начала запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

endTimeUtc

string

Время окончания запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

callback

ServiceCallback<ReplicaEventUnion[]>

Обратный вызов

getPartitionReplicaEventList(string, string, string, string, ServiceFabricClientGetPartitionReplicaEventListOptionalParams)

Ответ — это список объектов ReplicaEvent.

function getPartitionReplicaEventList(partitionId: string, replicaId: string, startTimeUtc: string, endTimeUtc: string, options?: ServiceFabricClientGetPartitionReplicaEventListOptionalParams): Promise<GetPartitionReplicaEventListResponse>

Параметры

partitionId

string

Удостоверение секции.

replicaId

string

Идентификатор реплики.

startTimeUtc

string

Время начала запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

endTimeUtc

string

Время окончания запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

options
ServiceFabricClientGetPartitionReplicaEventListOptionalParams

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

Возвращаемое значение

Обещание<Models.GetPartitionReplicaEventListResponse>

getPartitionReplicaEventList(string, string, string, string, ServiceFabricClientGetPartitionReplicaEventListOptionalParams, ServiceCallback<ReplicaEventUnion[]>)

function getPartitionReplicaEventList(partitionId: string, replicaId: string, startTimeUtc: string, endTimeUtc: string, options: ServiceFabricClientGetPartitionReplicaEventListOptionalParams, callback: ServiceCallback<ReplicaEventUnion[]>)

Параметры

partitionId

string

Удостоверение секции.

replicaId

string

Идентификатор реплики.

startTimeUtc

string

Время начала запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

endTimeUtc

string

Время окончания запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

options
ServiceFabricClientGetPartitionReplicaEventListOptionalParams

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

callback

ServiceCallback<ReplicaEventUnion[]>

Обратный вызов

getPartitionReplicasEventList(string, string, string, ServiceCallback<ReplicaEventUnion[]>)

function getPartitionReplicasEventList(partitionId: string, startTimeUtc: string, endTimeUtc: string, callback: ServiceCallback<ReplicaEventUnion[]>)

Параметры

partitionId

string

Удостоверение секции.

startTimeUtc

string

Время начала запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

endTimeUtc

string

Время окончания запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

callback

ServiceCallback<ReplicaEventUnion[]>

Обратный вызов

getPartitionReplicasEventList(string, string, string, ServiceFabricClientGetPartitionReplicasEventListOptionalParams)

Ответ — это список объектов ReplicaEvent.

function getPartitionReplicasEventList(partitionId: string, startTimeUtc: string, endTimeUtc: string, options?: ServiceFabricClientGetPartitionReplicasEventListOptionalParams): Promise<GetPartitionReplicasEventListResponse>

Параметры

partitionId

string

Удостоверение секции.

startTimeUtc

string

Время начала запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

endTimeUtc

string

Время окончания запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

options
ServiceFabricClientGetPartitionReplicasEventListOptionalParams

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

Возвращаемое значение

Обещание<Models.GetPartitionReplicasEventListResponse>

getPartitionReplicasEventList(string, string, string, ServiceFabricClientGetPartitionReplicasEventListOptionalParams, ServiceCallback<ReplicaEventUnion[]>)

function getPartitionReplicasEventList(partitionId: string, startTimeUtc: string, endTimeUtc: string, options: ServiceFabricClientGetPartitionReplicasEventListOptionalParams, callback: ServiceCallback<ReplicaEventUnion[]>)

Параметры

partitionId

string

Удостоверение секции.

startTimeUtc

string

Время начала запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

endTimeUtc

string

Время окончания запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

options
ServiceFabricClientGetPartitionReplicasEventListOptionalParams

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

callback

ServiceCallback<ReplicaEventUnion[]>

Обратный вызов

getPartitionRestartProgress(string, string, string, ServiceCallback<PartitionRestartProgress>)

function getPartitionRestartProgress(serviceId: string, partitionId: string, operationId: string, callback: ServiceCallback<PartitionRestartProgress>)

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

partitionId

string

Удостоверение секции.

operationId

string

ИДЕНТИФИКАТОР GUID, определяющий вызов этого API. Это передается в соответствующий API GetProgress

callback

ServiceCallback<PartitionRestartProgress>

Обратный вызов

getPartitionRestartProgress(string, string, string, ServiceFabricClientGetPartitionRestartProgressOptionalParams)

Возвращает ход выполнения секционирования, запущенного с StartPartitionRestart с помощью предоставленного OperationId.

function getPartitionRestartProgress(serviceId: string, partitionId: string, operationId: string, options?: ServiceFabricClientGetPartitionRestartProgressOptionalParams): Promise<GetPartitionRestartProgressResponse>

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

partitionId

string

Удостоверение секции.

operationId

string

ИДЕНТИФИКАТОР GUID, определяющий вызов этого API. Это передается в соответствующий API GetProgress

options
ServiceFabricClientGetPartitionRestartProgressOptionalParams

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

Возвращаемое значение

Обещание<Models.GetPartitionRestartProgresssResponse>

getPartitionRestartProgress(string, string, string, ServiceFabricClientGetPartitionRestartProgressOptionalParams, ServiceCallback<PartitionRestartProgress>)

function getPartitionRestartProgress(serviceId: string, partitionId: string, operationId: string, options: ServiceFabricClientGetPartitionRestartProgressOptionalParams, callback: ServiceCallback<PartitionRestartProgress>)

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

partitionId

string

Удостоверение секции.

operationId

string

ИДЕНТИФИКАТОР GUID, определяющий вызов этого API. Это передается в соответствующий API GetProgress

options
ServiceFabricClientGetPartitionRestartProgressOptionalParams

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

callback

ServiceCallback<PartitionRestartProgress>

Обратный вызов

getPartitionRestoreProgress(string, ServiceCallback<RestoreProgressInfo>)

function getPartitionRestoreProgress(partitionId: string, callback: ServiceCallback<RestoreProgressInfo>)

Параметры

partitionId

string

Удостоверение секции.

callback

ServiceCallback<RestoreProgressInfo>

Обратный вызов

getPartitionRestoreProgress(string, ServiceFabricClientGetPartitionRestoreProgressOptionalParams)

Возвращает сведения о состоянии последней операции восстановления вместе с подробными сведениями или причиной сбоя в случае завершения.

function getPartitionRestoreProgress(partitionId: string, options?: ServiceFabricClientGetPartitionRestoreProgressOptionalParams): Promise<GetPartitionRestoreProgressResponse>

Параметры

partitionId

string

Удостоверение секции.

options
ServiceFabricClientGetPartitionRestoreProgressOptionalParams

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

Возвращаемое значение

Обещание<Models.GetPartitionRestoreProgresResponse>

getPartitionRestoreProgress(string, ServiceFabricClientGetPartitionRestoreProgressOptionalParams, ServiceCallback<RestoreProgressInfo>)

function getPartitionRestoreProgress(partitionId: string, options: ServiceFabricClientGetPartitionRestoreProgressOptionalParams, callback: ServiceCallback<RestoreProgressInfo>)

Параметры

partitionId

string

Удостоверение секции.

options
ServiceFabricClientGetPartitionRestoreProgressOptionalParams

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

callback

ServiceCallback<RestoreProgressInfo>

Обратный вызов

getPartitionsEventList(string, string, ServiceCallback<PartitionEventUnion[]>)

function getPartitionsEventList(startTimeUtc: string, endTimeUtc: string, callback: ServiceCallback<PartitionEventUnion[]>)

Параметры

startTimeUtc

string

Время начала запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

endTimeUtc

string

Время окончания запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

callback

ServiceCallback<PartitionEventUnion[]>

Обратный вызов

getPartitionsEventList(string, string, ServiceFabricClientGetPartitionsEventListOptionalParams)

Ответ — это список объектов PartitionEvent.

function getPartitionsEventList(startTimeUtc: string, endTimeUtc: string, options?: ServiceFabricClientGetPartitionsEventListOptionalParams): Promise<GetPartitionsEventListResponse>

Параметры

startTimeUtc

string

Время начала запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

endTimeUtc

string

Время окончания запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

options
ServiceFabricClientGetPartitionsEventListOptionalParams

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

Возвращаемое значение

Обещание<Models.GetPartitionsEventListResponse>

getPartitionsEventList(string, string, ServiceFabricClientGetPartitionsEventListOptionalParams, ServiceCallback<PartitionEventUnion[]>)

function getPartitionsEventList(startTimeUtc: string, endTimeUtc: string, options: ServiceFabricClientGetPartitionsEventListOptionalParams, callback: ServiceCallback<PartitionEventUnion[]>)

Параметры

startTimeUtc

string

Время начала запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

endTimeUtc

string

Время окончания запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

options
ServiceFabricClientGetPartitionsEventListOptionalParams

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

callback

ServiceCallback<PartitionEventUnion[]>

Обратный вызов

getPropertyInfo(string, string, ServiceCallback<PropertyInfo>)

function getPropertyInfo(nameId: string, propertyName: string, callback: ServiceCallback<PropertyInfo>)

Параметры

nameId

string

Имя Service Fabric без схемы URI fabric:.

propertyName

string

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

callback

ServiceCallback<PropertyInfo>

Обратный вызов

getPropertyInfo(string, string, ServiceFabricClientGetPropertyInfoOptionalParams)

Возвращает указанное свойство Service Fabric под заданным именем. Это всегда будет возвращать как значение, так и метаданные.

function getPropertyInfo(nameId: string, propertyName: string, options?: ServiceFabricClientGetPropertyInfoOptionalParams): Promise<GetPropertyInfoResponse>

Параметры

nameId

string

Имя Service Fabric без схемы URI fabric:.

propertyName

string

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

options
ServiceFabricClientGetPropertyInfoOptionalParams

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

Возвращаемое значение

Обещание<Models.GetPropertyInfoResponse>

getPropertyInfo(string, string, ServiceFabricClientGetPropertyInfoOptionalParams, ServiceCallback<PropertyInfo>)

function getPropertyInfo(nameId: string, propertyName: string, options: ServiceFabricClientGetPropertyInfoOptionalParams, callback: ServiceCallback<PropertyInfo>)

Параметры

nameId

string

Имя Service Fabric без схемы URI fabric:.

propertyName

string

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

options
ServiceFabricClientGetPropertyInfoOptionalParams

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

callback

ServiceCallback<PropertyInfo>

Обратный вызов

getPropertyInfoList(string, ServiceCallback<PagedPropertyInfoList>)

function getPropertyInfoList(nameId: string, callback: ServiceCallback<PagedPropertyInfoList>)

Параметры

nameId

string

Имя Service Fabric без схемы URI fabric:.

callback

ServiceCallback<PagedPropertyInfoList>

Обратный вызов

getPropertyInfoList(string, ServiceFabricClientGetPropertyInfoListOptionalParams)

Имя Service Fabric может содержать одно или несколько именованных свойств, в которых хранятся пользовательские сведения. Эта операция получает сведения об этих свойствах в списке страниц. Сведения включают имя, значение и метаданные о каждом из свойств.

function getPropertyInfoList(nameId: string, options?: ServiceFabricClientGetPropertyInfoListOptionalParams): Promise<GetPropertyInfoListResponse>

Параметры

nameId

string

Имя Service Fabric без схемы URI fabric:.

options
ServiceFabricClientGetPropertyInfoListOptionalParams

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

Возвращаемое значение

Обещание<Models.GetPropertyInfoListResponse>

getPropertyInfoList(string, ServiceFabricClientGetPropertyInfoListOptionalParams, ServiceCallback<PagedPropertyInfoList>)

function getPropertyInfoList(nameId: string, options: ServiceFabricClientGetPropertyInfoListOptionalParams, callback: ServiceCallback<PagedPropertyInfoList>)

Параметры

nameId

string

Имя Service Fabric без схемы URI fabric:.

options
ServiceFabricClientGetPropertyInfoListOptionalParams

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

callback

ServiceCallback<PagedPropertyInfoList>

Обратный вызов

getProvisionedFabricCodeVersionInfoList(ServiceCallback<FabricCodeVersionInfo[]>)

function getProvisionedFabricCodeVersionInfoList(callback: ServiceCallback<FabricCodeVersionInfo[]>)

Параметры

callback

ServiceCallback<FabricCodeVersionInfo[]>

Обратный вызов

getProvisionedFabricCodeVersionInfoList(ServiceFabricClientGetProvisionedFabricCodeVersionInfoListOptionalParams)

Возвращает список сведений о версиях кода структуры, подготовленных в кластере. Параметр CodeVersion можно использовать для фильтрации выходных данных только в этой конкретной версии.

function getProvisionedFabricCodeVersionInfoList(options?: ServiceFabricClientGetProvisionedFabricCodeVersionInfoListOptionalParams): Promise<GetProvisionedFabricCodeVersionInfoListResponse>

Параметры

options
ServiceFabricClientGetProvisionedFabricCodeVersionInfoListOptionalParams

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

Возвращаемое значение

Обещание<Models.GetProvisionedFabricCodeVersionInfoListResponse>

getProvisionedFabricCodeVersionInfoList(ServiceFabricClientGetProvisionedFabricCodeVersionInfoListOptionalParams, ServiceCallback<FabricCodeVersionInfo[]>)

function getProvisionedFabricCodeVersionInfoList(options: ServiceFabricClientGetProvisionedFabricCodeVersionInfoListOptionalParams, callback: ServiceCallback<FabricCodeVersionInfo[]>)

Параметры

options
ServiceFabricClientGetProvisionedFabricCodeVersionInfoListOptionalParams

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

callback

ServiceCallback<FabricCodeVersionInfo[]>

Обратный вызов

getProvisionedFabricConfigVersionInfoList(ServiceCallback<FabricConfigVersionInfo[]>)

function getProvisionedFabricConfigVersionInfoList(callback: ServiceCallback<FabricConfigVersionInfo[]>)

Параметры

callback

ServiceCallback<FabricConfigVersionInfo[]>

Обратный вызов

getProvisionedFabricConfigVersionInfoList(ServiceFabricClientGetProvisionedFabricConfigVersionInfoListOptionalParams)

Возвращает список сведений о версиях конфигурации структуры, подготовленных в кластере. Параметр ConfigVersion можно использовать для фильтрации выходных данных только в этой конкретной версии.

function getProvisionedFabricConfigVersionInfoList(options?: ServiceFabricClientGetProvisionedFabricConfigVersionInfoListOptionalParams): Promise<GetProvisionedFabricConfigVersionInfoListResponse>

Параметры

options
ServiceFabricClientGetProvisionedFabricConfigVersionInfoListOptionalParams

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

Возвращаемое значение

Обещание<Models.GetProvisionedFabricConfigVersionInfoListResponse>

getProvisionedFabricConfigVersionInfoList(ServiceFabricClientGetProvisionedFabricConfigVersionInfoListOptionalParams, ServiceCallback<FabricConfigVersionInfo[]>)

function getProvisionedFabricConfigVersionInfoList(options: ServiceFabricClientGetProvisionedFabricConfigVersionInfoListOptionalParams, callback: ServiceCallback<FabricConfigVersionInfo[]>)

Параметры

options
ServiceFabricClientGetProvisionedFabricConfigVersionInfoListOptionalParams

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

callback

ServiceCallback<FabricConfigVersionInfo[]>

Обратный вызов

getQuorumLossProgress(string, string, string, ServiceCallback<PartitionQuorumLossProgress>)

function getQuorumLossProgress(serviceId: string, partitionId: string, operationId: string, callback: ServiceCallback<PartitionQuorumLossProgress>)

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

partitionId

string

Удостоверение секции.

operationId

string

ИДЕНТИФИКАТОР GUID, определяющий вызов этого API. Это передается в соответствующий API GetProgress

callback

ServiceCallback<PartitionQuorumLossProgress>

Обратный вызов

getQuorumLossProgress(string, string, string, ServiceFabricClientGetQuorumLossProgressOptionalParams)

Возвращает ход выполнения операции потери кворума, запущенной с StartQuorumLoss, используя предоставленный OperationId.

function getQuorumLossProgress(serviceId: string, partitionId: string, operationId: string, options?: ServiceFabricClientGetQuorumLossProgressOptionalParams): Promise<GetQuorumLossProgressResponse>

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

partitionId

string

Удостоверение секции.

operationId

string

ИДЕНТИФИКАТОР GUID, определяющий вызов этого API. Это передается в соответствующий API GetProgress

options
ServiceFabricClientGetQuorumLossProgressOptionalParams

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

Возвращаемое значение

Обещание<Models.GetQuorumLossProgressResponse>

getQuorumLossProgress(string, string, string, ServiceFabricClientGetQuorumLossProgressOptionalParams, ServiceCallback<PartitionQuorumLossProgress>)

function getQuorumLossProgress(serviceId: string, partitionId: string, operationId: string, options: ServiceFabricClientGetQuorumLossProgressOptionalParams, callback: ServiceCallback<PartitionQuorumLossProgress>)

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

partitionId

string

Удостоверение секции.

operationId

string

ИДЕНТИФИКАТОР GUID, определяющий вызов этого API. Это передается в соответствующий API GetProgress

options
ServiceFabricClientGetQuorumLossProgressOptionalParams

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

callback

ServiceCallback<PartitionQuorumLossProgress>

Обратный вызов

getRepairTaskList(ServiceCallback<RepairTask[]>)

function getRepairTaskList(callback: ServiceCallback<RepairTask[]>)

Параметры

callback

ServiceCallback<RepairTask[]>

Обратный вызов

getRepairTaskList(ServiceFabricClientGetRepairTaskListOptionalParams)

Этот API поддерживает платформу Service Fabric; Он не предназначен для использования непосредственно из кода.

function getRepairTaskList(options?: ServiceFabricClientGetRepairTaskListOptionalParams): Promise<GetRepairTaskListResponse>

Параметры

options
ServiceFabricClientGetRepairTaskListOptionalParams

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

Возвращаемое значение

Обещание<Models.GetRepairTaskListResponse>

getRepairTaskList(ServiceFabricClientGetRepairTaskListOptionalParams, ServiceCallback<RepairTask[]>)

function getRepairTaskList(options: ServiceFabricClientGetRepairTaskListOptionalParams, callback: ServiceCallback<RepairTask[]>)

Параметры

options
ServiceFabricClientGetRepairTaskListOptionalParams

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

callback

ServiceCallback<RepairTask[]>

Обратный вызов

getReplicaHealth(string, string, ServiceCallback<ReplicaHealthUnion>)

function getReplicaHealth(partitionId: string, replicaId: string, callback: ServiceCallback<ReplicaHealthUnion>)

Параметры

partitionId

string

Удостоверение секции.

replicaId

string

Идентификатор реплики.

callback

ServiceCallback<ReplicaHealthUnion>

Обратный вызов

getReplicaHealth(string, string, ServiceFabricClientGetReplicaHealthOptionalParams)

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

function getReplicaHealth(partitionId: string, replicaId: string, options?: ServiceFabricClientGetReplicaHealthOptionalParams): Promise<GetReplicaHealthResponse>

Параметры

partitionId

string

Удостоверение секции.

replicaId

string

Идентификатор реплики.

options
ServiceFabricClientGetReplicaHealthOptionalParams

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

Возвращаемое значение

Обещание<Models.GetReplicaHealthResponse>

getReplicaHealth(string, string, ServiceFabricClientGetReplicaHealthOptionalParams, ServiceCallback<ReplicaHealthUnion>)

function getReplicaHealth(partitionId: string, replicaId: string, options: ServiceFabricClientGetReplicaHealthOptionalParams, callback: ServiceCallback<ReplicaHealthUnion>)

Параметры

partitionId

string

Удостоверение секции.

replicaId

string

Идентификатор реплики.

options
ServiceFabricClientGetReplicaHealthOptionalParams

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

callback

ServiceCallback<ReplicaHealthUnion>

Обратный вызов

getReplicaHealthUsingPolicy(string, string, ServiceCallback<ReplicaHealthUnion>)

function getReplicaHealthUsingPolicy(partitionId: string, replicaId: string, callback: ServiceCallback<ReplicaHealthUnion>)

Параметры

partitionId

string

Удостоверение секции.

replicaId

string

Идентификатор реплики.

callback

ServiceCallback<ReplicaHealthUnion>

Обратный вызов

getReplicaHealthUsingPolicy(string, string, ServiceFabricClientGetReplicaHealthUsingPolicyOptionalParams)

Возвращает работоспособность реплики службы с отслеживанием состояния Service Fabric или экземпляра службы без отслеживания состояния. Используйте EventsHealthStateFilter, чтобы отфильтровать коллекцию событий работоспособности, сообщаемых в кластере на основе состояния работоспособности. Используйте ApplicationHealthPolicy, чтобы при необходимости переопределить политики работоспособности, используемые для оценки работоспособности. Этот API использует только поле "ConsiderWarningAsError" приложения ApplicationHealthPolicy. Остальные поля игнорируются при оценке работоспособности реплики.

function getReplicaHealthUsingPolicy(partitionId: string, replicaId: string, options?: ServiceFabricClientGetReplicaHealthUsingPolicyOptionalParams): Promise<GetReplicaHealthUsingPolicyResponse>

Параметры

partitionId

string

Удостоверение секции.

replicaId

string

Идентификатор реплики.

options
ServiceFabricClientGetReplicaHealthUsingPolicyOptionalParams

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

Возвращаемое значение

Обещание<Models.GetReplicaHealthUsingPolicyResponse>

getReplicaHealthUsingPolicy(string, string, ServiceFabricClientGetReplicaHealthUsingPolicyOptionalParams, ServiceCallback<ReplicaHealthUnion>)

function getReplicaHealthUsingPolicy(partitionId: string, replicaId: string, options: ServiceFabricClientGetReplicaHealthUsingPolicyOptionalParams, callback: ServiceCallback<ReplicaHealthUnion>)

Параметры

partitionId

string

Удостоверение секции.

replicaId

string

Идентификатор реплики.

options
ServiceFabricClientGetReplicaHealthUsingPolicyOptionalParams

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

callback

ServiceCallback<ReplicaHealthUnion>

Обратный вызов

getReplicaInfo(string, string, ServiceCallback<ReplicaInfoUnion>)

function getReplicaInfo(partitionId: string, replicaId: string, callback: ServiceCallback<ReplicaInfoUnion>)

Параметры

partitionId

string

Удостоверение секции.

replicaId

string

Идентификатор реплики.

callback

ServiceCallback<ReplicaInfoUnion>

Обратный вызов

getReplicaInfo(string, string, ServiceFabricClientGetReplicaInfoOptionalParams)

Ответ включает идентификатор, роль, состояние, состояние, имя узла, время ожидания и другие сведения о реплике.

function getReplicaInfo(partitionId: string, replicaId: string, options?: ServiceFabricClientGetReplicaInfoOptionalParams): Promise<GetReplicaInfoResponse>

Параметры

partitionId

string

Удостоверение секции.

replicaId

string

Идентификатор реплики.

options
ServiceFabricClientGetReplicaInfoOptionalParams

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

Возвращаемое значение

Обещание<Models.GetReplicaInfoResponse>

getReplicaInfo(string, string, ServiceFabricClientGetReplicaInfoOptionalParams, ServiceCallback<ReplicaInfoUnion>)

function getReplicaInfo(partitionId: string, replicaId: string, options: ServiceFabricClientGetReplicaInfoOptionalParams, callback: ServiceCallback<ReplicaInfoUnion>)

Параметры

partitionId

string

Удостоверение секции.

replicaId

string

Идентификатор реплики.

options
ServiceFabricClientGetReplicaInfoOptionalParams

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

callback

ServiceCallback<ReplicaInfoUnion>

Обратный вызов

getReplicaInfoList(string, ServiceCallback<PagedReplicaInfoList>)

function getReplicaInfoList(partitionId: string, callback: ServiceCallback<PagedReplicaInfoList>)

Параметры

partitionId

string

Удостоверение секции.

callback

ServiceCallback<PagedReplicaInfoList>

Обратный вызов

getReplicaInfoList(string, ServiceFabricClientGetReplicaInfoListOptionalParams)

Конечная точка GetReplicas возвращает сведения о репликах указанной секции. Ответ включает идентификатор, роль, состояние, состояние, имя узла, время ожидания и другие сведения о реплике.

function getReplicaInfoList(partitionId: string, options?: ServiceFabricClientGetReplicaInfoListOptionalParams): Promise<GetReplicaInfoListResponse>

Параметры

partitionId

string

Удостоверение секции.

options
ServiceFabricClientGetReplicaInfoListOptionalParams

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

Возвращаемое значение

Обещание<Models.GetReplicaInfoListResponse>

getReplicaInfoList(string, ServiceFabricClientGetReplicaInfoListOptionalParams, ServiceCallback<PagedReplicaInfoList>)

function getReplicaInfoList(partitionId: string, options: ServiceFabricClientGetReplicaInfoListOptionalParams, callback: ServiceCallback<PagedReplicaInfoList>)

Параметры

partitionId

string

Удостоверение секции.

options
ServiceFabricClientGetReplicaInfoListOptionalParams

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

callback

ServiceCallback<PagedReplicaInfoList>

Обратный вызов

getServiceBackupConfigurationInfo(string, ServiceCallback<PagedBackupConfigurationInfoList>)

function getServiceBackupConfigurationInfo(serviceId: string, callback: ServiceCallback<PagedBackupConfigurationInfoList>)

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

callback

ServiceCallback<PagedBackupConfigurationInfoList>

Обратный вызов

getServiceBackupConfigurationInfo(string, ServiceFabricClientGetServiceBackupConfigurationInfoOptionalParams)

Возвращает сведения о конфигурации резервного копирования Service Fabric для службы и секций в этой службе.

function getServiceBackupConfigurationInfo(serviceId: string, options?: ServiceFabricClientGetServiceBackupConfigurationInfoOptionalParams): Promise<GetServiceBackupConfigurationInfoResponse>

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

options
ServiceFabricClientGetServiceBackupConfigurationInfoOptionalParams

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

Возвращаемое значение

Обещание<Models.GetServiceBackupConfigurationInfoResponse>

getServiceBackupConfigurationInfo(string, ServiceFabricClientGetServiceBackupConfigurationInfoOptionalParams, ServiceCallback<PagedBackupConfigurationInfoList>)

function getServiceBackupConfigurationInfo(serviceId: string, options: ServiceFabricClientGetServiceBackupConfigurationInfoOptionalParams, callback: ServiceCallback<PagedBackupConfigurationInfoList>)

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

options
ServiceFabricClientGetServiceBackupConfigurationInfoOptionalParams

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

callback

ServiceCallback<PagedBackupConfigurationInfoList>

Обратный вызов

getServiceBackupList(string, ServiceCallback<PagedBackupInfoList>)

function getServiceBackupList(serviceId: string, callback: ServiceCallback<PagedBackupInfoList>)

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

callback

ServiceCallback<PagedBackupInfoList>

Обратный вызов

getServiceBackupList(string, ServiceFabricClientGetServiceBackupListOptionalParams)

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

function getServiceBackupList(serviceId: string, options?: ServiceFabricClientGetServiceBackupListOptionalParams): Promise<GetServiceBackupListResponse>

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

options
ServiceFabricClientGetServiceBackupListOptionalParams

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

Возвращаемое значение

Обещание<Models.GetServiceBackupListResponse>

getServiceBackupList(string, ServiceFabricClientGetServiceBackupListOptionalParams, ServiceCallback<PagedBackupInfoList>)

function getServiceBackupList(serviceId: string, options: ServiceFabricClientGetServiceBackupListOptionalParams, callback: ServiceCallback<PagedBackupInfoList>)

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

options
ServiceFabricClientGetServiceBackupListOptionalParams

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

callback

ServiceCallback<PagedBackupInfoList>

Обратный вызов

getServiceDescription(string, ServiceCallback<ServiceDescriptionUnion>)

function getServiceDescription(serviceId: string, callback: ServiceCallback<ServiceDescriptionUnion>)

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

callback

ServiceCallback<ServiceDescriptionUnion>

Обратный вызов

getServiceDescription(string, ServiceFabricClientGetServiceDescriptionOptionalParams)

Возвращает описание существующей службы Service Fabric. Прежде чем его описание можно получить, необходимо создать службу.

function getServiceDescription(serviceId: string, options?: ServiceFabricClientGetServiceDescriptionOptionalParams): Promise<GetServiceDescriptionResponse>

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

options
ServiceFabricClientGetServiceDescriptionOptionalParams

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

Возвращаемое значение

Обещание<Models.GetServiceDescriptionResponse>

getServiceDescription(string, ServiceFabricClientGetServiceDescriptionOptionalParams, ServiceCallback<ServiceDescriptionUnion>)

function getServiceDescription(serviceId: string, options: ServiceFabricClientGetServiceDescriptionOptionalParams, callback: ServiceCallback<ServiceDescriptionUnion>)

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

options
ServiceFabricClientGetServiceDescriptionOptionalParams

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

callback

ServiceCallback<ServiceDescriptionUnion>

Обратный вызов

getServiceEventList(string, string, string, ServiceCallback<ServiceEventUnion[]>)

function getServiceEventList(serviceId: string, startTimeUtc: string, endTimeUtc: string, callback: ServiceCallback<ServiceEventUnion[]>)

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

startTimeUtc

string

Время начала запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

endTimeUtc

string

Время окончания запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

callback

ServiceCallback<ServiceEventUnion[]>

Обратный вызов

getServiceEventList(string, string, string, ServiceFabricClientGetServiceEventListOptionalParams)

Ответ — это список объектов ServiceEvent.

function getServiceEventList(serviceId: string, startTimeUtc: string, endTimeUtc: string, options?: ServiceFabricClientGetServiceEventListOptionalParams): Promise<GetServiceEventListResponse>

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

startTimeUtc

string

Время начала запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

endTimeUtc

string

Время окончания запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

options
ServiceFabricClientGetServiceEventListOptionalParams

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

Возвращаемое значение

Обещание<Models.GetServiceEventListResponse>

getServiceEventList(string, string, string, ServiceFabricClientGetServiceEventListOptionalParams, ServiceCallback<ServiceEventUnion[]>)

function getServiceEventList(serviceId: string, startTimeUtc: string, endTimeUtc: string, options: ServiceFabricClientGetServiceEventListOptionalParams, callback: ServiceCallback<ServiceEventUnion[]>)

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

startTimeUtc

string

Время начала запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

endTimeUtc

string

Время окончания запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

options
ServiceFabricClientGetServiceEventListOptionalParams

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

callback

ServiceCallback<ServiceEventUnion[]>

Обратный вызов

getServiceHealth(string, ServiceCallback<ServiceHealth>)

function getServiceHealth(serviceId: string, callback: ServiceCallback<ServiceHealth>)

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

callback

ServiceCallback<ServiceHealth>

Обратный вызов

getServiceHealth(string, ServiceFabricClientGetServiceHealthOptionalParams)

Возвращает сведения о работоспособности указанной службы. Используйте EventsHealthStateFilter, чтобы отфильтровать коллекцию событий работоспособности, сообщаемых в службе на основе состояния работоспособности. Используйте PartitionsHealthStateFilter, чтобы отфильтровать коллекцию возвращаемых секций. Если указать службу, которая не существует в хранилище работоспособности, этот запрос возвращает ошибку.

function getServiceHealth(serviceId: string, options?: ServiceFabricClientGetServiceHealthOptionalParams): Promise<GetServiceHealthResponse>

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

options
ServiceFabricClientGetServiceHealthOptionalParams

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

Возвращаемое значение

Обещание<Models.GetServiceHealthResponse>

getServiceHealth(string, ServiceFabricClientGetServiceHealthOptionalParams, ServiceCallback<ServiceHealth>)

function getServiceHealth(serviceId: string, options: ServiceFabricClientGetServiceHealthOptionalParams, callback: ServiceCallback<ServiceHealth>)

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

options
ServiceFabricClientGetServiceHealthOptionalParams

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

callback

ServiceCallback<ServiceHealth>

Обратный вызов

getServiceHealthUsingPolicy(string, ServiceCallback<ServiceHealth>)

function getServiceHealthUsingPolicy(serviceId: string, callback: ServiceCallback<ServiceHealth>)

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

callback

ServiceCallback<ServiceHealth>

Обратный вызов

getServiceHealthUsingPolicy(string, ServiceFabricClientGetServiceHealthUsingPolicyOptionalParams)

Возвращает сведения о работоспособности указанной службы. Если указана политика работоспособности приложения, оценка работоспособности использует ее для получения агрегированного состояния работоспособности. Если политика не указана, оценка работоспособности использует политику работоспособности приложения, определенную в манифесте приложения, или политику работоспособности по умолчанию, если политика не определена в манифесте. Используйте EventsHealthStateFilter, чтобы отфильтровать коллекцию событий работоспособности, сообщаемых в службе на основе состояния работоспособности. Используйте PartitionsHealthStateFilter, чтобы отфильтровать коллекцию возвращаемых секций. Если указать службу, которая не существует в хранилище работоспособности, этот запрос возвращает ошибку.

function getServiceHealthUsingPolicy(serviceId: string, options?: ServiceFabricClientGetServiceHealthUsingPolicyOptionalParams): Promise<GetServiceHealthUsingPolicyResponse>

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

options
ServiceFabricClientGetServiceHealthUsingPolicyOptionalParams

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

Возвращаемое значение

Обещание<Models.GetServiceHealthUsingPolicyResponse>

getServiceHealthUsingPolicy(string, ServiceFabricClientGetServiceHealthUsingPolicyOptionalParams, ServiceCallback<ServiceHealth>)

function getServiceHealthUsingPolicy(serviceId: string, options: ServiceFabricClientGetServiceHealthUsingPolicyOptionalParams, callback: ServiceCallback<ServiceHealth>)

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

options
ServiceFabricClientGetServiceHealthUsingPolicyOptionalParams

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

callback

ServiceCallback<ServiceHealth>

Обратный вызов

getServiceInfo(string, string, ServiceCallback<ServiceInfoUnion>)

function getServiceInfo(applicationId: string, serviceId: string, callback: ServiceCallback<ServiceInfoUnion>)

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

callback

ServiceCallback<ServiceInfoUnion>

Обратный вызов

getServiceInfo(string, string, ServiceFabricClientGetServiceInfoOptionalParams)

Возвращает сведения о указанной службе, принадлежащей указанному приложению Service Fabric.

function getServiceInfo(applicationId: string, serviceId: string, options?: ServiceFabricClientGetServiceInfoOptionalParams): Promise<GetServiceInfoResponse>

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

options
ServiceFabricClientGetServiceInfoOptionalParams

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

Возвращаемое значение

Обещание<Models.GetServiceInfoResponse>

getServiceInfo(string, string, ServiceFabricClientGetServiceInfoOptionalParams, ServiceCallback<ServiceInfoUnion>)

function getServiceInfo(applicationId: string, serviceId: string, options: ServiceFabricClientGetServiceInfoOptionalParams, callback: ServiceCallback<ServiceInfoUnion>)

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

options
ServiceFabricClientGetServiceInfoOptionalParams

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

callback

ServiceCallback<ServiceInfoUnion>

Обратный вызов

getServiceInfoList(string, ServiceCallback<PagedServiceInfoList>)

function getServiceInfoList(applicationId: string, callback: ServiceCallback<PagedServiceInfoList>)

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

callback

ServiceCallback<PagedServiceInfoList>

Обратный вызов

getServiceInfoList(string, ServiceFabricClientGetServiceInfoListOptionalParams)

Возвращает сведения обо всех службах, принадлежащих приложению, указанному идентификатором приложения.

function getServiceInfoList(applicationId: string, options?: ServiceFabricClientGetServiceInfoListOptionalParams): Promise<GetServiceInfoListResponse>

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

options
ServiceFabricClientGetServiceInfoListOptionalParams

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

Возвращаемое значение

Обещание<Models.GetServiceInfoListResponse>

getServiceInfoList(string, ServiceFabricClientGetServiceInfoListOptionalParams, ServiceCallback<PagedServiceInfoList>)

function getServiceInfoList(applicationId: string, options: ServiceFabricClientGetServiceInfoListOptionalParams, callback: ServiceCallback<PagedServiceInfoList>)

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

options
ServiceFabricClientGetServiceInfoListOptionalParams

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

callback

ServiceCallback<PagedServiceInfoList>

Обратный вызов

getServiceManifest(string, string, string, ServiceCallback<ServiceTypeManifest>)

function getServiceManifest(applicationTypeName: string, applicationTypeVersion: string, serviceManifestName: string, callback: ServiceCallback<ServiceTypeManifest>)

Параметры

applicationTypeName

string

Имя типа приложения.

applicationTypeVersion

string

Версия типа приложения.

serviceManifestName

string

Имя манифеста службы, зарегистрированного в составе типа приложения в кластере Service Fabric.

callback

ServiceCallback<ServiceTypeManifest>

Обратный вызов

getServiceManifest(string, string, string, ServiceFabricClientGetServiceManifestOptionalParams)

Возвращает манифест, описывающий тип службы. Ответ содержит XML-код манифеста службы в виде строки.

function getServiceManifest(applicationTypeName: string, applicationTypeVersion: string, serviceManifestName: string, options?: ServiceFabricClientGetServiceManifestOptionalParams): Promise<GetServiceManifestResponse>

Параметры

applicationTypeName

string

Имя типа приложения.

applicationTypeVersion

string

Версия типа приложения.

serviceManifestName

string

Имя манифеста службы, зарегистрированного в составе типа приложения в кластере Service Fabric.

options
ServiceFabricClientGetServiceManifestOptionalParams

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

Возвращаемое значение

Обещание<Models.GetServiceManifestResponse>

getServiceManifest(string, string, string, ServiceFabricClientGetServiceManifestOptionalParams, ServiceCallback<ServiceTypeManifest>)

function getServiceManifest(applicationTypeName: string, applicationTypeVersion: string, serviceManifestName: string, options: ServiceFabricClientGetServiceManifestOptionalParams, callback: ServiceCallback<ServiceTypeManifest>)

Параметры

applicationTypeName

string

Имя типа приложения.

applicationTypeVersion

string

Версия типа приложения.

serviceManifestName

string

Имя манифеста службы, зарегистрированного в составе типа приложения в кластере Service Fabric.

options
ServiceFabricClientGetServiceManifestOptionalParams

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

callback

ServiceCallback<ServiceTypeManifest>

Обратный вызов

getServiceNameInfo(string, ServiceCallback<ServiceNameInfo>)

function getServiceNameInfo(partitionId: string, callback: ServiceCallback<ServiceNameInfo>)

Параметры

partitionId

string

Удостоверение секции.

callback

ServiceCallback<ServiceNameInfo>

Обратный вызов

getServiceNameInfo(string, ServiceFabricClientGetServiceNameInfoOptionalParams)

Возвращает имя службы для указанной секции. Возвращается ошибка 404, если идентификатор секции не существует в кластере.

function getServiceNameInfo(partitionId: string, options?: ServiceFabricClientGetServiceNameInfoOptionalParams): Promise<GetServiceNameInfoResponse>

Параметры

partitionId

string

Удостоверение секции.

options
ServiceFabricClientGetServiceNameInfoOptionalParams

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

Возвращаемое значение

Обещание<Models.GetServiceNameInfoResponse>

getServiceNameInfo(string, ServiceFabricClientGetServiceNameInfoOptionalParams, ServiceCallback<ServiceNameInfo>)

function getServiceNameInfo(partitionId: string, options: ServiceFabricClientGetServiceNameInfoOptionalParams, callback: ServiceCallback<ServiceNameInfo>)

Параметры

partitionId

string

Удостоверение секции.

options
ServiceFabricClientGetServiceNameInfoOptionalParams

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

callback

ServiceCallback<ServiceNameInfo>

Обратный вызов

getServicesEventList(string, string, ServiceCallback<ServiceEventUnion[]>)

function getServicesEventList(startTimeUtc: string, endTimeUtc: string, callback: ServiceCallback<ServiceEventUnion[]>)

Параметры

startTimeUtc

string

Время начала запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

endTimeUtc

string

Время окончания запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

callback

ServiceCallback<ServiceEventUnion[]>

Обратный вызов

getServicesEventList(string, string, ServiceFabricClientGetServicesEventListOptionalParams)

Ответ — это список объектов ServiceEvent.

function getServicesEventList(startTimeUtc: string, endTimeUtc: string, options?: ServiceFabricClientGetServicesEventListOptionalParams): Promise<GetServicesEventListResponse>

Параметры

startTimeUtc

string

Время начала запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

endTimeUtc

string

Время окончания запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

options
ServiceFabricClientGetServicesEventListOptionalParams

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

Возвращаемое значение

Обещание<Models.GetServicesEventListResponse>

getServicesEventList(string, string, ServiceFabricClientGetServicesEventListOptionalParams, ServiceCallback<ServiceEventUnion[]>)

function getServicesEventList(startTimeUtc: string, endTimeUtc: string, options: ServiceFabricClientGetServicesEventListOptionalParams, callback: ServiceCallback<ServiceEventUnion[]>)

Параметры

startTimeUtc

string

Время начала запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

endTimeUtc

string

Время окончания запроса подстановки в формате ISO yyyy-MM-ddTHH:mm:ssZ.

options
ServiceFabricClientGetServicesEventListOptionalParams

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

callback

ServiceCallback<ServiceEventUnion[]>

Обратный вызов

getServiceTypeInfoByName(string, string, string, ServiceCallback<ServiceTypeInfo>)

function getServiceTypeInfoByName(applicationTypeName: string, applicationTypeVersion: string, serviceTypeName: string, callback: ServiceCallback<ServiceTypeInfo>)

Параметры

applicationTypeName

string

Имя типа приложения.

applicationTypeVersion

string

Версия типа приложения.

serviceTypeName

string

Указывает имя типа службы Service Fabric.

callback

ServiceCallback<ServiceTypeInfo>

Обратный вызов

getServiceTypeInfoByName(string, string, string, ServiceFabricClientGetServiceTypeInfoByNameOptionalParams)

Возвращает сведения о конкретном типе службы, поддерживаемом подготовленным типом приложения в кластере Service Fabric. Указанный тип приложения должен существовать. В противном случае возвращается состояние 404. Ответ 204 возвращается, если указанный тип службы не найден в кластере.

function getServiceTypeInfoByName(applicationTypeName: string, applicationTypeVersion: string, serviceTypeName: string, options?: ServiceFabricClientGetServiceTypeInfoByNameOptionalParams): Promise<GetServiceTypeInfoByNameResponse>

Параметры

applicationTypeName

string

Имя типа приложения.

applicationTypeVersion

string

Версия типа приложения.

serviceTypeName

string

Указывает имя типа службы Service Fabric.

options
ServiceFabricClientGetServiceTypeInfoByNameOptionalParams

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

Возвращаемое значение

Обещание<Models.GetServiceTypeInfoByNameResponse>

getServiceTypeInfoByName(string, string, string, ServiceFabricClientGetServiceTypeInfoByNameOptionalParams, ServiceCallback<ServiceTypeInfo>)

function getServiceTypeInfoByName(applicationTypeName: string, applicationTypeVersion: string, serviceTypeName: string, options: ServiceFabricClientGetServiceTypeInfoByNameOptionalParams, callback: ServiceCallback<ServiceTypeInfo>)

Параметры

applicationTypeName

string

Имя типа приложения.

applicationTypeVersion

string

Версия типа приложения.

serviceTypeName

string

Указывает имя типа службы Service Fabric.

options
ServiceFabricClientGetServiceTypeInfoByNameOptionalParams

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

callback

ServiceCallback<ServiceTypeInfo>

Обратный вызов

getServiceTypeInfoList(string, string, ServiceCallback<ServiceTypeInfo[]>)

function getServiceTypeInfoList(applicationTypeName: string, applicationTypeVersion: string, callback: ServiceCallback<ServiceTypeInfo[]>)

Параметры

applicationTypeName

string

Имя типа приложения.

applicationTypeVersion

string

Версия типа приложения.

callback

ServiceCallback<ServiceTypeInfo[]>

Обратный вызов

getServiceTypeInfoList(string, string, ServiceFabricClientGetServiceTypeInfoListOptionalParams)

Возвращает список, содержащий сведения о типах служб, поддерживаемых подготовленным типом приложения в кластере Service Fabric. Указанный тип приложения должен существовать. В противном случае возвращается состояние 404.

function getServiceTypeInfoList(applicationTypeName: string, applicationTypeVersion: string, options?: ServiceFabricClientGetServiceTypeInfoListOptionalParams): Promise<GetServiceTypeInfoListResponse>

Параметры

applicationTypeName

string

Имя типа приложения.

applicationTypeVersion

string

Версия типа приложения.

options
ServiceFabricClientGetServiceTypeInfoListOptionalParams

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

Возвращаемое значение

Обещание<Models.GetServiceTypeInfoListResponse>

getServiceTypeInfoList(string, string, ServiceFabricClientGetServiceTypeInfoListOptionalParams, ServiceCallback<ServiceTypeInfo[]>)

function getServiceTypeInfoList(applicationTypeName: string, applicationTypeVersion: string, options: ServiceFabricClientGetServiceTypeInfoListOptionalParams, callback: ServiceCallback<ServiceTypeInfo[]>)

Параметры

applicationTypeName

string

Имя типа приложения.

applicationTypeVersion

string

Версия типа приложения.

options
ServiceFabricClientGetServiceTypeInfoListOptionalParams

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

callback

ServiceCallback<ServiceTypeInfo[]>

Обратный вызов

getSubNameInfoList(string, ServiceCallback<PagedSubNameInfoList>)

function getSubNameInfoList(nameId: string, callback: ServiceCallback<PagedSubNameInfoList>)

Параметры

nameId

string

Имя Service Fabric без схемы URI fabric:.

callback

ServiceCallback<PagedSubNameInfoList>

Обратный вызов

getSubNameInfoList(string, ServiceFabricClientGetSubNameInfoListOptionalParams)

Перечисляет все имена Service Fabric под заданным именем. Если вложенные имена не помещаются на страницу, возвращается одна страница результатов, а также маркер продолжения, который можно использовать для получения следующей страницы. Запрос имени, который не существует, завершится ошибкой.

function getSubNameInfoList(nameId: string, options?: ServiceFabricClientGetSubNameInfoListOptionalParams): Promise<GetSubNameInfoListResponse>

Параметры

nameId

string

Имя Service Fabric без схемы URI fabric:.

options
ServiceFabricClientGetSubNameInfoListOptionalParams

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

Возвращаемое значение

Обещание<Models.GetSubNameInfoListResponse>

getSubNameInfoList(string, ServiceFabricClientGetSubNameInfoListOptionalParams, ServiceCallback<PagedSubNameInfoList>)

function getSubNameInfoList(nameId: string, options: ServiceFabricClientGetSubNameInfoListOptionalParams, callback: ServiceCallback<PagedSubNameInfoList>)

Параметры

nameId

string

Имя Service Fabric без схемы URI fabric:.

options
ServiceFabricClientGetSubNameInfoListOptionalParams

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

callback

ServiceCallback<PagedSubNameInfoList>

Обратный вызов

getUnplacedReplicaInformation(string, ServiceCallback<UnplacedReplicaInformation>)

function getUnplacedReplicaInformation(serviceId: string, callback: ServiceCallback<UnplacedReplicaInformation>)

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

callback

ServiceCallback<UnplacedReplicaInformation>

Обратный вызов

getUnplacedReplicaInformation(string, ServiceFabricClientGetUnplacedReplicaInformationOptionalParams)

Возвращает сведения о неуправляемых репликах службы. Если параметр PartitionId указан, результат будет содержать сведения только о неуправляемых репликах для этой секции. Если PartitionId не указан, результат будет содержать сведения о незаместенных репликах для всех секций этой службы. Если для OnlyQueryPrimaries задано значение true, результат будет содержать сведения только о первичных репликах и будет игнорировать неуправляемые вторичные реплики.

function getUnplacedReplicaInformation(serviceId: string, options?: ServiceFabricClientGetUnplacedReplicaInformationOptionalParams): Promise<GetUnplacedReplicaInformationResponse>

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

options
ServiceFabricClientGetUnplacedReplicaInformationOptionalParams

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

Возвращаемое значение

Обещание<Models.GetUnplacedReplicaInformationResponse>

getUnplacedReplicaInformation(string, ServiceFabricClientGetUnplacedReplicaInformationOptionalParams, ServiceCallback<UnplacedReplicaInformation>)

function getUnplacedReplicaInformation(serviceId: string, options: ServiceFabricClientGetUnplacedReplicaInformationOptionalParams, callback: ServiceCallback<UnplacedReplicaInformation>)

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

options
ServiceFabricClientGetUnplacedReplicaInformationOptionalParams

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

callback

ServiceCallback<UnplacedReplicaInformation>

Обратный вызов

getUpgradeOrchestrationServiceState(ServiceCallback<UpgradeOrchestrationServiceState>)

function getUpgradeOrchestrationServiceState(callback: ServiceCallback<UpgradeOrchestrationServiceState>)

Параметры

callback

ServiceCallback<UpgradeOrchestrationServiceState>

Обратный вызов

getUpgradeOrchestrationServiceState(ServiceFabricClientGetUpgradeOrchestrationServiceStateOptionalParams)

Получите состояние службы service Fabric Upgrade Orchestration Service. Этот API используется во внутренней среде для поддержки.

function getUpgradeOrchestrationServiceState(options?: ServiceFabricClientGetUpgradeOrchestrationServiceStateOptionalParams): Promise<GetUpgradeOrchestrationServiceStateResponse>

Параметры

options
ServiceFabricClientGetUpgradeOrchestrationServiceStateOptionalParams

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

Возвращаемое значение

Обещание<Models.GetUpgradeOrchestrationServiceStateResponse>

getUpgradeOrchestrationServiceState(ServiceFabricClientGetUpgradeOrchestrationServiceStateOptionalParams, ServiceCallback<UpgradeOrchestrationServiceState>)

function getUpgradeOrchestrationServiceState(options: ServiceFabricClientGetUpgradeOrchestrationServiceStateOptionalParams, callback: ServiceCallback<UpgradeOrchestrationServiceState>)

Параметры

options
ServiceFabricClientGetUpgradeOrchestrationServiceStateOptionalParams

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

callback

ServiceCallback<UpgradeOrchestrationServiceState>

Обратный вызов

invokeContainerApi(string, string, string, string, string, ContainerApiRequestBody, ServiceCallback<ContainerApiResponse>)

function invokeContainerApi(nodeName: string, applicationId: string, serviceManifestName: string, codePackageName: string, codePackageInstanceId: string, containerApiRequestBody: ContainerApiRequestBody, callback: ServiceCallback<ContainerApiResponse>)

Параметры

nodeName

string

Имя узла.

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

serviceManifestName

string

Имя манифеста службы, зарегистрированного в составе типа приложения в кластере Service Fabric.

codePackageName

string

Имя пакета кода, указанного в манифесте службы, зарегистрированном в составе типа приложения в кластере Service Fabric.

codePackageInstanceId

string

Идентификатор, который однозначно идентифицирует экземпляр пакета кода, развернутый на узле Service Fabric.

containerApiRequestBody
ContainerApiRequestBody

Параметры для вызова API контейнера

callback

ServiceCallback<ContainerApiResponse>

Обратный вызов

invokeContainerApi(string, string, string, string, string, ContainerApiRequestBody, ServiceFabricClientInvokeContainerApiOptionalParams)

Вызов API контейнера в контейнере, развернутом на узле Service Fabric для данного пакета кода.

function invokeContainerApi(nodeName: string, applicationId: string, serviceManifestName: string, codePackageName: string, codePackageInstanceId: string, containerApiRequestBody: ContainerApiRequestBody, options?: ServiceFabricClientInvokeContainerApiOptionalParams): Promise<InvokeContainerApiResponse>

Параметры

nodeName

string

Имя узла.

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

serviceManifestName

string

Имя манифеста службы, зарегистрированного в составе типа приложения в кластере Service Fabric.

codePackageName

string

Имя пакета кода, указанного в манифесте службы, зарегистрированном в составе типа приложения в кластере Service Fabric.

codePackageInstanceId

string

Идентификатор, который однозначно идентифицирует экземпляр пакета кода, развернутый на узле Service Fabric.

containerApiRequestBody
ContainerApiRequestBody

Параметры для вызова API контейнера

options
ServiceFabricClientInvokeContainerApiOptionalParams

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

Возвращаемое значение

Обещание<Models.InvokeContainerApiResponse>

invokeContainerApi(string, string, string, string, string, ContainerApiRequestBody, ServiceFabricClientInvokeContainerApiOptionalParams, ServiceCallback<ContainerApiResponse>)

function invokeContainerApi(nodeName: string, applicationId: string, serviceManifestName: string, codePackageName: string, codePackageInstanceId: string, containerApiRequestBody: ContainerApiRequestBody, options: ServiceFabricClientInvokeContainerApiOptionalParams, callback: ServiceCallback<ContainerApiResponse>)

Параметры

nodeName

string

Имя узла.

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

serviceManifestName

string

Имя манифеста службы, зарегистрированного в составе типа приложения в кластере Service Fabric.

codePackageName

string

Имя пакета кода, указанного в манифесте службы, зарегистрированном в составе типа приложения в кластере Service Fabric.

codePackageInstanceId

string

Идентификатор, который однозначно идентифицирует экземпляр пакета кода, развернутый на узле Service Fabric.

containerApiRequestBody
ContainerApiRequestBody

Параметры для вызова API контейнера

options
ServiceFabricClientInvokeContainerApiOptionalParams

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

callback

ServiceCallback<ContainerApiResponse>

Обратный вызов

invokeInfrastructureCommand(string, ServiceCallback<string>)

function invokeInfrastructureCommand(command: string, callback: ServiceCallback<string>)

Параметры

command

string

Текст вызываемой команды. Содержимое команды зависит от инфраструктуры.

callback

ServiceCallback<string>

Обратный вызов

invokeInfrastructureCommand(string, ServiceFabricClientInvokeInfrastructureCommandOptionalParams)

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

Доступные команды и соответствующие форматы ответов зависят от инфраструктуры, в которой выполняется кластер.

Этот API поддерживает платформу Service Fabric; Он не предназначен для использования непосредственно из кода.

function invokeInfrastructureCommand(command: string, options?: ServiceFabricClientInvokeInfrastructureCommandOptionalParams): Promise<InvokeInfrastructureCommandResponse>

Параметры

command

string

Текст вызываемой команды. Содержимое команды зависит от инфраструктуры.

options
ServiceFabricClientInvokeInfrastructureCommandOptionalParams

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

Возвращаемое значение

Обещание<Models.InvokeInfrastructureCommandResponse>

invokeInfrastructureCommand(string, ServiceFabricClientInvokeInfrastructureCommandOptionalParams, ServiceCallback<string>)

function invokeInfrastructureCommand(command: string, options: ServiceFabricClientInvokeInfrastructureCommandOptionalParams, callback: ServiceCallback<string>)

Параметры

command

string

Текст вызываемой команды. Содержимое команды зависит от инфраструктуры.

options
ServiceFabricClientInvokeInfrastructureCommandOptionalParams

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

callback

ServiceCallback<string>

Обратный вызов

invokeInfrastructureQuery(string, ServiceCallback<string>)

function invokeInfrastructureQuery(command: string, callback: ServiceCallback<string>)

Параметры

command

string

Текст вызываемой команды. Содержимое команды зависит от инфраструктуры.

callback

ServiceCallback<string>

Обратный вызов

invokeInfrastructureQuery(string, ServiceFabricClientInvokeInfrastructureQueryOptionalParams)

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

Доступные команды и соответствующие форматы ответов зависят от инфраструктуры, в которой выполняется кластер.

Этот API поддерживает платформу Service Fabric; Он не предназначен для использования непосредственно из кода.

function invokeInfrastructureQuery(command: string, options?: ServiceFabricClientInvokeInfrastructureQueryOptionalParams): Promise<InvokeInfrastructureQueryResponse>

Параметры

command

string

Текст вызываемой команды. Содержимое команды зависит от инфраструктуры.

options
ServiceFabricClientInvokeInfrastructureQueryOptionalParams

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

Возвращаемое значение

Обещание<Models.InvokeInfrastructureQueryResponse>

invokeInfrastructureQuery(string, ServiceFabricClientInvokeInfrastructureQueryOptionalParams, ServiceCallback<string>)

function invokeInfrastructureQuery(command: string, options: ServiceFabricClientInvokeInfrastructureQueryOptionalParams, callback: ServiceCallback<string>)

Параметры

command

string

Текст вызываемой команды. Содержимое команды зависит от инфраструктуры.

options
ServiceFabricClientInvokeInfrastructureQueryOptionalParams

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

callback

ServiceCallback<string>

Обратный вызов

movePrimaryReplica(string, ServiceCallback<void>)

function movePrimaryReplica(partitionId: string, callback: ServiceCallback<void>)

Параметры

partitionId

string

Удостоверение секции.

callback

ServiceCallback<void>

Обратный вызов

movePrimaryReplica(string, ServiceFabricClientMovePrimaryReplicaOptionalParams)

Эта команда перемещает основную реплику секции службы с отслеживанием состояния, учитывая все ограничения. Если задан параметр NodeName, первичный объект будет перемещен на указанный узел (если ограничения позволяют ему). Если параметр NodeName не указан, первичная реплика будет перемещена на случайный узел в кластере. Если параметр IgnoreConstraints указан и задано значение true, основной объект будет перемещен независимо от ограничений.

function movePrimaryReplica(partitionId: string, options?: ServiceFabricClientMovePrimaryReplicaOptionalParams): Promise<RestResponse>

Параметры

partitionId

string

Удостоверение секции.

options
ServiceFabricClientMovePrimaryReplicaOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

movePrimaryReplica(string, ServiceFabricClientMovePrimaryReplicaOptionalParams, ServiceCallback<void>)

function movePrimaryReplica(partitionId: string, options: ServiceFabricClientMovePrimaryReplicaOptionalParams, callback: ServiceCallback<void>)

Параметры

partitionId

string

Удостоверение секции.

options
ServiceFabricClientMovePrimaryReplicaOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

moveSecondaryReplica(string, string, ServiceCallback<void>)

function moveSecondaryReplica(partitionId: string, currentNodeName: string, callback: ServiceCallback<void>)

Параметры

partitionId

string

Удостоверение секции.

currentNodeName

string

Имя исходного узла для перемещения вторичной реплики.

callback

ServiceCallback<void>

Обратный вызов

moveSecondaryReplica(string, string, ServiceFabricClientMoveSecondaryReplicaOptionalParams)

Эта команда перемещает вторичную реплику секции службы с отслеживанием состояния, уважая все ограничения. Для идентификации перемещаемой реплики необходимо указать параметр CurrentNodeName. Имя исходного узла должно быть указано, но новое имя узла может быть пропущено, и в этом случае реплика перемещается на случайный узел. Если параметр IgnoreConstraints указан и задано значение true, то вторичный будет перемещен независимо от ограничений.

function moveSecondaryReplica(partitionId: string, currentNodeName: string, options?: ServiceFabricClientMoveSecondaryReplicaOptionalParams): Promise<RestResponse>

Параметры

partitionId

string

Удостоверение секции.

currentNodeName

string

Имя исходного узла для перемещения вторичной реплики.

options
ServiceFabricClientMoveSecondaryReplicaOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

moveSecondaryReplica(string, string, ServiceFabricClientMoveSecondaryReplicaOptionalParams, ServiceCallback<void>)

function moveSecondaryReplica(partitionId: string, currentNodeName: string, options: ServiceFabricClientMoveSecondaryReplicaOptionalParams, callback: ServiceCallback<void>)

Параметры

partitionId

string

Удостоверение секции.

currentNodeName

string

Имя исходного узла для перемещения вторичной реплики.

options
ServiceFabricClientMoveSecondaryReplicaOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

postChaosSchedule(ChaosScheduleDescription, ServiceCallback<void>)

function postChaosSchedule(chaosSchedule: ChaosScheduleDescription, callback: ServiceCallback<void>)

Параметры

chaosSchedule
ChaosScheduleDescription

Описывает расписание, используемое Хаосом.

callback

ServiceCallback<void>

Обратный вызов

postChaosSchedule(ChaosScheduleDescription, ServiceFabricClientPostChaosScheduleOptionalParams)

Хаос автоматически запланирует запуски на основе расписания хаоса. Расписание хаоса будет обновлено, если указанная версия соответствует версии на сервере. При обновлении расписания хаоса версия на сервере увеличивается на 1. Версия на сервере будет отключать до 0 после достижения большого числа. Если хаос выполняется при выполнении этого вызова, вызов завершится ошибкой.

function postChaosSchedule(chaosSchedule: ChaosScheduleDescription, options?: ServiceFabricClientPostChaosScheduleOptionalParams): Promise<RestResponse>

Параметры

chaosSchedule
ChaosScheduleDescription

Описывает расписание, используемое Хаосом.

options
ServiceFabricClientPostChaosScheduleOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

postChaosSchedule(ChaosScheduleDescription, ServiceFabricClientPostChaosScheduleOptionalParams, ServiceCallback<void>)

function postChaosSchedule(chaosSchedule: ChaosScheduleDescription, options: ServiceFabricClientPostChaosScheduleOptionalParams, callback: ServiceCallback<void>)

Параметры

chaosSchedule
ChaosScheduleDescription

Описывает расписание, используемое Хаосом.

options
ServiceFabricClientPostChaosScheduleOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

provisionApplicationType(ProvisionApplicationTypeDescriptionBaseUnion, ServiceCallback<void>)

function provisionApplicationType(provisionApplicationTypeDescriptionBaseRequiredBodyParam: ProvisionApplicationTypeDescriptionBaseUnion, callback: ServiceCallback<void>)

Параметры

provisionApplicationTypeDescriptionBaseRequiredBodyParam
ProvisionApplicationTypeDescriptionBaseUnion

Базовый тип описания типа приложения подготовки, который поддерживает подготовку на основе хранилища образов или подготовку на основе внешнего хранилища.

callback

ServiceCallback<void>

Обратный вызов

provisionApplicationType(ProvisionApplicationTypeDescriptionBaseUnion, ServiceFabricClientProvisionApplicationTypeOptionalParams)

Подготавливает тип приложения Service Fabric к кластеру. Подготовка требуется перед созданием экземпляров новых приложений. Операция подготовки может выполняться либо в пакете приложения, заданном относительнымPathInImageStore, либо с помощью URI внешнего sfpkg.

function provisionApplicationType(provisionApplicationTypeDescriptionBaseRequiredBodyParam: ProvisionApplicationTypeDescriptionBaseUnion, options?: ServiceFabricClientProvisionApplicationTypeOptionalParams): Promise<RestResponse>

Параметры

provisionApplicationTypeDescriptionBaseRequiredBodyParam
ProvisionApplicationTypeDescriptionBaseUnion

Базовый тип описания типа приложения подготовки, который поддерживает подготовку на основе хранилища образов или подготовку на основе внешнего хранилища.

options
ServiceFabricClientProvisionApplicationTypeOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

provisionApplicationType(ProvisionApplicationTypeDescriptionBaseUnion, ServiceFabricClientProvisionApplicationTypeOptionalParams, ServiceCallback<void>)

function provisionApplicationType(provisionApplicationTypeDescriptionBaseRequiredBodyParam: ProvisionApplicationTypeDescriptionBaseUnion, options: ServiceFabricClientProvisionApplicationTypeOptionalParams, callback: ServiceCallback<void>)

Параметры

provisionApplicationTypeDescriptionBaseRequiredBodyParam
ProvisionApplicationTypeDescriptionBaseUnion

Базовый тип описания типа приложения подготовки, который поддерживает подготовку на основе хранилища образов или подготовку на основе внешнего хранилища.

options
ServiceFabricClientProvisionApplicationTypeOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

provisionCluster(ProvisionFabricDescription, ServiceCallback<void>)

function provisionCluster(provisionFabricDescription: ProvisionFabricDescription, callback: ServiceCallback<void>)

Параметры

provisionFabricDescription
ProvisionFabricDescription

Описывает параметры подготовки кластера.

callback

ServiceCallback<void>

Обратный вызов

provisionCluster(ProvisionFabricDescription, ServiceFabricClientProvisionClusterOptionalParams)

Проверьте и подготовьте код или пакеты конфигурации кластера Service Fabric.

function provisionCluster(provisionFabricDescription: ProvisionFabricDescription, options?: ServiceFabricClientProvisionClusterOptionalParams): Promise<RestResponse>

Параметры

provisionFabricDescription
ProvisionFabricDescription

Описывает параметры подготовки кластера.

options
ServiceFabricClientProvisionClusterOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

provisionCluster(ProvisionFabricDescription, ServiceFabricClientProvisionClusterOptionalParams, ServiceCallback<void>)

function provisionCluster(provisionFabricDescription: ProvisionFabricDescription, options: ServiceFabricClientProvisionClusterOptionalParams, callback: ServiceCallback<void>)

Параметры

provisionFabricDescription
ProvisionFabricDescription

Описывает параметры подготовки кластера.

options
ServiceFabricClientProvisionClusterOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

putProperty(string, PropertyDescription, ServiceCallback<void>)

function putProperty(nameId: string, propertyDescription: PropertyDescription, callback: ServiceCallback<void>)

Параметры

nameId

string

Имя Service Fabric без схемы URI fabric:.

propertyDescription
PropertyDescription

Описывает созданное свойство Service Fabric.

callback

ServiceCallback<void>

Обратный вызов

putProperty(string, PropertyDescription, ServiceFabricClientPutPropertyOptionalParams)

Создает или обновляет указанное свойство Service Fabric под заданным именем.

function putProperty(nameId: string, propertyDescription: PropertyDescription, options?: ServiceFabricClientPutPropertyOptionalParams): Promise<RestResponse>

Параметры

nameId

string

Имя Service Fabric без схемы URI fabric:.

propertyDescription
PropertyDescription

Описывает созданное свойство Service Fabric.

options
ServiceFabricClientPutPropertyOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

putProperty(string, PropertyDescription, ServiceFabricClientPutPropertyOptionalParams, ServiceCallback<void>)

function putProperty(nameId: string, propertyDescription: PropertyDescription, options: ServiceFabricClientPutPropertyOptionalParams, callback: ServiceCallback<void>)

Параметры

nameId

string

Имя Service Fabric без схемы URI fabric:.

propertyDescription
PropertyDescription

Описывает созданное свойство Service Fabric.

options
ServiceFabricClientPutPropertyOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

recoverAllPartitions(ServiceCallback<void>)

function recoverAllPartitions(callback: ServiceCallback<void>)

Параметры

callback

ServiceCallback<void>

Обратный вызов

recoverAllPartitions(ServiceFabricClientRecoverAllPartitionsOptionalParams)

Эта операция должна выполняться только в том случае, если известно, что реплики, которые находятся вниз, не могут быть восстановлены. Неправильное использование этого API может привести к потенциальной потере данных.

function recoverAllPartitions(options?: ServiceFabricClientRecoverAllPartitionsOptionalParams): Promise<RestResponse>

Параметры

options
ServiceFabricClientRecoverAllPartitionsOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

recoverAllPartitions(ServiceFabricClientRecoverAllPartitionsOptionalParams, ServiceCallback<void>)

function recoverAllPartitions(options: ServiceFabricClientRecoverAllPartitionsOptionalParams, callback: ServiceCallback<void>)

Параметры

options
ServiceFabricClientRecoverAllPartitionsOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

recoverPartition(string, ServiceCallback<void>)

function recoverPartition(partitionId: string, callback: ServiceCallback<void>)

Параметры

partitionId

string

Удостоверение секции.

callback

ServiceCallback<void>

Обратный вызов

recoverPartition(string, ServiceFabricClientRecoverPartitionOptionalParams)

Эта операция должна выполняться только в том случае, если известно, что реплики, которые находятся вниз, не могут быть восстановлены. Неправильное использование этого API может привести к потенциальной потере данных.

function recoverPartition(partitionId: string, options?: ServiceFabricClientRecoverPartitionOptionalParams): Promise<RestResponse>

Параметры

partitionId

string

Удостоверение секции.

options
ServiceFabricClientRecoverPartitionOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

recoverPartition(string, ServiceFabricClientRecoverPartitionOptionalParams, ServiceCallback<void>)

function recoverPartition(partitionId: string, options: ServiceFabricClientRecoverPartitionOptionalParams, callback: ServiceCallback<void>)

Параметры

partitionId

string

Удостоверение секции.

options
ServiceFabricClientRecoverPartitionOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

recoverServicePartitions(string, ServiceCallback<void>)

function recoverServicePartitions(serviceId: string, callback: ServiceCallback<void>)

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

callback

ServiceCallback<void>

Обратный вызов

recoverServicePartitions(string, ServiceFabricClientRecoverServicePartitionsOptionalParams)

Указывает кластеру Service Fabric, что он должен попытаться восстановить указанную службу, которая в настоящее время зависла в потере кворума. Эта операция должна выполняться только в том случае, если известно, что реплики, которые находятся вниз, не могут быть восстановлены. Неправильное использование этого API может привести к потенциальной потере данных.

function recoverServicePartitions(serviceId: string, options?: ServiceFabricClientRecoverServicePartitionsOptionalParams): Promise<RestResponse>

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

options
ServiceFabricClientRecoverServicePartitionsOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

recoverServicePartitions(string, ServiceFabricClientRecoverServicePartitionsOptionalParams, ServiceCallback<void>)

function recoverServicePartitions(serviceId: string, options: ServiceFabricClientRecoverServicePartitionsOptionalParams, callback: ServiceCallback<void>)

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

options
ServiceFabricClientRecoverServicePartitionsOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

recoverSystemPartitions(ServiceCallback<void>)

function recoverSystemPartitions(callback: ServiceCallback<void>)

Параметры

callback

ServiceCallback<void>

Обратный вызов

recoverSystemPartitions(ServiceFabricClientRecoverSystemPartitionsOptionalParams)

Указывает кластеру Service Fabric, что он должен попытаться восстановить системные службы, которые в настоящее время застряли в потере кворума. Эта операция должна выполняться только в том случае, если известно, что реплики, которые находятся вниз, не могут быть восстановлены. Неправильное использование этого API может привести к потенциальной потере данных.

function recoverSystemPartitions(options?: ServiceFabricClientRecoverSystemPartitionsOptionalParams): Promise<RestResponse>

Параметры

options
ServiceFabricClientRecoverSystemPartitionsOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

recoverSystemPartitions(ServiceFabricClientRecoverSystemPartitionsOptionalParams, ServiceCallback<void>)

function recoverSystemPartitions(options: ServiceFabricClientRecoverSystemPartitionsOptionalParams, callback: ServiceCallback<void>)

Параметры

options
ServiceFabricClientRecoverSystemPartitionsOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

removeComposeDeployment(string, ServiceCallback<void>)

function removeComposeDeployment(deploymentName: string, callback: ServiceCallback<void>)

Параметры

deploymentName

string

Удостоверение развертывания.

callback

ServiceCallback<void>

Обратный вызов

removeComposeDeployment(string, ServiceFabricClientRemoveComposeDeploymentOptionalParams)

Удаляет существующее развертывание Создания Service Fabric.

function removeComposeDeployment(deploymentName: string, options?: ServiceFabricClientRemoveComposeDeploymentOptionalParams): Promise<RestResponse>

Параметры

deploymentName

string

Удостоверение развертывания.

options
ServiceFabricClientRemoveComposeDeploymentOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

removeComposeDeployment(string, ServiceFabricClientRemoveComposeDeploymentOptionalParams, ServiceCallback<void>)

function removeComposeDeployment(deploymentName: string, options: ServiceFabricClientRemoveComposeDeploymentOptionalParams, callback: ServiceCallback<void>)

Параметры

deploymentName

string

Удостоверение развертывания.

options
ServiceFabricClientRemoveComposeDeploymentOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

removeConfigurationOverrides(string, ServiceCallback<void>)

function removeConfigurationOverrides(nodeName: string, callback: ServiceCallback<void>)

Параметры

nodeName

string

Имя узла.

callback

ServiceCallback<void>

Обратный вызов

removeConfigurationOverrides(string, ServiceFabricClientRemoveConfigurationOverridesOptionalParams)

Этот API позволяет удалить все существующие переопределения конфигурации на указанном узле.

function removeConfigurationOverrides(nodeName: string, options?: ServiceFabricClientRemoveConfigurationOverridesOptionalParams): Promise<RestResponse>

Параметры

nodeName

string

Имя узла.

options
ServiceFabricClientRemoveConfigurationOverridesOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

removeConfigurationOverrides(string, ServiceFabricClientRemoveConfigurationOverridesOptionalParams, ServiceCallback<void>)

function removeConfigurationOverrides(nodeName: string, options: ServiceFabricClientRemoveConfigurationOverridesOptionalParams, callback: ServiceCallback<void>)

Параметры

nodeName

string

Имя узла.

options
ServiceFabricClientRemoveConfigurationOverridesOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

removeNodeState(string, ServiceCallback<void>)

function removeNodeState(nodeName: string, callback: ServiceCallback<void>)

Параметры

nodeName

string

Имя узла.

callback

ServiceCallback<void>

Обратный вызов

removeNodeState(string, ServiceFabricClientRemoveNodeStateOptionalParams)

Это означает, что восстановление сохраняемого состояния этого узла невозможно. Как правило, это происходит, если жесткий диск был очисткой или если жесткий диск завершается сбоем. Узел должен быть отключен, чтобы эта операция была успешной. Эта операция позволяет Service Fabric знать, что реплики на этом узле больше не существуют, и что Service Fabric должен перестать ожидать резервного копирования этих реплик. Не выполняйте этот командлет, если состояние на узле не было удалено, и узел может вернуться с его состоянием без изменений. Начиная с Service Fabric 6.5, чтобы использовать этот API для начальных узлов, измените начальные узлы на обычные (не начальные) узлы, а затем вызовите этот API, чтобы удалить состояние узла. Если кластер запущен в Azure, после перехода начального узла Service Fabric попытается автоматически изменить его на незатратовый узел. Чтобы это произошло, убедитесь, что количество узлов, отличных от начального значения, в типе первичного узла не меньше числа начальных узлов вниз. При необходимости добавьте дополнительные узлы в тип основного узла, чтобы добиться этого. Если автономному кластеру не ожидается резервное копирование с его состоянием, удалите узел из кластера, см. https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-cluster-windows-server-add-remove-nodes

function removeNodeState(nodeName: string, options?: ServiceFabricClientRemoveNodeStateOptionalParams): Promise<RestResponse>

Параметры

nodeName

string

Имя узла.

options
ServiceFabricClientRemoveNodeStateOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

removeNodeState(string, ServiceFabricClientRemoveNodeStateOptionalParams, ServiceCallback<void>)

function removeNodeState(nodeName: string, options: ServiceFabricClientRemoveNodeStateOptionalParams, callback: ServiceCallback<void>)

Параметры

nodeName

string

Имя узла.

options
ServiceFabricClientRemoveNodeStateOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

removeReplica(string, string, string, ServiceCallback<void>)

function removeReplica(nodeName: string, partitionId: string, replicaId: string, callback: ServiceCallback<void>)

Параметры

nodeName

string

Имя узла.

partitionId

string

Удостоверение секции.

replicaId

string

Идентификатор реплики.

callback

ServiceCallback<void>

Обратный вызов

removeReplica(string, string, string, ServiceFabricClientRemoveReplicaOptionalParams)

Этот API имитирует сбой реплики Service Fabric, удалив реплику из кластера Service Fabric. Удаление закрывает реплику, перемещает реплику на роль None, а затем удаляет все сведения о состоянии реплики из кластера. Этот API проверяет путь удаления состояния реплики и имитирует постоянный путь отчета через клиентские API. Предупреждение. При использовании этого API не выполняются проверки безопасности. Неправильное использование этого API может привести к потере данных для служб с отслеживанием состояния. Кроме того, флаг forceRemove влияет на все остальные реплики, размещенные в одном процессе.

function removeReplica(nodeName: string, partitionId: string, replicaId: string, options?: ServiceFabricClientRemoveReplicaOptionalParams): Promise<RestResponse>

Параметры

nodeName

string

Имя узла.

partitionId

string

Удостоверение секции.

replicaId

string

Идентификатор реплики.

options
ServiceFabricClientRemoveReplicaOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

removeReplica(string, string, string, ServiceFabricClientRemoveReplicaOptionalParams, ServiceCallback<void>)

function removeReplica(nodeName: string, partitionId: string, replicaId: string, options: ServiceFabricClientRemoveReplicaOptionalParams, callback: ServiceCallback<void>)

Параметры

nodeName

string

Имя узла.

partitionId

string

Удостоверение секции.

replicaId

string

Идентификатор реплики.

options
ServiceFabricClientRemoveReplicaOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

reportApplicationHealth(string, HealthInformation, ServiceCallback<void>)

function reportApplicationHealth(applicationId: string, healthInformation: HealthInformation, callback: ServiceCallback<void>)

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

healthInformation
HealthInformation

Описывает сведения о работоспособности отчета о работоспособности. Эта информация должна присутствовать во всех отчетах о работоспособности, отправленных руководителю работоспособности.

callback

ServiceCallback<void>

Обратный вызов

reportApplicationHealth(string, HealthInformation, ServiceFabricClientReportApplicationHealthOptionalParams)

Сообщает о состоянии работоспособности указанного приложения Service Fabric. Отчет должен содержать сведения о источнике отчета о работоспособности и свойстве, на котором он сообщается. Отчет отправляется в приложение шлюза Service Fabric, которое передается в хранилище работоспособности. Отчет может быть принят шлюзом, но отклонен хранилищем работоспособности после дополнительной проверки. Например, хранилище работоспособности может отклонить отчет из-за недопустимого параметра, например устаревший порядковый номер. Чтобы узнать, был ли отчет применен в хранилище работоспособности, получите работоспособность приложения и проверьте, отображается ли отчет в разделе HealthEvents.

function reportApplicationHealth(applicationId: string, healthInformation: HealthInformation, options?: ServiceFabricClientReportApplicationHealthOptionalParams): Promise<RestResponse>

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

healthInformation
HealthInformation

Описывает сведения о работоспособности отчета о работоспособности. Эта информация должна присутствовать во всех отчетах о работоспособности, отправленных руководителю работоспособности.

options
ServiceFabricClientReportApplicationHealthOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

reportApplicationHealth(string, HealthInformation, ServiceFabricClientReportApplicationHealthOptionalParams, ServiceCallback<void>)

function reportApplicationHealth(applicationId: string, healthInformation: HealthInformation, options: ServiceFabricClientReportApplicationHealthOptionalParams, callback: ServiceCallback<void>)

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

healthInformation
HealthInformation

Описывает сведения о работоспособности отчета о работоспособности. Эта информация должна присутствовать во всех отчетах о работоспособности, отправленных руководителю работоспособности.

options
ServiceFabricClientReportApplicationHealthOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

reportClusterHealth(HealthInformation, ServiceCallback<void>)

function reportClusterHealth(healthInformation: HealthInformation, callback: ServiceCallback<void>)

Параметры

healthInformation
HealthInformation

Описывает сведения о работоспособности отчета о работоспособности. Эта информация должна присутствовать во всех отчетах о работоспособности, отправленных руководителю работоспособности.

callback

ServiceCallback<void>

Обратный вызов

reportClusterHealth(HealthInformation, ServiceFabricClientReportClusterHealthOptionalParams)

Отправляет отчет о работоспособности в кластере Service Fabric. Отчет должен содержать сведения о источнике отчета о работоспособности и свойстве, на котором он сообщается. Отчет отправляется на узел шлюза Service Fabric, который пересылается в хранилище работоспособности. Отчет может быть принят шлюзом, но отклонен хранилищем работоспособности после дополнительной проверки. Например, хранилище работоспособности может отклонить отчет из-за недопустимого параметра, например устаревший порядковый номер. Чтобы узнать, был ли отчет применен в хранилище работоспособности, запустите GetClusterHealth и убедитесь, что отчет отображается в разделе HealthEvents.

function reportClusterHealth(healthInformation: HealthInformation, options?: ServiceFabricClientReportClusterHealthOptionalParams): Promise<RestResponse>

Параметры

healthInformation
HealthInformation

Описывает сведения о работоспособности отчета о работоспособности. Эта информация должна присутствовать во всех отчетах о работоспособности, отправленных руководителю работоспособности.

options
ServiceFabricClientReportClusterHealthOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

reportClusterHealth(HealthInformation, ServiceFabricClientReportClusterHealthOptionalParams, ServiceCallback<void>)

function reportClusterHealth(healthInformation: HealthInformation, options: ServiceFabricClientReportClusterHealthOptionalParams, callback: ServiceCallback<void>)

Параметры

healthInformation
HealthInformation

Описывает сведения о работоспособности отчета о работоспособности. Эта информация должна присутствовать во всех отчетах о работоспособности, отправленных руководителю работоспособности.

options
ServiceFabricClientReportClusterHealthOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

reportDeployedApplicationHealth(string, string, HealthInformation, ServiceCallback<void>)

function reportDeployedApplicationHealth(nodeName: string, applicationId: string, healthInformation: HealthInformation, callback: ServiceCallback<void>)

Параметры

nodeName

string

Имя узла.

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

healthInformation
HealthInformation

Описывает сведения о работоспособности отчета о работоспособности. Эта информация должна присутствовать во всех отчетах о работоспособности, отправленных руководителю работоспособности.

callback

ServiceCallback<void>

Обратный вызов

reportDeployedApplicationHealth(string, string, HealthInformation, ServiceFabricClientReportDeployedApplicationHealthOptionalParams)

Сообщает о состоянии работоспособности приложения, развернутого на узле Service Fabric. Отчет должен содержать сведения о источнике отчета о работоспособности и свойстве, на котором он сообщается. Отчет отправляется в службу шлюза Service Fabric, которая пересылается в хранилище работоспособности. Отчет может быть принят шлюзом, но отклонен хранилищем работоспособности после дополнительной проверки. Например, хранилище работоспособности может отклонить отчет из-за недопустимого параметра, например устаревший порядковый номер. Чтобы узнать, был ли отчет применен в хранилище работоспособности, получите развернутое приложение работоспособности и убедитесь, что отчет отображается в разделе HealthEvents.

function reportDeployedApplicationHealth(nodeName: string, applicationId: string, healthInformation: HealthInformation, options?: ServiceFabricClientReportDeployedApplicationHealthOptionalParams): Promise<RestResponse>

Параметры

nodeName

string

Имя узла.

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

healthInformation
HealthInformation

Описывает сведения о работоспособности отчета о работоспособности. Эта информация должна присутствовать во всех отчетах о работоспособности, отправленных руководителю работоспособности.

options
ServiceFabricClientReportDeployedApplicationHealthOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

reportDeployedApplicationHealth(string, string, HealthInformation, ServiceFabricClientReportDeployedApplicationHealthOptionalParams, ServiceCallback<void>)

function reportDeployedApplicationHealth(nodeName: string, applicationId: string, healthInformation: HealthInformation, options: ServiceFabricClientReportDeployedApplicationHealthOptionalParams, callback: ServiceCallback<void>)

Параметры

nodeName

string

Имя узла.

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

healthInformation
HealthInformation

Описывает сведения о работоспособности отчета о работоспособности. Эта информация должна присутствовать во всех отчетах о работоспособности, отправленных руководителю работоспособности.

options
ServiceFabricClientReportDeployedApplicationHealthOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

reportDeployedServicePackageHealth(string, string, string, HealthInformation, ServiceCallback<void>)

function reportDeployedServicePackageHealth(nodeName: string, applicationId: string, servicePackageName: string, healthInformation: HealthInformation, callback: ServiceCallback<void>)

Параметры

nodeName

string

Имя узла.

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

servicePackageName

string

Имя пакета службы.

healthInformation
HealthInformation

Описывает сведения о работоспособности отчета о работоспособности. Эта информация должна присутствовать во всех отчетах о работоспособности, отправленных руководителю работоспособности.

callback

ServiceCallback<void>

Обратный вызов

reportDeployedServicePackageHealth(string, string, string, HealthInformation, ServiceFabricClientReportDeployedServicePackageHealthOptionalParams)

Сообщает о состоянии работоспособности пакета службы приложения, развернутого на узле Service Fabric. Отчет должен содержать сведения о источнике отчета о работоспособности и свойстве, на котором он сообщается. Отчет отправляется в службу шлюза Service Fabric, которая пересылается в хранилище работоспособности. Отчет может быть принят шлюзом, но отклонен хранилищем работоспособности после дополнительной проверки. Например, хранилище работоспособности может отклонить отчет из-за недопустимого параметра, например устаревший порядковый номер. Чтобы узнать, был ли отчет применен в хранилище работоспособности, получите развернутый пакет службы работоспособности и проверьте, отображается ли отчет в разделе HealthEvents.

function reportDeployedServicePackageHealth(nodeName: string, applicationId: string, servicePackageName: string, healthInformation: HealthInformation, options?: ServiceFabricClientReportDeployedServicePackageHealthOptionalParams): Promise<RestResponse>

Параметры

nodeName

string

Имя узла.

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

servicePackageName

string

Имя пакета службы.

healthInformation
HealthInformation

Описывает сведения о работоспособности отчета о работоспособности. Эта информация должна присутствовать во всех отчетах о работоспособности, отправленных руководителю работоспособности.

options
ServiceFabricClientReportDeployedServicePackageHealthOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

reportDeployedServicePackageHealth(string, string, string, HealthInformation, ServiceFabricClientReportDeployedServicePackageHealthOptionalParams, ServiceCallback<void>)

function reportDeployedServicePackageHealth(nodeName: string, applicationId: string, servicePackageName: string, healthInformation: HealthInformation, options: ServiceFabricClientReportDeployedServicePackageHealthOptionalParams, callback: ServiceCallback<void>)

Параметры

nodeName

string

Имя узла.

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

servicePackageName

string

Имя пакета службы.

healthInformation
HealthInformation

Описывает сведения о работоспособности отчета о работоспособности. Эта информация должна присутствовать во всех отчетах о работоспособности, отправленных руководителю работоспособности.

options
ServiceFabricClientReportDeployedServicePackageHealthOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

reportNodeHealth(string, HealthInformation, ServiceCallback<void>)

function reportNodeHealth(nodeName: string, healthInformation: HealthInformation, callback: ServiceCallback<void>)

Параметры

nodeName

string

Имя узла.

healthInformation
HealthInformation

Описывает сведения о работоспособности отчета о работоспособности. Эта информация должна присутствовать во всех отчетах о работоспособности, отправленных руководителю работоспособности.

callback

ServiceCallback<void>

Обратный вызов

reportNodeHealth(string, HealthInformation, ServiceFabricClientReportNodeHealthOptionalParams)

Сообщает о состоянии работоспособности указанного узла Service Fabric. Отчет должен содержать сведения о источнике отчета о работоспособности и свойстве, на котором он сообщается. Отчет отправляется на узел шлюза Service Fabric, который пересылается в хранилище работоспособности. Отчет может быть принят шлюзом, но отклонен хранилищем работоспособности после дополнительной проверки. Например, хранилище работоспособности может отклонить отчет из-за недопустимого параметра, например устаревший порядковый номер. Чтобы узнать, был ли отчет применен в хранилище работоспособности, запустите GetNodeHealth и убедитесь, что отчет отображается в разделе HealthEvents.

function reportNodeHealth(nodeName: string, healthInformation: HealthInformation, options?: ServiceFabricClientReportNodeHealthOptionalParams): Promise<RestResponse>

Параметры

nodeName

string

Имя узла.

healthInformation
HealthInformation

Описывает сведения о работоспособности отчета о работоспособности. Эта информация должна присутствовать во всех отчетах о работоспособности, отправленных руководителю работоспособности.

options
ServiceFabricClientReportNodeHealthOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

reportNodeHealth(string, HealthInformation, ServiceFabricClientReportNodeHealthOptionalParams, ServiceCallback<void>)

function reportNodeHealth(nodeName: string, healthInformation: HealthInformation, options: ServiceFabricClientReportNodeHealthOptionalParams, callback: ServiceCallback<void>)

Параметры

nodeName

string

Имя узла.

healthInformation
HealthInformation

Описывает сведения о работоспособности отчета о работоспособности. Эта информация должна присутствовать во всех отчетах о работоспособности, отправленных руководителю работоспособности.

options
ServiceFabricClientReportNodeHealthOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

reportPartitionHealth(string, HealthInformation, ServiceCallback<void>)

function reportPartitionHealth(partitionId: string, healthInformation: HealthInformation, callback: ServiceCallback<void>)

Параметры

partitionId

string

Удостоверение секции.

healthInformation
HealthInformation

Описывает сведения о работоспособности отчета о работоспособности. Эта информация должна присутствовать во всех отчетах о работоспособности, отправленных руководителю работоспособности.

callback

ServiceCallback<void>

Обратный вызов

reportPartitionHealth(string, HealthInformation, ServiceFabricClientReportPartitionHealthOptionalParams)

Сообщает о состоянии работоспособности указанной секции Service Fabric. Отчет должен содержать сведения о источнике отчета о работоспособности и свойстве, на котором он сообщается. Отчет отправляется в раздел шлюза Service Fabric, который пересылается в хранилище работоспособности. Отчет может быть принят шлюзом, но отклонен хранилищем работоспособности после дополнительной проверки. Например, хранилище работоспособности может отклонить отчет из-за недопустимого параметра, например устаревший порядковый номер. Чтобы узнать, был ли отчет применен в хранилище работоспособности, запустите GetPartitionHealth и убедитесь, что отчет отображается в разделе HealthEvents.

function reportPartitionHealth(partitionId: string, healthInformation: HealthInformation, options?: ServiceFabricClientReportPartitionHealthOptionalParams): Promise<RestResponse>

Параметры

partitionId

string

Удостоверение секции.

healthInformation
HealthInformation

Описывает сведения о работоспособности отчета о работоспособности. Эта информация должна присутствовать во всех отчетах о работоспособности, отправленных руководителю работоспособности.

options
ServiceFabricClientReportPartitionHealthOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

reportPartitionHealth(string, HealthInformation, ServiceFabricClientReportPartitionHealthOptionalParams, ServiceCallback<void>)

function reportPartitionHealth(partitionId: string, healthInformation: HealthInformation, options: ServiceFabricClientReportPartitionHealthOptionalParams, callback: ServiceCallback<void>)

Параметры

partitionId

string

Удостоверение секции.

healthInformation
HealthInformation

Описывает сведения о работоспособности отчета о работоспособности. Эта информация должна присутствовать во всех отчетах о работоспособности, отправленных руководителю работоспособности.

options
ServiceFabricClientReportPartitionHealthOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

reportReplicaHealth(string, string, ReplicaHealthReportServiceKind, HealthInformation, ServiceCallback<void>)

function reportReplicaHealth(partitionId: string, replicaId: string, serviceKind: ReplicaHealthReportServiceKind, healthInformation: HealthInformation, callback: ServiceCallback<void>)

Параметры

partitionId

string

Удостоверение секции.

replicaId

string

Идентификатор реплики.

serviceKind
ReplicaHealthReportServiceKind

Тип реплики службы (без отслеживания состояния или состояния), для которой сообщается о работоспособности. Ниже приведены возможные значения. Возможные значения: Stateless, Stateful

healthInformation
HealthInformation

Описывает сведения о работоспособности отчета о работоспособности. Эта информация должна присутствовать во всех отчетах о работоспособности, отправленных руководителю работоспособности.

callback

ServiceCallback<void>

Обратный вызов

reportReplicaHealth(string, string, ReplicaHealthReportServiceKind, HealthInformation, ServiceFabricClientReportReplicaHealthOptionalParams)

Сообщает о состоянии работоспособности указанной реплики Service Fabric. Отчет должен содержать сведения о источнике отчета о работоспособности и свойстве, на котором он сообщается. Отчет отправляется в реплику шлюза Service Fabric, которая пересылается в хранилище работоспособности. Отчет может быть принят шлюзом, но отклонен хранилищем работоспособности после дополнительной проверки. Например, хранилище работоспособности может отклонить отчет из-за недопустимого параметра, например устаревший порядковый номер. Чтобы узнать, был ли отчет применен в хранилище работоспособности, запустите GetReplicaHealth и убедитесь, что отчет отображается в разделе HealthEvents.

function reportReplicaHealth(partitionId: string, replicaId: string, serviceKind: ReplicaHealthReportServiceKind, healthInformation: HealthInformation, options?: ServiceFabricClientReportReplicaHealthOptionalParams): Promise<RestResponse>

Параметры

partitionId

string

Удостоверение секции.

replicaId

string

Идентификатор реплики.

serviceKind
ReplicaHealthReportServiceKind

Тип реплики службы (без отслеживания состояния или состояния), для которой сообщается о работоспособности. Ниже приведены возможные значения. Возможные значения: Stateless, Stateful

healthInformation
HealthInformation

Описывает сведения о работоспособности отчета о работоспособности. Эта информация должна присутствовать во всех отчетах о работоспособности, отправленных руководителю работоспособности.

options
ServiceFabricClientReportReplicaHealthOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

reportReplicaHealth(string, string, ReplicaHealthReportServiceKind, HealthInformation, ServiceFabricClientReportReplicaHealthOptionalParams, ServiceCallback<void>)

function reportReplicaHealth(partitionId: string, replicaId: string, serviceKind: ReplicaHealthReportServiceKind, healthInformation: HealthInformation, options: ServiceFabricClientReportReplicaHealthOptionalParams, callback: ServiceCallback<void>)

Параметры

partitionId

string

Удостоверение секции.

replicaId

string

Идентификатор реплики.

serviceKind
ReplicaHealthReportServiceKind

Тип реплики службы (без отслеживания состояния или состояния), для которой сообщается о работоспособности. Ниже приведены возможные значения. Возможные значения: Stateless, Stateful

healthInformation
HealthInformation

Описывает сведения о работоспособности отчета о работоспособности. Эта информация должна присутствовать во всех отчетах о работоспособности, отправленных руководителю работоспособности.

options
ServiceFabricClientReportReplicaHealthOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

reportServiceHealth(string, HealthInformation, ServiceCallback<void>)

function reportServiceHealth(serviceId: string, healthInformation: HealthInformation, callback: ServiceCallback<void>)

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

healthInformation
HealthInformation

Описывает сведения о работоспособности отчета о работоспособности. Эта информация должна присутствовать во всех отчетах о работоспособности, отправленных руководителю работоспособности.

callback

ServiceCallback<void>

Обратный вызов

reportServiceHealth(string, HealthInformation, ServiceFabricClientReportServiceHealthOptionalParams)

Сообщает о состоянии работоспособности указанной службы Service Fabric. Отчет должен содержать сведения о источнике отчета о работоспособности и свойстве, на котором он сообщается. Отчет отправляется в службу шлюза Service Fabric, которая пересылается в хранилище работоспособности. Отчет может быть принят шлюзом, но отклонен хранилищем работоспособности после дополнительной проверки. Например, хранилище работоспособности может отклонить отчет из-за недопустимого параметра, например устаревший порядковый номер. Чтобы узнать, был ли отчет применен в хранилище работоспособности, запустите GetServiceHealth и убедитесь, что отчет отображается в разделе HealthEvents.

function reportServiceHealth(serviceId: string, healthInformation: HealthInformation, options?: ServiceFabricClientReportServiceHealthOptionalParams): Promise<RestResponse>

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

healthInformation
HealthInformation

Описывает сведения о работоспособности отчета о работоспособности. Эта информация должна присутствовать во всех отчетах о работоспособности, отправленных руководителю работоспособности.

options
ServiceFabricClientReportServiceHealthOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

reportServiceHealth(string, HealthInformation, ServiceFabricClientReportServiceHealthOptionalParams, ServiceCallback<void>)

function reportServiceHealth(serviceId: string, healthInformation: HealthInformation, options: ServiceFabricClientReportServiceHealthOptionalParams, callback: ServiceCallback<void>)

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

healthInformation
HealthInformation

Описывает сведения о работоспособности отчета о работоспособности. Эта информация должна присутствовать во всех отчетах о работоспособности, отправленных руководителю работоспособности.

options
ServiceFabricClientReportServiceHealthOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

resetPartitionLoad(string, ServiceCallback<void>)

function resetPartitionLoad(partitionId: string, callback: ServiceCallback<void>)

Параметры

partitionId

string

Удостоверение секции.

callback

ServiceCallback<void>

Обратный вызов

resetPartitionLoad(string, ServiceFabricClientResetPartitionLoadOptionalParams)

Сбрасывает текущую нагрузку секции Service Fabric на загрузку по умолчанию для службы.

function resetPartitionLoad(partitionId: string, options?: ServiceFabricClientResetPartitionLoadOptionalParams): Promise<RestResponse>

Параметры

partitionId

string

Удостоверение секции.

options
ServiceFabricClientResetPartitionLoadOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

resetPartitionLoad(string, ServiceFabricClientResetPartitionLoadOptionalParams, ServiceCallback<void>)

function resetPartitionLoad(partitionId: string, options: ServiceFabricClientResetPartitionLoadOptionalParams, callback: ServiceCallback<void>)

Параметры

partitionId

string

Удостоверение секции.

options
ServiceFabricClientResetPartitionLoadOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

resolveService(string, ServiceCallback<ResolvedServicePartition>)

function resolveService(serviceId: string, callback: ServiceCallback<ResolvedServicePartition>)

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

callback

ServiceCallback<ResolvedServicePartition>

Обратный вызов

resolveService(string, ServiceFabricClientResolveServiceOptionalParams)

Разрешите раздел службы Service Fabric, чтобы получить конечные точки реплик службы.

function resolveService(serviceId: string, options?: ServiceFabricClientResolveServiceOptionalParams): Promise<ResolveServiceResponse>

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

options
ServiceFabricClientResolveServiceOptionalParams

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

Возвращаемое значение

Обещание<Models.ResolveServiceResponse>

resolveService(string, ServiceFabricClientResolveServiceOptionalParams, ServiceCallback<ResolvedServicePartition>)

function resolveService(serviceId: string, options: ServiceFabricClientResolveServiceOptionalParams, callback: ServiceCallback<ResolvedServicePartition>)

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

options
ServiceFabricClientResolveServiceOptionalParams

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

callback

ServiceCallback<ResolvedServicePartition>

Обратный вызов

restartDeployedCodePackage(string, string, RestartDeployedCodePackageDescription, ServiceCallback<void>)

function restartDeployedCodePackage(nodeName: string, applicationId: string, restartDeployedCodePackageDescription: RestartDeployedCodePackageDescription, callback: ServiceCallback<void>)

Параметры

nodeName

string

Имя узла.

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

restartDeployedCodePackageDescription
RestartDeployedCodePackageDescription

Описывает развернутый пакет кода на узле Service Fabric для перезапуска.

callback

ServiceCallback<void>

Обратный вызов

restartDeployedCodePackage(string, string, RestartDeployedCodePackageDescription, ServiceFabricClientRestartDeployedCodePackageOptionalParams)

Перезапуск пакета кода, развернутого на узле Service Fabric в кластере. Этот процесс прерывает процесс пакета кода, который перезагрузит все реплики службы пользователей, размещенные в этом процессе.

function restartDeployedCodePackage(nodeName: string, applicationId: string, restartDeployedCodePackageDescription: RestartDeployedCodePackageDescription, options?: ServiceFabricClientRestartDeployedCodePackageOptionalParams): Promise<RestResponse>

Параметры

nodeName

string

Имя узла.

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

restartDeployedCodePackageDescription
RestartDeployedCodePackageDescription

Описывает развернутый пакет кода на узле Service Fabric для перезапуска.

options
ServiceFabricClientRestartDeployedCodePackageOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

restartDeployedCodePackage(string, string, RestartDeployedCodePackageDescription, ServiceFabricClientRestartDeployedCodePackageOptionalParams, ServiceCallback<void>)

function restartDeployedCodePackage(nodeName: string, applicationId: string, restartDeployedCodePackageDescription: RestartDeployedCodePackageDescription, options: ServiceFabricClientRestartDeployedCodePackageOptionalParams, callback: ServiceCallback<void>)

Параметры

nodeName

string

Имя узла.

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

restartDeployedCodePackageDescription
RestartDeployedCodePackageDescription

Описывает развернутый пакет кода на узле Service Fabric для перезапуска.

options
ServiceFabricClientRestartDeployedCodePackageOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

restartNode(string, RestartNodeDescription, ServiceCallback<void>)

function restartNode(nodeName: string, restartNodeDescription: RestartNodeDescription, callback: ServiceCallback<void>)

Параметры

nodeName

string

Имя узла.

restartNodeDescription
RestartNodeDescription

Экземпляр узла, который необходимо перезапустить, и флаг, указывающий на необходимость создания дампа процесса структуры.

callback

ServiceCallback<void>

Обратный вызов

restartNode(string, RestartNodeDescription, ServiceFabricClientRestartNodeOptionalParams)

Перезапускает узел кластера Service Fabric, который уже запущен.

function restartNode(nodeName: string, restartNodeDescription: RestartNodeDescription, options?: ServiceFabricClientRestartNodeOptionalParams): Promise<RestResponse>

Параметры

nodeName

string

Имя узла.

restartNodeDescription
RestartNodeDescription

Экземпляр узла, который необходимо перезапустить, и флаг, указывающий на необходимость создания дампа процесса структуры.

options
ServiceFabricClientRestartNodeOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

restartNode(string, RestartNodeDescription, ServiceFabricClientRestartNodeOptionalParams, ServiceCallback<void>)

function restartNode(nodeName: string, restartNodeDescription: RestartNodeDescription, options: ServiceFabricClientRestartNodeOptionalParams, callback: ServiceCallback<void>)

Параметры

nodeName

string

Имя узла.

restartNodeDescription
RestartNodeDescription

Экземпляр узла, который необходимо перезапустить, и флаг, указывающий на необходимость создания дампа процесса структуры.

options
ServiceFabricClientRestartNodeOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

restartReplica(string, string, string, ServiceCallback<void>)

function restartReplica(nodeName: string, partitionId: string, replicaId: string, callback: ServiceCallback<void>)

Параметры

nodeName

string

Имя узла.

partitionId

string

Удостоверение секции.

replicaId

string

Идентификатор реплики.

callback

ServiceCallback<void>

Обратный вызов

restartReplica(string, string, string, ServiceFabricClientRestartReplicaOptionalParams)

Перезапускает реплику службы сохраняемой службы, работающей на узле. Предупреждение. При использовании этого API не выполняются проверки безопасности. Неправильное использование этого API может привести к потере доступности для служб с отслеживанием состояния.

function restartReplica(nodeName: string, partitionId: string, replicaId: string, options?: ServiceFabricClientRestartReplicaOptionalParams): Promise<RestResponse>

Параметры

nodeName

string

Имя узла.

partitionId

string

Удостоверение секции.

replicaId

string

Идентификатор реплики.

options
ServiceFabricClientRestartReplicaOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

restartReplica(string, string, string, ServiceFabricClientRestartReplicaOptionalParams, ServiceCallback<void>)

function restartReplica(nodeName: string, partitionId: string, replicaId: string, options: ServiceFabricClientRestartReplicaOptionalParams, callback: ServiceCallback<void>)

Параметры

nodeName

string

Имя узла.

partitionId

string

Удостоверение секции.

replicaId

string

Идентификатор реплики.

options
ServiceFabricClientRestartReplicaOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

restorePartition(string, RestorePartitionDescription, ServiceCallback<void>)

function restorePartition(partitionId: string, restorePartitionDescription: RestorePartitionDescription, callback: ServiceCallback<void>)

Параметры

partitionId

string

Удостоверение секции.

restorePartitionDescription
RestorePartitionDescription

Описывает параметры для восстановления секции.

callback

ServiceCallback<void>

Обратный вызов

restorePartition(string, RestorePartitionDescription, ServiceFabricClientRestorePartitionOptionalParams)

Восстанавливает состояние сохраняемой секции с отслеживанием состояния с помощью указанной точки резервного копирования. Если секция уже периодически выполняется резервное копирование, то по умолчанию точка резервного копирования ищется в хранилище, указанном в политике резервного копирования. Можно также переопределить то же самое, указав сведения о хранилище резервных копий в рамках описания раздела восстановления в тексте. После запуска восстановления его ход выполнения можно отслеживать с помощью операции GetRestoreProgress. В случае ожидания операции укажите большее значение времени ожидания восстановления в параметре запроса.

function restorePartition(partitionId: string, restorePartitionDescription: RestorePartitionDescription, options?: ServiceFabricClientRestorePartitionOptionalParams): Promise<RestResponse>

Параметры

partitionId

string

Удостоверение секции.

restorePartitionDescription
RestorePartitionDescription

Описывает параметры для восстановления секции.

options
ServiceFabricClientRestorePartitionOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

restorePartition(string, RestorePartitionDescription, ServiceFabricClientRestorePartitionOptionalParams, ServiceCallback<void>)

function restorePartition(partitionId: string, restorePartitionDescription: RestorePartitionDescription, options: ServiceFabricClientRestorePartitionOptionalParams, callback: ServiceCallback<void>)

Параметры

partitionId

string

Удостоверение секции.

restorePartitionDescription
RestorePartitionDescription

Описывает параметры для восстановления секции.

options
ServiceFabricClientRestorePartitionOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

resumeApplicationBackup(string, ServiceCallback<void>)

function resumeApplicationBackup(applicationId: string, callback: ServiceCallback<void>)

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

callback

ServiceCallback<void>

Обратный вызов

resumeApplicationBackup(string, ServiceFabricClientResumeApplicationBackupOptionalParams)

Ранее приостановленное приложение Service Fabric возобновляет периодическое резервное копирование в соответствии с политикой резервного копирования, настроенной в настоящее время для той же.

function resumeApplicationBackup(applicationId: string, options?: ServiceFabricClientResumeApplicationBackupOptionalParams): Promise<RestResponse>

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

options
ServiceFabricClientResumeApplicationBackupOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

resumeApplicationBackup(string, ServiceFabricClientResumeApplicationBackupOptionalParams, ServiceCallback<void>)

function resumeApplicationBackup(applicationId: string, options: ServiceFabricClientResumeApplicationBackupOptionalParams, callback: ServiceCallback<void>)

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

options
ServiceFabricClientResumeApplicationBackupOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

resumeApplicationUpgrade(string, ResumeApplicationUpgradeDescription, ServiceCallback<void>)

function resumeApplicationUpgrade(applicationId: string, resumeApplicationUpgradeDescription: ResumeApplicationUpgradeDescription, callback: ServiceCallback<void>)

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

resumeApplicationUpgradeDescription
ResumeApplicationUpgradeDescription

Описывает параметры для возобновления обновления приложения.

callback

ServiceCallback<void>

Обратный вызов

resumeApplicationUpgrade(string, ResumeApplicationUpgradeDescription, ServiceFabricClientResumeApplicationUpgradeOptionalParams)

Возобновляет обновление приложения Service Fabric без мониторинга вручную. Service Fabric обновляет один домен обновления за раз. При немониторедных обновлениях вручную после завершения обновления Service Fabric ожидает вызова этого API, прежде чем переходить к следующему домену обновления.

function resumeApplicationUpgrade(applicationId: string, resumeApplicationUpgradeDescription: ResumeApplicationUpgradeDescription, options?: ServiceFabricClientResumeApplicationUpgradeOptionalParams): Promise<RestResponse>

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

resumeApplicationUpgradeDescription
ResumeApplicationUpgradeDescription

Описывает параметры для возобновления обновления приложения.

options
ServiceFabricClientResumeApplicationUpgradeOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

resumeApplicationUpgrade(string, ResumeApplicationUpgradeDescription, ServiceFabricClientResumeApplicationUpgradeOptionalParams, ServiceCallback<void>)

function resumeApplicationUpgrade(applicationId: string, resumeApplicationUpgradeDescription: ResumeApplicationUpgradeDescription, options: ServiceFabricClientResumeApplicationUpgradeOptionalParams, callback: ServiceCallback<void>)

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

resumeApplicationUpgradeDescription
ResumeApplicationUpgradeDescription

Описывает параметры для возобновления обновления приложения.

options
ServiceFabricClientResumeApplicationUpgradeOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

resumeClusterUpgrade(ResumeClusterUpgradeDescription, ServiceCallback<void>)

function resumeClusterUpgrade(resumeClusterUpgradeDescription: ResumeClusterUpgradeDescription, callback: ServiceCallback<void>)

Параметры

resumeClusterUpgradeDescription
ResumeClusterUpgradeDescription

Описывает параметры для возобновления обновления кластера.

callback

ServiceCallback<void>

Обратный вызов

resumeClusterUpgrade(ResumeClusterUpgradeDescription, ServiceFabricClientResumeClusterUpgradeOptionalParams)

При необходимости перейдите к следующему домену обновления кластера или конфигурации.

function resumeClusterUpgrade(resumeClusterUpgradeDescription: ResumeClusterUpgradeDescription, options?: ServiceFabricClientResumeClusterUpgradeOptionalParams): Promise<RestResponse>

Параметры

resumeClusterUpgradeDescription
ResumeClusterUpgradeDescription

Описывает параметры для возобновления обновления кластера.

options
ServiceFabricClientResumeClusterUpgradeOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

resumeClusterUpgrade(ResumeClusterUpgradeDescription, ServiceFabricClientResumeClusterUpgradeOptionalParams, ServiceCallback<void>)

function resumeClusterUpgrade(resumeClusterUpgradeDescription: ResumeClusterUpgradeDescription, options: ServiceFabricClientResumeClusterUpgradeOptionalParams, callback: ServiceCallback<void>)

Параметры

resumeClusterUpgradeDescription
ResumeClusterUpgradeDescription

Описывает параметры для возобновления обновления кластера.

options
ServiceFabricClientResumeClusterUpgradeOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

resumePartitionBackup(string, ServiceCallback<void>)

function resumePartitionBackup(partitionId: string, callback: ServiceCallback<void>)

Параметры

partitionId

string

Удостоверение секции.

callback

ServiceCallback<void>

Обратный вызов

resumePartitionBackup(string, ServiceFabricClientResumePartitionBackupOptionalParams)

Ранее приостановленная секция возобновляет периодическое резервное копирование в соответствии с политикой резервного копирования, настроенной в настоящее время для той же.

function resumePartitionBackup(partitionId: string, options?: ServiceFabricClientResumePartitionBackupOptionalParams): Promise<RestResponse>

Параметры

partitionId

string

Удостоверение секции.

options
ServiceFabricClientResumePartitionBackupOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

resumePartitionBackup(string, ServiceFabricClientResumePartitionBackupOptionalParams, ServiceCallback<void>)

function resumePartitionBackup(partitionId: string, options: ServiceFabricClientResumePartitionBackupOptionalParams, callback: ServiceCallback<void>)

Параметры

partitionId

string

Удостоверение секции.

options
ServiceFabricClientResumePartitionBackupOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

resumeServiceBackup(string, ServiceCallback<void>)

function resumeServiceBackup(serviceId: string, callback: ServiceCallback<void>)

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

callback

ServiceCallback<void>

Обратный вызов

resumeServiceBackup(string, ServiceFabricClientResumeServiceBackupOptionalParams)

Ранее приостановленная служба Service Fabric возобновляет периодическое резервное копирование в соответствии с политикой резервного копирования, настроенной в настоящее время для той же.

function resumeServiceBackup(serviceId: string, options?: ServiceFabricClientResumeServiceBackupOptionalParams): Promise<RestResponse>

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

options
ServiceFabricClientResumeServiceBackupOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

resumeServiceBackup(string, ServiceFabricClientResumeServiceBackupOptionalParams, ServiceCallback<void>)

function resumeServiceBackup(serviceId: string, options: ServiceFabricClientResumeServiceBackupOptionalParams, callback: ServiceCallback<void>)

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

options
ServiceFabricClientResumeServiceBackupOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

rollbackApplicationUpgrade(string, ServiceCallback<void>)

function rollbackApplicationUpgrade(applicationId: string, callback: ServiceCallback<void>)

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

callback

ServiceCallback<void>

Обратный вызов

rollbackApplicationUpgrade(string, ServiceFabricClientRollbackApplicationUpgradeOptionalParams)

Начинает откат текущего обновления приложения до предыдущей версии. Этот API можно использовать только для отката текущего обновления во время выполнения, который выполняется переход к новой версии. Если приложение в настоящее время не обновляется, используйте API StartApplicationUpgrade для обновления до требуемой версии, включая откат до предыдущей версии.

function rollbackApplicationUpgrade(applicationId: string, options?: ServiceFabricClientRollbackApplicationUpgradeOptionalParams): Promise<RestResponse>

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

options
ServiceFabricClientRollbackApplicationUpgradeOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

rollbackApplicationUpgrade(string, ServiceFabricClientRollbackApplicationUpgradeOptionalParams, ServiceCallback<void>)

function rollbackApplicationUpgrade(applicationId: string, options: ServiceFabricClientRollbackApplicationUpgradeOptionalParams, callback: ServiceCallback<void>)

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

options
ServiceFabricClientRollbackApplicationUpgradeOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

rollbackClusterUpgrade(ServiceCallback<void>)

function rollbackClusterUpgrade(callback: ServiceCallback<void>)

Параметры

callback

ServiceCallback<void>

Обратный вызов

rollbackClusterUpgrade(ServiceFabricClientRollbackClusterUpgradeOptionalParams)

Откат кода или обновления конфигурации кластера Service Fabric.

function rollbackClusterUpgrade(options?: ServiceFabricClientRollbackClusterUpgradeOptionalParams): Promise<RestResponse>

Параметры

options
ServiceFabricClientRollbackClusterUpgradeOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

rollbackClusterUpgrade(ServiceFabricClientRollbackClusterUpgradeOptionalParams, ServiceCallback<void>)

function rollbackClusterUpgrade(options: ServiceFabricClientRollbackClusterUpgradeOptionalParams, callback: ServiceCallback<void>)

Параметры

options
ServiceFabricClientRollbackClusterUpgradeOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

setUpgradeOrchestrationServiceState(UpgradeOrchestrationServiceState, ServiceCallback<UpgradeOrchestrationServiceStateSummary>)

function setUpgradeOrchestrationServiceState(upgradeOrchestrationServiceState: UpgradeOrchestrationServiceState, callback: ServiceCallback<UpgradeOrchestrationServiceStateSummary>)

Параметры

upgradeOrchestrationServiceState
UpgradeOrchestrationServiceState

Состояние службы service Fabric Upgrade Orchestration Service.

callback

ServiceCallback<UpgradeOrchestrationServiceStateSummary>

Обратный вызов

setUpgradeOrchestrationServiceState(UpgradeOrchestrationServiceState, ServiceFabricClientSetUpgradeOrchestrationServiceStateOptionalParams)

Обновите состояние службы service Fabric Upgrade Orchestration Service. Этот API используется во внутренней среде для поддержки.

function setUpgradeOrchestrationServiceState(upgradeOrchestrationServiceState: UpgradeOrchestrationServiceState, options?: ServiceFabricClientSetUpgradeOrchestrationServiceStateOptionalParams): Promise<SetUpgradeOrchestrationServiceStateResponse>

Параметры

upgradeOrchestrationServiceState
UpgradeOrchestrationServiceState

Состояние службы service Fabric Upgrade Orchestration Service.

options
ServiceFabricClientSetUpgradeOrchestrationServiceStateOptionalParams

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

Возвращаемое значение

Обещание<Models.SetUpgradeOrchestrationServiceStateResponse>

setUpgradeOrchestrationServiceState(UpgradeOrchestrationServiceState, ServiceFabricClientSetUpgradeOrchestrationServiceStateOptionalParams, ServiceCallback<UpgradeOrchestrationServiceStateSummary>)

function setUpgradeOrchestrationServiceState(upgradeOrchestrationServiceState: UpgradeOrchestrationServiceState, options: ServiceFabricClientSetUpgradeOrchestrationServiceStateOptionalParams, callback: ServiceCallback<UpgradeOrchestrationServiceStateSummary>)

Параметры

upgradeOrchestrationServiceState
UpgradeOrchestrationServiceState

Состояние службы service Fabric Upgrade Orchestration Service.

options
ServiceFabricClientSetUpgradeOrchestrationServiceStateOptionalParams

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

callback

ServiceCallback<UpgradeOrchestrationServiceStateSummary>

Обратный вызов

startApplicationUpgrade(string, ApplicationUpgradeDescription, ServiceCallback<void>)

function startApplicationUpgrade(applicationId: string, applicationUpgradeDescription: ApplicationUpgradeDescription, callback: ServiceCallback<void>)

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

applicationUpgradeDescription
ApplicationUpgradeDescription

Параметры обновления приложения.

callback

ServiceCallback<void>

Обратный вызов

startApplicationUpgrade(string, ApplicationUpgradeDescription, ServiceFabricClientStartApplicationUpgradeOptionalParams)

Проверяет указанные параметры обновления приложения и начинает обновление приложения, если параметры допустимы.

function startApplicationUpgrade(applicationId: string, applicationUpgradeDescription: ApplicationUpgradeDescription, options?: ServiceFabricClientStartApplicationUpgradeOptionalParams): Promise<RestResponse>

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

applicationUpgradeDescription
ApplicationUpgradeDescription

Параметры обновления приложения.

options
ServiceFabricClientStartApplicationUpgradeOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

startApplicationUpgrade(string, ApplicationUpgradeDescription, ServiceFabricClientStartApplicationUpgradeOptionalParams, ServiceCallback<void>)

function startApplicationUpgrade(applicationId: string, applicationUpgradeDescription: ApplicationUpgradeDescription, options: ServiceFabricClientStartApplicationUpgradeOptionalParams, callback: ServiceCallback<void>)

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

applicationUpgradeDescription
ApplicationUpgradeDescription

Параметры обновления приложения.

options
ServiceFabricClientStartApplicationUpgradeOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

startChaos(ChaosParameters, ServiceCallback<void>)

function startChaos(chaosParameters: ChaosParameters, callback: ServiceCallback<void>)

Параметры

chaosParameters
ChaosParameters

Описывает все параметры для настройки запуска Chaos.

callback

ServiceCallback<void>

Обратный вызов

startChaos(ChaosParameters, ServiceFabricClientStartChaosOptionalParams)

Если хаос еще не запущен в кластере, он запускает Chaos с переданными параметрами Chaos. Если хаос уже выполняется при выполнении этого вызова, вызов завершается сбоем с кодом ошибки FABRIC_E_CHAOS_ALREADY_RUNNING. Дополнительные сведения см. в статье "Вызвать управляемый хаос" в кластерах Service Fabric.

function startChaos(chaosParameters: ChaosParameters, options?: ServiceFabricClientStartChaosOptionalParams): Promise<RestResponse>

Параметры

chaosParameters
ChaosParameters

Описывает все параметры для настройки запуска Chaos.

options
ServiceFabricClientStartChaosOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

startChaos(ChaosParameters, ServiceFabricClientStartChaosOptionalParams, ServiceCallback<void>)

function startChaos(chaosParameters: ChaosParameters, options: ServiceFabricClientStartChaosOptionalParams, callback: ServiceCallback<void>)

Параметры

chaosParameters
ChaosParameters

Описывает все параметры для настройки запуска Chaos.

options
ServiceFabricClientStartChaosOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

startClusterConfigurationUpgrade(ClusterConfigurationUpgradeDescription, ServiceCallback<void>)

function startClusterConfigurationUpgrade(clusterConfigurationUpgradeDescription: ClusterConfigurationUpgradeDescription, callback: ServiceCallback<void>)

Параметры

clusterConfigurationUpgradeDescription
ClusterConfigurationUpgradeDescription

Параметры для обновления автономной конфигурации кластера.

callback

ServiceCallback<void>

Обратный вызов

startClusterConfigurationUpgrade(ClusterConfigurationUpgradeDescription, ServiceFabricClientStartClusterConfigurationUpgradeOptionalParams)

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

function startClusterConfigurationUpgrade(clusterConfigurationUpgradeDescription: ClusterConfigurationUpgradeDescription, options?: ServiceFabricClientStartClusterConfigurationUpgradeOptionalParams): Promise<RestResponse>

Параметры

clusterConfigurationUpgradeDescription
ClusterConfigurationUpgradeDescription

Параметры для обновления автономной конфигурации кластера.

options
ServiceFabricClientStartClusterConfigurationUpgradeOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

startClusterConfigurationUpgrade(ClusterConfigurationUpgradeDescription, ServiceFabricClientStartClusterConfigurationUpgradeOptionalParams, ServiceCallback<void>)

function startClusterConfigurationUpgrade(clusterConfigurationUpgradeDescription: ClusterConfigurationUpgradeDescription, options: ServiceFabricClientStartClusterConfigurationUpgradeOptionalParams, callback: ServiceCallback<void>)

Параметры

clusterConfigurationUpgradeDescription
ClusterConfigurationUpgradeDescription

Параметры для обновления автономной конфигурации кластера.

options
ServiceFabricClientStartClusterConfigurationUpgradeOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

startClusterUpgrade(StartClusterUpgradeDescription, ServiceCallback<void>)

function startClusterUpgrade(startClusterUpgradeDescription: StartClusterUpgradeDescription, callback: ServiceCallback<void>)

Параметры

startClusterUpgradeDescription
StartClusterUpgradeDescription

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

callback

ServiceCallback<void>

Обратный вызов

startClusterUpgrade(StartClusterUpgradeDescription, ServiceFabricClientStartClusterUpgradeOptionalParams)

Проверьте указанные параметры обновления и запустите обновление кода или версии конфигурации кластера Service Fabric, если параметры допустимы.

function startClusterUpgrade(startClusterUpgradeDescription: StartClusterUpgradeDescription, options?: ServiceFabricClientStartClusterUpgradeOptionalParams): Promise<RestResponse>

Параметры

startClusterUpgradeDescription
StartClusterUpgradeDescription

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

options
ServiceFabricClientStartClusterUpgradeOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

startClusterUpgrade(StartClusterUpgradeDescription, ServiceFabricClientStartClusterUpgradeOptionalParams, ServiceCallback<void>)

function startClusterUpgrade(startClusterUpgradeDescription: StartClusterUpgradeDescription, options: ServiceFabricClientStartClusterUpgradeOptionalParams, callback: ServiceCallback<void>)

Параметры

startClusterUpgradeDescription
StartClusterUpgradeDescription

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

options
ServiceFabricClientStartClusterUpgradeOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

startComposeDeploymentUpgrade(string, ComposeDeploymentUpgradeDescription, ServiceCallback<void>)

function startComposeDeploymentUpgrade(deploymentName: string, composeDeploymentUpgradeDescription: ComposeDeploymentUpgradeDescription, callback: ServiceCallback<void>)

Параметры

deploymentName

string

Удостоверение развертывания.

composeDeploymentUpgradeDescription
ComposeDeploymentUpgradeDescription

Параметры для обновления развертывания создания.

callback

ServiceCallback<void>

Обратный вызов

startComposeDeploymentUpgrade(string, ComposeDeploymentUpgradeDescription, ServiceFabricClientStartComposeDeploymentUpgradeOptionalParams)

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

function startComposeDeploymentUpgrade(deploymentName: string, composeDeploymentUpgradeDescription: ComposeDeploymentUpgradeDescription, options?: ServiceFabricClientStartComposeDeploymentUpgradeOptionalParams): Promise<RestResponse>

Параметры

deploymentName

string

Удостоверение развертывания.

composeDeploymentUpgradeDescription
ComposeDeploymentUpgradeDescription

Параметры для обновления развертывания создания.

options
ServiceFabricClientStartComposeDeploymentUpgradeOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

startComposeDeploymentUpgrade(string, ComposeDeploymentUpgradeDescription, ServiceFabricClientStartComposeDeploymentUpgradeOptionalParams, ServiceCallback<void>)

function startComposeDeploymentUpgrade(deploymentName: string, composeDeploymentUpgradeDescription: ComposeDeploymentUpgradeDescription, options: ServiceFabricClientStartComposeDeploymentUpgradeOptionalParams, callback: ServiceCallback<void>)

Параметры

deploymentName

string

Удостоверение развертывания.

composeDeploymentUpgradeDescription
ComposeDeploymentUpgradeDescription

Параметры для обновления развертывания создания.

options
ServiceFabricClientStartComposeDeploymentUpgradeOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

startDataLoss(string, string, string, DataLossMode, ServiceCallback<void>)

function startDataLoss(serviceId: string, partitionId: string, operationId: string, dataLossMode: DataLossMode, callback: ServiceCallback<void>)

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

partitionId

string

Удостоверение секции.

operationId

string

ИДЕНТИФИКАТОР GUID, определяющий вызов этого API. Это передается в соответствующий API GetProgress

dataLossMode
DataLossMode

Этот перечисление передается в API StartDataLoss, чтобы указать, какой тип потери данных требуется вызвать. Возможные значения: "Invalid", "PartialDataLoss", "FullDataLoss"

callback

ServiceCallback<void>

Обратный вызов

startDataLoss(string, string, string, DataLossMode, ServiceFabricClientStartDataLossOptionalParams)

Этот API вызывает потерю данных для указанной секции. Он активирует вызов API OnDataLoss секции. Фактическая потеря данных зависит от указанного DataLossMode.

  • PartialDataLoss — удаляется только кворум реплик, и для секции активируется OnDataLoss, но фактическая потеря данных зависит от наличия репликации во время выполнения.
  • FullDataLoss — все реплики удаляются, поэтому все данные будут потеряны и активируются OnDataLoss.

Этот API должен вызываться только с помощью службы с отслеживанием состояния в качестве целевого объекта.

Вызов этого API с системной службой в качестве целевого объекта не рекомендуется.

Примечание. После вызова этого API его нельзя отменить. Вызов CancelOperation приведет только к остановке выполнения и очистке внутреннего состояния системы. Он не восстановит данные, если команда выполнена достаточно далеко, чтобы привести к потере данных.

Вызовите API GetDataLossProgress с тем же идентификатором operationId, чтобы вернуть сведения об операции, запущенной с этого API.

function startDataLoss(serviceId: string, partitionId: string, operationId: string, dataLossMode: DataLossMode, options?: ServiceFabricClientStartDataLossOptionalParams): Promise<RestResponse>

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

partitionId

string

Удостоверение секции.

operationId

string

ИДЕНТИФИКАТОР GUID, определяющий вызов этого API. Это передается в соответствующий API GetProgress

dataLossMode
DataLossMode

Этот перечисление передается в API StartDataLoss, чтобы указать, какой тип потери данных требуется вызвать. Возможные значения: "Invalid", "PartialDataLoss", "FullDataLoss"

options
ServiceFabricClientStartDataLossOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

startDataLoss(string, string, string, DataLossMode, ServiceFabricClientStartDataLossOptionalParams, ServiceCallback<void>)

function startDataLoss(serviceId: string, partitionId: string, operationId: string, dataLossMode: DataLossMode, options: ServiceFabricClientStartDataLossOptionalParams, callback: ServiceCallback<void>)

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

partitionId

string

Удостоверение секции.

operationId

string

ИДЕНТИФИКАТОР GUID, определяющий вызов этого API. Это передается в соответствующий API GetProgress

dataLossMode
DataLossMode

Этот перечисление передается в API StartDataLoss, чтобы указать, какой тип потери данных требуется вызвать. Возможные значения: "Invalid", "PartialDataLoss", "FullDataLoss"

options
ServiceFabricClientStartDataLossOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

startNodeTransition(string, string, NodeTransitionType, string, number, ServiceCallback<void>)

function startNodeTransition(nodeName: string, operationId: string, nodeTransitionType: NodeTransitionType, nodeInstanceId: string, stopDurationInSeconds: number, callback: ServiceCallback<void>)

Параметры

nodeName

string

Имя узла.

operationId

string

ИДЕНТИФИКАТОР GUID, определяющий вызов этого API. Это передается в соответствующий API GetProgress

nodeTransitionType
NodeTransitionType

Указывает тип выполняемого перехода. NodeTransitionType.Start запустит остановленный узел. NodeTransitionType.Stop остановит узел, который находится в состоянии. Возможные значения: "Invalid", "Start", "Stop"

nodeInstanceId

string

Идентификатор экземпляра узла целевого узла. Это можно определить с помощью API GetNodeInfo.

stopDurationInSeconds

number

Длительность( в секундах) для остановки узла. Минимальное значение равно 600, максимальное — 14400. После истечения этого срока действия узел автоматически будет выполнять резервное копирование.

callback

ServiceCallback<void>

Обратный вызов

startNodeTransition(string, string, NodeTransitionType, string, number, ServiceFabricClientStartNodeTransitionOptionalParams)

Запускает или останавливает узел кластера. Узел кластера — это процесс, а не сам экземпляр ОС. Чтобы запустить узел, передайте "Пуск" для параметра NodeTransitionType. Чтобы остановить узел, передайте значение Stop для параметра NodeTransitionType. Этот API запускает операцию— когда API возвращает узел, возможно, еще не завершил переход. Вызовите GetNodeTransitionProgress с тем же идентификатором operationId, чтобы получить ход выполнения операции.

function startNodeTransition(nodeName: string, operationId: string, nodeTransitionType: NodeTransitionType, nodeInstanceId: string, stopDurationInSeconds: number, options?: ServiceFabricClientStartNodeTransitionOptionalParams): Promise<RestResponse>

Параметры

nodeName

string

Имя узла.

operationId

string

ИДЕНТИФИКАТОР GUID, определяющий вызов этого API. Это передается в соответствующий API GetProgress

nodeTransitionType
NodeTransitionType

Указывает тип выполняемого перехода. NodeTransitionType.Start запустит остановленный узел. NodeTransitionType.Stop остановит узел, который находится в состоянии. Возможные значения: "Invalid", "Start", "Stop"

nodeInstanceId

string

Идентификатор экземпляра узла целевого узла. Это можно определить с помощью API GetNodeInfo.

stopDurationInSeconds

number

Длительность( в секундах) для остановки узла. Минимальное значение равно 600, максимальное — 14400. После истечения этого срока действия узел автоматически будет выполнять резервное копирование.

options
ServiceFabricClientStartNodeTransitionOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

startNodeTransition(string, string, NodeTransitionType, string, number, ServiceFabricClientStartNodeTransitionOptionalParams, ServiceCallback<void>)

function startNodeTransition(nodeName: string, operationId: string, nodeTransitionType: NodeTransitionType, nodeInstanceId: string, stopDurationInSeconds: number, options: ServiceFabricClientStartNodeTransitionOptionalParams, callback: ServiceCallback<void>)

Параметры

nodeName

string

Имя узла.

operationId

string

ИДЕНТИФИКАТОР GUID, определяющий вызов этого API. Это передается в соответствующий API GetProgress

nodeTransitionType
NodeTransitionType

Указывает тип выполняемого перехода. NodeTransitionType.Start запустит остановленный узел. NodeTransitionType.Stop остановит узел, который находится в состоянии. Возможные значения: "Invalid", "Start", "Stop"

nodeInstanceId

string

Идентификатор экземпляра узла целевого узла. Это можно определить с помощью API GetNodeInfo.

stopDurationInSeconds

number

Длительность( в секундах) для остановки узла. Минимальное значение равно 600, максимальное — 14400. После истечения этого срока действия узел автоматически будет выполнять резервное копирование.

options
ServiceFabricClientStartNodeTransitionOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

startPartitionRestart(string, string, string, RestartPartitionMode, ServiceCallback<void>)

function startPartitionRestart(serviceId: string, partitionId: string, operationId: string, restartPartitionMode: RestartPartitionMode, callback: ServiceCallback<void>)

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

partitionId

string

Удостоверение секции.

operationId

string

ИДЕНТИФИКАТОР GUID, определяющий вызов этого API. Это передается в соответствующий API GetProgress

restartPartitionMode
RestartPartitionMode

Описание секций для перезапуска. Возможные значения: Invalid, AllReplicasOrInstances, OnlyActiveSecondaries

callback

ServiceCallback<void>

Обратный вызов

startPartitionRestart(string, string, string, RestartPartitionMode, ServiceFabricClientStartPartitionRestartOptionalParams)

Этот API полезен для тестирования отработки отказа.

Если используется для целевой секции службы без отслеживания состояния, перезапускPartitionMode должен иметь значение AllReplicasOrInstances.

Вызовите API GetPartitionRestartProgress, используя тот же идентификатор OperationId, чтобы получить ход выполнения.

function startPartitionRestart(serviceId: string, partitionId: string, operationId: string, restartPartitionMode: RestartPartitionMode, options?: ServiceFabricClientStartPartitionRestartOptionalParams): Promise<RestResponse>

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

partitionId

string

Удостоверение секции.

operationId

string

ИДЕНТИФИКАТОР GUID, определяющий вызов этого API. Это передается в соответствующий API GetProgress

restartPartitionMode
RestartPartitionMode

Описание секций для перезапуска. Возможные значения: Invalid, AllReplicasOrInstances, OnlyActiveSecondaries

options
ServiceFabricClientStartPartitionRestartOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

startPartitionRestart(string, string, string, RestartPartitionMode, ServiceFabricClientStartPartitionRestartOptionalParams, ServiceCallback<void>)

function startPartitionRestart(serviceId: string, partitionId: string, operationId: string, restartPartitionMode: RestartPartitionMode, options: ServiceFabricClientStartPartitionRestartOptionalParams, callback: ServiceCallback<void>)

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

partitionId

string

Удостоверение секции.

operationId

string

ИДЕНТИФИКАТОР GUID, определяющий вызов этого API. Это передается в соответствующий API GetProgress

restartPartitionMode
RestartPartitionMode

Описание секций для перезапуска. Возможные значения: Invalid, AllReplicasOrInstances, OnlyActiveSecondaries

options
ServiceFabricClientStartPartitionRestartOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

startQuorumLoss(string, string, string, QuorumLossMode, number, ServiceCallback<void>)

function startQuorumLoss(serviceId: string, partitionId: string, operationId: string, quorumLossMode: QuorumLossMode, quorumLossDuration: number, callback: ServiceCallback<void>)

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

partitionId

string

Удостоверение секции.

operationId

string

ИДЕНТИФИКАТОР GUID, определяющий вызов этого API. Это передается в соответствующий API GetProgress

quorumLossMode
QuorumLossMode

Этот перечисление передается API StartQuorumLoss, чтобы указать, какой тип потери кворума вызывается. Возможные значения: Invalid, QuorumReplicas, AllReplicas

quorumLossDuration

number

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

callback

ServiceCallback<void>

Обратный вызов

startQuorumLoss(string, string, string, QuorumLossMode, number, ServiceFabricClientStartQuorumLossOptionalParams)

Этот API полезен для временной ситуации потери кворума в службе.

Вызовите API GetQuorumLossProgress с тем же идентификатором OperationId, чтобы вернуть сведения об операции, запущенной с этим API.

Это можно вызвать только для сохраненных служб с отслеживанием состояния (HasPersistedState=true). Не используйте этот API в службах без отслеживания состояния или только службах с отслеживанием состояния в памяти.

function startQuorumLoss(serviceId: string, partitionId: string, operationId: string, quorumLossMode: QuorumLossMode, quorumLossDuration: number, options?: ServiceFabricClientStartQuorumLossOptionalParams): Promise<RestResponse>

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

partitionId

string

Удостоверение секции.

operationId

string

ИДЕНТИФИКАТОР GUID, определяющий вызов этого API. Это передается в соответствующий API GetProgress

quorumLossMode
QuorumLossMode

Этот перечисление передается API StartQuorumLoss, чтобы указать, какой тип потери кворума вызывается. Возможные значения: Invalid, QuorumReplicas, AllReplicas

quorumLossDuration

number

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

options
ServiceFabricClientStartQuorumLossOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

startQuorumLoss(string, string, string, QuorumLossMode, number, ServiceFabricClientStartQuorumLossOptionalParams, ServiceCallback<void>)

function startQuorumLoss(serviceId: string, partitionId: string, operationId: string, quorumLossMode: QuorumLossMode, quorumLossDuration: number, options: ServiceFabricClientStartQuorumLossOptionalParams, callback: ServiceCallback<void>)

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

partitionId

string

Удостоверение секции.

operationId

string

ИДЕНТИФИКАТОР GUID, определяющий вызов этого API. Это передается в соответствующий API GetProgress

quorumLossMode
QuorumLossMode

Этот перечисление передается API StartQuorumLoss, чтобы указать, какой тип потери кворума вызывается. Возможные значения: Invalid, QuorumReplicas, AllReplicas

quorumLossDuration

number

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

options
ServiceFabricClientStartQuorumLossOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

startRollbackComposeDeploymentUpgrade(string, ServiceCallback<void>)

function startRollbackComposeDeploymentUpgrade(deploymentName: string, callback: ServiceCallback<void>)

Параметры

deploymentName

string

Удостоверение развертывания.

callback

ServiceCallback<void>

Обратный вызов

startRollbackComposeDeploymentUpgrade(string, ServiceFabricClientStartRollbackComposeDeploymentUpgradeOptionalParams)

Откат обновления развертывания Service Fabric.

function startRollbackComposeDeploymentUpgrade(deploymentName: string, options?: ServiceFabricClientStartRollbackComposeDeploymentUpgradeOptionalParams): Promise<RestResponse>

Параметры

deploymentName

string

Удостоверение развертывания.

options
ServiceFabricClientStartRollbackComposeDeploymentUpgradeOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

startRollbackComposeDeploymentUpgrade(string, ServiceFabricClientStartRollbackComposeDeploymentUpgradeOptionalParams, ServiceCallback<void>)

function startRollbackComposeDeploymentUpgrade(deploymentName: string, options: ServiceFabricClientStartRollbackComposeDeploymentUpgradeOptionalParams, callback: ServiceCallback<void>)

Параметры

deploymentName

string

Удостоверение развертывания.

options
ServiceFabricClientStartRollbackComposeDeploymentUpgradeOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

stopChaos(ServiceCallback<void>)

function stopChaos(callback: ServiceCallback<void>)

Параметры

callback

ServiceCallback<void>

Обратный вызов

stopChaos(ServiceFabricClientStopChaosOptionalParams)

Останавливает Хаос от выполнения новых ошибок. Ошибки во время полета будут продолжать выполняться до тех пор, пока они не будут завершены. Текущее расписание хаоса помещается в остановленное состояние. После остановки расписания он будет оставаться в остановленном состоянии и не будет использоваться для создания расписания хаоса новых запусков Хаоса. Для возобновления планирования необходимо задать новое расписание хаоса.

function stopChaos(options?: ServiceFabricClientStopChaosOptionalParams): Promise<RestResponse>

Параметры

options
ServiceFabricClientStopChaosOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

stopChaos(ServiceFabricClientStopChaosOptionalParams, ServiceCallback<void>)

function stopChaos(options: ServiceFabricClientStopChaosOptionalParams, callback: ServiceCallback<void>)

Параметры

options
ServiceFabricClientStopChaosOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

submitPropertyBatch(string, PropertyBatchDescriptionList, ServiceCallback<PropertyBatchInfoUnion>)

function submitPropertyBatch(nameId: string, propertyBatchDescriptionList: PropertyBatchDescriptionList, callback: ServiceCallback<PropertyBatchInfoUnion>)

Параметры

nameId

string

Имя Service Fabric без схемы URI fabric:.

propertyBatchDescriptionList
PropertyBatchDescriptionList

Описывает отправленные пакетные операции свойств.

callback

ServiceCallback<PropertyBatchInfoUnion>

Обратный вызов

submitPropertyBatch(string, PropertyBatchDescriptionList, ServiceFabricClientSubmitPropertyBatchOptionalParams)

Отправляет пакет операций свойств. Все или ни одна из операций не будет зафиксирована.

function submitPropertyBatch(nameId: string, propertyBatchDescriptionList: PropertyBatchDescriptionList, options?: ServiceFabricClientSubmitPropertyBatchOptionalParams): Promise<SubmitPropertyBatchResponse>

Параметры

nameId

string

Имя Service Fabric без схемы URI fabric:.

propertyBatchDescriptionList
PropertyBatchDescriptionList

Описывает отправленные пакетные операции свойств.

options
ServiceFabricClientSubmitPropertyBatchOptionalParams

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

Возвращаемое значение

Обещание<Models.SubmitPropertyBatchResponse>

submitPropertyBatch(string, PropertyBatchDescriptionList, ServiceFabricClientSubmitPropertyBatchOptionalParams, ServiceCallback<PropertyBatchInfoUnion>)

function submitPropertyBatch(nameId: string, propertyBatchDescriptionList: PropertyBatchDescriptionList, options: ServiceFabricClientSubmitPropertyBatchOptionalParams, callback: ServiceCallback<PropertyBatchInfoUnion>)

Параметры

nameId

string

Имя Service Fabric без схемы URI fabric:.

propertyBatchDescriptionList
PropertyBatchDescriptionList

Описывает отправленные пакетные операции свойств.

options
ServiceFabricClientSubmitPropertyBatchOptionalParams

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

callback

ServiceCallback<PropertyBatchInfoUnion>

Обратный вызов

suspendApplicationBackup(string, ServiceCallback<void>)

function suspendApplicationBackup(applicationId: string, callback: ServiceCallback<void>)

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

callback

ServiceCallback<void>

Обратный вызов

suspendApplicationBackup(string, ServiceFabricClientSuspendApplicationBackupOptionalParams)

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

function suspendApplicationBackup(applicationId: string, options?: ServiceFabricClientSuspendApplicationBackupOptionalParams): Promise<RestResponse>

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

options
ServiceFabricClientSuspendApplicationBackupOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

suspendApplicationBackup(string, ServiceFabricClientSuspendApplicationBackupOptionalParams, ServiceCallback<void>)

function suspendApplicationBackup(applicationId: string, options: ServiceFabricClientSuspendApplicationBackupOptionalParams, callback: ServiceCallback<void>)

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

options
ServiceFabricClientSuspendApplicationBackupOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

suspendPartitionBackup(string, ServiceCallback<void>)

function suspendPartitionBackup(partitionId: string, callback: ServiceCallback<void>)

Параметры

partitionId

string

Удостоверение секции.

callback

ServiceCallback<void>

Обратный вызов

suspendPartitionBackup(string, ServiceFabricClientSuspendPartitionBackupOptionalParams)

Секция, настроенная для периодического резервного копирования, приостановлена для получения дополнительных резервных копий до возобновления.

function suspendPartitionBackup(partitionId: string, options?: ServiceFabricClientSuspendPartitionBackupOptionalParams): Promise<RestResponse>

Параметры

partitionId

string

Удостоверение секции.

options
ServiceFabricClientSuspendPartitionBackupOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

suspendPartitionBackup(string, ServiceFabricClientSuspendPartitionBackupOptionalParams, ServiceCallback<void>)

function suspendPartitionBackup(partitionId: string, options: ServiceFabricClientSuspendPartitionBackupOptionalParams, callback: ServiceCallback<void>)

Параметры

partitionId

string

Удостоверение секции.

options
ServiceFabricClientSuspendPartitionBackupOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

suspendServiceBackup(string, ServiceCallback<void>)

function suspendServiceBackup(serviceId: string, callback: ServiceCallback<void>)

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

callback

ServiceCallback<void>

Обратный вызов

suspendServiceBackup(string, ServiceFabricClientSuspendServiceBackupOptionalParams)

Служба, настроенная для периодического резервного копирования, приостановлена для получения дополнительных резервных копий до возобновления работы. Эта операция применяется ко всей иерархии службы. Это означает, что все секции в этой службе теперь приостановлены для резервного копирования.

function suspendServiceBackup(serviceId: string, options?: ServiceFabricClientSuspendServiceBackupOptionalParams): Promise<RestResponse>

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

options
ServiceFabricClientSuspendServiceBackupOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

suspendServiceBackup(string, ServiceFabricClientSuspendServiceBackupOptionalParams, ServiceCallback<void>)

function suspendServiceBackup(serviceId: string, options: ServiceFabricClientSuspendServiceBackupOptionalParams, callback: ServiceCallback<void>)

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

options
ServiceFabricClientSuspendServiceBackupOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

toggleVerboseServicePlacementHealthReporting(boolean, ServiceCallback<void>)

function toggleVerboseServicePlacementHealthReporting(enabled: boolean, callback: ServiceCallback<void>)

Параметры

enabled

boolean

Подробные сведения о работоспособности размещения служб.

callback

ServiceCallback<void>

Обратный вызов

toggleVerboseServicePlacementHealthReporting(boolean, ServiceFabricClientToggleVerboseServicePlacementHealthReportingOptionalParams)

Если задано значение true, то подробные отчеты о работоспособности создаются, когда реплики не могут быть помещены или удалены. Если для детализации задано значение false, то отчеты о работоспособности не будут создаваться, когда реплики не могут быть размещены или удалены.

function toggleVerboseServicePlacementHealthReporting(enabled: boolean, options?: ServiceFabricClientToggleVerboseServicePlacementHealthReportingOptionalParams): Promise<RestResponse>

Параметры

enabled

boolean

Подробные сведения о работоспособности размещения служб.

options
ServiceFabricClientToggleVerboseServicePlacementHealthReportingOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

toggleVerboseServicePlacementHealthReporting(boolean, ServiceFabricClientToggleVerboseServicePlacementHealthReportingOptionalParams, ServiceCallback<void>)

function toggleVerboseServicePlacementHealthReporting(enabled: boolean, options: ServiceFabricClientToggleVerboseServicePlacementHealthReportingOptionalParams, callback: ServiceCallback<void>)

Параметры

enabled

boolean

Подробные сведения о работоспособности размещения служб.

options
ServiceFabricClientToggleVerboseServicePlacementHealthReportingOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

unprovisionApplicationType(string, UnprovisionApplicationTypeDescriptionInfo, ServiceCallback<void>)

function unprovisionApplicationType(applicationTypeName: string, unprovisionApplicationTypeDescriptionInfo: UnprovisionApplicationTypeDescriptionInfo, callback: ServiceCallback<void>)

Параметры

applicationTypeName

string

Имя типа приложения.

unprovisionApplicationTypeDescriptionInfo
UnprovisionApplicationTypeDescriptionInfo

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

callback

ServiceCallback<void>

Обратный вызов

unprovisionApplicationType(string, UnprovisionApplicationTypeDescriptionInfo, ServiceFabricClientUnprovisionApplicationTypeOptionalParams)

Эту операцию можно выполнить только в том случае, если все экземпляры приложения типа приложения были удалены. После отмены регистрации типа приложения новые экземпляры приложений не могут быть созданы для этого конкретного типа приложения.

function unprovisionApplicationType(applicationTypeName: string, unprovisionApplicationTypeDescriptionInfo: UnprovisionApplicationTypeDescriptionInfo, options?: ServiceFabricClientUnprovisionApplicationTypeOptionalParams): Promise<RestResponse>

Параметры

applicationTypeName

string

Имя типа приложения.

unprovisionApplicationTypeDescriptionInfo
UnprovisionApplicationTypeDescriptionInfo

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

options
ServiceFabricClientUnprovisionApplicationTypeOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

unprovisionApplicationType(string, UnprovisionApplicationTypeDescriptionInfo, ServiceFabricClientUnprovisionApplicationTypeOptionalParams, ServiceCallback<void>)

function unprovisionApplicationType(applicationTypeName: string, unprovisionApplicationTypeDescriptionInfo: UnprovisionApplicationTypeDescriptionInfo, options: ServiceFabricClientUnprovisionApplicationTypeOptionalParams, callback: ServiceCallback<void>)

Параметры

applicationTypeName

string

Имя типа приложения.

unprovisionApplicationTypeDescriptionInfo
UnprovisionApplicationTypeDescriptionInfo

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

options
ServiceFabricClientUnprovisionApplicationTypeOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

unprovisionCluster(UnprovisionFabricDescription, ServiceCallback<void>)

function unprovisionCluster(unprovisionFabricDescription: UnprovisionFabricDescription, callback: ServiceCallback<void>)

Параметры

unprovisionFabricDescription
UnprovisionFabricDescription

Описывает параметры для отмены подготовки кластера.

callback

ServiceCallback<void>

Обратный вызов

unprovisionCluster(UnprovisionFabricDescription, ServiceFabricClientUnprovisionClusterOptionalParams)

Она поддерживается для отмены подготовки кода и конфигурации отдельно.

function unprovisionCluster(unprovisionFabricDescription: UnprovisionFabricDescription, options?: ServiceFabricClientUnprovisionClusterOptionalParams): Promise<RestResponse>

Параметры

unprovisionFabricDescription
UnprovisionFabricDescription

Описывает параметры для отмены подготовки кластера.

options
ServiceFabricClientUnprovisionClusterOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

unprovisionCluster(UnprovisionFabricDescription, ServiceFabricClientUnprovisionClusterOptionalParams, ServiceCallback<void>)

function unprovisionCluster(unprovisionFabricDescription: UnprovisionFabricDescription, options: ServiceFabricClientUnprovisionClusterOptionalParams, callback: ServiceCallback<void>)

Параметры

unprovisionFabricDescription
UnprovisionFabricDescription

Описывает параметры для отмены подготовки кластера.

options
ServiceFabricClientUnprovisionClusterOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

updateApplicationUpgrade(string, ApplicationUpgradeUpdateDescription, ServiceCallback<void>)

function updateApplicationUpgrade(applicationId: string, applicationUpgradeUpdateDescription: ApplicationUpgradeUpdateDescription, callback: ServiceCallback<void>)

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

applicationUpgradeUpdateDescription
ApplicationUpgradeUpdateDescription

Параметры для обновления существующего обновления приложения.

callback

ServiceCallback<void>

Обратный вызов

updateApplicationUpgrade(string, ApplicationUpgradeUpdateDescription, ServiceFabricClientUpdateApplicationUpgradeOptionalParams)

Обновляет параметры текущего обновления приложения, указанные во время запуска обновления приложения. Это может потребоваться для устранения зависнутых обновлений приложений из-за неправильных параметров или проблем в приложении для выполнения выполнения.

function updateApplicationUpgrade(applicationId: string, applicationUpgradeUpdateDescription: ApplicationUpgradeUpdateDescription, options?: ServiceFabricClientUpdateApplicationUpgradeOptionalParams): Promise<RestResponse>

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

applicationUpgradeUpdateDescription
ApplicationUpgradeUpdateDescription

Параметры для обновления существующего обновления приложения.

options
ServiceFabricClientUpdateApplicationUpgradeOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

updateApplicationUpgrade(string, ApplicationUpgradeUpdateDescription, ServiceFabricClientUpdateApplicationUpgradeOptionalParams, ServiceCallback<void>)

function updateApplicationUpgrade(applicationId: string, applicationUpgradeUpdateDescription: ApplicationUpgradeUpdateDescription, options: ServiceFabricClientUpdateApplicationUpgradeOptionalParams, callback: ServiceCallback<void>)

Параметры

applicationId

string

Удостоверение приложения. Обычно это полное имя приложения без схемы URI fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя приложения — fabric:/myapp/app1, удостоверение приложения будет "myapp~app1" в версии 6.0+ и "myapp/app1" в предыдущих версиях.

applicationUpgradeUpdateDescription
ApplicationUpgradeUpdateDescription

Параметры для обновления существующего обновления приложения.

options
ServiceFabricClientUpdateApplicationUpgradeOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

updateBackupPolicy(BackupPolicyDescription, string, ServiceCallback<void>)

function updateBackupPolicy(backupPolicyDescription: BackupPolicyDescription, backupPolicyName: string, callback: ServiceCallback<void>)

Параметры

backupPolicyDescription
BackupPolicyDescription

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

backupPolicyName

string

Имя политики резервного копирования.

callback

ServiceCallback<void>

Обратный вызов

updateBackupPolicy(BackupPolicyDescription, string, ServiceFabricClientUpdateBackupPolicyOptionalParams)

Обновляет политику резервного копирования, определяемую {backupPolicyName}

function updateBackupPolicy(backupPolicyDescription: BackupPolicyDescription, backupPolicyName: string, options?: ServiceFabricClientUpdateBackupPolicyOptionalParams): Promise<RestResponse>

Параметры

backupPolicyDescription
BackupPolicyDescription

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

backupPolicyName

string

Имя политики резервного копирования.

options
ServiceFabricClientUpdateBackupPolicyOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

updateBackupPolicy(BackupPolicyDescription, string, ServiceFabricClientUpdateBackupPolicyOptionalParams, ServiceCallback<void>)

function updateBackupPolicy(backupPolicyDescription: BackupPolicyDescription, backupPolicyName: string, options: ServiceFabricClientUpdateBackupPolicyOptionalParams, callback: ServiceCallback<void>)

Параметры

backupPolicyDescription
BackupPolicyDescription

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

backupPolicyName

string

Имя политики резервного копирования.

options
ServiceFabricClientUpdateBackupPolicyOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

updateClusterUpgrade(UpdateClusterUpgradeDescription, ServiceCallback<void>)

function updateClusterUpgrade(updateClusterUpgradeDescription: UpdateClusterUpgradeDescription, callback: ServiceCallback<void>)

Параметры

updateClusterUpgradeDescription
UpdateClusterUpgradeDescription

Параметры обновления кластера.

callback

ServiceCallback<void>

Обратный вызов

updateClusterUpgrade(UpdateClusterUpgradeDescription, ServiceFabricClientUpdateClusterUpgradeOptionalParams)

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

function updateClusterUpgrade(updateClusterUpgradeDescription: UpdateClusterUpgradeDescription, options?: ServiceFabricClientUpdateClusterUpgradeOptionalParams): Promise<RestResponse>

Параметры

updateClusterUpgradeDescription
UpdateClusterUpgradeDescription

Параметры обновления кластера.

options
ServiceFabricClientUpdateClusterUpgradeOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

updateClusterUpgrade(UpdateClusterUpgradeDescription, ServiceFabricClientUpdateClusterUpgradeOptionalParams, ServiceCallback<void>)

function updateClusterUpgrade(updateClusterUpgradeDescription: UpdateClusterUpgradeDescription, options: ServiceFabricClientUpdateClusterUpgradeOptionalParams, callback: ServiceCallback<void>)

Параметры

updateClusterUpgradeDescription
UpdateClusterUpgradeDescription

Параметры обновления кластера.

options
ServiceFabricClientUpdateClusterUpgradeOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

updateRepairExecutionState(RepairTask, RequestOptionsBase)

Этот API поддерживает платформу Service Fabric; Он не предназначен для использования непосредственно из кода.

function updateRepairExecutionState(repairTask: RepairTask, options?: RequestOptionsBase): Promise<UpdateRepairExecutionStateResponse>

Параметры

repairTask
RepairTask

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

options
RequestOptionsBase

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

Возвращаемое значение

Обещание<Models.UpdateRepairExecutionStateResponse>

updateRepairExecutionState(RepairTask, RequestOptionsBase, ServiceCallback<RepairTaskUpdateInfo>)

function updateRepairExecutionState(repairTask: RepairTask, options: RequestOptionsBase, callback: ServiceCallback<RepairTaskUpdateInfo>)

Параметры

repairTask
RepairTask

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

options
RequestOptionsBase

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

callback

ServiceCallback<RepairTaskUpdateInfo>

Обратный вызов

updateRepairExecutionState(RepairTask, ServiceCallback<RepairTaskUpdateInfo>)

function updateRepairExecutionState(repairTask: RepairTask, callback: ServiceCallback<RepairTaskUpdateInfo>)

Параметры

repairTask
RepairTask

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

callback

ServiceCallback<RepairTaskUpdateInfo>

Обратный вызов

updateRepairTaskHealthPolicy(RepairTaskUpdateHealthPolicyDescription, RequestOptionsBase)

Этот API поддерживает платформу Service Fabric; Он не предназначен для использования непосредственно из кода.

function updateRepairTaskHealthPolicy(repairTaskUpdateHealthPolicyDescription: RepairTaskUpdateHealthPolicyDescription, options?: RequestOptionsBase): Promise<UpdateRepairTaskHealthPolicyResponse>

Параметры

repairTaskUpdateHealthPolicyDescription
RepairTaskUpdateHealthPolicyDescription

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

options
RequestOptionsBase

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

Возвращаемое значение

Обещание<Models.UpdateRepairTaskHealthPolicyResponse>

updateRepairTaskHealthPolicy(RepairTaskUpdateHealthPolicyDescription, RequestOptionsBase, ServiceCallback<RepairTaskUpdateInfo>)

function updateRepairTaskHealthPolicy(repairTaskUpdateHealthPolicyDescription: RepairTaskUpdateHealthPolicyDescription, options: RequestOptionsBase, callback: ServiceCallback<RepairTaskUpdateInfo>)

Параметры

repairTaskUpdateHealthPolicyDescription
RepairTaskUpdateHealthPolicyDescription

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

options
RequestOptionsBase

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

callback

ServiceCallback<RepairTaskUpdateInfo>

Обратный вызов

updateRepairTaskHealthPolicy(RepairTaskUpdateHealthPolicyDescription, ServiceCallback<RepairTaskUpdateInfo>)

function updateRepairTaskHealthPolicy(repairTaskUpdateHealthPolicyDescription: RepairTaskUpdateHealthPolicyDescription, callback: ServiceCallback<RepairTaskUpdateInfo>)

Параметры

repairTaskUpdateHealthPolicyDescription
RepairTaskUpdateHealthPolicyDescription

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

callback

ServiceCallback<RepairTaskUpdateInfo>

Обратный вызов

updateService(string, ServiceUpdateDescriptionUnion, ServiceCallback<void>)

function updateService(serviceId: string, serviceUpdateDescription: ServiceUpdateDescriptionUnion, callback: ServiceCallback<void>)

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

serviceUpdateDescription
ServiceUpdateDescriptionUnion

Сведения, необходимые для обновления службы.

callback

ServiceCallback<void>

Обратный вызов

updateService(string, ServiceUpdateDescriptionUnion, ServiceFabricClientUpdateServiceOptionalParams)

Этот API позволяет обновлять свойства запущенной службы Service Fabric. Набор свойств, которые можно обновить, — это подмножество свойств, указанных во время создания службы. Текущий набор свойств можно получить с помощью API GetServiceDescription. Обратите внимание, что обновление свойств запущенной службы отличается от обновления приложения с помощью API StartApplicationUpgrade. Обновление — это длительная фоновая операция, которая включает перемещение приложения из одной версии в другую, один домен обновления за раз, а обновление применяет новые свойства немедленно к службе.

function updateService(serviceId: string, serviceUpdateDescription: ServiceUpdateDescriptionUnion, options?: ServiceFabricClientUpdateServiceOptionalParams): Promise<RestResponse>

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

serviceUpdateDescription
ServiceUpdateDescriptionUnion

Сведения, необходимые для обновления службы.

options
ServiceFabricClientUpdateServiceOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

updateService(string, ServiceUpdateDescriptionUnion, ServiceFabricClientUpdateServiceOptionalParams, ServiceCallback<void>)

function updateService(serviceId: string, serviceUpdateDescription: ServiceUpdateDescriptionUnion, options: ServiceFabricClientUpdateServiceOptionalParams, callback: ServiceCallback<void>)

Параметры

serviceId

string

Удостоверение службы. Этот идентификатор обычно является полным именем службы без схемы URI Fabric:. Начиная с версии 6.0 иерархические имена разделены символом ~. Например, если имя службы — Fabric:/myapp/app1/svc1, удостоверение службы будет иметь значение "myapp~app1~svc1" в версии 6.0+ и "myapp/app1/svc1" в предыдущих версиях.

serviceUpdateDescription
ServiceUpdateDescriptionUnion

Сведения, необходимые для обновления службы.

options
ServiceFabricClientUpdateServiceOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

uploadFile(string, ServiceCallback<void>)

function uploadFile(contentPath: string, callback: ServiceCallback<void>)

Параметры

contentPath

string

Относительный путь к файлу или папке в хранилище образов из корневого каталога.

callback

ServiceCallback<void>

Обратный вызов

uploadFile(string, ServiceFabricClientUploadFileOptionalParams)

Отправляет содержимое файла в хранилище образов. Используйте этот API, если файл достаточно мал, чтобы отправить еще раз, если подключение завершается ошибкой. Данные файла необходимо добавить в текст запроса. Содержимое будет отправлено в указанный путь. Служба хранилища изображений использует файл метки для указания доступности папки. Файл метки — пустой файл с именем _.dir. Файл метки создается службой хранилища образов при отправке всех файлов в папку. При использовании подхода "Файл по файлам" для отправки пакета приложения в REST служба хранилища образов не знает о иерархии файлов пакета приложения; Необходимо создать файл пометки для каждой папки и отправить его последнее, чтобы сообщить службе хранилища образов, что папка завершена.

function uploadFile(contentPath: string, options?: ServiceFabricClientUploadFileOptionalParams): Promise<RestResponse>

Параметры

contentPath

string

Относительный путь к файлу или папке в хранилище образов из корневого каталога.

options
ServiceFabricClientUploadFileOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

uploadFile(string, ServiceFabricClientUploadFileOptionalParams, ServiceCallback<void>)

function uploadFile(contentPath: string, options: ServiceFabricClientUploadFileOptionalParams, callback: ServiceCallback<void>)

Параметры

contentPath

string

Относительный путь к файлу или папке в хранилище образов из корневого каталога.

options
ServiceFabricClientUploadFileOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

uploadFileChunk(string, string, string, ServiceCallback<void>)

function uploadFileChunk(contentPath: string, sessionId: string, contentRange: string, callback: ServiceCallback<void>)

Параметры

contentPath

string

Относительный путь к файлу или папке в хранилище образов из корневого каталога.

sessionId

string

GUID, созданный пользователем для отправки файла. Он определяет сеанс отправки хранилища образов, который отслеживает все блоки файлов, пока не будет зафиксировано.

contentRange

string

При отправке блоков файлов в хранилище образов поле заголовка Content-Range необходимо настроить и отправить запрос. Формат должен выглядеть следующим образом: "байты {First-Byte-Position}-{Last-Byte-Position}/{File-Length}". Например, Content-Range:байт 300-5000/20000 указывает, что пользователь отправляет байты 300–5000, а общая длина файла — 20 000 байт.

callback

ServiceCallback<void>

Обратный вызов

uploadFileChunk(string, string, string, ServiceFabricClientUploadFileChunkOptionalParams)

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

Чтобы выполнить повторную отправку файлов, пользователю необходимо разбить файл на несколько блоков и отправить эти блоки в хранилище образов по одному. Блоки не нужно отправлять по порядку. Если файл, представленный относительным путем хранилища образов, уже существует, он будет перезаписан при фиксации сеанса отправки.

function uploadFileChunk(contentPath: string, sessionId: string, contentRange: string, options?: ServiceFabricClientUploadFileChunkOptionalParams): Promise<RestResponse>

Параметры

contentPath

string

Относительный путь к файлу или папке в хранилище образов из корневого каталога.

sessionId

string

GUID, созданный пользователем для отправки файла. Он определяет сеанс отправки хранилища образов, который отслеживает все блоки файлов, пока не будет зафиксировано.

contentRange

string

При отправке блоков файлов в хранилище образов поле заголовка Content-Range необходимо настроить и отправить запрос. Формат должен выглядеть следующим образом: "байты {First-Byte-Position}-{Last-Byte-Position}/{File-Length}". Например, Content-Range:байт 300-5000/20000 указывает, что пользователь отправляет байты 300–5000, а общая длина файла — 20 000 байт.

options
ServiceFabricClientUploadFileChunkOptionalParams

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

Возвращаемое значение

Promise<RestResponse>

Обещание<msRest.RestResponse>

uploadFileChunk(string, string, string, ServiceFabricClientUploadFileChunkOptionalParams, ServiceCallback<void>)

function uploadFileChunk(contentPath: string, sessionId: string, contentRange: string, options: ServiceFabricClientUploadFileChunkOptionalParams, callback: ServiceCallback<void>)

Параметры

contentPath

string

Относительный путь к файлу или папке в хранилище образов из корневого каталога.

sessionId

string

GUID, созданный пользователем для отправки файла. Он определяет сеанс отправки хранилища образов, который отслеживает все блоки файлов, пока не будет зафиксировано.

contentRange

string

При отправке блоков файлов в хранилище образов поле заголовка Content-Range необходимо настроить и отправить запрос. Формат должен выглядеть следующим образом: "байты {First-Byte-Position}-{Last-Byte-Position}/{File-Length}". Например, Content-Range:байт 300-5000/20000 указывает, что пользователь отправляет байты 300–5000, а общая длина файла — 20 000 байт.

options
ServiceFabricClientUploadFileChunkOptionalParams

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

callback

ServiceCallback<void>

Обратный вызов

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

sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)

Отправьте HTTP-запрос, заполненный с помощью предоставленной операцииSpec.

function sendOperationRequest(operationArguments: OperationArguments, operationSpec: OperationSpec, callback?: ServiceCallback<any>): Promise<RestResponse>

Параметры

operationArguments
OperationArguments

Аргументы, из которыми будут заполнены шаблонные значения HTTP-запроса.

operationSpec
OperationSpec

ОперацияSpec, используемая для заполнения httpRequest.

callback

ServiceCallback<any>

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

Возвращаемое значение

Promise<RestResponse>

унаследовано отServiceFabricClientContext.sendOperationRequest

sendRequest(RequestPrepareOptions | WebResourceLike)

Отправьте предоставленный httpRequest.

function sendRequest(options: RequestPrepareOptions | WebResourceLike): Promise<HttpOperationResponse>

Параметры

Возвращаемое значение

наследуется отServiceFabricClientContext.sendRequest