azure.mgmt.automation.operations module

class azure.mgmt.automation.operations.ActivityOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AutomationClient’s activity attribute.

get(resource_group_name: str, automation_account_name: str, module_name: str, activity_name: str, **kwargs: Any) → azure.mgmt.automation.models._models_py3.Activity

Retrieve the activity in the module identified by module name and activity name.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• module_name (str) – The name of module.

• activity_name (str) – The name of activity.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

Activity, or the result of cls(response)

Return type

Activity

Raises

~azure.core.exceptions.HttpResponseError

list_by_module(resource_group_name: str, automation_account_name: str, module_name: str, **kwargs: Any) → Iterable[azure.mgmt.automation.models._models_py3.ActivityListResult]

Retrieve a list of activities in the module identified by module name.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• module_name (str) – The name of module.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ActivityListResult or the result of cls(response)

Return type

ItemPaged[ActivityListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/automation/models/__init__.py'>

class azure.mgmt.automation.operations.AgentRegistrationInformationOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AutomationClient’s agent_registration_information attribute.

get(resource_group_name: str, automation_account_name: str, **kwargs: Any) → azure.mgmt.automation.models._models_py3.AgentRegistration

Retrieve the automation agent registration information.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

AgentRegistration, or the result of cls(response)

Return type

AgentRegistration

Raises

~azure.core.exceptions.HttpResponseError

regenerate_key(resource_group_name: str, automation_account_name: str, parameters: azure.mgmt.automation.models._models_py3.AgentRegistrationRegenerateKeyParameter, **kwargs: Any) → azure.mgmt.automation.models._models_py3.AgentRegistration

Regenerate a primary or secondary agent registration key.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• parameters (AgentRegistrationRegenerateKeyParameter) – The name of the agent registration key to be regenerated.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

AgentRegistration, or the result of cls(response)

Return type

AgentRegistration

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/automation/models/__init__.py'>

class azure.mgmt.automation.operations.AutomationAccountOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AutomationClient’s automation_account attribute.

create_or_update(resource_group_name: str, automation_account_name: str, parameters: azure.mgmt.automation.models._models_py3.AutomationAccountCreateOrUpdateParameters, **kwargs: Any) → azure.mgmt.automation.models._models_py3.AutomationAccount

Create or update automation account.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• parameters (AutomationAccountCreateOrUpdateParameters) – Parameters supplied to the create or update automation account.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2021-06-22”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

AutomationAccount, or the result of cls(response)

Return type

AutomationAccount

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, automation_account_name: str, **kwargs: Any) → None

Delete an automation account.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2021-06-22”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, automation_account_name: str, **kwargs: Any) → azure.mgmt.automation.models._models_py3.AutomationAccount

Get information about an Automation Account.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2021-06-22”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

AutomationAccount, or the result of cls(response)

Return type

AutomationAccount

Raises

~azure.core.exceptions.HttpResponseError

list(**kwargs: Any) → Iterable[azure.mgmt.automation.models._models_py3.AutomationAccountListResult]

Lists the Automation Accounts within an Azure subscription.

Retrieve a list of accounts within a given subscription.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2021-06-22”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either AutomationAccountListResult or the result of cls(response)

Return type

ItemPaged[AutomationAccountListResult]

Raises

~azure.core.exceptions.HttpResponseError

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.automation.models._models_py3.AutomationAccountListResult]

Retrieve a list of accounts within a given resource group.

Parameters

resource_group_name (str) – Name of an Azure Resource group.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2021-06-22”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either AutomationAccountListResult or the result of cls(response)

Return type

ItemPaged[AutomationAccountListResult]

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, automation_account_name: str, parameters: azure.mgmt.automation.models._models_py3.AutomationAccountUpdateParameters, **kwargs: Any) → azure.mgmt.automation.models._models_py3.AutomationAccount

Update an automation account.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• parameters (AutomationAccountUpdateParameters) – Parameters supplied to the update automation account.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2021-06-22”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

AutomationAccount, or the result of cls(response)

Return type

AutomationAccount

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/automation/models/__init__.py'>

class azure.mgmt.automation.operations.AutomationClientOperationsMixin

Bases: azure.mgmt.automation._vendor.MixinABC

convert_graph_runbook_content(resource_group_name: str, automation_account_name: str, parameters: azure.mgmt.automation.models._models_py3.GraphicalRunbookContent, **kwargs: Any) → azure.mgmt.automation.models._models_py3.GraphicalRunbookContent

Post operation to serialize or deserialize GraphRunbookContent.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• parameters (GraphicalRunbookContent) – Input data describing the graphical runbook.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2021-06-22”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

GraphicalRunbookContent, or the result of cls(response)

Return type

GraphicalRunbookContent

Raises

~azure.core.exceptions.HttpResponseError

class azure.mgmt.automation.operations.CertificateOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AutomationClient’s certificate attribute.

create_or_update(resource_group_name: str, automation_account_name: str, certificate_name: str, parameters: azure.mgmt.automation.models._models_py3.CertificateCreateOrUpdateParameters, **kwargs: Any) → azure.mgmt.automation.models._models_py3.Certificate

Create a certificate.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• certificate_name (str) – The parameters supplied to the create or update certificate operation.

• parameters (CertificateCreateOrUpdateParameters) – The parameters supplied to the create or update certificate operation.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

Certificate, or the result of cls(response)

Return type

Certificate

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, automation_account_name: str, certificate_name: str, **kwargs: Any) → None

Delete the certificate.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• certificate_name (str) – The name of certificate.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, automation_account_name: str, certificate_name: str, **kwargs: Any) → azure.mgmt.automation.models._models_py3.Certificate

Retrieve the certificate identified by certificate name.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• certificate_name (str) – The name of certificate.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

Certificate, or the result of cls(response)

Return type

Certificate

Raises

~azure.core.exceptions.HttpResponseError

list_by_automation_account(resource_group_name: str, automation_account_name: str, **kwargs: Any) → Iterable[azure.mgmt.automation.models._models_py3.CertificateListResult]

Retrieve a list of certificates.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either CertificateListResult or the result of cls(response)

Return type

ItemPaged[CertificateListResult]

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, automation_account_name: str, certificate_name: str, parameters: azure.mgmt.automation.models._models_py3.CertificateUpdateParameters, **kwargs: Any) → azure.mgmt.automation.models._models_py3.Certificate

Update a certificate.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• certificate_name (str) – The parameters supplied to the update certificate operation.

• parameters (CertificateUpdateParameters) – The parameters supplied to the update certificate operation.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

Certificate, or the result of cls(response)

Return type

Certificate

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/automation/models/__init__.py'>

class azure.mgmt.automation.operations.ConnectionOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AutomationClient’s connection attribute.

create_or_update(resource_group_name: str, automation_account_name: str, connection_name: str, parameters: azure.mgmt.automation.models._models_py3.ConnectionCreateOrUpdateParameters, **kwargs: Any) → azure.mgmt.automation.models._models_py3.Connection

Create or update a connection.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• connection_name (str) – The parameters supplied to the create or update connection operation.

• parameters (ConnectionCreateOrUpdateParameters) – The parameters supplied to the create or update connection operation.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

Connection, or the result of cls(response)

Return type

Connection

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, automation_account_name: str, connection_name: str, **kwargs: Any) → None

Delete the connection.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• connection_name (str) – The name of connection.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, automation_account_name: str, connection_name: str, **kwargs: Any) → azure.mgmt.automation.models._models_py3.Connection

Retrieve the connection identified by connection name.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• connection_name (str) – The name of connection.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

Connection, or the result of cls(response)

Return type

Connection

Raises

~azure.core.exceptions.HttpResponseError

list_by_automation_account(resource_group_name: str, automation_account_name: str, **kwargs: Any) → Iterable[azure.mgmt.automation.models._models_py3.ConnectionListResult]

Retrieve a list of connections.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ConnectionListResult or the result of cls(response)

Return type

ItemPaged[ConnectionListResult]

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, automation_account_name: str, connection_name: str, parameters: azure.mgmt.automation.models._models_py3.ConnectionUpdateParameters, **kwargs: Any) → azure.mgmt.automation.models._models_py3.Connection

Update a connection.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• connection_name (str) – The parameters supplied to the update a connection operation.

• parameters (ConnectionUpdateParameters) – The parameters supplied to the update a connection operation.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

Connection, or the result of cls(response)

Return type

Connection

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/automation/models/__init__.py'>

class azure.mgmt.automation.operations.ConnectionTypeOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AutomationClient’s connection_type attribute.

