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) → Activity

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

See also

• http://aka.ms/azureautomationsdk/activityoperations

Parameters:

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

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

• module_name (str) – The name of module. Required.

• activity_name (str) – The name of activity. Required.

Returns:

Activity or the result of cls(response)

Return type:

Activity

Raises:

HttpResponseError –

list_by_module(resource_group_name: str, automation_account_name: str, module_name: str, **kwargs: Any) → Iterable[Activity]

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

See also

• http://aka.ms/azureautomationsdk/activityoperations

Parameters:

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

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

• module_name (str) – The name of module. Required.

Returns:

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

Return type:

ItemPaged[Activity]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.11/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) → AgentRegistration

Retrieve the automation agent registration information.

See also

• http://aka.ms/azureautomationsdk/agentregistrationoperations

Parameters:

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

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

Returns:

AgentRegistration or the result of cls(response)

Return type:

AgentRegistration

Raises:

HttpResponseError –

regenerate_key(resource_group_name: str, automation_account_name: str, parameters: _models.AgentRegistrationRegenerateKeyParameter, *, content_type: str = 'application/json', **kwargs: Any) → _models.AgentRegistration

regenerate_key(resource_group_name: str, automation_account_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.AgentRegistration

Regenerate a primary or secondary agent registration key.

See also

• http://aka.ms/azureautomationsdk/agentregistrationoperations

Parameters:

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

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

• parameters (AgentRegistrationRegenerateKeyParameter or IO[bytes]) – The name of the agent registration key to be regenerated. Is either a AgentRegistrationRegenerateKeyParameter type or a IO[bytes] type. Required.

Returns:

AgentRegistration or the result of cls(response)

Return type:

AgentRegistration

Raises:

HttpResponseError –

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.11/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: _models.AutomationAccountCreateOrUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) → _models.AutomationAccount

create_or_update(resource_group_name: str, automation_account_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.AutomationAccount

Create or update automation account.

See also

• http://aka.ms/azureautomationsdk/automationaccountoperations

Parameters:

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

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

• parameters (AutomationAccountCreateOrUpdateParameters or IO[bytes]) – Parameters supplied to the create or update automation account. Is either a AutomationAccountCreateOrUpdateParameters type or a IO[bytes] type. Required.

Returns:

AutomationAccount or the result of cls(response)

Return type:

AutomationAccount

Raises:

HttpResponseError –

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

Delete an automation account.

See also

• http://aka.ms/azureautomationsdk/automationaccountoperations

Parameters:

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

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

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name: str, automation_account_name: str, **kwargs: Any) → AutomationAccount

Get information about an Automation Account.

See also

• http://aka.ms/azureautomationsdk/automationaccountoperations

Parameters:

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

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

Returns:

AutomationAccount or the result of cls(response)

Return type:

AutomationAccount

Raises:

HttpResponseError –

list(**kwargs: Any) → Iterable[AutomationAccount]

Lists the Automation Accounts within an Azure subscription.

Retrieve a list of accounts within a given subscription.

Returns:

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

Return type:

ItemPaged[AutomationAccount]

Raises:

HttpResponseError –

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[AutomationAccount]

Retrieve a list of accounts within a given resource group.

See also

• http://aka.ms/azureautomationsdk/automationaccountoperations

Parameters:

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

Returns:

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

Return type:

ItemPaged[AutomationAccount]

Raises:

HttpResponseError –

update(resource_group_name: str, automation_account_name: str, parameters: _models.AutomationAccountUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) → _models.AutomationAccount

update(resource_group_name: str, automation_account_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.AutomationAccount

Update an automation account.

See also

• http://aka.ms/azureautomationsdk/automationaccountoperations

Parameters:

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

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

• parameters (AutomationAccountUpdateParameters or IO[bytes]) – Parameters supplied to the update automation account. Is either a AutomationAccountUpdateParameters type or a IO[bytes] type. Required.

Returns:

AutomationAccount or the result of cls(response)

Return type:

AutomationAccount

Raises:

HttpResponseError –

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

class azure.mgmt.automation.operations.AutomationClientOperationsMixin

Bases: AutomationClientMixinABC

convert_graph_runbook_content(resource_group_name: str, automation_account_name: str, parameters: _models.GraphicalRunbookContent, *, content_type: str = 'application/json', **kwargs: Any) → _models.GraphicalRunbookContent

convert_graph_runbook_content(resource_group_name: str, automation_account_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.GraphicalRunbookContent

Post operation to serialize or deserialize GraphRunbookContent.

Parameters:

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

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

• parameters (GraphicalRunbookContent or IO[bytes]) – Input data describing the graphical runbook. Is either a GraphicalRunbookContent type or a IO[bytes] type. Required.

Returns:

GraphicalRunbookContent or the result of cls(response)

Return type:

GraphicalRunbookContent

Raises:

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: _models.CertificateCreateOrUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) → _models.Certificate

create_or_update(resource_group_name: str, automation_account_name: str, certificate_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.Certificate

Create a certificate.

See also

• http://aka.ms/azureautomationsdk/certificateoperations

Parameters:

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

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

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

• parameters (CertificateCreateOrUpdateParameters or IO[bytes]) – The parameters supplied to the create or update certificate operation. Is either a CertificateCreateOrUpdateParameters type or a IO[bytes] type. Required.

Returns:

Certificate or the result of cls(response)

Return type:

Certificate

Raises:

HttpResponseError –

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

Delete the certificate.

See also

• http://aka.ms/azureautomationsdk/certificateoperations

Parameters:

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

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

• certificate_name (str) – The name of certificate. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name: str, automation_account_name: str, certificate_name: str, **kwargs: Any) → Certificate

Retrieve the certificate identified by certificate name.

See also

• http://aka.ms/azureautomationsdk/certificateoperations

Parameters:

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

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

• certificate_name (str) – The name of certificate. Required.

Returns:

Certificate or the result of cls(response)

Return type:

Certificate

Raises:

HttpResponseError –

list_by_automation_account(resource_group_name: str, automation_account_name: str, **kwargs: Any) → Iterable[Certificate]

Retrieve a list of certificates.

See also

• http://aka.ms/azureautomationsdk/certificateoperations

Parameters:

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

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

Returns:

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

Return type:

ItemPaged[Certificate]

Raises:

HttpResponseError –

update(resource_group_name: str, automation_account_name: str, certificate_name: str, parameters: _models.CertificateUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) → _models.Certificate

update(resource_group_name: str, automation_account_name: str, certificate_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.Certificate

Update a certificate.

See also

• http://aka.ms/azureautomationsdk/certificateoperations

Parameters:

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

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

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

• parameters (CertificateUpdateParameters or IO[bytes]) – The parameters supplied to the update certificate operation. Is either a CertificateUpdateParameters type or a IO[bytes] type. Required.

Returns:

Certificate or the result of cls(response)

Return type:

Certificate

Raises:

HttpResponseError –

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.11/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: _models.ConnectionCreateOrUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) → _models.Connection

create_or_update(resource_group_name: str, automation_account_name: str, connection_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.Connection

Create or update a connection.

See also

• http://aka.ms/azureautomationsdk/connectionoperations

Parameters:

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

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

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

• parameters (ConnectionCreateOrUpdateParameters or IO[bytes]) – The parameters supplied to the create or update connection operation. Is either a ConnectionCreateOrUpdateParameters type or a IO[bytes] type. Required.

Returns:

Connection or the result of cls(response)

Return type:

Connection

Raises:

HttpResponseError –

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

Delete the connection.

See also

• http://aka.ms/azureautomationsdk/connectionoperations

Parameters:

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

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

• connection_name (str) – The name of connection. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name: str, automation_account_name: str, connection_name: str, **kwargs: Any) → Connection

Retrieve the connection identified by connection name.

See also

• http://aka.ms/azureautomationsdk/connectionoperations

Parameters:

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

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

• connection_name (str) – The name of connection. Required.

Returns:

Connection or the result of cls(response)

Return type:

Connection

Raises:

HttpResponseError –

list_by_automation_account(resource_group_name: str, automation_account_name: str, **kwargs: Any) → Iterable[Connection]

Retrieve a list of connections.

See also

• http://aka.ms/azureautomationsdk/connectionoperations

Parameters:

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

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

Returns:

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

Return type:

ItemPaged[Connection]

Raises:

HttpResponseError –

update(resource_group_name: str, automation_account_name: str, connection_name: str, parameters: _models.ConnectionUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) → _models.Connection

update(resource_group_name: str, automation_account_name: str, connection_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.Connection

Update a connection.

See also

• http://aka.ms/azureautomationsdk/connectionoperations

Parameters:

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

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

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

• parameters (ConnectionUpdateParameters or IO[bytes]) – The parameters supplied to the update a connection operation. Is either a ConnectionUpdateParameters type or a IO[bytes] type. Required.

Returns:

Connection or the result of cls(response)

Return type:

Connection

Raises:

HttpResponseError –

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.11/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: _models.ConnectionTypeCreateOrUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) → _models.ConnectionType

create_or_update(resource_group_name: str, automation_account_name: str, connection_type_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.ConnectionType

Create a connection type.

See also

• http://aka.ms/azureautomationsdk/connectiontypeoperations

Parameters:

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

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

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

• parameters (ConnectionTypeCreateOrUpdateParameters or IO[bytes]) – The parameters supplied to the create or update connection type operation. Is either a ConnectionTypeCreateOrUpdateParameters type or a IO[bytes] type. Required.

Returns:

ConnectionType or the result of cls(response)

Return type:

ConnectionType

Raises:

HttpResponseError –

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

Delete the connection type.

See also

• http://aka.ms/azureautomationsdk/connectiontypeoperations

Parameters:

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

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

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

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name: str, automation_account_name: str, connection_type_name: str, **kwargs: Any) → ConnectionType

Retrieve the connection type identified by connection type name.

See also

• http://aka.ms/azureautomationsdk/connectiontypeoperations

Parameters:

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

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

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

Returns:

ConnectionType or the result of cls(response)

Return type:

ConnectionType

Raises:

HttpResponseError –

list_by_automation_account(resource_group_name: str, automation_account_name: str, **kwargs: Any) → Iterable[ConnectionType]

Retrieve a list of connection types.

See also

• http://aka.ms/azureautomationsdk/connectiontypeoperations

Parameters:

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

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

Returns:

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

Return type:

ItemPaged[ConnectionType]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.11/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: _models.CredentialCreateOrUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) → _models.Credential

