Language

AutomationJobResource Class

Definition

A Class representing an AutomationJob along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct an AutomationJobResource from an instance of ArmClient using the GetAutomationJobResource method. Otherwise you can get one from its parent resource AutomationAccountResource using the GetAutomationJob method.

public class AutomationJobResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Automation.AutomationJobData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Automation.AutomationJobData>
public class AutomationJobResource : Azure.ResourceManager.ArmResource
type AutomationJobResource = class
    inherit ArmResource
    interface IJsonModel<AutomationJobData>
    interface IPersistableModel<AutomationJobData>
type AutomationJobResource = class
    inherit ArmResource
Public Class AutomationJobResource
Inherits ArmResource
Implements IJsonModel(Of AutomationJobData), IPersistableModel(Of AutomationJobData)
Public Class AutomationJobResource
Inherits ArmResource
Inheritance
AutomationJobResource
Implements

Constructors

Name Description
AutomationJobResource()

Initializes a new instance of the AutomationJobResource class for mocking.

Fields

Name Description
ResourceType

Gets the resource type for the operations.

Properties

Name Description
Client

Gets the ArmClient this resource client was created from.

(Inherited from ArmResource)
Data

Gets the data representing this Feature.

Diagnostics

Gets the diagnostic options for this resource client.

(Inherited from ArmResource)
Endpoint

Gets the base uri for this resource client.

(Inherited from ArmResource)
HasData

Gets whether or not the current instance has data.

Id

Gets the resource identifier.

(Inherited from ArmResource)
Pipeline

Gets the pipeline for this resource client.

(Inherited from ArmResource)

Methods

Name Description
CanUseTagResource(CancellationToken)

Checks to see if the TagResource API is deployed in the current environment.

(Inherited from ArmResource)
CanUseTagResourceAsync(CancellationToken)

Checks to see if the TagResource API is deployed in the current environment.

(Inherited from ArmResource)
CreateResourceIdentifier(String, String, String, String)

Generate the resource identifier of a AutomationJobResource instance.

Get(String, CancellationToken)

Retrieve the job identified by job name.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobName}
  • Operation Id: Job_Get
  • Default Api Version: 2019-06-01
  • Resource: AutomationJobResource
GetAsync(String, CancellationToken)

Retrieve the job identified by job name.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobName}
  • Operation Id: Job_Get
  • Default Api Version: 2019-06-01
  • Resource: AutomationJobResource
GetAvailableLocations(CancellationToken)

Lists all available geo-locations.

(Inherited from ArmResource)
GetAvailableLocationsAsync(CancellationToken)

Lists all available geo-locations.

(Inherited from ArmResource)
GetJobStream(String, String, CancellationToken)

Retrieve the job stream identified by job stream id.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobName}/streams/{jobStreamId}
  • Operation Id: JobStream_Get
  • Default Api Version: 2019-06-01
GetJobStreamAsync(String, String, CancellationToken)

Retrieve the job stream identified by job stream id.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobName}/streams/{jobStreamId}
  • Operation Id: JobStream_Get
  • Default Api Version: 2019-06-01
GetJobStreams(String, String, CancellationToken)

Retrieve a list of jobs streams identified by job name.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobName}/streams
  • Operation Id: JobStream_ListByJob
  • Default Api Version: 2019-06-01
GetJobStreamsAsync(String, String, CancellationToken)

Retrieve a list of jobs streams identified by job name.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobName}/streams
  • Operation Id: JobStream_ListByJob
  • Default Api Version: 2019-06-01
GetManagementLock(String, CancellationToken)

Get a management lock by scope.

  • Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName}
  • Operation Id: ManagementLocks_GetByScope
  • Default Api Version: 2020-05-01
  • Resource: ManagementLockResource
(Inherited from ArmResource)
GetManagementLockAsync(String, CancellationToken)

Get a management lock by scope.

  • Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName}
  • Operation Id: ManagementLocks_GetByScope
  • Default Api Version: 2020-05-01
  • Resource: ManagementLockResource
(Inherited from ArmResource)
GetManagementLocks()

Gets a collection of ManagementLockResources in the ArmResource.

(Inherited from ArmResource)
GetOutput(String, CancellationToken)

Retrieve the job output identified by job name.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobName}/output
  • Operation Id: Job_GetOutput
  • Default Api Version: 2019-06-01
  • Resource: AutomationJobResource