create_or_update(resource_group_name: str, automation_account_name: str, connection_type_name: str, parameters: azure.mgmt.automation.models._models_py3.ConnectionTypeCreateOrUpdateParameters, **kwargs: Any) → azure.mgmt.automation.models._models_py3.ConnectionType

Create a connection type.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• connection_type_name (str) – The parameters supplied to the create or update connection type operation.

• parameters (ConnectionTypeCreateOrUpdateParameters) – The parameters supplied to the create or update connection type operation.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

ConnectionType, or the result of cls(response)

Return type

ConnectionType

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, automation_account_name: str, connection_type_name: str, **kwargs: Any) → None

Delete the connection type.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• connection_type_name (str) – The name of connection type.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, automation_account_name: str, connection_type_name: str, **kwargs: Any) → azure.mgmt.automation.models._models_py3.ConnectionType

Retrieve the connection type identified by connection type name.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• connection_type_name (str) – The name of connection type.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

ConnectionType, or the result of cls(response)

Return type

ConnectionType

Raises

~azure.core.exceptions.HttpResponseError

list_by_automation_account(resource_group_name: str, automation_account_name: str, **kwargs: Any) → Iterable[azure.mgmt.automation.models._models_py3.ConnectionTypeListResult]

Retrieve a list of connection types.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ConnectionTypeListResult or the result of cls(response)

Return type

ItemPaged[ConnectionTypeListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/automation/models/__init__.py'>

class azure.mgmt.automation.operations.CredentialOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AutomationClient’s credential attribute.

create_or_update(resource_group_name: str, automation_account_name: str, credential_name: str, parameters: azure.mgmt.automation.models._models_py3.CredentialCreateOrUpdateParameters, **kwargs: Any) → azure.mgmt.automation.models._models_py3.Credential

Create a credential.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• credential_name (str) – The parameters supplied to the create or update credential operation.

• parameters (CredentialCreateOrUpdateParameters) – The parameters supplied to the create or update credential operation.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

Credential, or the result of cls(response)

Return type

Credential

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, automation_account_name: str, credential_name: str, **kwargs: Any) → None

Delete the credential.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• credential_name (str) – The name of credential.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, automation_account_name: str, credential_name: str, **kwargs: Any) → azure.mgmt.automation.models._models_py3.Credential

Retrieve the credential identified by credential name.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• credential_name (str) – The name of credential.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

Credential, or the result of cls(response)

Return type

Credential

Raises

~azure.core.exceptions.HttpResponseError

list_by_automation_account(resource_group_name: str, automation_account_name: str, **kwargs: Any) → Iterable[azure.mgmt.automation.models._models_py3.CredentialListResult]

Retrieve a list of credentials.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either CredentialListResult or the result of cls(response)

Return type

ItemPaged[CredentialListResult]

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, automation_account_name: str, credential_name: str, parameters: azure.mgmt.automation.models._models_py3.CredentialUpdateParameters, **kwargs: Any) → azure.mgmt.automation.models._models_py3.Credential

Update a credential.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• credential_name (str) – The parameters supplied to the Update credential operation.

• parameters (CredentialUpdateParameters) – The parameters supplied to the Update credential operation.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

Credential, or the result of cls(response)

Return type

Credential

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/automation/models/__init__.py'>

class azure.mgmt.automation.operations.DscCompilationJobOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AutomationClient’s dsc_compilation_job attribute.

begin_create(resource_group_name: str, automation_account_name: str, compilation_job_name: str, parameters: azure.mgmt.automation.models._models_py3.DscCompilationJobCreateParameters, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.automation.models._models_py3.DscCompilationJob]

Creates the Dsc compilation job of the configuration.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• compilation_job_name (str) – The DSC configuration Id.

• parameters (DscCompilationJobCreateParameters) – The parameters supplied to the create compilation job operation.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either DscCompilationJob or the result of cls(response)

Return type

LROPoller[DscCompilationJob]

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, automation_account_name: str, compilation_job_name: str, **kwargs: Any) → azure.mgmt.automation.models._models_py3.DscCompilationJob

Retrieve the Dsc configuration compilation job identified by job id.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• compilation_job_name (str) – The DSC configuration Id.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

DscCompilationJob, or the result of cls(response)

Return type

DscCompilationJob

Raises

~azure.core.exceptions.HttpResponseError

get_stream(resource_group_name: str, automation_account_name: str, job_id: str, job_stream_id: str, **kwargs: Any) → azure.mgmt.automation.models._models_py3.JobStream

Retrieve the job stream identified by job stream id.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• job_id (str) – The job id.

• job_stream_id (str) – The job stream id.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

JobStream, or the result of cls(response)

Return type

JobStream

Raises

~azure.core.exceptions.HttpResponseError

list_by_automation_account(resource_group_name: str, automation_account_name: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.automation.models._models_py3.DscCompilationJobListResult]

Retrieve a list of dsc compilation jobs.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• filter (str) – The filter to apply on the operation. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either DscCompilationJobListResult or the result of cls(response)

Return type

ItemPaged[DscCompilationJobListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/automation/models/__init__.py'>

class azure.mgmt.automation.operations.DscCompilationJobStreamOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AutomationClient’s dsc_compilation_job_stream attribute.

list_by_job(resource_group_name: str, automation_account_name: str, job_id: str, **kwargs: Any) → azure.mgmt.automation.models._models_py3.JobStreamListResult

Retrieve all the job streams for the compilation Job.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• job_id (str) – The job id.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

JobStreamListResult, or the result of cls(response)

Return type

JobStreamListResult

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/automation/models/__init__.py'>

class azure.mgmt.automation.operations.DscConfigurationOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AutomationClient’s dsc_configuration attribute.

create_or_update(resource_group_name: str, automation_account_name: str, configuration_name: str, parameters: Union[str, azure.mgmt.automation.models._models_py3.DscConfigurationCreateOrUpdateParameters], *, content_type: Optional[str] = 'application/json', **kwargs: Any) → azure.mgmt.automation.models._models_py3.DscConfiguration

Create the configuration identified by configuration name.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• configuration_name (str) – The create or update parameters for configuration.

• parameters (str or DscConfigurationCreateOrUpdateParameters) – The create or update parameters for configuration.

Keyword Arguments

• content_type (str) – Media type of the body sent to the API. Known values are: “text/plain; charset=utf-8” or “application/json”. Default value is “application/json”.

• api_version (str) – Api Version. Default value is “2019-06-01”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

DscConfiguration, or the result of cls(response)

Return type

DscConfiguration

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, automation_account_name: str, configuration_name: str, **kwargs: Any) → None

Delete the dsc configuration identified by configuration name.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• configuration_name (str) – The configuration name.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2019-06-01”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, automation_account_name: str, configuration_name: str, **kwargs: Any) → azure.mgmt.automation.models._models_py3.DscConfiguration

Retrieve the configuration identified by configuration name.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• configuration_name (str) – The configuration name.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2019-06-01”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

DscConfiguration, or the result of cls(response)

Return type

DscConfiguration

Raises

~azure.core.exceptions.HttpResponseError

get_content(resource_group_name: str, automation_account_name: str, configuration_name: str, **kwargs: Any) → str

Retrieve the configuration script identified by configuration name.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• configuration_name (str) – The configuration name.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2019-06-01”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

str, or the result of cls(response)

Return type

str

Raises

~azure.core.exceptions.HttpResponseError

list_by_automation_account(resource_group_name: str, automation_account_name: str, filter: Optional[str] = None, skip: Optional[int] = None, top: Optional[int] = None, inlinecount: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.automation.models._models_py3.DscConfigurationListResult]

Retrieve a list of configurations.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• filter (str) – The filter to apply on the operation. Default value is None.

• skip (int) – The number of rows to skip. Default value is None.

• top (int) – The number of rows to take. Default value is None.

• inlinecount (str) – Return total rows. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2019-06-01”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either DscConfigurationListResult or the result of cls(response)

Return type

ItemPaged[DscConfigurationListResult]

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, automation_account_name: str, configuration_name: str, parameters: Optional[Union[str, azure.mgmt.automation.models._models_py3.DscConfigurationUpdateParameters]] = None, *, content_type: Optional[str] = 'application/json', **kwargs: Any) → azure.mgmt.automation.models._models_py3.DscConfiguration

Create the configuration identified by configuration name.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• configuration_name (str) – The create or update parameters for configuration.

• parameters (str or DscConfigurationUpdateParameters) – The create or update parameters for configuration. Default value is None.

Keyword Arguments

• content_type (str) – Media type of the body sent to the API. Known values are: “text/plain; charset=utf-8” or “application/json”. Default value is “application/json”.

• api_version (str) – Api Version. Default value is “2019-06-01”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

DscConfiguration, or the result of cls(response)

