Share via


AutomationAccountResource Class

Definition

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
type AutomationAccountResource = class
    inherit ArmResource
Public Class AutomationAccountResource
Inherits ArmResource
Inheritance
AutomationAccountResource

Constructors

AutomationAccountResource()

Initializes a new instance of the AutomationAccountResource class for mocking.

Fields

ResourceType

Gets the resource type for the operations.

Properties

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

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
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
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
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
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
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
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
DeleteAsync(WaitUntil, CancellationToken)

Delete an automation account.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}
  • Operation Id: AutomationAccount_Delete
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
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
Get(CancellationToken)

Get information about an Automation Account.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}
  • Operation Id: AutomationAccount_Get
GetAgentRegistrationInformation(CancellationToken)

Retrieve the automation agent registration information.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/agentRegistrationInformation
  • Operation Id: AgentRegistrationInformation_Get
GetAgentRegistrationInformationAsync(CancellationToken)

Retrieve the automation agent registration information.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/agentRegistrationInformation
  • Operation Id: AgentRegistrationInformation_Get
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
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
GetAsync(CancellationToken)

Get information about an Automation Account.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}
  • Operation Id: AutomationAccount_Get
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
UpdateAsync(AutomationAccountPatch, CancellationToken)

Update an automation account.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}
  • Operation Id: AutomationAccount_Update

Extension Methods

GetAuthorizationRoleDefinition(ArmResource, ResourceIdentifier, CancellationToken)

Get role definition by name (GUID).

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId}
  • Operation Id: RoleDefinitions_Get
  • Default Api Version: 2022-04-01
  • Resource: AuthorizationRoleDefinitionResource
GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken)

Get role definition by name (GUID).

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId}
  • Operation Id: RoleDefinitions_Get
  • Default Api Version: 2022-04-01
  • Resource: AuthorizationRoleDefinitionResource
GetAuthorizationRoleDefinitions(ArmResource)

Gets a collection of AuthorizationRoleDefinitionResources in the ArmResource. MockingTo mock this method, please mock GetAuthorizationRoleDefinitions() instead.

GetDenyAssignment(ArmResource, String, CancellationToken)

Get the specified deny assignment.

  • Request Path: /{scope}/providers/Microsoft.Authorization/denyAssignments/{denyAssignmentId}
  • Operation Id: DenyAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: DenyAssignmentResource
GetDenyAssignmentAsync(ArmResource, String, CancellationToken)

Get the specified deny assignment.

  • Request Path: /{scope}/providers/Microsoft.Authorization/denyAssignments/{denyAssignmentId}
  • Operation Id: DenyAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: DenyAssignmentResource
GetDenyAssignments(ArmResource)

Gets a collection of DenyAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetDenyAssignments() instead.

GetRoleAssignment(ArmResource, String, String, CancellationToken)

Get a role assignment by scope and name.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}
  • Operation Id: RoleAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: RoleAssignmentResource
GetRoleAssignmentAsync(ArmResource, String, String, CancellationToken)

Get a role assignment by scope and name.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}
  • Operation Id: RoleAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: RoleAssignmentResource
GetRoleAssignments(ArmResource)

Gets a collection of RoleAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignments() instead.

GetRoleAssignmentSchedule(ArmResource, String, CancellationToken)

Get the specified role assignment schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentSchedules/{roleAssignmentScheduleName}
  • Operation Id: RoleAssignmentSchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleResource
GetRoleAssignmentScheduleAsync(ArmResource, String, CancellationToken)

Get the specified role assignment schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentSchedules/{roleAssignmentScheduleName}
  • Operation Id: RoleAssignmentSchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleResource
GetRoleAssignmentScheduleInstance(ArmResource, String, CancellationToken)

Gets the specified role assignment schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleInstances/{roleAssignmentScheduleInstanceName}
  • Operation Id: RoleAssignmentScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleInstanceResource
GetRoleAssignmentScheduleInstanceAsync(ArmResource, String, CancellationToken)

Gets the specified role assignment schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleInstances/{roleAssignmentScheduleInstanceName}
  • Operation Id: RoleAssignmentScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleInstanceResource
GetRoleAssignmentScheduleInstances(ArmResource)

Gets a collection of RoleAssignmentScheduleInstanceResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentScheduleInstances() instead.

