5.0.0 • Published 5 years ago

@datafire/azure_hdinsight_scriptactions v5.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
5 years ago

@datafire/azure_hdinsight_scriptactions

Client library for HDInsightManagementClient

Installation and Usage

npm install --save @datafire/azure_hdinsight_scriptactions
let azure_hdinsight_scriptactions = require('@datafire/azure_hdinsight_scriptactions').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

The HDInsight Management Client.

Actions

Clusters_ExecuteScriptActions

Executes script actions on the specified HDInsight cluster.

azure_hdinsight_scriptactions.Clusters_ExecuteScriptActions({
  "subscriptionId": "",
  "resourceGroupName": "",
  "clusterName": "",
  "api-version": "",
  "parameters": null
}, context)

Input

  • input object
    • subscriptionId required string: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
    • resourceGroupName required string: The name of the resource group.
    • clusterName required string: The name of the cluster.
    • api-version required string: The HDInsight client API Version.
    • parameters required object: The parameters for the script actions to execute on a running cluster.
      • persistOnSuccess required boolean: Gets or sets if the scripts needs to be persisted.
      • scriptActions array: The list of run time script actions.
        • items object: Describes a script action on a running cluster.
          • applicationName string: The application name of the script action, if any.
          • name required string: The name of the script action.
          • parameters string: The parameters for the script
          • roles required array: The list of roles where script will be executed.
            • items string
          • uri required string: The URI to the script.

Output

Output schema unknown

ScriptActions_ListByCluster

Lists all the persisted script actions for the specified cluster.

azure_hdinsight_scriptactions.ScriptActions_ListByCluster({
  "subscriptionId": "",
  "resourceGroupName": "",
  "clusterName": "",
  "api-version": ""
}, context)

Input

  • input object
    • subscriptionId required string: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
    • resourceGroupName required string: The name of the resource group.
    • clusterName required string: The name of the cluster.
    • api-version required string: The HDInsight client API Version.

Output

ScriptActions_Delete

Deletes a specified persisted script action of the cluster.

azure_hdinsight_scriptactions.ScriptActions_Delete({
  "subscriptionId": "",
  "resourceGroupName": "",
  "clusterName": "",
  "scriptName": "",
  "api-version": ""
}, context)

Input

  • input object
    • subscriptionId required string: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
    • resourceGroupName required string: The name of the resource group.
    • clusterName required string: The name of the cluster.
    • scriptName required string: The name of the script.
    • api-version required string: The HDInsight client API Version.

Output

Output schema unknown

ScriptExecutionHistory_ListByCluster

Lists all scripts' execution history for the specified cluster.

azure_hdinsight_scriptactions.ScriptExecutionHistory_ListByCluster({
  "subscriptionId": "",
  "resourceGroupName": "",
  "clusterName": "",
  "api-version": ""
}, context)

Input

  • input object
    • subscriptionId required string: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
    • resourceGroupName required string: The name of the resource group.
    • clusterName required string: The name of the cluster.
    • api-version required string: The HDInsight client API Version.

Output

ScriptActions_GetExecutionDetail

Gets the script execution detail for the given script execution ID.