GetOutputAsync(String, CancellationToken)

Retrieve the job output identified by job name.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobName}/output
  • Operation Id: Job_GetOutput
  • Default Api Version: 2019-06-01
  • Resource: AutomationJobResource
GetPolicyAssignment(String, CancellationToken)

This operation retrieves a single policy assignment, given its name and the scope it was created at.

  • Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
  • Operation Id: PolicyAssignments_Get
  • Default Api Version: 2022-06-01
  • Resource: PolicyAssignmentResource
(Inherited from ArmResource)
GetPolicyAssignmentAsync(String, CancellationToken)

This operation retrieves a single policy assignment, given its name and the scope it was created at.

  • Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
  • Operation Id: PolicyAssignments_Get
  • Default Api Version: 2022-06-01
  • Resource: PolicyAssignmentResource
(Inherited from ArmResource)
GetPolicyAssignments()

Gets a collection of PolicyAssignmentResources in the ArmResource.

(Inherited from ArmResource)
GetRunbookContent(String, CancellationToken)

Retrieve the runbook content of the job identified by job name.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobName}/runbookContent
  • Operation Id: Job_GetRunbookContent
  • Default Api Version: 2019-06-01
  • Resource: AutomationJobResource
GetRunbookContentAsync(String, CancellationToken)

Retrieve the runbook content of the job identified by job name.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobName}/runbookContent
  • Operation Id: Job_GetRunbookContent
  • Default Api Version: 2019-06-01
  • Resource: AutomationJobResource
GetTagResource()

Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource.

(Inherited from ArmResource)
Resume(String, CancellationToken)

Resume the job identified by jobName.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobName}/resume
  • Operation Id: Job_Resume
  • Default Api Version: 2019-06-01
  • Resource: AutomationJobResource
ResumeAsync(String, CancellationToken)

Resume the job identified by jobName.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobName}/resume
  • Operation Id: Job_Resume
  • Default Api Version: 2019-06-01
  • Resource: AutomationJobResource
Stop(String, CancellationToken)

Stop the job identified by jobName.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobName}/stop
  • Operation Id: Job_Stop
  • Default Api Version: 2019-06-01
  • Resource: AutomationJobResource
StopAsync(String, CancellationToken)

Stop the job identified by jobName.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobName}/stop
  • Operation Id: Job_Stop
  • Default Api Version: 2019-06-01
  • Resource: AutomationJobResource
Suspend(String, CancellationToken)

Suspend the job identified by job name.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobName}/suspend
  • Operation Id: Job_Suspend
  • Default Api Version: 2019-06-01
  • Resource: AutomationJobResource
SuspendAsync(String, CancellationToken)

Suspend the job identified by job name.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobName}/suspend
  • Operation Id: Job_Suspend
  • Default Api Version: 2019-06-01
  • Resource: AutomationJobResource
TryGetApiVersion(ResourceType, String)

Gets the api version override if it has been set for the current client options.

(Inherited from ArmResource)
Update(WaitUntil, AutomationJobCreateOrUpdateContent, String, CancellationToken)

Create a job of the runbook.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobName}
  • Operation Id: Job_Create
  • Default Api Version: 2019-06-01
  • Resource: AutomationJobResource
UpdateAsync(WaitUntil, AutomationJobCreateOrUpdateContent, String, CancellationToken)

Create a job of the runbook.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobs/{jobName}
  • Operation Id: Job_Create
  • Default Api Version: 2019-06-01
  • Resource: AutomationJobResource

Explicit Interface Implementations

Name Description
IJsonModel<AutomationJobData>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<AutomationJobData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<AutomationJobData>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<AutomationJobData>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<AutomationJobData>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Extension Methods

Name Description
GetAuthorizationRoleDefinition(ArmResource, ResourceIdentifier, CancellationToken)

Gets the role definition identified by roleDefinitionId at this resource scope.

GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken)

Gets the role definition identified by roleDefinitionId at this resource scope.

GetAuthorizationRoleDefinitions(ArmResource)

Gets a collection of AuthorizationRoleDefinitionCollection objects within the specified scope.

GetDenyAssignment(ArmResource, String, CancellationToken)

Get the specified deny assignment.

GetDenyAssignmentAsync(ArmResource, String, CancellationToken)

Get the specified deny assignment.

GetDenyAssignments(ArmResource)

Gets a collection of DenyAssignmentCollection objects within the specified scope.

