Job Stream - List By Job

Reference

Service:: Automation

API Version:: 2023-11-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=2023-11-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=2023-11-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=2023-11-01

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

Share via