AutomationAccountResource Class

Definition

Namespace:: Azure.ResourceManager.Automation

Assembly:: Azure.ResourceManager.Automation.dll

Package:: Azure.ResourceManager.Automation v1.1.2

Package:: Azure.ResourceManager.Automation v1.1.0-beta.1

Source:: AutomationAccountResource.cs

Source:: AutomationAccountResource.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public class AutomationAccountResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Automation.AutomationAccountData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Automation.AutomationAccountData>

public class AutomationAccountResource : Azure.ResourceManager.ArmResource

type AutomationAccountResource = class
    inherit ArmResource
    interface IJsonModel<AutomationAccountData>
    interface IPersistableModel<AutomationAccountData>

type AutomationAccountResource = class
    inherit ArmResource

Public Class AutomationAccountResource
Inherits ArmResource
Implements IJsonModel(Of AutomationAccountData), IPersistableModel(Of AutomationAccountData)

Public Class AutomationAccountResource
Inherits ArmResource

Inheritance: Object

ArmResource
AutomationAccountResource

Implements: IJsonModel<AutomationAccountData> IPersistableModel<AutomationAccountData> IPersistableModel<T>

Constructors

Name	Description
AutomationAccountResource()	Initializes a new instance of the AutomationAccountResource 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
AddTag(String, String, CancellationToken)	Add a tag to the current resource. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName} Operation Id: AutomationAccount_Get Default Api Version: 2021-06-22 Resource: AutomationAccountResource
AddTagAsync(String, String, CancellationToken)	Add a tag to the current resource. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName} Operation Id: AutomationAccount_Get Default Api Version: 2021-06-22 Resource: AutomationAccountResource
AutomationPrivateLinkResources(CancellationToken)	Gets the private link resources that need to be created for Automation account. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/privateLinkResources Operation Id: PrivateLinkResources_Automation Default Api Version: 2020-01-13-preview
AutomationPrivateLinkResourcesAsync(CancellationToken)	Gets the private link resources that need to be created for Automation account. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/privateLinkResources Operation Id: PrivateLinkResources_Automation Default Api Version: 2020-01-13-preview
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)
ConvertGraphRunbookContent(GraphicalRunbookContent, CancellationToken)	Post operation to serialize or deserialize GraphRunbookContent Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/convertGraphRunbookContent Operation Id: ConvertGraphRunbookContent Default Api Version: 2021-06-22
ConvertGraphRunbookContentAsync(GraphicalRunbookContent, CancellationToken)	Post operation to serialize or deserialize GraphRunbookContent Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/convertGraphRunbookContent Operation Id: ConvertGraphRunbookContent Default Api Version: 2021-06-22
CreateResourceIdentifier(String, String, String)	Generate the resource identifier of a AutomationAccountResource instance.
Delete(WaitUntil, CancellationToken)	Delete an automation account. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName} Operation Id: AutomationAccount_Delete Default Api Version: 2021-06-22 Resource: AutomationAccountResource
DeleteAsync(WaitUntil, CancellationToken)	Delete an automation account. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName} Operation Id: AutomationAccount_Delete Default Api Version: 2021-06-22 Resource: AutomationAccountResource
GenerateUriWebhook(CancellationToken)	Generates a Uri for use in creating a webhook. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/webhooks/generateUri Operation Id: Webhook_GenerateUri Default Api Version: 2015-10-31 Resource: AutomationWebhookResource
GenerateUriWebhookAsync(CancellationToken)	Generates a Uri for use in creating a webhook. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/webhooks/generateUri Operation Id: Webhook_GenerateUri Default Api Version: 2015-10-31 Resource: AutomationWebhookResource
Get(CancellationToken)	Get information about an Automation Account. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName} Operation Id: AutomationAccount_Get Default Api Version: 2021-06-22 Resource: AutomationAccountResource
GetAgentRegistrationInformation(CancellationToken)	Retrieve the automation agent registration information. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/agentRegistrationInformation Operation Id: AgentRegistrationInformation_Get Default Api Version: 2020-01-13-preview
GetAgentRegistrationInformationAsync(CancellationToken)	Retrieve the automation agent registration information. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/agentRegistrationInformation Operation Id: AgentRegistrationInformation_Get Default Api Version: 2020-01-13-preview
GetAllNodeCountInformation(AutomationCountType, CancellationToken)	Retrieve counts for Dsc Nodes. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/nodecounts/{countType} Operation Id: NodeCountInformation_Get Default Api Version: 2020-01-13-preview
GetAllNodeCountInformationAsync(AutomationCountType, CancellationToken)	Retrieve counts for Dsc Nodes. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/nodecounts/{countType} Operation Id: NodeCountInformation_Get Default Api Version: 2020-01-13-preview
GetAsync(CancellationToken)	Get information about an Automation Account. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName} Operation Id: AutomationAccount_Get Default Api Version: 2021-06-22 Resource: AutomationAccountResource
GetAutomationAccountKeys(CancellationToken)	Retrieve the automation keys for an account. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/listKeys Operation Id: Keys_ListByAutomationAccount Default Api Version: 2021-06-22
GetAutomationAccountKeysAsync(CancellationToken)	Retrieve the automation keys for an account. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/listKeys Operation Id: Keys_ListByAutomationAccount Default Api Version: 2021-06-22
GetAutomationAccountModule(String, CancellationToken)	Retrieve the module identified by module name. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/modules/{moduleName} Operation Id: Module_Get Default Api Version: 2020-01-13-preview Resource: AutomationAccountModuleResource
GetAutomationAccountModuleAsync(String, CancellationToken)	Retrieve the module identified by module name. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/modules/{moduleName} Operation Id: Module_Get Default Api Version: 2020-01-13-preview Resource: AutomationAccountModuleResource
GetAutomationAccountModules()	Gets a collection of AutomationAccountModuleResources in the AutomationAccount.
GetAutomationAccountPython2Package(String, CancellationToken)	Retrieve the python 2 package identified by package name. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/python2Packages/{packageName} Operation Id: Python2Package_Get Default Api Version: 2020-01-13-preview Resource: AutomationAccountPython2PackageResource
GetAutomationAccountPython2PackageAsync(String, CancellationToken)	Retrieve the python 2 package identified by package name. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/python2Packages/{packageName} Operation Id: Python2Package_Get Default Api Version: 2020-01-13-preview Resource: AutomationAccountPython2PackageResource
GetAutomationAccountPython2Packages()	Gets a collection of AutomationAccountPython2PackageResources in the AutomationAccount.
GetAutomationCertificate(String, CancellationToken)	Retrieve the certificate identified by certificate name. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/certificates/{certificateName} Operation Id: Certificate_Get Default Api Version: 2020-01-13-preview Resource: AutomationCertificateResource
GetAutomationCertificateAsync(String, CancellationToken)	Retrieve the certificate identified by certificate name. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/certificates/{certificateName} Operation Id: Certificate_Get Default Api Version: 2020-01-13-preview Resource: AutomationCertificateResource
GetAutomationCertificates()	Gets a collection of AutomationCertificateResources in the AutomationAccount.
GetAutomationConnection(String, CancellationToken)	Retrieve the connection identified by connection name. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/connections/{connectionName} Operation Id: Connection_Get Default Api Version: 2020-01-13-preview Resource: AutomationConnectionResource
GetAutomationConnectionAsync(String, CancellationToken)	Retrieve the connection identified by connection name. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/connections/{connectionName} Operation Id: Connection_Get Default Api Version: 2020-01-13-preview Resource: AutomationConnectionResource
GetAutomationConnections()	Gets a collection of AutomationConnectionResources in the AutomationAccount.
GetAutomationConnectionType(String, CancellationToken)	Retrieve the connection type identified by connection type name. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/connectionTypes/{connectionTypeName} Operation Id: ConnectionType_Get Default Api Version: 2020-01-13-preview Resource: AutomationConnectionTypeResource
GetAutomationConnectionTypeAsync(String, CancellationToken)	Retrieve the connection type identified by connection type name. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/connectionTypes/{connectionTypeName} Operation Id: ConnectionType_Get Default Api Version: 2020-01-13-preview Resource: AutomationConnectionTypeResource
GetAutomationConnectionTypes()	Gets a collection of AutomationConnectionTypeResources in the AutomationAccount.
GetAutomationCredential(String, CancellationToken)	Retrieve the credential identified by credential name. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/credentials/{credentialName} Operation Id: Credential_Get Default Api Version: 2020-01-13-preview Resource: AutomationCredentialResource
GetAutomationCredentialAsync(String, CancellationToken)	Retrieve the credential identified by credential name. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/credentials/{credentialName} Operation Id: Credential_Get Default Api Version: 2020-01-13-preview Resource: AutomationCredentialResource
GetAutomationCredentials()	Gets a collection of AutomationCredentialResources in the AutomationAccount.
GetAutomationJob(String, 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
GetAutomationJobAsync(String, 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
GetAutomationJobs()	Gets a collection of AutomationJobResources in the AutomationAccount.
GetAutomationJobSchedule(Guid, CancellationToken)	Retrieve the job schedule identified by job schedule name. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobSchedules/{jobScheduleId} Operation Id: JobSchedule_Get Default Api Version: 2020-01-13-preview Resource: AutomationJobScheduleResource
GetAutomationJobScheduleAsync(Guid, CancellationToken)	Retrieve the job schedule identified by job schedule name. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobSchedules/{jobScheduleId} Operation Id: JobSchedule_Get Default Api Version: 2020-01-13-preview Resource: AutomationJobScheduleResource
GetAutomationJobSchedules()	Gets a collection of AutomationJobScheduleResources in the AutomationAccount.
GetAutomationPrivateEndpointConnection(String, CancellationToken)	Gets a private endpoint connection. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/privateEndpointConnections/{privateEndpointConnectionName} Operation Id: PrivateEndpointConnections_Get Default Api Version: 2020-01-13-preview Resource: AutomationPrivateEndpointConnectionResource
GetAutomationPrivateEndpointConnectionAsync(String, CancellationToken)	Gets a private endpoint connection. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/privateEndpointConnections/{privateEndpointConnectionName} Operation Id: PrivateEndpointConnections_Get Default Api Version: 2020-01-13-preview Resource: AutomationPrivateEndpointConnectionResource
GetAutomationPrivateEndpointConnections()	Gets a collection of AutomationPrivateEndpointConnectionResources in the AutomationAccount.
GetAutomationRunbook(String, CancellationToken)	Retrieve the runbook identified by runbook name. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName} Operation Id: Runbook_Get Default Api Version: 2018-06-30 Resource: AutomationRunbookResource
GetAutomationRunbookAsync(String, CancellationToken)	Retrieve the runbook identified by runbook name. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName} Operation Id: Runbook_Get Default Api Version: 2018-06-30 Resource: AutomationRunbookResource
GetAutomationRunbooks()	Gets a collection of AutomationRunbookResources in the AutomationAccount.
GetAutomationSchedule(String, CancellationToken)	Retrieve the schedule identified by schedule name. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/schedules/{scheduleName} Operation Id: Schedule_Get Default Api Version: 2020-01-13-preview Resource: AutomationScheduleResource
GetAutomationScheduleAsync(String, CancellationToken)	Retrieve the schedule identified by schedule name. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/schedules/{scheduleName} Operation Id: Schedule_Get Default Api Version: 2020-01-13-preview Resource: AutomationScheduleResource
GetAutomationSchedules()	Gets a collection of AutomationScheduleResources in the AutomationAccount.
GetAutomationSourceControl(String, CancellationToken)	Retrieve the source control identified by source control name. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/sourceControls/{sourceControlName} Operation Id: SourceControl_Get Default Api Version: 2020-01-13-preview Resource: AutomationSourceControlResource
GetAutomationSourceControlAsync(String, CancellationToken)	Retrieve the source control identified by source control name. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/sourceControls/{sourceControlName} Operation Id: SourceControl_Get Default Api Version: 2020-01-13-preview Resource: AutomationSourceControlResource
GetAutomationSourceControls()	Gets a collection of AutomationSourceControlResources in the AutomationAccount.
GetAutomationVariable(String, CancellationToken)	Retrieve the variable identified by variable name. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/variables/{variableName} Operation Id: Variable_Get Default Api Version: 2020-01-13-preview Resource: AutomationVariableResource
GetAutomationVariableAsync(String, CancellationToken)	Retrieve the variable identified by variable name. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/variables/{variableName} Operation Id: Variable_Get Default Api Version: 2020-01-13-preview Resource: AutomationVariableResource
GetAutomationVariables()	Gets a collection of AutomationVariableResources in the AutomationAccount.
GetAutomationWatcher(String, CancellationToken)	Retrieve the watcher identified by watcher name. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/watchers/{watcherName} Operation Id: Watcher_Get Default Api Version: 2020-01-13-preview Resource: AutomationWatcherResource
GetAutomationWatcherAsync(String, CancellationToken)	Retrieve the watcher identified by watcher name. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/watchers/{watcherName} Operation Id: Watcher_Get Default Api Version: 2020-01-13-preview Resource: AutomationWatcherResource
GetAutomationWatchers()	Gets a collection of AutomationWatcherResources in the AutomationAccount.
GetAutomationWebhook(String, CancellationToken)	Retrieve the webhook identified by webhook name. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/webhooks/{webhookName} Operation Id: Webhook_Get Default Api Version: 2015-10-31 Resource: AutomationWebhookResource
GetAutomationWebhookAsync(String, CancellationToken)	Retrieve the webhook identified by webhook name. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/webhooks/{webhookName} Operation Id: Webhook_Get Default Api Version: 2015-10-31 Resource: AutomationWebhookResource
GetAutomationWebhooks()	Gets a collection of AutomationWebhookResources in the AutomationAccount.
GetAvailableLocations(CancellationToken)	Lists all available geo-locations. (Inherited from ArmResource)
GetAvailableLocationsAsync(CancellationToken)	Lists all available geo-locations. (Inherited from ArmResource)
GetDscCompilationJob(String, CancellationToken)	Retrieve the Dsc configuration compilation job identified by job id. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/compilationjobs/{compilationJobName} Operation Id: DscCompilationJob_Get Default Api Version: 2020-01-13-preview Resource: DscCompilationJobResource
GetDscCompilationJobAsync(String, CancellationToken)	Retrieve the Dsc configuration compilation job identified by job id. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/compilationjobs/{compilationJobName} Operation Id: DscCompilationJob_Get Default Api Version: 2020-01-13-preview Resource: DscCompilationJobResource
GetDscCompilationJobs()	Gets a collection of DscCompilationJobResources in the AutomationAccount.
GetDscCompilationJobStreams(Guid, CancellationToken)	Retrieve all the job streams for the compilation Job. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/compilationjobs/{jobId}/streams Operation Id: DscCompilationJobStream_ListByJob Default Api Version: 2020-01-13-preview
GetDscCompilationJobStreamsAsync(Guid, CancellationToken)	Retrieve all the job streams for the compilation Job. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/compilationjobs/{jobId}/streams Operation Id: DscCompilationJobStream_ListByJob Default Api Version: 2020-01-13-preview
GetDscConfiguration(String, CancellationToken)	Retrieve the configuration identified by configuration name. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/configurations/{configurationName} Operation Id: DscConfiguration_Get Default Api Version: 2019-06-01 Resource: DscConfigurationResource
GetDscConfigurationAsync(String, CancellationToken)	Retrieve the configuration identified by configuration name. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/configurations/{configurationName} Operation Id: DscConfiguration_Get Default Api Version: 2019-06-01 Resource: DscConfigurationResource
GetDscConfigurations()	Gets a collection of DscConfigurationResources in the AutomationAccount.
GetDscNode(String, CancellationToken)	Retrieve the dsc node identified by node id. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/nodes/{nodeId} Operation Id: DscNode_Get Default Api Version: 2020-01-13-preview Resource: DscNodeResource
GetDscNodeAsync(String, CancellationToken)	Retrieve the dsc node identified by node id. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/nodes/{nodeId} Operation Id: DscNode_Get Default Api Version: 2020-01-13-preview Resource: DscNodeResource
GetDscNodeConfiguration(String, CancellationToken)	Retrieve the Dsc node configurations by node configuration. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/nodeConfigurations/{nodeConfigurationName} Operation Id: DscNodeConfiguration_Get Default Api Version: 2020-01-13-preview Resource: DscNodeConfigurationResource
GetDscNodeConfigurationAsync(String, CancellationToken)	Retrieve the Dsc node configurations by node configuration. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/nodeConfigurations/{nodeConfigurationName} Operation Id: DscNodeConfiguration_Get Default Api Version: 2020-01-13-preview Resource: DscNodeConfigurationResource
GetDscNodeConfigurations()	Gets a collection of DscNodeConfigurationResources in the AutomationAccount.
GetDscNodes()	Gets a collection of DscNodeResources in the AutomationAccount.
GetFieldsByType(String, CancellationToken)	Retrieve a list of fields of a given type across all accessible modules. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/objectDataTypes/{typeName}/fields Operation Id: ObjectDataTypes_ListFieldsByType Default Api Version: 2020-01-13-preview
GetFieldsByTypeAsync(String, CancellationToken)	Retrieve a list of fields of a given type across all accessible modules. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/objectDataTypes/{typeName}/fields Operation Id: ObjectDataTypes_ListFieldsByType Default Api Version: 2020-01-13-preview
GetHybridRunbookWorkerGroup(String, CancellationToken)	Retrieve a hybrid runbook worker group. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/hybridRunbookWorkerGroups/{hybridRunbookWorkerGroupName} Operation Id: HybridRunbookWorkerGroup_Get Default Api Version: 2022-02-22 Resource: HybridRunbookWorkerGroupResource
GetHybridRunbookWorkerGroupAsync(String, CancellationToken)	Retrieve a hybrid runbook worker group. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/hybridRunbookWorkerGroups/{hybridRunbookWorkerGroupName} Operation Id: HybridRunbookWorkerGroup_Get Default Api Version: 2022-02-22 Resource: HybridRunbookWorkerGroupResource
GetHybridRunbookWorkerGroups()	Gets a collection of HybridRunbookWorkerGroupResources in the AutomationAccount.
GetLinkedWorkspace(CancellationToken)	Retrieve the linked workspace for the account id. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/linkedWorkspace Operation Id: LinkedWorkspace_Get Default Api Version: 2020-01-13-preview
GetLinkedWorkspaceAsync(CancellationToken)	Retrieve the linked workspace for the account id. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/linkedWorkspace Operation Id: LinkedWorkspace_Get Default Api Version: 2020-01-13-preview
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)
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)
GetSoftwareUpdateConfiguration(String, String, CancellationToken)	Get a single software update configuration by name. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/softwareUpdateConfigurations/{softwareUpdateConfigurationName} Operation Id: SoftwareUpdateConfigurations_GetByName Default Api Version: 2019-06-01 Resource: SoftwareUpdateConfigurationResource
GetSoftwareUpdateConfigurationAsync(String, String, CancellationToken)	Get a single software update configuration by name. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/softwareUpdateConfigurations/{softwareUpdateConfigurationName} Operation Id: SoftwareUpdateConfigurations_GetByName Default Api Version: 2019-06-01 Resource: SoftwareUpdateConfigurationResource
GetSoftwareUpdateConfigurationMachineRun(Guid, String, CancellationToken)	Get a single software update configuration machine run by Id. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/softwareUpdateConfigurationMachineRuns/{softwareUpdateConfigurationMachineRunId} Operation Id: SoftwareUpdateConfigurationMachineRuns_GetById Default Api Version: 2019-06-01
GetSoftwareUpdateConfigurationMachineRunAsync(Guid, String, CancellationToken)	Get a single software update configuration machine run by Id. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/softwareUpdateConfigurationMachineRuns/{softwareUpdateConfigurationMachineRunId} Operation Id: SoftwareUpdateConfigurationMachineRuns_GetById Default Api Version: 2019-06-01
GetSoftwareUpdateConfigurationMachineRuns(String, String, String, String, CancellationToken)	Return list of software update configuration machine runs Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/softwareUpdateConfigurationMachineRuns Operation Id: SoftwareUpdateConfigurationMachineRuns_List Default Api Version: 2019-06-01
GetSoftwareUpdateConfigurationMachineRunsAsync(String, String, String, String, CancellationToken)	Return list of software update configuration machine runs Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/softwareUpdateConfigurationMachineRuns Operation Id: SoftwareUpdateConfigurationMachineRuns_List Default Api Version: 2019-06-01
GetSoftwareUpdateConfigurationRun(Guid, String, CancellationToken)	Get a single software update configuration Run by Id. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/softwareUpdateConfigurationRuns/{softwareUpdateConfigurationRunId} Operation Id: SoftwareUpdateConfigurationRuns_GetById Default Api Version: 2019-06-01
GetSoftwareUpdateConfigurationRunAsync(Guid, String, CancellationToken)	Get a single software update configuration Run by Id. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/softwareUpdateConfigurationRuns/{softwareUpdateConfigurationRunId} Operation Id: SoftwareUpdateConfigurationRuns_GetById Default Api Version: 2019-06-01
GetSoftwareUpdateConfigurationRuns(String, String, String, String, CancellationToken)	Return list of software update configuration runs Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/softwareUpdateConfigurationRuns Operation Id: SoftwareUpdateConfigurationRuns_List Default Api Version: 2019-06-01
GetSoftwareUpdateConfigurationRunsAsync(String, String, String, String, CancellationToken)	Return list of software update configuration runs Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/softwareUpdateConfigurationRuns Operation Id: SoftwareUpdateConfigurationRuns_List Default Api Version: 2019-06-01
GetSoftwareUpdateConfigurations()	Gets a collection of SoftwareUpdateConfigurationResources in the AutomationAccount.
GetStatistics(String, CancellationToken)	Retrieve the statistics for the account. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/statistics Operation Id: Statistics_ListByAutomationAccount Default Api Version: 2021-06-22
GetStatisticsAsync(String, CancellationToken)	Retrieve the statistics for the account. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/statistics Operation Id: Statistics_ListByAutomationAccount Default Api Version: 2021-06-22
GetStreamDscCompilationJob(Guid, String, CancellationToken)	Retrieve the job stream identified by job stream id. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/compilationjobs/{jobId}/streams/{jobStreamId} Operation Id: DscCompilationJob_GetStream Default Api Version: 2020-01-13-preview Resource: DscCompilationJobResource
GetStreamDscCompilationJobAsync(Guid, String, CancellationToken)	Retrieve the job stream identified by job stream id. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/compilationjobs/{jobId}/streams/{jobStreamId} Operation Id: DscCompilationJob_GetStream Default Api Version: 2020-01-13-preview Resource: DscCompilationJobResource
GetTagResource()	Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource. (Inherited from ArmResource)
GetUsages(CancellationToken)	Retrieve the usage for the account id. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/usages Operation Id: Usages_ListByAutomationAccount Default Api Version: 2021-06-22
GetUsagesAsync(CancellationToken)	Retrieve the usage for the account id. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/usages Operation Id: Usages_ListByAutomationAccount Default Api Version: 2021-06-22
RegenerateKeyAgentRegistrationInformation(AgentRegistrationRegenerateKeyContent, CancellationToken)	Regenerate a primary or secondary agent registration key Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/agentRegistrationInformation/regenerateKey Operation Id: AgentRegistrationInformation_RegenerateKey Default Api Version: 2020-01-13-preview
RegenerateKeyAgentRegistrationInformationAsync(AgentRegistrationRegenerateKeyContent, CancellationToken)	Regenerate a primary or secondary agent registration key Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/agentRegistrationInformation/regenerateKey Operation Id: AgentRegistrationInformation_RegenerateKey Default Api Version: 2020-01-13-preview
RemoveTag(String, CancellationToken)	Removes a tag by key from the resource. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName} Operation Id: AutomationAccount_Get Default Api Version: 2021-06-22 Resource: AutomationAccountResource
RemoveTagAsync(String, CancellationToken)	Removes a tag by key from the resource. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName} Operation Id: AutomationAccount_Get Default Api Version: 2021-06-22 Resource: AutomationAccountResource
SetTags(IDictionary<String,String>, CancellationToken)	Replace the tags on the resource with the given set. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName} Operation Id: AutomationAccount_Get Default Api Version: 2021-06-22 Resource: AutomationAccountResource
SetTagsAsync(IDictionary<String,String>, CancellationToken)	Replace the tags on the resource with the given set. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName} Operation Id: AutomationAccount_Get Default Api Version: 2021-06-22 Resource: AutomationAccountResource
TryGetApiVersion(ResourceType, String)	Gets the api version override if it has been set for the current client options. (Inherited from ArmResource)
Update(AutomationAccountPatch, CancellationToken)	Update an automation account. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName} Operation Id: AutomationAccount_Update Default Api Version: 2021-06-22 Resource: AutomationAccountResource
UpdateAsync(AutomationAccountPatch, CancellationToken)	Update an automation account. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName} Operation Id: AutomationAccount_Update Default Api Version: 2021-06-22 Resource: AutomationAccountResource

Explicit Interface Implementations

Name	Description
IJsonModel<AutomationAccountData>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<AutomationAccountData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<AutomationAccountData>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<AutomationAccountData>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<AutomationAccountData>.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

Feedback

Was this page helpful?