GetLinkerResource(ArmResource, String, CancellationToken)

Returns Linker resource for a given name.

  • Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
  • Operation Id: Linker_Get
  • Default Api Version: 2022-05-01
  • Resource: LinkerResource
<item>MockingTo mock this method, please mock GetLinkerResource(String, CancellationToken) instead.</item>
GetLinkerResourceAsync(ArmResource, String, CancellationToken)

Returns Linker resource for a given name.

  • Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
  • Operation Id: Linker_Get
  • Default Api Version: 2022-05-01
  • Resource: LinkerResource
<item>MockingTo mock this method, please mock GetLinkerResourceAsync(String, CancellationToken) instead.</item>
GetLinkerResources(ArmResource)

Gets a collection of LinkerResources in the ArmResource. <item>MockingTo mock this method, please mock GetLinkerResources() instead.</item>

GetRoleAssignment(ArmResource, String, String, CancellationToken)

Get a role assignment by scope and name.

GetRoleAssignmentAsync(ArmResource, String, String, CancellationToken)

Get a role assignment by scope and name.

GetRoleAssignments(ArmResource)

Gets a collection of RoleAssignmentCollection objects within the specified scope.

GetRoleAssignmentSchedule(ArmResource, String, CancellationToken)

Get the specified role assignment schedule for a resource scope.

GetRoleAssignmentScheduleAsync(ArmResource, String, CancellationToken)

Get the specified role assignment schedule for a resource scope.

GetRoleAssignmentScheduleInstance(ArmResource, String, CancellationToken)

Gets the specified role assignment schedule instance.

GetRoleAssignmentScheduleInstanceAsync(ArmResource, String, CancellationToken)

Gets the specified role assignment schedule instance.

GetRoleAssignmentScheduleInstances(ArmResource)

Gets a collection of RoleAssignmentScheduleInstanceCollection objects within the specified scope.

GetRoleAssignmentScheduleRequest(ArmResource, String, CancellationToken)

Get the specified role assignment schedule request.

GetRoleAssignmentScheduleRequestAsync(ArmResource, String, CancellationToken)

Get the specified role assignment schedule request.

GetRoleAssignmentScheduleRequests(ArmResource)

Gets a collection of RoleAssignmentScheduleRequestCollection objects within the specified scope.

GetRoleAssignmentSchedules(ArmResource)

Gets a collection of RoleAssignmentScheduleCollection objects within the specified scope.

GetRoleEligibilitySchedule(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule for a resource scope.

GetRoleEligibilityScheduleAsync(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule for a resource scope.

GetRoleEligibilityScheduleInstance(ArmResource, String, CancellationToken)

Gets the specified role eligibility schedule instance.

GetRoleEligibilityScheduleInstanceAsync(ArmResource, String, CancellationToken)

Gets the specified role eligibility schedule instance.

GetRoleEligibilityScheduleInstances(ArmResource)

Gets a collection of RoleEligibilityScheduleInstanceCollection objects within the specified scope.

GetRoleEligibilityScheduleRequest(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule request.

GetRoleEligibilityScheduleRequestAsync(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule request.

GetRoleEligibilityScheduleRequests(ArmResource)

Gets a collection of RoleEligibilityScheduleRequestCollection objects within the specified scope.

GetRoleEligibilitySchedules(ArmResource)

Gets a collection of RoleEligibilityScheduleCollection objects within the specified scope.

GetRoleManagementPolicies(ArmResource)

Gets a collection of RoleManagementPolicyCollection objects within the specified scope.

GetRoleManagementPolicy(ArmResource, String, CancellationToken)

Get the specified role management policy for a resource scope.

GetRoleManagementPolicyAssignment(ArmResource, String, CancellationToken)

Get the specified role management policy assignment for a resource scope.

GetRoleManagementPolicyAssignmentAsync(ArmResource, String, CancellationToken)

Get the specified role management policy assignment for a resource scope.

GetRoleManagementPolicyAssignments(ArmResource)

Gets a collection of RoleManagementPolicyAssignmentCollection objects within the specified scope.

GetRoleManagementPolicyAsync(ArmResource, String, CancellationToken)

Get the specified role management policy for a resource scope.

GetSystemAssignedIdentity(ArmResource)

Gets an object representing a SystemAssignedIdentityResource along with the instance operations that can be performed on it in the ArmResource scope.

Applies to