Return type

DscConfiguration

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/automation/models/__init__.py'>

class azure.mgmt.automation.operations.DscNodeConfigurationOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AutomationClient’s dsc_node_configuration attribute.

begin_create_or_update(resource_group_name: str, automation_account_name: str, node_configuration_name: str, parameters: azure.mgmt.automation.models._models_py3.DscNodeConfigurationCreateOrUpdateParameters, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.automation.models._models_py3.DscNodeConfiguration]

Create the node configuration identified by node configuration name.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• node_configuration_name (str) – The Dsc node configuration name.

• parameters (DscNodeConfigurationCreateOrUpdateParameters) – The create or update parameters for configuration.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either DscNodeConfiguration or the result of cls(response)

Return type

LROPoller[DscNodeConfiguration]

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, automation_account_name: str, node_configuration_name: str, **kwargs: Any) → None

Delete the Dsc node configurations by node configuration.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• node_configuration_name (str) – The Dsc node configuration name.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, automation_account_name: str, node_configuration_name: str, **kwargs: Any) → azure.mgmt.automation.models._models_py3.DscNodeConfiguration

Retrieve the Dsc node configurations by node configuration.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• node_configuration_name (str) – The Dsc node configuration name.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

DscNodeConfiguration, or the result of cls(response)

Return type

DscNodeConfiguration

Raises

~azure.core.exceptions.HttpResponseError

list_by_automation_account(resource_group_name: str, automation_account_name: str, filter: Optional[str] = None, skip: Optional[int] = None, top: Optional[int] = None, inlinecount: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.automation.models._models_py3.DscNodeConfigurationListResult]

Retrieve a list of dsc node configurations.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• filter (str) – The filter to apply on the operation. Default value is None.

• skip (int) – The number of rows to skip. Default value is None.

• top (int) – The number of rows to take. Default value is None.

• inlinecount (str) – Return total rows. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either DscNodeConfigurationListResult or the result of cls(response)

Return type

ItemPaged[DscNodeConfigurationListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/automation/models/__init__.py'>

class azure.mgmt.automation.operations.DscNodeOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AutomationClient’s dsc_node attribute.

delete(resource_group_name: str, automation_account_name: str, node_id: str, **kwargs: Any) → None

Delete the dsc node identified by node id.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• node_id (str) – The node id.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, automation_account_name: str, node_id: str, **kwargs: Any) → azure.mgmt.automation.models._models_py3.DscNode

Retrieve the dsc node identified by node id.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• node_id (str) – The node id.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

DscNode, or the result of cls(response)

Return type

DscNode

Raises

~azure.core.exceptions.HttpResponseError

list_by_automation_account(resource_group_name: str, automation_account_name: str, filter: Optional[str] = None, skip: Optional[int] = None, top: Optional[int] = None, inlinecount: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.automation.models._models_py3.DscNodeListResult]

Retrieve a list of dsc nodes.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• filter (str) – The filter to apply on the operation. Default value is None.

• skip (int) – The number of rows to skip. Default value is None.

• top (int) – The number of rows to take. Default value is None.

• inlinecount (str) – Return total rows. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either DscNodeListResult or the result of cls(response)

Return type

ItemPaged[DscNodeListResult]

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, automation_account_name: str, node_id: str, dsc_node_update_parameters: azure.mgmt.automation.models._models_py3.DscNodeUpdateParameters, **kwargs: Any) → azure.mgmt.automation.models._models_py3.DscNode

Update the dsc node.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• node_id (str) – Parameters supplied to the update dsc node.

• dsc_node_update_parameters (DscNodeUpdateParameters) – Parameters supplied to the update dsc node.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

DscNode, or the result of cls(response)

Return type

DscNode

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/automation/models/__init__.py'>

class azure.mgmt.automation.operations.FieldsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AutomationClient’s fields attribute.

list_by_type(resource_group_name: str, automation_account_name: str, module_name: str, type_name: str, **kwargs: Any) → Iterable[azure.mgmt.automation.models._models_py3.TypeFieldListResult]

Retrieve a list of fields of a given type identified by module name.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• module_name (str) – The name of module.

• type_name (str) – The name of type.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either TypeFieldListResult or the result of cls(response)

Return type

ItemPaged[TypeFieldListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/automation/models/__init__.py'>

class azure.mgmt.automation.operations.HybridRunbookWorkerGroupOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AutomationClient’s hybrid_runbook_worker_group attribute.

create(resource_group_name: str, automation_account_name: str, hybrid_runbook_worker_group_name: str, hybrid_runbook_worker_group_creation_parameters: azure.mgmt.automation.models._models_py3.HybridRunbookWorkerGroupCreateOrUpdateParameters, **kwargs: Any) → azure.mgmt.automation.models._models_py3.HybridRunbookWorkerGroup

Create a hybrid runbook worker group.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• hybrid_runbook_worker_group_name (str) – The hybrid runbook worker group name.

• hybrid_runbook_worker_group_creation_parameters (HybridRunbookWorkerGroupCreateOrUpdateParameters) – The create or update parameters for hybrid runbook worker group.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2021-06-22”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

HybridRunbookWorkerGroup, or the result of cls(response)

Return type

HybridRunbookWorkerGroup

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, automation_account_name: str, hybrid_runbook_worker_group_name: str, **kwargs: Any) → None

Delete a hybrid runbook worker group.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• hybrid_runbook_worker_group_name (str) – The hybrid runbook worker group name.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2021-06-22”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, automation_account_name: str, hybrid_runbook_worker_group_name: str, **kwargs: Any) → azure.mgmt.automation.models._models_py3.HybridRunbookWorkerGroup

Retrieve a hybrid runbook worker group.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• hybrid_runbook_worker_group_name (str) – The hybrid runbook worker group name.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2021-06-22”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

HybridRunbookWorkerGroup, or the result of cls(response)

Return type

HybridRunbookWorkerGroup

Raises

~azure.core.exceptions.HttpResponseError

list_by_automation_account(resource_group_name: str, automation_account_name: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.automation.models._models_py3.HybridRunbookWorkerGroupsListResult]

Retrieve a list of hybrid runbook worker groups.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• filter (str) – The filter to apply on the operation. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2021-06-22”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either HybridRunbookWorkerGroupsListResult or the result of cls(response)

Return type

ItemPaged[HybridRunbookWorkerGroupsListResult]

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, automation_account_name: str, hybrid_runbook_worker_group_name: str, parameters: azure.mgmt.automation.models._models_py3.HybridRunbookWorkerGroupCreateOrUpdateParameters, **kwargs: Any) → azure.mgmt.automation.models._models_py3.HybridRunbookWorkerGroup

Update a hybrid runbook worker group.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• hybrid_runbook_worker_group_name (str) – The hybrid runbook worker group name.

• parameters (HybridRunbookWorkerGroupCreateOrUpdateParameters) – The hybrid runbook worker group.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2021-06-22”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

HybridRunbookWorkerGroup, or the result of cls(response)

Return type

HybridRunbookWorkerGroup

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/automation/models/__init__.py'>

class azure.mgmt.automation.operations.HybridRunbookWorkersOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AutomationClient’s hybrid_runbook_workers attribute.

create(resource_group_name: str, automation_account_name: str, hybrid_runbook_worker_group_name: str, hybrid_runbook_worker_id: str, hybrid_runbook_worker_creation_parameters: azure.mgmt.automation.models._models_py3.HybridRunbookWorkerCreateParameters, **kwargs: Any) → azure.mgmt.automation.models._models_py3.HybridRunbookWorker

Create a hybrid runbook worker.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• hybrid_runbook_worker_group_name (str) – The hybrid runbook worker group name.

• hybrid_runbook_worker_id (str) – The hybrid runbook worker id.

• hybrid_runbook_worker_creation_parameters (HybridRunbookWorkerCreateParameters) – The create or update parameters for hybrid runbook worker.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2021-06-22”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

HybridRunbookWorker, or the result of cls(response)

Return type

HybridRunbookWorker

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, automation_account_name: str, hybrid_runbook_worker_group_name: str, hybrid_runbook_worker_id: str, **kwargs: Any) → None

Delete a hybrid runbook worker.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• hybrid_runbook_worker_group_name (str) – The hybrid runbook worker group name.

• hybrid_runbook_worker_id (str) – The hybrid runbook worker id.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2021-06-22”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, automation_account_name: str, hybrid_runbook_worker_group_name: str, hybrid_runbook_worker_id: str, **kwargs: Any) → azure.mgmt.automation.models._models_py3.HybridRunbookWorker

Retrieve a hybrid runbook worker.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• hybrid_runbook_worker_group_name (str) – The hybrid runbook worker group name.

