Metadata-Version: 2.4
Name: azure-mgmt-automation
Version: 1.1.0b5
Summary: Microsoft Azure Automation Management Client Library for Python
Author-email: Microsoft Corporation <azpysdkhelp@microsoft.com>
License-Expression: MIT
Project-URL: repository, https://github.com/Azure/azure-sdk-for-python
Keywords: azure,azure sdk
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: isodate>=0.6.1
Requires-Dist: azure-mgmt-core>=1.6.0
Requires-Dist: typing-extensions>=4.6.0
Dynamic: license-file

# Microsoft Azure SDK for Python

This is the Microsoft Azure Automation Client Library.
This package has been tested with Python 3.10+.
For a more complete view of Azure libraries, see the [azure sdk python release](https://aka.ms/azsdk/python/all).

## _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.10+ is required to use this package.
- [Azure subscription](https://azure.microsoft.com/free/)

### Install the package

```bash
pip install azure-mgmt-automation
pip install azure-identity
```

### Authentication

By default, [Azure Active Directory](https://aka.ms/awps/aad) token authentication depends on correct configuration of the 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:

```python
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](https://docs.microsoft.com/samples/browse/?languages=python&term=Getting%20started%20-%20Managing&terms=Getting%20started%20-%20Managing) on docs.microsoft.com
- [Azure Python Mgmt SDK Samples Repo](https://aka.ms/azsdk/python/mgmt/samples)


## Troubleshooting

## Next steps

## Provide Feedback

If you encounter any bugs or have suggestions, please file an issue in the
[Issues](https://github.com/Azure/azure-sdk-for-python/issues)
section of the project. 

# Release History

## 1.1.0b5 (2026-05-27)

### Features Added

  - Client `AutomationClient` added parameter `cloud_setting` in method `__init__`
  - Client `AutomationClient` added method `send_request`
  - Client `AutomationClient` added operation group `runtime_environments`
  - Client `AutomationClient` added operation group `package`
  - Model `Certificate` added property `system_data`
  - Model `Connection` added property `system_data`
  - Model `ConnectionType` added property `system_data`
  - Model `Credential` added property `system_data`
  - Model `DscConfiguration` added property `system_data`
  - Model `DscNode` added property `system_data`
  - Model `DscNodeConfiguration` added property `system_data`
  - Model `HybridRunbookWorker` added property `tags`
  - Model `HybridRunbookWorker` added property `location`
  - Model `HybridRunbookWorkerGroup` added property `tags`
  - Model `HybridRunbookWorkerGroup` added property `location`
  - Model `Job` added property `system_data`
  - Model `JobCollectionItem` added property `system_data`
  - Model `JobSchedule` added property `system_data`
  - Model `Module` added property `system_data`
  - Model `PrivateEndpointConnection` added property `system_data`
  - Model `PrivateLinkResource` added property `system_data`
  - Model `ProxyResource` added property `system_data`
  - Model `Resource` added property `system_data`
  - Model `Runbook` added property `system_data`
  - Enum `RunbookTypeEnum` added member `POWER_SHELL72`
  - Enum `RunbookTypeEnum` added member `PYTHON`
  - Model `Schedule` added property `system_data`
  - Model `SoftwareUpdateConfiguration` added property `system_data`
  - Model `SourceControl` added property `system_data`
  - Model `TestJobCreateParameters` added property `runtime_environment`
  - Model `TrackedResource` added property `system_data`
  - Model `Variable` added property `system_data`
  - Model `Watcher` added property `system_data`
  - Model `Webhook` added property `system_data`
  - Added model `AutomationErrorResponse`
  - Added model `DeletedRunbook`
  - Added model `DeletedRunbookProperties`
  - Added model `ErrorAdditionalInfo`
  - Added model `JobRuntimeEnvironment`
  - Added model `Package`
  - Added model `PackageCreateOrUpdateParameters`
  - Added model `PackageCreateOrUpdateProperties`
  - Added model `PackageErrorInfo`
  - Added model `PackageProperties`
  - Added enum `PackageProvisioningState`
  - Added model `PackageUpdateParameters`
  - Added model `PackageUpdateProperties`
  - Added model `RuntimeEnvironment`
  - Added model `RuntimeEnvironmentProperties`
  - Added model `RuntimeEnvironmentUpdateParameters`
  - Added model `RuntimeEnvironmentUpdateProperties`
  - Added model `RuntimeProperties`
  - Operation group `AutomationAccountOperations` added method `list_deleted_runbooks`
  - Operation group `HybridRunbookWorkersOperations` added method `patch`
  - Added operation group `PackageOperations`
  - Added operation group `RuntimeEnvironmentsOperations`

### Breaking Changes

  - This version introduces new hybrid models which have dual dictionary and model nature. Please follow https://aka.ms/azsdk/python/migrate/hybrid-models for migration.
  - For the method breakings, please refer to https://aka.ms/azsdk/python/migrate/operations for migration.
  - Model `AgentRegistration` renamed its instance variable `keys` to `keys_property`
  - Model `AutomationAccountCreateOrUpdateParameters` moved instance variable `sku`, `encryption`, `public_network_access` and `disable_local_auth` under property `properties` whose type is `AutomationAccountCreateOrUpdateProperties`
  - Model `AutomationAccountUpdateParameters` moved instance variable `sku`, `encryption`, `public_network_access` and `disable_local_auth` under property `properties` whose type is `AutomationAccountUpdateProperties`
  - Model `CertificateCreateOrUpdateParameters` moved instance variable `base64_value`, `description`, `thumbprint` and `is_exportable` under property `properties` whose type is `CertificateCreateOrUpdateProperties`
  - Model `CertificateUpdateParameters` moved instance variable `description` under property `properties` whose type is `CertificateUpdateProperties`
  - Model `ConnectionCreateOrUpdateParameters` moved instance variable `description`, `connection_type` and `field_definition_values` under property `properties` whose type is `ConnectionCreateOrUpdateProperties`
  - Model `ConnectionTypeCreateOrUpdateParameters` moved instance variable `is_global` and `field_definitions` under property `properties` whose type is `ConnectionTypeCreateOrUpdateProperties`
  - Model `ConnectionUpdateParameters` moved instance variable `description` and `field_definition_values` under property `properties` whose type is `ConnectionUpdateProperties`
  - Model `CredentialCreateOrUpdateParameters` moved instance variable `user_name`, `password` and `description` under property `properties` whose type is `CredentialCreateOrUpdateProperties`
  - Model `CredentialUpdateParameters` moved instance variable `user_name`, `password` and `description` under property `properties` whose type is `CredentialUpdateProperties`
  - Model `DscConfigurationCreateOrUpdateParameters` moved instance variable `log_verbose`, `log_progress`, `source`, `parameters` and `description` under property `properties` whose type is `DscConfigurationCreateOrUpdateProperties`
  - Model `DscConfigurationUpdateParameters` moved instance variable `log_verbose`, `log_progress`, `source`, `parameters` and `description` under property `properties` whose type is `DscConfigurationCreateOrUpdateProperties`
  - Model `DscNodeUpdateParametersProperties` moved instance variable `name` under property `node_configuration` whose type is `DscNodeConfigurationAssociationProperty`
  - Model `ErrorResponse` moved instance variable `code` and `message` under property `error` whose type is `ErrorDetail`
  - Model `HybridRunbookWorkerCreateParameters` moved instance variable `vm_resource_id` under property `properties` whose type is `HybridRunbookWorkerCreateOrUpdateParameters`
  - Model `HybridRunbookWorkerGroupCreateOrUpdateParameters` moved instance variable `credential` under property `properties` whose type is `HybridRunbookWorkerGroupCreateOrUpdateProperties`
  - Model `JobCreateParameters` moved instance variable `runbook`, `parameters` and `run_on` under property `properties` whose type is `JobCreateProperties`
  - Model `JobScheduleCreateParameters` moved instance variable `schedule`, `runbook`, `run_on` and `parameters` under property `properties` whose type is `JobScheduleCreateProperties`
  - Model `KeyListResult` renamed its instance variable `keys` to `keys_property`
  - Model `ModuleCreateOrUpdateParameters` moved instance variable `content_link` under property `properties` whose type is `ModuleCreateOrUpdateProperties`
  - Renamed enum value `ModuleProvisioningState.CANCELLED` to `ModuleProvisioningState.CANCELED`
  - Model `ModuleUpdateParameters` moved instance variable `content_link` under property `properties` whose type is `ModuleUpdateProperties`
  - Model `Operation` moved instance variable `service_specification` under property `properties` whose type is `OperationPropertiesFormat`
  - Model `PythonPackageCreateParameters` moved instance variable `content_link` under property `properties` whose type is `PythonPackageCreateProperties`
  - Model `RunbookCreateOrUpdateParameters` moved instance variable `log_verbose`, `log_progress`, `runbook_type`, `draft`, `publish_content_link`, `description` and `log_activity_trace` under property `properties` whose type is `RunbookCreateOrUpdateProperties`
  - Model `RunbookUpdateParameters` moved instance variable `description`, `log_verbose`, `log_progress` and `log_activity_trace` under property `properties` whose type is `RunbookUpdateProperties`
  - Model `ScheduleCreateOrUpdateParameters` moved instance variable `description`, `start_time`, `expiry_time`, `interval`, `frequency`, `time_zone` and `advanced_schedule` under property `properties` whose type is `ScheduleCreateOrUpdateProperties`
  - Model `ScheduleUpdateParameters` moved instance variable `description` and `is_enabled` under property `properties` whose type is `ScheduleUpdateProperties`
  - Model `SoftwareUpdateConfigurationMachineRun` moved instance variable `target_computer`, `target_computer_type`, `software_update_configuration`, `status`, `os_type`, `correlation_id`, `source_computer_id`, `start_time`, `end_time`, `configured_duration`, `job`, `creation_time`, `created_by`, `last_modified_time`, `last_modified_by` and `error` under property `properties` whose type is `UpdateConfigurationMachineRunProperties`
  - Model `SourceControlCreateOrUpdateParameters` moved instance variable `repo_url`, `branch`, `folder_path`, `auto_sync`, `publish_runbook`, `source_type`, `security_token` and `description` under property `properties` whose type is `SourceControlCreateOrUpdateProperties`
  - Model `SourceControlSyncJobCreateParameters` moved instance variable `commit_id` under property `properties` whose type is `SourceControlSyncJobCreateProperties`
  - Model `SourceControlUpdateParameters` moved instance variable `branch`, `folder_path`, `auto_sync`, `publish_runbook`, `security_token` and `description` under property `properties` whose type is `SourceControlUpdateProperties`
  - Model `VariableCreateOrUpdateParameters` moved instance variable `value`, `description` and `is_encrypted` under property `properties` whose type is `VariableCreateOrUpdateProperties`
  - Model `VariableUpdateParameters` moved instance variable `value` and `description` under property `properties` whose type is `VariableUpdateProperties`
  - Model `WatcherUpdateParameters` moved instance variable `execution_frequency_in_seconds` under property `properties` whose type is `WatcherUpdateProperties`
  - Model `WebhookCreateOrUpdateParameters` moved instance variable `is_enabled`, `uri`, `expiry_time`, `parameters`, `runbook` and `run_on` under property `properties` whose type is `WebhookCreateOrUpdateProperties`
  - Model `WebhookUpdateParameters` moved instance variable `is_enabled`, `run_on`, `parameters` and `description` under property `properties` whose type is `WebhookUpdateProperties`
  - Deleted operation group `AutomationClient.dsc_compilation_job`/`AutomationClient.dsc_compilation_job_stream` and their corresponding models `DscCompilationJob`/`DscCompilationJobCreateParameters` were also deleted
  - Method `DscConfigurationOperations.list_by_automation_account` changed its parameter `inlinecount` from `positional_or_keyword` to `keyword_only`
  - Method `DscNodeConfigurationOperations.list_by_automation_account` changed its parameter `inlinecount` from `positional_or_keyword` to `keyword_only`
  - Method `DscNodeOperations.list_by_automation_account` changed its parameter `inlinecount` from `positional_or_keyword` to `keyword_only`
  - Method `JobOperations.create` changed its parameter `client_request_id` from `positional_or_keyword` to `keyword_only`
  - Method `JobOperations.get` changed its parameter `client_request_id` from `positional_or_keyword` to `keyword_only`
  - Method `JobOperations.get_output` changed its parameter `client_request_id` from `positional_or_keyword` to `keyword_only`
  - Method `JobOperations.get_runbook_content` changed its parameter `client_request_id` from `positional_or_keyword` to `keyword_only`
  - Method `JobOperations.list_by_automation_account` changed its parameter `client_request_id` from `positional_or_keyword` to `keyword_only`
  - Method `JobOperations.resume` changed its parameter `client_request_id` from `positional_or_keyword` to `keyword_only`
  - Method `JobOperations.stop` changed its parameter `client_request_id` from `positional_or_keyword` to `keyword_only`
  - Method `JobOperations.suspend` changed its parameter `client_request_id` from `positional_or_keyword` to `keyword_only`
  - Method `JobStreamOperations.get` changed its parameter `client_request_id` from `positional_or_keyword` to `keyword_only`
  - Method `JobStreamOperations.list_by_job` changed its parameter `client_request_id` from `positional_or_keyword` to `keyword_only`
  - Method `SoftwareUpdateConfigurationMachineRunsOperations.get_by_id` changed its parameter `client_request_id` from `positional_or_keyword` to `keyword_only`
  - Method `SoftwareUpdateConfigurationMachineRunsOperations.list` changed its parameter `client_request_id` from `positional_or_keyword` to `keyword_only`
  - Method `SoftwareUpdateConfigurationRunsOperations.get_by_id` changed its parameter `client_request_id` from `positional_or_keyword` to `keyword_only`
  - Method `SoftwareUpdateConfigurationRunsOperations.list` changed its parameter `client_request_id` from `positional_or_keyword` to `keyword_only`
  - Method `SoftwareUpdateConfigurationsOperations.create` changed its parameter `client_request_id` from `positional_or_keyword` to `keyword_only`
  - Method `SoftwareUpdateConfigurationsOperations.delete` changed its parameter `client_request_id` from `positional_or_keyword` to `keyword_only`
  - Method `SoftwareUpdateConfigurationsOperations.get_by_name` changed its parameter `client_request_id` from `positional_or_keyword` to `keyword_only`
  - Method `SoftwareUpdateConfigurationsOperations.list` changed its parameter `client_request_id` from `positional_or_keyword` to `keyword_only`
  - Method `DscConfigurationOperations.get_content` changed return type from `Iterator[bytes]` to `str`
  - Method `NodeReportsOperations.get_content` changed return type from `JSON` to `str`
  - Method `RunbookDraftOperations.begin_replace_content` changed return type from `LROPoller[Iterator[bytes]]` to `LROPoller[None]`
  - Method `RunbookDraftOperations.get_content` changed return type from `Iterator[bytes]` to `str`
  - Method `RunbookOperations.get_content` changed return type from `Iterator[bytes]` to `str`

### Other Changes

  - Deleted model `JobListResultV2`/`SourceControlSyncJobStreamsListBySyncJob`/`RunbookCreateOrUpdateDraftParameters`/`RunbookCreateOrUpdateDraftProperties` which actually were not used by SDK users

## 1.0.1 (2026-05-14)

### Other Changes

  - Regenerated with latest code generator tool

## 1.1.0b4 (2024-11-05)

### Other Changes

  - Update dependencies

## 1.1.0b3 (2022-12-12)

### Features Added

  - Added operation group DeletedAutomationAccountsOperations
  - Added operation group Python3PackageOperations
  - Model HybridRunbookWorkerGroupCreateOrUpdateParameters has a new parameter name
  - Model Operation has a new parameter origin
  - Model Operation has a new parameter service_specification
  - Model OperationDisplay has a new parameter description

### Breaking Changes

  - Model HybridRunbookWorkerGroup no longer has parameter hybrid_runbook_workers
  - Operation DscConfigurationOperations.create_or_update no longer has parameter content_type
  - Operation DscConfigurationOperations.update no longer has parameter content_type
  - Operation HybridRunbookWorkerGroupOperations.update has a new required parameter hybrid_runbook_worker_group_updation_parameters
  - Operation HybridRunbookWorkerGroupOperations.update no longer has parameter parameters

## 1.1.0b2 (2022-07-18)

**Features**

  - Added operation HybridRunbookWorkerGroupOperations.create
  - Added operation group AutomationClientOperationsMixin
  - Added operation group HybridRunbookWorkersOperations
  - Added operation group PrivateEndpointConnectionsOperations
  - Added operation group PrivateLinkResourcesOperations
  - Model AutomationAccount has a new parameter automation_hybrid_service_url
  - Model AutomationAccount has a new parameter disable_local_auth
  - Model AutomationAccount has a new parameter encryption
  - Model AutomationAccount has a new parameter identity
  - Model AutomationAccount has a new parameter private_endpoint_connections
  - Model AutomationAccount has a new parameter public_network_access
  - Model AutomationAccount has a new parameter system_data
  - Model AutomationAccountCreateOrUpdateParameters has a new parameter disable_local_auth
  - Model AutomationAccountCreateOrUpdateParameters has a new parameter encryption
  - Model AutomationAccountCreateOrUpdateParameters has a new parameter identity
  - Model AutomationAccountCreateOrUpdateParameters has a new parameter public_network_access
  - Model AutomationAccountUpdateParameters has a new parameter disable_local_auth
  - Model AutomationAccountUpdateParameters has a new parameter encryption
  - Model AutomationAccountUpdateParameters has a new parameter identity
  - Model AutomationAccountUpdateParameters has a new parameter public_network_access
  - Model HybridRunbookWorker has a new parameter id
  - Model HybridRunbookWorker has a new parameter registered_date_time
  - Model HybridRunbookWorker has a new parameter system_data
  - Model HybridRunbookWorker has a new parameter type
  - Model HybridRunbookWorker has a new parameter vm_resource_id
  - Model HybridRunbookWorker has a new parameter worker_name
  - Model HybridRunbookWorker has a new parameter worker_type
  - Model HybridRunbookWorkerGroup has a new parameter system_data
  - Model HybridRunbookWorkerGroup has a new parameter type
  - Operation DscConfigurationOperations.create_or_update has a new optional and keyword-only parameter content_type
  - Operation DscConfigurationOperations.update has a new optional and keyword-only parameter content_type

**Breaking changes**

  - Model HybridRunbookWorker no longer has parameter registration_time

## 1.1.0b1 (2021-03-16)

**Features**

  - Model SoftwareUpdateConfigurationCollectionItem has a new parameter tasks

## 1.0.0 (2020-12-17)

- GA release

## 1.0.0b1 (2020-11-11)

This is beta preview version.

This version uses a next-generation code generator that introduces important breaking changes, but also important new features (like unified authentication and async programming).

**General breaking changes**

- Credential system has been completly revamped:

  - `azure.common.credentials` or `msrestazure.azure_active_directory` instances are no longer supported, use the `azure-identity` classes instead: https://pypi.org/project/azure-identity/
  - `credentials` parameter has been renamed `credential`

- The `config` attribute no longer exists on a client, configuration should be passed as kwarg. Example: `MyClient(credential, subscription_id, enable_logging=True)`. For a complete set of
  supported options, see the [parameters accept in init documentation of azure-core](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#available-policies)
- You can't import a `version` module anymore, use `__version__` instead
- Operations that used to return a `msrest.polling.LROPoller` now returns a `azure.core.polling.LROPoller` and are prefixed with `begin_`.
- Exceptions tree have been simplified and most exceptions are now `azure.core.exceptions.HttpResponseError` (`CloudError` has been removed).
- Most of the operation kwarg have changed. Some of the most noticeable:

  - `raw` has been removed. Equivalent feature can be found using `cls`, a callback that will give access to internal HTTP response for advanced user
  - For a complete set of
  supported options, see the [parameters accept in Request documentation of azure-core](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#available-policies)

**General new features**

- Type annotations support using `typing`. SDKs are mypy ready.
- This client has now stable and official support for async. Check the `aio` namespace of your package to find the async client.
- This client now support natively tracing library like OpenCensus or OpenTelemetry. See this [tracing quickstart](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/core/azure-core-tracing-opentelemetry) for an overview.

## 0.1.1 (2019-05-13)

**Bugfixes**

  - Remove incorrect "count_type1" parameter from client signature
    #4965

## 0.1.0 (2019-04-16)

  - Initial Release
