azure.mgmt.automation.operations module¶

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

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

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.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[Activity]

Raises

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

class azure.mgmt.automation.operations.AgentRegistrationInformationOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

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

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

Retrieve the automation agent registration information.

Parameters

resource_group_name (str) – Name of an Azure Resource group. Required.
automation_account_name (str) – The name of the automation account. Required.

Keyword Arguments

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

Returns

AgentRegistration or the result of cls(response)

Return type

AgentRegistration

Raises

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

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

Regenerate a primary or secondary agent registration key.

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) – The name of the agent registration key to be regenerated. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

AgentRegistration or the result of cls(response)

Return type

AgentRegistration

Raises

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

class azure.mgmt.automation.operations.AutomationAccountOperations(*args, **kwargs)[source]¶

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[source]¶

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

Create or update 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.
parameters (AutomationAccountCreateOrUpdateParameters or IO) – Parameters supplied to the create or update automation account. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

AutomationAccount or the result of cls(response)

Return type

AutomationAccount

Raises

delete(resource_group_name: str, automation_account_name: str, **kwargs: Any) → None [source]¶

Delete an 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.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

Raises

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

Get information about an 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.

Keyword Arguments

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

Returns

AutomationAccount or the result of cls(response)

Return type

AutomationAccount

Raises

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

Lists the Automation Accounts within an Azure subscription.

Retrieve a list of accounts within a given subscription.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
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[azure.mgmt.automation.models._models_py3.AutomationAccount][source]¶

Retrieve a list of accounts within a given resource group.

Parameters: resource_group_name (str) – Name of an Azure Resource group. Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
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[source]¶

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

Update an 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.
parameters (AutomationAccountUpdateParameters or IO) – Parameters supplied to the update automation account. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

AutomationAccount or the result of cls(response)

Return type

AutomationAccount

Raises

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

class azure.mgmt.automation.operations.AutomationClientOperationsMixin[source]¶

Bases: azure.mgmt.automation._vendor.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[source]¶

convert_graph_runbook_content(resource_group_name: str, automation_account_name: str, parameters: IO, *, 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) – Input data describing the graphical runbook. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

GraphicalRunbookContent or the result of cls(response)

Return type

GraphicalRunbookContent

Raises

class azure.mgmt.automation.operations.CertificateOperations(*args, **kwargs)[source]¶

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[source]¶

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

Create a certificate.

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) – The parameters supplied to the create or update certificate operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

Certificate or the result of cls(response)

Return type

Certificate

Raises

delete(resource_group_name: str, automation_account_name: str, certificate_name: str, **kwargs: Any) → None [source]¶

Delete the certificate.

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.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

Raises

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

Retrieve the certificate identified by certificate name.

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.

Keyword Arguments

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

Returns

Certificate or the result of cls(response)

Return type

Certificate

Raises

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

Retrieve a list of certificates.

Parameters

resource_group_name (str) – Name of an Azure Resource group. Required.
automation_account_name (str) – The name of the automation account. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[Certificate]

Raises

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

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

Update a certificate.

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) – The parameters supplied to the update certificate operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

Certificate or the result of cls(response)

Return type

Certificate

Raises

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

class azure.mgmt.automation.operations.ConnectionOperations(*args, **kwargs)[source]¶

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[source]¶

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

Create or update a connection.

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) – The parameters supplied to the create or update connection operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

Connection or the result of cls(response)

Return type

Connection

Raises

delete(resource_group_name: str, automation_account_name: str, connection_name: str, **kwargs: Any) → None [source]¶

Delete the connection.

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.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

Raises

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

Retrieve the connection identified by connection name.

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.

Keyword Arguments

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

Returns

Connection or the result of cls(response)

Return type

Connection

Raises

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

Retrieve a list of connections.

Parameters

resource_group_name (str) – Name of an Azure Resource group. Required.
automation_account_name (str) – The name of the automation account. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[Connection]

Raises

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

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

Update a connection.

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) – The parameters supplied to the update a connection operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

Connection or the result of cls(response)

Return type

Connection

Raises

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

class azure.mgmt.automation.operations.ConnectionTypeOperations(*args, **kwargs)[source]¶

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[source]¶

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

Create a connection type.

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) – The parameters supplied to the create or update connection type operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

ConnectionType or the result of cls(response)

Return type

ConnectionType

Raises

delete(resource_group_name: str, automation_account_name: str, connection_type_name: str, **kwargs: Any) → None [source]¶

Delete the connection type.

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.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

Raises

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

Retrieve the connection type identified by connection type name.

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.