• hybrid_runbook_worker_id (str) – The hybrid runbook worker id.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2021-06-22”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

HybridRunbookWorker, or the result of cls(response)

Return type

HybridRunbookWorker

Raises

~azure.core.exceptions.HttpResponseError

list_by_hybrid_runbook_worker_group(resource_group_name: str, automation_account_name: str, hybrid_runbook_worker_group_name: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.automation.models._models_py3.HybridRunbookWorkersListResult]

Retrieve a list of hybrid runbook workers.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• hybrid_runbook_worker_group_name (str) – The hybrid runbook worker group name.

• filter (str) – The filter to apply on the operation. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2021-06-22”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either HybridRunbookWorkersListResult or the result of cls(response)

Return type

ItemPaged[HybridRunbookWorkersListResult]

Raises

~azure.core.exceptions.HttpResponseError

move(resource_group_name: str, automation_account_name: str, hybrid_runbook_worker_group_name: str, hybrid_runbook_worker_id: str, hybrid_runbook_worker_move_parameters: azure.mgmt.automation.models._models_py3.HybridRunbookWorkerMoveParameters, **kwargs: Any) → None

Move a hybrid worker to a different group.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• hybrid_runbook_worker_group_name (str) – The hybrid runbook worker group name.

• hybrid_runbook_worker_id (str) – The hybrid runbook worker id.

• hybrid_runbook_worker_move_parameters (HybridRunbookWorkerMoveParameters) – The hybrid runbook worker move parameters.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2021-06-22”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/automation/models/__init__.py'>

class azure.mgmt.automation.operations.JobOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AutomationClient’s job attribute.

create(resource_group_name: str, automation_account_name: str, job_name: str, parameters: azure.mgmt.automation.models._models_py3.JobCreateParameters, client_request_id: Optional[str] = None, **kwargs: Any) → azure.mgmt.automation.models._models_py3.Job

Create a job of the runbook.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• job_name (str) – The job name.

• parameters (JobCreateParameters) – The parameters supplied to the create job operation.

• client_request_id (str) – Identifies this specific client request. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2019-06-01”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

Job, or the result of cls(response)

Return type

Job

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, automation_account_name: str, job_name: str, client_request_id: Optional[str] = None, **kwargs: Any) → azure.mgmt.automation.models._models_py3.Job

Retrieve the job identified by job name.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• job_name (str) – The job name.

• client_request_id (str) – Identifies this specific client request. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2019-06-01”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

Job, or the result of cls(response)

Return type

Job

Raises

~azure.core.exceptions.HttpResponseError

get_output(resource_group_name: str, automation_account_name: str, job_name: str, client_request_id: Optional[str] = None, **kwargs: Any) → str

Retrieve the job output identified by job name.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• job_name (str) – The name of the job to be created.

• client_request_id (str) – Identifies this specific client request. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2019-06-01”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

str, or the result of cls(response)

Return type

str

Raises

~azure.core.exceptions.HttpResponseError

get_runbook_content(resource_group_name: str, automation_account_name: str, job_name: str, client_request_id: Optional[str] = None, **kwargs: Any) → str

Retrieve the runbook content of the job identified by job name.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• job_name (str) – The job name.

• client_request_id (str) – Identifies this specific client request. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2019-06-01”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

str, or the result of cls(response)

Return type

str

Raises

~azure.core.exceptions.HttpResponseError

list_by_automation_account(resource_group_name: str, automation_account_name: str, filter: Optional[str] = None, client_request_id: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.automation.models._models_py3.JobListResultV2]

Retrieve a list of jobs.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• filter (str) – The filter to apply on the operation. Default value is None.

• client_request_id (str) – Identifies this specific client request. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2019-06-01”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either JobListResultV2 or the result of cls(response)

Return type

ItemPaged[JobListResultV2]

Raises

~azure.core.exceptions.HttpResponseError

resume(resource_group_name: str, automation_account_name: str, job_name: str, client_request_id: Optional[str] = None, **kwargs: Any) → None

Resume the job identified by jobName.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• job_name (str) – The job name.

• client_request_id (str) – Identifies this specific client request. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2019-06-01”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

stop(resource_group_name: str, automation_account_name: str, job_name: str, client_request_id: Optional[str] = None, **kwargs: Any) → None

Stop the job identified by jobName.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• job_name (str) – The job name.

• client_request_id (str) – Identifies this specific client request. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2019-06-01”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

suspend(resource_group_name: str, automation_account_name: str, job_name: str, client_request_id: Optional[str] = None, **kwargs: Any) → None

Suspend the job identified by job name.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• job_name (str) – The job name.

• client_request_id (str) – Identifies this specific client request. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2019-06-01”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/automation/models/__init__.py'>

class azure.mgmt.automation.operations.JobScheduleOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AutomationClient’s job_schedule attribute.

create(resource_group_name: str, automation_account_name: str, job_schedule_id: str, parameters: azure.mgmt.automation.models._models_py3.JobScheduleCreateParameters, **kwargs: Any) → azure.mgmt.automation.models._models_py3.JobSchedule

Create a job schedule.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• job_schedule_id (str) – The job schedule name.

• parameters (JobScheduleCreateParameters) – The parameters supplied to the create job schedule operation.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

JobSchedule, or the result of cls(response)

Return type

JobSchedule

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, automation_account_name: str, job_schedule_id: str, **kwargs: Any) → None

Delete the job schedule identified by job schedule name.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• job_schedule_id (str) – The job schedule name.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, automation_account_name: str, job_schedule_id: str, **kwargs: Any) → azure.mgmt.automation.models._models_py3.JobSchedule

Retrieve the job schedule identified by job schedule name.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• job_schedule_id (str) – The job schedule name.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

JobSchedule, or the result of cls(response)

Return type

JobSchedule

Raises

~azure.core.exceptions.HttpResponseError

list_by_automation_account(resource_group_name: str, automation_account_name: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.automation.models._models_py3.JobScheduleListResult]

Retrieve a list of job schedules.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• filter (str) – The filter to apply on the operation. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either JobScheduleListResult or the result of cls(response)

Return type

ItemPaged[JobScheduleListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/automation/models/__init__.py'>

class azure.mgmt.automation.operations.JobStreamOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AutomationClient’s job_stream attribute.

get(resource_group_name: str, automation_account_name: str, job_name: str, job_stream_id: str, client_request_id: Optional[str] = None, **kwargs: Any) → azure.mgmt.automation.models._models_py3.JobStream

Retrieve the job stream identified by job stream id.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• job_name (str) – The job name.

• job_stream_id (str) – The job stream id.

• client_request_id (str) – Identifies this specific client request. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2019-06-01”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

JobStream, or the result of cls(response)

Return type

JobStream

Raises

~azure.core.exceptions.HttpResponseError

list_by_job(resource_group_name: str, automation_account_name: str, job_name: str, filter: Optional[str] = None, client_request_id: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.automation.models._models_py3.JobStreamListResult]

Retrieve a list of jobs streams identified by job name.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• job_name (str) – The job name.

• filter (str) – The filter to apply on the operation. Default value is None.

• client_request_id (str) – Identifies this specific client request. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2019-06-01”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either JobStreamListResult or the result of cls(response)

Return type

ItemPaged[JobStreamListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/automation/models/__init__.py'>

class azure.mgmt.automation.operations.KeysOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AutomationClient’s keys attribute.

list_by_automation_account(resource_group_name: str, automation_account_name: str, **kwargs: Any) → azure.mgmt.automation.models._models_py3.KeyListResult

Retrieve the automation keys for an account.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2021-06-22”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

KeyListResult, or the result of cls(response)

Return type

KeyListResult

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/automation/models/__init__.py'>

class azure.mgmt.automation.operations.LinkedWorkspaceOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AutomationClient’s linked_workspace attribute.

get(resource_group_name: str, automation_account_name: str, **kwargs: Any) → azure.mgmt.automation.models._models_py3.LinkedWorkspace

Retrieve the linked workspace for the account id.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

LinkedWorkspace, or the result of cls(response)

Return type

LinkedWorkspace

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/automation/models/__init__.py'>

class azure.mgmt.automation.operations.ModuleOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AutomationClient’s module attribute.

create_or_update(resource_group_name: str, automation_account_name: str, module_name: str, parameters: azure.mgmt.automation.models._models_py3.ModuleCreateOrUpdateParameters, **kwargs: Any) → azure.mgmt.automation.models._models_py3.Module

Create or Update the module identified by module name.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• module_name (str) – The name of module.

• parameters (ModuleCreateOrUpdateParameters) – The create or update parameters for module.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

Module, or the result of cls(response)

Return type

Module

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, automation_account_name: str, module_name: str, **kwargs: Any) → None

Delete the module by name.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• module_name (str) – The module name.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, automation_account_name: str, module_name: str, **kwargs: Any) → azure.mgmt.automation.models._models_py3.Module

