Job Stream - List By Job

Service:

Automation

API Version:

2019-06-01

Retrieve a list of jobs streams identified by job name.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobName}/streams?api-version=2019-06-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobName}/streams?$filter={$filter}&api-version=2019-06-01

URI Parameters

Name	In	Required	Type	Description
automationAccountName	path	True	string	The name of the automation account.
jobName	path	True	string	The job name.
resourceGroupName	path	True	string	Name of an Azure Resource group. Regex pattern: ^[-\w\._]+$
subscriptionId	path	True	string	Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
api-version	query	True	string	Client Api Version.
$filter	query		string	The filter to apply on the operation.

Request Header

Name	Required	Type	Description
clientRequestId		string	Identifies this specific client request.

Responses

Name	Type	Description
200 OK	JobStreamListResult	OK
Other Status Codes	ErrorResponse	Automation error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

List job streams by job name

Sample Request

HTTP

GET https://management.azure.com/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/jobs/foo/streams?api-version=2019-06-01

Java

import com.azure.core.util.Context;

/** Samples for JobStream ListByJob. */
public final class Main {
    /*
     * x-ms-original-file: specification/automation/resource-manager/Microsoft.Automation/stable/2019-06-01/examples/job/listJobStreamsByJob.json
     */
    /**
     * Sample code: List job streams by job name.
     *
     * @param manager Entry point to AutomationManager.
     */
    public static void listJobStreamsByJobName(com.azure.resourcemanager.automation.AutomationManager manager) {
        manager.jobStreams().listByJob("mygroup", "ContoseAutomationAccount", "foo", null, null, 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 armautomation_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/automation/armautomation"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/main/specification/automation/resource-manager/Microsoft.Automation/stable/2019-06-01/examples/job/listJobStreamsByJob.json
func ExampleJobStreamClient_NewListByJobPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armautomation.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewJobStreamClient().NewListByJobPager("mygroup", "ContoseAutomationAccount", "foo", &armautomation.JobStreamClientListByJobOptions{Filter: nil,
		ClientRequestID: 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.JobStreamListResult = armautomation.JobStreamListResult{
		// 	Value: []*armautomation.JobStream{
		// 		{
		// 			ID: to.Ptr("/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourcegroups/mygroup/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/jobs/jobName/streams/24456a8a-2857-4af6-932c-3455f38bd05e_00636535675981232703_00000000000000000001"),
		// 			Properties: &armautomation.JobStreamProperties{
		// 				JobStreamID: to.Ptr("24456a8a-2857-4af6-932c-3455f38bd05e_00636535675981232703_00000000000000000001"),
		// 				StreamType: to.Ptr(armautomation.JobStreamTypeOutput),
		// 				Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-02-07T02:33:18.1232703+00:00"); return t}()),
		// 			},
		// 		},
		// 		{
		// 			ID: to.Ptr("/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourcegroups/mygroup/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/jobs/jobName/streams/24456a8a-2857-4af6-932c-3455f38bd05e_00636535675984691350_00000000000000000002"),
		// 			Properties: &armautomation.JobStreamProperties{
		// 				JobStreamID: to.Ptr("24456a8a-2857-4af6-932c-3455f38bd05e_00636535675984691350_00000000000000000002"),
		// 				StreamType: to.Ptr(armautomation.JobStreamTypeOutput),
		// 				Time: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-02-07T02:33:18.469135+00:00"); return t}()),
		// 			},
		// 	}},
		// }
	}
}

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 { AutomationClient } = require("@azure/arm-automation");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Retrieve a list of jobs streams identified by job name.
 *
 * @summary Retrieve a list of jobs streams identified by job name.
 * x-ms-original-file: specification/automation/resource-manager/Microsoft.Automation/stable/2019-06-01/examples/job/listJobStreamsByJob.json
 */
async function listJobStreamsByJobName() {
  const subscriptionId =
    process.env["AUTOMATION_SUBSCRIPTION_ID"] || "51766542-3ed7-4a72-a187-0c8ab644ddab";
  const resourceGroupName = process.env["AUTOMATION_RESOURCE_GROUP"] || "mygroup";
  const automationAccountName = "ContoseAutomationAccount";
  const jobName = "foo";
  const credential = new DefaultAzureCredential();
  const client = new AutomationClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.jobStreamOperations.listByJob(
    resourceGroupName,
    automationAccountName,
    jobName
  )) {
    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

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Automation;
using Azure.ResourceManager.Automation.Models;

// Generated from example definition: specification/automation/resource-manager/Microsoft.Automation/stable/2019-06-01/examples/job/listJobStreamsByJob.json
// this example is just showing the usage of "JobStream_ListByJob" 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 AutomationJobResource created on azure
// for more information of creating AutomationJobResource, please refer to the document of AutomationJobResource
string subscriptionId = "51766542-3ed7-4a72-a187-0c8ab644ddab";
string resourceGroupName = "mygroup";
string automationAccountName = "ContoseAutomationAccount";
string jobName = "foo";
ResourceIdentifier automationJobResourceId = AutomationJobResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, automationAccountName, jobName);
AutomationJobResource automationJob = client.GetAutomationJobResource(automationJobResourceId);

// invoke the operation and iterate over the result
await foreach (AutomationJobStream item in automationJob.GetJobStreamsAsync())
{
    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": [
    {
      "id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourcegroups/mygroup/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/jobs/jobName/streams/24456a8a-2857-4af6-932c-3455f38bd05e_00636535675981232703_00000000000000000001",
      "properties": {
        "jobStreamId": "24456a8a-2857-4af6-932c-3455f38bd05e_00636535675981232703_00000000000000000001",
        "summary": null,
        "time": "2018-02-07T02:33:18.1232703+00:00",
        "streamType": "Output"
      }
    },
    {
      "id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourcegroups/mygroup/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/jobs/jobName/streams/24456a8a-2857-4af6-932c-3455f38bd05e_00636535675984691350_00000000000000000002",
      "properties": {
        "jobStreamId": "24456a8a-2857-4af6-932c-3455f38bd05e_00636535675984691350_00000000000000000002",
        "summary": null,
        "time": "2018-02-07T02:33:18.469135+00:00",
        "streamType": "Output"
      }
    }
  ],
  "nextLink": null
}

Definitions

Name	Description
ErrorResponse	Error response of an operation failure
JobStream	Definition of the job stream.
JobStreamListResult	The response model for the list job stream operation.
JobStreamType	Gets or sets the stream type.

ErrorResponse

Error response of an operation failure

Name	Type	Description
code	string	Error code
message	string	Error message indicating why the operation failed.

JobStream

Definition of the job stream.

Name	Type	Description
id	string	Gets or sets the id of the resource.
properties.jobStreamId	string	Gets or sets the id of the job stream.
properties.streamText	string	Gets or sets the stream text.
properties.streamType	JobStreamType	Gets or sets the stream type.
properties.summary	string	Gets or sets the summary.
properties.time	string	Gets or sets the creation time of the job.
properties.value	object	Gets or sets the values of the job stream.

JobStreamListResult

The response model for the list job stream operation.

Name	Type	Description
nextLink	string	Gets or sets the next link.
value	JobStream[]	A list of job streams.

JobStreamType

Gets or sets the stream type.

Name	Type	Description
Any	string
Debug	string
Error	string
Output	string
Progress	string
Verbose	string
Warning	string