Keyword Arguments

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

Returns

ConnectionType or the result of cls(response)

Return type

ConnectionType

Raises

ItemPaged[ConnectionType]

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

Retrieve a list of connection types.

Parameters

resource_group_name (str) – Name of an Azure Resource group. Required.
automation_account_name (str) – The name of the automation account. Required.

Keyword Arguments

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

Returns

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

Return type

Raises

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

class azure.mgmt.automation.operations.CredentialOperations(*args, **kwargs)[source]¶

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[source]¶

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

Create a credential.

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) – The parameters supplied to the create or update credential operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

Credential or the result of cls(response)

Return type

Credential

Raises

delete(resource_group_name: str, automation_account_name: str, credential_name: str, **kwargs: Any) → None [source]¶

Delete the credential.

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.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

Raises

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

Retrieve the credential identified by credential name.

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.

Keyword Arguments

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

Returns

Credential or the result of cls(response)

Return type

Credential

Raises

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

Retrieve a list of credentials.

Parameters

resource_group_name (str) – Name of an Azure Resource group. Required.
automation_account_name (str) – The name of the automation account. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[Credential]

Raises

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

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

Update a credential.

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) – The parameters supplied to the Update credential operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

Credential or the result of cls(response)

Return type

Credential

Raises

LROPoller[DscCompilationJob]

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

class azure.mgmt.automation.operations.DeletedAutomationAccountsOperations(*args, **kwargs)[source]¶

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) → azure.mgmt.automation.models._models_py3.DeletedAutomationAccountListResult[source]¶

Retrieve deleted automation account.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
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.9/site-packages/azure/mgmt/automation/models/__init__.py'>¶

class azure.mgmt.automation.operations.DscCompilationJobOperations(*args, **kwargs)[source]¶

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][source]¶

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

Creates the Dsc compilation job of the configuration.

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) – The parameters supplied to the create compilation job operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises

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

Retrieve the Dsc configuration compilation job identified by job id.

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.

Keyword Arguments

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

Returns

DscCompilationJob or the result of cls(response)

Return type

DscCompilationJob

Raises

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

Retrieve the job stream identified by job stream id.

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.

Keyword Arguments

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

Returns

JobStream or the result of cls(response)

Return type

JobStream

Raises

ItemPaged[DscCompilationJob]

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

Retrieve a list of dsc compilation jobs.

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.

Keyword Arguments

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

Returns

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

Return type

Raises

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

class azure.mgmt.automation.operations.DscCompilationJobStreamOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

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

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

Retrieve all the job streams for the compilation Job.

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.

Keyword Arguments

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

Returns

JobStreamListResult or the result of cls(response)

Return type

JobStreamListResult

Raises

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

class azure.mgmt.automation.operations.DscConfigurationOperations(*args, **kwargs)[source]¶

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[source]¶

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

Create the configuration identified by configuration name.

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 model type or a string type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’, ‘text/plain; charset=utf-8’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

DscConfiguration or the result of cls(response)

Return type

DscConfiguration

Raises

delete(resource_group_name: str, automation_account_name: str, configuration_name: str, **kwargs: Any) → None [source]¶

Delete the dsc configuration identified by configuration name.

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.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

Raises

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

Retrieve the configuration identified by configuration name.

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.

Keyword Arguments

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

Returns

DscConfiguration or the result of cls(response)

Return type

DscConfiguration

Raises

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

Retrieve the configuration script identified by configuration name.

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.

Keyword Arguments

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

Returns

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

Return type

Iterator[bytes]

Raises

ItemPaged[DscConfiguration]

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

Retrieve a list of configurations.

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.

Keyword Arguments

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

Returns

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

Return type

Raises

update(resource_group_name: str, automation_account_name: str, configuration_name: str, parameters: Optional[_models.DscConfigurationUpdateParameters] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DscConfiguration[source]¶

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

Create the configuration identified by configuration name.

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 model type or a string type. Default value is None.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’, ‘text/plain; charset=utf-8’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

DscConfiguration or the result of cls(response)

Return type

DscConfiguration

Raises

LROPoller[DscNodeConfiguration]

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

class azure.mgmt.automation.operations.DscNodeConfigurationOperations(*args, **kwargs)[source]¶

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[None][source]¶

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

Create the node configuration identified by node configuration name.

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) – The create or update parameters for configuration. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises

delete(resource_group_name: str, automation_account_name: str, node_configuration_name: str, **kwargs: Any) → None [source]¶

Delete the Dsc node configurations by node configuration.

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.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