create_or_update(resource_group_name: str, automation_account_name: str, credential_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.Credential

Create a credential.

See also

• http://aka.ms/azureautomationsdk/credentialoperations

Parameters:

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

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

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

• parameters (CredentialCreateOrUpdateParameters or IO[bytes]) – The parameters supplied to the create or update credential operation. Is either a CredentialCreateOrUpdateParameters type or a IO[bytes] type. Required.

Returns:

Credential or the result of cls(response)

Return type:

Credential

Raises:

HttpResponseError –

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

Delete the credential.

See also

• http://aka.ms/azureautomationsdk/credentialoperations

Parameters:

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

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

• credential_name (str) – The name of credential. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name: str, automation_account_name: str, credential_name: str, **kwargs: Any) → Credential

Retrieve the credential identified by credential name.

See also

• http://aka.ms/azureautomationsdk/credentialoperations

Parameters:

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

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

• credential_name (str) – The name of credential. Required.

Returns:

Credential or the result of cls(response)

Return type:

Credential

Raises:

HttpResponseError –

list_by_automation_account(resource_group_name: str, automation_account_name: str, **kwargs: Any) → Iterable[Credential]

Retrieve a list of credentials.

See also

• http://aka.ms/azureautomationsdk/credentialoperations

Parameters:

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

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

Returns:

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

Return type:

ItemPaged[Credential]

Raises:

HttpResponseError –

update(resource_group_name: str, automation_account_name: str, credential_name: str, parameters: _models.CredentialUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) → _models.Credential

update(resource_group_name: str, automation_account_name: str, credential_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.Credential

Update a credential.

See also

• http://aka.ms/azureautomationsdk/credentialoperations

Parameters:

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

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

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

• parameters (CredentialUpdateParameters or IO[bytes]) – The parameters supplied to the Update credential operation. Is either a CredentialUpdateParameters type or a IO[bytes] type. Required.

Returns:

Credential or the result of cls(response)

Return type:

Credential

Raises:

HttpResponseError –

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

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

Bases: object

Warning

DO NOT instantiate this class directly.

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

list_by_subscription(**kwargs: Any) → DeletedAutomationAccountListResult

Retrieve deleted automation account.

Returns:

DeletedAutomationAccountListResult or the result of cls(response)

Return type:

DeletedAutomationAccountListResult

Raises:

HttpResponseError –

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.11/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: _models.DscCompilationJobCreateParameters, *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.DscCompilationJob]

begin_create(resource_group_name: str, automation_account_name: str, compilation_job_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.DscCompilationJob]

Creates the Dsc compilation job of the configuration.

See also

• http://aka.ms/azureautomationsdk/dscconfigurationcompilejoboperations

Parameters:

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

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

• compilation_job_name (str) – The DSC configuration Id. Required.

• parameters (DscCompilationJobCreateParameters or IO[bytes]) – The parameters supplied to the create compilation job operation. Is either a DscCompilationJobCreateParameters type or a IO[bytes] type. Required.

Returns:

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

Return type:

LROPoller[DscCompilationJob]

Raises:

HttpResponseError –

get(resource_group_name: str, automation_account_name: str, compilation_job_name: str, **kwargs: Any) → DscCompilationJob

Retrieve the Dsc configuration compilation job identified by job id.

See also

• http://aka.ms/azureautomationsdk/dsccompilationjoboperations

Parameters:

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

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

• compilation_job_name (str) – The DSC configuration Id. Required.

Returns:

DscCompilationJob or the result of cls(response)

Return type:

DscCompilationJob

Raises:

HttpResponseError –

get_stream(resource_group_name: str, automation_account_name: str, job_id: str, job_stream_id: str, **kwargs: Any) → JobStream

Retrieve the job stream identified by job stream id.

See also

• http://aka.ms/azureautomationsdk/jobstreamoperations

Parameters:

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

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

• job_id (str) – The job id. Required.

• job_stream_id (str) – The job stream id. Required.

Returns:

JobStream or the result of cls(response)

Return type:

JobStream

Raises:

HttpResponseError –

list_by_automation_account(resource_group_name: str, automation_account_name: str, filter: str | None = None, **kwargs: Any) → Iterable[DscCompilationJob]

Retrieve a list of dsc compilation jobs.

See also

• http://aka.ms/azureautomationsdk/compilationjoboperations

Parameters:

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

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

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

Returns:

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

Return type:

ItemPaged[DscCompilationJob]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.11/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) → JobStreamListResult

Retrieve all the job streams for the compilation Job.

See also

• http://aka.ms/azureautomationsdk/jobstreamoperations

Parameters:

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

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

• job_id (str) – The job id. Required.

Returns:

JobStreamListResult or the result of cls(response)

Return type:

JobStreamListResult

Raises:

HttpResponseError –

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.11/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: _models.DscConfigurationCreateOrUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) → _models.DscConfiguration

create_or_update(resource_group_name: str, automation_account_name: str, configuration_name: str, parameters: str, *, content_type: str | None = None, **kwargs: Any) → _models.DscConfiguration

Create the configuration identified by configuration name.

See also

• http://aka.ms/azureautomationsdk/configurationoperations

Parameters:

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

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

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

• parameters (DscConfigurationCreateOrUpdateParameters or str) – The create or update parameters for configuration. Is either a DscConfigurationCreateOrUpdateParameters type or a str type. Required.

Returns:

DscConfiguration or the result of cls(response)

Return type:

DscConfiguration

Raises:

HttpResponseError –

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

Delete the dsc configuration identified by configuration name.

See also

• http://aka.ms/azureautomationsdk/configurationoperations

Parameters:

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

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

• configuration_name (str) – The configuration name. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

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

Retrieve the configuration identified by configuration name.

See also

• http://aka.ms/azureautomationsdk/configurationoperations

Parameters:

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

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

• configuration_name (str) – The configuration name. Required.

Returns:

DscConfiguration or the result of cls(response)

Return type:

DscConfiguration

Raises:

HttpResponseError –

get_content(resource_group_name: str, automation_account_name: str, configuration_name: str, **kwargs: Any) → Iterator[bytes]

Retrieve the configuration script identified by configuration name.

See also

• http://aka.ms/azureautomationsdk/configurationoperations

Parameters:

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

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

• configuration_name (str) – The configuration name. Required.

Returns:

Iterator[bytes] or the result of cls(response)

Return type:

Iterator[bytes]

Raises:

HttpResponseError –

list_by_automation_account(resource_group_name: str, automation_account_name: str, filter: str | None = None, skip: int | None = None, top: int | None = None, inlinecount: str | None = None, **kwargs: Any) → Iterable[DscConfiguration]

Retrieve a list of configurations.

See also

• http://aka.ms/azureautomationsdk/configurationoperations

Parameters:

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

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

• 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.

Returns:

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

Return type:

ItemPaged[DscConfiguration]

Raises:

HttpResponseError –

update(resource_group_name: str, automation_account_name: str, configuration_name: str, parameters: _models.DscConfigurationUpdateParameters | None = None, *, content_type: str = 'application/json', **kwargs: Any) → _models.DscConfiguration

