Script Actions - List By Cluster

Odwołanie

Service:: HDInsight

API Version:: 2021-06-01

Listy wszystkie utrwalone akcje skryptu dla określonego klastra.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/scriptActions?api-version=2021-06-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
clusterName	path	True	string	Nazwa klastra.
resourceGroupName	path	True	string	Nazwa grupy zasobów.
subscriptionId	path	True	string	Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.
api-version	query	True	string	Wersja interfejsu API klienta usługi HDInsight.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ScriptActionsList	Definicja odpowiedzi OK.
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

List all persisted script actions for the given cluster

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/scriptActions?api-version=2021-06-01

import com.azure.core.util.Context;

/** Samples for ScriptActions ListByCluster. */
public final class Main {
    /*
     * x-ms-original-file: specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/GetLinuxHadoopScriptAction.json
     */
    /**
     * Sample code: List all persisted script actions for the given cluster.
     *
     * @param manager Entry point to HDInsightManager.
     */
    public static void listAllPersistedScriptActionsForTheGivenCluster(
        com.azure.resourcemanager.hdinsight.HDInsightManager manager) {
        manager.scriptActions().listByCluster("rg1", "cluster1", Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential
from azure.mgmt.hdinsight import HDInsightManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-hdinsight
# USAGE
    python get_linux_hadoop_script_action.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = HDInsightManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.script_actions.list_by_cluster(
        resource_group_name="rg1",
        cluster_name="cluster1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/GetLinuxHadoopScriptAction.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armhdinsight_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hdinsight/armhdinsight"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/GetLinuxHadoopScriptAction.json
func ExampleScriptActionsClient_NewListByClusterPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armhdinsight.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewScriptActionsClient().NewListByClusterPager("rg1", "cluster1", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ScriptActionsList = armhdinsight.ScriptActionsList{
		// 	Value: []*armhdinsight.RuntimeScriptActionDetail{
		// 		{
		// 			Name: to.Ptr("app-Install"),
		// 			ApplicationName: to.Ptr("app"),
		// 			Roles: []*string{
		// 				to.Ptr("edgenode")},
		// 				URI: to.Ptr("https://app.com/azure/app_install.sh"),
		// 		}},
		// 	}
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { HDInsightManagementClient } = require("@azure/arm-hdinsight");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Lists all the persisted script actions for the specified cluster.
 *
 * @summary Lists all the persisted script actions for the specified cluster.
 * x-ms-original-file: specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/GetLinuxHadoopScriptAction.json
 */
async function listAllPersistedScriptActionsForTheGivenCluster() {
  const subscriptionId = process.env["HDINSIGHT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["HDINSIGHT_RESOURCE_GROUP"] || "rg1";
  const clusterName = "cluster1";
  const credential = new DefaultAzureCredential();
  const client = new HDInsightManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.scriptActions.listByCluster(resourceGroupName, clusterName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.HDInsight;
using Azure.ResourceManager.HDInsight.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/GetLinuxHadoopScriptAction.json
// this example is just showing the usage of "ScriptActions_ListByCluster" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this HDInsightClusterResource created on azure
// for more information of creating HDInsightClusterResource, please refer to the document of HDInsightClusterResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string clusterName = "cluster1";
ResourceIdentifier hdInsightClusterResourceId = HDInsightClusterResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, clusterName);
HDInsightClusterResource hdInsightCluster = client.GetHDInsightClusterResource(hdInsightClusterResourceId);

// invoke the operation and iterate over the result
await foreach (RuntimeScriptActionDetail item in hdInsightCluster.GetScriptActionsAsync())
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine($"Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

{
  "value": [
    {
      "name": "app-Install",
      "uri": "https://app.com/azure/app_install.sh",
      "roles": [
        "edgenode"
      ],
      "applicationName": "app"
    }
  ]
}

Definicje

Nazwa	Opis
ErrorResponse	Opisuje format odpowiedzi na błąd.
RuntimeScriptActionDetail	Szczegóły wykonywania akcji skryptu.
ScriptActionExecutionSummary	Podsumowanie wykonania akcji skryptu.
ScriptActionsList	Akcja utrwalonego skryptu dla klastra.

ErrorResponse

Opisuje format odpowiedzi na błąd.

Nazwa	Typ	Opis
code	string	Kod błędu
message	string	Komunikat o błędzie wskazujący, dlaczego operacja nie powiodła się.

RuntimeScriptActionDetail

Szczegóły wykonywania akcji skryptu.

Nazwa	Typ	Opis
applicationName	string	Nazwa aplikacji akcji skryptu, jeśli istnieje.
debugInformation	string	Informacje debugowania wykonywania akcji skryptu.
endTime	string	Godzina zakończenia wykonywania akcji skryptu.
executionSummary	ScriptActionExecutionSummary[]	Podsumowanie wyniku wykonania akcji skryptu.
name	string	Nazwa akcji skryptu.
operation	string	Przyczyna wykonania akcji skryptu.
parameters	string	Parametry skryptu
roles	string[]	Lista ról, w których zostanie wykonany skrypt.
scriptExecutionId	integer	Identyfikator wykonania akcji skryptu.
startTime	string	Godzina rozpoczęcia wykonywania akcji skryptu.
status	string	Bieżący stan wykonania akcji skryptu.
uri	string	Identyfikator URI skryptu.

ScriptActionExecutionSummary

Podsumowanie wykonania akcji skryptu.

Nazwa	Typ	Opis
instanceCount	integer	Liczba wystąpień dla danego stanu wykonywania akcji skryptu.
status	string	Stan wykonywania akcji skryptu.

ScriptActionsList

Akcja utrwalonego skryptu dla klastra.

Nazwa	Typ	Opis
nextLink	string	Link (adres URL) do następnej strony wyników.
value	RuntimeScriptActionDetail[]	Lista szczegółów akcji utrwalonego skryptu dla klastra.