Share via

AutomationClient class

  • Reference
Package:
@azure/arm-automation
Extends
ServiceClient

Constructors

AutomationClient(TokenCredential, string, AutomationClientOptionalParams)

Initializes a new instance of the AutomationClient class.

Properties

$host
activityOperations
agentRegistrationInformation
automationAccountOperations
certificateOperations
connectionOperations
connectionTypeOperations
credentialOperations
deletedAutomationAccounts
dscCompilationJobOperations
dscCompilationJobStream
dscConfigurationOperations
dscNodeConfigurationOperations
dscNodeOperations
fields
hybridRunbookWorkerGroupOperations
hybridRunbookWorkers
jobOperations
jobScheduleOperations
jobStreamOperations
keys
linkedWorkspaceOperations
moduleOperations
nodeCountInformation
nodeReports
objectDataTypes
operations
privateEndpointConnections
privateLinkResources
python2Package
runbookDraftOperations
runbookOperations
scheduleOperations
softwareUpdateConfigurationMachineRuns
softwareUpdateConfigurationRuns
softwareUpdateConfigurations
sourceControlOperations
sourceControlSyncJobOperations
sourceControlSyncJobStreams
statisticsOperations
subscriptionId
testJobOperations
testJobStreams
usages
variableOperations
watcherOperations
webhookOperations

Inherited Properties

pipeline

The pipeline used by this client to make requests

Methods

convertGraphRunbookContent(string, string, GraphicalRunbookContent, ConvertGraphRunbookContentOptionalParams)

Post operation to serialize or deserialize GraphRunbookContent

Inherited Methods

sendOperationRequest<T>(OperationArguments, OperationSpec)

Send an HTTP request that is populated using the provided OperationSpec.
sendRequest(PipelineRequest)

Send the provided httpRequest.

Constructor Details

AutomationClient(TokenCredential, string, AutomationClientOptionalParams)

Initializes a new instance of the AutomationClient class.

new AutomationClient(credentials: TokenCredential, subscriptionId: string, options?: AutomationClientOptionalParams)

Parameters

credentials
TokenCredential

Subscription credentials which uniquely identify client subscription.

subscriptionId

string

Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

options
AutomationClientOptionalParams

The parameter options

Property Details

$host 

$host: string

Property Value

string

activityOperations 

activityOperations: ActivityOperations

Property Value

ActivityOperations

agentRegistrationInformation 

agentRegistrationInformation: AgentRegistrationInformation

Property Value

AgentRegistrationInformation

automationAccountOperations 

automationAccountOperations: AutomationAccountOperations

Property Value

AutomationAccountOperations

certificateOperations 

certificateOperations: CertificateOperations

Property Value

CertificateOperations

connectionOperations 

connectionOperations: ConnectionOperations

Property Value

ConnectionOperations

connectionTypeOperations 

connectionTypeOperations: ConnectionTypeOperations

Property Value

ConnectionTypeOperations

credentialOperations 

credentialOperations: CredentialOperations

Property Value

CredentialOperations

deletedAutomationAccounts 

deletedAutomationAccounts: DeletedAutomationAccounts

Property Value

DeletedAutomationAccounts

dscCompilationJobOperations 

dscCompilationJobOperations: DscCompilationJobOperations

Property Value

DscCompilationJobOperations

dscCompilationJobStream 

dscCompilationJobStream: DscCompilationJobStream

Property Value

DscCompilationJobStream

dscConfigurationOperations 

dscConfigurationOperations: DscConfigurationOperations

Property Value

DscConfigurationOperations

dscNodeConfigurationOperations 

dscNodeConfigurationOperations: DscNodeConfigurationOperations

Property Value

DscNodeConfigurationOperations

dscNodeOperations 

dscNodeOperations: DscNodeOperations

Property Value

DscNodeOperations

fields 

fields: Fields

Property Value

Fields

hybridRunbookWorkerGroupOperations 

hybridRunbookWorkerGroupOperations: HybridRunbookWorkerGroupOperations

Property Value

HybridRunbookWorkerGroupOperations

hybridRunbookWorkers 

hybridRunbookWorkers: HybridRunbookWorkers

Property Value

HybridRunbookWorkers

jobOperations 

jobOperations: JobOperations

Property Value

JobOperations

jobScheduleOperations 

jobScheduleOperations: JobScheduleOperations

Property Value

JobScheduleOperations

jobStreamOperations 

jobStreamOperations: JobStreamOperations

Property Value

JobStreamOperations

keys 