update(resource_group_name: str, automation_account_name: str, configuration_name: str, parameters: str | None = None, *, content_type: str | None = None, **kwargs: Any) → _models.DscConfiguration

Create the configuration identified by configuration name.

See also

• http://aka.ms/azureautomationsdk/configurationoperations

Parameters:

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

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

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

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

Returns:

DscConfiguration or the result of cls(response)

Return type:

DscConfiguration

Raises:

HttpResponseError –

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.11/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: _models.DscNodeConfigurationCreateOrUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.DscNodeConfiguration]

begin_create_or_update(resource_group_name: str, automation_account_name: str, node_configuration_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.DscNodeConfiguration]

Create the node configuration identified by node configuration name.

See also

• http://aka.ms/azureautomationsdk/dscnodeconfigurations

Parameters:

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

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

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

• parameters (DscNodeConfigurationCreateOrUpdateParameters or IO[bytes]) – The create or update parameters for configuration. Is either a DscNodeConfigurationCreateOrUpdateParameters type or a IO[bytes] type. Required.

Returns:

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

Return type:

LROPoller[DscNodeConfiguration]

Raises:

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.

See also

• http://aka.ms/azureautomationsdk/dscnodeconfigurations

Parameters:

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

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

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

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name: str, automation_account_name: str, node_configuration_name: str, **kwargs: Any) → DscNodeConfiguration

Retrieve the Dsc node configurations by node configuration.

See also

• http://aka.ms/azureautomationsdk/dscnodeconfigurations

Parameters:

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

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

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

Returns:

DscNodeConfiguration or the result of cls(response)

Return type:

DscNodeConfiguration

Raises:

HttpResponseError –

list_by_automation_account(resource_group_name: str, automation_account_name: str, filter: str | None = None, skip: int | None = None, top: int | None = None, inlinecount: str | None = None, **kwargs: Any) → Iterable[DscNodeConfiguration]

Retrieve a list of dsc node configurations.

See also

• http://aka.ms/azureautomationsdk/dscnodeconfigurations

Parameters:

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

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

• 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.

Returns:

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

Return type:

ItemPaged[DscNodeConfiguration]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.11/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.

See also

• http://aka.ms/azureautomationsdk/dscnodeoperations

Parameters:

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

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

• node_id (str) – The node id. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name: str, automation_account_name: str, node_id: str, **kwargs: Any) → DscNode

Retrieve the dsc node identified by node id.

See also

• http://aka.ms/azureautomationsdk/dscnodeoperations

Parameters:

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

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

• node_id (str) – The node id. Required.

Returns:

DscNode or the result of cls(response)

Return type:

DscNode

Raises:

HttpResponseError –

list_by_automation_account(resource_group_name: str, automation_account_name: str, filter: str | None = None, skip: int | None = None, top: int | None = None, inlinecount: str | None = None, **kwargs: Any) → Iterable[DscNode]

Retrieve a list of dsc nodes.

See also

• http://aka.ms/azureautomationsdk/dscnodeoperations

Parameters:

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

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

• 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.

Returns:

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

Return type:

ItemPaged[DscNode]

Raises:

HttpResponseError –

update(resource_group_name: str, automation_account_name: str, node_id: str, dsc_node_update_parameters: _models.DscNodeUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) → _models.DscNode

update(resource_group_name: str, automation_account_name: str, node_id: str, dsc_node_update_parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.DscNode

Update the dsc node.

See also

• http://aka.ms/azureautomationsdk/dscnodeoperations

Parameters:

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

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

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

• dsc_node_update_parameters (DscNodeUpdateParameters or IO[bytes]) – Parameters supplied to the update dsc node. Is either a DscNodeUpdateParameters type or a IO[bytes] type. Required.

Returns:

DscNode or the result of cls(response)

Return type:

DscNode

Raises:

HttpResponseError –

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.11/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[TypeField]

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

See also

• http://aka.ms/azureautomationsdk/typefieldoperations

Parameters:

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

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

• module_name (str) – The name of module. Required.

• type_name (str) – The name of type. Required.

Returns:

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

Return type:

ItemPaged[TypeField]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.11/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: _models.HybridRunbookWorkerGroupCreateOrUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) → _models.HybridRunbookWorkerGroup

create(resource_group_name: str, automation_account_name: str, hybrid_runbook_worker_group_name: str, hybrid_runbook_worker_group_creation_parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.HybridRunbookWorkerGroup

Create a hybrid runbook worker group.

See also

• http://aka.ms/azureautomationsdk/hybridrunbookworkergroupoperations

Parameters:

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

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

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

• hybrid_runbook_worker_group_creation_parameters (HybridRunbookWorkerGroupCreateOrUpdateParameters or IO[bytes]) – The create or update parameters for hybrid runbook worker group. Is either a HybridRunbookWorkerGroupCreateOrUpdateParameters type or a IO[bytes] type. Required.

Returns:

HybridRunbookWorkerGroup or the result of cls(response)

Return type:

HybridRunbookWorkerGroup

Raises:

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.

See also

• http://aka.ms/azureautomationsdk/hybridrunbookworkergroupoperations

Parameters:

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

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

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

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name: str, automation_account_name: str, hybrid_runbook_worker_group_name: str, **kwargs: Any) → HybridRunbookWorkerGroup

Retrieve a hybrid runbook worker group.

See also

• http://aka.ms/azureautomationsdk/hybridrunbookworkergroupoperations

Parameters:

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

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

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

Returns:

HybridRunbookWorkerGroup or the result of cls(response)

Return type:

HybridRunbookWorkerGroup

Raises:

HttpResponseError –

list_by_automation_account(resource_group_name: str, automation_account_name: str, filter: str | None = None, **kwargs: Any) → Iterable[HybridRunbookWorkerGroup]

Retrieve a list of hybrid runbook worker groups.

See also

• http://aka.ms/azureautomationsdk/hybridrunbookworkergroupoperations

Parameters:

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

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

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

Returns:

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

Return type:

ItemPaged[HybridRunbookWorkerGroup]

Raises:

HttpResponseError –

update(resource_group_name: str, automation_account_name: str, hybrid_runbook_worker_group_name: str, hybrid_runbook_worker_group_updation_parameters: _models.HybridRunbookWorkerGroupCreateOrUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) → _models.HybridRunbookWorkerGroup

update(resource_group_name: str, automation_account_name: str, hybrid_runbook_worker_group_name: str, hybrid_runbook_worker_group_updation_parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.HybridRunbookWorkerGroup

Update a hybrid runbook worker group.

See also

• http://aka.ms/azureautomationsdk/hybridrunbookworkergroupoperations

Parameters:

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

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

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

• hybrid_runbook_worker_group_updation_parameters (HybridRunbookWorkerGroupCreateOrUpdateParameters or IO[bytes]) – The hybrid runbook worker group. Is either a HybridRunbookWorkerGroupCreateOrUpdateParameters type or a IO[bytes] type. Required.

Returns:

HybridRunbookWorkerGroup or the result of cls(response)

Return type:

HybridRunbookWorkerGroup

Raises:

HttpResponseError –

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.11/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: _models.HybridRunbookWorkerCreateParameters, *, content_type: str = 'application/json', **kwargs: Any) → _models.HybridRunbookWorker

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: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.HybridRunbookWorker

Create a hybrid runbook worker.

See also

• http://aka.ms/azureautomationsdk/hybridrunbookworkeroperations

Parameters:

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

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

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

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

• hybrid_runbook_worker_creation_parameters (HybridRunbookWorkerCreateParameters or IO[bytes]) – The create or update parameters for hybrid runbook worker. Is either a HybridRunbookWorkerCreateParameters type or a IO[bytes] type. Required.

Returns:

HybridRunbookWorker or the result of cls(response)

Return type:

HybridRunbookWorker

Raises:

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.

See also

• http://aka.ms/azureautomationsdk/hybridrunbookworkeroperations

Parameters:

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

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

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

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

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name: str, automation_account_name: str, hybrid_runbook_worker_group_name: str, hybrid_runbook_worker_id: str, **kwargs: Any) → HybridRunbookWorker

Retrieve a hybrid runbook worker.

See also

• http://aka.ms/azureautomationsdk/hybridrunbookworkeroperations

Parameters:

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

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

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

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

Returns:

HybridRunbookWorker or the result of cls(response)

Return type:

HybridRunbookWorker

Raises:

HttpResponseError –

list_by_hybrid_runbook_worker_group(resource_group_name: str, automation_account_name: str, hybrid_runbook_worker_group_name: str, filter: str | None = None, **kwargs: Any) → Iterable[HybridRunbookWorker]

Retrieve a list of hybrid runbook workers.

See also

• http://aka.ms/azureautomationsdk/hybridrunbookworkeroperations