Retrieve the module identified by module name.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• module_name (str) – The module name.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

Module, or the result of cls(response)

Return type

Module

Raises

~azure.core.exceptions.HttpResponseError

list_by_automation_account(resource_group_name: str, automation_account_name: str, **kwargs: Any) → Iterable[azure.mgmt.automation.models._models_py3.ModuleListResult]

Retrieve a list of modules.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ModuleListResult or the result of cls(response)

Return type

ItemPaged[ModuleListResult]

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, automation_account_name: str, module_name: str, parameters: azure.mgmt.automation.models._models_py3.ModuleUpdateParameters, **kwargs: Any) → azure.mgmt.automation.models._models_py3.Module

Update the module identified by module name.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• module_name (str) – The name of module.

• parameters (ModuleUpdateParameters) – The update parameters for module.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

Module, or the result of cls(response)

Return type

Module

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/automation/models/__init__.py'>

class azure.mgmt.automation.operations.NodeCountInformationOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AutomationClient’s node_count_information attribute.

get(resource_group_name: str, automation_account_name: str, count_type: Union[str, azure.mgmt.automation.models._automation_client_enums.CountType], **kwargs: Any) → azure.mgmt.automation.models._models_py3.NodeCounts

Retrieve counts for Dsc Nodes.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• count_type (str or CountType) – The type of counts to retrieve.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

NodeCounts, or the result of cls(response)

Return type

NodeCounts

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/automation/models/__init__.py'>

class azure.mgmt.automation.operations.NodeReportsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AutomationClient’s node_reports attribute.

get(resource_group_name: str, automation_account_name: str, node_id: str, report_id: str, **kwargs: Any) → azure.mgmt.automation.models._models_py3.DscNodeReport

Retrieve the Dsc node report data by node id and report id.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• node_id (str) – The Dsc node id.

• report_id (str) – The report id.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

DscNodeReport, or the result of cls(response)

Return type

DscNodeReport

Raises

~azure.core.exceptions.HttpResponseError

get_content(resource_group_name: str, automation_account_name: str, node_id: str, report_id: str, **kwargs: Any) → Any

Retrieve the Dsc node reports by node id and report id.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• node_id (str) – The Dsc node id.

• report_id (str) – The report id.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

any, or the result of cls(response)

Return type

any

Raises

~azure.core.exceptions.HttpResponseError

list_by_node(resource_group_name: str, automation_account_name: str, node_id: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.automation.models._models_py3.DscNodeReportListResult]

Retrieve the Dsc node report list by node id.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• node_id (str) – The parameters supplied to the list operation.

• filter (str) – The filter to apply on the operation. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either DscNodeReportListResult or the result of cls(response)

Return type

ItemPaged[DscNodeReportListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/automation/models/__init__.py'>

class azure.mgmt.automation.operations.ObjectDataTypesOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AutomationClient’s object_data_types attribute.

list_fields_by_module_and_type(resource_group_name: str, automation_account_name: str, module_name: str, type_name: str, **kwargs: Any) → Iterable[azure.mgmt.automation.models._models_py3.TypeFieldListResult]

Retrieve a list of fields of a given type identified by module name.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• module_name (str) – The name of module.

• type_name (str) – The name of type.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either TypeFieldListResult or the result of cls(response)

Return type

ItemPaged[TypeFieldListResult]

Raises

~azure.core.exceptions.HttpResponseError

list_fields_by_type(resource_group_name: str, automation_account_name: str, type_name: str, **kwargs: Any) → Iterable[azure.mgmt.automation.models._models_py3.TypeFieldListResult]

Retrieve a list of fields of a given type across all accessible modules.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• type_name (str) – The name of type.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either TypeFieldListResult or the result of cls(response)

Return type

ItemPaged[TypeFieldListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/automation/models/__init__.py'>

class azure.mgmt.automation.operations.Operations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AutomationClient’s operations attribute.

list(**kwargs: Any) → Iterable[azure.mgmt.automation.models._models_py3.OperationListResult]

Lists all of the available Automation REST API operations.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2021-06-22”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either OperationListResult or the result of cls(response)

Return type

ItemPaged[OperationListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/automation/models/__init__.py'>

class azure.mgmt.automation.operations.PrivateEndpointConnectionsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AutomationClient’s private_endpoint_connections attribute.

begin_create_or_update(resource_group_name: str, automation_account_name: str, private_endpoint_connection_name: str, parameters: azure.mgmt.automation.models._models_py3.PrivateEndpointConnection, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.automation.models._models_py3.PrivateEndpointConnection]

Approve or reject a private endpoint connection with a given name.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• private_endpoint_connection_name (str) – The name of the private endpoint connection.

• parameters (PrivateEndpointConnection) –

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either PrivateEndpointConnection or the result of cls(response)

Return type

LROPoller[PrivateEndpointConnection]

Raises

~azure.core.exceptions.HttpResponseError

begin_delete(resource_group_name: str, automation_account_name: str, private_endpoint_connection_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None]

Deletes a private endpoint connection with a given name.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• private_endpoint_connection_name (str) – The name of the private endpoint connection.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, automation_account_name: str, private_endpoint_connection_name: str, **kwargs: Any) → azure.mgmt.automation.models._models_py3.PrivateEndpointConnection

Gets a private endpoint connection.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• private_endpoint_connection_name (str) – The name of the private endpoint connection.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

PrivateEndpointConnection, or the result of cls(response)

Return type

PrivateEndpointConnection

Raises

~azure.core.exceptions.HttpResponseError

list_by_automation_account(resource_group_name: str, automation_account_name: str, **kwargs: Any) → Iterable[azure.mgmt.automation.models._models_py3.PrivateEndpointConnectionListResult]

List all private endpoint connections on a Automation account.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either PrivateEndpointConnectionListResult or the result of cls(response)

Return type

ItemPaged[PrivateEndpointConnectionListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/automation/models/__init__.py'>

class azure.mgmt.automation.operations.PrivateLinkResourcesOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AutomationClient’s private_link_resources attribute.

automation(resource_group_name: str, automation_account_name: str, **kwargs: Any) → Iterable[azure.mgmt.automation.models._models_py3.PrivateLinkResourceListResult]

Gets the private link resources that need to be created for Automation account.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either PrivateLinkResourceListResult or the result of cls(response)

Return type

ItemPaged[PrivateLinkResourceListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/automation/models/__init__.py'>

class azure.mgmt.automation.operations.Python2PackageOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AutomationClient’s python2_package attribute.

create_or_update(resource_group_name: str, automation_account_name: str, package_name: str, parameters: azure.mgmt.automation.models._models_py3.PythonPackageCreateParameters, **kwargs: Any) → azure.mgmt.automation.models._models_py3.Module

Create or Update the python 2 package identified by package name.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• package_name (str) – The name of python package.

• parameters (PythonPackageCreateParameters) – The create or update parameters for python package.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

Module, or the result of cls(response)

Return type

Module

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, automation_account_name: str, package_name: str, **kwargs: Any) → None

Delete the python 2 package by name.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• package_name (str) – The python package name.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, automation_account_name: str, package_name: str, **kwargs: Any) → azure.mgmt.automation.models._models_py3.Module

Retrieve the python 2 package identified by package name.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• package_name (str) – The python package name.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

Module, or the result of cls(response)

Return type

Module

Raises

~azure.core.exceptions.HttpResponseError

list_by_automation_account(resource_group_name: str, automation_account_name: str, **kwargs: Any) → Iterable[azure.mgmt.automation.models._models_py3.ModuleListResult]

Retrieve a list of python 2 packages.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ModuleListResult or the result of cls(response)

Return type

ItemPaged[ModuleListResult]

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, automation_account_name: str, package_name: str, parameters: azure.mgmt.automation.models._models_py3.PythonPackageUpdateParameters, **kwargs: Any) → azure.mgmt.automation.models._models_py3.Module

Update the python 2 package identified by package name.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• package_name (str) – The name of python package.

• parameters (PythonPackageUpdateParameters) – The update parameters for python package.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

Module, or the result of cls(response)

Return type

Module

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/automation/models/__init__.py'>

class azure.mgmt.automation.operations.RunbookDraftOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AutomationClient’s runbook_draft attribute.

begin_replace_content(resource_group_name: str, automation_account_name: str, runbook_name: str, runbook_content: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[IO]

Replaces the runbook draft content.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• runbook_name (str) – The runbook name.

• runbook_content (str) – The runbook draft content.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2018-06-30”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either IO or the result of cls(response)

Return type

LROPoller[IO]

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, automation_account_name: str, runbook_name: str, **kwargs: Any) → azure.mgmt.automation.models._models_py3.RunbookDraft

Retrieve the runbook draft identified by runbook name.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• runbook_name (str) – The runbook name.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2018-06-30”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

RunbookDraft, or the result of cls(response)

Return type

RunbookDraft

Raises

~azure.core.exceptions.HttpResponseError

get_content(resource_group_name: str, automation_account_name: str, runbook_name: str, **kwargs: Any) → IO

Retrieve the content of runbook draft identified by runbook name.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• runbook_name (str) – The runbook name.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2018-06-30”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

IO, or the result of cls(response)

Return type

IO

Raises

~azure.core.exceptions.HttpResponseError

undo_edit(resource_group_name: str, automation_account_name: str, runbook_name: str, **kwargs: Any) → azure.mgmt.automation.models._models_py3.RunbookDraftUndoEditResult

Undo draft edit to last known published state identified by runbook name.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• runbook_name (str) – The runbook name.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2018-06-30”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

RunbookDraftUndoEditResult, or the result of cls(response)

Return type

RunbookDraftUndoEditResult

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/automation/models/__init__.py'>

class azure.mgmt.automation.operations.RunbookOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AutomationClient’s runbook attribute.

begin_publish(resource_group_name: str, automation_account_name: str, runbook_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None]

Publish runbook draft.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• runbook_name (str) – The parameters supplied to the publish runbook operation.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2018-06-30”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

~azure.core.exceptions.HttpResponseError

create_or_update(resource_group_name: str, automation_account_name: str, runbook_name: str, parameters: azure.mgmt.automation.models._models_py3.RunbookCreateOrUpdateParameters, **kwargs: Any) → azure.mgmt.automation.models._models_py3.Runbook

Create the runbook identified by runbook name.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• runbook_name (str) – The runbook name.

• parameters (RunbookCreateOrUpdateParameters) – The create or update parameters for runbook. Provide either content link for a published runbook or draft, not both.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2018-06-30”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

Runbook, or the result of cls(response)

Return type

Runbook

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, automation_account_name: str, runbook_name: str, **kwargs: Any) → None

