openapi-directory/api/azure.com/hdinsight-scriptActions.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"description":"The HDInsight Management Client.","title":"HDInsightManagementClient","version":"2018-06-01-preview","x-apisguru-categories":["cloud"],"x-logo":{"url":"https://assets.onestore.ms/cdnfiles/onestorerolling-1606-01000/shell/v3/images/logo/microsoft.png"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/scriptActions.json","version":"2.0"}],"x-preferred":true,"x-providerName":"azure.com","x-serviceName":"hdinsight-scriptActions","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/executeScriptActions":{"post":{"description":"Executes script actions on the specified HDInsight cluster.","operationId":"Clusters_ExecuteScriptActions","parameters":[{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/ClusterNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"description":"The parameters for the script actions to execute on a running cluster.","properties":{"persistOnSuccess":{"description":"Gets or sets if the scripts needs to be persisted.","type":"boolean"},"scriptActions":{"description":"The list of run time script actions.","items":{"description":"Describes a script action on a running cluster.","properties":{"applicationName":{"description":"The application name of the script action, if any.","readOnly":true,"type":"string"},"name":{"description":"The name of the script action.","type":"string"},"parameters":{"description":"The parameters for the script","type":"string"},"roles":{"description":"The list of roles where script will be executed.","items":{"type":"string"},"type":"array"},"uri":{"description":"The URI to the script.","type":"string"}},"required":["name","uri","roles"]},"type":"array"}},"required":["persistOnSuccess"]}}},"description":"The parameters for executing script actions.","required":true},"responses":{"200":{"description":"Accepted response definition."},"202":{"description":"OK response definition."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Describes the format of Error response.","properties":{"code":{"description":"Error code","type":"string"},"message":{"description":"Error message indicating why the operation failed.","type":"string"}},"type":"object"}}}}},"tags":["Clusters"],"x-ms-long-running-operation":true}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/scriptActions":{"get":{"description":"Lists all the persisted script actions for the specified cluster.","operationId":"ScriptActions_ListByCluster","parameters":[{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/ClusterNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"OK response definition.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScriptActionsList"},"examples":{"List all persisted script actions for the given cluster":{"$ref":"#/components/examples/List_all_persisted_script_actions_for_the_given_cluster"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Describes the format of Error response.","properties":{"code":{"description":"Error code","type":"string"},"message":{"description":"Error message indicating why the operation failed.","type":"string"}},"type":"object"}}}}},"tags":["ScriptActions"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/scriptActions/{scriptName}":{"delete":{"description":"Deletes a specified persisted script action of the cluster.","operationId":"ScriptActions_Delete","parameters":[{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/ClusterNameParameter"},{"$ref":"#/components/parameters/ScriptNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"OK response definition."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Describes the format of Error response.","properties":{"code":{"description":"Error code","type":"string"},"message":{"description":"Error message indicating why the operation failed.","type":"string"}},"type":"object"}}}}},"tags":["ScriptActions"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/scriptExecutionHistory":{"get":{"description":"Lists all scripts' execution history for the specified cluster.","operationId":"ScriptExecutionHistory_ListByCluster","parameters":[{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/ClusterNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"OK response definition.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScriptActionExecutionHistoryList"},"examples":{"Get Script Execution History List":{"$ref":"#/components/examples/Get_Script_Execution_History_List"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Describes the format of Error response.","properties":{"code":{"description":"Error code","type":"string"},"message":{"description":"Error message indicating why the operation failed.","type":"string"}},"type":"object"}}}}},"tags":["ScriptExecutionHistory"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/scriptExecutionHistory/{scriptExecutionId}":{"get":{"description":"Gets the script execution detail for the given script execution ID.","operationId":"ScriptActions_GetExecutionDetail","parameters":[{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/ClusterNameParameter"},{"$ref":"#/components/parameters/ScriptExecutionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"OK response definition.","content":{"application/json":{"schema":{"allOf":[{"description":"Describes a script action on a running cluster.","properties":{"applicationName":{"description":"The application name of the script action, if any.","readOnly":true,"type":"string"},"name":{"description":"The name of the script action.","type":"string"},"parameters":{"description":"The parameters for the script","type":"string"},"roles":{"description":"The list of roles where script will be executed.","items":{"type":"string"},"type":"array"},"uri":{"description":"The URI to the script.","type":"string"}},"required":["name","uri","roles"]},{"properties":{"debugInformation":{"description":"The script action execution debug information.","readOnly":true,"type":"string"},"endTime":{"description":"The end time of script action execution.","readOnly":true,"type":"string"},"executionSummary":{"description":"The summary of script action execution result.","items":{"description":"The execution summary of a script action.","properties":{"instanceCount":{"description":"The instance count for a given script action execution status.","format":"int32","readOnly":true,"type":"integer"},"status":{"description":"The status of script action execution.","readOnly":true,"type":"string"}}},"readOnly":true,"type":"array"},"operation":{"description":"The reason why the script action was executed.","readOnly":true,"type":"string"},"scriptExecutionId":{"description":"The execution id of the script action.","format":"int64","readOnly":true,"type":"integer"},"startTime":{"description":"The start time of script action execution.","readOnly":true,"type":"string"},"status":{"description":"The current execution status of the script action.","readOnly":true,"type":"string"}}}],"description":"The execution details of a script action."},"examples":{"Get script execution history by script id":{"$ref":"#/components/examples/Get_script_execution_history_by_script_id"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Describes the format of Error response.","properties":{"code":{"description":"Error code","type":"string"},"message":{"description":"Error message indicating why the operation failed.","type":"string"}},"type":"object"}}}}},"tags":["ScriptExecutionHistory"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/scriptExecutionHistory/{scriptExecutionId}/promote":{"post":{"description":"Promotes the specified ad-hoc script execution to a persisted script.","operationId":"ScriptExecutionHistory_Promote","parameters":[{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/ClusterNameParameter"},{"$ref":"#/components/parameters/ScriptExecutionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"OK response definition."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Describes the format of Error response.","properties":{"code":{"description":"Error code","type":"string"},"message":{"description":"Error message indicating why the operation failed.","type":"string"}},"type":"object"}}}}},"tags":["Promote"]}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"List_all_persisted_script_actions_for_the_given_cluster":{"value":{"value":[{"applicationName":"app","name":"app-Install","parameters":"","roles":["edgenode"],"uri":"https://app.com/azure/app_install.sh"}]}},"Get_Script_Execution_History_List":{"value":{"value":[{"applicationName":"app1","endTime":"2017-03-22T21:34:39.293","executionSummary":[],"name":"Test","operation":"PostClusterCreateScriptActionRequest","parameters":"","roles":["headnode","workernode"],"scriptExecutionId":391145124054712,"startTime":"2017-03-22T21:34:39.293","status":"ValidationFailed","uri":"http://testurl.com/install.ssh"},{"applicationName":"app2","endTime":"2017-03-22T21:34:39.293","executionSummary":[],"name":"Test","operation":"PostClusterCreateScriptActionRequest","parameters":"","roles":["headnode","workernode"],"scriptExecutionId":391144597342127,"startTime":"2017-03-22T21:34:39.293","status":"ValidationFailed","uri":"http://testurl.com/install-script.ssh"}]}},"Get_script_execution_history_by_script_id":{"value":{"applicationName":"app1","debugInformation":"","endTime":"2017-03-22T21:34:39.293","executionSummary":[],"name":"Test","operation":"PostClusterCreateScriptActionRequest","parameters":"","roles":["headnode","workernode"],"scriptExecutionId":391145124054712,"startTime":"2017-03-22T21:34:39.293","status":"ValidationFailed","uri":"http://testurl.com/install.ssh"}}},"parameters":{"ApiVersionParameter":{"description":"The HDInsight client API Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Execute script action on HDInsight cluster":{"value":"2018-06-01-preview"},"List all persisted script actions for the given cluster":{"value":"2018-06-01-preview"},"Delete a script action on HDInsight cluster":{"value":"2018-06-01-preview"},"Get Script Execution History List":{"value":"2018-06-01-preview"},"Get script execution history by script id":{"value":"2018-06-01-preview"},"Promote a script action on HDInsight cluster":{"value":"2018-06-01-preview"}}},"ClusterNameParameter":{"description":"The name of the cluster.","in":"path","name":"clusterName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Execute script action on HDInsight cluster":{"value":"cluster1"},"List all persisted script actions for the given cluster":{"value":"cluster1"},"Delete a script action on HDInsight cluster":{"value":"cluster1"},"Get Script Execution History List":{"value":"cluster1"},"Get script execution history by script id":{"value":"cluster1"},"Promote a script action on HDInsight cluster":{"value":"cluster1"}}},"ResourceGroupNameParameter":{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Execute script action on HDInsight cluster":{"value":"rg1"},"List all persisted script actions for the given cluster":{"value":"rg1"},"Delete a script action on HDInsight cluster":{"value":"rg1"},"Get Script Execution History List":{"value":"rg1"},"Get script execution history by script id":{"value":"rg1"},"Promote a script action on HDInsight cluster":{"value":"rg1"}}},"ScriptExecutionIdParameter":{"description":"The script execution Id","in":"path","name":"scriptExecutionId","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Get script execution history by script id":{"value":"391145124054712"},"Promote a script action on HDInsight cluster":{"value":"391145124054712"}}},"ScriptNameParameter":{"description":"The name of the script.","in":"path","name":"scriptName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Delete a script action on HDInsight cluster":{"value":"scriptName"}}},"SubscriptionIdParameter":{"description":"The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Execute script action on HDInsight cluster":{"value":"subid"},"List all persisted script actions for the given cluster":{"value":"subid"},"Delete a script action on HDInsight cluster":{"value":"subid"},"Get Script Execution History List":{"value":"subid"},"Get script execution history by script id":{"value":"subid"},"Promote a script action on HDInsight cluster":{"value":"subid"}}}},"securitySchemes":{"azure_auth":{"description":"Azure Active Directory OAuth2 Flow","type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://login.microsoftonline.com/common/oauth2/authorize","scopes":{"user_impersonation":"impersonate your user account"}}}}},"schemas":{"ClusterListRuntimeScriptActionDetailResult":{"description":"The list runtime script action detail response.","properties":{"nextLink":{"description":"The link (url) to the next page of results.","readOnly":true,"type":"string"},"value":{"description":"The list of persisted script action details for the cluster.","items":{"allOf":[{"description":"Describes a script action on a running cluster.","properties":{"applicationName":{"description":"The application name of the script action, if any.","readOnly":true,"type":"string"},"name":{"description":"The name of the script action.","type":"string"},"parameters":{"description":"The parameters for the script","type":"string"},"roles":{"description":"The list of roles where script will be executed.","items":{"type":"string"},"type":"array"},"uri":{"description":"The URI to the script.","type":"string"}},"required":["name","uri","roles"]},{"properties":{"debugInformation":{"description":"The script action execution debug information.","readOnly":true,"type":"string"},"endTime":{"description":"The end time of script action execution.","readOnly":true,"type":"string"},"executionSummary":{"description":"The summary of script action execution result.","items":{"description":"The execution summary of a script action.","properties":{"instanceCount":{"description":"The instance count for a given script action execution status.","format":"int32","readOnly":true,"type":"integer"},"status":{"description":"The status of script action execution.","readOnly":true,"type":"string"}}},"readOnly":true,"type":"array"},"operation":{"description":"The reason why the script action was executed.","readOnly":true,"type":"string"},"scriptExecutionId":{"description":"The execution id of the script action.","format":"int64","readOnly":true,"type":"integer"},"startTime":{"description":"The start time of script action execution.","readOnly":true,"type":"string"},"status":{"description":"The current execution status of the script action.","readOnly":true,"type":"string"}}}],"description":"The execution details of a script action."},"readOnly":true,"type":"array"}}},"ScriptAction":{"description":"Describes a script action on role on the cluster.","properties":{"name":{"description":"The name of the script action.","type":"string"},"parameters":{"description":"The parameters for the script provided.","type":"string"},"uri":{"description":"The URI to the script.","type":"string"}},"required":["name","uri","parameters"]},"ScriptActionExecutionHistoryList":{"description":"The list script execution history response.","properties":{"nextLink":{"description":"The link (url) to the next page of results.","readOnly":true,"type":"string"},"value":{"description":"The list of persisted script action details for the cluster.","items":{"allOf":[{"description":"Describes a script action on a running cluster.","properties":{"applicationName":{"description":"The application name of the script action, if any.","readOnly":true,"type":"string"},"name":{"description":"The name of the script action.","type":"string"},"parameters":{"description":"The parameters for the script","type":"string"},"roles":{"description":"The list of roles where script will be executed.","items":{"type":"string"},"type":"array"},"uri":{"description":"The URI to the script.","type":"string"}},"required":["name","uri","roles"]},{"properties":{"debugInformation":{"description":"The script action execution debug information.","readOnly":true,"type":"string"},"endTime":{"description":"The end time of script action execution.","readOnly":true,"type":"string"},"executionSummary":{"description":"The summary of script action execution result.","items":{"description":"The execution summary of a script action.","properties":{"instanceCount":{"description":"The instance count for a given script action execution status.","format":"int32","readOnly":true,"type":"integer"},"status":{"description":"The status of script action execution.","readOnly":true,"type":"string"}}},"readOnly":true,"type":"array"},"operation":{"description":"The reason why the script action was executed.","readOnly":true,"type":"string"},"scriptExecutionId":{"description":"The execution id of the script action.","format":"int64","readOnly":true,"type":"integer"},"startTime":{"description":"The start time of script action execution.","readOnly":true,"type":"string"},"status":{"description":"The current execution status of the script action.","readOnly":true,"type":"string"}}}],"description":"The execution details of a script action."},"readOnly":true,"type":"array"}}},"ScriptActionPersistedGetResponseSpec":{"description":"The persisted script action for cluster.","properties":{"applicationName":{"description":"The application name for the script action.","type":"string"},"name":{"description":"The name of script action.","type":"string"},"parameters":{"description":"The parameters for the script provided.","type":"string"},"roles":{"description":"The list of roles where script will be executed.","items":{"type":"string"},"type":"array"},"uri":{"description":"The URI to the script.","type":"string"}}},"ScriptActionsList":{"description":"The persisted script action for the cluster.","properties":{"nextLink":{"description":"The link (url) to the next page of results.","readOnly":true,"type":"string"},"value":{"description":"The list of persisted script action details for the cluster.","items":{"allOf":[{"description":"Describes a script action on a running cluster.","properties":{"applicationName":{"description":"The application name of the script action, if any.","readOnly":true,"type":"string"},"name":{"description":"The name of the script action.","type":"string"},"parameters":{"description":"The parameters for the script","type":"string"},"roles":{"description":"The list of roles where script will be executed.","items":{"type":"string"},"type":"array"},"uri":{"description":"The URI to the script.","type":"string"}},"required":["name","uri","roles"]},{"properties":{"debugInformation":{"description":"The script action execution debug information.","readOnly":true,"type":"string"},"endTime":{"description":"The end time of script action execution.","readOnly":true,"type":"string"},"executionSummary":{"description":"The summary of script action execution result.","items":{"description":"The execution summary of a script action.","properties":{"instanceCount":{"description":"The instance count for a given script action execution status.","format":"int32","readOnly":true,"type":"integer"},"status":{"description":"The status of script action execution.","readOnly":true,"type":"string"}}},"readOnly":true,"type":"array"},"operation":{"description":"The reason why the script action was executed.","readOnly":true,"type":"string"},"scriptExecutionId":{"description":"The execution id of the script action.","format":"int64","readOnly":true,"type":"integer"},"startTime":{"description":"The start time of script action execution.","readOnly":true,"type":"string"},"status":{"description":"The current execution status of the script action.","readOnly":true,"type":"string"}}}],"description":"The execution details of a script action."},"type":"array"}}}}}}