Raises

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

Retrieve the Dsc node configurations by node configuration.

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.

Keyword Arguments

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

Returns

DscNodeConfiguration or the result of cls(response)

Return type

DscNodeConfiguration

Raises

ItemPaged[DscNodeConfiguration]

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

Retrieve a list of dsc node configurations.

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.

Keyword Arguments

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

Returns

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

Return type

Raises

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

class azure.mgmt.automation.operations.DscNodeOperations(*args, **kwargs)[source]¶

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 [source]¶

Delete the dsc node identified by node id.

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.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

Raises

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

Retrieve the dsc node identified by node id.

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.

Keyword Arguments

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

Returns

DscNode or the result of cls(response)

Return type

DscNode

Raises

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

Retrieve a list of dsc nodes.

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.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[DscNode]

Raises

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[source]¶

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

Update the dsc node.

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) – Parameters supplied to the update dsc node. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

DscNode or the result of cls(response)

Return type

DscNode

Raises

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

class azure.mgmt.automation.operations.FieldsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

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

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

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

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.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[TypeField]

Raises

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

class azure.mgmt.automation.operations.HybridRunbookWorkerGroupOperations(*args, **kwargs)[source]¶

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[source]¶

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

Create a hybrid runbook worker group.

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) – The create or update parameters for hybrid runbook worker group. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

HybridRunbookWorkerGroup or the result of cls(response)

Return type

HybridRunbookWorkerGroup

Raises

delete(resource_group_name: str, automation_account_name: str, hybrid_runbook_worker_group_name: str, **kwargs: Any) → None [source]¶

Delete a hybrid runbook worker group.

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.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

Raises

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

Retrieve a hybrid runbook worker group.

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.

Keyword Arguments

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

Returns

HybridRunbookWorkerGroup or the result of cls(response)

Return type

HybridRunbookWorkerGroup

Raises

ItemPaged[HybridRunbookWorkerGroup]

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

Retrieve a list of hybrid runbook worker groups.

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.

Keyword Arguments

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

Returns

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

Return type

Raises

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[source]¶

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

Update a hybrid runbook worker group.

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) – The hybrid runbook worker group. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

HybridRunbookWorkerGroup or the result of cls(response)

Return type

HybridRunbookWorkerGroup

Raises

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

class azure.mgmt.automation.operations.HybridRunbookWorkersOperations(*args, **kwargs)[source]¶

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[source]¶

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

Create a hybrid runbook worker.

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) – The create or update parameters for hybrid runbook worker. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

HybridRunbookWorker or the result of cls(response)

Return type

HybridRunbookWorker

Raises

delete(resource_group_name: str, automation_account_name: str, hybrid_runbook_worker_group_name: str, hybrid_runbook_worker_id: str, **kwargs: Any) → None [source]¶

Delete a hybrid runbook worker.

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.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

Raises

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

Retrieve a hybrid runbook worker.

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.

Keyword Arguments

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

Returns

HybridRunbookWorker or the result of cls(response)

Return type

HybridRunbookWorker

Raises

ItemPaged[HybridRunbookWorker]

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

Retrieve a list of hybrid runbook workers.

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.

Keyword Arguments

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

Returns

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

Return type

Raises

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 [source]¶

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

Move a hybrid worker to a different group.

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) – The hybrid runbook worker move parameters. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

Raises

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

class azure.mgmt.automation.operations.JobOperations(*args, **kwargs)[source]¶

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: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Job[source]¶

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

Create a job of the runbook.

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) – The parameters supplied to the create job operation. Is either a model type or a IO type. Required.
client_request_id (str) – Identifies this specific client request. Default value is None.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

Job or the result of cls(response)

Return type

Job

Raises

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

Retrieve the job identified by job name.

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.

Keyword Arguments

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

Returns

Job or the result of cls(response)

Return type

Job

Raises

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

Retrieve the job output identified by job name.

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.

Keyword Arguments

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

Returns

str or the result of cls(response)

Return type

str

Raises

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

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

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.

Keyword Arguments

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

Returns

str or the result of cls(response)

Return type

str

Raises

ItemPaged[JobCollectionItem]

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

Retrieve a list of jobs.

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.

Keyword Arguments

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

Returns

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

Return type

Raises

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

Resume the job identified by jobName.

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.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

Raises

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

Stop the job identified by jobName.

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.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

Raises

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

Suspend the job identified by job name.

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.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

Raises

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

class azure.mgmt.automation.operations.JobScheduleOperations(*args, **kwargs)[source]¶

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[source]¶

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