azure_hdinsight_scriptactions.ScriptActions_GetExecutionDetail({
  "subscriptionId": "",
  "resourceGroupName": "",
  "clusterName": "",
  "scriptExecutionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • subscriptionId required string: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
    • resourceGroupName required string: The name of the resource group.
    • clusterName required string: The name of the cluster.
    • scriptExecutionId required string: The script execution Id
    • api-version required string: The HDInsight client API Version.

Output

  • output: The execution details of a script action.
    • applicationName string: The application name of the script action, if any.
    • name required string: The name of the script action.
    • parameters string: The parameters for the script
    • roles required array: The list of roles where script will be executed.
      • items string
    • uri required string: The URI to the script.
    • debugInformation string: The script action execution debug information.
    • endTime string: The end time of script action execution.
    • executionSummary array: The summary of script action execution result.
      • items object: The execution summary of a script action.
        • instanceCount integer: The instance count for a given script action execution status.
        • status string: The status of script action execution.
    • operation string: The reason why the script action was executed.
    • scriptExecutionId integer: The execution id of the script action.
    • startTime string: The start time of script action execution.
    • status string: The current execution status of the script action.

ScriptExecutionHistory_Promote

Promotes the specified ad-hoc script execution to a persisted script.

azure_hdinsight_scriptactions.ScriptExecutionHistory_Promote({
  "subscriptionId": "",
  "resourceGroupName": "",
  "clusterName": "",
  "scriptExecutionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • subscriptionId required string: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
    • resourceGroupName required string: The name of the resource group.
    • clusterName required string: The name of the cluster.
    • scriptExecutionId required string: The script execution Id
    • api-version required string: The HDInsight client API Version.

Output

Output schema unknown

Definitions

ClusterListRuntimeScriptActionDetailResult

  • ClusterListRuntimeScriptActionDetailResult object: The list runtime script action detail response.
    • nextLink string: The link (url) to the next page of results.
    • value array: The list of persisted script action details for the cluster.
      • items: The execution details of a script action.
        • applicationName string: The application name of the script action, if any.
        • name required string: The name of the script action.
        • parameters string: The parameters for the script
        • roles required array: The list of roles where script will be executed.
          • items string
        • uri required string: The URI to the script.
        • debugInformation string: The script action execution debug information.
        • endTime string: The end time of script action execution.
        • executionSummary array: The summary of script action execution result.
          • items object: The execution summary of a script action.
            • instanceCount integer: The instance count for a given script action execution status.
            • status string: The status of script action execution.
        • operation string: The reason why the script action was executed.
        • scriptExecutionId integer: The execution id of the script action.
        • startTime string: The start time of script action execution.
        • status string: The current execution status of the script action.

ScriptAction

  • ScriptAction object: Describes a script action on role on the cluster.
    • name required string: The name of the script action.
    • parameters required string: The parameters for the script provided.
    • uri required string: The URI to the script.

ScriptActionExecutionHistoryList

  • ScriptActionExecutionHistoryList object: The list script execution history response.
    • nextLink string: The link (url) to the next page of results.
    • value array: The list of persisted script action details for the cluster.
      • items: The execution details of a script action.
        • applicationName string: The application name of the script action, if any.
        • name required string: The name of the script action.
        • parameters string: The parameters for the script
        • roles required array: The list of roles where script will be executed.
          • items string
        • uri required string: The URI to the script.
        • debugInformation string: The script action execution debug information.
        • endTime string: The end time of script action execution.
        • executionSummary array: The summary of script action execution result.
          • items object: The execution summary of a script action.
            • instanceCount integer: The instance count for a given script action execution status.
            • status string: The status of script action execution.
        • operation string: The reason why the script action was executed.
        • scriptExecutionId integer: The execution id of the script action.
        • startTime string: The start time of script action execution.
        • status string: The current execution status of the script action.

ScriptActionPersistedGetResponseSpec

  • ScriptActionPersistedGetResponseSpec object: The persisted script action for cluster.
    • applicationName string: The application name for the script action.
    • name string: The name of script action.
    • parameters string: The parameters for the script provided.
    • roles array: The list of roles where script will be executed.
      • items string
    • uri string: The URI to the script.

ScriptActionsList

  • ScriptActionsList object: The persisted script action for the cluster.
    • nextLink string: The link (url) to the next page of results.
    • value array: The list of persisted script action details for the cluster.
      • items: The execution details of a script action.
        • applicationName string: The application name of the script action, if any.
        • name required string: The name of the script action.
        • parameters string: The parameters for the script
        • roles required array: The list of roles where script will be executed.
          • items string
        • uri required string: The URI to the script.
        • debugInformation string: The script action execution debug information.
        • endTime string: The end time of script action execution.
        • executionSummary array: The summary of script action execution result.
          • items object: The execution summary of a script action.
            • instanceCount integer: The instance count for a given script action execution status.
            • status string: The status of script action execution.
        • operation string: The reason why the script action was executed.
        • scriptExecutionId integer: The execution id of the script action.
        • startTime string: The start time of script action execution.
        • status string: The current execution status of the script action.
5.0.0

5 years ago

4.0.0

7 years ago

3.0.0

7 years ago