Delete the runbook by name.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• runbook_name (str) – The runbook name.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2018-06-30”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, automation_account_name: str, runbook_name: str, **kwargs: Any) → azure.mgmt.automation.models._models_py3.Runbook

Retrieve the runbook identified by runbook name.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• runbook_name (str) – The runbook name.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2018-06-30”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

Runbook, or the result of cls(response)

Return type

Runbook

Raises

~azure.core.exceptions.HttpResponseError

get_content(resource_group_name: str, automation_account_name: str, runbook_name: str, **kwargs: Any) → IO

Retrieve the content of runbook identified by runbook name.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• runbook_name (str) – The runbook name.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2018-06-30”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

IO, or the result of cls(response)

Return type

IO

Raises

~azure.core.exceptions.HttpResponseError

list_by_automation_account(resource_group_name: str, automation_account_name: str, **kwargs: Any) → Iterable[azure.mgmt.automation.models._models_py3.RunbookListResult]

Retrieve a list of runbooks.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2018-06-30”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either RunbookListResult or the result of cls(response)

Return type

ItemPaged[RunbookListResult]

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, automation_account_name: str, runbook_name: str, parameters: azure.mgmt.automation.models._models_py3.RunbookUpdateParameters, **kwargs: Any) → azure.mgmt.automation.models._models_py3.Runbook

Update the runbook identified by runbook name.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• runbook_name (str) – The runbook name.

• parameters (RunbookUpdateParameters) – The update parameters for runbook.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2018-06-30”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

Runbook, or the result of cls(response)

Return type

Runbook

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/automation/models/__init__.py'>

class azure.mgmt.automation.operations.ScheduleOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AutomationClient’s schedule attribute.

create_or_update(resource_group_name: str, automation_account_name: str, schedule_name: str, parameters: azure.mgmt.automation.models._models_py3.ScheduleCreateOrUpdateParameters, **kwargs: Any) → Optional[azure.mgmt.automation.models._models_py3.Schedule]

Create a schedule.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• schedule_name (str) – The schedule name.

• parameters (ScheduleCreateOrUpdateParameters) – The parameters supplied to the create or update schedule operation.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

Schedule, or the result of cls(response)

Return type

Schedule or None

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, automation_account_name: str, schedule_name: str, **kwargs: Any) → None

Delete the schedule identified by schedule name.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• schedule_name (str) – The schedule name.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, automation_account_name: str, schedule_name: str, **kwargs: Any) → azure.mgmt.automation.models._models_py3.Schedule

Retrieve the schedule identified by schedule name.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• schedule_name (str) – The schedule name.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

Schedule, or the result of cls(response)

Return type

Schedule

Raises

~azure.core.exceptions.HttpResponseError

list_by_automation_account(resource_group_name: str, automation_account_name: str, **kwargs: Any) → Iterable[azure.mgmt.automation.models._models_py3.ScheduleListResult]

Retrieve a list of schedules.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ScheduleListResult or the result of cls(response)

Return type

ItemPaged[ScheduleListResult]

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, automation_account_name: str, schedule_name: str, parameters: azure.mgmt.automation.models._models_py3.ScheduleUpdateParameters, **kwargs: Any) → azure.mgmt.automation.models._models_py3.Schedule

Update the schedule identified by schedule name.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• schedule_name (str) – The schedule name.

• parameters (ScheduleUpdateParameters) – The parameters supplied to the update schedule operation.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

Schedule, or the result of cls(response)

Return type

Schedule

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/automation/models/__init__.py'>

class azure.mgmt.automation.operations.SoftwareUpdateConfigurationMachineRunsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AutomationClient’s software_update_configuration_machine_runs attribute.

get_by_id(resource_group_name: str, automation_account_name: str, software_update_configuration_machine_run_id: str, client_request_id: Optional[str] = None, **kwargs: Any) → azure.mgmt.automation.models._models_py3.SoftwareUpdateConfigurationMachineRun

Get a single software update configuration machine run by Id.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• software_update_configuration_machine_run_id (str) – The Id of the software update configuration machine run.

• client_request_id (str) – Identifies this specific client request. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2019-06-01”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

SoftwareUpdateConfigurationMachineRun, or the result of cls(response)

Return type

SoftwareUpdateConfigurationMachineRun

Raises

~azure.core.exceptions.HttpResponseError

list(resource_group_name: str, automation_account_name: str, client_request_id: Optional[str] = None, filter: Optional[str] = None, skip: Optional[str] = None, top: Optional[str] = None, **kwargs: Any) → azure.mgmt.automation.models._models_py3.SoftwareUpdateConfigurationMachineRunListResult

Return list of software update configuration machine runs.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• client_request_id (str) – Identifies this specific client request. Default value is None.

• filter (str) – The filter to apply on the operation. You can use the following filters: ‘properties/osType’, ‘properties/status’, ‘properties/startTime’, and ‘properties/softwareUpdateConfiguration/name’. Default value is None.

• skip (str) – number of entries you skip before returning results. Default value is None.

• top (str) – Maximum number of entries returned in the results collection. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2019-06-01”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

SoftwareUpdateConfigurationMachineRunListResult, or the result of cls(response)

Return type

SoftwareUpdateConfigurationMachineRunListResult

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/automation/models/__init__.py'>

class azure.mgmt.automation.operations.SoftwareUpdateConfigurationRunsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AutomationClient’s software_update_configuration_runs attribute.

get_by_id(resource_group_name: str, automation_account_name: str, software_update_configuration_run_id: str, client_request_id: Optional[str] = None, **kwargs: Any) → azure.mgmt.automation.models._models_py3.SoftwareUpdateConfigurationRun

Get a single software update configuration Run by Id.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• software_update_configuration_run_id (str) – The Id of the software update configuration run.

• client_request_id (str) – Identifies this specific client request. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2019-06-01”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

SoftwareUpdateConfigurationRun, or the result of cls(response)

Return type

SoftwareUpdateConfigurationRun

Raises

~azure.core.exceptions.HttpResponseError

list(resource_group_name: str, automation_account_name: str, client_request_id: Optional[str] = None, filter: Optional[str] = None, skip: Optional[str] = None, top: Optional[str] = None, **kwargs: Any) → azure.mgmt.automation.models._models_py3.SoftwareUpdateConfigurationRunListResult

Return list of software update configuration runs.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• client_request_id (str) – Identifies this specific client request. Default value is None.