Create a job schedule.

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) – The parameters supplied to the create job schedule operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

JobSchedule or the result of cls(response)

Return type

JobSchedule

Raises

delete(resource_group_name: str, automation_account_name: str, job_schedule_id: str, **kwargs: Any) → None [source]¶

Delete the job schedule identified by job schedule name.

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.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

Raises

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

Retrieve the job schedule identified by job schedule name.

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.

Keyword Arguments

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

Returns

JobSchedule or the result of cls(response)

Return type

JobSchedule

Raises

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

Retrieve a list of job schedules.

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.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[JobSchedule]

Raises

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

class azure.mgmt.automation.operations.JobStreamOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

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

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

Retrieve the job stream identified by job stream id.

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.

Keyword Arguments

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

Returns

JobStream or the result of cls(response)

Return type

JobStream

Raises

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

Retrieve a list of jobs streams identified by job name.

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.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[JobStream]

Raises

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

class azure.mgmt.automation.operations.KeysOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

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

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

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.

Keyword Arguments

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

Returns

KeyListResult or the result of cls(response)

Return type

KeyListResult

Raises

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

class azure.mgmt.automation.operations.LinkedWorkspaceOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

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

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

Retrieve the linked workspace for the account id.

Parameters

resource_group_name (str) – Name of an Azure Resource group. Required.
automation_account_name (str) – The name of the automation account. Required.

Keyword Arguments

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

Returns

LinkedWorkspace or the result of cls(response)

Return type

LinkedWorkspace

Raises

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

class azure.mgmt.automation.operations.ModuleOperations(*args, **kwargs)[source]¶

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[source]¶

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

Create or Update the module identified by module name.

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) – The create or update parameters for module. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

Module or the result of cls(response)

Return type

Raises

delete(resource_group_name: str, automation_account_name: str, module_name: str, **kwargs: Any) → None [source]¶

Delete the module by name.

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.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

Raises

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

Retrieve the module identified by module name.

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.

Keyword Arguments

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

Returns

Module or the result of cls(response)

Return type

Raises

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

Retrieve a list of modules.

Parameters

resource_group_name (str) – Name of an Azure Resource group. Required.
automation_account_name (str) – The name of the automation account. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[Module]

Raises

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

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

Update the module identified by module name.

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) – The update parameters for module. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

Module or the result of cls(response)

Return type

Raises

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

class azure.mgmt.automation.operations.NodeCountInformationOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

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

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

Retrieve counts for Dsc Nodes.

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.

Keyword Arguments

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

Returns

NodeCounts or the result of cls(response)

Return type

NodeCounts

Raises

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

class azure.mgmt.automation.operations.NodeReportsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

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

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

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

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.

Keyword Arguments

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

Returns

DscNodeReport or the result of cls(response)

Return type

DscNodeReport

Raises

get_content(resource_group_name: str, automation_account_name: str, node_id: str, report_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶

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

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.

Keyword Arguments

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

Returns

JSON or the result of cls(response)

Return type

JSON

Raises

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

Retrieve the Dsc node report list by node id.

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.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[DscNodeReport]

Raises

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

class azure.mgmt.automation.operations.ObjectDataTypesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

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

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

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

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.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[TypeField]

Raises

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

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

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.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[TypeField]

Raises

LROPoller[PrivateEndpointConnection]

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

class azure.mgmt.automation.operations.Operations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

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

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

Lists all of the available Automation REST API operations.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
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.9/site-packages/azure/mgmt/automation/models/__init__.py'>¶

class azure.mgmt.automation.operations.PrivateEndpointConnectionsOperations(*args, **kwargs)[source]¶

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][source]¶

begin_create_or_update(resource_group_name: str, automation_account_name: str, private_endpoint_connection_name: str, parameters: IO, *, 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) – Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

Raises

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

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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

PrivateEndpointConnection

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

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.

Keyword Arguments

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

Returns

PrivateEndpointConnection or the result of cls(response)

Return type

Raises

ItemPaged[PrivateEndpointConnection]

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

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.

Keyword Arguments

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

Returns

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

Return type

Raises

ItemPaged[PrivateLinkResource]

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

class azure.mgmt.automation.operations.PrivateLinkResourcesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

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

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

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.

Keyword Arguments

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

Returns

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

Return type

Raises

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

class azure.mgmt.automation.operations.Python2PackageOperations(*args, **kwargs)[source]¶

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[source]¶

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

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

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) – The create or update parameters for python package. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

Module or the result of cls(response)

Return type

Raises

delete(resource_group_name: str, automation_account_name: str, package_name: str, **kwargs: Any) → None [source]¶