keys: Keys

Property Value

Keys

linkedWorkspaceOperations 

linkedWorkspaceOperations: LinkedWorkspaceOperations

Property Value

LinkedWorkspaceOperations

moduleOperations 

moduleOperations: ModuleOperations

Property Value

ModuleOperations

nodeCountInformation 

nodeCountInformation: NodeCountInformation

Property Value

NodeCountInformation

nodeReports 

nodeReports: NodeReports

Property Value

NodeReports

objectDataTypes 

objectDataTypes: ObjectDataTypes

Property Value

ObjectDataTypes

operations 

operations: Operations

Property Value

Operations

privateEndpointConnections 

privateEndpointConnections: PrivateEndpointConnections

Property Value

PrivateEndpointConnections

privateLinkResources 

privateLinkResources: PrivateLinkResources

Property Value

PrivateLinkResources

python2Package 

python2Package: Python2Package

Property Value

Python2Package

runbookDraftOperations 

runbookDraftOperations: RunbookDraftOperations

Property Value

RunbookDraftOperations

runbookOperations 

runbookOperations: RunbookOperations

Property Value

RunbookOperations

scheduleOperations 

scheduleOperations: ScheduleOperations

Property Value

ScheduleOperations

softwareUpdateConfigurationMachineRuns 

softwareUpdateConfigurationMachineRuns: SoftwareUpdateConfigurationMachineRuns

Property Value

SoftwareUpdateConfigurationMachineRuns

softwareUpdateConfigurationRuns 

softwareUpdateConfigurationRuns: SoftwareUpdateConfigurationRuns

Property Value

SoftwareUpdateConfigurationRuns

softwareUpdateConfigurations 

softwareUpdateConfigurations: SoftwareUpdateConfigurations

Property Value

SoftwareUpdateConfigurations

sourceControlOperations 

sourceControlOperations: SourceControlOperations

Property Value

SourceControlOperations

sourceControlSyncJobOperations 

sourceControlSyncJobOperations: SourceControlSyncJobOperations

Property Value

SourceControlSyncJobOperations

sourceControlSyncJobStreams 

sourceControlSyncJobStreams: SourceControlSyncJobStreams

Property Value

SourceControlSyncJobStreams

statisticsOperations 

statisticsOperations: StatisticsOperations

Property Value

StatisticsOperations

subscriptionId 

subscriptionId: string

Property Value

string

testJobOperations 

testJobOperations: TestJobOperations

Property Value

TestJobOperations

testJobStreams 

testJobStreams: TestJobStreams

Property Value

TestJobStreams

usages 

usages: Usages

Property Value

Usages

variableOperations 

variableOperations: VariableOperations

Property Value

VariableOperations

watcherOperations 

watcherOperations: WatcherOperations

Property Value

WatcherOperations

webhookOperations 

webhookOperations: WebhookOperations

Property Value

WebhookOperations

Inherited Property Details

pipeline

The pipeline used by this client to make requests

pipeline: Pipeline

Property Value

Pipeline

Inherited From coreClient.ServiceClient.pipeline

Method Details

convertGraphRunbookContent(string, string, GraphicalRunbookContent, ConvertGraphRunbookContentOptionalParams)

Post operation to serialize or deserialize GraphRunbookContent

function convertGraphRunbookContent(resourceGroupName: string, automationAccountName: string, parameters: GraphicalRunbookContent, options?: ConvertGraphRunbookContentOptionalParams): Promise<GraphicalRunbookContent>

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

parameters
GraphicalRunbookContent

Input data describing the graphical runbook.

options
ConvertGraphRunbookContentOptionalParams

The options parameters.

Returns

Promise<GraphicalRunbookContent>

Inherited Method Details

sendOperationRequest<T>(OperationArguments, OperationSpec)

Send an HTTP request that is populated using the provided OperationSpec.

function sendOperationRequest<T>(operationArguments: OperationArguments, operationSpec: OperationSpec): Promise<T>

Parameters

operationArguments
OperationArguments

The arguments that the HTTP request's templated values will be populated from.

operationSpec
OperationSpec

The OperationSpec to use to populate the httpRequest.

Returns

Promise<T>

Inherited From coreClient.ServiceClient.sendOperationRequest

sendRequest(PipelineRequest)

Send the provided httpRequest.

function sendRequest(request: PipelineRequest): Promise<PipelineResponse>

Parameters

request
PipelineRequest

Returns

Promise<PipelineResponse>

Inherited From coreClient.ServiceClient.sendRequest