Parameters:

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

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

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

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

Returns:

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

Return type:

ItemPaged[HybridRunbookWorker]

Raises:

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: _models.HybridRunbookWorkerMoveParameters, *, content_type: str = 'application/json', **kwargs: Any) → None

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: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → None

Move a hybrid worker to a different group.

See also

• http://aka.ms/azureautomationsdk/hybridrunbookworkeroperations

Parameters:

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

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

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

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

• hybrid_runbook_worker_move_parameters (HybridRunbookWorkerMoveParameters or IO[bytes]) – The hybrid runbook worker move parameters. Is either a HybridRunbookWorkerMoveParameters type or a IO[bytes] type. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.11/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: _models.JobCreateParameters, client_request_id: str | None = None, *, content_type: str = 'application/json', **kwargs: Any) → _models.Job

create(resource_group_name: str, automation_account_name: str, job_name: str, parameters: IO[bytes], client_request_id: str | None = None, *, content_type: str = 'application/json', **kwargs: Any) → _models.Job

Create a job of the runbook.

See also

• http://aka.ms/azureautomationsdk/joboperations

Parameters:

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

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

• job_name (str) – The job name. Required.

• parameters (JobCreateParameters or IO[bytes]) – The parameters supplied to the create job operation. Is either a JobCreateParameters type or a IO[bytes] type. Required.

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

Returns:

Job or the result of cls(response)

Return type:

Job

Raises:

HttpResponseError –

get(resource_group_name: str, automation_account_name: str, job_name: str, client_request_id: str | None = None, **kwargs: Any) → Job

Retrieve the job identified by job name.

See also

• http://aka.ms/azureautomationsdk/joboperations

Parameters:

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

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

• job_name (str) – The job name. Required.

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

Returns:

Job or the result of cls(response)

Return type:

Job

Raises:

HttpResponseError –

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

Retrieve the job output identified by job name.

See also

• http://aka.ms/azureautomationsdk/joboperations

Parameters:

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

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

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

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

Returns:

str or the result of cls(response)

Return type:

str

Raises:

HttpResponseError –

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

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

See also

• http://aka.ms/azureautomationsdk/joboperations

Parameters:

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

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

• job_name (str) – The job name. Required.

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

Returns:

str or the result of cls(response)

Return type:

str

Raises:

HttpResponseError –

list_by_automation_account(resource_group_name: str, automation_account_name: str, filter: str | None = None, client_request_id: str | None = None, **kwargs: Any) → Iterable[JobCollectionItem]

Retrieve a list of jobs.

See also

• http://aka.ms/azureautomationsdk/joboperations

Parameters:

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

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

• 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.

Returns:

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

Return type:

ItemPaged[JobCollectionItem]

Raises:

HttpResponseError –

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

Resume the job identified by jobName.

See also

• http://aka.ms/azureautomationsdk/joboperations

Parameters:

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

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

• job_name (str) – The job name. Required.

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

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

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

Stop the job identified by jobName.

See also

• http://aka.ms/azureautomationsdk/joboperations

Parameters:

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

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

• job_name (str) – The job name. Required.

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

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

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

Suspend the job identified by job name.

See also

• http://aka.ms/azureautomationsdk/joboperations

Parameters:

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

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

• job_name (str) – The job name. Required.

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

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.11/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: _models.JobScheduleCreateParameters, *, content_type: str = 'application/json', **kwargs: Any) → _models.JobSchedule

create(resource_group_name: str, automation_account_name: str, job_schedule_id: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.JobSchedule

Create a job schedule.

See also

• http://aka.ms/azureautomationsdk/jobscheduleoperations

Parameters:

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

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

• job_schedule_id (str) – The job schedule name. Required.

• parameters (JobScheduleCreateParameters or IO[bytes]) – The parameters supplied to the create job schedule operation. Is either a JobScheduleCreateParameters type or a IO[bytes] type. Required.

Returns:

JobSchedule or the result of cls(response)

Return type:

JobSchedule

Raises:

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.

See also

• http://aka.ms/azureautomationsdk/jobscheduleoperations

Parameters:

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

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

• job_schedule_id (str) – The job schedule name. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name: str, automation_account_name: str, job_schedule_id: str, **kwargs: Any) → JobSchedule

Retrieve the job schedule identified by job schedule name.

See also

• http://aka.ms/azureautomationsdk/jobscheduleoperations

Parameters:

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

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

• job_schedule_id (str) – The job schedule name. Required.

Returns:

JobSchedule or the result of cls(response)

Return type:

JobSchedule

Raises:

HttpResponseError –

list_by_automation_account(resource_group_name: str, automation_account_name: str, filter: str | None = None, **kwargs: Any) → Iterable[JobSchedule]

Retrieve a list of job schedules.

See also

• http://aka.ms/azureautomationsdk/jobscheduleoperations

Parameters:

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

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

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

Returns:

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

Return type:

ItemPaged[JobSchedule]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.11/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: str | None = None, **kwargs: Any) → JobStream

Retrieve the job stream identified by job stream id.

See also

• http://aka.ms/azureautomationsdk/jobstreamoperations

Parameters:

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

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

• job_name (str) – The job name. Required.

• job_stream_id (str) – The job stream id. Required.

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

Returns:

JobStream or the result of cls(response)

Return type:

JobStream

Raises:

HttpResponseError –

list_by_job(resource_group_name: str, automation_account_name: str, job_name: str, filter: str | None = None, client_request_id: str | None = None, **kwargs: Any) → Iterable[JobStream]

Retrieve a list of jobs streams identified by job name.

See also

• http://aka.ms/azureautomationsdk/jobstreamoperations

Parameters:

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

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

• job_name (str) – The job name. Required.

• 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.

Returns:

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

Return type:

ItemPaged[JobStream]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.11/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) → KeyListResult

Retrieve the automation keys for an account.

Parameters:

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

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

Returns:

KeyListResult or the result of cls(response)

Return type:

KeyListResult

Raises:

HttpResponseError –

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.11/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) → LinkedWorkspace

Retrieve the linked workspace for the account id.

See also

• http://aka.ms/azureautomationsdk/linkedworkspaceoperations

Parameters:

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

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

Returns:

LinkedWorkspace or the result of cls(response)

Return type:

LinkedWorkspace

Raises:

HttpResponseError –

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.11/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: _models.ModuleCreateOrUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) → _models.Module

create_or_update(resource_group_name: str, automation_account_name: str, module_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.Module

Create or Update the module identified by module name.

See also

• http://aka.ms/azureautomationsdk/moduleoperations

Parameters:

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

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

• module_name (str) – The name of module. Required.

• parameters (ModuleCreateOrUpdateParameters or IO[bytes]) – The create or update parameters for module. Is either a ModuleCreateOrUpdateParameters type or a IO[bytes] type. Required.

Returns:

Module or the result of cls(response)

Return type:

Module

Raises:

HttpResponseError –

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

Delete the module by name.

See also

• http://aka.ms/azureautomationsdk/moduleoperations

Parameters:

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

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

• module_name (str) – The module name. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name: str, automation_account_name: str, module_name: str, **kwargs: Any) → Module

Retrieve the module identified by module name.

See also

• http://aka.ms/azureautomationsdk/moduleoperations

Parameters:

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

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

• module_name (str) – The module name. Required.

Returns:

Module or the result of cls(response)

Return type:

Module

Raises:

HttpResponseError –

list_by_automation_account(resource_group_name: str, automation_account_name: str, **kwargs: Any) → Iterable[Module]

Retrieve a list of modules.

See also

• http://aka.ms/azureautomationsdk/moduleoperations

Parameters:

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

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

Returns:

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

Return type:

ItemPaged[Module]

Raises:

HttpResponseError –

update(resource_group_name: str, automation_account_name: str, module_name: str, parameters: _models.ModuleUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) → _models.Module

update(resource_group_name: str, automation_account_name: str, module_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.Module

Update the module identified by module name.

See also

• http://aka.ms/azureautomationsdk/moduleoperations

Parameters:

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

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

• module_name (str) – The name of module. Required.

• parameters (ModuleUpdateParameters or IO[bytes]) – The update parameters for module. Is either a ModuleUpdateParameters type or a IO[bytes] type. Required.

Returns:

Module or the result of cls(response)

Return type:

Module

Raises:

HttpResponseError –

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.11/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: str | CountType, **kwargs: Any) → NodeCounts

Retrieve counts for Dsc Nodes.

See also

• http://aka.ms/azureautomationsdk/nodecounts

Parameters:

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

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

• count_type (str or CountType) – The type of counts to retrieve. Known values are: “status” and “nodeconfiguration”. Required.

Returns:

NodeCounts or the result of cls(response)

Return type:

NodeCounts

Raises:

HttpResponseError –

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.11/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) → DscNodeReport

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