Delete the python 2 package by name.

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.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

Raises

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

Retrieve the python 2 package identified by package name.

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.

Keyword Arguments

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

Returns

Module or the result of cls(response)

Return type

Raises

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

Retrieve a list of python 2 packages.

Parameters

resource_group_name (str) – Name of an Azure Resource group. Required.
automation_account_name (str) – The name of the automation account. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[Module]

Raises

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

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

Update the python 2 package identified by package name.

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) – The update parameters for python package. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

Module or the result of cls(response)

Return type

Raises

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

class azure.mgmt.automation.operations.Python3PackageOperations(*args, **kwargs)[source]¶

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[source]¶

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

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

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) – The create or update parameters for python package. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

Module or the result of cls(response)

Return type

Raises

delete(resource_group_name: str, automation_account_name: str, package_name: str, **kwargs: Any) → None [source]¶

Delete the python 3 package by name.

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.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

Raises

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

Retrieve the python 3 package identified by package name.

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.

Keyword Arguments

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

Returns

Module or the result of cls(response)

Return type

Raises

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

Retrieve a list of python 3 packages.

Parameters

resource_group_name (str) – Name of an Azure Resource group. Required.
automation_account_name (str) – The name of the automation account. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[Module]

Raises

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

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

Update the python 3 package identified by package name.

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) – The update parameters for python package. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

Module or the result of cls(response)

Return type

Raises

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

class azure.mgmt.automation.operations.RunbookDraftOperations(*args, **kwargs)[source]¶

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, **kwargs: Any) → azure.core.polling._poller.LROPoller[Iterator[bytes]][source]¶

Replaces the runbook draft content.

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) – The runbook draft content. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[Iterator[bytes]]

Raises

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

Retrieve the runbook draft identified by runbook name.

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.

Keyword Arguments

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

Returns

RunbookDraft or the result of cls(response)

Return type

RunbookDraft

Raises

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

Retrieve the content of runbook draft identified by runbook name.

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.

Keyword Arguments

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

Returns

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

Return type

Iterator[bytes]

Raises

RunbookDraftUndoEditResult

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

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

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.

Keyword Arguments

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

Returns

RunbookDraftUndoEditResult or the result of cls(response)

Return type

Raises

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

class azure.mgmt.automation.operations.RunbookOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

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

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

Publish runbook draft.

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.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

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[source]¶

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

Create the runbook identified by runbook name.

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) – The create or update parameters for runbook. Provide either content link for a published runbook or draft, not both. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

Runbook or the result of cls(response)

Return type

Runbook

Raises

delete(resource_group_name: str, automation_account_name: str, runbook_name: str, **kwargs: Any) → None [source]¶

Delete the runbook by name.

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.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

Raises

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

Retrieve the runbook identified by runbook name.

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.

Keyword Arguments

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

Returns

Runbook or the result of cls(response)

Return type

Runbook

Raises

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

Retrieve the content of runbook identified by runbook name.

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.

Keyword Arguments

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

Returns

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

Return type

Iterator[bytes]

Raises

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

Retrieve a list of runbooks.

Parameters

resource_group_name (str) – Name of an Azure Resource group. Required.
automation_account_name (str) – The name of the automation account. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[Runbook]

Raises

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

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

Update the runbook identified by runbook name.

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) – The update parameters for runbook. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

Runbook or the result of cls(response)

Return type

Runbook

Raises

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

class azure.mgmt.automation.operations.ScheduleOperations(*args, **kwargs)[source]¶

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) → Optional[_models.Schedule][source]¶

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

Create a schedule.

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) – The parameters supplied to the create or update schedule operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

Schedule or None or the result of cls(response)

Return type

Schedule or None

Raises

delete(resource_group_name: str, automation_account_name: str, schedule_name: str, **kwargs: Any) → None [source]¶

Delete the schedule identified by schedule name.

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.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

Raises

get(resource_group_name: str, automation_account_name: str, schedule_name: str, **kwargs: Any) → azure.mgmt.automation.models._models_py3.Schedule[source]¶

Retrieve the schedule identified by schedule name.

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.

Keyword Arguments

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

Returns

Schedule or the result of cls(response)

Return type

Schedule

Raises

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

Retrieve a list of schedules.

Parameters

resource_group_name (str) – Name of an Azure Resource group. Required.
automation_account_name (str) – The name of the automation account. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[Schedule]

Raises

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

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

Update the schedule identified by schedule name.

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) – The parameters supplied to the update schedule operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

Schedule or the result of cls(response)