GetRoleAssignmentScheduleRequest(ArmResource, String, CancellationToken)

Get the specified role assignment schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleRequests/{roleAssignmentScheduleRequestName}
  • Operation Id: RoleAssignmentScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleRequestResource
GetRoleAssignmentScheduleRequestAsync(ArmResource, String, CancellationToken)

Get the specified role assignment schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleRequests/{roleAssignmentScheduleRequestName}
  • Operation Id: RoleAssignmentScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleRequestResource
GetRoleAssignmentScheduleRequests(ArmResource)

Gets a collection of RoleAssignmentScheduleRequestResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentScheduleRequests() instead.

GetRoleAssignmentSchedules(ArmResource)

Gets a collection of RoleAssignmentScheduleResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentSchedules() instead.

GetRoleEligibilitySchedule(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilitySchedules/{roleEligibilityScheduleName}
  • Operation Id: RoleEligibilitySchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleResource
GetRoleEligibilityScheduleAsync(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilitySchedules/{roleEligibilityScheduleName}
  • Operation Id: RoleEligibilitySchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleResource
GetRoleEligibilityScheduleInstance(ArmResource, String, CancellationToken)

Gets the specified role eligibility schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleInstances/{roleEligibilityScheduleInstanceName}
  • Operation Id: RoleEligibilityScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleInstanceResource
GetRoleEligibilityScheduleInstanceAsync(ArmResource, String, CancellationToken)

Gets the specified role eligibility schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleInstances/{roleEligibilityScheduleInstanceName}
  • Operation Id: RoleEligibilityScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleInstanceResource
GetRoleEligibilityScheduleInstances(ArmResource)

Gets a collection of RoleEligibilityScheduleInstanceResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilityScheduleInstances() instead.

GetRoleEligibilityScheduleRequest(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleRequests/{roleEligibilityScheduleRequestName}
  • Operation Id: RoleEligibilityScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleRequestResource
GetRoleEligibilityScheduleRequestAsync(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleRequests/{roleEligibilityScheduleRequestName}
  • Operation Id: RoleEligibilityScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleRequestResource
GetRoleEligibilityScheduleRequests(ArmResource)

Gets a collection of RoleEligibilityScheduleRequestResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilityScheduleRequests() instead.

GetRoleEligibilitySchedules(ArmResource)

Gets a collection of RoleEligibilityScheduleResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilitySchedules() instead.

GetRoleManagementPolicies(ArmResource)

Gets a collection of RoleManagementPolicyResources in the ArmResource. MockingTo mock this method, please mock GetRoleManagementPolicies() instead.

GetRoleManagementPolicy(ArmResource, String, CancellationToken)

Get the specified role management policy for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicies/{roleManagementPolicyName}
  • Operation Id: RoleManagementPolicies_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyResource
GetRoleManagementPolicyAssignment(ArmResource, String, CancellationToken)

Get the specified role management policy assignment for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicyAssignments/{roleManagementPolicyAssignmentName}
  • Operation Id: RoleManagementPolicyAssignments_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyAssignmentResource
GetRoleManagementPolicyAssignmentAsync(ArmResource, String, CancellationToken)

Get the specified role management policy assignment for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicyAssignments/{roleManagementPolicyAssignmentName}
  • Operation Id: RoleManagementPolicyAssignments_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyAssignmentResource
GetRoleManagementPolicyAssignments(ArmResource)

Gets a collection of RoleManagementPolicyAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetRoleManagementPolicyAssignments() instead.

GetRoleManagementPolicyAsync(ArmResource, String, CancellationToken)

Get the specified role management policy for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicies/{roleManagementPolicyName}
  • Operation Id: RoleManagementPolicies_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyResource
GetSystemAssignedIdentity(ArmResource)

Gets an object representing a SystemAssignedIdentityResource along with the instance operations that can be performed on it in the ArmResource. MockingTo mock this method, please mock GetSystemAssignedIdentity() instead.

GetLinkerResource(ArmResource, String, CancellationToken)

Returns Linker resource for a given name.

  • Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
  • Operation Id: Linker_Get
GetLinkerResourceAsync(ArmResource, String, CancellationToken)

Returns Linker resource for a given name.

  • Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
  • Operation Id: Linker_Get
GetLinkerResources(ArmResource)

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

Applies to