See also

• http://aka.ms/azureautomationsdk/dscnodereportoperations

Parameters:

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

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

• node_id (str) – The Dsc node id. Required.

• report_id (str) – The report id. Required.

Returns:

DscNodeReport or the result of cls(response)

Return type:

DscNodeReport

Raises:

HttpResponseError –

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

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

See also

• http://aka.ms/azureautomationsdk/dscnodereportoperations

Parameters:

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

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

• node_id (str) – The Dsc node id. Required.

• report_id (str) – The report id. Required.

Returns:

JSON or the result of cls(response)

Return type:

JSON

Raises:

HttpResponseError –

list_by_node(resource_group_name: str, automation_account_name: str, node_id: str, filter: str | None = None, **kwargs: Any) → Iterable[DscNodeReport]

Retrieve the Dsc node report list by node id.

See also

• http://aka.ms/azureautomationsdk/dscnodereportoperations

Parameters:

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

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

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

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

Returns:

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

Return type:

ItemPaged[DscNodeReport]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.11/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[TypeField]

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

See also

• http://aka.ms/azureautomationsdk/objectdatatypeoperations

Parameters:

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

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

• module_name (str) – The name of module. Required.

• type_name (str) – The name of type. Required.

Returns:

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

Return type:

ItemPaged[TypeField]

Raises:

HttpResponseError –

list_fields_by_type(resource_group_name: str, automation_account_name: str, type_name: str, **kwargs: Any) → Iterable[TypeField]

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

See also

• http://aka.ms/azureautomationsdk/objectdatatypeoperations

Parameters:

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

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

• type_name (str) – The name of type. Required.

Returns:

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

Return type:

ItemPaged[TypeField]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.11/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[Operation]

Lists all of the available Automation REST API operations.

Returns:

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

Return type:

ItemPaged[Operation]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.11/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: _models.PrivateEndpointConnection, *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.PrivateEndpointConnection]

begin_create_or_update(resource_group_name: str, automation_account_name: str, private_endpoint_connection_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → LROPoller[_models.PrivateEndpointConnection]

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

Parameters:

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

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

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

• parameters (PrivateEndpointConnection or IO[bytes]) – Is either a PrivateEndpointConnection type or a IO[bytes] type. Required.

Returns:

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

Return type:

LROPoller[PrivateEndpointConnection]

Raises:

HttpResponseError –

begin_delete(resource_group_name: str, automation_account_name: str, private_endpoint_connection_name: str, **kwargs: Any) → LROPoller[None]

Deletes a private endpoint connection with a given name.

Parameters:

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

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

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

Returns:

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

Return type:

LROPoller[None]

Raises:

HttpResponseError –

get(resource_group_name: str, automation_account_name: str, private_endpoint_connection_name: str, **kwargs: Any) → PrivateEndpointConnection

Gets a private endpoint connection.

Parameters:

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

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

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

Returns:

PrivateEndpointConnection or the result of cls(response)

Return type:

PrivateEndpointConnection

Raises:

HttpResponseError –

list_by_automation_account(resource_group_name: str, automation_account_name: str, **kwargs: Any) → Iterable[PrivateEndpointConnection]

List all private endpoint connections on a Automation account.

Parameters:

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

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

Returns:

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

Return type:

ItemPaged[PrivateEndpointConnection]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.11/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[PrivateLinkResource]

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

Parameters:

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

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

Returns:

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

Return type:

ItemPaged[PrivateLinkResource]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.11/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: _models.PythonPackageCreateParameters, *, content_type: str = 'application/json', **kwargs: Any) → _models.Module

create_or_update(resource_group_name: str, automation_account_name: str, package_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.Module

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

See also

• http://aka.ms/azureautomationsdk/moduleoperations

Parameters:

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

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

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

• parameters (PythonPackageCreateParameters or IO[bytes]) – The create or update parameters for python package. Is either a PythonPackageCreateParameters type or a IO[bytes] type. Required.

Returns:

Module or the result of cls(response)

Return type:

Module

Raises:

HttpResponseError –

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

Delete the python 2 package by name.

See also

• http://aka.ms/azureautomationsdk/moduleoperations

Parameters:

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

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

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

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name: str, automation_account_name: str, package_name: str, **kwargs: Any) → Module

Retrieve the python 2 package identified by package name.

See also

• http://aka.ms/azureautomationsdk/moduleoperations

Parameters:

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

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

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

Returns:

Module or the result of cls(response)

Return type:

Module

Raises:

HttpResponseError –

list_by_automation_account(resource_group_name: str, automation_account_name: str, **kwargs: Any) → Iterable[Module]

Retrieve a list of python 2 packages.

See also

• http://aka.ms/azureautomationsdk/moduleoperations

Parameters:

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

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

Returns:

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

Return type:

ItemPaged[Module]

Raises:

HttpResponseError –

update(resource_group_name: str, automation_account_name: str, package_name: str, parameters: _models.PythonPackageUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) → _models.Module

update(resource_group_name: str, automation_account_name: str, package_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.Module

Update the python 2 package identified by package name.

See also

• http://aka.ms/azureautomationsdk/moduleoperations

Parameters:

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

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

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

• parameters (PythonPackageUpdateParameters or IO[bytes]) – The update parameters for python package. Is either a PythonPackageUpdateParameters type or a IO[bytes] type. Required.

Returns:

Module or the result of cls(response)

Return type:

Module

Raises:

HttpResponseError –

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

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

Bases: object

Warning

DO NOT instantiate this class directly.

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

create_or_update(resource_group_name: str, automation_account_name: str, package_name: str, parameters: _models.PythonPackageCreateParameters, *, content_type: str = 'application/json', **kwargs: Any) → _models.Module

create_or_update(resource_group_name: str, automation_account_name: str, package_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.Module

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

See also

• http://aka.ms/azureautomationsdk/moduleoperations

Parameters:

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

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

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

• parameters (PythonPackageCreateParameters or IO[bytes]) – The create or update parameters for python package. Is either a PythonPackageCreateParameters type or a IO[bytes] type. Required.

Returns:

Module or the result of cls(response)

Return type:

Module

Raises:

HttpResponseError –

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

Delete the python 3 package by name.

See also

• http://aka.ms/azureautomationsdk/moduleoperations

Parameters:

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

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

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

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name: str, automation_account_name: str, package_name: str, **kwargs: Any) → Module

Retrieve the python 3 package identified by package name.

See also

• http://aka.ms/azureautomationsdk/moduleoperations

Parameters:

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

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

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

Returns:

Module or the result of cls(response)

Return type:

Module

Raises:

HttpResponseError –

list_by_automation_account(resource_group_name: str, automation_account_name: str, **kwargs: Any) → Iterable[Module]

Retrieve a list of python 3 packages.

See also

• http://aka.ms/azureautomationsdk/moduleoperations

Parameters:

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

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

Returns:

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

Return type:

ItemPaged[Module]

Raises:

HttpResponseError –

update(resource_group_name: str, automation_account_name: str, package_name: str, parameters: _models.PythonPackageUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) → _models.Module

update(resource_group_name: str, automation_account_name: str, package_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.Module

Update the python 3 package identified by package name.

See also

• http://aka.ms/azureautomationsdk/moduleoperations

Parameters:

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

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

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

• parameters (PythonPackageUpdateParameters or IO[bytes]) – The update parameters for python package. Is either a PythonPackageUpdateParameters type or a IO[bytes] type. Required.

Returns:

Module or the result of cls(response)

Return type:

Module

Raises:

HttpResponseError –

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.11/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: IO[bytes], **kwargs: Any) → LROPoller[Iterator[bytes]]

Replaces the runbook draft content.

See also

• http://aka.ms/azureautomationsdk/runbookdraftoperations

Parameters:

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

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

• runbook_name (str) – The runbook name. Required.

• runbook_content (IO[bytes]) – The runbook draft content. Required.

Returns:

An instance of LROPoller that returns either Iterator[bytes] or the result of cls(response)

Return type:

LROPoller[Iterator[bytes]]

Raises:

HttpResponseError –

get(resource_group_name: str, automation_account_name: str, runbook_name: str, **kwargs: Any) → RunbookDraft

Retrieve the runbook draft identified by runbook name.

See also

• http://aka.ms/azureautomationsdk/runbookdraftoperations

Parameters:

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

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

• runbook_name (str) – The runbook name. Required.

Returns:

RunbookDraft or the result of cls(response)

Return type:

RunbookDraft

Raises:

HttpResponseError –

get_content(resource_group_name: str, automation_account_name: str, runbook_name: str, **kwargs: Any) → Iterator[bytes]

Retrieve the content of runbook draft identified by runbook name.

See also

• http://aka.ms/azureautomationsdk/runbookdraftoperations

Parameters:

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

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

• runbook_name (str) – The runbook name. Required.

Returns:

Iterator[bytes] or the result of cls(response)

Return type:

Iterator[bytes]

Raises:

HttpResponseError –

undo_edit(resource_group_name: str, automation_account_name: str, runbook_name: str, **kwargs: Any) → RunbookDraftUndoEditResult

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

See also

• http://aka.ms/azureautomationsdk/runbookdraftoperations

Parameters:

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

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

• runbook_name (str) – The runbook name. Required.

Returns:

RunbookDraftUndoEditResult or the result of cls(response)

Return type:

RunbookDraftUndoEditResult

Raises:

HttpResponseError –

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.11/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) → LROPoller[None]