• filter (str) – The filter to apply on the operation. You can use the following filters: ‘properties/osType’, ‘properties/status’, ‘properties/startTime’, and ‘properties/softwareUpdateConfiguration/name’. Default value is None.

• skip (str) – Number of entries you skip before returning results. Default value is None.

• top (str) – Maximum number of entries returned in the results collection. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2019-06-01”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

SoftwareUpdateConfigurationRunListResult, or the result of cls(response)

Return type

SoftwareUpdateConfigurationRunListResult

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/automation/models/__init__.py'>

class azure.mgmt.automation.operations.SoftwareUpdateConfigurationsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AutomationClient’s software_update_configurations attribute.

create(resource_group_name: str, automation_account_name: str, software_update_configuration_name: str, parameters: azure.mgmt.automation.models._models_py3.SoftwareUpdateConfiguration, client_request_id: Optional[str] = None, **kwargs: Any) → azure.mgmt.automation.models._models_py3.SoftwareUpdateConfiguration

Create a new software update configuration with the name given in the URI.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• software_update_configuration_name (str) – The name of the software update configuration to be created.

• parameters (SoftwareUpdateConfiguration) – Request body.

• client_request_id (str) – Identifies this specific client request. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2019-06-01”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

SoftwareUpdateConfiguration, or the result of cls(response)

Return type

SoftwareUpdateConfiguration

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, automation_account_name: str, software_update_configuration_name: str, client_request_id: Optional[str] = None, **kwargs: Any) → None

delete a specific software update configuration.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• software_update_configuration_name (str) – The name of the software update configuration to be created.

• client_request_id (str) – Identifies this specific client request. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2019-06-01”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

get_by_name(resource_group_name: str, automation_account_name: str, software_update_configuration_name: str, client_request_id: Optional[str] = None, **kwargs: Any) → azure.mgmt.automation.models._models_py3.SoftwareUpdateConfiguration

Get a single software update configuration by name.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• software_update_configuration_name (str) – The name of the software update configuration to be created.

• client_request_id (str) – Identifies this specific client request. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2019-06-01”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

SoftwareUpdateConfiguration, or the result of cls(response)

Return type

SoftwareUpdateConfiguration

Raises

~azure.core.exceptions.HttpResponseError

list(resource_group_name: str, automation_account_name: str, client_request_id: Optional[str] = None, filter: Optional[str] = None, **kwargs: Any) → azure.mgmt.automation.models._models_py3.SoftwareUpdateConfigurationListResult

Get all software update configurations for the account.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• client_request_id (str) – Identifies this specific client request. Default value is None.

• filter (str) – The filter to apply on the operation. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2019-06-01”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

SoftwareUpdateConfigurationListResult, or the result of cls(response)

Return type

SoftwareUpdateConfigurationListResult

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/automation/models/__init__.py'>

class azure.mgmt.automation.operations.SourceControlOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AutomationClient’s source_control attribute.

create_or_update(resource_group_name: str, automation_account_name: str, source_control_name: str, parameters: azure.mgmt.automation.models._models_py3.SourceControlCreateOrUpdateParameters, **kwargs: Any) → azure.mgmt.automation.models._models_py3.SourceControl

Create a source control.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• source_control_name (str) – The source control name.

• parameters (SourceControlCreateOrUpdateParameters) – The parameters supplied to the create or update source control operation.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

SourceControl, or the result of cls(response)

Return type

SourceControl

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, automation_account_name: str, source_control_name: str, **kwargs: Any) → None

Delete the source control.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• source_control_name (str) – The name of source control.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, automation_account_name: str, source_control_name: str, **kwargs: Any) → azure.mgmt.automation.models._models_py3.SourceControl

Retrieve the source control identified by source control name.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• source_control_name (str) – The name of source control.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

SourceControl, or the result of cls(response)

Return type

SourceControl

Raises

~azure.core.exceptions.HttpResponseError

list_by_automation_account(resource_group_name: str, automation_account_name: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.automation.models._models_py3.SourceControlListResult]

Retrieve a list of source controls.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• filter (str) – The filter to apply on the operation. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SourceControlListResult or the result of cls(response)

Return type

ItemPaged[SourceControlListResult]

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, automation_account_name: str, source_control_name: str, parameters: azure.mgmt.automation.models._models_py3.SourceControlUpdateParameters, **kwargs: Any) → azure.mgmt.automation.models._models_py3.SourceControl

Update a source control.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• source_control_name (str) – The source control name.

• parameters (SourceControlUpdateParameters) – The parameters supplied to the update source control operation.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

SourceControl, or the result of cls(response)

Return type

SourceControl

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/automation/models/__init__.py'>

class azure.mgmt.automation.operations.SourceControlSyncJobOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AutomationClient’s source_control_sync_job attribute.

create(resource_group_name: str, automation_account_name: str, source_control_name: str, source_control_sync_job_id: str, parameters: azure.mgmt.automation.models._models_py3.SourceControlSyncJobCreateParameters, **kwargs: Any) → azure.mgmt.automation.models._models_py3.SourceControlSyncJob

Creates the sync job for a source control.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• source_control_name (str) – The source control name.

• source_control_sync_job_id (str) – The source control sync job id.

• parameters (SourceControlSyncJobCreateParameters) – The parameters supplied to the create source control sync job operation.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

SourceControlSyncJob, or the result of cls(response)

Return type

SourceControlSyncJob

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, automation_account_name: str, source_control_name: str, source_control_sync_job_id: str, **kwargs: Any) → azure.mgmt.automation.models._models_py3.SourceControlSyncJobById

Retrieve the source control sync job identified by job id.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• source_control_name (str) – The source control name.

• source_control_sync_job_id (str) – The source control sync job id.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

SourceControlSyncJobById, or the result of cls(response)

Return type

SourceControlSyncJobById

Raises

~azure.core.exceptions.HttpResponseError

list_by_automation_account(resource_group_name: str, automation_account_name: str, source_control_name: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.automation.models._models_py3.SourceControlSyncJobListResult]

Retrieve a list of source control sync jobs.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• source_control_name (str) – The source control name.

• filter (str) – The filter to apply on the operation. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SourceControlSyncJobListResult or the result of cls(response)

Return type