Return type

Schedule

Raises

SoftwareUpdateConfigurationMachineRun

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

class azure.mgmt.automation.operations.SoftwareUpdateConfigurationMachineRunsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

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

get_by_id(resource_group_name: str, automation_account_name: str, software_update_configuration_machine_run_id: str, client_request_id: Optional[str] = None, **kwargs: Any) → azure.mgmt.automation.models._models_py3.SoftwareUpdateConfigurationMachineRun[source]¶

Get a single software update configuration machine run by Id.

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.

Keyword Arguments

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

Returns

SoftwareUpdateConfigurationMachineRun or the result of cls(response)

Return type

Raises

SoftwareUpdateConfigurationMachineRunListResult

list(resource_group_name: str, automation_account_name: str, client_request_id: Optional[str] = None, filter: Optional[str] = None, skip: Optional[str] = None, top: Optional[str] = None, **kwargs: Any) → azure.mgmt.automation.models._models_py3.SoftwareUpdateConfigurationMachineRunListResult[source]¶

Return list of software update configuration machine runs.

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.

Keyword Arguments

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

Returns

SoftwareUpdateConfigurationMachineRunListResult or the result of cls(response)

Return type

Raises

SoftwareUpdateConfigurationRun

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

class azure.mgmt.automation.operations.SoftwareUpdateConfigurationRunsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

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

get_by_id(resource_group_name: str, automation_account_name: str, software_update_configuration_run_id: str, client_request_id: Optional[str] = None, **kwargs: Any) → azure.mgmt.automation.models._models_py3.SoftwareUpdateConfigurationRun[source]¶

Get a single software update configuration Run by Id.

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.

Keyword Arguments

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

Returns

SoftwareUpdateConfigurationRun or the result of cls(response)

Return type

Raises

SoftwareUpdateConfigurationRunListResult

list(resource_group_name: str, automation_account_name: str, client_request_id: Optional[str] = None, filter: Optional[str] = None, skip: Optional[str] = None, top: Optional[str] = None, **kwargs: Any) → azure.mgmt.automation.models._models_py3.SoftwareUpdateConfigurationRunListResult[source]¶

Return list of software update configuration runs.

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.

Keyword Arguments

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

Returns

SoftwareUpdateConfigurationRunListResult or the result of cls(response)

Return type

Raises

SoftwareUpdateConfiguration

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

class azure.mgmt.automation.operations.SoftwareUpdateConfigurationsOperations(*args, **kwargs)[source]¶

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: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.SoftwareUpdateConfiguration[source]¶

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

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

Parameters

resource_group_name (str) – Name of an Azure Resource group. 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) – Request body. Is either a model type or a IO type. Required.
client_request_id (str) – Identifies this specific client request. Default value is None.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

SoftwareUpdateConfiguration or the result of cls(response)

Return type

Raises

delete(resource_group_name: str, automation_account_name: str, software_update_configuration_name: str, client_request_id: Optional[str] = None, **kwargs: Any) → None [source]¶

delete a specific software update configuration.

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.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

Raises

SoftwareUpdateConfiguration

get_by_name(resource_group_name: str, automation_account_name: str, software_update_configuration_name: str, client_request_id: Optional[str] = None, **kwargs: Any) → azure.mgmt.automation.models._models_py3.SoftwareUpdateConfiguration[source]¶

Get a single software update configuration by name.

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.

Keyword Arguments

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

Returns

SoftwareUpdateConfiguration or the result of cls(response)

Return type

Raises

SoftwareUpdateConfigurationListResult

list(resource_group_name: str, automation_account_name: str, client_request_id: Optional[str] = None, filter: Optional[str] = None, **kwargs: Any) → azure.mgmt.automation.models._models_py3.SoftwareUpdateConfigurationListResult[source]¶

Get all software update configurations for the account.

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.

Keyword Arguments

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

Returns

SoftwareUpdateConfigurationListResult or the result of cls(response)

Return type

Raises

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

class azure.mgmt.automation.operations.SourceControlOperations(*args, **kwargs)[source]¶

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[source]¶

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

Create a source control.

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) – The parameters supplied to the create or update source control operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

SourceControl or the result of cls(response)

Return type

SourceControl

Raises

delete(resource_group_name: str, automation_account_name: str, source_control_name: str, **kwargs: Any) → None [source]¶

Delete the source control.

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.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

Raises

get(resource_group_name: str, automation_account_name: str, source_control_name: str, **kwargs: Any) → azure.mgmt.automation.models._models_py3.SourceControl[source]¶