Publish runbook draft.

See also

• http://aka.ms/azureautomationsdk/runbookdraftoperations

Parameters:

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

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

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

Returns:

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

Return type:

LROPoller[None]

Raises:

HttpResponseError –

create_or_update(resource_group_name: str, automation_account_name: str, runbook_name: str, parameters: _models.RunbookCreateOrUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) → _models.Runbook

create_or_update(resource_group_name: str, automation_account_name: str, runbook_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.Runbook

Create the runbook identified by runbook name.

See also

• http://aka.ms/azureautomationsdk/runbookoperations

Parameters:

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

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

• runbook_name (str) – The runbook name. Required.

• parameters (RunbookCreateOrUpdateParameters or IO[bytes]) – The create or update parameters for runbook. Provide either content link for a published runbook or draft, not both. Is either a RunbookCreateOrUpdateParameters type or a IO[bytes] type. Required.

Returns:

Runbook or the result of cls(response)

Return type:

Runbook

Raises:

HttpResponseError –

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

Delete the runbook by name.

See also

• http://aka.ms/azureautomationsdk/runbookoperations

Parameters:

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

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

• runbook_name (str) – The runbook name. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name: str, automation_account_name: str, runbook_name: str, **kwargs: Any) → Runbook

Retrieve the runbook identified by runbook name.

See also

• http://aka.ms/azureautomationsdk/runbookoperations

Parameters:

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

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

• runbook_name (str) – The runbook name. Required.

Returns:

Runbook or the result of cls(response)

Return type:

Runbook

Raises:

HttpResponseError –

get_content(resource_group_name: str, automation_account_name: str, runbook_name: str, **kwargs: Any) → Iterator[bytes]

Retrieve the content of runbook identified by runbook name.

See also

• http://aka.ms/azureautomationsdk/runbookoperations

Parameters:

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

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

• runbook_name (str) – The runbook name. Required.

Returns:

Iterator[bytes] or the result of cls(response)

Return type:

Iterator[bytes]

Raises:

HttpResponseError –

list_by_automation_account(resource_group_name: str, automation_account_name: str, **kwargs: Any) → Iterable[Runbook]

Retrieve a list of runbooks.

See also

• http://aka.ms/azureautomationsdk/runbookoperations

Parameters:

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

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

Returns:

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

Return type:

ItemPaged[Runbook]

Raises:

HttpResponseError –

update(resource_group_name: str, automation_account_name: str, runbook_name: str, parameters: _models.RunbookUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) → _models.Runbook

update(resource_group_name: str, automation_account_name: str, runbook_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.Runbook

Update the runbook identified by runbook name.

See also

• http://aka.ms/azureautomationsdk/runbookoperations

Parameters:

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

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

• runbook_name (str) – The runbook name. Required.

• parameters (RunbookUpdateParameters or IO[bytes]) – The update parameters for runbook. Is either a RunbookUpdateParameters type or a IO[bytes] type. Required.

Returns:

Runbook or the result of cls(response)

Return type:

Runbook

Raises:

HttpResponseError –

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.11/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: _models.ScheduleCreateOrUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) → _models.Schedule | None

create_or_update(resource_group_name: str, automation_account_name: str, schedule_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.Schedule | None

Create a schedule.

See also

• http://aka.ms/azureautomationsdk/scheduleoperations

Parameters:

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

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

• schedule_name (str) – The schedule name. Required.

• parameters (ScheduleCreateOrUpdateParameters or IO[bytes]) – The parameters supplied to the create or update schedule operation. Is either a ScheduleCreateOrUpdateParameters type or a IO[bytes] type. Required.

Returns:

Schedule or None or the result of cls(response)

Return type:

Schedule or None

Raises:

HttpResponseError –

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

Delete the schedule identified by schedule name.

See also

• http://aka.ms/azureautomationsdk/scheduleoperations

Parameters:

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

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

• schedule_name (str) – The schedule name. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name: str, automation_account_name: str, schedule_name: str, **kwargs: Any) → Schedule

Retrieve the schedule identified by schedule name.

See also

• http://aka.ms/azureautomationsdk/scheduleoperations

Parameters:

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

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

• schedule_name (str) – The schedule name. Required.

Returns:

Schedule or the result of cls(response)

Return type:

Schedule

Raises:

HttpResponseError –

list_by_automation_account(resource_group_name: str, automation_account_name: str, **kwargs: Any) → Iterable[Schedule]

Retrieve a list of schedules.

See also

• http://aka.ms/azureautomationsdk/scheduleoperations

Parameters:

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

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

Returns:

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

Return type:

ItemPaged[Schedule]

Raises:

HttpResponseError –

update(resource_group_name: str, automation_account_name: str, schedule_name: str, parameters: _models.ScheduleUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) → _models.Schedule

update(resource_group_name: str, automation_account_name: str, schedule_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.Schedule

Update the schedule identified by schedule name.

See also

• http://aka.ms/azureautomationsdk/scheduleoperations

Parameters:

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

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

• schedule_name (str) – The schedule name. Required.

• parameters (ScheduleUpdateParameters or IO[bytes]) – The parameters supplied to the update schedule operation. Is either a ScheduleUpdateParameters type or a IO[bytes] type. Required.

Returns:

Schedule or the result of cls(response)

Return type:

Schedule

Raises:

HttpResponseError –

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.11/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: str | None = None, **kwargs: Any) → SoftwareUpdateConfigurationMachineRun

Get a single software update configuration machine run by Id.

See also

• http://aka.ms/azureautomationsdk/softwareupdateconfigurationoperations

Parameters:

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

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

• software_update_configuration_machine_run_id (str) – The Id of the software update configuration machine run. Required.

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

Returns:

SoftwareUpdateConfigurationMachineRun or the result of cls(response)

Return type:

SoftwareUpdateConfigurationMachineRun

Raises:

HttpResponseError –

list(resource_group_name: str, automation_account_name: str, client_request_id: str | None = None, filter: str | None = None, skip: str | None = None, top: str | None = None, **kwargs: Any) → SoftwareUpdateConfigurationMachineRunListResult

Return list of software update configuration machine runs.

See also

• http://aka.ms/azureautomationsdk/softwareupdateconfigurationoperations

Parameters:

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

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

• 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.

Returns:

SoftwareUpdateConfigurationMachineRunListResult or the result of cls(response)

Return type:

SoftwareUpdateConfigurationMachineRunListResult

Raises:

HttpResponseError –

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.11/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: str | None = None, **kwargs: Any) → SoftwareUpdateConfigurationRun

Get a single software update configuration Run by Id.

See also

• http://aka.ms/azureautomationsdk/softwareupdateconfigurationrunoperations

Parameters:

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

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

• software_update_configuration_run_id (str) – The Id of the software update configuration run. Required.

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

Returns:

SoftwareUpdateConfigurationRun or the result of cls(response)

Return type:

SoftwareUpdateConfigurationRun

Raises:

HttpResponseError –

list(resource_group_name: str, automation_account_name: str, client_request_id: str | None = None, filter: str | None = None, skip: str | None = None, top: str | None = None, **kwargs: Any) → SoftwareUpdateConfigurationRunListResult

Return list of software update configuration runs.

See also

• http://aka.ms/azureautomationsdk/softwareupdateconfigurationoperations

Parameters:

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

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

• 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.

Returns:

SoftwareUpdateConfigurationRunListResult or the result of cls(response)

Return type:

SoftwareUpdateConfigurationRunListResult

Raises:

HttpResponseError –

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.11/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: _models.SoftwareUpdateConfiguration, client_request_id: str | None = None, *, content_type: str = 'application/json', **kwargs: Any) → _models.SoftwareUpdateConfiguration

create(resource_group_name: str, automation_account_name: str, software_update_configuration_name: str, parameters: IO[bytes], client_request_id: str | None = None, *, content_type: str = 'application/json', **kwargs: Any) → _models.SoftwareUpdateConfiguration

Create a new software update configuration with the name given in the URI.

See also

• http://aka.ms/azureautomationsdk/softwareupdateconfigurationoperations

Parameters:

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

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

• software_update_configuration_name (str) – The name of the software update configuration to be created. Required.

