Microsoft Azure SDK for Python¶
This is the Microsoft Azure Automation Client Library. This package has been tested with Python 3.8+. For a more complete view of Azure libraries, see the azure sdk python release.
Disclaimer¶
Azure SDK Python packages support for Python 2.7 has ended 01 January 2022. For more information and questions, please refer to https://github.com/Azure/azure-sdk-for-python/issues/20691
Getting started¶
Prerequisites¶
Python 3.8+ is required to use this package.
Install the package¶
pip install azure-mgmt-automation
pip install azure-identity
Authentication¶
By default, Azure Active Directory token authentication depends on correct configure of following environment variables.
AZURE_CLIENT_ID
for Azure client ID.AZURE_TENANT_ID
for Azure tenant ID.AZURE_CLIENT_SECRET
for Azure client secret.
In addition, Azure subscription ID can be configured via environment variable AZURE_SUBSCRIPTION_ID
.
With above configuration, client can be authenticated by following code:
from azure.identity import DefaultAzureCredential
from azure.mgmt.automation import AutomationClient
import os
sub_id = os.getenv("AZURE_SUBSCRIPTION_ID")
client = AutomationClient(credential=DefaultAzureCredential(), subscription_id=sub_id)
Examples¶
Code samples for this package can be found at:
Search Automation on docs.microsoft.com
Troubleshooting¶
Next steps¶
Provide Feedback¶
If you encounter any bugs or have suggestions, please file an issue in the Issues section of the project.
Indices and tables¶
Developer Documentation
- azure.mgmt.automation package
- Submodules
- azure.mgmt.automation.models module
Activity
ActivityListResult
ActivityOutputType
ActivityParameter
ActivityParameterSet
ActivityParameterValidationSet
AdvancedSchedule
AdvancedScheduleMonthlyOccurrence
AgentRegistration
AgentRegistrationKeyName
AgentRegistrationKeys
AgentRegistrationRegenerateKeyParameter
AutomationAccount
AutomationAccountCreateOrUpdateParameters
AutomationAccountListResult
AutomationAccountState
AutomationAccountUpdateParameters
AutomationKeyName
AutomationKeyPermissions
AzureQueryProperties
Certificate
CertificateCreateOrUpdateParameters
CertificateListResult
CertificateUpdateParameters
Connection
ConnectionCreateOrUpdateParameters
ConnectionListResult
ConnectionType
ConnectionTypeAssociationProperty
ConnectionTypeCreateOrUpdateParameters
ConnectionTypeListResult
ConnectionUpdateParameters
ContentHash
ContentLink
ContentSource
ContentSourceType
CountType
CreatedByType
Credential
CredentialCreateOrUpdateParameters
CredentialListResult
CredentialUpdateParameters
DeletedAutomationAccount
DeletedAutomationAccountListResult
Dimension
DscCompilationJob
DscCompilationJobCreateParameters
DscCompilationJobListResult
DscConfiguration
DscConfigurationAssociationProperty
DscConfigurationCreateOrUpdateParameters
DscConfigurationListResult
DscConfigurationParameter
DscConfigurationState
DscConfigurationUpdateParameters
DscMetaConfiguration
DscNode
DscNodeConfiguration
DscNodeConfigurationCreateOrUpdateParameters
DscNodeConfigurationListResult
DscNodeExtensionHandlerAssociationProperty
DscNodeListResult
DscNodeReport
DscNodeReportListResult
DscNodeUpdateParameters
DscNodeUpdateParametersProperties
DscReportError
DscReportResource
DscReportResourceNavigation
EncryptionKeySourceType
EncryptionProperties
EncryptionPropertiesIdentity
ErrorResponse
FieldDefinition
GraphRunbookType
GraphicalRunbookContent
GroupTypeEnum
HttpStatusCode
HttpStatusCode.ACCEPTED
HttpStatusCode.AMBIGUOUS
HttpStatusCode.BAD_GATEWAY
HttpStatusCode.BAD_REQUEST
HttpStatusCode.CONFLICT
HttpStatusCode.CONTINUE
HttpStatusCode.CONTINUE_ENUM
HttpStatusCode.CREATED
HttpStatusCode.EXPECTATION_FAILED
HttpStatusCode.FORBIDDEN
HttpStatusCode.FOUND
HttpStatusCode.GATEWAY_TIMEOUT
HttpStatusCode.GONE
HttpStatusCode.HTTP_VERSION_NOT_SUPPORTED
HttpStatusCode.INTERNAL_SERVER_ERROR
HttpStatusCode.LENGTH_REQUIRED
HttpStatusCode.METHOD_NOT_ALLOWED
HttpStatusCode.MOVED
HttpStatusCode.MOVED_PERMANENTLY
HttpStatusCode.MULTIPLE_CHOICES
HttpStatusCode.NON_AUTHORITATIVE_INFORMATION
HttpStatusCode.NOT_ACCEPTABLE
HttpStatusCode.NOT_FOUND
HttpStatusCode.NOT_IMPLEMENTED
HttpStatusCode.NOT_MODIFIED
HttpStatusCode.NO_CONTENT
HttpStatusCode.OK
HttpStatusCode.PARTIAL_CONTENT
HttpStatusCode.PAYMENT_REQUIRED
HttpStatusCode.PRECONDITION_FAILED
HttpStatusCode.PROXY_AUTHENTICATION_REQUIRED
HttpStatusCode.REDIRECT
HttpStatusCode.REDIRECT_KEEP_VERB
HttpStatusCode.REDIRECT_METHOD
HttpStatusCode.REQUESTED_RANGE_NOT_SATISFIABLE
HttpStatusCode.REQUEST_ENTITY_TOO_LARGE
HttpStatusCode.REQUEST_TIMEOUT
HttpStatusCode.REQUEST_URI_TOO_LONG
HttpStatusCode.RESET_CONTENT
HttpStatusCode.SEE_OTHER
HttpStatusCode.SERVICE_UNAVAILABLE
HttpStatusCode.SWITCHING_PROTOCOLS
HttpStatusCode.TEMPORARY_REDIRECT
HttpStatusCode.UNAUTHORIZED
HttpStatusCode.UNSUPPORTED_MEDIA_TYPE
HttpStatusCode.UNUSED
HttpStatusCode.UPGRADE_REQUIRED
HttpStatusCode.USE_PROXY
HybridRunbookWorker
HybridRunbookWorkerCreateParameters
HybridRunbookWorkerGroup
HybridRunbookWorkerGroupCreateOrUpdateParameters
HybridRunbookWorkerGroupsListResult
HybridRunbookWorkerMoveParameters
HybridRunbookWorkersListResult
Identity
Job
JobCollectionItem
JobCreateParameters
JobListResultV2
JobNavigation
JobProvisioningState
JobSchedule
JobScheduleCreateParameters
JobScheduleListResult
JobStatus
JobStream
JobStreamListResult
JobStreamType
Key
KeyListResult
KeyVaultProperties
LinkedWorkspace
LinuxProperties
LinuxUpdateClasses
LogSpecification
MetricSpecification
Module
ModuleCreateOrUpdateParameters
ModuleErrorInfo
ModuleListResult
ModuleProvisioningState
ModuleProvisioningState.ACTIVITIES_STORED
ModuleProvisioningState.CANCELLED
ModuleProvisioningState.CONNECTION_TYPE_IMPORTED
ModuleProvisioningState.CONTENT_DOWNLOADED
ModuleProvisioningState.CONTENT_RETRIEVED
ModuleProvisioningState.CONTENT_STORED
ModuleProvisioningState.CONTENT_VALIDATED
ModuleProvisioningState.CREATED
ModuleProvisioningState.CREATING
ModuleProvisioningState.FAILED
ModuleProvisioningState.MODULE_DATA_STORED
ModuleProvisioningState.MODULE_IMPORT_RUNBOOK_COMPLETE
ModuleProvisioningState.RUNNING_IMPORT_MODULE_RUNBOOK
ModuleProvisioningState.STARTING_IMPORT_MODULE_RUNBOOK
ModuleProvisioningState.SUCCEEDED
ModuleProvisioningState.UPDATING
ModuleUpdateParameters
NodeCount
NodeCountProperties
NodeCounts
NonAzureQueryProperties
OperatingSystemType
Operation
OperationDisplay
OperationListResult
OperationPropertiesFormatServiceSpecification
PrivateEndpointConnection
PrivateEndpointConnectionListResult
PrivateEndpointProperty
PrivateLinkResource
PrivateLinkResourceListResult
PrivateLinkServiceConnectionStateProperty
ProvisioningState
ProxyResource
PythonPackageCreateParameters
PythonPackageUpdateParameters
RawGraphicalRunbookContent
Resource
ResourceIdentityType
RunAsCredentialAssociationProperty
Runbook
RunbookAssociationProperty
RunbookCreateOrUpdateDraftParameters
RunbookCreateOrUpdateDraftProperties
RunbookCreateOrUpdateParameters
RunbookDraft
RunbookDraftUndoEditResult
RunbookListResult
RunbookParameter
RunbookState
RunbookTypeEnum
RunbookUpdateParameters
SUCScheduleProperties
Schedule
ScheduleAssociationProperty
ScheduleCreateOrUpdateParameters
ScheduleDay
ScheduleFrequency
ScheduleListResult
ScheduleUpdateParameters
Sku
SkuNameEnum
SoftwareUpdateConfiguration
SoftwareUpdateConfigurationCollectionItem
SoftwareUpdateConfigurationListResult
SoftwareUpdateConfigurationMachineRun
SoftwareUpdateConfigurationMachineRunListResult
SoftwareUpdateConfigurationRun
SoftwareUpdateConfigurationRunListResult
SoftwareUpdateConfigurationRunTaskProperties
SoftwareUpdateConfigurationRunTasks
SoftwareUpdateConfigurationTasks
SourceControl
SourceControlCreateOrUpdateParameters
SourceControlListResult
SourceControlSecurityTokenProperties
SourceControlSyncJob
SourceControlSyncJobById
SourceControlSyncJobCreateParameters
SourceControlSyncJobListResult
SourceControlSyncJobStream
SourceControlSyncJobStreamById
SourceControlSyncJobStreamsListBySyncJob
SourceControlUpdateParameters
SourceType
Statistics
StatisticsListResult
StreamType
SyncType
SystemData
TagOperators
TagSettingsProperties
TargetProperties
TaskProperties
TestJob
TestJobCreateParameters
TokenType
TrackedResource
TypeField
TypeFieldListResult
UpdateConfiguration
UpdateConfigurationNavigation
Usage
UsageCounterName
UsageListResult
UserAssignedIdentitiesProperties
Variable
VariableCreateOrUpdateParameters
VariableListResult
VariableUpdateParameters
Watcher
WatcherListResult
WatcherUpdateParameters
Webhook
WebhookCreateOrUpdateParameters
WebhookListResult
WebhookUpdateParameters
WindowsProperties
WindowsUpdateClasses
WorkerType
- azure.mgmt.automation.operations module
ActivityOperations
AgentRegistrationInformationOperations
AutomationAccountOperations
AutomationClientOperationsMixin
CertificateOperations
ConnectionOperations
ConnectionTypeOperations
CredentialOperations
DeletedAutomationAccountsOperations
DscCompilationJobOperations
DscCompilationJobStreamOperations
DscConfigurationOperations
DscNodeConfigurationOperations
DscNodeOperations
FieldsOperations
HybridRunbookWorkerGroupOperations
HybridRunbookWorkersOperations
JobOperations
JobScheduleOperations
JobStreamOperations
KeysOperations
LinkedWorkspaceOperations
ModuleOperations
NodeCountInformationOperations
NodeReportsOperations
ObjectDataTypesOperations
Operations
PrivateEndpointConnectionsOperations
PrivateLinkResourcesOperations
Python2PackageOperations
Python3PackageOperations
RunbookDraftOperations
RunbookOperations
ScheduleOperations
SoftwareUpdateConfigurationMachineRunsOperations
SoftwareUpdateConfigurationRunsOperations
SoftwareUpdateConfigurationsOperations
SourceControlOperations
SourceControlSyncJobOperations
SourceControlSyncJobStreamsOperations
StatisticsOperations
TestJobOperations
TestJobStreamsOperations
UsagesOperations
VariableOperations
WatcherOperations
WebhookOperations
- azure.mgmt.automation.models module
- Module contents
- Submodules