ServiceFabricClient class
- Extends
コンストラクター
| Service |
ServiceFabricClient クラスの新しいインスタンスを初期化します。 |
プロパティ
| mesh |
|
| mesh |
|
| mesh |
|
| mesh |
|
| mesh |
|
| mesh |
|
| mesh |
|
| mesh |
|
| mesh |
メソッド
継承されたメソッド
| send |
指定された OperationSpec を使用して設定された HTTP 要求を送信します。 |
| send |
指定された httpRequest を送信します。 |
コンストラクターの詳細
ServiceFabricClient(ServiceFabricClientOptions)
ServiceFabricClient クラスの新しいインスタンスを初期化します。
new ServiceFabricClient(options?: ServiceFabricClientOptions)
パラメーター
- options
- ServiceFabricClientOptions
パラメーター のオプション
プロパティの詳細
meshApplication
meshCodePackage
meshGateway
meshNetwork
meshSecret
meshSecretValue
meshService
meshServiceReplica
meshVolume
メソッドの詳細
addConfigurationParameterOverrides(string, ConfigParameterOverride[], ServiceCallback<void>)
function addConfigurationParameterOverrides(nodeName: string, configParameterOverrideList: ConfigParameterOverride[], callback: ServiceCallback<void>)
パラメーター
- nodeName
-
string
ノード名。
- configParameterOverrideList
構成オーバーライドのリストを追加するための説明。
- callback
-
ServiceCallback<void>
コールバック
addConfigurationParameterOverrides(string, ConfigParameterOverride[], ServiceFabricClientAddConfigurationParameterOverridesOptionalParams)
この API を使用すると、指定されたノードに既存のすべての構成オーバーライドを追加できます。
function addConfigurationParameterOverrides(nodeName: string, configParameterOverrideList: ConfigParameterOverride[], options?: ServiceFabricClientAddConfigurationParameterOverridesOptionalParams): Promise<RestResponse>
パラメーター
- nodeName
-
string
ノード名。
- configParameterOverrideList
構成オーバーライドのリストを追加するための説明。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
addConfigurationParameterOverrides(string, ConfigParameterOverride[], ServiceFabricClientAddConfigurationParameterOverridesOptionalParams, ServiceCallback<void>)
function addConfigurationParameterOverrides(nodeName: string, configParameterOverrideList: ConfigParameterOverride[], options: ServiceFabricClientAddConfigurationParameterOverridesOptionalParams, callback: ServiceCallback<void>)
パラメーター
- nodeName
-
string
ノード名。
- configParameterOverrideList
構成オーバーライドのリストを追加するための説明。
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
backupPartition(string, ServiceCallback<void>)
function backupPartition(partitionId: string, callback: ServiceCallback<void>)
パラメーター
- partitionId
-
string
パーティションの ID。
- callback
-
ServiceCallback<void>
コールバック
backupPartition(string, ServiceFabricClientBackupPartitionOptionalParams)
ステートフル永続パーティションの状態のバックアップを作成します。 パーティションがすでに定期的にバックアップされている場合は、デフォルトでは、新しいバックアップは同じバックアップストレージに作成されます。 また、リクエスト本文の一部としてバックアップストレージの詳細を指定することで、同じものをオーバーライドすることもできます。 バックアップが開始されると、GetBackupProgress 操作を使用してその進行状況を追跡できます。 操作がタイムアウトした場合は、クエリ パラメーターでより大きなバックアップ タイムアウト値を指定します。
function backupPartition(partitionId: string, options?: ServiceFabricClientBackupPartitionOptionalParams): Promise<RestResponse>
パラメーター
- partitionId
-
string
パーティションの ID。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
backupPartition(string, ServiceFabricClientBackupPartitionOptionalParams, ServiceCallback<void>)
function backupPartition(partitionId: string, options: ServiceFabricClientBackupPartitionOptionalParams, callback: ServiceCallback<void>)
パラメーター
- partitionId
-
string
パーティションの ID。
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
cancelOperation(string, boolean, ServiceCallback<void>)
function cancelOperation(operationId: string, force: boolean, callback: ServiceCallback<void>)
パラメーター
- operationId
-
string
この API の呼び出しを識別する GUID。 これは、対応する GetProgress API に渡されます
- force
-
boolean
ユーザー誘導操作の実行によって変更された内部システム状態を正常にロールバックしてクリーンアップするかどうかを示します。
- callback
-
ServiceCallback<void>
コールバック
cancelOperation(string, boolean, ServiceFabricClientCancelOperationOptionalParams)
次の API は、CancelOperation を使用して取り消すことができる障害操作を開始します: StartDataLoss、StartQuorumLoss、StartPartitionRestart、StartNodeTransition。
force が false の場合、指定されたユーザー誘導操作は正常に停止され、クリーンアップされます。 force が true の場合、コマンドは中止され、内部状態が残る可能性があります。 force を true として指定する場合は、注意して使用する必要があります。 force を true に設定してこの API を呼び出すことは、最初に force を false に設定して同じテストコマンドでこの API が呼び出されるまで、またはテストコマンドの OperationState が既に OperationState.RollingBack でない限り許可されません。 明確化: OperationState.RollingBack は、システムがコマンドの実行によって引き起こされる内部システム状態をクリーンアップすることを意味します。 テストコマンドがデータ損失を引き起こす場合、データは復元されません。 たとえば、StartDataLoss を呼び出してからこの API を呼び出すと、システムはコマンドの実行による内部状態のみをクリーンアップします。 コマンドがデータ損失を引き起こすほど進行した場合、ターゲットパーティションのデータは復元されません。
重要な注意: この API が force==true で呼び出されると、内部状態が残される可能性があります。
function cancelOperation(operationId: string, force: boolean, options?: ServiceFabricClientCancelOperationOptionalParams): Promise<RestResponse>
パラメーター
- operationId
-
string
この API の呼び出しを識別する GUID。 これは、対応する GetProgress API に渡されます
- force
-
boolean
ユーザー誘導操作の実行によって変更された内部システム状態を正常にロールバックしてクリーンアップするかどうかを示します。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
cancelOperation(string, boolean, ServiceFabricClientCancelOperationOptionalParams, ServiceCallback<void>)
function cancelOperation(operationId: string, force: boolean, options: ServiceFabricClientCancelOperationOptionalParams, callback: ServiceCallback<void>)
パラメーター
- operationId
-
string
この API の呼び出しを識別する GUID。 これは、対応する GetProgress API に渡されます
- force
-
boolean
ユーザー誘導操作の実行によって変更された内部システム状態を正常にロールバックしてクリーンアップするかどうかを示します。
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
cancelRepairTask(RepairTaskCancelDescription, RequestOptionsBase)
この API は Service Fabric プラットフォームをサポートします。コードから直接使用することを意図したものではありません。
function cancelRepairTask(repairTaskCancelDescription: RepairTaskCancelDescription, options?: RequestOptionsBase): Promise<CancelRepairTaskResponse>
パラメーター
- repairTaskCancelDescription
- RepairTaskCancelDescription
取り消す修復タスクについて説明します。
- options
- RequestOptionsBase
省略可能なパラメーター
戻り値
Promise<CancelRepairTaskResponse>
Promise<Models.CancelRepairTaskResponse>
cancelRepairTask(RepairTaskCancelDescription, RequestOptionsBase, ServiceCallback<RepairTaskUpdateInfo>)
function cancelRepairTask(repairTaskCancelDescription: RepairTaskCancelDescription, options: RequestOptionsBase, callback: ServiceCallback<RepairTaskUpdateInfo>)
パラメーター
- repairTaskCancelDescription
- RepairTaskCancelDescription
取り消す修復タスクについて説明します。
- options
- RequestOptionsBase
省略可能なパラメーター
- callback
コールバック
cancelRepairTask(RepairTaskCancelDescription, ServiceCallback<RepairTaskUpdateInfo>)
function cancelRepairTask(repairTaskCancelDescription: RepairTaskCancelDescription, callback: ServiceCallback<RepairTaskUpdateInfo>)
パラメーター
- repairTaskCancelDescription
- RepairTaskCancelDescription
取り消す修復タスクについて説明します。
- callback
コールバック
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。 これは、コミットされるまですべてのファイルチャンクを追跡するイメージストアアップロードセッションを識別します。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
commitImageStoreUploadSession(string, ServiceFabricClientCommitImageStoreUploadSessionOptionalParams, ServiceCallback<void>)
function commitImageStoreUploadSession(sessionId: string, options: ServiceFabricClientCommitImageStoreUploadSessionOptionalParams, callback: ServiceCallback<void>)
パラメーター
- sessionId
-
string
ファイルのアップロードのためにユーザーが生成した GUID。 これは、コミットされるまですべてのファイルチャンクを追跡するイメージストアアップロードセッションを識別します。
省略可能なパラメーター
- 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
イメージ ストアのコピーの説明について説明します。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
copyImageStoreContent(ImageStoreCopyDescription, ServiceFabricClientCopyImageStoreContentOptionalParams, ServiceCallback<void>)
function copyImageStoreContent(imageStoreCopyDescription: ImageStoreCopyDescription, options: ServiceFabricClientCopyImageStoreContentOptionalParams, callback: ServiceCallback<void>)
パラメーター
- imageStoreCopyDescription
- ImageStoreCopyDescription
イメージ ストアのコピーの説明について説明します。
省略可能なパラメーター
- 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
アプリケーションの作成に関する説明。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
createApplication(ApplicationDescription, ServiceFabricClientCreateApplicationOptionalParams, ServiceCallback<void>)
function createApplication(applicationDescription: ApplicationDescription, options: ServiceFabricClientCreateApplicationOptionalParams, callback: ServiceCallback<void>)
パラメーター
- applicationDescription
- ApplicationDescription
アプリケーションの作成に関する説明。
省略可能なパラメーター
- 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
バックアップ ポリシーについて説明します。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
createBackupPolicy(BackupPolicyDescription, ServiceFabricClientCreateBackupPolicyOptionalParams, ServiceCallback<void>)
function createBackupPolicy(backupPolicyDescription: BackupPolicyDescription, options: ServiceFabricClientCreateBackupPolicyOptionalParams, callback: ServiceCallback<void>)
パラメーター
- backupPolicyDescription
- BackupPolicyDescription
バックアップ ポリシーについて説明します。
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
createComposeDeployment(CreateComposeDeploymentDescription, ServiceCallback<void>)
function createComposeDeployment(createComposeDeploymentDescription: CreateComposeDeploymentDescription, callback: ServiceCallback<void>)
パラメーター
- createComposeDeploymentDescription
- CreateComposeDeploymentDescription
作成する必要がある作成デプロイについて説明します。
- callback
-
ServiceCallback<void>
コールバック
createComposeDeployment(CreateComposeDeploymentDescription, ServiceFabricClientCreateComposeDeploymentOptionalParams)
Compose は、マルチコンテナアプリケーションを記述するファイル形式です。 この API を使用すると、作成形式で定義されたコンテナー ベースのアプリケーションを Service Fabric クラスターにデプロイできます。 デプロイが作成されると、 GetComposeDeploymentStatus API を使用してそのステータスを追跡できます。
function createComposeDeployment(createComposeDeploymentDescription: CreateComposeDeploymentDescription, options?: ServiceFabricClientCreateComposeDeploymentOptionalParams): Promise<RestResponse>
パラメーター
- createComposeDeploymentDescription
- CreateComposeDeploymentDescription
作成する必要がある作成デプロイについて説明します。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
createComposeDeployment(CreateComposeDeploymentDescription, ServiceFabricClientCreateComposeDeploymentOptionalParams, ServiceCallback<void>)
function createComposeDeployment(createComposeDeploymentDescription: CreateComposeDeploymentDescription, options: ServiceFabricClientCreateComposeDeploymentOptionalParams, callback: ServiceCallback<void>)
パラメーター
- createComposeDeploymentDescription
- CreateComposeDeploymentDescription
作成する必要がある作成デプロイについて説明します。
省略可能なパラメーター
- 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 名について説明します。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
createName(NameDescription, ServiceFabricClientCreateNameOptionalParams, ServiceCallback<void>)
function createName(nameDescription: NameDescription, options: ServiceFabricClientCreateNameOptionalParams, callback: ServiceCallback<void>)
パラメーター
- nameDescription
- NameDescription
作成する Service Fabric 名について説明します。
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
createRepairTask(RepairTask, RequestOptionsBase)
Repair Manager Service が構成されているクラスターの場合、この API は、自動または手動で実行される修復タスクを作成する方法を提供します。 自動的に実行される修復タスクの場合、修復アクションごとに適切な修復エグゼキューターが実行されている必要があります。 これらは現在、特別に構成された Azure Cloud Services でのみ使用できます。
手動修復タスクを作成するには、影響を受けるノード名のセットと予想される影響を指定します。 作成された修復タスクの状態が承認済みに変わると、それらのノードで修復アクションを安全に実行できます。
この API は Service Fabric プラットフォームをサポートします。コードから直接使用することを意図したものではありません。
function createRepairTask(repairTask: RepairTask, options?: RequestOptionsBase): Promise<CreateRepairTaskResponse>
パラメーター
- repairTask
- RepairTask
作成または更新する修復タスクについて説明します。
- options
- RequestOptionsBase
省略可能なパラメーター
戻り値
Promise<CreateRepairTaskResponse>
Promise<Models.CreateRepairTaskResponse>
createRepairTask(RepairTask, RequestOptionsBase, ServiceCallback<RepairTaskUpdateInfo>)
function createRepairTask(repairTask: RepairTask, options: RequestOptionsBase, callback: ServiceCallback<RepairTaskUpdateInfo>)
パラメーター
- repairTask
- RepairTask
作成または更新する修復タスクについて説明します。
- options
- RequestOptionsBase
省略可能なパラメーター
- callback
コールバック
createRepairTask(RepairTask, ServiceCallback<RepairTaskUpdateInfo>)
function createRepairTask(repairTask: RepairTask, callback: ServiceCallback<RepairTaskUpdateInfo>)
パラメーター
- repairTask
- RepairTask
作成または更新する修復タスクについて説明します。
- callback
コールバック
createService(string, ServiceDescriptionUnion, ServiceCallback<void>)
function createService(applicationId: string, serviceDescription: ServiceDescriptionUnion, callback: ServiceCallback<void>)
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- serviceDescription
- ServiceDescriptionUnion
サービスの作成に必要な情報。
- callback
-
ServiceCallback<void>
コールバック
createService(string, ServiceDescriptionUnion, ServiceFabricClientCreateServiceOptionalParams)
この API を使用すると、指定した Service Fabric アプリケーションの下に新しい Service Fabric ステートレス サービスまたはステートフル サービスを作成できます。 サービスの作成に関する説明には、パーティション情報と、配置と負荷分散のためのオプションのプロパティが含まれています。 一部のプロパティは、後で API を使用して変更できます UpdateService 。
function createService(applicationId: string, serviceDescription: ServiceDescriptionUnion, options?: ServiceFabricClientCreateServiceOptionalParams): Promise<RestResponse>
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- serviceDescription
- ServiceDescriptionUnion
サービスの作成に必要な情報。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
createService(string, ServiceDescriptionUnion, ServiceFabricClientCreateServiceOptionalParams, ServiceCallback<void>)
function createService(applicationId: string, serviceDescription: ServiceDescriptionUnion, options: ServiceFabricClientCreateServiceOptionalParams, callback: ServiceCallback<void>)
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- serviceDescription
- ServiceDescriptionUnion
サービスの作成に必要な情報。
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
createServiceFromTemplate(string, ServiceFromTemplateDescription, ServiceCallback<void>)
function createServiceFromTemplate(applicationId: string, serviceFromTemplateDescription: ServiceFromTemplateDescription, callback: ServiceCallback<void>)
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "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
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- serviceFromTemplateDescription
- ServiceFromTemplateDescription
アプリケーション マニフェストで定義されているテンプレートから作成する必要があるサービスについて説明します。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
createServiceFromTemplate(string, ServiceFromTemplateDescription, ServiceFabricClientCreateServiceFromTemplateOptionalParams, ServiceCallback<void>)
function createServiceFromTemplate(applicationId: string, serviceFromTemplateDescription: ServiceFromTemplateDescription, options: ServiceFabricClientCreateServiceFromTemplateOptionalParams, callback: ServiceCallback<void>)
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- serviceFromTemplateDescription
- ServiceFromTemplateDescription
アプリケーション マニフェストで定義されているテンプレートから作成する必要があるサービスについて説明します。
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
deleteApplication(string, ServiceCallback<void>)
function deleteApplication(applicationId: string, callback: ServiceCallback<void>)
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- callback
-
ServiceCallback<void>
コールバック
deleteApplication(string, ServiceFabricClientDeleteApplicationOptionalParams)
アプリケーションを削除する前に作成する必要があります。 アプリケーションを削除すると、そのアプリケーションの一部であるすべてのサービスが削除されます。 既定では、Service Fabric は正常な方法でサービス レプリカを閉じてから、サービスを削除しようとします。 ただし、サービスでレプリカを正常に閉じる際に問題が発生した場合、削除操作に時間がかかったり、停止したりする可能性があります。 オプションの ForceRemove フラグを使用して、グレースフル クローズ シーケンスをスキップし、アプリケーションとそのすべてのサービスを強制的に削除します。
function deleteApplication(applicationId: string, options?: ServiceFabricClientDeleteApplicationOptionalParams): Promise<RestResponse>
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
deleteApplication(string, ServiceFabricClientDeleteApplicationOptionalParams, ServiceCallback<void>)
function deleteApplication(applicationId: string, options: ServiceFabricClientDeleteApplicationOptionalParams, callback: ServiceCallback<void>)
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
省略可能なパラメーター
- 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
バックアップ ポリシーの名前。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
deleteBackupPolicy(string, ServiceFabricClientDeleteBackupPolicyOptionalParams, ServiceCallback<void>)
function deleteBackupPolicy(backupPolicyName: string, options: ServiceFabricClientDeleteBackupPolicyOptionalParams, callback: ServiceCallback<void>)
パラメーター
- backupPolicyName
-
string
バックアップ ポリシーの名前。
省略可能なパラメーター
- 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
イメージストア内のファイルまたはフォルダのルートからの相対パス。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
deleteImageStoreContent(string, ServiceFabricClientDeleteImageStoreContentOptionalParams, ServiceCallback<void>)
function deleteImageStoreContent(contentPath: string, options: ServiceFabricClientDeleteImageStoreContentOptionalParams, callback: ServiceCallback<void>)
パラメーター
- contentPath
-
string
イメージストア内のファイルまたはフォルダのルートからの相対パス。
省略可能なパラメーター
- 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。 これは、コミットされるまですべてのファイルチャンクを追跡するイメージストアアップロードセッションを識別します。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
deleteImageStoreUploadSession(string, ServiceFabricClientDeleteImageStoreUploadSessionOptionalParams, ServiceCallback<void>)
function deleteImageStoreUploadSession(sessionId: string, options: ServiceFabricClientDeleteImageStoreUploadSessionOptionalParams, callback: ServiceCallback<void>)
パラメーター
- sessionId
-
string
ファイルのアップロードのためにユーザーが生成した GUID。 これは、コミットされるまですべてのファイルチャンクを追跡するイメージストアアップロードセッションを識別します。
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
deleteName(string, ServiceCallback<void>)
function deleteName(nameId: string, callback: ServiceCallback<void>)
パラメーター
- nameId
-
string
'fabric:' URI スキームを含まない Service Fabric 名。
- callback
-
ServiceCallback<void>
コールバック
deleteName(string, ServiceFabricClientDeleteNameOptionalParams)
指定した Service Fabric 名を削除します。 名前を削除する前に、名前を作成する必要があります。 子プロパティを含む名前の削除は失敗します。
function deleteName(nameId: string, options?: ServiceFabricClientDeleteNameOptionalParams): Promise<RestResponse>
パラメーター
- nameId
-
string
'fabric:' URI スキームを含まない Service Fabric 名。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
deleteName(string, ServiceFabricClientDeleteNameOptionalParams, ServiceCallback<void>)
function deleteName(nameId: string, options: ServiceFabricClientDeleteNameOptionalParams, callback: ServiceCallback<void>)
パラメーター
- nameId
-
string
'fabric:' URI スキームを含まない Service Fabric 名。
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
deleteProperty(string, string, ServiceCallback<void>)
function deleteProperty(nameId: string, propertyName: string, callback: ServiceCallback<void>)
パラメーター
- nameId
-
string
'fabric:' URI スキームを含まない Service Fabric 名。
- propertyName
-
string
取得するプロパティの名前を指定します。
- callback
-
ServiceCallback<void>
コールバック
deleteProperty(string, string, ServiceFabricClientDeletePropertyOptionalParams)
指定された名前で指定された Service Fabric プロパティを削除します。 プロパティを削除する前に作成する必要があります。
function deleteProperty(nameId: string, propertyName: string, options?: ServiceFabricClientDeletePropertyOptionalParams): Promise<RestResponse>
パラメーター
- nameId
-
string
'fabric:' URI スキームを含まない Service Fabric 名。
- propertyName
-
string
取得するプロパティの名前を指定します。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
deleteProperty(string, string, ServiceFabricClientDeletePropertyOptionalParams, ServiceCallback<void>)
function deleteProperty(nameId: string, propertyName: string, options: ServiceFabricClientDeletePropertyOptionalParams, callback: ServiceCallback<void>)
パラメーター
- nameId
-
string
'fabric:' URI スキームを含まない Service Fabric 名。
- propertyName
-
string
取得するプロパティの名前を指定します。
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
deleteRepairTask(RepairTaskDeleteDescription, RequestOptionsBase)
この API は Service Fabric プラットフォームをサポートします。コードから直接使用することを意図したものではありません。
function deleteRepairTask(repairTaskDeleteDescription: RepairTaskDeleteDescription, options?: RequestOptionsBase): Promise<RestResponse>
パラメーター
- repairTaskDeleteDescription
- RepairTaskDeleteDescription
削除する修復タスクについて説明します。
- options
- RequestOptionsBase
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<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
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
- callback
-
ServiceCallback<void>
コールバック
deleteService(string, ServiceFabricClientDeleteServiceOptionalParams)
サービスを削除する前に作成する必要があります。 既定では、Service Fabric は正常な方法でサービス レプリカを閉じてから、サービスを削除しようとします。 ただし、サービスでレプリカを正常に閉じる際に問題が発生した場合、削除操作に時間がかかったり、停止したりする可能性があります。 オプションの ForceRemove フラグを使用して、グレースフル クローズ シーケンスをスキップし、サービスを強制的に削除します。
function deleteService(serviceId: string, options?: ServiceFabricClientDeleteServiceOptionalParams): Promise<RestResponse>
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
deleteService(string, ServiceFabricClientDeleteServiceOptionalParams, ServiceCallback<void>)
function deleteService(serviceId: string, options: ServiceFabricClientDeleteServiceOptionalParams, callback: ServiceCallback<void>)
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
省略可能なパラメーター
- 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 ノードにサービス パッケージをデプロイするための情報について説明します。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<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 ノードにサービス パッケージをデプロイするための情報について説明します。
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
disableApplicationBackup(string, ServiceCallback<void>)
function disableApplicationBackup(applicationId: string, callback: ServiceCallback<void>)
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- callback
-
ServiceCallback<void>
コールバック
disableApplicationBackup(string, ServiceFabricClientDisableApplicationBackupOptionalParams)
以前に有効にしていた Service Fabric アプリケーションの定期的なバックアップを無効にします。
function disableApplicationBackup(applicationId: string, options?: ServiceFabricClientDisableApplicationBackupOptionalParams): Promise<RestResponse>
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
disableApplicationBackup(string, ServiceFabricClientDisableApplicationBackupOptionalParams, ServiceCallback<void>)
function disableApplicationBackup(applicationId: string, options: ServiceFabricClientDisableApplicationBackupOptionalParams, callback: ServiceCallback<void>)
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
省略可能なパラメーター
- 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 クラスター ノードを非アクティブ化します。 非アクティブ化が進行中になると、非アクティブ化インテントを増やすことはできますが、減らすことはできません (たとえば、Pause インテントで非アクティブ化されたノードは、Restart でさらに非アクティブ化できますが、その逆はできません)。 ノードは、非アクティブ化された後、いつでも [ノードをアクティブ化] 操作を使用して再アクティブ化できます。 非アクティブ化が完了していない場合、これにより非アクティブ化がキャンセルされます。 非アクティブ化中にダウンして元に戻ったノードは、そのノードにサービスが配置される前に、再アクティブ化する必要があります。
function disableNode(nodeName: string, deactivationIntentDescription: DeactivationIntentDescription, options?: ServiceFabricClientDisableNodeOptionalParams): Promise<RestResponse>
パラメーター
- nodeName
-
string
ノード名。
- deactivationIntentDescription
- DeactivationIntentDescription
ノードを非アクティブ化する意図または理由について説明します。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
disableNode(string, DeactivationIntentDescription, ServiceFabricClientDisableNodeOptionalParams, ServiceCallback<void>)
function disableNode(nodeName: string, deactivationIntentDescription: DeactivationIntentDescription, options: ServiceFabricClientDisableNodeOptionalParams, callback: ServiceCallback<void>)
パラメーター
- nodeName
-
string
ノード名。
- deactivationIntentDescription
- DeactivationIntentDescription
ノードを非アクティブ化する意図または理由について説明します。
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
disablePartitionBackup(string, ServiceCallback<void>)
function disablePartitionBackup(partitionId: string, callback: ServiceCallback<void>)
パラメーター
- partitionId
-
string
パーティションの ID。
- callback
-
ServiceCallback<void>
コールバック
disablePartitionBackup(string, ServiceFabricClientDisablePartitionBackupOptionalParams)
以前に有効にしていたパーティションの定期的なバックアップを無効にします。 バックアップを無効にする前に、明示的に有効にする必要があります。 このパーティションが属する Service Fabric アプリケーションまたはサービスに対してバックアップが有効になっている場合、このパーティションは、上位レベルのエンティティでマップされたポリシーに従って定期的にバックアップされ続けます。
function disablePartitionBackup(partitionId: string, options?: ServiceFabricClientDisablePartitionBackupOptionalParams): Promise<RestResponse>
パラメーター
- partitionId
-
string
パーティションの ID。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
disablePartitionBackup(string, ServiceFabricClientDisablePartitionBackupOptionalParams, ServiceCallback<void>)
function disablePartitionBackup(partitionId: string, options: ServiceFabricClientDisablePartitionBackupOptionalParams, callback: ServiceCallback<void>)
パラメーター
- partitionId
-
string
パーティションの ID。
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
disableServiceBackup(string, ServiceCallback<void>)
function disableServiceBackup(serviceId: string, callback: ServiceCallback<void>)
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
- callback
-
ServiceCallback<void>
コールバック
disableServiceBackup(string, ServiceFabricClientDisableServiceBackupOptionalParams)
以前に有効になっていた Service Fabric サービスの定期的なバックアップを無効にします。 バックアップを無効にする前に、明示的に有効にする必要があります。 このサービスが属する Service Fabric アプリケーションに対してバックアップが有効になっている場合、このサービスは、アプリケーション レベルでマップされたポリシーに従って定期的にバックアップされ続けます。
function disableServiceBackup(serviceId: string, options?: ServiceFabricClientDisableServiceBackupOptionalParams): Promise<RestResponse>
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
disableServiceBackup(string, ServiceFabricClientDisableServiceBackupOptionalParams, ServiceCallback<void>)
function disableServiceBackup(serviceId: string, options: ServiceFabricClientDisableServiceBackupOptionalParams, callback: ServiceCallback<void>)
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
enableApplicationBackup(string, EnableBackupDescription, ServiceCallback<void>)
function enableApplicationBackup(applicationId: string, enableBackupDescription: EnableBackupDescription, callback: ServiceCallback<void>)
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- enableBackupDescription
- EnableBackupDescription
バックアップを有効にするためのパラメータを指定します。
- callback
-
ServiceCallback<void>
コールバック
enableApplicationBackup(string, EnableBackupDescription, ServiceFabricClientEnableApplicationBackupOptionalParams)
この Service Fabric アプリケーションの一部であるステートフル パーティションの定期的なバックアップを有効にします。 各パーティションは、指定されたバックアップポリシーの説明に従って個別にバックアップされます。 注: 現在、定期的なバックアップでは、C# ベースの Reliable Actor サービスと Reliable Stateful サービスのみがサポートされています。
function enableApplicationBackup(applicationId: string, enableBackupDescription: EnableBackupDescription, options?: ServiceFabricClientEnableApplicationBackupOptionalParams): Promise<RestResponse>
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- enableBackupDescription
- EnableBackupDescription
バックアップを有効にするためのパラメータを指定します。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
enableApplicationBackup(string, EnableBackupDescription, ServiceFabricClientEnableApplicationBackupOptionalParams, ServiceCallback<void>)
function enableApplicationBackup(applicationId: string, enableBackupDescription: EnableBackupDescription, options: ServiceFabricClientEnableApplicationBackupOptionalParams, callback: ServiceCallback<void>)
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- enableBackupDescription
- EnableBackupDescription
バックアップを有効にするためのパラメータを指定します。
省略可能なパラメーター
- 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
ノード名。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
enableNode(string, ServiceFabricClientEnableNodeOptionalParams, ServiceCallback<void>)
function enableNode(nodeName: string, options: ServiceFabricClientEnableNodeOptionalParams, callback: ServiceCallback<void>)
パラメーター
- nodeName
-
string
ノード名。
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
enablePartitionBackup(string, EnableBackupDescription, ServiceCallback<void>)
function enablePartitionBackup(partitionId: string, enableBackupDescription: EnableBackupDescription, callback: ServiceCallback<void>)
パラメーター
- partitionId
-
string
パーティションの ID。
- enableBackupDescription
- EnableBackupDescription
バックアップを有効にするためのパラメータを指定します。
- callback
-
ServiceCallback<void>
コールバック
enablePartitionBackup(string, EnableBackupDescription, ServiceFabricClientEnablePartitionBackupOptionalParams)
ステートフル永続パーティションの定期的なバックアップを有効にします。 各パーティションは、指定されたバックアップポリシーの説明に従ってバックアップされます。 パーティションが属するアプリケーションまたはサービスが既にバックアップが有効になっている場合、この操作は、このパーティションの定期的なバックアップを行うために使用されているポリシーをオーバーライドします。 注: 現在、定期的なバックアップでは、C# ベースの Reliable Actor サービスと Reliable Stateful サービスのみがサポートされています。
function enablePartitionBackup(partitionId: string, enableBackupDescription: EnableBackupDescription, options?: ServiceFabricClientEnablePartitionBackupOptionalParams): Promise<RestResponse>
パラメーター
- partitionId
-
string
パーティションの ID。
- enableBackupDescription
- EnableBackupDescription
バックアップを有効にするためのパラメータを指定します。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
enablePartitionBackup(string, EnableBackupDescription, ServiceFabricClientEnablePartitionBackupOptionalParams, ServiceCallback<void>)
function enablePartitionBackup(partitionId: string, enableBackupDescription: EnableBackupDescription, options: ServiceFabricClientEnablePartitionBackupOptionalParams, callback: ServiceCallback<void>)
パラメーター
- partitionId
-
string
パーティションの ID。
- enableBackupDescription
- EnableBackupDescription
バックアップを有効にするためのパラメータを指定します。
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
enableServiceBackup(string, EnableBackupDescription, ServiceCallback<void>)
function enableServiceBackup(serviceId: string, enableBackupDescription: EnableBackupDescription, callback: ServiceCallback<void>)
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
- enableBackupDescription
- EnableBackupDescription
バックアップを有効にするためのパラメータを指定します。
- callback
-
ServiceCallback<void>
コールバック
enableServiceBackup(string, EnableBackupDescription, ServiceFabricClientEnableServiceBackupOptionalParams)
この Service Fabric サービスの一部であるステートフル パーティションの定期的なバックアップを有効にします。 各パーティションは、指定されたバックアップポリシーの説明に従って個別にバックアップされます。 サービスが属するアプリケーションが既にバックアップが有効になっている場合、この操作は、このサービスとそのパーティションの定期的なバックアップを作成するために使用されるポリシーをオーバーライドします (パーティション レベルで明示的にオーバーライドされない限り)。 注: 現在、定期的なバックアップでは、C# ベースの Reliable Actor サービスと Reliable Stateful サービスのみがサポートされています。
function enableServiceBackup(serviceId: string, enableBackupDescription: EnableBackupDescription, options?: ServiceFabricClientEnableServiceBackupOptionalParams): Promise<RestResponse>
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
- enableBackupDescription
- EnableBackupDescription
バックアップを有効にするためのパラメータを指定します。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
enableServiceBackup(string, EnableBackupDescription, ServiceFabricClientEnableServiceBackupOptionalParams, ServiceCallback<void>)
function enableServiceBackup(serviceId: string, enableBackupDescription: EnableBackupDescription, options: ServiceFabricClientEnableServiceBackupOptionalParams, callback: ServiceCallback<void>)
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
- enableBackupDescription
- EnableBackupDescription
バックアップを有効にするためのパラメータを指定します。
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
forceApproveRepairTask(RepairTaskApproveDescription, RequestOptionsBase)
この API は Service Fabric プラットフォームをサポートします。コードから直接使用することを意図したものではありません。
function forceApproveRepairTask(repairTaskApproveDescription: RepairTaskApproveDescription, options?: RequestOptionsBase): Promise<ForceApproveRepairTaskResponse>
パラメーター
- repairTaskApproveDescription
- RepairTaskApproveDescription
承認される修復タスクについて説明します。
- options
- RequestOptionsBase
省略可能なパラメーター
戻り値
Promise<ForceApproveRepairTaskResponse>
Promise<Models.ForceApproveRepairTaskResponse>
forceApproveRepairTask(RepairTaskApproveDescription, RequestOptionsBase, ServiceCallback<RepairTaskUpdateInfo>)
function forceApproveRepairTask(repairTaskApproveDescription: RepairTaskApproveDescription, options: RequestOptionsBase, callback: ServiceCallback<RepairTaskUpdateInfo>)
パラメーター
- repairTaskApproveDescription
- RepairTaskApproveDescription
承認される修復タスクについて説明します。
- options
- RequestOptionsBase
省略可能なパラメーター
- callback
コールバック
forceApproveRepairTask(RepairTaskApproveDescription, ServiceCallback<RepairTaskUpdateInfo>)
function forceApproveRepairTask(repairTaskApproveDescription: RepairTaskApproveDescription, callback: ServiceCallback<RepairTaskUpdateInfo>)
パラメーター
- repairTaskApproveDescription
- RepairTaskApproveDescription
承認される修復タスクについて説明します。
- callback
コールバック
getAadMetadata(ServiceCallback<AadMetadataObject>)
function getAadMetadata(callback: ServiceCallback<AadMetadataObject>)
パラメーター
- callback
コールバック
getAadMetadata(ServiceFabricClientGetAadMetadataOptionalParams)
クラスターへのセキュリティで保護された接続に使用される Azure Active Directory メタデータを取得します。 この API は個別に呼び出されるべきではありません。 Service Fabric クラスターとの Azure Active Directory でセキュリティで保護された接続を設定するために必要な情報を提供します。
function getAadMetadata(options?: ServiceFabricClientGetAadMetadataOptionalParams): Promise<GetAadMetadataResponse>
パラメーター
省略可能なパラメーター
戻り値
Promise<GetAadMetadataResponse>
Promise<Models.GetAadMetadataResponse>
getAadMetadata(ServiceFabricClientGetAadMetadataOptionalParams, ServiceCallback<AadMetadataObject>)
function getAadMetadata(options: ServiceFabricClientGetAadMetadataOptionalParams, callback: ServiceCallback<AadMetadataObject>)
パラメーター
省略可能なパラメーター
- callback
コールバック
getAllEntitiesBackedUpByPolicy(string, ServiceCallback<PagedBackupEntityList>)
function getAllEntitiesBackedUpByPolicy(backupPolicyName: string, callback: ServiceCallback<PagedBackupEntityList>)
パラメーター
- backupPolicyName
-
string
バックアップ ポリシーの名前。
- callback
コールバック
getAllEntitiesBackedUpByPolicy(string, ServiceFabricClientGetAllEntitiesBackedUpByPolicyOptionalParams)
このバックアップ ポリシーに関連付けられている Service Fabric アプリケーション、サービス、またはパーティションの一覧を返します。
function getAllEntitiesBackedUpByPolicy(backupPolicyName: string, options?: ServiceFabricClientGetAllEntitiesBackedUpByPolicyOptionalParams): Promise<GetAllEntitiesBackedUpByPolicyResponse>
パラメーター
- backupPolicyName
-
string
バックアップ ポリシーの名前。
省略可能なパラメーター
戻り値
Promise<Models.GetAllEntitiesBackedUpByPolicyResponse>
getAllEntitiesBackedUpByPolicy(string, ServiceFabricClientGetAllEntitiesBackedUpByPolicyOptionalParams, ServiceCallback<PagedBackupEntityList>)
function getAllEntitiesBackedUpByPolicy(backupPolicyName: string, options: ServiceFabricClientGetAllEntitiesBackedUpByPolicyOptionalParams, callback: ServiceCallback<PagedBackupEntityList>)
パラメーター
- backupPolicyName
-
string
バックアップ ポリシーの名前。
省略可能なパラメーター
- callback
コールバック
getApplicationBackupConfigurationInfo(string, ServiceCallback<PagedBackupConfigurationInfoList>)
function getApplicationBackupConfigurationInfo(applicationId: string, callback: ServiceCallback<PagedBackupConfigurationInfoList>)
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
コールバック
getApplicationBackupConfigurationInfo(string, ServiceFabricClientGetApplicationBackupConfigurationInfoOptionalParams)
アプリケーションと、このアプリケーションの下にあるサービスとパーティションの Service Fabric バックアップ構成情報を取得します。
function getApplicationBackupConfigurationInfo(applicationId: string, options?: ServiceFabricClientGetApplicationBackupConfigurationInfoOptionalParams): Promise<GetApplicationBackupConfigurationInfoResponse>
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
省略可能なパラメーター
戻り値
Promise<Models.GetApplicationBackupConfigurationInfoResponse応答>
getApplicationBackupConfigurationInfo(string, ServiceFabricClientGetApplicationBackupConfigurationInfoOptionalParams, ServiceCallback<PagedBackupConfigurationInfoList>)
function getApplicationBackupConfigurationInfo(applicationId: string, options: ServiceFabricClientGetApplicationBackupConfigurationInfoOptionalParams, callback: ServiceCallback<PagedBackupConfigurationInfoList>)
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
省略可能なパラメーター
コールバック
getApplicationBackupList(string, ServiceCallback<PagedBackupInfoList>)
function getApplicationBackupList(applicationId: string, callback: ServiceCallback<PagedBackupInfoList>)
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- callback
コールバック
getApplicationBackupList(string, ServiceFabricClientGetApplicationBackupListOptionalParams)
この Service Fabric アプリケーション内のすべてのパーティションで使用できるバックアップの一覧を返します。 サーバーは、バックアップ ポリシーで構成されたバックアップの場所で使用可能なすべてのバックアップを列挙します。 また、start と end datetime に基づいて結果をフィルター処理したり、すべてのパーティションで使用可能な最新のバックアップをフェッチしたりすることもできます。
function getApplicationBackupList(applicationId: string, options?: ServiceFabricClientGetApplicationBackupListOptionalParams): Promise<GetApplicationBackupListResponse>
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
省略可能なパラメーター
戻り値
Promise<GetApplicationBackupListResponse>
Promise<Models.GetApplicationBackupListResponse>
getApplicationBackupList(string, ServiceFabricClientGetApplicationBackupListOptionalParams, ServiceCallback<PagedBackupInfoList>)
function getApplicationBackupList(applicationId: string, options: ServiceFabricClientGetApplicationBackupListOptionalParams, callback: ServiceCallback<PagedBackupInfoList>)
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
省略可能なパラメーター
- callback
コールバック
getApplicationEventList(string, string, string, ServiceCallback<ApplicationEventUnion[]>)
function getApplicationEventList(applicationId: string, startTimeUtc: string, endTimeUtc: string, callback: ServiceCallback<ApplicationEventUnion[]>)
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- startTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの開始時刻。
- endTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの終了時刻。
- callback
コールバック
getApplicationEventList(string, string, string, ServiceFabricClientGetApplicationEventListOptionalParams)
応答は ApplicationEvent オブジェクトのリストです。
function getApplicationEventList(applicationId: string, startTimeUtc: string, endTimeUtc: string, options?: ServiceFabricClientGetApplicationEventListOptionalParams): Promise<GetApplicationEventListResponse>
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- startTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの開始時刻。
- endTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの終了時刻。
省略可能なパラメーター
戻り値
Promise<GetApplicationEventListResponse>
Promise<Models.GetApplicationEventListResponse応答>
getApplicationEventList(string, string, string, ServiceFabricClientGetApplicationEventListOptionalParams, ServiceCallback<ApplicationEventUnion[]>)
function getApplicationEventList(applicationId: string, startTimeUtc: string, endTimeUtc: string, options: ServiceFabricClientGetApplicationEventListOptionalParams, callback: ServiceCallback<ApplicationEventUnion[]>)
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- startTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの開始時刻。
- endTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの終了時刻。
省略可能なパラメーター
- callback
コールバック
getApplicationHealth(string, ServiceCallback<ApplicationHealth>)
function getApplicationHealth(applicationId: string, callback: ServiceCallback<ApplicationHealth>)
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- callback
コールバック
getApplicationHealth(string, ServiceFabricClientGetApplicationHealthOptionalParams)
Service Fabric アプリケーションの正常状態を返します。 応答は、Ok、Error、または Warning の正常性状態を報告します。 エンティティが正常性ストアに見つからない場合は、エラーが返されます。
function getApplicationHealth(applicationId: string, options?: ServiceFabricClientGetApplicationHealthOptionalParams): Promise<GetApplicationHealthResponse>
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
省略可能なパラメーター
戻り値
Promise<GetApplicationHealthResponse>
Promise<Models.GetApplicationHealthResponse>
getApplicationHealth(string, ServiceFabricClientGetApplicationHealthOptionalParams, ServiceCallback<ApplicationHealth>)
function getApplicationHealth(applicationId: string, options: ServiceFabricClientGetApplicationHealthOptionalParams, callback: ServiceCallback<ApplicationHealth>)
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
省略可能なパラメーター
- callback
コールバック
getApplicationHealthUsingPolicy(string, ServiceCallback<ApplicationHealth>)
function getApplicationHealthUsingPolicy(applicationId: string, callback: ServiceCallback<ApplicationHealth>)
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- callback
コールバック
getApplicationHealthUsingPolicy(string, ServiceFabricClientGetApplicationHealthUsingPolicyOptionalParams)
Service Fabric アプリケーションの正常性を取得します。 EventsHealthStateFilter を使用して、正常性状態に基づいてノードで報告される正常性イベントのコレクションをフィルター処理します。 ClusterHealthPolicies を使用して、正常性の評価に使用される正常性ポリシーをオーバーライドします。
function getApplicationHealthUsingPolicy(applicationId: string, options?: ServiceFabricClientGetApplicationHealthUsingPolicyOptionalParams): Promise<GetApplicationHealthUsingPolicyResponse>
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
省略可能なパラメーター
戻り値
Promise<Models.GetApplicationHealthUsingPolicyResponse>
getApplicationHealthUsingPolicy(string, ServiceFabricClientGetApplicationHealthUsingPolicyOptionalParams, ServiceCallback<ApplicationHealth>)
function getApplicationHealthUsingPolicy(applicationId: string, options: ServiceFabricClientGetApplicationHealthUsingPolicyOptionalParams, callback: ServiceCallback<ApplicationHealth>)
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
省略可能なパラメーター
- callback
コールバック
getApplicationInfo(string, ServiceCallback<ApplicationInfo>)
function getApplicationInfo(applicationId: string, callback: ServiceCallback<ApplicationInfo>)
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- callback
コールバック
getApplicationInfo(string, ServiceFabricClientGetApplicationInfoOptionalParams)
Service Fabric クラスターで作成された、または作成中で、名前がパラメーターとして指定されたものと一致するアプリケーションに関する情報を返します。 応答には、アプリケーションに関する名前、タイプ、ステータス、パラメータ、およびその他の詳細が含まれます。
function getApplicationInfo(applicationId: string, options?: ServiceFabricClientGetApplicationInfoOptionalParams): Promise<GetApplicationInfoResponse>
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
省略可能なパラメーター
戻り値
Promise<GetApplicationInfoResponse>
Promise<Models.GetApplicationInfoResponse>
getApplicationInfo(string, ServiceFabricClientGetApplicationInfoOptionalParams, ServiceCallback<ApplicationInfo>)
function getApplicationInfo(applicationId: string, options: ServiceFabricClientGetApplicationInfoOptionalParams, callback: ServiceCallback<ApplicationInfo>)
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
省略可能なパラメーター
- callback
コールバック
getApplicationInfoList(ServiceCallback<PagedApplicationInfoList>)
function getApplicationInfoList(callback: ServiceCallback<PagedApplicationInfoList>)
パラメーター
- callback
コールバック
getApplicationInfoList(ServiceFabricClientGetApplicationInfoListOptionalParams)
Service Fabric クラスターで作成された、または作成中のアプリケーションに関する情報を取得し、指定されたフィルターに一致します。 応答には、アプリケーションに関する名前、タイプ、ステータス、パラメータ、およびその他の詳細が含まれます。 アプリケーションがページに収まらない場合は、結果の 1 ページと継続トークンが返され、次のページの取得に使用できます。 フィルター ApplicationTypeName と ApplicationDefinitionKindFilter を同時に指定することはできません。
function getApplicationInfoList(options?: ServiceFabricClientGetApplicationInfoListOptionalParams): Promise<GetApplicationInfoListResponse>
パラメーター
省略可能なパラメーター
戻り値
Promise<GetApplicationInfoListResponse>
Promise<Models.GetApplicationInfoListResponse応答>
getApplicationInfoList(ServiceFabricClientGetApplicationInfoListOptionalParams, ServiceCallback<PagedApplicationInfoList>)
function getApplicationInfoList(options: ServiceFabricClientGetApplicationInfoListOptionalParams, callback: ServiceCallback<PagedApplicationInfoList>)
パラメーター
省略可能なパラメーター
- callback
コールバック
getApplicationLoadInfo(string, ServiceCallback<ApplicationLoadInfo>)
function getApplicationLoadInfo(applicationId: string, callback: ServiceCallback<ApplicationLoadInfo>)
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- callback
コールバック
getApplicationLoadInfo(string, ServiceFabricClientGetApplicationLoadInfoOptionalParams)
Service Fabric クラスターで作成された、または作成中で、名前がパラメーターとして指定されたアプリケーションと一致するアプリケーションに関する読み込み情報を返します。 応答には、名前、最小ノード数、最大ノード数、アプリケーションが現在占有しているノード数、およびアプリケーションに関するアプリケーション負荷メトリック情報が含まれます。
function getApplicationLoadInfo(applicationId: string, options?: ServiceFabricClientGetApplicationLoadInfoOptionalParams): Promise<GetApplicationLoadInfoResponse>
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
省略可能なパラメーター
戻り値
Promise<GetApplicationLoadInfoResponse>
Promise<Models.GetApplicationLoadInfoResponse>
getApplicationLoadInfo(string, ServiceFabricClientGetApplicationLoadInfoOptionalParams, ServiceCallback<ApplicationLoadInfo>)
function getApplicationLoadInfo(applicationId: string, options: ServiceFabricClientGetApplicationLoadInfoOptionalParams, callback: ServiceCallback<ApplicationLoadInfo>)
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
省略可能なパラメーター
- callback
コールバック
getApplicationManifest(string, string, ServiceCallback<ApplicationTypeManifest>)
function getApplicationManifest(applicationTypeName: string, applicationTypeVersion: string, callback: ServiceCallback<ApplicationTypeManifest>)
パラメーター
- applicationTypeName
-
string
アプリケーションの種類の名前。
- applicationTypeVersion
-
string
アプリケーションの種類のバージョン。
- callback
コールバック
getApplicationManifest(string, string, ServiceFabricClientGetApplicationManifestOptionalParams)
応答には、アプリケーション マニフェスト XML が文字列として含まれています。
function getApplicationManifest(applicationTypeName: string, applicationTypeVersion: string, options?: ServiceFabricClientGetApplicationManifestOptionalParams): Promise<GetApplicationManifestResponse>
パラメーター
- applicationTypeName
-
string
アプリケーションの種類の名前。
- applicationTypeVersion
-
string
アプリケーションの種類のバージョン。
省略可能なパラメーター
戻り値
Promise<GetApplicationManifestResponse>
Promise<Models.GetApplicationManifestResponse応答>
getApplicationManifest(string, string, ServiceFabricClientGetApplicationManifestOptionalParams, ServiceCallback<ApplicationTypeManifest>)
function getApplicationManifest(applicationTypeName: string, applicationTypeVersion: string, options: ServiceFabricClientGetApplicationManifestOptionalParams, callback: ServiceCallback<ApplicationTypeManifest>)
パラメーター
- applicationTypeName
-
string
アプリケーションの種類の名前。
- applicationTypeVersion
-
string
アプリケーションの種類のバージョン。
省略可能なパラメーター
- callback
コールバック
getApplicationNameInfo(string, ServiceCallback<ApplicationNameInfo>)
function getApplicationNameInfo(serviceId: string, callback: ServiceCallback<ApplicationNameInfo>)
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
- callback
コールバック
getApplicationNameInfo(string, ServiceFabricClientGetApplicationNameInfoOptionalParams)
指定したサービスのアプリケーションの名前を取得します。 指定されたサービス ID を持つサービスが存在しない場合は、404 FABRIC_E_SERVICE_DOES_NOT_EXIST エラーが返されます。
function getApplicationNameInfo(serviceId: string, options?: ServiceFabricClientGetApplicationNameInfoOptionalParams): Promise<GetApplicationNameInfoResponse>
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
省略可能なパラメーター
戻り値
Promise<GetApplicationNameInfoResponse>
Promise<Models.GetApplicationNameInfoResponse応答>
getApplicationNameInfo(string, ServiceFabricClientGetApplicationNameInfoOptionalParams, ServiceCallback<ApplicationNameInfo>)
function getApplicationNameInfo(serviceId: string, options: ServiceFabricClientGetApplicationNameInfoOptionalParams, callback: ServiceCallback<ApplicationNameInfo>)
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
省略可能なパラメーター
- callback
コールバック
getApplicationsEventList(string, string, ServiceCallback<ApplicationEventUnion[]>)
function getApplicationsEventList(startTimeUtc: string, endTimeUtc: string, callback: ServiceCallback<ApplicationEventUnion[]>)
パラメーター
- startTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの開始時刻。
- endTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの終了時刻。
- callback
コールバック
getApplicationsEventList(string, string, ServiceFabricClientGetApplicationsEventListOptionalParams)
応答は ApplicationEvent オブジェクトのリストです。
function getApplicationsEventList(startTimeUtc: string, endTimeUtc: string, options?: ServiceFabricClientGetApplicationsEventListOptionalParams): Promise<GetApplicationsEventListResponse>
パラメーター
- startTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの開始時刻。
- endTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの終了時刻。
省略可能なパラメーター
戻り値
Promise<GetApplicationsEventListResponse>
Promise<Models.GetApplicationsEventListResponse>
getApplicationsEventList(string, string, ServiceFabricClientGetApplicationsEventListOptionalParams, ServiceCallback<ApplicationEventUnion[]>)
function getApplicationsEventList(startTimeUtc: string, endTimeUtc: string, options: ServiceFabricClientGetApplicationsEventListOptionalParams, callback: ServiceCallback<ApplicationEventUnion[]>)
パラメーター
- startTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの開始時刻。
- endTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの終了時刻。
省略可能なパラメーター
- callback
コールバック
getApplicationTypeInfoList(ServiceCallback<PagedApplicationTypeInfoList>)
function getApplicationTypeInfoList(callback: ServiceCallback<PagedApplicationTypeInfoList>)
パラメーター
- callback
コールバック
getApplicationTypeInfoList(ServiceFabricClientGetApplicationTypeInfoListOptionalParams)
Service Fabric クラスターでプロビジョニングされている、またはプロビジョニング処理中のアプリケーションの種類に関する情報を返します。 アプリケーションタイプの各バージョンは、1つのアプリケーションタイプとして返されます。 応答には、名前、バージョン、ステータス、およびアプリケーションの種類に関するその他の詳細が含まれます。 これはページングされたクエリであり、すべてのアプリケーションの種類がページに収まらない場合は、結果の 1 ページと、次のページの取得に使用できる継続トークンが返されます。 たとえば、アプリケーションの種類が 10 個あるが、ページが最初の 3 つのアプリケーションの種類にしか適合しない場合、または max results が 3 に設定されている場合は、3 つが返されます。 残りの結果にアクセスするには、次のクエリで返された継続トークンを使用して後続のページを取得します。 後続のページがない場合は、空の継続トークンが返されます。
function getApplicationTypeInfoList(options?: ServiceFabricClientGetApplicationTypeInfoListOptionalParams): Promise<GetApplicationTypeInfoListResponse>
パラメーター
省略可能なパラメーター
戻り値
Promise<GetApplicationTypeInfoListResponse>
Promise<Models.GetApplicationTypeInfoListResponse応答>
getApplicationTypeInfoList(ServiceFabricClientGetApplicationTypeInfoListOptionalParams, ServiceCallback<PagedApplicationTypeInfoList>)
function getApplicationTypeInfoList(options: ServiceFabricClientGetApplicationTypeInfoListOptionalParams, callback: ServiceCallback<PagedApplicationTypeInfoList>)
パラメーター
省略可能なパラメーター
- callback
コールバック
getApplicationTypeInfoListByName(string, ServiceCallback<PagedApplicationTypeInfoList>)
function getApplicationTypeInfoListByName(applicationTypeName: string, callback: ServiceCallback<PagedApplicationTypeInfoList>)
パラメーター
- applicationTypeName
-
string
アプリケーションの種類の名前。
- callback
コールバック
getApplicationTypeInfoListByName(string, ServiceFabricClientGetApplicationTypeInfoListByNameOptionalParams)
Service Fabric クラスターでプロビジョニングされている、またはプロビジョニング処理中のアプリケーションの種類に関する情報を返します。 これらの結果は、名前がパラメータとして指定された名前と完全に一致し、指定されたクエリパラメータに準拠するアプリケーションタイプのものです。 アプリケーションの種類名に一致するアプリケーションの種類のすべてのバージョンが返され、各バージョンは 1 つのアプリケーションの種類として返されます。 応答には、名前、バージョン、ステータス、およびアプリケーションの種類に関するその他の詳細が含まれます。 これはページングされたクエリであり、すべてのアプリケーションの種類がページに収まらない場合は、結果の 1 ページと、次のページの取得に使用できる継続トークンが返されます。 たとえば、アプリケーションの種類が 10 個あるが、ページが最初の 3 つのアプリケーションの種類にしか適合しない場合、または max results が 3 に設定されている場合は、3 つが返されます。 残りの結果にアクセスするには、次のクエリで返された継続トークンを使用して後続のページを取得します。 後続のページがない場合は、空の継続トークンが返されます。
function getApplicationTypeInfoListByName(applicationTypeName: string, options?: ServiceFabricClientGetApplicationTypeInfoListByNameOptionalParams): Promise<GetApplicationTypeInfoListByNameResponse>
パラメーター
- applicationTypeName
-
string
アプリケーションの種類の名前。
省略可能なパラメーター
戻り値
Promise<Models.GetApplicationTypeInfoListByNameResponse応答>
getApplicationTypeInfoListByName(string, ServiceFabricClientGetApplicationTypeInfoListByNameOptionalParams, ServiceCallback<PagedApplicationTypeInfoList>)
function getApplicationTypeInfoListByName(applicationTypeName: string, options: ServiceFabricClientGetApplicationTypeInfoListByNameOptionalParams, callback: ServiceCallback<PagedApplicationTypeInfoList>)
パラメーター
- applicationTypeName
-
string
アプリケーションの種類の名前。
省略可能なパラメーター
- callback
コールバック
getApplicationUpgrade(string, ServiceCallback<ApplicationUpgradeProgressInfo>)
function getApplicationUpgrade(applicationId: string, callback: ServiceCallback<ApplicationUpgradeProgressInfo>)
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
コールバック
getApplicationUpgrade(string, ServiceFabricClientGetApplicationUpgradeOptionalParams)
最新のアプリケーション アップグレードの状態に関する情報と、アプリケーションの正常性の問題のデバッグに役立つ詳細を返します。
function getApplicationUpgrade(applicationId: string, options?: ServiceFabricClientGetApplicationUpgradeOptionalParams): Promise<GetApplicationUpgradeResponse>
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
省略可能なパラメーター
戻り値
Promise<GetApplicationUpgradeResponse>
Promise<Models.GetApplicationUpgradeResponseです。>
getApplicationUpgrade(string, ServiceFabricClientGetApplicationUpgradeOptionalParams, ServiceCallback<ApplicationUpgradeProgressInfo>)
function getApplicationUpgrade(applicationId: string, options: ServiceFabricClientGetApplicationUpgradeOptionalParams, callback: ServiceCallback<ApplicationUpgradeProgressInfo>)
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
省略可能なパラメーター
コールバック
getBackupPolicyByName(string, ServiceCallback<BackupPolicyDescription>)
function getBackupPolicyByName(backupPolicyName: string, callback: ServiceCallback<BackupPolicyDescription>)
パラメーター
- backupPolicyName
-
string
バックアップ ポリシーの名前。
- callback
コールバック
getBackupPolicyByName(string, ServiceFabricClientGetBackupPolicyByNameOptionalParams)
{backupPolicyName} で識別される特定のバックアップ ポリシーを取得します。
function getBackupPolicyByName(backupPolicyName: string, options?: ServiceFabricClientGetBackupPolicyByNameOptionalParams): Promise<GetBackupPolicyByNameResponse>
パラメーター
- backupPolicyName
-
string
バックアップ ポリシーの名前。
省略可能なパラメーター
戻り値
Promise<GetBackupPolicyByNameResponse>
Promise<Models.GetBackupPolicyByName応答>
getBackupPolicyByName(string, ServiceFabricClientGetBackupPolicyByNameOptionalParams, ServiceCallback<BackupPolicyDescription>)
function getBackupPolicyByName(backupPolicyName: string, options: ServiceFabricClientGetBackupPolicyByNameOptionalParams, callback: ServiceCallback<BackupPolicyDescription>)
パラメーター
- backupPolicyName
-
string
バックアップ ポリシーの名前。
省略可能なパラメーター
- callback
コールバック
getBackupPolicyList(ServiceCallback<PagedBackupPolicyDescriptionList>)
function getBackupPolicyList(callback: ServiceCallback<PagedBackupPolicyDescriptionList>)
パラメーター
コールバック
getBackupPolicyList(ServiceFabricClientGetBackupPolicyListOptionalParams)
構成されているすべてのバックアップ ポリシーのリストを取得します。
function getBackupPolicyList(options?: ServiceFabricClientGetBackupPolicyListOptionalParams): Promise<GetBackupPolicyListResponse>
パラメーター
省略可能なパラメーター
戻り値
Promise<GetBackupPolicyListResponse>
Promise<Models.GetBackupPolicyListResponse応答>
getBackupPolicyList(ServiceFabricClientGetBackupPolicyListOptionalParams, ServiceCallback<PagedBackupPolicyDescriptionList>)
function getBackupPolicyList(options: ServiceFabricClientGetBackupPolicyListOptionalParams, callback: ServiceCallback<PagedBackupPolicyDescriptionList>)
パラメーター
省略可能なパラメーター
コールバック
getBackupsFromBackupLocation(GetBackupByStorageQueryDescription, ServiceCallback<PagedBackupInfoList>)
function getBackupsFromBackupLocation(getBackupByStorageQueryDescription: GetBackupByStorageQueryDescription, callback: ServiceCallback<PagedBackupInfoList>)
パラメーター
- getBackupByStorageQueryDescription
- GetBackupByStorageQueryDescription
バックアップの列挙に使用するフィルターとバックアップ ストレージの詳細について説明します。
- callback
コールバック
getBackupsFromBackupLocation(GetBackupByStorageQueryDescription, ServiceFabricClientGetBackupsFromBackupLocationOptionalParams)
指定されたバックアップの場所 (FileShare または Azure Blob Storage) で、指定されたバックアップ エンティティ (アプリケーション、サービス、またはパーティション) で使用できるバックアップの一覧を取得します。
function getBackupsFromBackupLocation(getBackupByStorageQueryDescription: GetBackupByStorageQueryDescription, options?: ServiceFabricClientGetBackupsFromBackupLocationOptionalParams): Promise<GetBackupsFromBackupLocationResponse>
パラメーター
- getBackupByStorageQueryDescription
- GetBackupByStorageQueryDescription
バックアップの列挙に使用するフィルターとバックアップ ストレージの詳細について説明します。
省略可能なパラメーター
戻り値
Promise<GetBackupsFromBackupLocationResponse>
Promise<Models.GetBackupsFromBackupLocationResponseです。>
getBackupsFromBackupLocation(GetBackupByStorageQueryDescription, ServiceFabricClientGetBackupsFromBackupLocationOptionalParams, ServiceCallback<PagedBackupInfoList>)
function getBackupsFromBackupLocation(getBackupByStorageQueryDescription: GetBackupByStorageQueryDescription, options: ServiceFabricClientGetBackupsFromBackupLocationOptionalParams, callback: ServiceCallback<PagedBackupInfoList>)
パラメーター
- getBackupByStorageQueryDescription
- GetBackupByStorageQueryDescription
バックアップの列挙に使用するフィルターとバックアップ ストレージの詳細について説明します。
省略可能なパラメーター
- callback
コールバック
getChaos(ServiceCallback<Chaos>)
getChaos(ServiceFabricClientGetChaosOptionalParams)
Chaos が実行されているかどうかを示す Chaos の状態、Chaos の実行に使用される Chaos パラメーター、および Chaos スケジュールの状態を取得します。
function getChaos(options?: ServiceFabricClientGetChaosOptionalParams): Promise<GetChaosResponse>
パラメーター
省略可能なパラメーター
戻り値
Promise<GetChaosResponse>
Promise<Models.GetChaosResponse>
getChaos(ServiceFabricClientGetChaosOptionalParams, ServiceCallback<Chaos>)
function getChaos(options: ServiceFabricClientGetChaosOptionalParams, callback: ServiceCallback<Chaos>)
パラメーター
省略可能なパラメーター
- callback
コールバック
getChaosEvents(ServiceCallback<ChaosEventsSegment>)
function getChaosEvents(callback: ServiceCallback<ChaosEventsSegment>)
パラメーター
- callback
コールバック
getChaosEvents(ServiceFabricClientGetChaosEventsOptionalParams)
Chaos イベントの次のセグメントを取得するには、ContinuationToken を指定します。 Chaos イベントの新しいセグメントの開始を取得するには、StartTimeUtc と EndTimeUtc を使用して時間範囲を指定します。 同じ呼び出しで ContinuationToken と時間範囲の両方を指定することはできません。 Chaos イベントが 100 を超える場合、Chaos イベントは、セグメントに含まれる Chaos イベントが 100 個以下の複数のセグメントで返され、次のセグメントを取得するには、継続トークンを使用してこの API を呼び出します。
function getChaosEvents(options?: ServiceFabricClientGetChaosEventsOptionalParams): Promise<GetChaosEventsResponse>
パラメーター
省略可能なパラメーター
戻り値
Promise<GetChaosEventsResponse>
Promise<Models.GetChaosEventsResponseの>
getChaosEvents(ServiceFabricClientGetChaosEventsOptionalParams, ServiceCallback<ChaosEventsSegment>)
function getChaosEvents(options: ServiceFabricClientGetChaosEventsOptionalParams, callback: ServiceCallback<ChaosEventsSegment>)
パラメーター
省略可能なパラメーター
- callback
コールバック
getChaosSchedule(ServiceCallback<ChaosScheduleDescription>)
function getChaosSchedule(callback: ServiceCallback<ChaosScheduleDescription>)
パラメーター
- callback
コールバック
getChaosSchedule(ServiceFabricClientGetChaosScheduleOptionalParams)
使用中のカオス スケジュールのバージョンと、カオスを実行するタイミングと方法を定義するカオス スケジュールを取得します。
function getChaosSchedule(options?: ServiceFabricClientGetChaosScheduleOptionalParams): Promise<GetChaosScheduleResponse>
パラメーター
省略可能なパラメーター
戻り値
Promise<GetChaosScheduleResponse>
Promise<Models.GetChaosScheduleResponse>
getChaosSchedule(ServiceFabricClientGetChaosScheduleOptionalParams, ServiceCallback<ChaosScheduleDescription>)
function getChaosSchedule(options: ServiceFabricClientGetChaosScheduleOptionalParams, callback: ServiceCallback<ChaosScheduleDescription>)
パラメーター
省略可能なパラメーター
- callback
コールバック
getClusterConfiguration(string, ServiceCallback<ClusterConfiguration>)
function getClusterConfiguration(configurationApiVersion: string, callback: ServiceCallback<ClusterConfiguration>)
パラメーター
- configurationApiVersion
-
string
スタンドアロンクラスター json 構成の API バージョン。
- callback
コールバック
getClusterConfiguration(string, ServiceFabricClientGetClusterConfigurationOptionalParams)
クラスタ構成には、クラスタ上のさまざまなノードタイプ、セキュリティ設定、障害、アップグレードドメイントポロジなどを含むクラスタのプロパティが含まれています。
function getClusterConfiguration(configurationApiVersion: string, options?: ServiceFabricClientGetClusterConfigurationOptionalParams): Promise<GetClusterConfigurationResponse>
パラメーター
- configurationApiVersion
-
string
スタンドアロンクラスター json 構成の API バージョン。
省略可能なパラメーター
戻り値
Promise<GetClusterConfigurationResponse>
Promise<Models.GetClusterConfigurationResponse>
getClusterConfiguration(string, ServiceFabricClientGetClusterConfigurationOptionalParams, ServiceCallback<ClusterConfiguration>)
function getClusterConfiguration(configurationApiVersion: string, options: ServiceFabricClientGetClusterConfigurationOptionalParams, callback: ServiceCallback<ClusterConfiguration>)
パラメーター
- configurationApiVersion
-
string
スタンドアロンクラスター json 構成の API バージョン。
省略可能なパラメーター
- callback
コールバック
getClusterConfigurationUpgradeStatus(ServiceCallback<ClusterConfigurationUpgradeStatusInfo>)
function getClusterConfigurationUpgradeStatus(callback: ServiceCallback<ClusterConfigurationUpgradeStatusInfo>)
パラメーター
コールバック
getClusterConfigurationUpgradeStatus(ServiceFabricClientGetClusterConfigurationUpgradeStatusOptionalParams)
Service Fabric スタンドアロン クラスターのクラスター構成のアップグレード状態の詳細を取得します。
function getClusterConfigurationUpgradeStatus(options?: ServiceFabricClientGetClusterConfigurationUpgradeStatusOptionalParams): Promise<GetClusterConfigurationUpgradeStatusResponse>
パラメーター
省略可能なパラメーター
戻り値
Promise<Models.GetClusterConfigurationUpgradeStatusResponse応答>
getClusterConfigurationUpgradeStatus(ServiceFabricClientGetClusterConfigurationUpgradeStatusOptionalParams, ServiceCallback<ClusterConfigurationUpgradeStatusInfo>)
function getClusterConfigurationUpgradeStatus(options: ServiceFabricClientGetClusterConfigurationUpgradeStatusOptionalParams, callback: ServiceCallback<ClusterConfigurationUpgradeStatusInfo>)
パラメーター
省略可能なパラメーター
コールバック
getClusterEventList(string, string, ServiceCallback<ClusterEventUnion[]>)
function getClusterEventList(startTimeUtc: string, endTimeUtc: string, callback: ServiceCallback<ClusterEventUnion[]>)
パラメーター
- startTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの開始時刻。
- endTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの終了時刻。
- callback
コールバック
getClusterEventList(string, string, ServiceFabricClientGetClusterEventListOptionalParams)
応答は ClusterEvent オブジェクトのリストです。
function getClusterEventList(startTimeUtc: string, endTimeUtc: string, options?: ServiceFabricClientGetClusterEventListOptionalParams): Promise<GetClusterEventListResponse>
パラメーター
- startTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの開始時刻。
- endTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの終了時刻。
省略可能なパラメーター
戻り値
Promise<GetClusterEventListResponse>
Promise<Models.GetClusterEventListResponse応答>
getClusterEventList(string, string, ServiceFabricClientGetClusterEventListOptionalParams, ServiceCallback<ClusterEventUnion[]>)
function getClusterEventList(startTimeUtc: string, endTimeUtc: string, options: ServiceFabricClientGetClusterEventListOptionalParams, callback: ServiceCallback<ClusterEventUnion[]>)
パラメーター
- startTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの開始時刻。
- endTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの終了時刻。
省略可能なパラメーター
- callback
コールバック
getClusterHealth(ServiceCallback<ClusterHealth>)
function getClusterHealth(callback: ServiceCallback<ClusterHealth>)
パラメーター
- callback
コールバック
getClusterHealth(ServiceFabricClientGetClusterHealthOptionalParams)
EventsHealthStateFilter を使用して、正常性状態に基づいてクラスターで報告される正常性イベントのコレクションをフィルター処理します。 同様に、NodesHealthStateFilter と ApplicationsHealthStateFilter を使用して、集計された正常性状態に基づいて返されるノードとアプリケーションのコレクションをフィルター処理します。
function getClusterHealth(options?: ServiceFabricClientGetClusterHealthOptionalParams): Promise<GetClusterHealthResponse>
パラメーター
省略可能なパラメーター
戻り値
Promise<GetClusterHealthResponse>
Promise<Models.GetClusterHealthResponse>
getClusterHealth(ServiceFabricClientGetClusterHealthOptionalParams, ServiceCallback<ClusterHealth>)
function getClusterHealth(options: ServiceFabricClientGetClusterHealthOptionalParams, callback: ServiceCallback<ClusterHealth>)
パラメーター
省略可能なパラメーター
- callback
コールバック
getClusterHealthChunk(ServiceCallback<ClusterHealthChunk>)
function getClusterHealthChunk(callback: ServiceCallback<ClusterHealthChunk>)
パラメーター
- callback
コールバック
getClusterHealthChunk(ServiceFabricClientGetClusterHealthChunkOptionalParams)
正常性チャンクを使用して Service Fabric クラスターの正常性を取得します。 クラスターの集計された正常性状態は含まれますが、クラスター エンティティは含まれません。 クラスターの正常性を展開し、すべてまたは一部のエンティティの正常性状態を取得するには、POST URI を使用して、クラスターの正常性チャンク クエリの説明を指定します。
function getClusterHealthChunk(options?: ServiceFabricClientGetClusterHealthChunkOptionalParams): Promise<GetClusterHealthChunkResponse>
パラメーター
省略可能なパラメーター
戻り値
Promise<GetClusterHealthChunkResponse>
Promise<Models.GetClusterHealthChunkResponse>
getClusterHealthChunk(ServiceFabricClientGetClusterHealthChunkOptionalParams, ServiceCallback<ClusterHealthChunk>)
function getClusterHealthChunk(options: ServiceFabricClientGetClusterHealthChunkOptionalParams, callback: ServiceCallback<ClusterHealthChunk>)
パラメーター
省略可能なパラメーター
- callback
コールバック
getClusterHealthChunkUsingPolicyAndAdvancedFilters(ServiceCallback<ClusterHealthChunk>)
function getClusterHealthChunkUsingPolicyAndAdvancedFilters(callback: ServiceCallback<ClusterHealthChunk>)
パラメーター
- callback
コールバック
getClusterHealthChunkUsingPolicyAndAdvancedFilters(ServiceFabricClientGetClusterHealthChunkUsingPolicyAndAdvancedFiltersOptionalParams)
正常性チャンクを使用して Service Fabric クラスターの正常性を取得します。 正常性評価は、入力クラスター正常性チャンク クエリの説明に基づいて行われます。 クエリの説明を使用すると、ユーザーはクラスターとその子を評価するための正常性ポリシーを指定できます。 ユーザーは、非常に柔軟なフィルターを指定して、返すクラスターエンティティを選択できます。 選択は、エンティティの正常性状態と階層に基づいて行うことができます。 クエリは、指定されたフィルターに基づいてエンティティの複数レベルの子を返すことができます。 たとえば、指定した名前の 1 つのアプリケーションを返すことができます。このアプリケーションでは、エラーまたは警告に含まれるサービスと、これらのサービスの 1 つのすべてのパーティションとレプリカのみを返すことができます。
function getClusterHealthChunkUsingPolicyAndAdvancedFilters(options?: ServiceFabricClientGetClusterHealthChunkUsingPolicyAndAdvancedFiltersOptionalParams): Promise<GetClusterHealthChunkUsingPolicyAndAdvancedFiltersResponse>
パラメーター
省略可能なパラメーター
戻り値
Promise<Models.GetClusterHealthChunkUsingPolicyAndAdvancedFiltersResponse>
getClusterHealthChunkUsingPolicyAndAdvancedFilters(ServiceFabricClientGetClusterHealthChunkUsingPolicyAndAdvancedFiltersOptionalParams, ServiceCallback<ClusterHealthChunk>)
function getClusterHealthChunkUsingPolicyAndAdvancedFilters(options: ServiceFabricClientGetClusterHealthChunkUsingPolicyAndAdvancedFiltersOptionalParams, callback: ServiceCallback<ClusterHealthChunk>)
パラメーター
省略可能なパラメーター
- callback
コールバック
getClusterHealthUsingPolicy(ServiceCallback<ClusterHealth>)
function getClusterHealthUsingPolicy(callback: ServiceCallback<ClusterHealth>)
パラメーター
- callback
コールバック
getClusterHealthUsingPolicy(ServiceFabricClientGetClusterHealthUsingPolicyOptionalParams)
EventsHealthStateFilter を使用して、正常性状態に基づいてクラスターで報告される正常性イベントのコレクションをフィルター処理します。 同様に、NodesHealthStateFilter と ApplicationsHealthStateFilter を使用して、集計された正常性状態に基づいて返されるノードとアプリケーションのコレクションをフィルター処理します。 ClusterHealthPolicies を使用して、正常性の評価に使用される正常性ポリシーをオーバーライドします。
function getClusterHealthUsingPolicy(options?: ServiceFabricClientGetClusterHealthUsingPolicyOptionalParams): Promise<GetClusterHealthUsingPolicyResponse>
パラメーター
省略可能なパラメーター
戻り値
Promise<GetClusterHealthUsingPolicyResponse>
Promise<Models.GetClusterHealthUsingPolicyResponse>
getClusterHealthUsingPolicy(ServiceFabricClientGetClusterHealthUsingPolicyOptionalParams, ServiceCallback<ClusterHealth>)
function getClusterHealthUsingPolicy(options: ServiceFabricClientGetClusterHealthUsingPolicyOptionalParams, callback: ServiceCallback<ClusterHealth>)
パラメーター
省略可能なパラメーター
- callback
コールバック
getClusterLoad(ServiceCallback<ClusterLoadInfo>)
function getClusterLoad(callback: ServiceCallback<ClusterLoadInfo>)
パラメーター
- callback
コールバック
getClusterLoad(ServiceFabricClientGetClusterLoadOptionalParams)
負荷または容量が定義されているすべてのメトリックについて、Service Fabric クラスターの負荷情報を取得します。
function getClusterLoad(options?: ServiceFabricClientGetClusterLoadOptionalParams): Promise<GetClusterLoadResponse>
パラメーター
省略可能なパラメーター
戻り値
Promise<GetClusterLoadResponse>
Promise<Models.GetClusterLoadResponse>
getClusterLoad(ServiceFabricClientGetClusterLoadOptionalParams, ServiceCallback<ClusterLoadInfo>)
function getClusterLoad(options: ServiceFabricClientGetClusterLoadOptionalParams, callback: ServiceCallback<ClusterLoadInfo>)
パラメーター
省略可能なパラメーター
- callback
コールバック
getClusterManifest(ServiceCallback<ClusterManifest>)
function getClusterManifest(callback: ServiceCallback<ClusterManifest>)
パラメーター
- callback
コールバック
getClusterManifest(ServiceFabricClientGetClusterManifestOptionalParams)
Service Fabric クラスター マニフェストを取得します。 クラスター マニフェストには、クラスター上のさまざまなノードの種類、セキュリティ構成、障害、アップグレード ドメイン トポロジなどを含むクラスターのプロパティが含まれています。
これらのプロパティは、スタンドアロン クラスターのデプロイ時にClusterConfig.JSON ファイルの一部として指定されます。 ただし、クラスター マニフェスト内のほとんどの情報は、他のデプロイ シナリオでのクラスター デプロイ中に Service Fabric によって内部的に生成されます (Azure portal を使用する場合など)。
クラスター マニフェストの内容は情報提供のみを目的としており、ユーザーはファイルの内容の形式やその解釈に依存することは想定されていません。
function getClusterManifest(options?: ServiceFabricClientGetClusterManifestOptionalParams): Promise<GetClusterManifestResponse>
パラメーター
省略可能なパラメーター
戻り値
Promise<GetClusterManifestResponse>
Promise<Models.GetClusterManifestResponse>
getClusterManifest(ServiceFabricClientGetClusterManifestOptionalParams, ServiceCallback<ClusterManifest>)
function getClusterManifest(options: ServiceFabricClientGetClusterManifestOptionalParams, callback: ServiceCallback<ClusterManifest>)
パラメーター
省略可能なパラメーター
- callback
コールバック
getClusterUpgradeProgress(ServiceCallback<ClusterUpgradeProgressObject>)
function getClusterUpgradeProgress(callback: ServiceCallback<ClusterUpgradeProgressObject>)
パラメーター
- callback
コールバック
getClusterUpgradeProgress(ServiceFabricClientGetClusterUpgradeProgressOptionalParams)
進行中のクラスター アップグレードの現在の進行状況を取得します。 現在進行中のアップグレードがない場合は、前回のクラスタ アップグレードの最後の状態を取得します。
function getClusterUpgradeProgress(options?: ServiceFabricClientGetClusterUpgradeProgressOptionalParams): Promise<GetClusterUpgradeProgressResponse>
パラメーター
省略可能なパラメーター
戻り値
Promise<GetClusterUpgradeProgressResponse>
Promise<Models.GetClusterUpgradeProgressResponse>
getClusterUpgradeProgress(ServiceFabricClientGetClusterUpgradeProgressOptionalParams, ServiceCallback<ClusterUpgradeProgressObject>)
function getClusterUpgradeProgress(options: ServiceFabricClientGetClusterUpgradeProgressOptionalParams, callback: ServiceCallback<ClusterUpgradeProgressObject>)
パラメーター
省略可能なパラメーター
- callback
コールバック
getClusterVersion(ServiceCallback<ClusterVersion>)
function getClusterVersion(callback: ServiceCallback<ClusterVersion>)
パラメーター
- callback
コールバック
getClusterVersion(ServiceFabricClientGetClusterVersionOptionalParams)
クラスターのアップグレードが行われている場合、この API は、現在のクラスター ランタイム バージョンとターゲット クラスター ランタイム バージョンの最低 (古い) バージョンを返します。
function getClusterVersion(options?: ServiceFabricClientGetClusterVersionOptionalParams): Promise<GetClusterVersionResponse>
パラメーター
省略可能なパラメーター
戻り値
Promise<GetClusterVersionResponse>
Promise<Models.GetClusterVersionResponse応答>
getClusterVersion(ServiceFabricClientGetClusterVersionOptionalParams, ServiceCallback<ClusterVersion>)
function getClusterVersion(options: ServiceFabricClientGetClusterVersionOptionalParams, callback: ServiceCallback<ClusterVersion>)
パラメーター
省略可能なパラメーター
- callback
コールバック
getComposeDeploymentStatus(string, ServiceCallback<ComposeDeploymentStatusInfo>)
function getComposeDeploymentStatus(deploymentName: string, callback: ServiceCallback<ComposeDeploymentStatusInfo>)
パラメーター
- deploymentName
-
string
デプロイメントの ID。
- callback
コールバック
getComposeDeploymentStatus(string, ServiceFabricClientGetComposeDeploymentStatusOptionalParams)
Service Fabric クラスターで作成された、または作成中で、名前がパラメーターとして指定されたものと一致する作成デプロイの状態を返します。 応答には、名前、状態、およびデプロイに関するその他の詳細が含まれます。
function getComposeDeploymentStatus(deploymentName: string, options?: ServiceFabricClientGetComposeDeploymentStatusOptionalParams): Promise<GetComposeDeploymentStatusResponse>
パラメーター
- deploymentName
-
string
デプロイメントの ID。
省略可能なパラメーター
戻り値
Promise<GetComposeDeploymentStatusResponse>
Promise<Models.GetComposeDeploymentStatusResponse>
getComposeDeploymentStatus(string, ServiceFabricClientGetComposeDeploymentStatusOptionalParams, ServiceCallback<ComposeDeploymentStatusInfo>)
function getComposeDeploymentStatus(deploymentName: string, options: ServiceFabricClientGetComposeDeploymentStatusOptionalParams, callback: ServiceCallback<ComposeDeploymentStatusInfo>)
パラメーター
- deploymentName
-
string
デプロイメントの ID。
省略可能なパラメーター
- callback
コールバック
getComposeDeploymentStatusList(ServiceCallback<PagedComposeDeploymentStatusInfoList>)
function getComposeDeploymentStatusList(callback: ServiceCallback<PagedComposeDeploymentStatusInfoList>)
パラメーター
コールバック
getComposeDeploymentStatusList(ServiceFabricClientGetComposeDeploymentStatusListOptionalParams)
Service Fabric クラスターで作成された、または作成中の作成デプロイに関する状態を取得します。 応答には、作成デプロイメントに関する名前、ステータス、その他の詳細が含まれます。 デプロイのリストがページに収まらない場合は、結果の 1 ページと継続トークンが返され、次のページの取得に使用できます。
function getComposeDeploymentStatusList(options?: ServiceFabricClientGetComposeDeploymentStatusListOptionalParams): Promise<GetComposeDeploymentStatusListResponse>
パラメーター
省略可能なパラメーター
戻り値
Promise<Models.GetComposeDeploymentStatusListResponse>
getComposeDeploymentStatusList(ServiceFabricClientGetComposeDeploymentStatusListOptionalParams, ServiceCallback<PagedComposeDeploymentStatusInfoList>)
function getComposeDeploymentStatusList(options: ServiceFabricClientGetComposeDeploymentStatusListOptionalParams, callback: ServiceCallback<PagedComposeDeploymentStatusInfoList>)
パラメーター
省略可能なパラメーター
コールバック
getComposeDeploymentUpgradeProgress(string, ServiceCallback<ComposeDeploymentUpgradeProgressInfo>)
function getComposeDeploymentUpgradeProgress(deploymentName: string, callback: ServiceCallback<ComposeDeploymentUpgradeProgressInfo>)
パラメーター
- deploymentName
-
string
デプロイメントの ID。
コールバック
getComposeDeploymentUpgradeProgress(string, ServiceFabricClientGetComposeDeploymentUpgradeProgressOptionalParams)
作成デプロイメントのアップグレードの状態に関する情報と、アプリケーションの正常性の問題のデバッグに役立つ詳細を返します。
function getComposeDeploymentUpgradeProgress(deploymentName: string, options?: ServiceFabricClientGetComposeDeploymentUpgradeProgressOptionalParams): Promise<GetComposeDeploymentUpgradeProgressResponse>
パラメーター
- deploymentName
-
string
デプロイメントの ID。
省略可能なパラメーター
戻り値
Promise<Models.GetComposeDeploymentUpgradeProgressResponse>
getComposeDeploymentUpgradeProgress(string, ServiceFabricClientGetComposeDeploymentUpgradeProgressOptionalParams, ServiceCallback<ComposeDeploymentUpgradeProgressInfo>)
function getComposeDeploymentUpgradeProgress(deploymentName: string, options: ServiceFabricClientGetComposeDeploymentUpgradeProgressOptionalParams, callback: ServiceCallback<ComposeDeploymentUpgradeProgressInfo>)
パラメーター
- deploymentName
-
string
デプロイメントの ID。
省略可能なパラメーター
コールバック
getConfigurationOverrides(string, ServiceCallback<ConfigParameterOverride[]>)
function getConfigurationOverrides(nodeName: string, callback: ServiceCallback<ConfigParameterOverride[]>)
パラメーター
- nodeName
-
string
ノード名。
- callback
コールバック
getConfigurationOverrides(string, ServiceFabricClientGetConfigurationOverridesOptionalParams)
この API を使用すると、指定されたノード上の既存のすべての構成オーバーライドを取得できます。
function getConfigurationOverrides(nodeName: string, options?: ServiceFabricClientGetConfigurationOverridesOptionalParams): Promise<GetConfigurationOverridesResponse>
パラメーター
- nodeName
-
string
ノード名。
省略可能なパラメーター
戻り値
Promise<GetConfigurationOverridesResponse>
Promise<Models.GetConfigurationOverridesResponse>
getConfigurationOverrides(string, ServiceFabricClientGetConfigurationOverridesOptionalParams, ServiceCallback<ConfigParameterOverride[]>)
function getConfigurationOverrides(nodeName: string, options: ServiceFabricClientGetConfigurationOverridesOptionalParams, callback: ServiceCallback<ConfigParameterOverride[]>)
パラメーター
- nodeName
-
string
ノード名。
省略可能なパラメーター
- callback
コールバック
getContainerLogsDeployedOnNode(string, string, string, string, ServiceCallback<ContainerLogs>)
function getContainerLogsDeployedOnNode(nodeName: string, applicationId: string, serviceManifestName: string, codePackageName: string, callback: ServiceCallback<ContainerLogs>)
パラメーター
- nodeName
-
string
ノード名。
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- serviceManifestName
-
string
Service Fabric クラスター内のアプリケーションの種類の一部として登録されたサービス マニフェストの名前。
- codePackageName
-
string
Service Fabric クラスターのアプリケーションの種類の一部として登録されたサービス マニフェストで指定されたコード パッケージの名前。
- callback
コールバック
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
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- serviceManifestName
-
string
Service Fabric クラスター内のアプリケーションの種類の一部として登録されたサービス マニフェストの名前。
- codePackageName
-
string
Service Fabric クラスターのアプリケーションの種類の一部として登録されたサービス マニフェストで指定されたコード パッケージの名前。
省略可能なパラメーター
戻り値
Promise<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
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- serviceManifestName
-
string
Service Fabric クラスター内のアプリケーションの種類の一部として登録されたサービス マニフェストの名前。
- codePackageName
-
string
Service Fabric クラスターのアプリケーションの種類の一部として登録されたサービス マニフェストで指定されたコード パッケージの名前。
省略可能なパラメーター
- callback
コールバック
getContainersEventList(string, string, ServiceCallback<ContainerInstanceEvent[]>)
function getContainersEventList(startTimeUtc: string, endTimeUtc: string, callback: ServiceCallback<ContainerInstanceEvent[]>)
パラメーター
- startTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの開始時刻。
- endTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの終了時刻。
- callback
コールバック
getContainersEventList(string, string, ServiceFabricClientGetContainersEventListOptionalParams)
応答は ContainerInstanceEvent オブジェクトのリストです。
function getContainersEventList(startTimeUtc: string, endTimeUtc: string, options?: ServiceFabricClientGetContainersEventListOptionalParams): Promise<GetContainersEventListResponse>
パラメーター
- startTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの開始時刻。
- endTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの終了時刻。
省略可能なパラメーター
戻り値
Promise<GetContainersEventListResponse>
Promise<Models.GetContainersEventListResponse>
getContainersEventList(string, string, ServiceFabricClientGetContainersEventListOptionalParams, ServiceCallback<ContainerInstanceEvent[]>)
function getContainersEventList(startTimeUtc: string, endTimeUtc: string, options: ServiceFabricClientGetContainersEventListOptionalParams, callback: ServiceCallback<ContainerInstanceEvent[]>)
パラメーター
- startTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの開始時刻。
- endTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの終了時刻。
省略可能なパラメーター
- callback
コールバック
getCorrelatedEventList(string, ServiceCallback<FabricEventUnion[]>)
function getCorrelatedEventList(eventInstanceId: string, callback: ServiceCallback<FabricEventUnion[]>)
パラメーター
- eventInstanceId
-
string
EventInstanceId。
- callback
コールバック
getCorrelatedEventList(string, ServiceFabricClientGetCorrelatedEventListOptionalParams)
応答は FabricEvents のリストです。
function getCorrelatedEventList(eventInstanceId: string, options?: ServiceFabricClientGetCorrelatedEventListOptionalParams): Promise<GetCorrelatedEventListResponse>
パラメーター
- eventInstanceId
-
string
EventInstanceId。
省略可能なパラメーター
戻り値
Promise<GetCorrelatedEventListResponse>
Promise<Models.GetCorrelatedEventListResponse応答>
getCorrelatedEventList(string, ServiceFabricClientGetCorrelatedEventListOptionalParams, ServiceCallback<FabricEventUnion[]>)
function getCorrelatedEventList(eventInstanceId: string, options: ServiceFabricClientGetCorrelatedEventListOptionalParams, callback: ServiceCallback<FabricEventUnion[]>)
パラメーター
- eventInstanceId
-
string
EventInstanceId。
省略可能なパラメーター
- callback
コールバック
getDataLossProgress(string, string, string, ServiceCallback<PartitionDataLossProgress>)
function getDataLossProgress(serviceId: string, partitionId: string, operationId: string, callback: ServiceCallback<PartitionDataLossProgress>)
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
- partitionId
-
string
パーティションの ID。
- operationId
-
string
この API の呼び出しを識別する GUID。 これは、対応する GetProgress API に渡されます
- callback
コールバック
getDataLossProgress(string, string, string, ServiceFabricClientGetDataLossProgressOptionalParams)
OperationId を使用して、StartDataLoss で開始されたデータ損失操作の進行状況を取得します。
function getDataLossProgress(serviceId: string, partitionId: string, operationId: string, options?: ServiceFabricClientGetDataLossProgressOptionalParams): Promise<GetDataLossProgressResponse>
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
- partitionId
-
string
パーティションの ID。
- operationId
-
string
この API の呼び出しを識別する GUID。 これは、対応する GetProgress API に渡されます
省略可能なパラメーター
戻り値
Promise<GetDataLossProgressResponse>
Promise<Models.GetDataLossProgressResponse>
getDataLossProgress(string, string, string, ServiceFabricClientGetDataLossProgressOptionalParams, ServiceCallback<PartitionDataLossProgress>)
function getDataLossProgress(serviceId: string, partitionId: string, operationId: string, options: ServiceFabricClientGetDataLossProgressOptionalParams, callback: ServiceCallback<PartitionDataLossProgress>)
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
- partitionId
-
string
パーティションの ID。
- operationId
-
string
この API の呼び出しを識別する GUID。 これは、対応する GetProgress API に渡されます
省略可能なパラメーター
- callback
コールバック
getDeployedApplicationHealth(string, string, ServiceCallback<DeployedApplicationHealth>)
function getDeployedApplicationHealth(nodeName: string, applicationId: string, callback: ServiceCallback<DeployedApplicationHealth>)
パラメーター
- nodeName
-
string
ノード名。
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- callback
コールバック
getDeployedApplicationHealth(string, string, ServiceFabricClientGetDeployedApplicationHealthOptionalParams)
Service Fabric ノードにデプロイされたアプリケーションの正常性に関する情報を取得します。 EventsHealthStateFilter を使用して、必要に応じて、正常性状態に基づいてデプロイされたアプリケーションで報告された HealthEvent オブジェクトのコレクションをフィルター処理します。 DeployedServicePackagesHealthStateFilter を使用して、必要に応じて、正常性状態に基づいて DeployedServicePackageHealth の子をフィルター処理します。
function getDeployedApplicationHealth(nodeName: string, applicationId: string, options?: ServiceFabricClientGetDeployedApplicationHealthOptionalParams): Promise<GetDeployedApplicationHealthResponse>
パラメーター
- nodeName
-
string
ノード名。
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
省略可能なパラメーター
戻り値
Promise<GetDeployedApplicationHealthResponse>
Promise<Models.GetDeployedApplicationHealthResponse>
getDeployedApplicationHealth(string, string, ServiceFabricClientGetDeployedApplicationHealthOptionalParams, ServiceCallback<DeployedApplicationHealth>)
function getDeployedApplicationHealth(nodeName: string, applicationId: string, options: ServiceFabricClientGetDeployedApplicationHealthOptionalParams, callback: ServiceCallback<DeployedApplicationHealth>)
パラメーター
- nodeName
-
string
ノード名。
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
省略可能なパラメーター
- callback
コールバック
getDeployedApplicationHealthUsingPolicy(string, string, ServiceCallback<DeployedApplicationHealth>)
function getDeployedApplicationHealthUsingPolicy(nodeName: string, applicationId: string, callback: ServiceCallback<DeployedApplicationHealth>)
パラメーター
- nodeName
-
string
ノード名。
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- callback
コールバック
getDeployedApplicationHealthUsingPolicy(string, string, ServiceFabricClientGetDeployedApplicationHealthUsingPolicyOptionalParams)
指定したポリシーを使用して、Service Fabric ノードにデプロイされたアプリケーションの正常性に関する情報を取得します。 EventsHealthStateFilter を使用して、必要に応じて、正常性状態に基づいてデプロイされたアプリケーションで報告された HealthEvent オブジェクトのコレクションをフィルター処理します。 DeployedServicePackagesHealthStateFilter を使用して、必要に応じて、正常性状態に基づいて DeployedServicePackageHealth の子をフィルター処理します。 ApplicationHealthPolicy を使用して、必要に応じて、正常性の評価に使用される正常性ポリシーをオーバーライドします。 この API は、ApplicationHealthPolicy の 'ConsiderWarningAsError' フィールドのみを使用します。 残りのフィールドは、デプロイされたアプリケーションの正常性を評価する際に無視されます。
function getDeployedApplicationHealthUsingPolicy(nodeName: string, applicationId: string, options?: ServiceFabricClientGetDeployedApplicationHealthUsingPolicyOptionalParams): Promise<GetDeployedApplicationHealthUsingPolicyResponse>
パラメーター
- nodeName
-
string
ノード名。
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
省略可能なパラメーター
戻り値
Promise<Models.GetDeployedApplicationHealthUsingPolicyResponseです。>
getDeployedApplicationHealthUsingPolicy(string, string, ServiceFabricClientGetDeployedApplicationHealthUsingPolicyOptionalParams, ServiceCallback<DeployedApplicationHealth>)
function getDeployedApplicationHealthUsingPolicy(nodeName: string, applicationId: string, options: ServiceFabricClientGetDeployedApplicationHealthUsingPolicyOptionalParams, callback: ServiceCallback<DeployedApplicationHealth>)
パラメーター
- nodeName
-
string
ノード名。
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
省略可能なパラメーター
- callback
コールバック
getDeployedApplicationInfo(string, string, ServiceCallback<DeployedApplicationInfo>)
function getDeployedApplicationInfo(nodeName: string, applicationId: string, callback: ServiceCallback<DeployedApplicationInfo>)
パラメーター
- nodeName
-
string
ノード名。
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- callback
コールバック
getDeployedApplicationInfo(string, string, ServiceFabricClientGetDeployedApplicationInfoOptionalParams)
この照会は、指定されたアプリケーション ID がシステム・アプリケーション用である場合、システム・アプリケーション情報を返します。 結果には、アクティブ、アクティブ化、およびダウンロード中の状態のデプロイされたアプリケーションが含まれます。 このクエリでは、ノード名がクラスター上のノードに対応している必要があります。 指定されたノード名がクラスター上のアクティブな Service Fabric ノードを指さない場合、クエリは失敗します。
function getDeployedApplicationInfo(nodeName: string, applicationId: string, options?: ServiceFabricClientGetDeployedApplicationInfoOptionalParams): Promise<GetDeployedApplicationInfoResponse>
パラメーター
- nodeName
-
string
ノード名。
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
省略可能なパラメーター
戻り値
Promise<GetDeployedApplicationInfoResponse>
Promise<Models.GetDeployedApplicationInfoResponse>
getDeployedApplicationInfo(string, string, ServiceFabricClientGetDeployedApplicationInfoOptionalParams, ServiceCallback<DeployedApplicationInfo>)
function getDeployedApplicationInfo(nodeName: string, applicationId: string, options: ServiceFabricClientGetDeployedApplicationInfoOptionalParams, callback: ServiceCallback<DeployedApplicationInfo>)
パラメーター
- nodeName
-
string
ノード名。
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
省略可能なパラメーター
- callback
コールバック
getDeployedApplicationInfoList(string, ServiceCallback<PagedDeployedApplicationInfoList>)
function getDeployedApplicationInfoList(nodeName: string, callback: ServiceCallback<PagedDeployedApplicationInfoList>)
パラメーター
- nodeName
-
string
ノード名。
コールバック
getDeployedApplicationInfoList(string, ServiceFabricClientGetDeployedApplicationInfoListOptionalParams)
Service Fabric ノードにデプロイされたアプリケーションの一覧を取得します。 結果には、ID で明示的に照会されない限り、デプロイされたシステム・アプリケーションに関する情報は含まれません。 結果には、アクティブ、アクティブ化、およびダウンロード中の状態のデプロイされたアプリケーションが含まれます。 このクエリでは、ノード名がクラスター上のノードに対応している必要があります。 指定されたノード名がクラスター上のアクティブな Service Fabric ノードを指さない場合、クエリは失敗します。
function getDeployedApplicationInfoList(nodeName: string, options?: ServiceFabricClientGetDeployedApplicationInfoListOptionalParams): Promise<GetDeployedApplicationInfoListResponse>
パラメーター
- nodeName
-
string
ノード名。
省略可能なパラメーター
戻り値
Promise<Models.GetDeployedApplicationInfoListResponse>
getDeployedApplicationInfoList(string, ServiceFabricClientGetDeployedApplicationInfoListOptionalParams, ServiceCallback<PagedDeployedApplicationInfoList>)
function getDeployedApplicationInfoList(nodeName: string, options: ServiceFabricClientGetDeployedApplicationInfoListOptionalParams, callback: ServiceCallback<PagedDeployedApplicationInfoList>)
パラメーター
- nodeName
-
string
ノード名。
省略可能なパラメーター
コールバック
getDeployedCodePackageInfoList(string, string, ServiceCallback<DeployedCodePackageInfo[]>)
function getDeployedCodePackageInfoList(nodeName: string, applicationId: string, callback: ServiceCallback<DeployedCodePackageInfo[]>)
パラメーター
- nodeName
-
string
ノード名。
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- callback
コールバック
getDeployedCodePackageInfoList(string, string, ServiceFabricClientGetDeployedCodePackageInfoListOptionalParams)
特定のアプリケーションの Service Fabric ノードにデプロイされたコード パッケージの一覧を取得します。
function getDeployedCodePackageInfoList(nodeName: string, applicationId: string, options?: ServiceFabricClientGetDeployedCodePackageInfoListOptionalParams): Promise<GetDeployedCodePackageInfoListResponse>
パラメーター
- nodeName
-
string
ノード名。
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
省略可能なパラメーター
戻り値
Promise<Models.GetDeployedCodePackageInfoListResponse応答>
getDeployedCodePackageInfoList(string, string, ServiceFabricClientGetDeployedCodePackageInfoListOptionalParams, ServiceCallback<DeployedCodePackageInfo[]>)
function getDeployedCodePackageInfoList(nodeName: string, applicationId: string, options: ServiceFabricClientGetDeployedCodePackageInfoListOptionalParams, callback: ServiceCallback<DeployedCodePackageInfo[]>)
パラメーター
- nodeName
-
string
ノード名。
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
省略可能なパラメーター
- callback
コールバック
getDeployedServicePackageHealth(string, string, string, ServiceCallback<DeployedServicePackageHealth>)
function getDeployedServicePackageHealth(nodeName: string, applicationId: string, servicePackageName: string, callback: ServiceCallback<DeployedServicePackageHealth>)
パラメーター
- nodeName
-
string
ノード名。
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- servicePackageName
-
string
サービス パッケージの名前。
- callback
コールバック
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
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- servicePackageName
-
string
サービス パッケージの名前。
省略可能なパラメーター
戻り値
Promise<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
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- servicePackageName
-
string
サービス パッケージの名前。
省略可能なパラメーター
- callback
コールバック
getDeployedServicePackageHealthUsingPolicy(string, string, string, ServiceCallback<DeployedServicePackageHealth>)
function getDeployedServicePackageHealthUsingPolicy(nodeName: string, applicationId: string, servicePackageName: string, callback: ServiceCallback<DeployedServicePackageHealth>)
パラメーター
- nodeName
-
string
ノード名。
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- servicePackageName
-
string
サービス パッケージの名前。
- callback
コールバック
getDeployedServicePackageHealthUsingPolicy(string, string, string, ServiceFabricClientGetDeployedServicePackageHealthUsingPolicyOptionalParams)
Service Fabric ノードにデプロイされた特定のアプリケーションのサービス パッケージの正常性に関する情報を取得します。 指定されたポリシーを使用します。 EventsHealthStateFilter を使用して、必要に応じて、正常性状態に基づいて、デプロイされたサービス パッケージで報告される HealthEvent オブジェクトのコレクションをフィルター処理します。 ApplicationHealthPolicy を使用して、必要に応じて、正常性の評価に使用される正常性ポリシーをオーバーライドします。 この API は、ApplicationHealthPolicy の 'ConsiderWarningAsError' フィールドのみを使用します。 残りのフィールドは、デプロイされたサービス パッケージの正常性を評価するときに無視されます。
function getDeployedServicePackageHealthUsingPolicy(nodeName: string, applicationId: string, servicePackageName: string, options?: ServiceFabricClientGetDeployedServicePackageHealthUsingPolicyOptionalParams): Promise<GetDeployedServicePackageHealthUsingPolicyResponse>
パラメーター
- nodeName
-
string
ノード名。
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- servicePackageName
-
string
サービス パッケージの名前。
省略可能なパラメーター
戻り値
Promise<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
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- servicePackageName
-
string
サービス パッケージの名前。
省略可能なパラメーター
- callback
コールバック
getDeployedServicePackageInfoList(string, string, ServiceCallback<DeployedServicePackageInfo[]>)
function getDeployedServicePackageInfoList(nodeName: string, applicationId: string, callback: ServiceCallback<DeployedServicePackageInfo[]>)
パラメーター
- nodeName
-
string
ノード名。
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- callback
コールバック
getDeployedServicePackageInfoList(string, string, ServiceFabricClientGetDeployedServicePackageInfoListOptionalParams)
特定のアプリケーションの Service Fabric ノードにデプロイされたサービス パッケージに関する情報を返します。
function getDeployedServicePackageInfoList(nodeName: string, applicationId: string, options?: ServiceFabricClientGetDeployedServicePackageInfoListOptionalParams): Promise<GetDeployedServicePackageInfoListResponse>
パラメーター
- nodeName
-
string
ノード名。
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
省略可能なパラメーター
戻り値
Promise<Models.GetDeployedServicePackageInfoListResponse応答>
getDeployedServicePackageInfoList(string, string, ServiceFabricClientGetDeployedServicePackageInfoListOptionalParams, ServiceCallback<DeployedServicePackageInfo[]>)
function getDeployedServicePackageInfoList(nodeName: string, applicationId: string, options: ServiceFabricClientGetDeployedServicePackageInfoListOptionalParams, callback: ServiceCallback<DeployedServicePackageInfo[]>)
パラメーター
- nodeName
-
string
ノード名。
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
省略可能なパラメーター
- callback
コールバック
getDeployedServicePackageInfoListByName(string, string, string, ServiceCallback<DeployedServicePackageInfo[]>)
function getDeployedServicePackageInfoListByName(nodeName: string, applicationId: string, servicePackageName: string, callback: ServiceCallback<DeployedServicePackageInfo[]>)
パラメーター
- nodeName
-
string
ノード名。
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- servicePackageName
-
string
サービス パッケージの名前。
- callback
コールバック
getDeployedServicePackageInfoListByName(string, string, string, ServiceFabricClientGetDeployedServicePackageInfoListByNameOptionalParams)
特定のアプリケーションの Service Fabric ノードにデプロイされたサービス パッケージに関する情報を返します。 これらの結果は、パラメーターとして指定されたサービス パッケージ名と正確に一致する名前のサービス パッケージです。
function getDeployedServicePackageInfoListByName(nodeName: string, applicationId: string, servicePackageName: string, options?: ServiceFabricClientGetDeployedServicePackageInfoListByNameOptionalParams): Promise<GetDeployedServicePackageInfoListByNameResponse>
パラメーター
- nodeName
-
string
ノード名。
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- servicePackageName
-
string
サービス パッケージの名前。
省略可能なパラメーター
戻り値
Promise<Models.GetDeployedServicePackageInfoListByName応答>
getDeployedServicePackageInfoListByName(string, string, string, ServiceFabricClientGetDeployedServicePackageInfoListByNameOptionalParams, ServiceCallback<DeployedServicePackageInfo[]>)
function getDeployedServicePackageInfoListByName(nodeName: string, applicationId: string, servicePackageName: string, options: ServiceFabricClientGetDeployedServicePackageInfoListByNameOptionalParams, callback: ServiceCallback<DeployedServicePackageInfo[]>)
パラメーター
- nodeName
-
string
ノード名。
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- servicePackageName
-
string
サービス パッケージの名前。
省略可能なパラメーター
- callback
コールバック
getDeployedServiceReplicaDetailInfo(string, string, string, ServiceCallback<DeployedServiceReplicaDetailInfoUnion>)
function getDeployedServiceReplicaDetailInfo(nodeName: string, partitionId: string, replicaId: string, callback: ServiceCallback<DeployedServiceReplicaDetailInfoUnion>)
パラメーター
- nodeName
-
string
ノード名。
- partitionId
-
string
パーティションの ID。
- replicaId
-
string
レプリカの識別子。
コールバック
getDeployedServiceReplicaDetailInfo(string, string, string, ServiceFabricClientGetDeployedServiceReplicaDetailInfoOptionalParams)
Service Fabric ノードにデプロイされたレプリカの詳細を取得します。 この情報には、サービスの種類、サービス名、現在のサービス操作、現在のサービス操作の開始日時、パーティション ID、レプリカ/インスタンス ID、報告された負荷、およびその他の情報が含まれます。
function getDeployedServiceReplicaDetailInfo(nodeName: string, partitionId: string, replicaId: string, options?: ServiceFabricClientGetDeployedServiceReplicaDetailInfoOptionalParams): Promise<GetDeployedServiceReplicaDetailInfoResponse>
パラメーター
- nodeName
-
string
ノード名。
- partitionId
-
string
パーティションの ID。
- replicaId
-
string
レプリカの識別子。
省略可能なパラメーター
戻り値
Promise<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
パーティションの ID。
- replicaId
-
string
レプリカの識別子。
省略可能なパラメーター
コールバック
getDeployedServiceReplicaDetailInfoByPartitionId(string, string, ServiceCallback<DeployedServiceReplicaDetailInfoUnion>)
function getDeployedServiceReplicaDetailInfoByPartitionId(nodeName: string, partitionId: string, callback: ServiceCallback<DeployedServiceReplicaDetailInfoUnion>)
パラメーター
- nodeName
-
string
ノード名。
- partitionId
-
string
パーティションの ID。
コールバック
getDeployedServiceReplicaDetailInfoByPartitionId(string, string, ServiceFabricClientGetDeployedServiceReplicaDetailInfoByPartitionIdOptionalParams)
Service Fabric ノードにデプロイされたレプリカの詳細を取得します。 この情報には、サービスの種類、サービス名、現在のサービス操作、現在のサービス操作の開始日時、パーティション ID、レプリカ/インスタンス ID、報告された負荷、およびその他の情報が含まれます。
function getDeployedServiceReplicaDetailInfoByPartitionId(nodeName: string, partitionId: string, options?: ServiceFabricClientGetDeployedServiceReplicaDetailInfoByPartitionIdOptionalParams): Promise<GetDeployedServiceReplicaDetailInfoByPartitionIdResponse>
パラメーター
- nodeName
-
string
ノード名。
- partitionId
-
string
パーティションの ID。
省略可能なパラメーター
戻り値
Promise<Models.GetDeployedServiceReplicaDetailInfoByPartitionIdResponse>
getDeployedServiceReplicaDetailInfoByPartitionId(string, string, ServiceFabricClientGetDeployedServiceReplicaDetailInfoByPartitionIdOptionalParams, ServiceCallback<DeployedServiceReplicaDetailInfoUnion>)
function getDeployedServiceReplicaDetailInfoByPartitionId(nodeName: string, partitionId: string, options: ServiceFabricClientGetDeployedServiceReplicaDetailInfoByPartitionIdOptionalParams, callback: ServiceCallback<DeployedServiceReplicaDetailInfoUnion>)
パラメーター
- nodeName
-
string
ノード名。
- partitionId
-
string
パーティションの ID。
省略可能なパラメーター
コールバック
getDeployedServiceReplicaInfoList(string, string, ServiceCallback<DeployedServiceReplicaInfoUnion[]>)
function getDeployedServiceReplicaInfoList(nodeName: string, applicationId: string, callback: ServiceCallback<DeployedServiceReplicaInfoUnion[]>)
パラメーター
- nodeName
-
string
ノード名。
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- callback
コールバック
getDeployedServiceReplicaInfoList(string, string, ServiceFabricClientGetDeployedServiceReplicaInfoListOptionalParams)
Service Fabric ノードにデプロイされたレプリカに関する情報を含む一覧を取得します。 情報には、パーティション ID、レプリカ ID、レプリカのステータス、サービスの名前、サービスの種類の名前、およびその他の情報が含まれます。 PartitionId または ServiceManifestName クエリ パラメーターを使用して、それらのパラメーターに指定された値に一致するデプロイされたレプリカに関する情報を返します。
function getDeployedServiceReplicaInfoList(nodeName: string, applicationId: string, options?: ServiceFabricClientGetDeployedServiceReplicaInfoListOptionalParams): Promise<GetDeployedServiceReplicaInfoListResponse>
パラメーター
- nodeName
-
string
ノード名。
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
省略可能なパラメーター
戻り値
Promise<Models.GetDeployedServiceReplicaInfoListResponse>
getDeployedServiceReplicaInfoList(string, string, ServiceFabricClientGetDeployedServiceReplicaInfoListOptionalParams, ServiceCallback<DeployedServiceReplicaInfoUnion[]>)
function getDeployedServiceReplicaInfoList(nodeName: string, applicationId: string, options: ServiceFabricClientGetDeployedServiceReplicaInfoListOptionalParams, callback: ServiceCallback<DeployedServiceReplicaInfoUnion[]>)
パラメーター
- nodeName
-
string
ノード名。
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
省略可能なパラメーター
- callback
コールバック
getDeployedServiceTypeInfoByName(string, string, string, ServiceCallback<DeployedServiceTypeInfo[]>)
function getDeployedServiceTypeInfoByName(nodeName: string, applicationId: string, serviceTypeName: string, callback: ServiceCallback<DeployedServiceTypeInfo[]>)
パラメーター
- nodeName
-
string
ノード名。
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- serviceTypeName
-
string
Service Fabric サービスの種類の名前を指定します。
- callback
コールバック
getDeployedServiceTypeInfoByName(string, string, string, ServiceFabricClientGetDeployedServiceTypeInfoByNameOptionalParams)
Service Fabric クラスター内のノードにデプロイされたアプリケーションから、特定のサービスの種類に関する情報を含む一覧を取得します。 応答には、サービスの種類の名前、登録状態、それを登録したコードパッケージ、およびサービスパッケージのアクティベーション ID が含まれます。 各エントリは、アクティベーション ID によって区別されるサービスタイプの 1 つのアクティベーションを表します。
function getDeployedServiceTypeInfoByName(nodeName: string, applicationId: string, serviceTypeName: string, options?: ServiceFabricClientGetDeployedServiceTypeInfoByNameOptionalParams): Promise<GetDeployedServiceTypeInfoByNameResponse>
パラメーター
- nodeName
-
string
ノード名。
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- serviceTypeName
-
string
Service Fabric サービスの種類の名前を指定します。
省略可能なパラメーター
戻り値
Promise<Models.GetDeployedServiceTypeInfoByName応答>
getDeployedServiceTypeInfoByName(string, string, string, ServiceFabricClientGetDeployedServiceTypeInfoByNameOptionalParams, ServiceCallback<DeployedServiceTypeInfo[]>)
function getDeployedServiceTypeInfoByName(nodeName: string, applicationId: string, serviceTypeName: string, options: ServiceFabricClientGetDeployedServiceTypeInfoByNameOptionalParams, callback: ServiceCallback<DeployedServiceTypeInfo[]>)
パラメーター
- nodeName
-
string
ノード名。
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- serviceTypeName
-
string
Service Fabric サービスの種類の名前を指定します。
省略可能なパラメーター
- callback
コールバック
getDeployedServiceTypeInfoList(string, string, ServiceCallback<DeployedServiceTypeInfo[]>)
function getDeployedServiceTypeInfoList(nodeName: string, applicationId: string, callback: ServiceCallback<DeployedServiceTypeInfo[]>)
パラメーター
- nodeName
-
string
ノード名。
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- callback
コールバック
getDeployedServiceTypeInfoList(string, string, ServiceFabricClientGetDeployedServiceTypeInfoListOptionalParams)
Service Fabric クラスター内のノードにデプロイされたアプリケーションから、サービスの種類に関する情報を含む一覧を取得します。 応答には、サービスの種類の名前、登録状態、それを登録したコードパッケージ、およびサービスパッケージのアクティベーション ID が含まれます。
function getDeployedServiceTypeInfoList(nodeName: string, applicationId: string, options?: ServiceFabricClientGetDeployedServiceTypeInfoListOptionalParams): Promise<GetDeployedServiceTypeInfoListResponse>
パラメーター
- nodeName
-
string
ノード名。
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
省略可能なパラメーター
戻り値
Promise<Models.GetDeployedServiceTypeInfoListResponse応答>
getDeployedServiceTypeInfoList(string, string, ServiceFabricClientGetDeployedServiceTypeInfoListOptionalParams, ServiceCallback<DeployedServiceTypeInfo[]>)
function getDeployedServiceTypeInfoList(nodeName: string, applicationId: string, options: ServiceFabricClientGetDeployedServiceTypeInfoListOptionalParams, callback: ServiceCallback<DeployedServiceTypeInfo[]>)
パラメーター
- nodeName
-
string
ノード名。
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
省略可能なパラメーター
- callback
コールバック
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 - [Faulted] を選択します。
- 32 - キャンセル済みを選択します
- 64 - ForceCancelled を選択します。
- callback
コールバック
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 - [Faulted] を選択します。
- 32 - キャンセル済みを選択します
- 64 - ForceCancelled を選択します。
省略可能なパラメーター
戻り値
Promise<GetFaultOperationListResponse>
Promise<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 - [Faulted] を選択します。
- 32 - キャンセル済みを選択します
- 64 - ForceCancelled を選択します。
省略可能なパラメーター
- callback
コールバック
getImageStoreContent(string, ServiceCallback<ImageStoreContent>)
function getImageStoreContent(contentPath: string, callback: ServiceCallback<ImageStoreContent>)
パラメーター
- contentPath
-
string
イメージストア内のファイルまたはフォルダのルートからの相対パス。
- callback
コールバック
getImageStoreContent(string, ServiceFabricClientGetImageStoreContentOptionalParams)
指定された contentPath のイメージ ストア コンテンツに関する情報を返します。 contentPath は、イメージ ストアのルートを基準にしています。
function getImageStoreContent(contentPath: string, options?: ServiceFabricClientGetImageStoreContentOptionalParams): Promise<GetImageStoreContentResponse>
パラメーター
- contentPath
-
string
イメージストア内のファイルまたはフォルダのルートからの相対パス。
省略可能なパラメーター
戻り値
Promise<GetImageStoreContentResponse>
Promise<Models.GetImageStoreContentResponse応答>
getImageStoreContent(string, ServiceFabricClientGetImageStoreContentOptionalParams, ServiceCallback<ImageStoreContent>)
function getImageStoreContent(contentPath: string, options: ServiceFabricClientGetImageStoreContentOptionalParams, callback: ServiceCallback<ImageStoreContent>)
パラメーター
- contentPath
-
string
イメージストア内のファイルまたはフォルダのルートからの相対パス。
省略可能なパラメーター
- callback
コールバック
getImageStoreFolderSize(string, ServiceCallback<FolderSizeInfo>)
function getImageStoreFolderSize(contentPath: string, callback: ServiceCallback<FolderSizeInfo>)
パラメーター
- contentPath
-
string
イメージストア内のファイルまたはフォルダのルートからの相対パス。
- callback
コールバック
getImageStoreFolderSize(string, ServiceFabricClientGetImageStoreFolderSizeOptionalParams)
contentPath で指定されたイメージ ストア フォルダーの下にあるファイルの合計サイズを取得します。 contentPath は、イメージ ストアのルートを基準にしています。
function getImageStoreFolderSize(contentPath: string, options?: ServiceFabricClientGetImageStoreFolderSizeOptionalParams): Promise<GetImageStoreFolderSizeResponse>
パラメーター
- contentPath
-
string
イメージストア内のファイルまたはフォルダのルートからの相対パス。
省略可能なパラメーター
戻り値
Promise<GetImageStoreFolderSizeResponse>
Promise<Models.GetImageStoreFolderSizeResponse応答>
getImageStoreFolderSize(string, ServiceFabricClientGetImageStoreFolderSizeOptionalParams, ServiceCallback<FolderSizeInfo>)
function getImageStoreFolderSize(contentPath: string, options: ServiceFabricClientGetImageStoreFolderSizeOptionalParams, callback: ServiceCallback<FolderSizeInfo>)
パラメーター
- contentPath
-
string
イメージストア内のファイルまたはフォルダのルートからの相対パス。
省略可能なパラメーター
- callback
コールバック
getImageStoreInfo(ServiceCallback<ImageStoreInfo>)
function getImageStoreInfo(callback: ServiceCallback<ImageStoreInfo>)
パラメーター
- callback
コールバック
getImageStoreInfo(ServiceFabricClientGetImageStoreInfoOptionalParams)
プライマリ ImageStore レプリカに関する情報 (ディスク容量やノードで使用可能なディスク容量、ImageStore のファイルシステムの使用状況のいくつかのカテゴリなど) を返します。
function getImageStoreInfo(options?: ServiceFabricClientGetImageStoreInfoOptionalParams): Promise<GetImageStoreInfoResponse>
パラメーター
省略可能なパラメーター
戻り値
Promise<GetImageStoreInfoResponse>
Promise<Models.GetImageStoreInfoResponse応答>
getImageStoreInfo(ServiceFabricClientGetImageStoreInfoOptionalParams, ServiceCallback<ImageStoreInfo>)
function getImageStoreInfo(options: ServiceFabricClientGetImageStoreInfoOptionalParams, callback: ServiceCallback<ImageStoreInfo>)
パラメーター
省略可能なパラメーター
- callback
コールバック
getImageStoreRootContent(ServiceCallback<ImageStoreContent>)
function getImageStoreRootContent(callback: ServiceCallback<ImageStoreContent>)
パラメーター
- callback
コールバック
getImageStoreRootContent(ServiceFabricClientGetImageStoreRootContentOptionalParams)
イメージストアのルートにあるイメージストアコンテンツに関する情報を返します。
function getImageStoreRootContent(options?: ServiceFabricClientGetImageStoreRootContentOptionalParams): Promise<GetImageStoreRootContentResponse>
パラメーター
省略可能なパラメーター
戻り値
Promise<GetImageStoreRootContentResponse>
Promise<Models.GetImageStoreRootContentResponseです>
getImageStoreRootContent(ServiceFabricClientGetImageStoreRootContentOptionalParams, ServiceCallback<ImageStoreContent>)
function getImageStoreRootContent(options: ServiceFabricClientGetImageStoreRootContentOptionalParams, callback: ServiceCallback<ImageStoreContent>)
パラメーター
省略可能なパラメーター
- callback
コールバック
getImageStoreRootFolderSize(ServiceCallback<FolderSizeInfo>)
function getImageStoreRootFolderSize(callback: ServiceCallback<FolderSizeInfo>)
パラメーター
- callback
コールバック
getImageStoreRootFolderSize(ServiceFabricClientGetImageStoreRootFolderSizeOptionalParams)
イメージストアのルートフォルダと子フォルダのファイルの合計サイズを返します。
function getImageStoreRootFolderSize(options?: ServiceFabricClientGetImageStoreRootFolderSizeOptionalParams): Promise<GetImageStoreRootFolderSizeResponse>
パラメーター
省略可能なパラメーター
戻り値
Promise<GetImageStoreRootFolderSizeResponse>
Promise<Models.GetImageStoreRootFolderSizeResponse応答>
getImageStoreRootFolderSize(ServiceFabricClientGetImageStoreRootFolderSizeOptionalParams, ServiceCallback<FolderSizeInfo>)
function getImageStoreRootFolderSize(options: ServiceFabricClientGetImageStoreRootFolderSizeOptionalParams, callback: ServiceCallback<FolderSizeInfo>)
パラメーター
省略可能なパラメーター
- callback
コールバック
getImageStoreUploadSessionById(string, ServiceCallback<UploadSession>)
function getImageStoreUploadSessionById(sessionId: string, callback: ServiceCallback<UploadSession>)
パラメーター
- sessionId
-
string
ファイルのアップロードのためにユーザーが生成した GUID。 これは、コミットされるまですべてのファイルチャンクを追跡するイメージストアアップロードセッションを識別します。
- callback
コールバック
getImageStoreUploadSessionById(string, ServiceFabricClientGetImageStoreUploadSessionByIdOptionalParams)
指定された ID で識別されるイメージ ストア アップロード セッションを取得します。 ユーザーは、アップロード中にいつでもアップロードセッションを照会できます。
function getImageStoreUploadSessionById(sessionId: string, options?: ServiceFabricClientGetImageStoreUploadSessionByIdOptionalParams): Promise<GetImageStoreUploadSessionByIdResponse>
パラメーター
- sessionId
-
string
ファイルのアップロードのためにユーザーが生成した GUID。 これは、コミットされるまですべてのファイルチャンクを追跡するイメージストアアップロードセッションを識別します。
省略可能なパラメーター
戻り値
Promise<Models.GetImageStoreUploadSessionByIdResponse>
getImageStoreUploadSessionById(string, ServiceFabricClientGetImageStoreUploadSessionByIdOptionalParams, ServiceCallback<UploadSession>)
function getImageStoreUploadSessionById(sessionId: string, options: ServiceFabricClientGetImageStoreUploadSessionByIdOptionalParams, callback: ServiceCallback<UploadSession>)
パラメーター
- sessionId
-
string
ファイルのアップロードのためにユーザーが生成した GUID。 これは、コミットされるまですべてのファイルチャンクを追跡するイメージストアアップロードセッションを識別します。
省略可能なパラメーター
- callback
コールバック
getImageStoreUploadSessionByPath(string, ServiceCallback<UploadSession>)
function getImageStoreUploadSessionByPath(contentPath: string, callback: ServiceCallback<UploadSession>)
パラメーター
- contentPath
-
string
イメージストア内のファイルまたはフォルダのルートからの相対パス。
- callback
コールバック
getImageStoreUploadSessionByPath(string, ServiceFabricClientGetImageStoreUploadSessionByPathOptionalParams)
指定されたイメージストアの相対パスに関連付けられたイメージストアのアップロードセッションを取得します。 ユーザーは、アップロード中にいつでもアップロードセッションを照会できます。
function getImageStoreUploadSessionByPath(contentPath: string, options?: ServiceFabricClientGetImageStoreUploadSessionByPathOptionalParams): Promise<GetImageStoreUploadSessionByPathResponse>
パラメーター
- contentPath
-
string
イメージストア内のファイルまたはフォルダのルートからの相対パス。
省略可能なパラメーター
戻り値
Promise<Models.GetImageStoreUploadSessionByPathResponse応答>
getImageStoreUploadSessionByPath(string, ServiceFabricClientGetImageStoreUploadSessionByPathOptionalParams, ServiceCallback<UploadSession>)
function getImageStoreUploadSessionByPath(contentPath: string, options: ServiceFabricClientGetImageStoreUploadSessionByPathOptionalParams, callback: ServiceCallback<UploadSession>)
パラメーター
- contentPath
-
string
イメージストア内のファイルまたはフォルダのルートからの相対パス。
省略可能なパラメーター
- callback
コールバック
getNameExistsInfo(string, ServiceCallback<void>)
function getNameExistsInfo(nameId: string, callback: ServiceCallback<void>)
パラメーター
- nameId
-
string
'fabric:' URI スキームを含まない Service Fabric 名。
- callback
-
ServiceCallback<void>
コールバック
getNameExistsInfo(string, ServiceFabricClientGetNameExistsInfoOptionalParams)
指定した Service Fabric 名が存在するかどうかを返します。
function getNameExistsInfo(nameId: string, options?: ServiceFabricClientGetNameExistsInfoOptionalParams): Promise<RestResponse>
パラメーター
- nameId
-
string
'fabric:' URI スキームを含まない Service Fabric 名。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
getNameExistsInfo(string, ServiceFabricClientGetNameExistsInfoOptionalParams, ServiceCallback<void>)
function getNameExistsInfo(nameId: string, options: ServiceFabricClientGetNameExistsInfoOptionalParams, callback: ServiceCallback<void>)
パラメーター
- nameId
-
string
'fabric:' URI スキームを含まない Service Fabric 名。
省略可能なパラメーター
- 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 UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの開始時刻。
- endTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの終了時刻。
- callback
コールバック
getNodeEventList(string, string, string, ServiceFabricClientGetNodeEventListOptionalParams)
応答は NodeEvent オブジェクトのリストです。
function getNodeEventList(nodeName: string, startTimeUtc: string, endTimeUtc: string, options?: ServiceFabricClientGetNodeEventListOptionalParams): Promise<GetNodeEventListResponse>
パラメーター
- nodeName
-
string
ノード名。
- startTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの開始時刻。
- endTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの終了時刻。
省略可能なパラメーター
戻り値
Promise<GetNodeEventListResponse>
Promise<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 UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの開始時刻。
- endTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの終了時刻。
省略可能なパラメーター
- callback
コールバック
getNodeHealth(string, ServiceCallback<NodeHealth>)
function getNodeHealth(nodeName: string, callback: ServiceCallback<NodeHealth>)
パラメーター
- nodeName
-
string
ノード名。
- callback
コールバック
getNodeHealth(string, ServiceFabricClientGetNodeHealthOptionalParams)
Service Fabric ノードの正常性を取得します。 EventsHealthStateFilter を使用して、正常性状態に基づいてノードで報告される正常性イベントのコレクションをフィルター処理します。 名前で指定したノードがヘルスストアに存在しない場合は、エラーが返されます。
function getNodeHealth(nodeName: string, options?: ServiceFabricClientGetNodeHealthOptionalParams): Promise<GetNodeHealthResponse>
パラメーター
- nodeName
-
string
ノード名。
省略可能なパラメーター
戻り値
Promise<GetNodeHealthResponse>
Promise<Models.GetNodeHealthResponse>
getNodeHealth(string, ServiceFabricClientGetNodeHealthOptionalParams, ServiceCallback<NodeHealth>)
function getNodeHealth(nodeName: string, options: ServiceFabricClientGetNodeHealthOptionalParams, callback: ServiceCallback<NodeHealth>)
パラメーター
- nodeName
-
string
ノード名。
省略可能なパラメーター
- callback
コールバック
getNodeHealthUsingPolicy(string, ServiceCallback<NodeHealth>)
function getNodeHealthUsingPolicy(nodeName: string, callback: ServiceCallback<NodeHealth>)
パラメーター
- nodeName
-
string
ノード名。
- callback
コールバック
getNodeHealthUsingPolicy(string, ServiceFabricClientGetNodeHealthUsingPolicyOptionalParams)
Service Fabric ノードの正常性を取得します。 EventsHealthStateFilter を使用して、正常性状態に基づいてノードで報告される正常性イベントのコレクションをフィルター処理します。 POST 本文で ClusterHealthPolicy を使用して、正常性の評価に使用される正常性ポリシーをオーバーライドします。 名前で指定したノードがヘルスストアに存在しない場合は、エラーが返されます。
function getNodeHealthUsingPolicy(nodeName: string, options?: ServiceFabricClientGetNodeHealthUsingPolicyOptionalParams): Promise<GetNodeHealthUsingPolicyResponse>
パラメーター
- nodeName
-
string
ノード名。
省略可能なパラメーター
戻り値
Promise<GetNodeHealthUsingPolicyResponse>
Promise<Models.GetNodeHealthUsingPolicyResponse>
getNodeHealthUsingPolicy(string, ServiceFabricClientGetNodeHealthUsingPolicyOptionalParams, ServiceCallback<NodeHealth>)
function getNodeHealthUsingPolicy(nodeName: string, options: ServiceFabricClientGetNodeHealthUsingPolicyOptionalParams, callback: ServiceCallback<NodeHealth>)
パラメーター
- nodeName
-
string
ノード名。
省略可能なパラメーター
- callback
コールバック
getNodeInfo(string, ServiceCallback<NodeInfo>)
function getNodeInfo(nodeName: string, callback: ServiceCallback<NodeInfo>)
パラメーター
- nodeName
-
string
ノード名。
- callback
コールバック
getNodeInfo(string, ServiceFabricClientGetNodeInfoOptionalParams)
応答には、名前、ステータス、ID、正常性、稼働時間、およびノードに関するその他の詳細が含まれます。
function getNodeInfo(nodeName: string, options?: ServiceFabricClientGetNodeInfoOptionalParams): Promise<GetNodeInfoResponse>
パラメーター
- nodeName
-
string
ノード名。
省略可能なパラメーター
戻り値
Promise<GetNodeInfoResponse>
Promise<Models.GetNodeInfo応答>
getNodeInfo(string, ServiceFabricClientGetNodeInfoOptionalParams, ServiceCallback<NodeInfo>)
function getNodeInfo(nodeName: string, options: ServiceFabricClientGetNodeInfoOptionalParams, callback: ServiceCallback<NodeInfo>)
パラメーター
- nodeName
-
string
ノード名。
省略可能なパラメーター
- callback
コールバック
getNodeInfoList(ServiceCallback<PagedNodeInfoList>)
function getNodeInfoList(callback: ServiceCallback<PagedNodeInfoList>)
パラメーター
- callback
コールバック
getNodeInfoList(ServiceFabricClientGetNodeInfoListOptionalParams)
応答には、名前、ステータス、ID、正常性、稼働時間、およびノードに関するその他の詳細が含まれます。
function getNodeInfoList(options?: ServiceFabricClientGetNodeInfoListOptionalParams): Promise<GetNodeInfoListResponse>
パラメーター
省略可能なパラメーター
戻り値
Promise<GetNodeInfoListResponse>
Promise<Models.GetNodeInfoListResponse応答>
getNodeInfoList(ServiceFabricClientGetNodeInfoListOptionalParams, ServiceCallback<PagedNodeInfoList>)
function getNodeInfoList(options: ServiceFabricClientGetNodeInfoListOptionalParams, callback: ServiceCallback<PagedNodeInfoList>)
パラメーター
省略可能なパラメーター
- callback
コールバック
getNodeLoadInfo(string, ServiceCallback<NodeLoadInfo>)
function getNodeLoadInfo(nodeName: string, callback: ServiceCallback<NodeLoadInfo>)
パラメーター
- nodeName
-
string
ノード名。
- callback
コールバック
getNodeLoadInfo(string, ServiceFabricClientGetNodeLoadInfoOptionalParams)
負荷または容量が定義されているすべてのメトリックの Service Fabric ノードの負荷情報を取得します。
function getNodeLoadInfo(nodeName: string, options?: ServiceFabricClientGetNodeLoadInfoOptionalParams): Promise<GetNodeLoadInfoResponse>
パラメーター
- nodeName
-
string
ノード名。
省略可能なパラメーター
戻り値
Promise<GetNodeLoadInfoResponse>
Promise<Models.GetNodeLoadInfo応答>
getNodeLoadInfo(string, ServiceFabricClientGetNodeLoadInfoOptionalParams, ServiceCallback<NodeLoadInfo>)
function getNodeLoadInfo(nodeName: string, options: ServiceFabricClientGetNodeLoadInfoOptionalParams, callback: ServiceCallback<NodeLoadInfo>)
パラメーター
- nodeName
-
string
ノード名。
省略可能なパラメーター
- callback
コールバック
getNodesEventList(string, string, ServiceCallback<NodeEventUnion[]>)
function getNodesEventList(startTimeUtc: string, endTimeUtc: string, callback: ServiceCallback<NodeEventUnion[]>)
パラメーター
- startTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの開始時刻。
- endTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの終了時刻。
- callback
コールバック
getNodesEventList(string, string, ServiceFabricClientGetNodesEventListOptionalParams)
応答は NodeEvent オブジェクトのリストです。
function getNodesEventList(startTimeUtc: string, endTimeUtc: string, options?: ServiceFabricClientGetNodesEventListOptionalParams): Promise<GetNodesEventListResponse>
パラメーター
- startTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの開始時刻。
- endTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの終了時刻。
省略可能なパラメーター
戻り値
Promise<GetNodesEventListResponse>
Promise<Models.GetNodesEventListResponse>
getNodesEventList(string, string, ServiceFabricClientGetNodesEventListOptionalParams, ServiceCallback<NodeEventUnion[]>)
function getNodesEventList(startTimeUtc: string, endTimeUtc: string, options: ServiceFabricClientGetNodesEventListOptionalParams, callback: ServiceCallback<NodeEventUnion[]>)
パラメーター
- startTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの開始時刻。
- endTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの終了時刻。
省略可能なパラメーター
- callback
コールバック
getNodeTransitionProgress(string, string, ServiceCallback<NodeTransitionProgress>)
function getNodeTransitionProgress(nodeName: string, operationId: string, callback: ServiceCallback<NodeTransitionProgress>)
パラメーター
- nodeName
-
string
ノード名。
- operationId
-
string
この API の呼び出しを識別する GUID。 これは、対応する GetProgress API に渡されます
- callback
コールバック
getNodeTransitionProgress(string, string, ServiceFabricClientGetNodeTransitionProgressOptionalParams)
指定された OperationId を使用して、StartNodeTransition で開始された操作の進行状況を取得します。
function getNodeTransitionProgress(nodeName: string, operationId: string, options?: ServiceFabricClientGetNodeTransitionProgressOptionalParams): Promise<GetNodeTransitionProgressResponse>
パラメーター
- nodeName
-
string
ノード名。
- operationId
-
string
この API の呼び出しを識別する GUID。 これは、対応する GetProgress API に渡されます
省略可能なパラメーター
戻り値
Promise<GetNodeTransitionProgressResponse>
Promise<Models.GetNodeTransitionProgressResponse>
getNodeTransitionProgress(string, string, ServiceFabricClientGetNodeTransitionProgressOptionalParams, ServiceCallback<NodeTransitionProgress>)
function getNodeTransitionProgress(nodeName: string, operationId: string, options: ServiceFabricClientGetNodeTransitionProgressOptionalParams, callback: ServiceCallback<NodeTransitionProgress>)
パラメーター
- nodeName
-
string
ノード名。
- operationId
-
string
この API の呼び出しを識別する GUID。 これは、対応する GetProgress API に渡されます
省略可能なパラメーター
- callback
コールバック
getPartitionBackupConfigurationInfo(string, ServiceCallback<PartitionBackupConfigurationInfo>)
function getPartitionBackupConfigurationInfo(partitionId: string, callback: ServiceCallback<PartitionBackupConfigurationInfo>)
パラメーター
- partitionId
-
string
パーティションの ID。
コールバック
getPartitionBackupConfigurationInfo(string, ServiceFabricClientGetPartitionBackupConfigurationInfoOptionalParams)
指定したパーティションの Service Fabric バックアップ構成情報を取得します。
function getPartitionBackupConfigurationInfo(partitionId: string, options?: ServiceFabricClientGetPartitionBackupConfigurationInfoOptionalParams): Promise<GetPartitionBackupConfigurationInfoResponse>
パラメーター
- partitionId
-
string
パーティションの ID。
省略可能なパラメーター
戻り値
Promise<Models.GetPartitionBackupConfigurationInfoResponse>
getPartitionBackupConfigurationInfo(string, ServiceFabricClientGetPartitionBackupConfigurationInfoOptionalParams, ServiceCallback<PartitionBackupConfigurationInfo>)
function getPartitionBackupConfigurationInfo(partitionId: string, options: ServiceFabricClientGetPartitionBackupConfigurationInfoOptionalParams, callback: ServiceCallback<PartitionBackupConfigurationInfo>)
パラメーター
- partitionId
-
string
パーティションの ID。
省略可能なパラメーター
コールバック
getPartitionBackupList(string, ServiceCallback<PagedBackupInfoList>)
function getPartitionBackupList(partitionId: string, callback: ServiceCallback<PagedBackupInfoList>)
パラメーター
- partitionId
-
string
パーティションの ID。
- callback
コールバック
getPartitionBackupList(string, ServiceFabricClientGetPartitionBackupListOptionalParams)
指定したパーティションで使用可能なバックアップのリストを返します。 サーバーは、バックアップ ポリシーで構成されたバックアップ ストアで使用可能なすべてのバックアップを列挙します。 また、開始日時と終了日時に基づいて結果をフィルタリングしたり、パーティションで利用可能な最新のバックアップを取得したりすることもできます。
function getPartitionBackupList(partitionId: string, options?: ServiceFabricClientGetPartitionBackupListOptionalParams): Promise<GetPartitionBackupListResponse>
パラメーター
- partitionId
-
string
パーティションの ID。
省略可能なパラメーター
戻り値
Promise<GetPartitionBackupListResponse>
Promise<Models.GetPartitionBackupListResponse>
getPartitionBackupList(string, ServiceFabricClientGetPartitionBackupListOptionalParams, ServiceCallback<PagedBackupInfoList>)
function getPartitionBackupList(partitionId: string, options: ServiceFabricClientGetPartitionBackupListOptionalParams, callback: ServiceCallback<PagedBackupInfoList>)
パラメーター
- partitionId
-
string
パーティションの ID。
省略可能なパラメーター
- callback
コールバック
getPartitionBackupProgress(string, ServiceCallback<BackupProgressInfo>)
function getPartitionBackupProgress(partitionId: string, callback: ServiceCallback<BackupProgressInfo>)
パラメーター
- partitionId
-
string
パーティションの ID。
- callback
コールバック
getPartitionBackupProgress(string, ServiceFabricClientGetPartitionBackupProgressOptionalParams)
最新のバックアップの状態に関する情報と、完了した場合の詳細または失敗の理由を返します。
function getPartitionBackupProgress(partitionId: string, options?: ServiceFabricClientGetPartitionBackupProgressOptionalParams): Promise<GetPartitionBackupProgressResponse>
パラメーター
- partitionId
-
string
パーティションの ID。
省略可能なパラメーター
戻り値
Promise<GetPartitionBackupProgressResponse>
Promise<Models.GetPartitionBackupProgressResponse>
getPartitionBackupProgress(string, ServiceFabricClientGetPartitionBackupProgressOptionalParams, ServiceCallback<BackupProgressInfo>)
function getPartitionBackupProgress(partitionId: string, options: ServiceFabricClientGetPartitionBackupProgressOptionalParams, callback: ServiceCallback<BackupProgressInfo>)
パラメーター
- partitionId
-
string
パーティションの ID。
省略可能なパラメーター
- callback
コールバック
getPartitionEventList(string, string, string, ServiceCallback<PartitionEventUnion[]>)
function getPartitionEventList(partitionId: string, startTimeUtc: string, endTimeUtc: string, callback: ServiceCallback<PartitionEventUnion[]>)
パラメーター
- partitionId
-
string
パーティションの ID。
- startTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの開始時刻。
- endTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの終了時刻。
- callback
コールバック
getPartitionEventList(string, string, string, ServiceFabricClientGetPartitionEventListOptionalParams)
応答は PartitionEvent オブジェクトのリストです。
function getPartitionEventList(partitionId: string, startTimeUtc: string, endTimeUtc: string, options?: ServiceFabricClientGetPartitionEventListOptionalParams): Promise<GetPartitionEventListResponse>
パラメーター
- partitionId
-
string
パーティションの ID。
- startTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの開始時刻。
- endTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの終了時刻。
省略可能なパラメーター
戻り値
Promise<GetPartitionEventListResponse>
Promise<Models.GetPartitionEventListResponse応答>
getPartitionEventList(string, string, string, ServiceFabricClientGetPartitionEventListOptionalParams, ServiceCallback<PartitionEventUnion[]>)
function getPartitionEventList(partitionId: string, startTimeUtc: string, endTimeUtc: string, options: ServiceFabricClientGetPartitionEventListOptionalParams, callback: ServiceCallback<PartitionEventUnion[]>)
パラメーター
- partitionId
-
string
パーティションの ID。
- startTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの開始時刻。
- endTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの終了時刻。
省略可能なパラメーター
- callback
コールバック
getPartitionHealth(string, ServiceCallback<PartitionHealth>)
function getPartitionHealth(partitionId: string, callback: ServiceCallback<PartitionHealth>)
パラメーター
- partitionId
-
string
パーティションの ID。
- callback
コールバック
getPartitionHealth(string, ServiceFabricClientGetPartitionHealthOptionalParams)
EventsHealthStateFilter を使用して、正常性状態に基づいてサービスで報告される正常性イベントのコレクションをフィルター処理します。 ReplicasHealthStateFilter を使用して、パーティション上の ReplicaHealthState オブジェクトのコレクションをフィルタリングします。 正常性ストアに存在しないパーティションを指定すると、この要求はエラーを返します。
function getPartitionHealth(partitionId: string, options?: ServiceFabricClientGetPartitionHealthOptionalParams): Promise<GetPartitionHealthResponse>
パラメーター
- partitionId
-
string
パーティションの ID。
省略可能なパラメーター
戻り値
Promise<GetPartitionHealthResponse>
Promise<Models.GetPartitionHealthResponse応答>
getPartitionHealth(string, ServiceFabricClientGetPartitionHealthOptionalParams, ServiceCallback<PartitionHealth>)
function getPartitionHealth(partitionId: string, options: ServiceFabricClientGetPartitionHealthOptionalParams, callback: ServiceCallback<PartitionHealth>)
パラメーター
- partitionId
-
string
パーティションの ID。
省略可能なパラメーター
- callback
コールバック
getPartitionHealthUsingPolicy(string, ServiceCallback<PartitionHealth>)
function getPartitionHealthUsingPolicy(partitionId: string, callback: ServiceCallback<PartitionHealth>)
パラメーター
- partitionId
-
string
パーティションの ID。
- callback
コールバック
getPartitionHealthUsingPolicy(string, ServiceFabricClientGetPartitionHealthUsingPolicyOptionalParams)
指定したパーティションの正常性情報を取得します。 アプリケーションの正常性ポリシーが指定されている場合、正常性評価では、そのポリシーを使用して集計された正常性状態を取得します。 ポリシーが指定されていない場合、正常性評価では、アプリケーション マニフェストで定義されているアプリケーション正常性ポリシーが使用され、マニフェストでポリシーが定義されていない場合は既定の正常性ポリシーが使用されます。 EventsHealthStateFilter を使用して、正常性状態に基づいてパーティションで報告される正常性イベントのコレクションをフィルター処理します。 ReplicasHealthStateFilter を使用して、パーティション上の ReplicaHealthState オブジェクトのコレクションをフィルタリングします。 POST 本文で ApplicationHealthPolicy を使用して、正常性の評価に使用される正常性ポリシーをオーバーライドします。 正常性ストアに存在しないパーティションを指定すると、この要求はエラーを返します。
function getPartitionHealthUsingPolicy(partitionId: string, options?: ServiceFabricClientGetPartitionHealthUsingPolicyOptionalParams): Promise<GetPartitionHealthUsingPolicyResponse>
パラメーター
- partitionId
-
string
パーティションの ID。
省略可能なパラメーター
戻り値
Promise<Models.GetPartitionHealthUsingPolicyResponseです。>
getPartitionHealthUsingPolicy(string, ServiceFabricClientGetPartitionHealthUsingPolicyOptionalParams, ServiceCallback<PartitionHealth>)
function getPartitionHealthUsingPolicy(partitionId: string, options: ServiceFabricClientGetPartitionHealthUsingPolicyOptionalParams, callback: ServiceCallback<PartitionHealth>)
パラメーター
- partitionId
-
string
パーティションの ID。
省略可能なパラメーター
- callback
コールバック
getPartitionInfo(string, ServiceCallback<ServicePartitionInfoUnion>)
function getPartitionInfo(partitionId: string, callback: ServiceCallback<ServicePartitionInfoUnion>)
パラメーター
- partitionId
-
string
パーティションの ID。
- callback
コールバック
getPartitionInfo(string, ServiceFabricClientGetPartitionInfoOptionalParams)
指定したパーティションに関する情報を取得します。 応答には、パーティション ID、パーティション スキーム情報、パーティションでサポートされているキー、状態、正常性、およびパーティションに関するその他の詳細が含まれます。
function getPartitionInfo(partitionId: string, options?: ServiceFabricClientGetPartitionInfoOptionalParams): Promise<GetPartitionInfoResponse>
パラメーター
- partitionId
-
string
パーティションの ID。
省略可能なパラメーター
戻り値
Promise<GetPartitionInfoResponse>
Promise<Models.GetPartitionInfoResponse>
getPartitionInfo(string, ServiceFabricClientGetPartitionInfoOptionalParams, ServiceCallback<ServicePartitionInfoUnion>)
function getPartitionInfo(partitionId: string, options: ServiceFabricClientGetPartitionInfoOptionalParams, callback: ServiceCallback<ServicePartitionInfoUnion>)
パラメーター
- partitionId
-
string
パーティションの ID。
省略可能なパラメーター
- callback
コールバック
getPartitionInfoList(string, ServiceCallback<PagedServicePartitionInfoList>)
function getPartitionInfoList(serviceId: string, callback: ServiceCallback<PagedServicePartitionInfoList>)
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
- callback
コールバック
getPartitionInfoList(string, ServiceFabricClientGetPartitionInfoListOptionalParams)
応答には、パーティション ID、パーティション スキーム情報、パーティションでサポートされているキー、状態、正常性、およびパーティションに関するその他の詳細が含まれます。
function getPartitionInfoList(serviceId: string, options?: ServiceFabricClientGetPartitionInfoListOptionalParams): Promise<GetPartitionInfoListResponse>
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
省略可能なパラメーター
戻り値
Promise<GetPartitionInfoListResponse>
Promise<Models.GetPartitionInfoListResponse応答>
getPartitionInfoList(string, ServiceFabricClientGetPartitionInfoListOptionalParams, ServiceCallback<PagedServicePartitionInfoList>)
function getPartitionInfoList(serviceId: string, options: ServiceFabricClientGetPartitionInfoListOptionalParams, callback: ServiceCallback<PagedServicePartitionInfoList>)
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
省略可能なパラメーター
- callback
コールバック
getPartitionLoadInformation(string, ServiceCallback<PartitionLoadInformation>)
function getPartitionLoadInformation(partitionId: string, callback: ServiceCallback<PartitionLoadInformation>)
パラメーター
- partitionId
-
string
パーティションの ID。
- callback
コールバック
getPartitionLoadInformation(string, ServiceFabricClientGetPartitionLoadInformationOptionalParams)
指定した区画の負荷に関する情報を返します。 応答には、Service Fabric パーティションの負荷レポートの一覧が含まれます。 各レポートには、ロードメトリック名、値、および最終報告時刻(UTC)が含まれます。
function getPartitionLoadInformation(partitionId: string, options?: ServiceFabricClientGetPartitionLoadInformationOptionalParams): Promise<GetPartitionLoadInformationResponse>
パラメーター
- partitionId
-
string
パーティションの ID。
省略可能なパラメーター
戻り値
Promise<GetPartitionLoadInformationResponse>
Promise<Models.GetPartitionLoadInformationResponse応答>
getPartitionLoadInformation(string, ServiceFabricClientGetPartitionLoadInformationOptionalParams, ServiceCallback<PartitionLoadInformation>)
function getPartitionLoadInformation(partitionId: string, options: ServiceFabricClientGetPartitionLoadInformationOptionalParams, callback: ServiceCallback<PartitionLoadInformation>)
パラメーター
- partitionId
-
string
パーティションの ID。
省略可能なパラメーター
- callback
コールバック
getPartitionReplicaEventList(string, string, string, string, ServiceCallback<ReplicaEventUnion[]>)
function getPartitionReplicaEventList(partitionId: string, replicaId: string, startTimeUtc: string, endTimeUtc: string, callback: ServiceCallback<ReplicaEventUnion[]>)
パラメーター
- partitionId
-
string
パーティションの ID。
- replicaId
-
string
レプリカの識別子。
- startTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの開始時刻。
- endTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの終了時刻。
- callback
コールバック
getPartitionReplicaEventList(string, string, string, string, ServiceFabricClientGetPartitionReplicaEventListOptionalParams)
応答は ReplicaEvent オブジェクトのリストです。
function getPartitionReplicaEventList(partitionId: string, replicaId: string, startTimeUtc: string, endTimeUtc: string, options?: ServiceFabricClientGetPartitionReplicaEventListOptionalParams): Promise<GetPartitionReplicaEventListResponse>
パラメーター
- partitionId
-
string
パーティションの ID。
- replicaId
-
string
レプリカの識別子。
- startTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの開始時刻。
- endTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの終了時刻。
省略可能なパラメーター
戻り値
Promise<GetPartitionReplicaEventListResponse>
Promise<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
パーティションの ID。
- replicaId
-
string
レプリカの識別子。
- startTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの開始時刻。
- endTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの終了時刻。
省略可能なパラメーター
- callback
コールバック
getPartitionReplicasEventList(string, string, string, ServiceCallback<ReplicaEventUnion[]>)
function getPartitionReplicasEventList(partitionId: string, startTimeUtc: string, endTimeUtc: string, callback: ServiceCallback<ReplicaEventUnion[]>)
パラメーター
- partitionId
-
string
パーティションの ID。
- startTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの開始時刻。
- endTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの終了時刻。
- callback
コールバック
getPartitionReplicasEventList(string, string, string, ServiceFabricClientGetPartitionReplicasEventListOptionalParams)
応答は ReplicaEvent オブジェクトのリストです。
function getPartitionReplicasEventList(partitionId: string, startTimeUtc: string, endTimeUtc: string, options?: ServiceFabricClientGetPartitionReplicasEventListOptionalParams): Promise<GetPartitionReplicasEventListResponse>
パラメーター
- partitionId
-
string
パーティションの ID。
- startTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの開始時刻。
- endTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの終了時刻。
省略可能なパラメーター
戻り値
Promise<Models.GetPartitionReplicasEventListResponse>
getPartitionReplicasEventList(string, string, string, ServiceFabricClientGetPartitionReplicasEventListOptionalParams, ServiceCallback<ReplicaEventUnion[]>)
function getPartitionReplicasEventList(partitionId: string, startTimeUtc: string, endTimeUtc: string, options: ServiceFabricClientGetPartitionReplicasEventListOptionalParams, callback: ServiceCallback<ReplicaEventUnion[]>)
パラメーター
- partitionId
-
string
パーティションの ID。
- startTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの開始時刻。
- endTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの終了時刻。
省略可能なパラメーター
- callback
コールバック
getPartitionRestartProgress(string, string, string, ServiceCallback<PartitionRestartProgress>)
function getPartitionRestartProgress(serviceId: string, partitionId: string, operationId: string, callback: ServiceCallback<PartitionRestartProgress>)
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
- partitionId
-
string
パーティションの ID。
- operationId
-
string
この API の呼び出しを識別する GUID。 これは、対応する GetProgress API に渡されます
- callback
コールバック
getPartitionRestartProgress(string, string, string, ServiceFabricClientGetPartitionRestartProgressOptionalParams)
指定された OperationId を使用して、StartPartitionRestart で開始された PartitionRestart の進行状況を取得します。
function getPartitionRestartProgress(serviceId: string, partitionId: string, operationId: string, options?: ServiceFabricClientGetPartitionRestartProgressOptionalParams): Promise<GetPartitionRestartProgressResponse>
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
- partitionId
-
string
パーティションの ID。
- operationId
-
string
この API の呼び出しを識別する GUID。 これは、対応する GetProgress API に渡されます
省略可能なパラメーター
戻り値
Promise<GetPartitionRestartProgressResponse>
Promise<Models.GetPartitionRestartProgressResponse>
getPartitionRestartProgress(string, string, string, ServiceFabricClientGetPartitionRestartProgressOptionalParams, ServiceCallback<PartitionRestartProgress>)
function getPartitionRestartProgress(serviceId: string, partitionId: string, operationId: string, options: ServiceFabricClientGetPartitionRestartProgressOptionalParams, callback: ServiceCallback<PartitionRestartProgress>)
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
- partitionId
-
string
パーティションの ID。
- operationId
-
string
この API の呼び出しを識別する GUID。 これは、対応する GetProgress API に渡されます
省略可能なパラメーター
- callback
コールバック
getPartitionRestoreProgress(string, ServiceCallback<RestoreProgressInfo>)
function getPartitionRestoreProgress(partitionId: string, callback: ServiceCallback<RestoreProgressInfo>)
パラメーター
- partitionId
-
string
パーティションの ID。
- callback
コールバック
getPartitionRestoreProgress(string, ServiceFabricClientGetPartitionRestoreProgressOptionalParams)
最新の復元操作の状態に関する情報と、完了した場合の詳細または失敗の理由を返します。
function getPartitionRestoreProgress(partitionId: string, options?: ServiceFabricClientGetPartitionRestoreProgressOptionalParams): Promise<GetPartitionRestoreProgressResponse>
パラメーター
- partitionId
-
string
パーティションの ID。
省略可能なパラメーター
戻り値
Promise<GetPartitionRestoreProgressResponse>
Promise<Models.GetPartitionRestoreProgressResponse>
getPartitionRestoreProgress(string, ServiceFabricClientGetPartitionRestoreProgressOptionalParams, ServiceCallback<RestoreProgressInfo>)
function getPartitionRestoreProgress(partitionId: string, options: ServiceFabricClientGetPartitionRestoreProgressOptionalParams, callback: ServiceCallback<RestoreProgressInfo>)
パラメーター
- partitionId
-
string
パーティションの ID。
省略可能なパラメーター
- callback
コールバック
getPartitionsEventList(string, string, ServiceCallback<PartitionEventUnion[]>)
function getPartitionsEventList(startTimeUtc: string, endTimeUtc: string, callback: ServiceCallback<PartitionEventUnion[]>)
パラメーター
- startTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの開始時刻。
- endTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの終了時刻。
- callback
コールバック
getPartitionsEventList(string, string, ServiceFabricClientGetPartitionsEventListOptionalParams)
応答は PartitionEvent オブジェクトのリストです。
function getPartitionsEventList(startTimeUtc: string, endTimeUtc: string, options?: ServiceFabricClientGetPartitionsEventListOptionalParams): Promise<GetPartitionsEventListResponse>
パラメーター
- startTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの開始時刻。
- endTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの終了時刻。
省略可能なパラメーター
戻り値
Promise<GetPartitionsEventListResponse>
Promise<Models.GetPartitionsEventListResponse応答>
getPartitionsEventList(string, string, ServiceFabricClientGetPartitionsEventListOptionalParams, ServiceCallback<PartitionEventUnion[]>)
function getPartitionsEventList(startTimeUtc: string, endTimeUtc: string, options: ServiceFabricClientGetPartitionsEventListOptionalParams, callback: ServiceCallback<PartitionEventUnion[]>)
パラメーター
- startTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの開始時刻。
- endTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの終了時刻。
省略可能なパラメーター
- callback
コールバック
getPropertyInfo(string, string, ServiceCallback<PropertyInfo>)
function getPropertyInfo(nameId: string, propertyName: string, callback: ServiceCallback<PropertyInfo>)
パラメーター
- nameId
-
string
'fabric:' URI スキームを含まない Service Fabric 名。
- propertyName
-
string
取得するプロパティの名前を指定します。
- callback
コールバック
getPropertyInfo(string, string, ServiceFabricClientGetPropertyInfoOptionalParams)
指定された Service Fabric プロパティを指定された名前で取得します。 これにより、常に値とメタデータの両方が返されます。
function getPropertyInfo(nameId: string, propertyName: string, options?: ServiceFabricClientGetPropertyInfoOptionalParams): Promise<GetPropertyInfoResponse>
パラメーター
- nameId
-
string
'fabric:' URI スキームを含まない Service Fabric 名。
- propertyName
-
string
取得するプロパティの名前を指定します。
省略可能なパラメーター
戻り値
Promise<GetPropertyInfoResponse>
Promise<Models.GetPropertyInfoResponse>
getPropertyInfo(string, string, ServiceFabricClientGetPropertyInfoOptionalParams, ServiceCallback<PropertyInfo>)
function getPropertyInfo(nameId: string, propertyName: string, options: ServiceFabricClientGetPropertyInfoOptionalParams, callback: ServiceCallback<PropertyInfo>)
パラメーター
- nameId
-
string
'fabric:' URI スキームを含まない Service Fabric 名。
- propertyName
-
string
取得するプロパティの名前を指定します。
省略可能なパラメーター
- callback
コールバック
getPropertyInfoList(string, ServiceCallback<PagedPropertyInfoList>)
function getPropertyInfoList(nameId: string, callback: ServiceCallback<PagedPropertyInfoList>)
パラメーター
- nameId
-
string
'fabric:' URI スキームを含まない Service Fabric 名。
- callback
コールバック
getPropertyInfoList(string, ServiceFabricClientGetPropertyInfoListOptionalParams)
Service Fabric 名には、カスタム情報を格納する 1 つ以上の名前付きプロパティを含めることができます。 この操作は、ページ リスト内のこれらのプロパティに関する情報を取得します。 この情報には、各プロパティーに関する名前、値、メタデータが含まれます。
function getPropertyInfoList(nameId: string, options?: ServiceFabricClientGetPropertyInfoListOptionalParams): Promise<GetPropertyInfoListResponse>
パラメーター
- nameId
-
string
'fabric:' URI スキームを含まない Service Fabric 名。
省略可能なパラメーター
戻り値
Promise<GetPropertyInfoListResponse>
Promise<Models.GetPropertyInfoListResponse応答>
getPropertyInfoList(string, ServiceFabricClientGetPropertyInfoListOptionalParams, ServiceCallback<PagedPropertyInfoList>)
function getPropertyInfoList(nameId: string, options: ServiceFabricClientGetPropertyInfoListOptionalParams, callback: ServiceCallback<PagedPropertyInfoList>)
パラメーター
- nameId
-
string
'fabric:' URI スキームを含まない Service Fabric 名。
省略可能なパラメーター
- callback
コールバック
getProvisionedFabricCodeVersionInfoList(ServiceCallback<FabricCodeVersionInfo[]>)
function getProvisionedFabricCodeVersionInfoList(callback: ServiceCallback<FabricCodeVersionInfo[]>)
パラメーター
- callback
コールバック
getProvisionedFabricCodeVersionInfoList(ServiceFabricClientGetProvisionedFabricCodeVersionInfoListOptionalParams)
クラスターにプロビジョニングされているファブリック コードのバージョンに関する情報の一覧を取得します。 パラメーター CodeVersion を使用して、必要に応じて、その特定のバージョンのみに出力をフィルター処理できます。
function getProvisionedFabricCodeVersionInfoList(options?: ServiceFabricClientGetProvisionedFabricCodeVersionInfoListOptionalParams): Promise<GetProvisionedFabricCodeVersionInfoListResponse>
パラメーター
省略可能なパラメーター
戻り値
Promise<Models.GetProvisionedFabricCodeVersionInfoListResponse応答>
getProvisionedFabricCodeVersionInfoList(ServiceFabricClientGetProvisionedFabricCodeVersionInfoListOptionalParams, ServiceCallback<FabricCodeVersionInfo[]>)
function getProvisionedFabricCodeVersionInfoList(options: ServiceFabricClientGetProvisionedFabricCodeVersionInfoListOptionalParams, callback: ServiceCallback<FabricCodeVersionInfo[]>)
パラメーター
省略可能なパラメーター
- callback
コールバック
getProvisionedFabricConfigVersionInfoList(ServiceCallback<FabricConfigVersionInfo[]>)
function getProvisionedFabricConfigVersionInfoList(callback: ServiceCallback<FabricConfigVersionInfo[]>)
パラメーター
- callback
コールバック
getProvisionedFabricConfigVersionInfoList(ServiceFabricClientGetProvisionedFabricConfigVersionInfoListOptionalParams)
クラスターでプロビジョニングされているファブリック構成バージョンに関する情報の一覧を取得します。 パラメータ ConfigVersion を使用して、オプションで出力をその特定のバージョンのみにフィルタリングできます。
function getProvisionedFabricConfigVersionInfoList(options?: ServiceFabricClientGetProvisionedFabricConfigVersionInfoListOptionalParams): Promise<GetProvisionedFabricConfigVersionInfoListResponse>
パラメーター
省略可能なパラメーター
戻り値
Promise<Models.GetProvisionedFabricConfigVersionInfoListResponse応答>
getProvisionedFabricConfigVersionInfoList(ServiceFabricClientGetProvisionedFabricConfigVersionInfoListOptionalParams, ServiceCallback<FabricConfigVersionInfo[]>)
function getProvisionedFabricConfigVersionInfoList(options: ServiceFabricClientGetProvisionedFabricConfigVersionInfoListOptionalParams, callback: ServiceCallback<FabricConfigVersionInfo[]>)
パラメーター
省略可能なパラメーター
- callback
コールバック
getQuorumLossProgress(string, string, string, ServiceCallback<PartitionQuorumLossProgress>)
function getQuorumLossProgress(serviceId: string, partitionId: string, operationId: string, callback: ServiceCallback<PartitionQuorumLossProgress>)
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
- partitionId
-
string
パーティションの ID。
- operationId
-
string
この API の呼び出しを識別する GUID。 これは、対応する GetProgress API に渡されます
- callback
コールバック
getQuorumLossProgress(string, string, string, ServiceFabricClientGetQuorumLossProgressOptionalParams)
指定された OperationId を使用して、StartQuorumLoss で開始されたクォーラム損失操作の進行状況を取得します。
function getQuorumLossProgress(serviceId: string, partitionId: string, operationId: string, options?: ServiceFabricClientGetQuorumLossProgressOptionalParams): Promise<GetQuorumLossProgressResponse>
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
- partitionId
-
string
パーティションの ID。
- operationId
-
string
この API の呼び出しを識別する GUID。 これは、対応する GetProgress API に渡されます
省略可能なパラメーター
戻り値
Promise<GetQuorumLossProgressResponse>
Promise<Models.GetQuorumLossProgressResponse応答>
getQuorumLossProgress(string, string, string, ServiceFabricClientGetQuorumLossProgressOptionalParams, ServiceCallback<PartitionQuorumLossProgress>)
function getQuorumLossProgress(serviceId: string, partitionId: string, operationId: string, options: ServiceFabricClientGetQuorumLossProgressOptionalParams, callback: ServiceCallback<PartitionQuorumLossProgress>)
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
- partitionId
-
string
パーティションの ID。
- operationId
-
string
この API の呼び出しを識別する GUID。 これは、対応する GetProgress API に渡されます
省略可能なパラメーター
- callback
コールバック
getRepairTaskList(ServiceCallback<RepairTask[]>)
function getRepairTaskList(callback: ServiceCallback<RepairTask[]>)
パラメーター
- callback
コールバック
getRepairTaskList(ServiceFabricClientGetRepairTaskListOptionalParams)
この API は Service Fabric プラットフォームをサポートします。コードから直接使用することを意図したものではありません。
function getRepairTaskList(options?: ServiceFabricClientGetRepairTaskListOptionalParams): Promise<GetRepairTaskListResponse>
パラメーター
省略可能なパラメーター
戻り値
Promise<GetRepairTaskListResponse>
Promise<Models.GetRepairTaskListResponse>
getRepairTaskList(ServiceFabricClientGetRepairTaskListOptionalParams, ServiceCallback<RepairTask[]>)
function getRepairTaskList(options: ServiceFabricClientGetRepairTaskListOptionalParams, callback: ServiceCallback<RepairTask[]>)
パラメーター
省略可能なパラメーター
- callback
コールバック
getReplicaHealth(string, string, ServiceCallback<ReplicaHealthUnion>)
function getReplicaHealth(partitionId: string, replicaId: string, callback: ServiceCallback<ReplicaHealthUnion>)
パラメーター
- partitionId
-
string
パーティションの ID。
- replicaId
-
string
レプリカの識別子。
- callback
コールバック
getReplicaHealth(string, string, ServiceFabricClientGetReplicaHealthOptionalParams)
Service Fabric レプリカの正常性を取得します。 EventsHealthStateFilter を使用して、正常性状態に基づいてレプリカで報告される正常性イベントのコレクションをフィルター処理します。
function getReplicaHealth(partitionId: string, replicaId: string, options?: ServiceFabricClientGetReplicaHealthOptionalParams): Promise<GetReplicaHealthResponse>
パラメーター
- partitionId
-
string
パーティションの ID。
- replicaId
-
string
レプリカの識別子。
省略可能なパラメーター
戻り値
Promise<GetReplicaHealthResponse>
Promise<Models.GetReplicaHealthResponse>
getReplicaHealth(string, string, ServiceFabricClientGetReplicaHealthOptionalParams, ServiceCallback<ReplicaHealthUnion>)
function getReplicaHealth(partitionId: string, replicaId: string, options: ServiceFabricClientGetReplicaHealthOptionalParams, callback: ServiceCallback<ReplicaHealthUnion>)
パラメーター
- partitionId
-
string
パーティションの ID。
- replicaId
-
string
レプリカの識別子。
省略可能なパラメーター
- callback
コールバック
getReplicaHealthUsingPolicy(string, string, ServiceCallback<ReplicaHealthUnion>)
function getReplicaHealthUsingPolicy(partitionId: string, replicaId: string, callback: ServiceCallback<ReplicaHealthUnion>)
パラメーター
- partitionId
-
string
パーティションの ID。
- replicaId
-
string
レプリカの識別子。
- callback
コールバック
getReplicaHealthUsingPolicy(string, string, ServiceFabricClientGetReplicaHealthUsingPolicyOptionalParams)
Service Fabric ステートフル サービス レプリカまたはステートレス サービス インスタンスの正常性を取得します。 EventsHealthStateFilter を使用して、正常性状態に基づいてクラスターで報告される正常性イベントのコレクションをフィルター処理します。 ApplicationHealthPolicy を使用して、必要に応じて、正常性の評価に使用される正常性ポリシーをオーバーライドします。 この API は、ApplicationHealthPolicy の 'ConsiderWarningAsError' フィールドのみを使用します。 残りのフィールドは、レプリカの正常性を評価する際に無視されます。
function getReplicaHealthUsingPolicy(partitionId: string, replicaId: string, options?: ServiceFabricClientGetReplicaHealthUsingPolicyOptionalParams): Promise<GetReplicaHealthUsingPolicyResponse>
パラメーター
- partitionId
-
string
パーティションの ID。
- replicaId
-
string
レプリカの識別子。
省略可能なパラメーター
戻り値
Promise<GetReplicaHealthUsingPolicyResponse>
Promise<Models.GetReplicaHealthUsingPolicyResponse>
getReplicaHealthUsingPolicy(string, string, ServiceFabricClientGetReplicaHealthUsingPolicyOptionalParams, ServiceCallback<ReplicaHealthUnion>)
function getReplicaHealthUsingPolicy(partitionId: string, replicaId: string, options: ServiceFabricClientGetReplicaHealthUsingPolicyOptionalParams, callback: ServiceCallback<ReplicaHealthUnion>)
パラメーター
- partitionId
-
string
パーティションの ID。
- replicaId
-
string
レプリカの識別子。
省略可能なパラメーター
- callback
コールバック
getReplicaInfo(string, string, ServiceCallback<ReplicaInfoUnion>)
function getReplicaInfo(partitionId: string, replicaId: string, callback: ServiceCallback<ReplicaInfoUnion>)
パラメーター
- partitionId
-
string
パーティションの ID。
- replicaId
-
string
レプリカの識別子。
- callback
コールバック
getReplicaInfo(string, string, ServiceFabricClientGetReplicaInfoOptionalParams)
応答には、レプリカに関する ID、ロール、状態、正常性、ノード名、稼働時間、その他の詳細が含まれます。
function getReplicaInfo(partitionId: string, replicaId: string, options?: ServiceFabricClientGetReplicaInfoOptionalParams): Promise<GetReplicaInfoResponse>
パラメーター
- partitionId
-
string
パーティションの ID。
- replicaId
-
string
レプリカの識別子。
省略可能なパラメーター
戻り値
Promise<GetReplicaInfoResponse>
Promise<Models.GetReplicaInfoResponse>
getReplicaInfo(string, string, ServiceFabricClientGetReplicaInfoOptionalParams, ServiceCallback<ReplicaInfoUnion>)
function getReplicaInfo(partitionId: string, replicaId: string, options: ServiceFabricClientGetReplicaInfoOptionalParams, callback: ServiceCallback<ReplicaInfoUnion>)
パラメーター
- partitionId
-
string
パーティションの ID。
- replicaId
-
string
レプリカの識別子。
省略可能なパラメーター
- callback
コールバック
getReplicaInfoList(string, ServiceCallback<PagedReplicaInfoList>)
function getReplicaInfoList(partitionId: string, callback: ServiceCallback<PagedReplicaInfoList>)
パラメーター
- partitionId
-
string
パーティションの ID。
- callback
コールバック
getReplicaInfoList(string, ServiceFabricClientGetReplicaInfoListOptionalParams)
GetReplicas エンドポイントは、指定されたパーティションのレプリカに関する情報を返します。 応答には、レプリカに関する ID、ロール、状態、正常性、ノード名、稼働時間、その他の詳細が含まれます。
function getReplicaInfoList(partitionId: string, options?: ServiceFabricClientGetReplicaInfoListOptionalParams): Promise<GetReplicaInfoListResponse>
パラメーター
- partitionId
-
string
パーティションの ID。
省略可能なパラメーター
戻り値
Promise<GetReplicaInfoListResponse>
Promise<Models.GetReplicaInfoListResponse応答>
getReplicaInfoList(string, ServiceFabricClientGetReplicaInfoListOptionalParams, ServiceCallback<PagedReplicaInfoList>)
function getReplicaInfoList(partitionId: string, options: ServiceFabricClientGetReplicaInfoListOptionalParams, callback: ServiceCallback<PagedReplicaInfoList>)
パラメーター
- partitionId
-
string
パーティションの ID。
省略可能なパラメーター
- callback
コールバック
getServiceBackupConfigurationInfo(string, ServiceCallback<PagedBackupConfigurationInfoList>)
function getServiceBackupConfigurationInfo(serviceId: string, callback: ServiceCallback<PagedBackupConfigurationInfoList>)
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
コールバック
getServiceBackupConfigurationInfo(string, ServiceFabricClientGetServiceBackupConfigurationInfoOptionalParams)
サービスとこのサービスの下のパーティションの Service Fabric バックアップ構成情報を取得します。
function getServiceBackupConfigurationInfo(serviceId: string, options?: ServiceFabricClientGetServiceBackupConfigurationInfoOptionalParams): Promise<GetServiceBackupConfigurationInfoResponse>
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
省略可能なパラメーター
戻り値
Promise<Models.GetServiceBackupConfigurationInfoResponse応答>
getServiceBackupConfigurationInfo(string, ServiceFabricClientGetServiceBackupConfigurationInfoOptionalParams, ServiceCallback<PagedBackupConfigurationInfoList>)
function getServiceBackupConfigurationInfo(serviceId: string, options: ServiceFabricClientGetServiceBackupConfigurationInfoOptionalParams, callback: ServiceCallback<PagedBackupConfigurationInfoList>)
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
省略可能なパラメーター
コールバック
getServiceBackupList(string, ServiceCallback<PagedBackupInfoList>)
function getServiceBackupList(serviceId: string, callback: ServiceCallback<PagedBackupInfoList>)
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
- callback
コールバック
getServiceBackupList(string, ServiceFabricClientGetServiceBackupListOptionalParams)
この Service Fabric サービス内のすべてのパーティションで使用できるバックアップの一覧を返します。 サーバーは、バックアップ ポリシーで構成されたバックアップ ストアで使用可能なすべてのバックアップを列挙します。 また、start と end datetime に基づいて結果をフィルター処理したり、すべてのパーティションで使用可能な最新のバックアップをフェッチしたりすることもできます。
function getServiceBackupList(serviceId: string, options?: ServiceFabricClientGetServiceBackupListOptionalParams): Promise<GetServiceBackupListResponse>
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
省略可能なパラメーター
戻り値
Promise<GetServiceBackupListResponse>
Promise<Models.GetServiceBackupListResponse>
getServiceBackupList(string, ServiceFabricClientGetServiceBackupListOptionalParams, ServiceCallback<PagedBackupInfoList>)
function getServiceBackupList(serviceId: string, options: ServiceFabricClientGetServiceBackupListOptionalParams, callback: ServiceCallback<PagedBackupInfoList>)
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
省略可能なパラメーター
- callback
コールバック
getServiceDescription(string, ServiceCallback<ServiceDescriptionUnion>)
function getServiceDescription(serviceId: string, callback: ServiceCallback<ServiceDescriptionUnion>)
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
- callback
コールバック
getServiceDescription(string, ServiceFabricClientGetServiceDescriptionOptionalParams)
既存の Service Fabric サービスの説明を取得します。 サービスは、その説明を取得する前に作成する必要があります。
function getServiceDescription(serviceId: string, options?: ServiceFabricClientGetServiceDescriptionOptionalParams): Promise<GetServiceDescriptionResponse>
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
省略可能なパラメーター
戻り値
Promise<GetServiceDescriptionResponse>
Promise<Models.GetServiceDescriptionResponse応答>
getServiceDescription(string, ServiceFabricClientGetServiceDescriptionOptionalParams, ServiceCallback<ServiceDescriptionUnion>)
function getServiceDescription(serviceId: string, options: ServiceFabricClientGetServiceDescriptionOptionalParams, callback: ServiceCallback<ServiceDescriptionUnion>)
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
省略可能なパラメーター
- callback
コールバック
getServiceEventList(string, string, string, ServiceCallback<ServiceEventUnion[]>)
function getServiceEventList(serviceId: string, startTimeUtc: string, endTimeUtc: string, callback: ServiceCallback<ServiceEventUnion[]>)
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
- startTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの開始時刻。
- endTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの終了時刻。
- callback
コールバック
getServiceEventList(string, string, string, ServiceFabricClientGetServiceEventListOptionalParams)
応答は ServiceEvent オブジェクトのリストです。
function getServiceEventList(serviceId: string, startTimeUtc: string, endTimeUtc: string, options?: ServiceFabricClientGetServiceEventListOptionalParams): Promise<GetServiceEventListResponse>
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
- startTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの開始時刻。
- endTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの終了時刻。
省略可能なパラメーター
戻り値
Promise<GetServiceEventListResponse>
Promise<Models.GetServiceEventListResponse応答>
getServiceEventList(string, string, string, ServiceFabricClientGetServiceEventListOptionalParams, ServiceCallback<ServiceEventUnion[]>)
function getServiceEventList(serviceId: string, startTimeUtc: string, endTimeUtc: string, options: ServiceFabricClientGetServiceEventListOptionalParams, callback: ServiceCallback<ServiceEventUnion[]>)
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
- startTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの開始時刻。
- endTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの終了時刻。
省略可能なパラメーター
- callback
コールバック
getServiceHealth(string, ServiceCallback<ServiceHealth>)
function getServiceHealth(serviceId: string, callback: ServiceCallback<ServiceHealth>)
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
- callback
コールバック
getServiceHealth(string, ServiceFabricClientGetServiceHealthOptionalParams)
指定したサービスの正常性情報を取得します。 EventsHealthStateFilter を使用して、正常性状態に基づいてサービスで報告される正常性イベントのコレクションをフィルター処理します。 PartitionsHealthStateFilter を使用して、返されたパーティションのコレクションをフィルター処理します。 正常性ストアに存在しないサービスを指定した場合、この要求はエラーを返します。
function getServiceHealth(serviceId: string, options?: ServiceFabricClientGetServiceHealthOptionalParams): Promise<GetServiceHealthResponse>
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
省略可能なパラメーター
戻り値
Promise<GetServiceHealthResponse>
Promise<Models.GetServiceHealthResponse>
getServiceHealth(string, ServiceFabricClientGetServiceHealthOptionalParams, ServiceCallback<ServiceHealth>)
function getServiceHealth(serviceId: string, options: ServiceFabricClientGetServiceHealthOptionalParams, callback: ServiceCallback<ServiceHealth>)
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
省略可能なパラメーター
- callback
コールバック
getServiceHealthUsingPolicy(string, ServiceCallback<ServiceHealth>)
function getServiceHealthUsingPolicy(serviceId: string, callback: ServiceCallback<ServiceHealth>)
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
- callback
コールバック
getServiceHealthUsingPolicy(string, ServiceFabricClientGetServiceHealthUsingPolicyOptionalParams)
指定したサービスの正常性情報を取得します。 アプリケーションの正常性ポリシーが指定されている場合、正常性評価では、そのポリシーを使用して集計された正常性状態を取得します。 ポリシーが指定されていない場合、正常性評価では、アプリケーション マニフェストで定義されているアプリケーション正常性ポリシーが使用され、マニフェストでポリシーが定義されていない場合は既定の正常性ポリシーが使用されます。 EventsHealthStateFilter を使用して、正常性状態に基づいてサービスで報告される正常性イベントのコレクションをフィルター処理します。 PartitionsHealthStateFilter を使用して、返されたパーティションのコレクションをフィルター処理します。 正常性ストアに存在しないサービスを指定した場合、この要求はエラーを返します。
function getServiceHealthUsingPolicy(serviceId: string, options?: ServiceFabricClientGetServiceHealthUsingPolicyOptionalParams): Promise<GetServiceHealthUsingPolicyResponse>
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
省略可能なパラメーター
戻り値
Promise<GetServiceHealthUsingPolicyResponse>
Promise<Models.GetServiceHealthUsingPolicyResponseです>
getServiceHealthUsingPolicy(string, ServiceFabricClientGetServiceHealthUsingPolicyOptionalParams, ServiceCallback<ServiceHealth>)
function getServiceHealthUsingPolicy(serviceId: string, options: ServiceFabricClientGetServiceHealthUsingPolicyOptionalParams, callback: ServiceCallback<ServiceHealth>)
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
省略可能なパラメーター
- callback
コールバック
getServiceInfo(string, string, ServiceCallback<ServiceInfoUnion>)
function getServiceInfo(applicationId: string, serviceId: string, callback: ServiceCallback<ServiceInfoUnion>)
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
- callback
コールバック
getServiceInfo(string, string, ServiceFabricClientGetServiceInfoOptionalParams)
指定された Service Fabric アプリケーションに属する指定されたサービスに関する情報を返します。
function getServiceInfo(applicationId: string, serviceId: string, options?: ServiceFabricClientGetServiceInfoOptionalParams): Promise<GetServiceInfoResponse>
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
省略可能なパラメーター
戻り値
Promise<GetServiceInfoResponse>
Promise<Models.GetServiceInfoResponse>
getServiceInfo(string, string, ServiceFabricClientGetServiceInfoOptionalParams, ServiceCallback<ServiceInfoUnion>)
function getServiceInfo(applicationId: string, serviceId: string, options: ServiceFabricClientGetServiceInfoOptionalParams, callback: ServiceCallback<ServiceInfoUnion>)
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
省略可能なパラメーター
- callback
コールバック
getServiceInfoList(string, ServiceCallback<PagedServiceInfoList>)
function getServiceInfoList(applicationId: string, callback: ServiceCallback<PagedServiceInfoList>)
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- callback
コールバック
getServiceInfoList(string, ServiceFabricClientGetServiceInfoListOptionalParams)
アプリケーション ID で指定されたアプリケーションに属するすべてのサービスに関する情報を返します。
function getServiceInfoList(applicationId: string, options?: ServiceFabricClientGetServiceInfoListOptionalParams): Promise<GetServiceInfoListResponse>
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
省略可能なパラメーター
戻り値
Promise<GetServiceInfoListResponse>
Promise<Models.GetServiceInfoListResponse応答>
getServiceInfoList(string, ServiceFabricClientGetServiceInfoListOptionalParams, ServiceCallback<PagedServiceInfoList>)
function getServiceInfoList(applicationId: string, options: ServiceFabricClientGetServiceInfoListOptionalParams, callback: ServiceCallback<PagedServiceInfoList>)
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
省略可能なパラメーター
- callback
コールバック
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
コールバック
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 クラスター内のアプリケーションの種類の一部として登録されたサービス マニフェストの名前。
省略可能なパラメーター
戻り値
Promise<GetServiceManifestResponse>
Promise<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 クラスター内のアプリケーションの種類の一部として登録されたサービス マニフェストの名前。
省略可能なパラメーター
- callback
コールバック
getServiceNameInfo(string, ServiceCallback<ServiceNameInfo>)
function getServiceNameInfo(partitionId: string, callback: ServiceCallback<ServiceNameInfo>)
パラメーター
- partitionId
-
string
パーティションの ID。
- callback
コールバック
getServiceNameInfo(string, ServiceFabricClientGetServiceNameInfoOptionalParams)
指定したパーティションのサービスの名前を取得します。 パーティション ID がクラスターに存在しない場合は、404 エラーが戻されます。
function getServiceNameInfo(partitionId: string, options?: ServiceFabricClientGetServiceNameInfoOptionalParams): Promise<GetServiceNameInfoResponse>
パラメーター
- partitionId
-
string
パーティションの ID。
省略可能なパラメーター
戻り値
Promise<GetServiceNameInfoResponse>
Promise<Models.GetServiceNameInfoResponse>
getServiceNameInfo(string, ServiceFabricClientGetServiceNameInfoOptionalParams, ServiceCallback<ServiceNameInfo>)
function getServiceNameInfo(partitionId: string, options: ServiceFabricClientGetServiceNameInfoOptionalParams, callback: ServiceCallback<ServiceNameInfo>)
パラメーター
- partitionId
-
string
パーティションの ID。
省略可能なパラメーター
- callback
コールバック
getServicesEventList(string, string, ServiceCallback<ServiceEventUnion[]>)
function getServicesEventList(startTimeUtc: string, endTimeUtc: string, callback: ServiceCallback<ServiceEventUnion[]>)
パラメーター
- startTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの開始時刻。
- endTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの終了時刻。
- callback
コールバック
getServicesEventList(string, string, ServiceFabricClientGetServicesEventListOptionalParams)
応答は ServiceEvent オブジェクトのリストです。
function getServicesEventList(startTimeUtc: string, endTimeUtc: string, options?: ServiceFabricClientGetServicesEventListOptionalParams): Promise<GetServicesEventListResponse>
パラメーター
- startTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの開始時刻。
- endTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの終了時刻。
省略可能なパラメーター
戻り値
Promise<GetServicesEventListResponse>
Promise<Models.GetServicesEventListResponse>
getServicesEventList(string, string, ServiceFabricClientGetServicesEventListOptionalParams, ServiceCallback<ServiceEventUnion[]>)
function getServicesEventList(startTimeUtc: string, endTimeUtc: string, options: ServiceFabricClientGetServicesEventListOptionalParams, callback: ServiceCallback<ServiceEventUnion[]>)
パラメーター
- startTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの開始時刻。
- endTimeUtc
-
string
ISO UTC yyyy-MM-ddTHH:mm:ssZ でのルックアップ クエリの終了時刻。
省略可能なパラメーター
- callback
コールバック
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
コールバック
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 サービスの種類の名前を指定します。
省略可能なパラメーター
戻り値
Promise<GetServiceTypeInfoByNameResponse>
Promise<Models.GetServiceTypeInfoByName応答>
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 サービスの種類の名前を指定します。
省略可能なパラメーター
- callback
コールバック
getServiceTypeInfoList(string, string, ServiceCallback<ServiceTypeInfo[]>)
function getServiceTypeInfoList(applicationTypeName: string, applicationTypeVersion: string, callback: ServiceCallback<ServiceTypeInfo[]>)
パラメーター
- applicationTypeName
-
string
アプリケーションの種類の名前。
- applicationTypeVersion
-
string
アプリケーションの種類のバージョン。
- callback
コールバック
getServiceTypeInfoList(string, string, ServiceFabricClientGetServiceTypeInfoListOptionalParams)
Service Fabric クラスター内のプロビジョニングされたアプリケーションの種類でサポートされているサービスの種類に関する情報を含む一覧を取得します。 指定されたアプリケーションタイプが存在する必要があります。 それ以外の場合は、404 ステータスが返されます。
function getServiceTypeInfoList(applicationTypeName: string, applicationTypeVersion: string, options?: ServiceFabricClientGetServiceTypeInfoListOptionalParams): Promise<GetServiceTypeInfoListResponse>
パラメーター
- applicationTypeName
-
string
アプリケーションの種類の名前。
- applicationTypeVersion
-
string
アプリケーションの種類のバージョン。
省略可能なパラメーター
戻り値
Promise<GetServiceTypeInfoListResponse>
Promise<Models.GetServiceTypeInfoListResponse応答>
getServiceTypeInfoList(string, string, ServiceFabricClientGetServiceTypeInfoListOptionalParams, ServiceCallback<ServiceTypeInfo[]>)
function getServiceTypeInfoList(applicationTypeName: string, applicationTypeVersion: string, options: ServiceFabricClientGetServiceTypeInfoListOptionalParams, callback: ServiceCallback<ServiceTypeInfo[]>)
パラメーター
- applicationTypeName
-
string
アプリケーションの種類の名前。
- applicationTypeVersion
-
string
アプリケーションの種類のバージョン。
省略可能なパラメーター
- callback
コールバック
getSubNameInfoList(string, ServiceCallback<PagedSubNameInfoList>)
function getSubNameInfoList(nameId: string, callback: ServiceCallback<PagedSubNameInfoList>)
パラメーター
- nameId
-
string
'fabric:' URI スキームを含まない Service Fabric 名。
- callback
コールバック
getSubNameInfoList(string, ServiceFabricClientGetSubNameInfoListOptionalParams)
指定された名前ですべての Service Fabric 名を列挙します。 サブネームがページに収まらない場合は、結果の 1 ページと継続トークンが返され、次のページの取得に使用できます。 存在しない名前のクエリは失敗します。
function getSubNameInfoList(nameId: string, options?: ServiceFabricClientGetSubNameInfoListOptionalParams): Promise<GetSubNameInfoListResponse>
パラメーター
- nameId
-
string
'fabric:' URI スキームを含まない Service Fabric 名。
省略可能なパラメーター
戻り値
Promise<GetSubNameInfoListResponse>
Promise<Models.GetSubNameInfoListResponse応答>
getSubNameInfoList(string, ServiceFabricClientGetSubNameInfoListOptionalParams, ServiceCallback<PagedSubNameInfoList>)
function getSubNameInfoList(nameId: string, options: ServiceFabricClientGetSubNameInfoListOptionalParams, callback: ServiceCallback<PagedSubNameInfoList>)
パラメーター
- nameId
-
string
'fabric:' URI スキームを含まない Service Fabric 名。
省略可能なパラメーター
- callback
コールバック
getUnplacedReplicaInformation(string, ServiceCallback<UnplacedReplicaInformation>)
function getUnplacedReplicaInformation(serviceId: string, callback: ServiceCallback<UnplacedReplicaInformation>)
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
- callback
コールバック
getUnplacedReplicaInformation(string, ServiceFabricClientGetUnplacedReplicaInformationOptionalParams)
サービスの未配置のレプリカに関する情報を返します。 PartitionId を指定すると、結果には、そのパーティションの未配置のレプリカに関する情報のみが含まれます。 PartitionId が指定されていない場合、結果には、そのサービスのすべてのパーティションの未配置のレプリカに関する情報が含まれます。 OnlyQueryPrimaries が true に設定されている場合、result にはプライマリ レプリカに関する情報のみが含まれ、配置されていないセカンダリ レプリカは無視されます。
function getUnplacedReplicaInformation(serviceId: string, options?: ServiceFabricClientGetUnplacedReplicaInformationOptionalParams): Promise<GetUnplacedReplicaInformationResponse>
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
省略可能なパラメーター
戻り値
Promise<Models.GetUnplacedReplicaInformationResponse応答>
getUnplacedReplicaInformation(string, ServiceFabricClientGetUnplacedReplicaInformationOptionalParams, ServiceCallback<UnplacedReplicaInformation>)
function getUnplacedReplicaInformation(serviceId: string, options: ServiceFabricClientGetUnplacedReplicaInformationOptionalParams, callback: ServiceCallback<UnplacedReplicaInformation>)
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
省略可能なパラメーター
- callback
コールバック
getUpgradeOrchestrationServiceState(ServiceCallback<UpgradeOrchestrationServiceState>)
function getUpgradeOrchestrationServiceState(callback: ServiceCallback<UpgradeOrchestrationServiceState>)
パラメーター
コールバック
getUpgradeOrchestrationServiceState(ServiceFabricClientGetUpgradeOrchestrationServiceStateOptionalParams)
Service Fabric アップグレード オーケストレーション サービスのサービス状態を取得します。 この API は、サポート目的で内部的に使用されます。
function getUpgradeOrchestrationServiceState(options?: ServiceFabricClientGetUpgradeOrchestrationServiceStateOptionalParams): Promise<GetUpgradeOrchestrationServiceStateResponse>
パラメーター
省略可能なパラメーター
戻り値
Promise<Models.GetUpgradeOrchestrationServiceStateResponseです>
getUpgradeOrchestrationServiceState(ServiceFabricClientGetUpgradeOrchestrationServiceStateOptionalParams, ServiceCallback<UpgradeOrchestrationServiceState>)
function getUpgradeOrchestrationServiceState(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
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- serviceManifestName
-
string
Service Fabric クラスター内のアプリケーションの種類の一部として登録されたサービス マニフェストの名前。
- codePackageName
-
string
Service Fabric クラスターのアプリケーションの種類の一部として登録されたサービス マニフェストで指定されたコード パッケージの名前。
- codePackageInstanceId
-
string
Service Fabric ノードにデプロイされたコード パッケージ インスタンスを一意に識別する ID。
- containerApiRequestBody
- ContainerApiRequestBody
コンテナーAPI呼び出しを行うためのパラメーター
- callback
コールバック
invokeContainerApi(string, string, string, string, string, ContainerApiRequestBody, ServiceFabricClientInvokeContainerApiOptionalParams)
指定されたコード パッケージの Service Fabric ノードにデプロイされたコンテナーでコンテナー API を呼び出します。
function invokeContainerApi(nodeName: string, applicationId: string, serviceManifestName: string, codePackageName: string, codePackageInstanceId: string, containerApiRequestBody: ContainerApiRequestBody, options?: ServiceFabricClientInvokeContainerApiOptionalParams): Promise<InvokeContainerApiResponse>
パラメーター
- nodeName
-
string
ノード名。
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- serviceManifestName
-
string
Service Fabric クラスター内のアプリケーションの種類の一部として登録されたサービス マニフェストの名前。
- codePackageName
-
string
Service Fabric クラスターのアプリケーションの種類の一部として登録されたサービス マニフェストで指定されたコード パッケージの名前。
- codePackageInstanceId
-
string
Service Fabric ノードにデプロイされたコード パッケージ インスタンスを一意に識別する ID。
- containerApiRequestBody
- ContainerApiRequestBody
コンテナーAPI呼び出しを行うためのパラメーター
省略可能なパラメーター
戻り値
Promise<InvokeContainerApiResponse>
Promise<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
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- serviceManifestName
-
string
Service Fabric クラスター内のアプリケーションの種類の一部として登録されたサービス マニフェストの名前。
- codePackageName
-
string
Service Fabric クラスターのアプリケーションの種類の一部として登録されたサービス マニフェストで指定されたコード パッケージの名前。
- codePackageInstanceId
-
string
Service Fabric ノードにデプロイされたコード パッケージ インスタンスを一意に識別する ID。
- containerApiRequestBody
- ContainerApiRequestBody
コンテナーAPI呼び出しを行うためのパラメーター
省略可能なパラメーター
- callback
コールバック
invokeInfrastructureCommand(string, ServiceCallback<string>)
function invokeInfrastructureCommand(command: string, callback: ServiceCallback<string>)
パラメーター
- command
-
string
呼び出されるコマンドのテキスト。 コマンドの内容はインフラストラクチャー固有です。
- callback
-
ServiceCallback<string>
コールバック
invokeInfrastructureCommand(string, ServiceFabricClientInvokeInfrastructureCommandOptionalParams)
インフラストラクチャサービスのインスタンスが 1 つ以上設定されているクラスタの場合、この API は、インフラストラクチャーサービスの特定のインスタンスにインフラストラクチャ固有のコマンドを送信する方法を提供します。
使用可能なコマンドとそれに対応する応答形式は、クラスターが実行されているインフラストラクチャによって異なります。
この API は Service Fabric プラットフォームをサポートします。コードから直接使用することを意図したものではありません。
function invokeInfrastructureCommand(command: string, options?: ServiceFabricClientInvokeInfrastructureCommandOptionalParams): Promise<InvokeInfrastructureCommandResponse>
パラメーター
- command
-
string
呼び出されるコマンドのテキスト。 コマンドの内容はインフラストラクチャー固有です。
省略可能なパラメーター
戻り値
Promise<InvokeInfrastructureCommandResponse>
Promise<Models.InvokeInfrastructureCommandResponse>
invokeInfrastructureCommand(string, ServiceFabricClientInvokeInfrastructureCommandOptionalParams, ServiceCallback<string>)
function invokeInfrastructureCommand(command: string, options: ServiceFabricClientInvokeInfrastructureCommandOptionalParams, callback: ServiceCallback<string>)
パラメーター
- command
-
string
呼び出されるコマンドのテキスト。 コマンドの内容はインフラストラクチャー固有です。
省略可能なパラメーター
- callback
-
ServiceCallback<string>
コールバック
invokeInfrastructureQuery(string, ServiceCallback<string>)
function invokeInfrastructureQuery(command: string, callback: ServiceCallback<string>)
パラメーター
- command
-
string
呼び出されるコマンドのテキスト。 コマンドの内容はインフラストラクチャー固有です。
- callback
-
ServiceCallback<string>
コールバック
invokeInfrastructureQuery(string, ServiceFabricClientInvokeInfrastructureQueryOptionalParams)
インフラストラクチャサービスのインスタンスが 1 つ以上設定されているクラスタの場合、この API は、インフラストラクチャ固有のクエリをインフラストラクチャサービスの特定のインスタンスに送信する方法を提供します。
使用可能なコマンドとそれに対応する応答形式は、クラスターが実行されているインフラストラクチャによって異なります。
この API は Service Fabric プラットフォームをサポートします。コードから直接使用することを意図したものではありません。
function invokeInfrastructureQuery(command: string, options?: ServiceFabricClientInvokeInfrastructureQueryOptionalParams): Promise<InvokeInfrastructureQueryResponse>
パラメーター
- command
-
string
呼び出されるコマンドのテキスト。 コマンドの内容はインフラストラクチャー固有です。
省略可能なパラメーター
戻り値
Promise<InvokeInfrastructureQueryResponse>
Promise<Models.InvokeInfrastructureQueryResponseです>
invokeInfrastructureQuery(string, ServiceFabricClientInvokeInfrastructureQueryOptionalParams, ServiceCallback<string>)
function invokeInfrastructureQuery(command: string, options: ServiceFabricClientInvokeInfrastructureQueryOptionalParams, callback: ServiceCallback<string>)
パラメーター
- command
-
string
呼び出されるコマンドのテキスト。 コマンドの内容はインフラストラクチャー固有です。
省略可能なパラメーター
- callback
-
ServiceCallback<string>
コールバック
movePrimaryReplica(string, ServiceCallback<void>)
function movePrimaryReplica(partitionId: string, callback: ServiceCallback<void>)
パラメーター
- partitionId
-
string
パーティションの ID。
- callback
-
ServiceCallback<void>
コールバック
movePrimaryReplica(string, ServiceFabricClientMovePrimaryReplicaOptionalParams)
このコマンドは、すべての制約を尊重して、ステートフル サービスのパーティションのプライマリ レプリカを移動します。 NodeName パラメーターを指定すると、プライマリは指定されたノードに移動されます (制約で許可されている場合)。 NodeName パラメーターが指定されていない場合、プライマリ レプリカはクラスター内のランダムなノードに移動されます。 IgnoreConstraints パラメータを指定して true に設定すると、制約に関係なくプライマリが移動されます。
function movePrimaryReplica(partitionId: string, options?: ServiceFabricClientMovePrimaryReplicaOptionalParams): Promise<RestResponse>
パラメーター
- partitionId
-
string
パーティションの ID。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
movePrimaryReplica(string, ServiceFabricClientMovePrimaryReplicaOptionalParams, ServiceCallback<void>)
function movePrimaryReplica(partitionId: string, options: ServiceFabricClientMovePrimaryReplicaOptionalParams, callback: ServiceCallback<void>)
パラメーター
- partitionId
-
string
パーティションの ID。
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
moveSecondaryReplica(string, string, ServiceCallback<void>)
function moveSecondaryReplica(partitionId: string, currentNodeName: string, callback: ServiceCallback<void>)
パラメーター
- partitionId
-
string
パーティションの ID。
- currentNodeName
-
string
セカンダリレプリカの移動のソースノードの名前。
- callback
-
ServiceCallback<void>
コールバック
moveSecondaryReplica(string, string, ServiceFabricClientMoveSecondaryReplicaOptionalParams)
このコマンドは、すべての制約を考慮して、ステートフル サービスのパーティションのセカンダリ レプリカを移動します。 CurrentNodeName パラメーターは、移動されるレプリカを識別するために指定する必要があります。 ソースノード名を指定する必要がありますが、新しいノード名は省略でき、その場合、レプリカはランダムノードに移動します。 IgnoreConstraints パラメータが指定され、true に設定されている場合、制約に関係なくセカンダリが移動されます。
function moveSecondaryReplica(partitionId: string, currentNodeName: string, options?: ServiceFabricClientMoveSecondaryReplicaOptionalParams): Promise<RestResponse>
パラメーター
- partitionId
-
string
パーティションの ID。
- currentNodeName
-
string
セカンダリレプリカの移動のソースノードの名前。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
moveSecondaryReplica(string, string, ServiceFabricClientMoveSecondaryReplicaOptionalParams, ServiceCallback<void>)
function moveSecondaryReplica(partitionId: string, currentNodeName: string, options: ServiceFabricClientMoveSecondaryReplicaOptionalParams, callback: ServiceCallback<void>)
パラメーター
- partitionId
-
string
パーティションの ID。
- currentNodeName
-
string
セカンダリレプリカの移動のソースノードの名前。
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
postChaosSchedule(ChaosScheduleDescription, ServiceCallback<void>)
function postChaosSchedule(chaosSchedule: ChaosScheduleDescription, callback: ServiceCallback<void>)
パラメーター
- chaosSchedule
- ChaosScheduleDescription
Chaos で使用されるスケジュールについて説明します。
- callback
-
ServiceCallback<void>
コールバック
postChaosSchedule(ChaosScheduleDescription, ServiceFabricClientPostChaosScheduleOptionalParams)
Chaos は、Chaos スケジュールに基づいて実行を自動的にスケジュールします。 カオス スケジュールは、提供されたバージョンがサーバー上のバージョンと一致する場合に更新されます。 カオススケジュールを更新すると、サーバー上のバージョンが1ずつ増加します。 サーバー上のバージョンは、大きな数値に達すると 0 に折り返されます。 この呼び出しが行われたときに Chaos が実行されている場合、呼び出しは失敗します。
function postChaosSchedule(chaosSchedule: ChaosScheduleDescription, options?: ServiceFabricClientPostChaosScheduleOptionalParams): Promise<RestResponse>
パラメーター
- chaosSchedule
- ChaosScheduleDescription
Chaos で使用されるスケジュールについて説明します。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
postChaosSchedule(ChaosScheduleDescription, ServiceFabricClientPostChaosScheduleOptionalParams, ServiceCallback<void>)
function postChaosSchedule(chaosSchedule: ChaosScheduleDescription, options: ServiceFabricClientPostChaosScheduleOptionalParams, callback: ServiceCallback<void>)
パラメーター
- chaosSchedule
- ChaosScheduleDescription
Chaos で使用されるスケジュールについて説明します。
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
provisionApplicationType(ProvisionApplicationTypeDescriptionBaseUnion, ServiceCallback<void>)
function provisionApplicationType(provisionApplicationTypeDescriptionBaseRequiredBodyParam: ProvisionApplicationTypeDescriptionBaseUnion, callback: ServiceCallback<void>)
パラメーター
- provisionApplicationTypeDescriptionBaseRequiredBodyParam
- ProvisionApplicationTypeDescriptionBaseUnion
イメージストアベースのプロビジョニングまたは外部ストアベースのプロビジョニングのいずれかをサポートするプロビジョニングアプリケーションタイプの説明の基本タイプ。
- callback
-
ServiceCallback<void>
コールバック
provisionApplicationType(ProvisionApplicationTypeDescriptionBaseUnion, ServiceFabricClientProvisionApplicationTypeOptionalParams)
クラスターで Service Fabric アプリケーションの種類をプロビジョニングします。 このプロビジョニングは、新しいアプリケーションをインスタンス化する前に必要です。 プロビジョニング操作は、relativePathInImageStore で指定されたアプリケーション パッケージで実行するか、外部 '.sfpkg' の URI を使用して実行できます。
function provisionApplicationType(provisionApplicationTypeDescriptionBaseRequiredBodyParam: ProvisionApplicationTypeDescriptionBaseUnion, options?: ServiceFabricClientProvisionApplicationTypeOptionalParams): Promise<RestResponse>
パラメーター
- provisionApplicationTypeDescriptionBaseRequiredBodyParam
- ProvisionApplicationTypeDescriptionBaseUnion
イメージストアベースのプロビジョニングまたは外部ストアベースのプロビジョニングのいずれかをサポートするプロビジョニングアプリケーションタイプの説明の基本タイプ。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
provisionApplicationType(ProvisionApplicationTypeDescriptionBaseUnion, ServiceFabricClientProvisionApplicationTypeOptionalParams, ServiceCallback<void>)
function provisionApplicationType(provisionApplicationTypeDescriptionBaseRequiredBodyParam: ProvisionApplicationTypeDescriptionBaseUnion, options: ServiceFabricClientProvisionApplicationTypeOptionalParams, callback: ServiceCallback<void>)
パラメーター
- provisionApplicationTypeDescriptionBaseRequiredBodyParam
- ProvisionApplicationTypeDescriptionBaseUnion
イメージストアベースのプロビジョニングまたは外部ストアベースのプロビジョニングのいずれかをサポートするプロビジョニングアプリケーションタイプの説明の基本タイプ。
省略可能なパラメーター
- 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
クラスターをプロビジョニングするためのパラメーターについて説明します。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
provisionCluster(ProvisionFabricDescription, ServiceFabricClientProvisionClusterOptionalParams, ServiceCallback<void>)
function provisionCluster(provisionFabricDescription: ProvisionFabricDescription, options: ServiceFabricClientProvisionClusterOptionalParams, callback: ServiceCallback<void>)
パラメーター
- provisionFabricDescription
- ProvisionFabricDescription
クラスターをプロビジョニングするためのパラメーターについて説明します。
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
putProperty(string, PropertyDescription, ServiceCallback<void>)
function putProperty(nameId: string, propertyDescription: PropertyDescription, callback: ServiceCallback<void>)
パラメーター
- nameId
-
string
'fabric:' URI スキームを含まない Service 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
'fabric:' URI スキームを含まない Service Fabric 名。
- propertyDescription
- PropertyDescription
作成する Service Fabric プロパティについて説明します。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
putProperty(string, PropertyDescription, ServiceFabricClientPutPropertyOptionalParams, ServiceCallback<void>)
function putProperty(nameId: string, propertyDescription: PropertyDescription, options: ServiceFabricClientPutPropertyOptionalParams, callback: ServiceCallback<void>)
パラメーター
- nameId
-
string
'fabric:' URI スキームを含まない Service Fabric 名。
- propertyDescription
- PropertyDescription
作成する Service Fabric プロパティについて説明します。
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
recoverAllPartitions(ServiceCallback<void>)
function recoverAllPartitions(callback: ServiceCallback<void>)
パラメーター
- callback
-
ServiceCallback<void>
コールバック
recoverAllPartitions(ServiceFabricClientRecoverAllPartitionsOptionalParams)
この操作は、ダウンしているレプリカをリカバリできないことがわかっている場合にのみ実行する必要があります。 この API を誤って使用すると、データが失われる可能性があります。
function recoverAllPartitions(options?: ServiceFabricClientRecoverAllPartitionsOptionalParams): Promise<RestResponse>
パラメーター
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
recoverAllPartitions(ServiceFabricClientRecoverAllPartitionsOptionalParams, ServiceCallback<void>)
function recoverAllPartitions(options: ServiceFabricClientRecoverAllPartitionsOptionalParams, callback: ServiceCallback<void>)
パラメーター
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
recoverPartition(string, ServiceCallback<void>)
function recoverPartition(partitionId: string, callback: ServiceCallback<void>)
パラメーター
- partitionId
-
string
パーティションの ID。
- callback
-
ServiceCallback<void>
コールバック
recoverPartition(string, ServiceFabricClientRecoverPartitionOptionalParams)
この操作は、ダウンしているレプリカをリカバリできないことがわかっている場合にのみ実行する必要があります。 この API を誤って使用すると、データが失われる可能性があります。
function recoverPartition(partitionId: string, options?: ServiceFabricClientRecoverPartitionOptionalParams): Promise<RestResponse>
パラメーター
- partitionId
-
string
パーティションの ID。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
recoverPartition(string, ServiceFabricClientRecoverPartitionOptionalParams, ServiceCallback<void>)
function recoverPartition(partitionId: string, options: ServiceFabricClientRecoverPartitionOptionalParams, callback: ServiceCallback<void>)
パラメーター
- partitionId
-
string
パーティションの ID。
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
recoverServicePartitions(string, ServiceCallback<void>)
function recoverServicePartitions(serviceId: string, callback: ServiceCallback<void>)
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
- callback
-
ServiceCallback<void>
コールバック
recoverServicePartitions(string, ServiceFabricClientRecoverServicePartitionsOptionalParams)
Service Fabric クラスターに、現在クォーラム損失でスタックしている指定されたサービスの回復を試みる必要があることを示します。 この操作は、ダウンしているレプリカをリカバリできないことがわかっている場合にのみ実行する必要があります。 この API を誤って使用すると、データが失われる可能性があります。
function recoverServicePartitions(serviceId: string, options?: ServiceFabricClientRecoverServicePartitionsOptionalParams): Promise<RestResponse>
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
recoverServicePartitions(string, ServiceFabricClientRecoverServicePartitionsOptionalParams, ServiceCallback<void>)
function recoverServicePartitions(serviceId: string, options: ServiceFabricClientRecoverServicePartitionsOptionalParams, callback: ServiceCallback<void>)
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
省略可能なパラメーター
- 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>
パラメーター
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
recoverSystemPartitions(ServiceFabricClientRecoverSystemPartitionsOptionalParams, ServiceCallback<void>)
function recoverSystemPartitions(options: ServiceFabricClientRecoverSystemPartitionsOptionalParams, callback: ServiceCallback<void>)
パラメーター
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
removeComposeDeployment(string, ServiceCallback<void>)
function removeComposeDeployment(deploymentName: string, callback: ServiceCallback<void>)
パラメーター
- deploymentName
-
string
デプロイメントの ID。
- callback
-
ServiceCallback<void>
コールバック
removeComposeDeployment(string, ServiceFabricClientRemoveComposeDeploymentOptionalParams)
既存の Service Fabric 作成デプロイを削除します。
function removeComposeDeployment(deploymentName: string, options?: ServiceFabricClientRemoveComposeDeploymentOptionalParams): Promise<RestResponse>
パラメーター
- deploymentName
-
string
デプロイメントの ID。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
removeComposeDeployment(string, ServiceFabricClientRemoveComposeDeploymentOptionalParams, ServiceCallback<void>)
function removeComposeDeployment(deploymentName: string, options: ServiceFabricClientRemoveComposeDeploymentOptionalParams, callback: ServiceCallback<void>)
パラメーター
- deploymentName
-
string
デプロイメントの ID。
省略可能なパラメーター
- 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
ノード名。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
removeConfigurationOverrides(string, ServiceFabricClientRemoveConfigurationOverridesOptionalParams, ServiceCallback<void>)
function removeConfigurationOverrides(nodeName: string, options: ServiceFabricClientRemoveConfigurationOverridesOptionalParams, callback: ServiceCallback<void>)
パラメーター
- nodeName
-
string
ノード名。
省略可能なパラメーター
- 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
ノード名。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
removeNodeState(string, ServiceFabricClientRemoveNodeStateOptionalParams, ServiceCallback<void>)
function removeNodeState(nodeName: string, options: ServiceFabricClientRemoveNodeStateOptionalParams, callback: ServiceCallback<void>)
パラメーター
- nodeName
-
string
ノード名。
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
removeReplica(string, string, string, ServiceCallback<void>)
function removeReplica(nodeName: string, partitionId: string, replicaId: string, callback: ServiceCallback<void>)
パラメーター
- nodeName
-
string
ノード名。
- partitionId
-
string
パーティションの ID。
- 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
パーティションの ID。
- replicaId
-
string
レプリカの識別子。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<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
パーティションの ID。
- replicaId
-
string
レプリカの識別子。
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
reportApplicationHealth(string, HealthInformation, ServiceCallback<void>)
function reportApplicationHealth(applicationId: string, healthInformation: HealthInformation, callback: ServiceCallback<void>)
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "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
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- healthInformation
- HealthInformation
正常性レポートの正常性情報について説明します。 この情報は、ヘルスマネージャーに送信されるすべてのヘルスレポートに含める必要があります。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
reportApplicationHealth(string, HealthInformation, ServiceFabricClientReportApplicationHealthOptionalParams, ServiceCallback<void>)
function reportApplicationHealth(applicationId: string, healthInformation: HealthInformation, options: ServiceFabricClientReportApplicationHealthOptionalParams, callback: ServiceCallback<void>)
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- healthInformation
- HealthInformation
正常性レポートの正常性情報について説明します。 この情報は、ヘルスマネージャーに送信されるすべてのヘルスレポートに含める必要があります。
省略可能なパラメーター
- 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
正常性レポートの正常性情報について説明します。 この情報は、ヘルスマネージャーに送信されるすべてのヘルスレポートに含める必要があります。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
reportClusterHealth(HealthInformation, ServiceFabricClientReportClusterHealthOptionalParams, ServiceCallback<void>)
function reportClusterHealth(healthInformation: HealthInformation, options: ServiceFabricClientReportClusterHealthOptionalParams, callback: ServiceCallback<void>)
パラメーター
- healthInformation
- HealthInformation
正常性レポートの正常性情報について説明します。 この情報は、ヘルスマネージャーに送信されるすべてのヘルスレポートに含める必要があります。
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
reportDeployedApplicationHealth(string, string, HealthInformation, ServiceCallback<void>)
function reportDeployedApplicationHealth(nodeName: string, applicationId: string, healthInformation: HealthInformation, callback: ServiceCallback<void>)
パラメーター
- nodeName
-
string
ノード名。
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "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
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- healthInformation
- HealthInformation
正常性レポートの正常性情報について説明します。 この情報は、ヘルスマネージャーに送信されるすべてのヘルスレポートに含める必要があります。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<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
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- healthInformation
- HealthInformation
正常性レポートの正常性情報について説明します。 この情報は、ヘルスマネージャーに送信されるすべてのヘルスレポートに含める必要があります。
省略可能なパラメーター
- 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
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "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
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- servicePackageName
-
string
サービス パッケージの名前。
- healthInformation
- HealthInformation
正常性レポートの正常性情報について説明します。 この情報は、ヘルスマネージャーに送信されるすべてのヘルスレポートに含める必要があります。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<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
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- servicePackageName
-
string
サービス パッケージの名前。
- healthInformation
- HealthInformation
正常性レポートの正常性情報について説明します。 この情報は、ヘルスマネージャーに送信されるすべてのヘルスレポートに含める必要があります。
省略可能なパラメーター
- 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
正常性レポートの正常性情報について説明します。 この情報は、ヘルスマネージャーに送信されるすべてのヘルスレポートに含める必要があります。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
reportNodeHealth(string, HealthInformation, ServiceFabricClientReportNodeHealthOptionalParams, ServiceCallback<void>)
function reportNodeHealth(nodeName: string, healthInformation: HealthInformation, options: ServiceFabricClientReportNodeHealthOptionalParams, callback: ServiceCallback<void>)
パラメーター
- nodeName
-
string
ノード名。
- healthInformation
- HealthInformation
正常性レポートの正常性情報について説明します。 この情報は、ヘルスマネージャーに送信されるすべてのヘルスレポートに含める必要があります。
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
reportPartitionHealth(string, HealthInformation, ServiceCallback<void>)
function reportPartitionHealth(partitionId: string, healthInformation: HealthInformation, callback: ServiceCallback<void>)
パラメーター
- partitionId
-
string
パーティションの ID。
- 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
パーティションの ID。
- healthInformation
- HealthInformation
正常性レポートの正常性情報について説明します。 この情報は、ヘルスマネージャーに送信されるすべてのヘルスレポートに含める必要があります。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
reportPartitionHealth(string, HealthInformation, ServiceFabricClientReportPartitionHealthOptionalParams, ServiceCallback<void>)
function reportPartitionHealth(partitionId: string, healthInformation: HealthInformation, options: ServiceFabricClientReportPartitionHealthOptionalParams, callback: ServiceCallback<void>)
パラメーター
- partitionId
-
string
パーティションの ID。
- healthInformation
- HealthInformation
正常性レポートの正常性情報について説明します。 この情報は、ヘルスマネージャーに送信されるすべてのヘルスレポートに含める必要があります。
省略可能なパラメーター
- 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
パーティションの ID。
- 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
パーティションの ID。
- replicaId
-
string
レプリカの識別子。
- serviceKind
- ReplicaHealthReportServiceKind
正常性が報告されているサービス レプリカの種類 (ステートレスまたはステートフル)。 使用可能な値を次に示します。 使用可能な値は、'Stateless'、'Stateful' です。
- healthInformation
- HealthInformation
正常性レポートの正常性情報について説明します。 この情報は、ヘルスマネージャーに送信されるすべてのヘルスレポートに含める必要があります。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<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
パーティションの ID。
- replicaId
-
string
レプリカの識別子。
- serviceKind
- ReplicaHealthReportServiceKind
正常性が報告されているサービス レプリカの種類 (ステートレスまたはステートフル)。 使用可能な値を次に示します。 使用可能な値は、'Stateless'、'Stateful' です。
- healthInformation
- HealthInformation
正常性レポートの正常性情報について説明します。 この情報は、ヘルスマネージャーに送信されるすべてのヘルスレポートに含める必要があります。
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
reportServiceHealth(string, HealthInformation, ServiceCallback<void>)
function reportServiceHealth(serviceId: string, healthInformation: HealthInformation, callback: ServiceCallback<void>)
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "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
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
- healthInformation
- HealthInformation
正常性レポートの正常性情報について説明します。 この情報は、ヘルスマネージャーに送信されるすべてのヘルスレポートに含める必要があります。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
reportServiceHealth(string, HealthInformation, ServiceFabricClientReportServiceHealthOptionalParams, ServiceCallback<void>)
function reportServiceHealth(serviceId: string, healthInformation: HealthInformation, options: ServiceFabricClientReportServiceHealthOptionalParams, callback: ServiceCallback<void>)
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
- healthInformation
- HealthInformation
正常性レポートの正常性情報について説明します。 この情報は、ヘルスマネージャーに送信されるすべてのヘルスレポートに含める必要があります。
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
resetPartitionLoad(string, ServiceCallback<void>)
function resetPartitionLoad(partitionId: string, callback: ServiceCallback<void>)
パラメーター
- partitionId
-
string
パーティションの ID。
- callback
-
ServiceCallback<void>
コールバック
resetPartitionLoad(string, ServiceFabricClientResetPartitionLoadOptionalParams)
Service Fabric パーティションの現在の負荷を、サービスの既定の負荷にリセットします。
function resetPartitionLoad(partitionId: string, options?: ServiceFabricClientResetPartitionLoadOptionalParams): Promise<RestResponse>
パラメーター
- partitionId
-
string
パーティションの ID。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
resetPartitionLoad(string, ServiceFabricClientResetPartitionLoadOptionalParams, ServiceCallback<void>)
function resetPartitionLoad(partitionId: string, options: ServiceFabricClientResetPartitionLoadOptionalParams, callback: ServiceCallback<void>)
パラメーター
- partitionId
-
string
パーティションの ID。
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
resolveService(string, ServiceCallback<ResolvedServicePartition>)
function resolveService(serviceId: string, callback: ServiceCallback<ResolvedServicePartition>)
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
- callback
コールバック
resolveService(string, ServiceFabricClientResolveServiceOptionalParams)
Service Fabric サービス パーティションを解決して、サービス レプリカのエンドポイントを取得します。
function resolveService(serviceId: string, options?: ServiceFabricClientResolveServiceOptionalParams): Promise<ResolveServiceResponse>
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
省略可能なパラメーター
戻り値
Promise<ResolveServiceResponse>
Promise<Models.ResolveServiceResponse>
resolveService(string, ServiceFabricClientResolveServiceOptionalParams, ServiceCallback<ResolvedServicePartition>)
function resolveService(serviceId: string, options: ServiceFabricClientResolveServiceOptionalParams, callback: ServiceCallback<ResolvedServicePartition>)
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
省略可能なパラメーター
- callback
コールバック
restartDeployedCodePackage(string, string, RestartDeployedCodePackageDescription, ServiceCallback<void>)
function restartDeployedCodePackage(nodeName: string, applicationId: string, restartDeployedCodePackageDescription: RestartDeployedCodePackageDescription, callback: ServiceCallback<void>)
パラメーター
- nodeName
-
string
ノード名。
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "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
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- restartDeployedCodePackageDescription
- RestartDeployedCodePackageDescription
再起動する Service Fabric ノードにデプロイされたコード パッケージについて説明します。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<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
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- restartDeployedCodePackageDescription
- RestartDeployedCodePackageDescription
再起動する Service Fabric ノードにデプロイされたコード パッケージについて説明します。
省略可能なパラメーター
- 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
再起動するノードのインスタンスと、ファブリック・プロセスのダンプを取得する必要があることを示すフラグ。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
restartNode(string, RestartNodeDescription, ServiceFabricClientRestartNodeOptionalParams, ServiceCallback<void>)
function restartNode(nodeName: string, restartNodeDescription: RestartNodeDescription, options: ServiceFabricClientRestartNodeOptionalParams, callback: ServiceCallback<void>)
パラメーター
- nodeName
-
string
ノード名。
- restartNodeDescription
- RestartNodeDescription
再起動するノードのインスタンスと、ファブリック・プロセスのダンプを取得する必要があることを示すフラグ。
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
restartReplica(string, string, string, ServiceCallback<void>)
function restartReplica(nodeName: string, partitionId: string, replicaId: string, callback: ServiceCallback<void>)
パラメーター
- nodeName
-
string
ノード名。
- partitionId
-
string
パーティションの ID。
- 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
パーティションの ID。
- replicaId
-
string
レプリカの識別子。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<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
パーティションの ID。
- replicaId
-
string
レプリカの識別子。
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
restorePartition(string, RestorePartitionDescription, ServiceCallback<void>)
function restorePartition(partitionId: string, restorePartitionDescription: RestorePartitionDescription, callback: ServiceCallback<void>)
パラメーター
- partitionId
-
string
パーティションの ID。
- restorePartitionDescription
- RestorePartitionDescription
パーティションを復元するためのパラメータについて説明します。
- callback
-
ServiceCallback<void>
コールバック
restorePartition(string, RestorePartitionDescription, ServiceFabricClientRestorePartitionOptionalParams)
指定されたバックアップ ポイントを使用して、ステートフル永続パーティションの状態を復元します。 パーティションがすでに定期的にバックアップされている場合、デフォルトでは、バックアップ・ポリシーで指定されたストレージでバックアップ・ポイントが検索されます。 本文の復元パーティションの説明の一部としてバックアップストレージの詳細を指定することで、同じものをオーバーライドすることもできます。 復元が開始されると、GetRestoreProgress 操作を使用して進行状況を追跡できます。 操作がタイムアウトした場合は、クエリ パラメーターでより大きな復元タイムアウト値を指定します。
function restorePartition(partitionId: string, restorePartitionDescription: RestorePartitionDescription, options?: ServiceFabricClientRestorePartitionOptionalParams): Promise<RestResponse>
パラメーター
- partitionId
-
string
パーティションの ID。
- restorePartitionDescription
- RestorePartitionDescription
パーティションを復元するためのパラメータについて説明します。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
restorePartition(string, RestorePartitionDescription, ServiceFabricClientRestorePartitionOptionalParams, ServiceCallback<void>)
function restorePartition(partitionId: string, restorePartitionDescription: RestorePartitionDescription, options: ServiceFabricClientRestorePartitionOptionalParams, callback: ServiceCallback<void>)
パラメーター
- partitionId
-
string
パーティションの ID。
- restorePartitionDescription
- RestorePartitionDescription
パーティションを復元するためのパラメータについて説明します。
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
resumeApplicationBackup(string, ServiceCallback<void>)
function resumeApplicationBackup(applicationId: string, callback: ServiceCallback<void>)
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- callback
-
ServiceCallback<void>
コールバック
resumeApplicationBackup(string, ServiceFabricClientResumeApplicationBackupOptionalParams)
以前に中断された Service Fabric アプリケーションは、現在構成されているバックアップ ポリシーに従って定期的なバックアップの実行を再開します。
function resumeApplicationBackup(applicationId: string, options?: ServiceFabricClientResumeApplicationBackupOptionalParams): Promise<RestResponse>
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
resumeApplicationBackup(string, ServiceFabricClientResumeApplicationBackupOptionalParams, ServiceCallback<void>)
function resumeApplicationBackup(applicationId: string, options: ServiceFabricClientResumeApplicationBackupOptionalParams, callback: ServiceCallback<void>)
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
resumeApplicationUpgrade(string, ResumeApplicationUpgradeDescription, ServiceCallback<void>)
function resumeApplicationUpgrade(applicationId: string, resumeApplicationUpgradeDescription: ResumeApplicationUpgradeDescription, callback: ServiceCallback<void>)
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- resumeApplicationUpgradeDescription
- ResumeApplicationUpgradeDescription
アプリケーションのアップグレードを再開するためのパラメータについて説明します。
- callback
-
ServiceCallback<void>
コールバック
resumeApplicationUpgrade(string, ResumeApplicationUpgradeDescription, ServiceFabricClientResumeApplicationUpgradeOptionalParams)
監視されていない手動の Service Fabric アプリケーション アップグレードを再開します。 Service Fabric は、一度に 1 つのアップグレード ドメインをアップグレードします。 監視対象外の手動アップグレードの場合、Service Fabric はアップグレード ドメインを終了した後、次のアップグレード ドメインに進む前に、この API を呼び出すのを待ちます。
function resumeApplicationUpgrade(applicationId: string, resumeApplicationUpgradeDescription: ResumeApplicationUpgradeDescription, options?: ServiceFabricClientResumeApplicationUpgradeOptionalParams): Promise<RestResponse>
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- resumeApplicationUpgradeDescription
- ResumeApplicationUpgradeDescription
アプリケーションのアップグレードを再開するためのパラメータについて説明します。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
resumeApplicationUpgrade(string, ResumeApplicationUpgradeDescription, ServiceFabricClientResumeApplicationUpgradeOptionalParams, ServiceCallback<void>)
function resumeApplicationUpgrade(applicationId: string, resumeApplicationUpgradeDescription: ResumeApplicationUpgradeDescription, options: ServiceFabricClientResumeApplicationUpgradeOptionalParams, callback: ServiceCallback<void>)
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- resumeApplicationUpgradeDescription
- ResumeApplicationUpgradeDescription
アプリケーションのアップグレードを再開するためのパラメータについて説明します。
省略可能なパラメーター
- 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
クラスターのアップグレードを再開するためのパラメーターについて説明します。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
resumeClusterUpgrade(ResumeClusterUpgradeDescription, ServiceFabricClientResumeClusterUpgradeOptionalParams, ServiceCallback<void>)
function resumeClusterUpgrade(resumeClusterUpgradeDescription: ResumeClusterUpgradeDescription, options: ServiceFabricClientResumeClusterUpgradeOptionalParams, callback: ServiceCallback<void>)
パラメーター
- resumeClusterUpgradeDescription
- ResumeClusterUpgradeDescription
クラスターのアップグレードを再開するためのパラメーターについて説明します。
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
resumePartitionBackup(string, ServiceCallback<void>)
function resumePartitionBackup(partitionId: string, callback: ServiceCallback<void>)
パラメーター
- partitionId
-
string
パーティションの ID。
- callback
-
ServiceCallback<void>
コールバック
resumePartitionBackup(string, ServiceFabricClientResumePartitionBackupOptionalParams)
以前に中断されたパーティションは、現在同じパーティションに設定されているバックアップポリシーに従って、定期的なバックアップの実行を再開します。
function resumePartitionBackup(partitionId: string, options?: ServiceFabricClientResumePartitionBackupOptionalParams): Promise<RestResponse>
パラメーター
- partitionId
-
string
パーティションの ID。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
resumePartitionBackup(string, ServiceFabricClientResumePartitionBackupOptionalParams, ServiceCallback<void>)
function resumePartitionBackup(partitionId: string, options: ServiceFabricClientResumePartitionBackupOptionalParams, callback: ServiceCallback<void>)
パラメーター
- partitionId
-
string
パーティションの ID。
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
resumeServiceBackup(string, ServiceCallback<void>)
function resumeServiceBackup(serviceId: string, callback: ServiceCallback<void>)
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
- callback
-
ServiceCallback<void>
コールバック
resumeServiceBackup(string, ServiceFabricClientResumeServiceBackupOptionalParams)
以前に中断された Service Fabric サービスは、現在構成されているバックアップ ポリシーに従って定期的なバックアップの取得を再開します。
function resumeServiceBackup(serviceId: string, options?: ServiceFabricClientResumeServiceBackupOptionalParams): Promise<RestResponse>
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
resumeServiceBackup(string, ServiceFabricClientResumeServiceBackupOptionalParams, ServiceCallback<void>)
function resumeServiceBackup(serviceId: string, options: ServiceFabricClientResumeServiceBackupOptionalParams, callback: ServiceCallback<void>)
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
rollbackApplicationUpgrade(string, ServiceCallback<void>)
function rollbackApplicationUpgrade(applicationId: string, callback: ServiceCallback<void>)
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- callback
-
ServiceCallback<void>
コールバック
rollbackApplicationUpgrade(string, ServiceFabricClientRollbackApplicationUpgradeOptionalParams)
現在のアプリケーションのアップグレードを以前のバージョンにロールバックします。 この API は、新しいバージョンにロールフォワードしている現在進行中のアップグレードをロールバックするためにのみ使用できます。 アプリケーションが現在アップグレードされていない場合は、StartApplicationUpgrade API を使用して、以前のバージョンへのロールバックを含め、目的のバージョンにアップグレードします。
function rollbackApplicationUpgrade(applicationId: string, options?: ServiceFabricClientRollbackApplicationUpgradeOptionalParams): Promise<RestResponse>
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
rollbackApplicationUpgrade(string, ServiceFabricClientRollbackApplicationUpgradeOptionalParams, ServiceCallback<void>)
function rollbackApplicationUpgrade(applicationId: string, options: ServiceFabricClientRollbackApplicationUpgradeOptionalParams, callback: ServiceCallback<void>)
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
rollbackClusterUpgrade(ServiceCallback<void>)
function rollbackClusterUpgrade(callback: ServiceCallback<void>)
パラメーター
- callback
-
ServiceCallback<void>
コールバック
rollbackClusterUpgrade(ServiceFabricClientRollbackClusterUpgradeOptionalParams)
Service Fabric クラスターのコードまたは構成のアップグレードをロールバックします。
function rollbackClusterUpgrade(options?: ServiceFabricClientRollbackClusterUpgradeOptionalParams): Promise<RestResponse>
パラメーター
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
rollbackClusterUpgrade(ServiceFabricClientRollbackClusterUpgradeOptionalParams, ServiceCallback<void>)
function rollbackClusterUpgrade(options: ServiceFabricClientRollbackClusterUpgradeOptionalParams, callback: ServiceCallback<void>)
パラメーター
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
setUpgradeOrchestrationServiceState(UpgradeOrchestrationServiceState, ServiceCallback<UpgradeOrchestrationServiceStateSummary>)
function setUpgradeOrchestrationServiceState(upgradeOrchestrationServiceState: UpgradeOrchestrationServiceState, callback: ServiceCallback<UpgradeOrchestrationServiceStateSummary>)
パラメーター
- upgradeOrchestrationServiceState
- UpgradeOrchestrationServiceState
Service Fabric アップグレード オーケストレーション サービスのサービス状態。
コールバック
setUpgradeOrchestrationServiceState(UpgradeOrchestrationServiceState, ServiceFabricClientSetUpgradeOrchestrationServiceStateOptionalParams)
Service Fabric アップグレード オーケストレーション サービスのサービス状態を更新します。 この API は、サポート目的で内部的に使用されます。
function setUpgradeOrchestrationServiceState(upgradeOrchestrationServiceState: UpgradeOrchestrationServiceState, options?: ServiceFabricClientSetUpgradeOrchestrationServiceStateOptionalParams): Promise<SetUpgradeOrchestrationServiceStateResponse>
パラメーター
- upgradeOrchestrationServiceState
- UpgradeOrchestrationServiceState
Service Fabric アップグレード オーケストレーション サービスのサービス状態。
省略可能なパラメーター
戻り値
Promise<Models.SetUpgradeOrchestrationServiceStateResponse>
setUpgradeOrchestrationServiceState(UpgradeOrchestrationServiceState, ServiceFabricClientSetUpgradeOrchestrationServiceStateOptionalParams, ServiceCallback<UpgradeOrchestrationServiceStateSummary>)
function setUpgradeOrchestrationServiceState(upgradeOrchestrationServiceState: UpgradeOrchestrationServiceState, options: ServiceFabricClientSetUpgradeOrchestrationServiceStateOptionalParams, callback: ServiceCallback<UpgradeOrchestrationServiceStateSummary>)
パラメーター
- upgradeOrchestrationServiceState
- UpgradeOrchestrationServiceState
Service Fabric アップグレード オーケストレーション サービスのサービス状態。
省略可能なパラメーター
コールバック
startApplicationUpgrade(string, ApplicationUpgradeDescription, ServiceCallback<void>)
function startApplicationUpgrade(applicationId: string, applicationUpgradeDescription: ApplicationUpgradeDescription, callback: ServiceCallback<void>)
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- applicationUpgradeDescription
- ApplicationUpgradeDescription
アプリケーションアップグレードのパラメーター。
- callback
-
ServiceCallback<void>
コールバック
startApplicationUpgrade(string, ApplicationUpgradeDescription, ServiceFabricClientStartApplicationUpgradeOptionalParams)
指定されたアプリケーション・アップグレード・パラメーターを検証し、パラメーターが有効な場合はアプリケーションのアップグレードを開始します。
function startApplicationUpgrade(applicationId: string, applicationUpgradeDescription: ApplicationUpgradeDescription, options?: ServiceFabricClientStartApplicationUpgradeOptionalParams): Promise<RestResponse>
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- applicationUpgradeDescription
- ApplicationUpgradeDescription
アプリケーションアップグレードのパラメーター。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
startApplicationUpgrade(string, ApplicationUpgradeDescription, ServiceFabricClientStartApplicationUpgradeOptionalParams, ServiceCallback<void>)
function startApplicationUpgrade(applicationId: string, applicationUpgradeDescription: ApplicationUpgradeDescription, options: ServiceFabricClientStartApplicationUpgradeOptionalParams, callback: ServiceCallback<void>)
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- applicationUpgradeDescription
- ApplicationUpgradeDescription
アプリケーションアップグレードのパラメーター。
省略可能なパラメーター
- 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 パラメーターを使用して Chaos が起動します。 この呼び出しが行われたときに Chaos が既に実行されている場合、呼び出しはエラー コード FABRIC_E_CHAOS_ALREADY_RUNNING で失敗します。 詳細については、「 Service Fabric クラスターで制御されたカオスを誘発する 」の記事を参照してください。
function startChaos(chaosParameters: ChaosParameters, options?: ServiceFabricClientStartChaosOptionalParams): Promise<RestResponse>
パラメーター
- chaosParameters
- ChaosParameters
Chaos 実行を構成するためのすべてのパラメーターについて説明します。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
startChaos(ChaosParameters, ServiceFabricClientStartChaosOptionalParams, ServiceCallback<void>)
function startChaos(chaosParameters: ChaosParameters, options: ServiceFabricClientStartChaosOptionalParams, callback: ServiceCallback<void>)
パラメーター
- chaosParameters
- ChaosParameters
Chaos 実行を構成するためのすべてのパラメーターについて説明します。
省略可能なパラメーター
- 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
スタンドアロン クラスタ構成のアップグレードのパラメータ。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
startClusterConfigurationUpgrade(ClusterConfigurationUpgradeDescription, ServiceFabricClientStartClusterConfigurationUpgradeOptionalParams, ServiceCallback<void>)
function startClusterConfigurationUpgrade(clusterConfigurationUpgradeDescription: ClusterConfigurationUpgradeDescription, options: ServiceFabricClientStartClusterConfigurationUpgradeOptionalParams, callback: ServiceCallback<void>)
パラメーター
- clusterConfigurationUpgradeDescription
- ClusterConfigurationUpgradeDescription
スタンドアロン クラスタ構成のアップグレードのパラメータ。
省略可能なパラメーター
- 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
クラスターのアップグレードを開始するためのパラメーターについて説明します。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
startClusterUpgrade(StartClusterUpgradeDescription, ServiceFabricClientStartClusterUpgradeOptionalParams, ServiceCallback<void>)
function startClusterUpgrade(startClusterUpgradeDescription: StartClusterUpgradeDescription, options: ServiceFabricClientStartClusterUpgradeOptionalParams, callback: ServiceCallback<void>)
パラメーター
- startClusterUpgradeDescription
- StartClusterUpgradeDescription
クラスターのアップグレードを開始するためのパラメーターについて説明します。
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
startComposeDeploymentUpgrade(string, ComposeDeploymentUpgradeDescription, ServiceCallback<void>)
function startComposeDeploymentUpgrade(deploymentName: string, composeDeploymentUpgradeDescription: ComposeDeploymentUpgradeDescription, callback: ServiceCallback<void>)
パラメーター
- deploymentName
-
string
デプロイメントの ID。
- composeDeploymentUpgradeDescription
- ComposeDeploymentUpgradeDescription
compose デプロイメントをアップグレードするためのパラメーター。
- callback
-
ServiceCallback<void>
コールバック
startComposeDeploymentUpgrade(string, ComposeDeploymentUpgradeDescription, ServiceFabricClientStartComposeDeploymentUpgradeOptionalParams)
指定されたアップグレード パラメータを検証し、パラメータが有効な場合は展開のアップグレードを開始します。
function startComposeDeploymentUpgrade(deploymentName: string, composeDeploymentUpgradeDescription: ComposeDeploymentUpgradeDescription, options?: ServiceFabricClientStartComposeDeploymentUpgradeOptionalParams): Promise<RestResponse>
パラメーター
- deploymentName
-
string
デプロイメントの ID。
- composeDeploymentUpgradeDescription
- ComposeDeploymentUpgradeDescription
compose デプロイメントをアップグレードするためのパラメーター。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
startComposeDeploymentUpgrade(string, ComposeDeploymentUpgradeDescription, ServiceFabricClientStartComposeDeploymentUpgradeOptionalParams, ServiceCallback<void>)
function startComposeDeploymentUpgrade(deploymentName: string, composeDeploymentUpgradeDescription: ComposeDeploymentUpgradeDescription, options: ServiceFabricClientStartComposeDeploymentUpgradeOptionalParams, callback: ServiceCallback<void>)
パラメーター
- deploymentName
-
string
デプロイメントの ID。
- composeDeploymentUpgradeDescription
- ComposeDeploymentUpgradeDescription
compose デプロイメントをアップグレードするためのパラメーター。
省略可能なパラメーター
- 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
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
- partitionId
-
string
パーティションの ID。
- operationId
-
string
この API の呼び出しを識別する GUID。 これは、対応する GetProgress API に渡されます
- dataLossMode
- DataLossMode
この列挙型は StartDataLoss API に渡され、誘発するデータ損失の種類を示します。 指定できる値は、'Invalid'、'PartialDataLoss'、'FullDataLoss' です。
- callback
-
ServiceCallback<void>
コールバック
startDataLoss(string, string, string, DataLossMode, ServiceFabricClientStartDataLossOptionalParams)
この API は、指定されたパーティションのデータ損失を誘発します。 パーティションの OnDataLoss API への呼び出しがトリガーされます。 実際のデータ損失は、指定された DataLossMode によって異なります。
- PartialDataLoss - レプリカのクォーラムのみが削除され、パーティションに対して OnDataLoss がトリガーされますが、実際のデータ損失は、処理中のレプリケーションの存在によって異なります。
- FullDataLoss - すべてのレプリカが削除されるため、すべてのデータが失われ、OnDataLoss がトリガーされます。
この API は、ステートフル サービスをターゲットとしてのみ呼び出す必要があります。
システム・サービスをターゲットとしてこのAPIを呼び出すことはお勧めしません。
注: この API は一度呼び出されると、元に戻すことはできません。 CancelOperation を呼び出すと、実行が停止し、内部システム状態がクリーンアップされるだけです。 コマンドがデータ損失を引き起こすほど進行した場合、データは復元されません。
同じ OperationId を使用して GetDataLossProgress API を呼び出して、この API で開始された操作に関する情報を返します。
function startDataLoss(serviceId: string, partitionId: string, operationId: string, dataLossMode: DataLossMode, options?: ServiceFabricClientStartDataLossOptionalParams): Promise<RestResponse>
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
- partitionId
-
string
パーティションの ID。
- operationId
-
string
この API の呼び出しを識別する GUID。 これは、対応する GetProgress API に渡されます
- dataLossMode
- DataLossMode
この列挙型は StartDataLoss API に渡され、誘発するデータ損失の種類を示します。 指定できる値は、'Invalid'、'PartialDataLoss'、'FullDataLoss' です。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<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
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
- partitionId
-
string
パーティションの ID。
- operationId
-
string
この API の呼び出しを識別する GUID。 これは、対応する GetProgress API に渡されます
- dataLossMode
- DataLossMode
この列挙型は StartDataLoss API に渡され、誘発するデータ損失の種類を示します。 指定できる値は、'Invalid'、'PartialDataLoss'、'FullDataLoss' です。
省略可能なパラメーター
- 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
この API の呼び出しを識別する GUID。 これは、対応する GetProgress API に渡されます
- nodeTransitionType
- NodeTransitionType
実行する遷移のタイプを示します。 NodeTransitionType.Start は、停止したノードを開始します。 NodeTransitionType.Stop は、稼働中のノードを停止します。 指定できる値は、'Invalid'、'Start'、'Stop' です。
- nodeInstanceId
-
string
ターゲットノードのノードインスタンスID。 これは、GetNodeInfo API を使用して判断できます。
- stopDurationInSeconds
-
number
ノードを停止したままにする期間 (秒単位)。 最小値は 600、最大値は 14400 です。 この時間が経過すると、ノードは自動的に復旧します。
- callback
-
ServiceCallback<void>
コールバック
startNodeTransition(string, string, NodeTransitionType, string, number, ServiceFabricClientStartNodeTransitionOptionalParams)
クラスタノードを起動または停止します。 クラスター・ノードはプロセスであり、OS インスタンス自体ではありません。 ノードを起動するには、NodeTransitionType パラメーターに "Start" を渡します。 ノードを停止するには、NodeTransitionType パラメーターに "Stop" を渡します。 この API は操作を開始しますが、API が戻ったときにノードはまだ移行を完了していない可能性があります。 同じ OperationId を使用して GetNodeTransitionProgress を呼び出して、操作の進行状況を取得します。
function startNodeTransition(nodeName: string, operationId: string, nodeTransitionType: NodeTransitionType, nodeInstanceId: string, stopDurationInSeconds: number, options?: ServiceFabricClientStartNodeTransitionOptionalParams): Promise<RestResponse>
パラメーター
- nodeName
-
string
ノード名。
- operationId
-
string
この API の呼び出しを識別する GUID。 これは、対応する GetProgress API に渡されます
- nodeTransitionType
- NodeTransitionType
実行する遷移のタイプを示します。 NodeTransitionType.Start は、停止したノードを開始します。 NodeTransitionType.Stop は、稼働中のノードを停止します。 指定できる値は、'Invalid'、'Start'、'Stop' です。
- nodeInstanceId
-
string
ターゲットノードのノードインスタンスID。 これは、GetNodeInfo API を使用して判断できます。
- stopDurationInSeconds
-
number
ノードを停止したままにする期間 (秒単位)。 最小値は 600、最大値は 14400 です。 この時間が経過すると、ノードは自動的に復旧します。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<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
この API の呼び出しを識別する GUID。 これは、対応する GetProgress API に渡されます
- nodeTransitionType
- NodeTransitionType
実行する遷移のタイプを示します。 NodeTransitionType.Start は、停止したノードを開始します。 NodeTransitionType.Stop は、稼働中のノードを停止します。 指定できる値は、'Invalid'、'Start'、'Stop' です。
- nodeInstanceId
-
string
ターゲットノードのノードインスタンスID。 これは、GetNodeInfo API を使用して判断できます。
- stopDurationInSeconds
-
number
ノードを停止したままにする期間 (秒単位)。 最小値は 600、最大値は 14400 です。 この時間が経過すると、ノードは自動的に復旧します。
省略可能なパラメーター
- 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
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
- partitionId
-
string
パーティションの ID。
- operationId
-
string
この API の呼び出しを識別する GUID。 これは、対応する GetProgress API に渡されます
- restartPartitionMode
- RestartPartitionMode
再起動するパーティションを記述する。 使用可能な値は、'Invalid'、'AllReplicasOrInstances'、'OnlyActiveSecondaries' です。
- callback
-
ServiceCallback<void>
コールバック
startPartitionRestart(string, string, string, RestartPartitionMode, ServiceFabricClientStartPartitionRestartOptionalParams)
この API は、フェールオーバーのテストに役立ちます。
ステートレス サービス パーティションを対象とするために使用する場合、RestartPartitionMode は AllReplicasOrInstances である必要があります。
同じ OperationId を使用して GetPartitionRestartProgress API を呼び出し、進行状況を取得します。
function startPartitionRestart(serviceId: string, partitionId: string, operationId: string, restartPartitionMode: RestartPartitionMode, options?: ServiceFabricClientStartPartitionRestartOptionalParams): Promise<RestResponse>
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
- partitionId
-
string
パーティションの ID。
- operationId
-
string
この API の呼び出しを識別する GUID。 これは、対応する GetProgress API に渡されます
- restartPartitionMode
- RestartPartitionMode
再起動するパーティションを記述する。 使用可能な値は、'Invalid'、'AllReplicasOrInstances'、'OnlyActiveSecondaries' です。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<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
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
- partitionId
-
string
パーティションの ID。
- operationId
-
string
この API の呼び出しを識別する GUID。 これは、対応する GetProgress API に渡されます
- restartPartitionMode
- RestartPartitionMode
再起動するパーティションを記述する。 使用可能な値は、'Invalid'、'AllReplicasOrInstances'、'OnlyActiveSecondaries' です。
省略可能なパラメーター
- 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
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
- partitionId
-
string
パーティションの ID。
- operationId
-
string
この API の呼び出しを識別する GUID。 これは、対応する GetProgress API に渡されます
- quorumLossMode
- QuorumLossMode
この列挙型は StartQuorumLoss API に渡され、どのタイプのクォーラム損失を誘発するかを示します。 使用可能な値は、'Invalid'、'QuorumReplicas'、'AllReplicas' です。
- quorumLossDuration
-
number
パーティションがクォーラム損失に保持される時間。 これは秒単位で指定する必要があります。
- callback
-
ServiceCallback<void>
コールバック
startQuorumLoss(string, string, string, QuorumLossMode, number, ServiceFabricClientStartQuorumLossOptionalParams)
この API は、サービスの一時的なクォーラム損失状況に役立ちます。
同じ OperationId を使用して GetQuorumLossProgress API を呼び出して、この API で開始された操作に関する情報を返します。
これは、ステートフル永続化 (HasPersistedState==true) サービスでのみ呼び出すことができます。 この API は、ステートレス サービスまたはステートフルなメモリ内のみのサービスでは使用しないでください。
function startQuorumLoss(serviceId: string, partitionId: string, operationId: string, quorumLossMode: QuorumLossMode, quorumLossDuration: number, options?: ServiceFabricClientStartQuorumLossOptionalParams): Promise<RestResponse>
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
- partitionId
-
string
パーティションの ID。
- operationId
-
string
この API の呼び出しを識別する GUID。 これは、対応する GetProgress API に渡されます
- quorumLossMode
- QuorumLossMode
この列挙型は StartQuorumLoss API に渡され、どのタイプのクォーラム損失を誘発するかを示します。 使用可能な値は、'Invalid'、'QuorumReplicas'、'AllReplicas' です。
- quorumLossDuration
-
number
パーティションがクォーラム損失に保持される時間。 これは秒単位で指定する必要があります。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<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
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
- partitionId
-
string
パーティションの ID。
- operationId
-
string
この API の呼び出しを識別する GUID。 これは、対応する GetProgress API に渡されます
- quorumLossMode
- QuorumLossMode
この列挙型は StartQuorumLoss API に渡され、どのタイプのクォーラム損失を誘発するかを示します。 使用可能な値は、'Invalid'、'QuorumReplicas'、'AllReplicas' です。
- quorumLossDuration
-
number
パーティションがクォーラム損失に保持される時間。 これは秒単位で指定する必要があります。
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
startRollbackComposeDeploymentUpgrade(string, ServiceCallback<void>)
function startRollbackComposeDeploymentUpgrade(deploymentName: string, callback: ServiceCallback<void>)
パラメーター
- deploymentName
-
string
デプロイメントの ID。
- callback
-
ServiceCallback<void>
コールバック
startRollbackComposeDeploymentUpgrade(string, ServiceFabricClientStartRollbackComposeDeploymentUpgradeOptionalParams)
Service Fabric Compose デプロイのアップグレードをロールバックします。
function startRollbackComposeDeploymentUpgrade(deploymentName: string, options?: ServiceFabricClientStartRollbackComposeDeploymentUpgradeOptionalParams): Promise<RestResponse>
パラメーター
- deploymentName
-
string
デプロイメントの ID。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
startRollbackComposeDeploymentUpgrade(string, ServiceFabricClientStartRollbackComposeDeploymentUpgradeOptionalParams, ServiceCallback<void>)
function startRollbackComposeDeploymentUpgrade(deploymentName: string, options: ServiceFabricClientStartRollbackComposeDeploymentUpgradeOptionalParams, callback: ServiceCallback<void>)
パラメーター
- deploymentName
-
string
デプロイメントの ID。
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
stopChaos(ServiceCallback<void>)
stopChaos(ServiceFabricClientStopChaosOptionalParams)
Chaos が新しい障害を実行しないようにします。 処理中の障害は、完了するまで実行され続けます。 現在のカオススケジュールは停止状態になります。 スケジュールが停止すると、停止状態のままになり、カオスの新しい実行をカオススケジュールするには使用されません。 スケジューリングを再開するには、新しいカオス スケジュールを設定する必要があります。
function stopChaos(options?: ServiceFabricClientStopChaosOptionalParams): Promise<RestResponse>
パラメーター
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
stopChaos(ServiceFabricClientStopChaosOptionalParams, ServiceCallback<void>)
function stopChaos(options: ServiceFabricClientStopChaosOptionalParams, callback: ServiceCallback<void>)
パラメーター
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
submitPropertyBatch(string, PropertyBatchDescriptionList, ServiceCallback<PropertyBatchInfoUnion>)
function submitPropertyBatch(nameId: string, propertyBatchDescriptionList: PropertyBatchDescriptionList, callback: ServiceCallback<PropertyBatchInfoUnion>)
パラメーター
- nameId
-
string
'fabric:' URI スキームを含まない Service Fabric 名。
- propertyBatchDescriptionList
- PropertyBatchDescriptionList
送信するプロパティのバッチ操作について説明します。
- callback
コールバック
submitPropertyBatch(string, PropertyBatchDescriptionList, ServiceFabricClientSubmitPropertyBatchOptionalParams)
プロパティ操作のバッチを送信します。 すべての操作がコミットされるか、コミットされないかのいずれかです。
function submitPropertyBatch(nameId: string, propertyBatchDescriptionList: PropertyBatchDescriptionList, options?: ServiceFabricClientSubmitPropertyBatchOptionalParams): Promise<SubmitPropertyBatchResponse>
パラメーター
- nameId
-
string
'fabric:' URI スキームを含まない Service Fabric 名。
- propertyBatchDescriptionList
- PropertyBatchDescriptionList
送信するプロパティのバッチ操作について説明します。
省略可能なパラメーター
戻り値
Promise<SubmitPropertyBatchResponse>
Promise<Models.SubmitPropertyBatchResponse>
submitPropertyBatch(string, PropertyBatchDescriptionList, ServiceFabricClientSubmitPropertyBatchOptionalParams, ServiceCallback<PropertyBatchInfoUnion>)
function submitPropertyBatch(nameId: string, propertyBatchDescriptionList: PropertyBatchDescriptionList, options: ServiceFabricClientSubmitPropertyBatchOptionalParams, callback: ServiceCallback<PropertyBatchInfoUnion>)
パラメーター
- nameId
-
string
'fabric:' URI スキームを含まない Service Fabric 名。
- propertyBatchDescriptionList
- PropertyBatchDescriptionList
送信するプロパティのバッチ操作について説明します。
省略可能なパラメーター
- callback
コールバック
suspendApplicationBackup(string, ServiceCallback<void>)
function suspendApplicationBackup(applicationId: string, callback: ServiceCallback<void>)
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- callback
-
ServiceCallback<void>
コールバック
suspendApplicationBackup(string, ServiceFabricClientSuspendApplicationBackupOptionalParams)
定期的なバックアップを作成するように構成されたアプリケーションは、再開されるまで、それ以降のバックアップを作成するために中断されます。 この操作は、アプリケーションの階層全体に適用されます。 これは、このアプリケーションの下のすべてのサービスとパーティションがバックアップのために中断されていることを意味します。
function suspendApplicationBackup(applicationId: string, options?: ServiceFabricClientSuspendApplicationBackupOptionalParams): Promise<RestResponse>
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
suspendApplicationBackup(string, ServiceFabricClientSuspendApplicationBackupOptionalParams, ServiceCallback<void>)
function suspendApplicationBackup(applicationId: string, options: ServiceFabricClientSuspendApplicationBackupOptionalParams, callback: ServiceCallback<void>)
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
suspendPartitionBackup(string, ServiceCallback<void>)
function suspendPartitionBackup(partitionId: string, callback: ServiceCallback<void>)
パラメーター
- partitionId
-
string
パーティションの ID。
- callback
-
ServiceCallback<void>
コールバック
suspendPartitionBackup(string, ServiceFabricClientSuspendPartitionBackupOptionalParams)
定期的なバックアップを行うように構成されたパーティションは、再度再開されるまで、さらなるバックアップを作成するために中断されます。
function suspendPartitionBackup(partitionId: string, options?: ServiceFabricClientSuspendPartitionBackupOptionalParams): Promise<RestResponse>
パラメーター
- partitionId
-
string
パーティションの ID。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
suspendPartitionBackup(string, ServiceFabricClientSuspendPartitionBackupOptionalParams, ServiceCallback<void>)
function suspendPartitionBackup(partitionId: string, options: ServiceFabricClientSuspendPartitionBackupOptionalParams, callback: ServiceCallback<void>)
パラメーター
- partitionId
-
string
パーティションの ID。
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
suspendServiceBackup(string, ServiceCallback<void>)
function suspendServiceBackup(serviceId: string, callback: ServiceCallback<void>)
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
- callback
-
ServiceCallback<void>
コールバック
suspendServiceBackup(string, ServiceFabricClientSuspendServiceBackupOptionalParams)
定期的なバックアップを実行するように構成されたサービスは、再度再開されるまで、それ以降のバックアップを作成するために中断されます。 この操作は、サービスの階層全体に適用されます。 これは、このサービスの下のすべてのパーティションがバックアップのために中断されていることを意味します。
function suspendServiceBackup(serviceId: string, options?: ServiceFabricClientSuspendServiceBackupOptionalParams): Promise<RestResponse>
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
suspendServiceBackup(string, ServiceFabricClientSuspendServiceBackupOptionalParams, ServiceCallback<void>)
function suspendServiceBackup(serviceId: string, options: ServiceFabricClientSuspendServiceBackupOptionalParams, callback: ServiceCallback<void>)
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
toggleVerboseServicePlacementHealthReporting(boolean, ServiceCallback<void>)
function toggleVerboseServicePlacementHealthReporting(enabled: boolean, callback: ServiceCallback<void>)
パラメーター
- enabled
-
boolean
サービス配置の正常性レポートの冗長性。
- callback
-
ServiceCallback<void>
コールバック
toggleVerboseServicePlacementHealthReporting(boolean, ServiceFabricClientToggleVerboseServicePlacementHealthReportingOptionalParams)
verbosity が true に設定されている場合、レプリカを配置または削除できない場合に詳細なヘルスレポートが生成されます。 verbosity が false に設定されている場合、レプリカを配置または削除できない場合、ヘルス レポートは生成されません。
function toggleVerboseServicePlacementHealthReporting(enabled: boolean, options?: ServiceFabricClientToggleVerboseServicePlacementHealthReportingOptionalParams): Promise<RestResponse>
パラメーター
- enabled
-
boolean
サービス配置の正常性レポートの冗長性。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
toggleVerboseServicePlacementHealthReporting(boolean, ServiceFabricClientToggleVerboseServicePlacementHealthReportingOptionalParams, ServiceCallback<void>)
function toggleVerboseServicePlacementHealthReporting(enabled: boolean, options: ServiceFabricClientToggleVerboseServicePlacementHealthReportingOptionalParams, callback: ServiceCallback<void>)
パラメーター
- enabled
-
boolean
サービス配置の正常性レポートの冗長性。
省略可能なパラメーター
- 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
前のコピー操作中に指定されたイメージ・ストア内のアプリケーション・パッケージの相対パス。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
unprovisionApplicationType(string, UnprovisionApplicationTypeDescriptionInfo, ServiceFabricClientUnprovisionApplicationTypeOptionalParams, ServiceCallback<void>)
function unprovisionApplicationType(applicationTypeName: string, unprovisionApplicationTypeDescriptionInfo: UnprovisionApplicationTypeDescriptionInfo, options: ServiceFabricClientUnprovisionApplicationTypeOptionalParams, callback: ServiceCallback<void>)
パラメーター
- applicationTypeName
-
string
アプリケーションの種類の名前。
- unprovisionApplicationTypeDescriptionInfo
- UnprovisionApplicationTypeDescriptionInfo
前のコピー操作中に指定されたイメージ・ストア内のアプリケーション・パッケージの相対パス。
省略可能なパラメーター
- 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
クラスターのプロビジョニングを解除するためのパラメーターについて説明します。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
unprovisionCluster(UnprovisionFabricDescription, ServiceFabricClientUnprovisionClusterOptionalParams, ServiceCallback<void>)
function unprovisionCluster(unprovisionFabricDescription: UnprovisionFabricDescription, options: ServiceFabricClientUnprovisionClusterOptionalParams, callback: ServiceCallback<void>)
パラメーター
- unprovisionFabricDescription
- UnprovisionFabricDescription
クラスターのプロビジョニングを解除するためのパラメーターについて説明します。
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
updateApplicationUpgrade(string, ApplicationUpgradeUpdateDescription, ServiceCallback<void>)
function updateApplicationUpgrade(applicationId: string, applicationUpgradeUpdateDescription: ApplicationUpgradeUpdateDescription, callback: ServiceCallback<void>)
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- applicationUpgradeUpdateDescription
- ApplicationUpgradeUpdateDescription
既存のアプリケーションアップグレードを更新するためのパラメータ。
- callback
-
ServiceCallback<void>
コールバック
updateApplicationUpgrade(string, ApplicationUpgradeUpdateDescription, ServiceFabricClientUpdateApplicationUpgradeOptionalParams)
進行中のアプリケーション・アップグレードのパラメータを、アプリケーションのアップグレードの開始時に指定されたパラメータから更新します。 これは、アプリケーション内の誤ったパラメーターや問題が原因でアプリケーションのアップグレードが停止するのを軽減するために必要になる場合があります。
function updateApplicationUpgrade(applicationId: string, applicationUpgradeUpdateDescription: ApplicationUpgradeUpdateDescription, options?: ServiceFabricClientUpdateApplicationUpgradeOptionalParams): Promise<RestResponse>
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- applicationUpgradeUpdateDescription
- ApplicationUpgradeUpdateDescription
既存のアプリケーションアップグレードを更新するためのパラメータ。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
updateApplicationUpgrade(string, ApplicationUpgradeUpdateDescription, ServiceFabricClientUpdateApplicationUpgradeOptionalParams, ServiceCallback<void>)
function updateApplicationUpgrade(applicationId: string, applicationUpgradeUpdateDescription: ApplicationUpgradeUpdateDescription, options: ServiceFabricClientUpdateApplicationUpgradeOptionalParams, callback: ServiceCallback<void>)
パラメーター
- applicationId
-
string
アプリケーションの ID。 これは通常、"fabric:" URI スキームのないアプリケーションの完全な名前です。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、アプリケーション名が "fabric:/myapp/app1" の場合、アプリケーション ID は 6.0 以降では "myapp~app1" になり、以前のバージョンでは "myapp/app1" になります。
- applicationUpgradeUpdateDescription
- ApplicationUpgradeUpdateDescription
既存のアプリケーションアップグレードを更新するためのパラメータ。
省略可能なパラメーター
- 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
バックアップ ポリシーの名前。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
updateBackupPolicy(BackupPolicyDescription, string, ServiceFabricClientUpdateBackupPolicyOptionalParams, ServiceCallback<void>)
function updateBackupPolicy(backupPolicyDescription: BackupPolicyDescription, backupPolicyName: string, options: ServiceFabricClientUpdateBackupPolicyOptionalParams, callback: ServiceCallback<void>)
パラメーター
- backupPolicyDescription
- BackupPolicyDescription
バックアップ ポリシーについて説明します。
- backupPolicyName
-
string
バックアップ ポリシーの名前。
省略可能なパラメーター
- 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
クラスターのアップグレードを更新するためのパラメーター。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
updateClusterUpgrade(UpdateClusterUpgradeDescription, ServiceFabricClientUpdateClusterUpgradeOptionalParams, ServiceCallback<void>)
function updateClusterUpgrade(updateClusterUpgradeDescription: UpdateClusterUpgradeDescription, options: ServiceFabricClientUpdateClusterUpgradeOptionalParams, callback: ServiceCallback<void>)
パラメーター
- updateClusterUpgradeDescription
- UpdateClusterUpgradeDescription
クラスターのアップグレードを更新するためのパラメーター。
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
updateRepairExecutionState(RepairTask, RequestOptionsBase)
この API は Service Fabric プラットフォームをサポートします。コードから直接使用することを意図したものではありません。
function updateRepairExecutionState(repairTask: RepairTask, options?: RequestOptionsBase): Promise<UpdateRepairExecutionStateResponse>
パラメーター
- repairTask
- RepairTask
作成または更新する修復タスクについて説明します。
- options
- RequestOptionsBase
省略可能なパラメーター
戻り値
Promise<UpdateRepairExecutionStateResponse>
Promise<Models.UpdateRepairExecutionStateResponse応答>
updateRepairExecutionState(RepairTask, RequestOptionsBase, ServiceCallback<RepairTaskUpdateInfo>)
function updateRepairExecutionState(repairTask: RepairTask, options: RequestOptionsBase, callback: ServiceCallback<RepairTaskUpdateInfo>)
パラメーター
- repairTask
- RepairTask
作成または更新する修復タスクについて説明します。
- options
- RequestOptionsBase
省略可能なパラメーター
- callback
コールバック
updateRepairExecutionState(RepairTask, ServiceCallback<RepairTaskUpdateInfo>)
function updateRepairExecutionState(repairTask: RepairTask, callback: ServiceCallback<RepairTaskUpdateInfo>)
パラメーター
- repairTask
- RepairTask
作成または更新する修復タスクについて説明します。
- callback
コールバック
updateRepairTaskHealthPolicy(RepairTaskUpdateHealthPolicyDescription, RequestOptionsBase)
この API は Service Fabric プラットフォームをサポートします。コードから直接使用することを意図したものではありません。
function updateRepairTaskHealthPolicy(repairTaskUpdateHealthPolicyDescription: RepairTaskUpdateHealthPolicyDescription, options?: RequestOptionsBase): Promise<UpdateRepairTaskHealthPolicyResponse>
パラメーター
- repairTaskUpdateHealthPolicyDescription
- RepairTaskUpdateHealthPolicyDescription
更新する修復タスクの正常性ポリシーについて説明します。
- options
- RequestOptionsBase
省略可能なパラメーター
戻り値
Promise<UpdateRepairTaskHealthPolicyResponse>
Promise<Models.UpdateRepairTaskHealthPolicyResponse応答>
updateRepairTaskHealthPolicy(RepairTaskUpdateHealthPolicyDescription, RequestOptionsBase, ServiceCallback<RepairTaskUpdateInfo>)
function updateRepairTaskHealthPolicy(repairTaskUpdateHealthPolicyDescription: RepairTaskUpdateHealthPolicyDescription, options: RequestOptionsBase, callback: ServiceCallback<RepairTaskUpdateInfo>)
パラメーター
- repairTaskUpdateHealthPolicyDescription
- RepairTaskUpdateHealthPolicyDescription
更新する修復タスクの正常性ポリシーについて説明します。
- options
- RequestOptionsBase
省略可能なパラメーター
- callback
コールバック
updateRepairTaskHealthPolicy(RepairTaskUpdateHealthPolicyDescription, ServiceCallback<RepairTaskUpdateInfo>)
function updateRepairTaskHealthPolicy(repairTaskUpdateHealthPolicyDescription: RepairTaskUpdateHealthPolicyDescription, callback: ServiceCallback<RepairTaskUpdateInfo>)
パラメーター
- repairTaskUpdateHealthPolicyDescription
- RepairTaskUpdateHealthPolicyDescription
更新する修復タスクの正常性ポリシーについて説明します。
- callback
コールバック
updateService(string, ServiceUpdateDescriptionUnion, ServiceCallback<void>)
function updateService(serviceId: string, serviceUpdateDescription: ServiceUpdateDescriptionUnion, callback: ServiceCallback<void>)
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
- serviceUpdateDescription
- ServiceUpdateDescriptionUnion
サービスの更新に必要な情報。
- callback
-
ServiceCallback<void>
コールバック
updateService(string, ServiceUpdateDescriptionUnion, ServiceFabricClientUpdateServiceOptionalParams)
この API を使用すると、実行中の Service Fabric サービスのプロパティを更新できます。 更新できるプロパティのセットは、サービスの作成時に指定されたプロパティのサブセットです。 現在のプロパティ セットは、API を使用して取得できます GetServiceDescription 。
実行中のサービスのプロパティの更新は、API を使用してアプリケーションをアップグレードすること StartApplicationUpgrade 異なることに注意してください。 アップグレードは、アプリケーションを 1 つのバージョンから別のバージョンに、一度に 1 つのアップグレード ドメインずつ移動する、実行時間の長いバックグラウンド操作ですが、更新は新しいプロパティをすぐにサービスに適用します。
function updateService(serviceId: string, serviceUpdateDescription: ServiceUpdateDescriptionUnion, options?: ServiceFabricClientUpdateServiceOptionalParams): Promise<RestResponse>
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
- serviceUpdateDescription
- ServiceUpdateDescriptionUnion
サービスの更新に必要な情報。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
updateService(string, ServiceUpdateDescriptionUnion, ServiceFabricClientUpdateServiceOptionalParams, ServiceCallback<void>)
function updateService(serviceId: string, serviceUpdateDescription: ServiceUpdateDescriptionUnion, options: ServiceFabricClientUpdateServiceOptionalParams, callback: ServiceCallback<void>)
パラメーター
- serviceId
-
string
サービスの ID。 この ID は通常、'fabric:' URI スキームを含まないサービスのフルネームです。 バージョン 6.0 以降では、階層名は "~" 文字で区切られます。 たとえば、サービス名が "fabric:/myapp/app1/svc1" の場合、サービス ID は 6.0 以降では "myapp~app1~svc1" になり、以前のバージョンでは "myapp/app1/svc1" になります。
- serviceUpdateDescription
- ServiceUpdateDescriptionUnion
サービスの更新に必要な情報。
省略可能なパラメーター
- 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
イメージストア内のファイルまたはフォルダのルートからの相対パス。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<msRest.RestResponse応答>
uploadFile(string, ServiceFabricClientUploadFileOptionalParams, ServiceCallback<void>)
function uploadFile(contentPath: string, options: ServiceFabricClientUploadFileOptionalParams, callback: ServiceCallback<void>)
パラメーター
- contentPath
-
string
イメージストア内のファイルまたはフォルダのルートからの相対パス。
省略可能なパラメーター
- 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ヘッダーフィールドを設定し、リクエストとともに送信する必要があります。 形式は「bytes {First-Byte-Position}-{Last-Byte-Position}/{File-Length}」のようになります。 たとえば、Content-Range:bytes 300-5000/20000 は、ユーザーがバイト 300 から 5,000 を送信し、合計ファイル長が 20,000 バイトであることを示します。
- callback
-
ServiceCallback<void>
コールバック
uploadFileChunk(string, string, string, ServiceFabricClientUploadFileChunkOptionalParams)
指定されたアップロードセッション ID とイメージストアの相対パスを使用して、ファイルチャンクをイメージストアにアップロードします。 この API を使用すると、ユーザーはファイルのアップロード操作を再開できます。 ユーザーは、ネットワークが中断されるたびにファイルのアップロードを最初からやり直す必要はありません。 ファイルサイズが大きい場合は、このオプションを使用します。
再開可能なファイルのアップロードを実行するには、ユーザーはファイルを複数のチャンクに分割し、これらのチャンクをイメージストアに 1 つずつアップロードする必要があります。 チャンクは順番にアップロードする必要はありません。 イメージストアの相対パスで表されるファイルが既に存在する場合、アップロードセッションのコミット時に上書きされます。
function uploadFileChunk(contentPath: string, sessionId: string, contentRange: string, options?: ServiceFabricClientUploadFileChunkOptionalParams): Promise<RestResponse>
パラメーター
- contentPath
-
string
イメージストア内のファイルまたはフォルダのルートからの相対パス。
- sessionId
-
string
ファイルのアップロードのためにユーザーが生成した GUID。 これは、コミットされるまですべてのファイルチャンクを追跡するイメージストアアップロードセッションを識別します。
- contentRange
-
string
ファイルチャンクをイメージストアにアップロードする場合は、Content-Rangeヘッダーフィールドを設定し、リクエストとともに送信する必要があります。 形式は「bytes {First-Byte-Position}-{Last-Byte-Position}/{File-Length}」のようになります。 たとえば、Content-Range:bytes 300-5000/20000 は、ユーザーがバイト 300 から 5,000 を送信し、合計ファイル長が 20,000 バイトであることを示します。
省略可能なパラメーター
戻り値
Promise<RestResponse>
Promise<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ヘッダーフィールドを設定し、リクエストとともに送信する必要があります。 形式は「bytes {First-Byte-Position}-{Last-Byte-Position}/{File-Length}」のようになります。 たとえば、Content-Range:bytes 300-5000/20000 は、ユーザーがバイト 300 から 5,000 を送信し、合計ファイル長が 20,000 バイトであることを示します。
省略可能なパラメーター
- callback
-
ServiceCallback<void>
コールバック
継承済みメソッドの詳細
sendOperationRequest(OperationArguments, OperationSpec, ServiceCallback<any>)
指定された OperationSpec を使用して設定された HTTP 要求を送信します。
function sendOperationRequest(operationArguments: OperationArguments, operationSpec: OperationSpec, callback?: ServiceCallback<any>): Promise<RestResponse>
パラメーター
- operationArguments
- OperationArguments
HTTP 要求のテンプレート値が設定される引数。
- operationSpec
- OperationSpec
httpRequest の設定に使用する OperationSpec。
- callback
-
ServiceCallback<any>
応答を受信したときに呼び出すコールバック。
戻り値
Promise<RestResponse>
sendRequest(RequestPrepareOptions | WebResourceLike)
指定された httpRequest を送信します。
function sendRequest(options: RequestPrepareOptions | WebResourceLike): Promise<HttpOperationResponse>
パラメーター
- options
戻り値
Promise<HttpOperationResponse>