• parameters (SoftwareUpdateConfiguration or IO[bytes]) – Request body. Is either a SoftwareUpdateConfiguration type or a IO[bytes] type. Required.

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

Returns:

SoftwareUpdateConfiguration or the result of cls(response)

Return type:

SoftwareUpdateConfiguration

Raises:

HttpResponseError –

delete(resource_group_name: str, automation_account_name: str, software_update_configuration_name: str, client_request_id: str | None = None, **kwargs: Any) → None

delete a specific software update configuration.

See also

• http://aka.ms/azureautomationsdk/softwareupdateconfigurationoperations

Parameters:

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

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

• software_update_configuration_name (str) – The name of the software update configuration to be created. Required.

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

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get_by_name(resource_group_name: str, automation_account_name: str, software_update_configuration_name: str, client_request_id: str | None = None, **kwargs: Any) → SoftwareUpdateConfiguration

Get a single software update configuration by name.

See also

• http://aka.ms/azureautomationsdk/softwareupdateconfigurationoperations

Parameters:

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

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

• software_update_configuration_name (str) – The name of the software update configuration to be created. Required.

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

Returns:

SoftwareUpdateConfiguration or the result of cls(response)

Return type:

SoftwareUpdateConfiguration

Raises:

HttpResponseError –

list(resource_group_name: str, automation_account_name: str, client_request_id: str | None = None, filter: str | None = None, **kwargs: Any) → SoftwareUpdateConfigurationListResult

Get all software update configurations for the account.

See also

• http://aka.ms/azureautomationsdk/softwareupdateconfigurationoperations

Parameters:

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

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

• 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.

Returns:

SoftwareUpdateConfigurationListResult or the result of cls(response)

Return type:

SoftwareUpdateConfigurationListResult

Raises:

HttpResponseError –

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.11/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: _models.SourceControlCreateOrUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) → _models.SourceControl

create_or_update(resource_group_name: str, automation_account_name: str, source_control_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.SourceControl

Create a source control.

See also

• http://aka.ms/azureautomationsdk/sourcecontroloperations

Parameters:

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

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

• source_control_name (str) – The source control name. Required.

• parameters (SourceControlCreateOrUpdateParameters or IO[bytes]) – The parameters supplied to the create or update source control operation. Is either a SourceControlCreateOrUpdateParameters type or a IO[bytes] type. Required.

Returns:

SourceControl or the result of cls(response)

Return type:

SourceControl

Raises:

HttpResponseError –

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

Delete the source control.

See also

• http://aka.ms/azureautomationsdk/sourcecontroloperations

Parameters:

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

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

• source_control_name (str) – The name of source control. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name: str, automation_account_name: str, source_control_name: str, **kwargs: Any) → SourceControl

Retrieve the source control identified by source control name.

See also

• http://aka.ms/azureautomationsdk/sourcecontroloperations

Parameters:

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

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

• source_control_name (str) – The name of source control. Required.

Returns:

SourceControl or the result of cls(response)

Return type:

SourceControl

Raises:

HttpResponseError –

list_by_automation_account(resource_group_name: str, automation_account_name: str, filter: str | None = None, **kwargs: Any) → Iterable[SourceControl]

Retrieve a list of source controls.

See also

• http://aka.ms/azureautomationsdk/sourcecontroloperations

Parameters:

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

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

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

Returns:

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

Return type:

ItemPaged[SourceControl]

Raises:

HttpResponseError –

update(resource_group_name: str, automation_account_name: str, source_control_name: str, parameters: _models.SourceControlUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) → _models.SourceControl

update(resource_group_name: str, automation_account_name: str, source_control_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.SourceControl

Update a source control.

See also

• http://aka.ms/azureautomationsdk/sourcecontroloperations

Parameters:

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

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

• source_control_name (str) – The source control name. Required.

• parameters (SourceControlUpdateParameters or IO[bytes]) – The parameters supplied to the update source control operation. Is either a SourceControlUpdateParameters type or a IO[bytes] type. Required.

Returns:

SourceControl or the result of cls(response)

Return type:

SourceControl

Raises:

HttpResponseError –

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.11/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: _models.SourceControlSyncJobCreateParameters, *, content_type: str = 'application/json', **kwargs: Any) → _models.SourceControlSyncJob

create(resource_group_name: str, automation_account_name: str, source_control_name: str, source_control_sync_job_id: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.SourceControlSyncJob

Creates the sync job for a source control.

See also

• http://aka.ms/azureautomationsdk/sourcecontrolsyncjoboperations

Parameters:

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

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

• source_control_name (str) – The source control name. Required.

• source_control_sync_job_id (str) – The source control sync job id. Required.

• parameters (SourceControlSyncJobCreateParameters or IO[bytes]) – The parameters supplied to the create source control sync job operation. Is either a SourceControlSyncJobCreateParameters type or a IO[bytes] type. Required.

Returns:

SourceControlSyncJob or the result of cls(response)

Return type:

SourceControlSyncJob

Raises:

HttpResponseError –

get(resource_group_name: str, automation_account_name: str, source_control_name: str, source_control_sync_job_id: str, **kwargs: Any) → SourceControlSyncJobById

Retrieve the source control sync job identified by job id.

See also

• http://aka.ms/azureautomationsdk/sourcecontrolsyncjoboperations

Parameters:

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

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

• source_control_name (str) – The source control name. Required.

• source_control_sync_job_id (str) – The source control sync job id. Required.

Returns:

SourceControlSyncJobById or the result of cls(response)

Return type:

SourceControlSyncJobById

Raises:

HttpResponseError –

list_by_automation_account(resource_group_name: str, automation_account_name: str, source_control_name: str, filter: str | None = None, **kwargs: Any) → Iterable[SourceControlSyncJob]

Retrieve a list of source control sync jobs.

See also

• http://aka.ms/azureautomationsdk/sourcecontrolsyncjoboperations

Parameters:

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

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

• source_control_name (str) – The source control name. Required.

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

Returns:

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

Return type:

ItemPaged[SourceControlSyncJob]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.11/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) → SourceControlSyncJobStreamById

Retrieve a sync job stream identified by stream id.

See also

• http://aka.ms/azureautomationsdk/sourcecontrolsyncjoboperations

Parameters:

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

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

• source_control_name (str) – The source control name. Required.

• source_control_sync_job_id (str) – The source control sync job id. Required.

• stream_id (str) – The id of the sync job stream. Required.

Returns:

SourceControlSyncJobStreamById or the result of cls(response)

Return type:

SourceControlSyncJobStreamById

Raises:

HttpResponseError –

list_by_sync_job(resource_group_name: str, automation_account_name: str, source_control_name: str, source_control_sync_job_id: str, filter: str | None = None, **kwargs: Any) → Iterable[SourceControlSyncJobStream]

Retrieve a list of sync job streams identified by sync job id.

See also

• http://aka.ms/azureautomationsdk/sourcecontrolsyncjoboperations

Parameters:

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

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

• source_control_name (str) – The source control name. Required.

• source_control_sync_job_id (str) – The source control sync job id. Required.

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

Returns:

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

Return type:

ItemPaged[SourceControlSyncJobStream]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.11/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: str | None = None, **kwargs: Any) → Iterable[Statistics]

Retrieve the statistics for the account.

See also

• http://aka.ms/azureautomationsdk/statisticsoperations

Parameters:

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

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

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

Returns:

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

Return type:

ItemPaged[Statistics]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.11/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: _models.TestJobCreateParameters, *, content_type: str = 'application/json', **kwargs: Any) → _models.TestJob

create(resource_group_name: str, automation_account_name: str, runbook_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.TestJob

Create a test job of the runbook.

See also

• http://aka.ms/azureautomationsdk/testjoboperations

Parameters:

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

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

• runbook_name (str) – The parameters supplied to the create test job operation. Required.

• parameters (TestJobCreateParameters or IO[bytes]) – The parameters supplied to the create test job operation. Is either a TestJobCreateParameters type or a IO[bytes] type. Required.

Returns:

TestJob or the result of cls(response)

Return type:

TestJob

Raises:

HttpResponseError –

get(resource_group_name: str, automation_account_name: str, runbook_name: str, **kwargs: Any) → TestJob

Retrieve the test job for the specified runbook.

See also

• http://aka.ms/azureautomationsdk/testjoboperations

Parameters:

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

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

• runbook_name (str) – The runbook name. Required.

Returns:

TestJob or the result of cls(response)

Return type:

TestJob

Raises:

HttpResponseError –

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

Resume the test job.

See also

• http://aka.ms/azureautomationsdk/testjoboperations

Parameters:

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

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

• runbook_name (str) – The runbook name. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

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

Stop the test job.

See also

• http://aka.ms/azureautomationsdk/testjoboperations

Parameters:

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

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

• runbook_name (str) – The runbook name. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

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

Suspend the test job.

See also

• http://aka.ms/azureautomationsdk/testjoboperations

Parameters:

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

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

• runbook_name (str) – The runbook name. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.11/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) → JobStream