ItemPaged[SourceControlSyncJobListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/automation/models/__init__.py'>

class azure.mgmt.automation.operations.SourceControlSyncJobStreamsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AutomationClient’s source_control_sync_job_streams attribute.

get(resource_group_name: str, automation_account_name: str, source_control_name: str, source_control_sync_job_id: str, stream_id: str, **kwargs: Any) → azure.mgmt.automation.models._models_py3.SourceControlSyncJobStreamById

Retrieve a sync job stream identified by stream id.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• source_control_name (str) – The source control name.

• source_control_sync_job_id (str) – The source control sync job id.

• stream_id (str) – The id of the sync job stream.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

SourceControlSyncJobStreamById, or the result of cls(response)

Return type

SourceControlSyncJobStreamById

Raises

~azure.core.exceptions.HttpResponseError

list_by_sync_job(resource_group_name: str, automation_account_name: str, source_control_name: str, source_control_sync_job_id: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.automation.models._models_py3.SourceControlSyncJobStreamsListBySyncJob]

Retrieve a list of sync job streams identified by sync job id.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• source_control_name (str) – The source control name.

• source_control_sync_job_id (str) – The source control sync job id.

• filter (str) – The filter to apply on the operation. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SourceControlSyncJobStreamsListBySyncJob or the result of cls(response)

Return type

ItemPaged[SourceControlSyncJobStreamsListBySyncJob]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/automation/models/__init__.py'>

class azure.mgmt.automation.operations.StatisticsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AutomationClient’s statistics attribute.

list_by_automation_account(resource_group_name: str, automation_account_name: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.automation.models._models_py3.StatisticsListResult]

Retrieve the statistics for the account.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• filter (str) – The filter to apply on the operation. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2021-06-22”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either StatisticsListResult or the result of cls(response)

Return type

ItemPaged[StatisticsListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/automation/models/__init__.py'>

class azure.mgmt.automation.operations.TestJobOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AutomationClient’s test_job attribute.

create(resource_group_name: str, automation_account_name: str, runbook_name: str, parameters: azure.mgmt.automation.models._models_py3.TestJobCreateParameters, **kwargs: Any) → azure.mgmt.automation.models._models_py3.TestJob

Create a test job of the runbook.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• runbook_name (str) – The parameters supplied to the create test job operation.

• parameters (TestJobCreateParameters) – The parameters supplied to the create test job operation.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2018-06-30”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

TestJob, or the result of cls(response)

Return type

TestJob

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, automation_account_name: str, runbook_name: str, **kwargs: Any) → azure.mgmt.automation.models._models_py3.TestJob

Retrieve the test job for the specified runbook.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• runbook_name (str) – The runbook name.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2018-06-30”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

TestJob, or the result of cls(response)

Return type

TestJob

Raises

~azure.core.exceptions.HttpResponseError

resume(resource_group_name: str, automation_account_name: str, runbook_name: str, **kwargs: Any) → None

Resume the test job.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• runbook_name (str) – The runbook name.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2018-06-30”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

stop(resource_group_name: str, automation_account_name: str, runbook_name: str, **kwargs: Any) → None

Stop the test job.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• runbook_name (str) – The runbook name.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2018-06-30”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

suspend(resource_group_name: str, automation_account_name: str, runbook_name: str, **kwargs: Any) → None

Suspend the test job.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• runbook_name (str) – The runbook name.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2018-06-30”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/automation/models/__init__.py'>

class azure.mgmt.automation.operations.TestJobStreamsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AutomationClient’s test_job_streams attribute.

get(resource_group_name: str, automation_account_name: str, runbook_name: str, job_stream_id: str, **kwargs: Any) → azure.mgmt.automation.models._models_py3.JobStream

Retrieve a test job stream of the test job identified by runbook name and stream id.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• runbook_name (str) – The runbook name.

• job_stream_id (str) – The job stream id.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2018-06-30”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

JobStream, or the result of cls(response)

Return type

JobStream

Raises

~azure.core.exceptions.HttpResponseError

list_by_test_job(resource_group_name: str, automation_account_name: str, runbook_name: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.automation.models._models_py3.JobStreamListResult]

Retrieve a list of test job streams identified by runbook name.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• runbook_name (str) – The runbook name.

• filter (str) – The filter to apply on the operation. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2018-06-30”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either JobStreamListResult or the result of cls(response)

Return type

ItemPaged[JobStreamListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/automation/models/__init__.py'>

class azure.mgmt.automation.operations.UsagesOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AutomationClient’s usages attribute.

list_by_automation_account(resource_group_name: str, automation_account_name: str, **kwargs: Any) → Iterable[azure.mgmt.automation.models._models_py3.UsageListResult]

Retrieve the usage for the account id.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2021-06-22”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either UsageListResult or the result of cls(response)

Return type

ItemPaged[UsageListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/automation/models/__init__.py'>

class azure.mgmt.automation.operations.VariableOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AutomationClient’s variable attribute.

create_or_update(resource_group_name: str, automation_account_name: str, variable_name: str, parameters: azure.mgmt.automation.models._models_py3.VariableCreateOrUpdateParameters, **kwargs: Any) → azure.mgmt.automation.models._models_py3.Variable

Create a variable.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• variable_name (str) – The variable name.

• parameters (VariableCreateOrUpdateParameters) – The parameters supplied to the create or update variable operation.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

Variable, or the result of cls(response)

Return type

Variable

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, automation_account_name: str, variable_name: str, **kwargs: Any) → None

Delete the variable.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• variable_name (str) – The name of variable.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, automation_account_name: str, variable_name: str, **kwargs: Any) → azure.mgmt.automation.models._models_py3.Variable

Retrieve the variable identified by variable name.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• variable_name (str) – The name of variable.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

Variable, or the result of cls(response)

Return type

Variable

Raises

~azure.core.exceptions.HttpResponseError

list_by_automation_account(resource_group_name: str, automation_account_name: str, **kwargs: Any) → Iterable[azure.mgmt.automation.models._models_py3.VariableListResult]

Retrieve a list of variables.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either VariableListResult or the result of cls(response)

Return type

ItemPaged[VariableListResult]

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, automation_account_name: str, variable_name: str, parameters: azure.mgmt.automation.models._models_py3.VariableUpdateParameters, **kwargs: Any) → azure.mgmt.automation.models._models_py3.Variable

Update a variable.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• variable_name (str) – The variable name.

• parameters (VariableUpdateParameters) – The parameters supplied to the update variable operation.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

Variable, or the result of cls(response)

Return type

Variable

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/automation/models/__init__.py'>

class azure.mgmt.automation.operations.WatcherOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AutomationClient’s watcher attribute.

create_or_update(resource_group_name: str, automation_account_name: str, watcher_name: str, parameters: azure.mgmt.automation.models._models_py3.Watcher, **kwargs: Any) → azure.mgmt.automation.models._models_py3.Watcher

Create the watcher identified by watcher name.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• watcher_name (str) – The watcher name.

• parameters (Watcher) – The create or update parameters for watcher.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

Watcher, or the result of cls(response)

Return type

Watcher

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, automation_account_name: str, watcher_name: str, **kwargs: Any) → None

Delete the watcher by name.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• watcher_name (str) – The watcher name.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, automation_account_name: str, watcher_name: str, **kwargs: Any) → azure.mgmt.automation.models._models_py3.Watcher

Retrieve the watcher identified by watcher name.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• watcher_name (str) – The watcher name.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

Watcher, or the result of cls(response)

Return type

Watcher

Raises

~azure.core.exceptions.HttpResponseError

list_by_automation_account(resource_group_name: str, automation_account_name: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.automation.models._models_py3.WatcherListResult]

Retrieve a list of watchers.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• filter (str) – The filter to apply on the operation. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either WatcherListResult or the result of cls(response)

Return type

ItemPaged[WatcherListResult]

Raises

~azure.core.exceptions.HttpResponseError

start(resource_group_name: str, automation_account_name: str, watcher_name: str, **kwargs: Any) → None

Resume the watcher identified by watcher name.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• watcher_name (str) – The watcher name.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

stop(resource_group_name: str, automation_account_name: str, watcher_name: str, **kwargs: Any) → None

Resume the watcher identified by watcher name.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• watcher_name (str) – The watcher name.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, automation_account_name: str, watcher_name: str, parameters: azure.mgmt.automation.models._models_py3.WatcherUpdateParameters, **kwargs: Any) → azure.mgmt.automation.models._models_py3.Watcher

Update the watcher identified by watcher name.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• watcher_name (str) – The watcher name.

• parameters (WatcherUpdateParameters) – The update parameters for watcher.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2020-01-13-preview”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

Watcher, or the result of cls(response)

Return type

Watcher

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/automation/models/__init__.py'>

class azure.mgmt.automation.operations.WebhookOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through AutomationClient’s webhook attribute.

create_or_update(resource_group_name: str, automation_account_name: str, webhook_name: str, parameters: azure.mgmt.automation.models._models_py3.WebhookCreateOrUpdateParameters, **kwargs: Any) → azure.mgmt.automation.models._models_py3.Webhook

Create the webhook identified by webhook name.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• webhook_name (str) – The webhook name.

• parameters (WebhookCreateOrUpdateParameters) – The create or update parameters for webhook.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2015-10-31”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

Webhook, or the result of cls(response)

Return type

Webhook

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, automation_account_name: str, webhook_name: str, **kwargs: Any) → None

Delete the webhook by name.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• webhook_name (str) – The webhook name.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2015-10-31”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

generate_uri(resource_group_name: str, automation_account_name: str, **kwargs: Any) → str

Generates a Uri for use in creating a webhook.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2015-10-31”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

str, or the result of cls(response)

Return type

str

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, automation_account_name: str, webhook_name: str, **kwargs: Any) → azure.mgmt.automation.models._models_py3.Webhook

Retrieve the webhook identified by webhook name.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• webhook_name (str) – The webhook name.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2015-10-31”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

Webhook, or the result of cls(response)

Return type

Webhook

Raises

~azure.core.exceptions.HttpResponseError

list_by_automation_account(resource_group_name: str, automation_account_name: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.automation.models._models_py3.WebhookListResult]

Retrieve a list of webhooks.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• filter (str) – The filter to apply on the operation. Default value is None.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2015-10-31”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either WebhookListResult or the result of cls(response)

Return type

ItemPaged[WebhookListResult]

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, automation_account_name: str, webhook_name: str, parameters: azure.mgmt.automation.models._models_py3.WebhookUpdateParameters, **kwargs: Any) → azure.mgmt.automation.models._models_py3.Webhook

Update the webhook identified by webhook name.

Parameters

• resource_group_name (str) – Name of an Azure Resource group.

• automation_account_name (str) – The name of the automation account.

• webhook_name (str) – The webhook name.

• parameters (WebhookUpdateParameters) – The update parameters for webhook.

Keyword Arguments

• api_version (str) – Api Version. Default value is “2015-10-31”. Note that overriding this default value may result in unsupported behavior.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

Webhook, or the result of cls(response)

Return type

Webhook

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/automation/models/__init__.py'>