Retrieve the source control identified by source control name.

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.

Keyword Arguments

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

Returns

SourceControl or the result of cls(response)

Return type

SourceControl

Raises

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

Retrieve a list of source controls.

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.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[SourceControl]

Raises

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[source]¶

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

Update a source control.

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) – The parameters supplied to the update source control operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

SourceControl or the result of cls(response)

Return type

SourceControl

Raises

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

class azure.mgmt.automation.operations.SourceControlSyncJobOperations(*args, **kwargs)[source]¶

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[source]¶

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

Creates the sync job for a source control.

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) – The parameters supplied to the create source control sync job operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

SourceControlSyncJob or the result of cls(response)

Return type

SourceControlSyncJob

Raises

get(resource_group_name: str, automation_account_name: str, source_control_name: str, source_control_sync_job_id: str, **kwargs: Any) → azure.mgmt.automation.models._models_py3.SourceControlSyncJobById[source]¶

Retrieve the source control sync job identified by job id.

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.

Keyword Arguments

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

Returns

SourceControlSyncJobById or the result of cls(response)

Return type

SourceControlSyncJobById

Raises

ItemPaged[SourceControlSyncJob]

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

Retrieve a list of source control sync jobs.

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.

Keyword Arguments

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

Returns

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

Return type

Raises

SourceControlSyncJobStreamById

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

class azure.mgmt.automation.operations.SourceControlSyncJobStreamsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

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

get(resource_group_name: str, automation_account_name: str, source_control_name: str, source_control_sync_job_id: str, stream_id: str, **kwargs: Any) → azure.mgmt.automation.models._models_py3.SourceControlSyncJobStreamById[source]¶

Retrieve a sync job stream identified by stream id.

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.

Keyword Arguments

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

Returns

SourceControlSyncJobStreamById or the result of cls(response)

Return type

Raises

ItemPaged[SourceControlSyncJobStream]

list_by_sync_job(resource_group_name: str, automation_account_name: str, source_control_name: str, source_control_sync_job_id: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.automation.models._models_py3.SourceControlSyncJobStream][source]¶

Retrieve a list of sync job streams identified by sync job id.

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.

Keyword Arguments

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

Returns

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

Return type

Raises

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

class azure.mgmt.automation.operations.StatisticsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

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

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

Retrieve the statistics for the account.

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.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[Statistics]

Raises

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

class azure.mgmt.automation.operations.TestJobOperations(*args, **kwargs)[source]¶

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[source]¶

create(resource_group_name: str, automation_account_name: str, runbook_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.TestJob

Create a test job of the runbook.

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) – The parameters supplied to the create test job operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

TestJob or the result of cls(response)

Return type

TestJob

Raises

get(resource_group_name: str, automation_account_name: str, runbook_name: str, **kwargs: Any) → azure.mgmt.automation.models._models_py3.TestJob[source]¶

Retrieve the test job for the specified runbook.

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.

Keyword Arguments

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

Returns

TestJob or the result of cls(response)

Return type

TestJob

Raises

resume(resource_group_name: str, automation_account_name: str, runbook_name: str, **kwargs: Any) → None [source]¶

Resume the test job.

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.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

Raises

stop(resource_group_name: str, automation_account_name: str, runbook_name: str, **kwargs: Any) → None [source]¶

Stop the test job.

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.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

Raises

suspend(resource_group_name: str, automation_account_name: str, runbook_name: str, **kwargs: Any) → None [source]¶

Suspend the test job.

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.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

Raises

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

class azure.mgmt.automation.operations.TestJobStreamsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

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

get(resource_group_name: str, automation_account_name: str, runbook_name: str, job_stream_id: str, **kwargs: Any) → azure.mgmt.automation.models._models_py3.JobStream[source]¶

Retrieve a test job stream of the test job identified by runbook name and stream id.

Parameters

resource_group_name (str) – Name of an Azure Resource group. 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.

Keyword Arguments

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

Returns

JobStream or the result of cls(response)

Return type

JobStream

Raises

list_by_test_job(resource_group_name: str, automation_account_name: str, runbook_name: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.automation.models._models_py3.JobStream][source]¶

Retrieve a list of test job streams identified by runbook name.

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.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[JobStream]

Raises

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

class azure.mgmt.automation.operations.UsagesOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

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

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

Retrieve the usage for the account id.

Parameters

resource_group_name (str) – Name of an Azure Resource group. Required.
automation_account_name (str) – The name of the automation account. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[Usage]

Raises

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

class azure.mgmt.automation.operations.VariableOperations(*args, **kwargs)[source]¶

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[source]¶