Retrieve a test job stream of the test job identified by runbook name and stream id.

See also

• http://aka.ms/azureautomationsdk/jobstreamoperations

Parameters:

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

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

• runbook_name (str) – The runbook name. Required.

• job_stream_id (str) – The job stream id. Required.

Returns:

JobStream or the result of cls(response)

Return type:

JobStream

Raises:

HttpResponseError –

list_by_test_job(resource_group_name: str, automation_account_name: str, runbook_name: str, filter: str | None = None, **kwargs: Any) → Iterable[JobStream]

Retrieve a list of test job streams identified by runbook name.

See also

• http://aka.ms/azureautomationsdk/jobstreamoperations

Parameters:

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

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

• runbook_name (str) – The runbook name. Required.

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

Returns:

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

Return type:

ItemPaged[JobStream]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.11/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[Usage]

Retrieve the usage for the account id.

See also

• http://aka.ms/azureautomationsdk/usageoperations

Parameters:

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

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

Returns:

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

Return type:

ItemPaged[Usage]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.11/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: _models.VariableCreateOrUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) → _models.Variable

create_or_update(resource_group_name: str, automation_account_name: str, variable_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.Variable

Create a variable.

See also

• http://aka.ms/azureautomationsdk/variableoperations

Parameters:

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

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

• variable_name (str) – The variable name. Required.

• parameters (VariableCreateOrUpdateParameters or IO[bytes]) – The parameters supplied to the create or update variable operation. Is either a VariableCreateOrUpdateParameters type or a IO[bytes] type. Required.

Returns:

Variable or the result of cls(response)

Return type:

Variable

Raises:

HttpResponseError –

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

Delete the variable.

See also

• http://aka.ms/azureautomationsdk/variableoperations

Parameters:

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

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

• variable_name (str) – The name of variable. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name: str, automation_account_name: str, variable_name: str, **kwargs: Any) → Variable

Retrieve the variable identified by variable name.

See also

• http://aka.ms/azureautomationsdk/variableoperations

Parameters:

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

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

• variable_name (str) – The name of variable. Required.

Returns:

Variable or the result of cls(response)

Return type:

Variable

Raises:

HttpResponseError –

list_by_automation_account(resource_group_name: str, automation_account_name: str, **kwargs: Any) → Iterable[Variable]

Retrieve a list of variables.

See also

• http://aka.ms/azureautomationsdk/variableoperations

Parameters:

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

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

Returns:

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

Return type:

ItemPaged[Variable]

Raises:

HttpResponseError –

update(resource_group_name: str, automation_account_name: str, variable_name: str, parameters: _models.VariableUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) → _models.Variable

update(resource_group_name: str, automation_account_name: str, variable_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.Variable

Update a variable.

See also

• http://aka.ms/azureautomationsdk/variableoperations

Parameters:

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

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

• variable_name (str) – The variable name. Required.

• parameters (VariableUpdateParameters or IO[bytes]) – The parameters supplied to the update variable operation. Is either a VariableUpdateParameters type or a IO[bytes] type. Required.

Returns:

Variable or the result of cls(response)

Return type:

Variable

Raises:

HttpResponseError –

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.11/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: _models.Watcher, *, content_type: str = 'application/json', **kwargs: Any) → _models.Watcher

create_or_update(resource_group_name: str, automation_account_name: str, watcher_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.Watcher

Create the watcher identified by watcher name.

See also

• http://aka.ms/azureautomationsdk/watcheroperations

Parameters:

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

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

• watcher_name (str) – The watcher name. Required.

• parameters (Watcher or IO[bytes]) – The create or update parameters for watcher. Is either a Watcher type or a IO[bytes] type. Required.

Returns:

Watcher or the result of cls(response)

Return type:

Watcher

Raises:

HttpResponseError –

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

Delete the watcher by name.

See also

• http://aka.ms/azureautomationsdk/watcheroperations

Parameters:

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

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

• watcher_name (str) – The watcher name. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name: str, automation_account_name: str, watcher_name: str, **kwargs: Any) → Watcher

Retrieve the watcher identified by watcher name.

See also

• http://aka.ms/azureautomationsdk/watcheroperations

Parameters:

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

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

• watcher_name (str) – The watcher name. Required.

Returns:

Watcher or the result of cls(response)

Return type:

Watcher

Raises:

HttpResponseError –

list_by_automation_account(resource_group_name: str, automation_account_name: str, filter: str | None = None, **kwargs: Any) → Iterable[Watcher]

Retrieve a list of watchers.

See also

• http://aka.ms/azureautomationsdk/watcheroperations

Parameters:

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

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

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

Returns:

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

Return type:

ItemPaged[Watcher]

Raises:

HttpResponseError –

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

Resume the watcher identified by watcher name.

See also

• http://aka.ms/azureautomationsdk/watcheroperations

Parameters:

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

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

• watcher_name (str) – The watcher name. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

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

Resume the watcher identified by watcher name.

See also

• http://aka.ms/azureautomationsdk/watcheroperations

Parameters:

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

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

• watcher_name (str) – The watcher name. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

update(resource_group_name: str, automation_account_name: str, watcher_name: str, parameters: _models.WatcherUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) → _models.Watcher

update(resource_group_name: str, automation_account_name: str, watcher_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.Watcher

Update the watcher identified by watcher name.

See also

• http://aka.ms/azureautomationsdk/watcheroperations

Parameters:

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

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

• watcher_name (str) – The watcher name. Required.

• parameters (WatcherUpdateParameters or IO[bytes]) – The update parameters for watcher. Is either a WatcherUpdateParameters type or a IO[bytes] type. Required.

Returns:

Watcher or the result of cls(response)

Return type:

Watcher

Raises:

HttpResponseError –

models = <module 'azure.mgmt.automation.models' from '/mnt/vss/_work/1/s/sdk/automation/azure-mgmt-automation/.tox/sphinx/lib/python3.11/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: _models.WebhookCreateOrUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) → _models.Webhook

create_or_update(resource_group_name: str, automation_account_name: str, webhook_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.Webhook

Create the webhook identified by webhook name.

See also

• http://aka.ms/azureautomationsdk/webhookoperations

Parameters:

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

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

• webhook_name (str) – The webhook name. Required.

• parameters (WebhookCreateOrUpdateParameters or IO[bytes]) – The create or update parameters for webhook. Is either a WebhookCreateOrUpdateParameters type or a IO[bytes] type. Required.

Returns:

Webhook or the result of cls(response)

Return type:

Webhook

Raises:

HttpResponseError –

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

Delete the webhook by name.

See also

• http://aka.ms/azureautomationsdk/webhookoperations

Parameters:

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

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

• webhook_name (str) – The webhook name. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

generate_uri(resource_group_name: str, automation_account_name: str, **kwargs: Any) → str

Generates a Uri for use in creating a webhook.

See also

• http://aka.ms/azureautomationsdk/webhookoperations

Parameters:

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

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

Returns:

str or the result of cls(response)

Return type:

str

Raises:

HttpResponseError –

get(resource_group_name: str, automation_account_name: str, webhook_name: str, **kwargs: Any) → Webhook

Retrieve the webhook identified by webhook name.

See also

• http://aka.ms/azureautomationsdk/webhookoperations

Parameters:

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

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

• webhook_name (str) – The webhook name. Required.

Returns:

Webhook or the result of cls(response)

Return type:

Webhook

Raises:

HttpResponseError –

list_by_automation_account(resource_group_name: str, automation_account_name: str, filter: str | None = None, **kwargs: Any) → Iterable[Webhook]

Retrieve a list of webhooks.

See also

• http://aka.ms/azureautomationsdk/webhookoperations

Parameters:

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

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

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

Returns:

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

Return type:

ItemPaged[Webhook]

Raises:

HttpResponseError –

update(resource_group_name: str, automation_account_name: str, webhook_name: str, parameters: _models.WebhookUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) → _models.Webhook

update(resource_group_name: str, automation_account_name: str, webhook_name: str, parameters: IO[bytes], *, content_type: str = 'application/json', **kwargs: Any) → _models.Webhook

Update the webhook identified by webhook name.

See also

• http://aka.ms/azureautomationsdk/webhookoperations

Parameters:

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

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

• webhook_name (str) – The webhook name. Required.

• parameters (WebhookUpdateParameters or IO[bytes]) – The update parameters for webhook. Is either a WebhookUpdateParameters type or a IO[bytes] type. Required.

Returns:

Webhook or the result of cls(response)

Return type:

Webhook

Raises:

HttpResponseError –

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