@azure/arm-automation package

Classes

AutomationClient

Interfaces

Activity	Definition of the activity.
ActivityOperationsGetOptionalParams	Optional parameters.
ActivityOperationsListByModuleOptionalParams	Optional parameters.
ActivityOperationsOperations	Interface representing a ActivityOperations operations.
ActivityOutputType	Definition of the activity output type.
ActivityParameter	Definition of the activity parameter.
ActivityParameterSet	Definition of the activity parameter set.
ActivityParameterValidationSet	Definition of the activity parameter validation set.
ActivityProperties	Properties of the activity.
AdvancedSchedule	The properties of the create Advanced Schedule.
AdvancedScheduleMonthlyOccurrence	The properties of the create advanced schedule monthly occurrence.
AgentRegistration	Definition of the agent registration information type.
AgentRegistrationInformationGetOptionalParams	Optional parameters.
AgentRegistrationInformationOperations	Interface representing a AgentRegistrationInformation operations.
AgentRegistrationInformationRegenerateKeyOptionalParams	Optional parameters.
AgentRegistrationKeys	Definition of the agent registration keys.
AgentRegistrationRegenerateKeyParameter	The parameters supplied to the regenerate keys operation.
AutomationAccount	Definition of the automation account type.
AutomationAccountCreateOrUpdateParameters	The parameters supplied to the create or update automation account operation.
AutomationAccountCreateOrUpdateProperties	The parameters supplied to the create or update account properties.
AutomationAccountOperationsCreateOrUpdateOptionalParams	Optional parameters.
AutomationAccountOperationsDeleteOptionalParams	Optional parameters.
AutomationAccountOperationsGetOptionalParams	Optional parameters.
AutomationAccountOperationsListByResourceGroupOptionalParams	Optional parameters.
AutomationAccountOperationsListDeletedRunbooksOptionalParams	Optional parameters.
AutomationAccountOperationsListOptionalParams	Optional parameters.
AutomationAccountOperationsOperations	Interface representing a AutomationAccountOperations operations.
AutomationAccountOperationsUpdateOptionalParams	Optional parameters.
AutomationAccountProperties	Definition of the account property.
AutomationAccountUpdateParameters	The parameters supplied to the update automation account operation.
AutomationAccountUpdateProperties	The parameters supplied to the update account properties.
AutomationClientOptionalParams	Optional parameters for the client.
AutomationErrorResponse	Error response of an operation failure
AzureQueryProperties	Azure query for the update configuration.
Certificate	Definition of the certificate.
CertificateCreateOrUpdateParameters	The parameters supplied to the create or update or replace certificate operation.
CertificateCreateOrUpdateProperties	The properties of the create certificate operation.
CertificateOperationsCreateOrUpdateOptionalParams	Optional parameters.
CertificateOperationsDeleteOptionalParams	Optional parameters.
CertificateOperationsGetOptionalParams	Optional parameters.
CertificateOperationsListByAutomationAccountOptionalParams	Optional parameters.
CertificateOperationsOperations	Interface representing a CertificateOperations operations.
CertificateOperationsUpdateOptionalParams	Optional parameters.
CertificateProperties	Properties of the certificate.
CertificateUpdateParameters	The parameters supplied to the update certificate operation.
CertificateUpdateProperties	The properties of the update certificate operation
ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties	model interface ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties
Connection	Definition of the connection.
ConnectionCreateOrUpdateParameters	The parameters supplied to the create or update connection operation.
ConnectionCreateOrUpdateProperties	The properties of the create connection properties
ConnectionOperationsCreateOrUpdateOptionalParams	Optional parameters.
ConnectionOperationsDeleteOptionalParams	Optional parameters.
ConnectionOperationsGetOptionalParams	Optional parameters.
ConnectionOperationsListByAutomationAccountOptionalParams	Optional parameters.
ConnectionOperationsOperations	Interface representing a ConnectionOperations operations.
ConnectionOperationsUpdateOptionalParams	Optional parameters.
ConnectionProperties	Definition of the connection properties.
ConnectionType	Definition of the connection type.
ConnectionTypeAssociationProperty	The connection type property associated with the entity.
ConnectionTypeCreateOrUpdateParameters	The parameters supplied to the create or update connection type operation.
ConnectionTypeCreateOrUpdateProperties	The properties of the create connection type.
ConnectionTypeOperationsCreateOrUpdateOptionalParams	Optional parameters.
ConnectionTypeOperationsDeleteOptionalParams	Optional parameters.
ConnectionTypeOperationsGetOptionalParams	Optional parameters.
ConnectionTypeOperationsListByAutomationAccountOptionalParams	Optional parameters.
ConnectionTypeOperationsOperations	Interface representing a ConnectionTypeOperations operations.
ConnectionTypeProperties	Properties of the connection type.
ConnectionUpdateParameters	The parameters supplied to the update connection operation.
ConnectionUpdateProperties	The properties of the update connection operation.
ContentHash	Definition of the runbook property type.
ContentLink	Definition of the content link.
ContentSource	Definition of the content source.
ConvertGraphRunbookContentOptionalParams	Optional parameters.
Credential	Definition of the credential.
CredentialCreateOrUpdateParameters	The parameters supplied to the create or update credential operation.
CredentialCreateOrUpdateProperties	The properties of the create credential operation.
CredentialOperationsCreateOrUpdateOptionalParams	Optional parameters.
CredentialOperationsDeleteOptionalParams	Optional parameters.
CredentialOperationsGetOptionalParams	Optional parameters.
CredentialOperationsListByAutomationAccountOptionalParams	Optional parameters.
CredentialOperationsOperations	Interface representing a CredentialOperations operations.
CredentialOperationsUpdateOptionalParams	Optional parameters.
CredentialProperties	Definition of the credential properties
CredentialUpdateParameters	The parameters supplied to the Update credential operation.
CredentialUpdateProperties	The properties of the Update credential
DeletedAutomationAccount	Definition of the deleted automation account type.
DeletedAutomationAccountListResult	The response model for the list deleted automation account.
DeletedAutomationAccountProperties	Definition of the deleted automation account properties.
DeletedAutomationAccountsListBySubscriptionOptionalParams	Optional parameters.
DeletedAutomationAccountsOperations	Interface representing a DeletedAutomationAccounts operations.
DeletedRunbook	Definition of deleted runbook.
DeletedRunbookProperties	Definition of the deleted runbook property.
Dimension	Dimension of the metric.
DscConfiguration	Definition of the configuration type.
DscConfigurationAssociationProperty	The Dsc configuration property associated with the entity.
DscConfigurationCreateOrUpdateParameters	The parameters supplied to the create or update configuration operation.
DscConfigurationCreateOrUpdateProperties	The properties to create or update configuration.
DscConfigurationOperationsCreateOrUpdateOptionalParams	Optional parameters.
DscConfigurationOperationsDeleteOptionalParams	Optional parameters.
DscConfigurationOperationsGetContentOptionalParams	Optional parameters.
DscConfigurationOperationsGetOptionalParams	Optional parameters.
DscConfigurationOperationsListByAutomationAccountOptionalParams	Optional parameters.
DscConfigurationOperationsOperations	Interface representing a DscConfigurationOperations operations.
DscConfigurationOperationsUpdateOptionalParams	Optional parameters.
DscConfigurationParameter	Definition of the configuration parameter type.
DscConfigurationProperties	Definition of the configuration property type.
DscConfigurationUpdateParameters	The parameters supplied to the create or update configuration operation.
DscMetaConfiguration	Definition of the DSC Meta Configuration.
DscNode	Definition of a DscNode
DscNodeConfiguration	Definition of the dsc node configuration.
DscNodeConfigurationAssociationProperty	The dsc node configuration property associated with the entity.
DscNodeConfigurationCreateOrUpdateParameters	The parameters supplied to the create or update node configuration operation.
DscNodeConfigurationCreateOrUpdateParametersProperties	The parameter properties supplied to the create or update node configuration operation.
DscNodeConfigurationListByAutomationAccountOptionalParams	Optional parameters.
DscNodeConfigurationOperations	Interface representing a DscNodeConfiguration operations.
DscNodeConfigurationOperationsCreateOrUpdateOptionalParams	Optional parameters.
DscNodeConfigurationOperationsDeleteOptionalParams	Optional parameters.
DscNodeConfigurationOperationsGetOptionalParams	Optional parameters.
DscNodeConfigurationOperationsOperations	Interface representing a DscNodeConfigurationOperations operations.
DscNodeConfigurationProperties	Properties for the DscNodeConfiguration
DscNodeExtensionHandlerAssociationProperty	The dsc extensionHandler property associated with the node
DscNodeOperationsDeleteOptionalParams	Optional parameters.
DscNodeOperationsGetOptionalParams	Optional parameters.
DscNodeOperationsListByAutomationAccountOptionalParams	Optional parameters.
DscNodeOperationsOperations	Interface representing a DscNodeOperations operations.
DscNodeOperationsUpdateOptionalParams	Optional parameters.
DscNodeProperties	The properties of a DscNode
DscNodeReport	Definition of the dsc node report type.
DscNodeUpdateParameters	The parameters supplied to the update dsc node operation.
DscNodeUpdateParametersProperties	model interface DscNodeUpdateParametersProperties
DscReportError	Definition of the dsc node report error type.
DscReportResource	Definition of the DSC Report Resource.
DscReportResourceNavigation	Navigation for DSC Report Resource.
EncryptionProperties	The encryption settings for automation account
EncryptionPropertiesIdentity	User identity used for CMK.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations.
FieldDefinition	Definition of the connection fields.
FieldsListByTypeOptionalParams	Optional parameters.
FieldsOperations	Interface representing a Fields operations.
GraphicalRunbookContent	Graphical Runbook Content
HybridRunbookWorker	Definition of hybrid runbook worker.
HybridRunbookWorkerCreateOrUpdateParameters	The parameters supplied to the create or update hybrid runbook worker operation.
HybridRunbookWorkerCreateParameters	The parameters supplied to the create hybrid runbook worker operation.
HybridRunbookWorkerGroup	Definition of hybrid runbook worker group.
HybridRunbookWorkerGroupCreateOrUpdateParameters	The parameters supplied to the create hybrid runbook worker group operation.
HybridRunbookWorkerGroupCreateOrUpdateProperties	The hybrid runbook worker group properties.
HybridRunbookWorkerGroupOperationsCreateOptionalParams	Optional parameters.
HybridRunbookWorkerGroupOperationsDeleteOptionalParams	Optional parameters.
HybridRunbookWorkerGroupOperationsGetOptionalParams	Optional parameters.
HybridRunbookWorkerGroupOperationsListByAutomationAccountOptionalParams	Optional parameters.
HybridRunbookWorkerGroupOperationsOperations	Interface representing a HybridRunbookWorkerGroupOperations operations.
HybridRunbookWorkerGroupOperationsUpdateOptionalParams	Optional parameters.
HybridRunbookWorkerGroupProperties	Definition of hybrid runbook worker group property.
HybridRunbookWorkerMoveParameters	Parameters supplied to move hybrid worker operation.
HybridRunbookWorkerProperties	Definition of hybrid runbook worker property.
HybridRunbookWorkersCreateOptionalParams	Optional parameters.
HybridRunbookWorkersDeleteOptionalParams	Optional parameters.
HybridRunbookWorkersGetOptionalParams	Optional parameters.
HybridRunbookWorkersListByHybridRunbookWorkerGroupOptionalParams	Optional parameters.
HybridRunbookWorkersMoveOptionalParams	Optional parameters.
HybridRunbookWorkersOperations	Interface representing a HybridRunbookWorkers operations.
HybridRunbookWorkersPatchOptionalParams	Optional parameters.
Identity	Identity for the resource.
Job	Definition of the job.
JobCollectionItem	Job collection item properties.
JobCollectionItemProperties	Job collection item properties.
JobCreateParameters	The parameters supplied to the create job operation.
JobCreateProperties	model interface JobCreateProperties
JobNavigation	Software update configuration machine run job navigation properties.
JobOperationsCreateOptionalParams	Optional parameters.
JobOperationsGetOptionalParams	Optional parameters.
JobOperationsGetOutputOptionalParams	Optional parameters.
JobOperationsGetRunbookContentOptionalParams	Optional parameters.
JobOperationsListByAutomationAccountOptionalParams	Optional parameters.
JobOperationsOperations	Interface representing a JobOperations operations.
JobOperationsResumeOptionalParams	Optional parameters.
JobOperationsStopOptionalParams	Optional parameters.
JobOperationsSuspendOptionalParams	Optional parameters.
JobProperties	Definition of job properties.
JobRuntimeEnvironment	The runbook property associated with the entity.
JobSchedule	Definition of the job schedule.
JobScheduleCreateParameters	The parameters supplied to the create job schedule operation.
JobScheduleCreateProperties	The parameters supplied to the create job schedule operation.
JobScheduleOperationsCreateOptionalParams	Optional parameters.
JobScheduleOperationsDeleteOptionalParams	Optional parameters.
JobScheduleOperationsGetOptionalParams	Optional parameters.
JobScheduleOperationsListByAutomationAccountOptionalParams	Optional parameters.
JobScheduleOperationsOperations	Interface representing a JobScheduleOperations operations.
JobScheduleProperties	Definition of job schedule parameters.
JobStream	Definition of the job stream.
JobStreamOperationsGetOptionalParams	Optional parameters.
JobStreamOperationsListByJobOptionalParams	Optional parameters.
JobStreamOperationsOperations	Interface representing a JobStreamOperations operations.
JobStreamProperties	Definition of the job stream.
Key	Automation key which is used to register a DSC Node
KeyListResult	model interface KeyListResult
KeyVaultProperties	Settings concerning key vault encryption for a configuration store.
KeysListByAutomationAccountOptionalParams	Optional parameters.
KeysOperations	Interface representing a Keys operations.
LinkedWorkspace	Definition of the linked workspace.
LinkedWorkspaceOperationsGetOptionalParams	Optional parameters.
LinkedWorkspaceOperationsOperations	Interface representing a LinkedWorkspaceOperations operations.
LinuxProperties	Linux specific update configuration.
LogSpecification	Description of logging specification.
MetricSpecification	Description of metrics specification.
Module	Definition of the module type.
ModuleCreateOrUpdateParameters	The parameters supplied to the create or update module operation.
ModuleCreateOrUpdateProperties	The parameters supplied to the create or update module properties.
ModuleErrorInfo	Definition of the module error info type.
ModuleOperationsCreateOrUpdateOptionalParams	Optional parameters.
ModuleOperationsDeleteOptionalParams	Optional parameters.
ModuleOperationsGetOptionalParams	Optional parameters.
ModuleOperationsListByAutomationAccountOptionalParams	Optional parameters.
ModuleOperationsOperations	Interface representing a ModuleOperations operations.
ModuleOperationsUpdateOptionalParams	Optional parameters.
ModuleProperties	Definition of the module property type.
ModuleUpdateParameters	The parameters supplied to the update module operation.
ModuleUpdateProperties	The parameters supplied to the update properties.
NodeCount	Number of nodes based on the Filter
NodeCountInformationGetOptionalParams	Optional parameters.
NodeCountInformationOperations	Interface representing a NodeCountInformation operations.
NodeCountProperties	model interface NodeCountProperties
NodeCounts	Gets the count of nodes by count type
NodeReportsGetContentOptionalParams	Optional parameters.
NodeReportsGetOptionalParams	Optional parameters.
NodeReportsListByNodeOptionalParams	Optional parameters.
NodeReportsOperations	Interface representing a NodeReports operations.
NonAzureQueryProperties	Non Azure query for the update configuration.
ObjectDataTypesListFieldsByModuleAndTypeOptionalParams	Optional parameters.
ObjectDataTypesListFieldsByTypeOptionalParams	Optional parameters.
ObjectDataTypesOperations	Interface representing a ObjectDataTypes operations.
Operation	Automation REST API operation
OperationDisplay	Provider, Resource and Operation values
OperationPropertiesFormat	Description of operation properties format.
OperationPropertiesFormatServiceSpecification	Specification of the service.
OperationsListOptionalParams	Optional parameters.
OperationsOperations	Interface representing a Operations operations.
Package	Definition of the Package type.
PackageCreateOrUpdateOptionalParams	Optional parameters.
PackageCreateOrUpdateParameters	The parameters supplied to the create or update package operation.
PackageCreateOrUpdateProperties	The parameters supplied to the create or update package properties.
PackageDeleteOptionalParams	Optional parameters.
PackageErrorInfo	Definition of the package error info type.
PackageGetOptionalParams	Optional parameters.
PackageListByRuntimeEnvironmentOptionalParams	Optional parameters.
PackageOperations	Interface representing a Package operations.
PackageProperties	Definition of the package property type.
PackageUpdateOptionalParams	Optional parameters.
PackageUpdateParameters	The parameters supplied to the update package operation.
PackageUpdateProperties	The parameters supplied to the update properties.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
PrivateEndpointConnection	A private endpoint connection
PrivateEndpointConnectionProperties	Properties of a private endpoint connection.
PrivateEndpointConnectionsCreateOrUpdateOptionalParams	Optional parameters.
PrivateEndpointConnectionsDeleteOptionalParams	Optional parameters.
PrivateEndpointConnectionsGetOptionalParams	Optional parameters.
PrivateEndpointConnectionsListByAutomationAccountOptionalParams	Optional parameters.
PrivateEndpointConnectionsOperations	Interface representing a PrivateEndpointConnections operations.
PrivateEndpointProperty	Private endpoint which the connection belongs to.
PrivateLinkResource	A private link resource
PrivateLinkResourceProperties	Properties of a private link resource.
PrivateLinkResourcesListAutomationOptionalParams	Optional parameters.
PrivateLinkResourcesOperations	Interface representing a PrivateLinkResources operations.
PrivateLinkServiceConnectionStateProperty	Connection State of the Private Endpoint Connection.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
Python2PackageCreateOrUpdateOptionalParams	Optional parameters.
Python2PackageDeleteOptionalParams	Optional parameters.
Python2PackageGetOptionalParams	Optional parameters.
Python2PackageListByAutomationAccountOptionalParams	Optional parameters.
Python2PackageOperations	Interface representing a Python2Package operations.
Python2PackageUpdateOptionalParams	Optional parameters.
Python3PackageCreateOrUpdateOptionalParams	Optional parameters.
Python3PackageDeleteOptionalParams	Optional parameters.
Python3PackageGetOptionalParams	Optional parameters.
Python3PackageListByAutomationAccountOptionalParams	Optional parameters.
Python3PackageOperations	Interface representing a Python3Package operations.
Python3PackageUpdateOptionalParams	Optional parameters.
PythonPackageCreateParameters	The parameters supplied to the create or update module operation.
PythonPackageCreateProperties	The parameters supplied to the create or update module properties.
PythonPackageUpdateParameters	The parameters supplied to the update module operation.
RawGraphicalRunbookContent	Raw Graphical Runbook content
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
RestorePollerOptions
RunAsCredentialAssociationProperty	Definition of RunAs credential to use for hybrid worker.
Runbook	Definition of the runbook type.
RunbookAssociationProperty	The runbook property associated with the entity.
RunbookCreateOrUpdateParameters	The parameters supplied to the create or update runbook operation.
RunbookCreateOrUpdateProperties	The parameters supplied to the create or update runbook properties.
RunbookDraft	model interface RunbookDraft
RunbookDraftOperationsGetContentOptionalParams	Optional parameters.
RunbookDraftOperationsGetOptionalParams	Optional parameters.
RunbookDraftOperationsOperations	Interface representing a RunbookDraftOperations operations.
RunbookDraftOperationsReplaceContentOptionalParams	Optional parameters.
RunbookDraftOperationsUndoEditOptionalParams	Optional parameters.
RunbookDraftUndoEditResult	The response model for the undo edit runbook operation.
RunbookGetContentOptionalParams	Optional parameters.
RunbookOperations	Interface representing a Runbook operations.
RunbookOperationsCreateOrUpdateOptionalParams	Optional parameters.
RunbookOperationsDeleteOptionalParams	Optional parameters.
RunbookOperationsGetOptionalParams	Optional parameters.
RunbookOperationsListByAutomationAccountOptionalParams	Optional parameters.
RunbookOperationsOperations	Interface representing a RunbookOperations operations.
RunbookOperationsUpdateOptionalParams	Optional parameters.
RunbookParameter	Definition of the runbook parameter type.
RunbookProperties	Definition of the runbook property type.
RunbookPublishOptionalParams	Optional parameters.
RunbookUpdateParameters	The parameters supplied to the update runbook operation.
RunbookUpdateProperties	The parameters supplied to the update runbook properties.
RuntimeEnvironment	Definition of the Runtime Environment type.
RuntimeEnvironmentProperties	Runtime Environment properties.
RuntimeEnvironmentUpdateParameters	The parameters supplied to the update automation account operation.
RuntimeEnvironmentUpdateProperties	Gets or sets Runtime update properties.
RuntimeEnvironmentsCreateOptionalParams	Optional parameters.
RuntimeEnvironmentsDeleteOptionalParams	Optional parameters.
RuntimeEnvironmentsGetOptionalParams	Optional parameters.
RuntimeEnvironmentsListByAutomationAccountOptionalParams	Optional parameters.
RuntimeEnvironmentsOperations	Interface representing a RuntimeEnvironments operations.
RuntimeEnvironmentsUpdateOptionalParams	Optional parameters.
RuntimeProperties	Runtime properties.
SUCScheduleProperties	Definition of schedule parameters.
Schedule	Definition of the schedule.
ScheduleAssociationProperty	The schedule property associated with the entity.
ScheduleCreateOrUpdateParameters	The parameters supplied to the create or update schedule operation.
ScheduleCreateOrUpdateProperties	The parameters supplied to the create or update schedule operation.
ScheduleOperationsCreateOrUpdateOptionalParams	Optional parameters.
ScheduleOperationsDeleteOptionalParams	Optional parameters.
ScheduleOperationsGetOptionalParams	Optional parameters.
ScheduleOperationsListByAutomationAccountOptionalParams	Optional parameters.
ScheduleOperationsOperations	Interface representing a ScheduleOperations operations.
ScheduleOperationsUpdateOptionalParams	Optional parameters.
ScheduleProperties	Definition of schedule parameters.
ScheduleUpdateParameters	The parameters supplied to the update schedule operation.
ScheduleUpdateProperties	The parameters supplied to the update schedule operation.
SimplePollerLike	A simple poller that can be used to poll a long running operation.
Sku	The account SKU.
SoftwareUpdateConfiguration	Software update configuration properties.
SoftwareUpdateConfigurationCollectionItem	Software update configuration collection item properties.
SoftwareUpdateConfigurationCollectionItemProperties	Software update configuration collection item properties.
SoftwareUpdateConfigurationListResult	result of listing all software update configuration
SoftwareUpdateConfigurationMachineRun	Software update configuration machine run model.
SoftwareUpdateConfigurationMachineRunListResult	result of listing all software update configuration machine runs
SoftwareUpdateConfigurationMachineRunsGetByIdOptionalParams	Optional parameters.
SoftwareUpdateConfigurationMachineRunsListOptionalParams	Optional parameters.
SoftwareUpdateConfigurationMachineRunsOperations	Interface representing a SoftwareUpdateConfigurationMachineRuns operations.
SoftwareUpdateConfigurationProperties	Software update configuration properties.
SoftwareUpdateConfigurationRun	Software update configuration Run properties.
SoftwareUpdateConfigurationRunListResult	result of listing all software update configuration runs
SoftwareUpdateConfigurationRunProperties	Software update configuration properties.
SoftwareUpdateConfigurationRunTaskProperties	Task properties of the software update configuration.
SoftwareUpdateConfigurationRunTasks	Software update configuration run tasks model.
SoftwareUpdateConfigurationRunsGetByIdOptionalParams	Optional parameters.
SoftwareUpdateConfigurationRunsListOptionalParams	Optional parameters.
SoftwareUpdateConfigurationRunsOperations	Interface representing a SoftwareUpdateConfigurationRuns operations.
SoftwareUpdateConfigurationTasks	Task properties of the software update configuration.
SoftwareUpdateConfigurationsCreateOptionalParams	Optional parameters.
SoftwareUpdateConfigurationsDeleteOptionalParams	Optional parameters.
SoftwareUpdateConfigurationsGetByNameOptionalParams	Optional parameters.
SoftwareUpdateConfigurationsListOptionalParams	Optional parameters.
SoftwareUpdateConfigurationsOperations	Interface representing a SoftwareUpdateConfigurations operations.
SourceControl	Definition of the source control.
SourceControlCreateOrUpdateParameters	The parameters supplied to the create or update source control operation.
SourceControlCreateOrUpdateProperties	The properties of the create source control operation.
SourceControlOperationsCreateOrUpdateOptionalParams	Optional parameters.
SourceControlOperationsDeleteOptionalParams	Optional parameters.
SourceControlOperationsGetOptionalParams	Optional parameters.
SourceControlOperationsListByAutomationAccountOptionalParams	Optional parameters.
SourceControlOperationsOperations	Interface representing a SourceControlOperations operations.
SourceControlOperationsUpdateOptionalParams	Optional parameters.
SourceControlProperties	Definition of the source control properties
SourceControlSecurityTokenProperties	model interface SourceControlSecurityTokenProperties
SourceControlSyncJob	Definition of the source control sync job.
SourceControlSyncJobById	Definition of the source control sync job.
SourceControlSyncJobByIdProperties	Definition of source control sync job properties.
SourceControlSyncJobCreateParameters	The parameters supplied to the create source control sync job operation.
SourceControlSyncJobCreateProperties	Definition of create source control sync job properties.
SourceControlSyncJobOperationsCreateOptionalParams	Optional parameters.
SourceControlSyncJobOperationsGetOptionalParams	Optional parameters.
SourceControlSyncJobOperationsListByAutomationAccountOptionalParams	Optional parameters.
SourceControlSyncJobOperationsOperations	Interface representing a SourceControlSyncJobOperations operations.
SourceControlSyncJobProperties	Definition of source control sync job properties.
SourceControlSyncJobStream	Definition of the source control sync job stream.
SourceControlSyncJobStreamById	Definition of the source control sync job stream by id.
SourceControlSyncJobStreamByIdProperties	Definition of source control sync job stream by id properties.
SourceControlSyncJobStreamProperties	Definition of source control sync job stream properties.
SourceControlSyncJobStreamsGetOptionalParams	Optional parameters.
SourceControlSyncJobStreamsListBySyncJobOptionalParams	Optional parameters.
SourceControlSyncJobStreamsOperations	Interface representing a SourceControlSyncJobStreams operations.
SourceControlUpdateParameters	The parameters supplied to the update source control operation.
SourceControlUpdateProperties	The properties of the update source control
Statistics	Definition of the statistic.
StatisticsOperationsListByAutomationAccountOptionalParams	Optional parameters.
StatisticsOperationsOperations	Interface representing a StatisticsOperations operations.
SystemData	Metadata pertaining to creation and last modification of the resource.
TagSettingsProperties	Tag filter information for the VM.
TargetProperties	Group specific to the update configuration.
TaskProperties	Task properties of the software update configuration.
TestJob	Definition of the test job.
TestJobCreateParameters	The parameters supplied to the create test job operation.
TestJobOperationsCreateOptionalParams	Optional parameters.
TestJobOperationsGetOptionalParams	Optional parameters.
TestJobOperationsOperations	Interface representing a TestJobOperations operations.
TestJobOperationsResumeOptionalParams	Optional parameters.
TestJobOperationsStopOptionalParams	Optional parameters.
TestJobOperationsSuspendOptionalParams	Optional parameters.
TestJobStreamsGetOptionalParams	Optional parameters.
TestJobStreamsListByTestJobOptionalParams	Optional parameters.
TestJobStreamsOperations	Interface representing a TestJobStreams operations.
TrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
TypeField	Information about a field of a type.
UpdateConfiguration	Update specific properties of the software update configuration.
UpdateConfigurationMachineRunProperties	Software update configuration machine run properties.
UpdateConfigurationNavigation	Software update configuration Run Navigation model.
Usage	Definition of Usage.
UsageCounterName	Definition of usage counter name.
UsagesListByAutomationAccountOptionalParams	Optional parameters.
UsagesOperations	Interface representing a Usages operations.
Variable	Definition of the variable.
VariableCreateOrUpdateParameters	The parameters supplied to the create or update variable operation.
VariableCreateOrUpdateProperties	The properties of the create variable operation.
VariableOperationsCreateOrUpdateOptionalParams	Optional parameters.
VariableOperationsDeleteOptionalParams	Optional parameters.
VariableOperationsGetOptionalParams	Optional parameters.
VariableOperationsListByAutomationAccountOptionalParams	Optional parameters.
VariableOperationsOperations	Interface representing a VariableOperations operations.
VariableOperationsUpdateOptionalParams	Optional parameters.
VariableProperties	Definition of the variable properties
VariableUpdateParameters	The parameters supplied to the update variable operation.
VariableUpdateProperties	The properties of the update variable
Watcher	Definition of the watcher type.
WatcherOperationsCreateOrUpdateOptionalParams	Optional parameters.
WatcherOperationsDeleteOptionalParams	Optional parameters.
WatcherOperationsGetOptionalParams	Optional parameters.
WatcherOperationsListByAutomationAccountOptionalParams	Optional parameters.
WatcherOperationsOperations	Interface representing a WatcherOperations operations.
WatcherOperationsStartOptionalParams	Optional parameters.
WatcherOperationsStopOptionalParams	Optional parameters.
WatcherOperationsUpdateOptionalParams	Optional parameters.
WatcherProperties	Definition of the watcher properties
WatcherUpdateParameters	model interface WatcherUpdateParameters
WatcherUpdateProperties	The properties of the update watcher operation.
Webhook	Definition of the webhook type.
WebhookCreateOrUpdateParameters	The parameters supplied to the create or update webhook operation.
WebhookCreateOrUpdateProperties	The properties of the create webhook operation.
WebhookOperationsCreateOrUpdateOptionalParams	Optional parameters.
WebhookOperationsDeleteOptionalParams	Optional parameters.
WebhookOperationsGenerateUriOptionalParams	Optional parameters.
WebhookOperationsGetOptionalParams	Optional parameters.
WebhookOperationsListByAutomationAccountOptionalParams	Optional parameters.
WebhookOperationsOperations	Interface representing a WebhookOperations operations.
WebhookOperationsUpdateOptionalParams	Optional parameters.
WebhookProperties	Definition of the webhook properties
WebhookUpdateParameters	The parameters supplied to the update webhook operation.
WebhookUpdateProperties	The properties of the update webhook.
WindowsProperties	Windows specific update configuration.