create_or_update(resource_group_name: str, automation_account_name: str, variable_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Variable

Create a variable.

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) – The parameters supplied to the create or update variable operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

Variable or the result of cls(response)

Return type

Variable

Raises

delete(resource_group_name: str, automation_account_name: str, variable_name: str, **kwargs: Any) → None [source]¶

Delete the variable.

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.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

Raises

get(resource_group_name: str, automation_account_name: str, variable_name: str, **kwargs: Any) → azure.mgmt.automation.models._models_py3.Variable[source]¶

Retrieve the variable identified by variable name.

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.

Keyword Arguments

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

Returns

Variable or the result of cls(response)

Return type

Variable

Raises

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

Retrieve a list of variables.

Parameters

resource_group_name (str) – Name of an Azure Resource group. Required.
automation_account_name (str) – The name of the automation account. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[Variable]

Raises

update(resource_group_name: str, automation_account_name: str, variable_name: str, parameters: _models.VariableUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Variable[source]¶

update(resource_group_name: str, automation_account_name: str, variable_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Variable

Update a variable.

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) – The parameters supplied to the update variable operation. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

Variable or the result of cls(response)

Return type

Variable

Raises

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

class azure.mgmt.automation.operations.WatcherOperations(*args, **kwargs)[source]¶

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[source]¶

create_or_update(resource_group_name: str, automation_account_name: str, watcher_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Watcher

Create the watcher identified by watcher name.

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) – The create or update parameters for watcher. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

Watcher or the result of cls(response)

Return type

Watcher

Raises

delete(resource_group_name: str, automation_account_name: str, watcher_name: str, **kwargs: Any) → None [source]¶

Delete the watcher by name.

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.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

Raises

get(resource_group_name: str, automation_account_name: str, watcher_name: str, **kwargs: Any) → azure.mgmt.automation.models._models_py3.Watcher[source]¶

Retrieve the watcher identified by watcher name.

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.

Keyword Arguments

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

Returns

Watcher or the result of cls(response)

Return type

Watcher

Raises

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

Retrieve a list of watchers.

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.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[Watcher]

Raises

start(resource_group_name: str, automation_account_name: str, watcher_name: str, **kwargs: Any) → None [source]¶

Resume the watcher identified by watcher name.

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.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

Raises

stop(resource_group_name: str, automation_account_name: str, watcher_name: str, **kwargs: Any) → None [source]¶

Resume the watcher identified by watcher name.

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.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

Raises

update(resource_group_name: str, automation_account_name: str, watcher_name: str, parameters: _models.WatcherUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Watcher[source]¶

update(resource_group_name: str, automation_account_name: str, watcher_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Watcher

Update the watcher identified by watcher name.

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) – The update parameters for watcher. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

Watcher or the result of cls(response)

Return type

Watcher

Raises

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

class azure.mgmt.automation.operations.WebhookOperations(*args, **kwargs)[source]¶

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[source]¶

create_or_update(resource_group_name: str, automation_account_name: str, webhook_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Webhook

Create the webhook identified by webhook name.

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) – The create or update parameters for webhook. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

Webhook or the result of cls(response)

Return type

Webhook

Raises

delete(resource_group_name: str, automation_account_name: str, webhook_name: str, **kwargs: Any) → None [source]¶

Delete the webhook by name.

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.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

Raises

generate_uri(resource_group_name: str, automation_account_name: str, **kwargs: Any) → str [source]¶

Generates a Uri for use in creating a webhook.

Parameters

resource_group_name (str) – Name of an Azure Resource group. Required.
automation_account_name (str) – The name of the automation account. Required.

Keyword Arguments

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

Returns

str or the result of cls(response)

Return type

str

Raises

get(resource_group_name: str, automation_account_name: str, webhook_name: str, **kwargs: Any) → azure.mgmt.automation.models._models_py3.Webhook[source]¶

Retrieve the webhook identified by webhook name.

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.

Keyword Arguments

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

Returns

Webhook or the result of cls(response)

Return type

Webhook

Raises

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

Retrieve a list of webhooks.

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.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[Webhook]

Raises

update(resource_group_name: str, automation_account_name: str, webhook_name: str, parameters: _models.WebhookUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Webhook[source]¶

update(resource_group_name: str, automation_account_name: str, webhook_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.Webhook

Update the webhook identified by webhook name.

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) – The update parameters for webhook. Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
cls (callable) – A custom type or function that will be passed the direct response

Returns

Webhook or the result of cls(response)

Return type

Webhook

Raises