Clusters - List Streaming Jobs

Service:

Stream Analytics

API Version:

2020-03-01

Listy wszystkie zadania przesyłania strumieniowego w danym klastrze.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/clusters/{clusterName}/listStreamingJobs?api-version=2020-03-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
clusterName	path	True	string	Nazwa klastra.
resourceGroupName	path	True	string	Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter. Regex pattern: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	Identyfikator subskrypcji docelowej.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ClusterJobListResult	Pomyślnie wymieniono zadania przesyłania strumieniowego w określonym klastrze.
Other Status Codes	Error	Błąd.

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 streaming jobs in cluster

Sample Request

HTTP

POST https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/sjrg/providers/Microsoft.StreamAnalytics/clusters/testcluster/listStreamingJobs?api-version=2020-03-01

Java

import com.azure.core.util.Context;

/** Samples for Clusters ListStreamingJobs. */
public final class Main {
    /*
     * x-ms-original-file: specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Cluster_ListStreamingJobs.json
     */
    /**
     * Sample code: List all streaming jobs in cluster.
     *
     * @param manager Entry point to StreamAnalyticsManager.
     */
    public static void listAllStreamingJobsInCluster(
        com.azure.resourcemanager.streamanalytics.StreamAnalyticsManager manager) {
        manager.clusters().listStreamingJobs("sjrg", "testcluster", 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

Go

package armstreamanalytics_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/streamanalytics/armstreamanalytics"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/d55b8005f05b040b852c15e74a0f3e36494a15e1/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Cluster_ListStreamingJobs.json
func ExampleClustersClient_NewListStreamingJobsPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armstreamanalytics.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewClustersClient().NewListStreamingJobsPager("sjrg", "testcluster", 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.ClusterJobListResult = armstreamanalytics.ClusterJobListResult{
		// 	Value: []*armstreamanalytics.ClusterJob{
		// 		{
		// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/sjrg/providers/microsoft.streamAnalytics/streamingjobs/AFilterSample"),
		// 			JobState: to.Ptr(armstreamanalytics.JobStateRunning),
		// 			StreamingUnits: to.Ptr[int32](6),
		// 		},
		// 		{
		// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/sjrg/providers/microsoft.streamAnalytics/streamingjobs/AnotherFilterSample"),
		// 			JobState: to.Ptr(armstreamanalytics.JobStateStopped),
		// 			StreamingUnits: to.Ptr[int32](1),
		// 	}},
		// }
	}
}

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

JavaScript

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

/**
 * This sample demonstrates how to Lists all of the streaming jobs in the given cluster.
 *
 * @summary Lists all of the streaming jobs in the given cluster.
 * x-ms-original-file: specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2020-03-01/examples/Cluster_ListStreamingJobs.json
 */
async function listAllStreamingJobsInCluster() {
  const subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = "sjrg";
  const clusterName = "testcluster";
  const credential = new DefaultAzureCredential();
  const client = new StreamAnalyticsManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.clusters.listStreamingJobs(resourceGroupName, clusterName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

listAllStreamingJobsInCluster().catch(console.error);

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": [
    {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/sjrg/providers/microsoft.streamAnalytics/streamingjobs/AFilterSample",
      "streamingUnits": 6,
      "jobState": "Running"
    },
    {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/sjrg/providers/microsoft.streamAnalytics/streamingjobs/AnotherFilterSample",
      "streamingUnits": 1,
      "jobState": "Stopped"
    }
  ],
  "nextLink": null
}

Definicje

Nazwa	Opis
ClusterJob	Zadanie przesyłania strumieniowego.
ClusterJobListResult	Lista zadań przesyłania strumieniowego. Wypełnione przez operację Lista.
Error	Typowa reprezentacja błędów.
JobState	Bieżący stan wykonywania zadania przesyłania strumieniowego.

ClusterJob

Zadanie przesyłania strumieniowego.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu zadania przesyłania strumieniowego.
jobState	JobState	Bieżący stan wykonywania zadania przesyłania strumieniowego.
streamingUnits	integer	Liczba jednostek przesyłania strumieniowego używanych przez zadanie przesyłania strumieniowego.

ClusterJobListResult

Lista zadań przesyłania strumieniowego. Wypełnione przez operację Lista.

Nazwa	Typ	Opis
nextLink	string	Adres URL służący do pobierania następnego zestawu zadań przesyłania strumieniowego.
value	ClusterJob[]	Lista zadań przesyłania strumieniowego.

Error

Typowa reprezentacja błędów.

Nazwa	Typ	Opis
error	Error	Właściwości definicji błędu.

JobState

Bieżący stan wykonywania zadania przesyłania strumieniowego.

Nazwa	Typ	Opis
Created	string	Zadanie jest obecnie w stanie Utworzony.
Degraded	string	Zadanie jest obecnie w stanie Obniżona wydajność.
Deleting	string	Zadanie jest obecnie w stanie Usuwanie.
Failed	string	Zadanie jest obecnie w stanie Niepowodzenie.
Restarting	string	Zadanie jest obecnie w stanie Ponowne uruchamianie.
Running	string	Zadanie jest obecnie w stanie Uruchomiony.
Scaling	string	Zadanie jest obecnie w stanie Skalowanie.
Starting	string	Zadanie jest obecnie w stanie początkowym.
Stopped	string	Zadanie jest obecnie w stanie Zatrzymano.
Stopping	string	Zadanie jest obecnie w stanie Zatrzymywanie.