Type Aliases

AgentRegistrationKeyName	Gets or sets the agent registration key name - primary or secondary. KnownAgentRegistrationKeyName can be used interchangeably with AgentRegistrationKeyName, this enum contains the known values that the service supports. Known values supported by the service primary: primary secondary: secondary
AutomationAccountState	Gets status of account. KnownAutomationAccountState can be used interchangeably with AutomationAccountState, this enum contains the known values that the service supports. Known values supported by the service Ok: Ok Unavailable: Unavailable Suspended: Suspended
AutomationKeyName	Automation key name. KnownAutomationKeyName can be used interchangeably with AutomationKeyName, this enum contains the known values that the service supports. Known values supported by the service Primary: Primary Secondary: Secondary
AutomationKeyPermissions	Automation key permissions. KnownAutomationKeyPermissions can be used interchangeably with AutomationKeyPermissions, this enum contains the known values that the service supports. Known values supported by the service Read: Read Full: Full
AzureSupportedClouds	The supported values for cloud setting as a string literal type
ContentSourceType	Gets or sets the content source type. KnownContentSourceType can be used interchangeably with ContentSourceType, this enum contains the known values that the service supports. Known values supported by the service embeddedContent: embeddedContent uri: uri
ContinuablePage	An interface that describes a page of results.
CountType	Type of CountType
CreatedByType	The kind of entity that created the resource. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User: The entity was created by a user. Application: The entity was created by an application. ManagedIdentity: The entity was created by a managed identity. Key: The entity was created by a key.
DscConfigurationOperationsGetContentResponse
DscConfigurationState	Gets or sets the state of the configuration. KnownDscConfigurationState can be used interchangeably with DscConfigurationState, this enum contains the known values that the service supports. Known values supported by the service New: New Edit: Edit Published: Published
EncryptionKeySourceType	Encryption Key Source
GraphRunbookType	Runbook Type KnownGraphRunbookType can be used interchangeably with GraphRunbookType, this enum contains the known values that the service supports. Known values supported by the service GraphPowerShell: GraphPowerShell GraphPowerShellWorkflow: GraphPowerShellWorkflow
GroupTypeEnum	Type of the HybridWorkerGroup. KnownGroupTypeEnum can be used interchangeably with GroupTypeEnum, this enum contains the known values that the service supports. Known values supported by the service User: User System: System
HttpStatusCode	Type of HttpStatusCode
JobOperationsGetOutputResponse
JobOperationsGetRunbookContentResponse
JobProvisioningState	The provisioning state of the resource. KnownJobProvisioningState can be used interchangeably with JobProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Failed: Failed Succeeded: Succeeded Suspended: Suspended Processing: Processing
JobStatus	Gets or sets the status of the job. KnownJobStatus can be used interchangeably with JobStatus, this enum contains the known values that the service supports. Known values supported by the service New: New Activating: Activating Running: Running Completed: Completed Failed: Failed Stopped: Stopped Blocked: Blocked Suspended: Suspended Disconnected: Disconnected Suspending: Suspending Stopping: Stopping Resuming: Resuming Removing: Removing
JobStreamType	Gets or sets the stream type. KnownJobStreamType can be used interchangeably with JobStreamType, this enum contains the known values that the service supports. Known values supported by the service Progress: Progress Output: Output Warning: Warning Error: Error Debug: Debug Verbose: Verbose Any: Any
LinuxUpdateClasses	Update classifications included in the software update configuration. KnownLinuxUpdateClasses can be used interchangeably with LinuxUpdateClasses, this enum contains the known values that the service supports. Known values supported by the service Unclassified: Unclassified Critical: Critical Security: Security Other: Other
ModuleProvisioningState	Gets or sets the provisioning state of the module. KnownModuleProvisioningState can be used interchangeably with ModuleProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Created: Created Creating: Creating StartingImportModuleRunbook: StartingImportModuleRunbook RunningImportModuleRunbook: RunningImportModuleRunbook ContentRetrieved: ContentRetrieved ContentDownloaded: ContentDownloaded ContentValidated: ContentValidated ConnectionTypeImported: ConnectionTypeImported ContentStored: ContentStored ModuleDataStored: ModuleDataStored ActivitiesStored: ActivitiesStored ModuleImportRunbookComplete: ModuleImportRunbookComplete Succeeded: Succeeded Failed: Failed Canceled: Canceled Updating: Updating
NodeReportsGetContentResponse
OperatingSystemType	Target operating system for the software update configuration.
PackageProvisioningState	Gets or sets the provisioning state of the Package. KnownPackageProvisioningState can be used interchangeably with PackageProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Created: Created Creating: Creating StartingImportModuleRunbook: StartingImportModuleRunbook RunningImportModuleRunbook: RunningImportModuleRunbook ContentRetrieved: ContentRetrieved ContentDownloaded: ContentDownloaded ContentValidated: ContentValidated ConnectionTypeImported: ConnectionTypeImported ContentStored: ContentStored ModuleDataStored: ModuleDataStored ActivitiesStored: ActivitiesStored ModuleImportRunbookComplete: ModuleImportRunbookComplete Succeeded: Succeeded Failed: Failed Canceled: Canceled Updating: Updating
ProvisioningState	The provisioning state of the job. KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Completed: Completed Failed: Failed Running: Running
ResourceIdentityType	The identity type.
RunbookDraftOperationsGetContentResponse
RunbookGetContentResponse
RunbookState	Gets or sets the state of the runbook. KnownRunbookState can be used interchangeably with RunbookState, this enum contains the known values that the service supports. Known values supported by the service New: New Edit: Edit Published: Published
RunbookTypeEnum	Gets or sets the type of the runbook. KnownRunbookTypeEnum can be used interchangeably with RunbookTypeEnum, this enum contains the known values that the service supports. Known values supported by the service Script: Script Graph: Graph PowerShellWorkflow: PowerShellWorkflow PowerShell: PowerShell GraphPowerShellWorkflow: GraphPowerShellWorkflow GraphPowerShell: GraphPowerShell Python2: Python2 Python3: Python3 Python: Python PowerShell72: PowerShell72
ScheduleDay	Day of the occurrence. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday. KnownScheduleDay can be used interchangeably with ScheduleDay, this enum contains the known values that the service supports. Known values supported by the service Monday: Monday Tuesday: Tuesday Wednesday: Wednesday Thursday: Thursday Friday: Friday Saturday: Saturday Sunday: Sunday
ScheduleFrequency	Gets or sets the frequency of the schedule. KnownScheduleFrequency can be used interchangeably with ScheduleFrequency, this enum contains the known values that the service supports. Known values supported by the service OneTime: OneTime Day: Day Hour: Hour Week: Week Month: Month Minute: The minimum allowed interval for Minute schedules is 15 minutes.
SkuNameEnum	Gets or sets the SKU name of the account. KnownSkuNameEnum can be used interchangeably with SkuNameEnum, this enum contains the known values that the service supports. Known values supported by the service Free: Free Basic: Basic
SourceType	The source type. Must be one of VsoGit, VsoTfvc, GitHub. KnownSourceType can be used interchangeably with SourceType, this enum contains the known values that the service supports. Known values supported by the service VsoGit: VsoGit VsoTfvc: VsoTfvc GitHub: GitHub
StreamType	The type of the sync job stream. KnownStreamType can be used interchangeably with StreamType, this enum contains the known values that the service supports. Known values supported by the service Error: Error Output: Output
SyncType	The sync type. KnownSyncType can be used interchangeably with SyncType, this enum contains the known values that the service supports. Known values supported by the service PartialSync: PartialSync FullSync: FullSync
TagOperators	Filter VMs by Any or All specified tags.
TokenType	The token type. Must be either PersonalAccessToken or Oauth. KnownTokenType can be used interchangeably with TokenType, this enum contains the known values that the service supports. Known values supported by the service PersonalAccessToken: PersonalAccessToken Oauth: Oauth
WebhookOperationsGenerateUriResponse
WindowsUpdateClasses	Update classification included in the software update configuration. A comma separated string with required values KnownWindowsUpdateClasses can be used interchangeably with WindowsUpdateClasses, this enum contains the known values that the service supports. Known values supported by the service Unclassified: Unclassified Critical: Critical Security: Security UpdateRollup: UpdateRollup FeaturePack: FeaturePack ServicePack: ServicePack Definition: Definition Tools: Tools Updates: Updates
WorkerType	Type of the HybridWorker. KnownWorkerType can be used interchangeably with WorkerType, this enum contains the known values that the service supports. Known values supported by the service HybridV1: HybridV1 HybridV2: HybridV2

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownAgentRegistrationKeyName	Gets or sets the agent registration key name - primary or secondary.
KnownAutomationAccountState	Gets status of account.
KnownAutomationKeyName	Automation key name.
KnownAutomationKeyPermissions	Automation key permissions.
KnownContentSourceType	Gets or sets the content source type.
KnownCountType	Known values of CountType that the service accepts.
KnownCreatedByType	The kind of entity that created the resource.
KnownDscConfigurationState	Gets or sets the state of the configuration.
KnownGraphRunbookType	Runbook Type
KnownGroupTypeEnum	Type of the HybridWorkerGroup.
KnownHttpStatusCode	Known values of HttpStatusCode that the service accepts.
KnownJobProvisioningState	The provisioning state of the resource.
KnownJobStatus	Gets or sets the status of the job.
KnownJobStreamType	Gets or sets the stream type.
KnownLinuxUpdateClasses	Update classifications included in the software update configuration.
KnownModuleProvisioningState	Gets or sets the provisioning state of the module.
KnownPackageProvisioningState	Gets or sets the provisioning state of the Package.
KnownProvisioningState	The provisioning state of the job.
KnownRunbookState	Gets or sets the state of the runbook.
KnownRunbookTypeEnum	Gets or sets the type of the runbook.
KnownScheduleDay	Day of the occurrence. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday.
KnownScheduleFrequency	Gets or sets the frequency of the schedule.
KnownSkuNameEnum	Gets or sets the SKU name of the account.
KnownSourceType	The source type. Must be one of VsoGit, VsoTfvc, GitHub.
KnownStreamType	The type of the sync job stream.
KnownSyncType	The sync type.
KnownTokenType	The token type. Must be either PersonalAccessToken or Oauth.
KnownVersions	The available API versions.
KnownWindowsUpdateClasses	Update classification included in the software update configuration. A comma separated string with required values
KnownWorkerType	Type of the HybridWorker.

Functions

isRestError(unknown)	Typeguard for RestError
restorePoller<TResponse, TResult>(AutomationClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Variables

RestError

A custom error type for failed pipeline requests.

Function Details

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e

Parameters

e

unknown

Something caught by a catch clause.

Returns

e

restorePoller<TResponse, TResult>(AutomationClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: AutomationClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client

AutomationClient

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>

Variable Details

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type

RestErrorConstructor