azure.mgmt.automation.operations module

class azure.mgmt.automation.operations.RunbookDraftOperations(client, config, serializer, deserializer)

Bases: object

RunbookDraftOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

begin_replace_content(resource_group_name: str, automation_account_name: str, runbook_name: str, runbook_content: str, **kwargs: Any) → LROPoller[None]

Replaces the runbook draft content.

Parameters

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

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

• runbook_name (str) – The runbook name.

• runbook_content (str) – The runbook draft content.

Keyword Arguments

• 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) – True for ARMPolling, False for no polling, or a polling object for 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

HttpResponseError –

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

Retrieve the runbook draft identified by runbook name.

Parameters

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

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

• runbook_name (str) – The runbook name.

Keyword Arguments

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

Returns

RunbookDraft, or the result of cls(response)

Return type

RunbookDraft

Raises

~azure.core.exceptions.HttpResponseError

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

Retrieve the content of runbook draft identified by runbook name.

Parameters

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

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

• runbook_name (str) – The runbook name.

Keyword Arguments

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

Returns

str, or the result of cls(response)

Return type

str

Raises

~azure.core.exceptions.HttpResponseError

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

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

Parameters

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

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

• runbook_name (str) – The runbook name.

Keyword Arguments

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

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

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

class azure.mgmt.automation.operations.RunbookOperations(client, config, serializer, deserializer)

Bases: object

RunbookOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

begin_publish(resource_group_name: str, automation_account_name: str, runbook_name: str, **kwargs: Any) → LROPoller[None]

Publish runbook draft.

Parameters

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

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

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

Keyword Arguments

• 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) – True for ARMPolling, False for no polling, or a polling object for 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

HttpResponseError –

create_or_update(resource_group_name: str, automation_account_name: str, runbook_name: str, parameters: ‘_models.RunbookCreateOrUpdateParameters’, **kwargs: Any) → ’_models.Runbook’

Create the runbook identified by runbook name.

Parameters

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

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

• runbook_name (str) – The runbook name.

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

Keyword Arguments

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

Returns

Runbook, or the result of cls(response)

Return type

Runbook

Raises

~azure.core.exceptions.HttpResponseError

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

Delete the runbook by name.

Parameters

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

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

• runbook_name (str) – The runbook name.

Keyword Arguments

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

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

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

Retrieve the runbook identified by runbook name.

Parameters

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

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

• runbook_name (str) – The runbook name.

Keyword Arguments

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

Returns

Runbook, or the result of cls(response)

Return type

Runbook

Raises

~azure.core.exceptions.HttpResponseError

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

Retrieve the content of runbook identified by runbook name.

Parameters

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

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

• runbook_name (str) – The runbook name.

Keyword Arguments

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

Returns

str, or the result of cls(response)

Return type

str

Raises

~azure.core.exceptions.HttpResponseError

list_by_automation_account(resource_group_name: str, automation_account_name: str, **kwargs: Any) → Iterable[‘_models.RunbookListResult’]

Retrieve a list of runbooks.

Parameters

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

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[RunbookListResult]

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, automation_account_name: str, runbook_name: str, parameters: ‘_models.RunbookUpdateParameters’, **kwargs: Any) → ’_models.Runbook’

Update the runbook identified by runbook name.

Parameters

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

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

• runbook_name (str) – The runbook name.

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

Keyword Arguments

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

Returns

Runbook, or the result of cls(response)

Return type

Runbook

Raises

~azure.core.exceptions.HttpResponseError

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

class azure.mgmt.automation.operations.TestJobStreamsOperations(client, config, serializer, deserializer)

Bases: object

TestJobStreamsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

get(resource_group_name: str, automation_account_name: str, runbook_name: str, job_stream_id: str, **kwargs: Any) → ’_models.JobStream’

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

Parameters

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

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

• runbook_name (str) – The runbook name.

• job_stream_id (str) – The job stream id.

Keyword Arguments

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

Returns

JobStream, or the result of cls(response)

Return type

JobStream

Raises

~azure.core.exceptions.HttpResponseError

list_by_test_job(resource_group_name: str, automation_account_name: str, runbook_name: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[‘_models.JobStreamListResult’]

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

Parameters

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

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

• runbook_name (str) – The runbook name.

• filter (str) – The filter to apply on the operation.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[JobStreamListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

class azure.mgmt.automation.operations.TestJobOperations(client, config, serializer, deserializer)

Bases: object

TestJobOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

create(resource_group_name: str, automation_account_name: str, runbook_name: str, parameters: ‘_models.TestJobCreateParameters’, **kwargs: Any) → ’_models.TestJob’

Create a test job of the runbook.

Parameters

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

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

• runbook_name (str) – The parameters supplied to the create test job operation.

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

Keyword Arguments

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

Returns

TestJob, or the result of cls(response)

Return type

TestJob

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, automation_account_name: str, runbook_name: str, **kwargs: Any) → ’_models.TestJob’

Retrieve the test job for the specified runbook.

Parameters

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

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

• runbook_name (str) – The runbook name.

Keyword Arguments

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

Returns

TestJob, or the result of cls(response)

Return type

TestJob

Raises

~azure.core.exceptions.HttpResponseError

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

Resume the test job.

Parameters

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

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

• runbook_name (str) – The runbook name.

Keyword Arguments

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

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

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

Stop the test job.

Parameters

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

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

• runbook_name (str) – The runbook name.

Keyword Arguments

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

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

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

Suspend the test job.

Parameters

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

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

• runbook_name (str) – The runbook name.

Keyword Arguments

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

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

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

class azure.mgmt.automation.operations.Python2PackageOperations(client, config, serializer, deserializer)

Bases: object

Python2PackageOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

create_or_update(resource_group_name: str, automation_account_name: str, package_name: str, parameters: ‘_models.PythonPackageCreateParameters’, **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.

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

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

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

Keyword Arguments

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

Returns

Module, or the result of cls(response)

Return type

Module

Raises

~azure.core.exceptions.HttpResponseError

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

Delete the python 2 package by name.

Parameters

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

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

• package_name (str) – The python package name.

Keyword Arguments

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

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

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

Retrieve the python 2 package identified by package name.

Parameters

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

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

• package_name (str) – The python package name.

Keyword Arguments

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

Returns

Module, or the result of cls(response)

Return type

Module

Raises

~azure.core.exceptions.HttpResponseError

list_by_automation_account(resource_group_name: str, automation_account_name: str, **kwargs: Any) → Iterable[‘_models.ModuleListResult’]

Retrieve a list of python 2 packages.

Parameters

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

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ModuleListResult]

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, automation_account_name: str, package_name: str, parameters: ‘_models.PythonPackageUpdateParameters’, **kwargs: Any) → ’_models.Module’

Update the python 2 package identified by package name.

Parameters

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

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

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

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

Keyword Arguments

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

Returns

Module, or the result of cls(response)

Return type

Module

Raises

~azure.core.exceptions.HttpResponseError

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

class azure.mgmt.automation.operations.AgentRegistrationInformationOperations(client, config, serializer, deserializer)

Bases: object

AgentRegistrationInformationOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

get(resource_group_name: str, automation_account_name: str, **kwargs: Any) → ’_models.AgentRegistration’

Retrieve the automation agent registration information.

Parameters

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

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

Keyword Arguments

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

Returns

AgentRegistration, or the result of cls(response)

Return type

AgentRegistration

Raises

~azure.core.exceptions.HttpResponseError

regenerate_key(resource_group_name: str, automation_account_name: str, parameters: ‘_models.AgentRegistrationRegenerateKeyParameter’, **kwargs: Any) → ’_models.AgentRegistration’

Regenerate a primary or secondary agent registration key.

Parameters

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

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

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

Keyword Arguments

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

Returns

AgentRegistration, or the result of cls(response)

Return type

AgentRegistration

Raises

~azure.core.exceptions.HttpResponseError

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

class azure.mgmt.automation.operations.DscNodeOperations(client, config, serializer, deserializer)

Bases: object

DscNodeOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

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

Delete the dsc node identified by node id.

Parameters

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

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

• node_id (str) – The node id.

Keyword Arguments

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

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

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

Retrieve the dsc node identified by node id.

Parameters

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

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

• node_id (str) – The node id.

Keyword Arguments

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

Returns

DscNode, or the result of cls(response)

Return type

DscNode

Raises

~azure.core.exceptions.HttpResponseError

list_by_automation_account(resource_group_name: str, automation_account_name: str, filter: Optional[str] = None, skip: Optional[int] = None, top: Optional[int] = None, inlinecount: Optional[str] = None, **kwargs: Any) → Iterable[‘_models.DscNodeListResult’]

Retrieve a list of dsc nodes.

Parameters

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

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

• filter (str) – The filter to apply on the operation.

• skip (int) – The number of rows to skip.

• top (int) – The number of rows to take.

• inlinecount (str) – Return total rows.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[DscNodeListResult]

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, automation_account_name: str, node_id: str, dsc_node_update_parameters: ‘_models.DscNodeUpdateParameters’, **kwargs: Any) → ’_models.DscNode’

Update the dsc node.

Parameters

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

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

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

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

Keyword Arguments

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

Returns

DscNode, or the result of cls(response)

Return type

DscNode

Raises

~azure.core.exceptions.HttpResponseError

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

class azure.mgmt.automation.operations.NodeReportsOperations(client, config, serializer, deserializer)

Bases: object

NodeReportsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

get(resource_group_name: str, automation_account_name: str, node_id: str, report_id: str, **kwargs: Any) → ’_models.DscNodeReport’

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

Parameters

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

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

• node_id (str) – The Dsc node id.

• report_id (str) – The report id.

Keyword Arguments

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

Returns

DscNodeReport, or the result of cls(response)

Return type

DscNodeReport

Raises

~azure.core.exceptions.HttpResponseError

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

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

Parameters

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

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

• node_id (str) – The Dsc node id.

• report_id (str) – The report id.

Keyword Arguments

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

Returns

object, or the result of cls(response)

Return type

object

Raises

~azure.core.exceptions.HttpResponseError

list_by_node(resource_group_name: str, automation_account_name: str, node_id: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[‘_models.DscNodeReportListResult’]

Retrieve the Dsc node report list by node id.

Parameters

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

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

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

• filter (str) – The filter to apply on the operation.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[DscNodeReportListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

class azure.mgmt.automation.operations.DscCompilationJobOperations(client, config, serializer, deserializer)

Bases: object

DscCompilationJobOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

begin_create(resource_group_name: str, automation_account_name: str, compilation_job_name: str, parameters: ‘_models.DscCompilationJobCreateParameters’, **kwargs: Any) → LROPoller[‘_models.DscCompilationJob’]

Creates the Dsc compilation job of the configuration.

Parameters

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

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

• compilation_job_name (str) – The DSC configuration Id.

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

Keyword Arguments

• 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) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy

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

Returns

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

Return type

LROPoller[DscCompilationJob]

Raises

HttpResponseError –

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

Retrieve the Dsc configuration compilation job identified by job id.

Parameters

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

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

• compilation_job_name (str) – The DSC configuration Id.

Keyword Arguments

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

Returns

DscCompilationJob, or the result of cls(response)

Return type

DscCompilationJob

Raises

~azure.core.exceptions.HttpResponseError

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

Retrieve the job stream identified by job stream id.

Parameters

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

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

• job_id (str) – The job id.

• job_stream_id (str) – The job stream id.

Keyword Arguments

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

Returns

JobStream, or the result of cls(response)

Return type

JobStream

Raises

~azure.core.exceptions.HttpResponseError

list_by_automation_account(resource_group_name: str, automation_account_name: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[‘_models.DscCompilationJobListResult’]

Retrieve a list of dsc compilation jobs.

Parameters

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

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

• filter (str) – The filter to apply on the operation.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[DscCompilationJobListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

class azure.mgmt.automation.operations.DscCompilationJobStreamOperations(client, config, serializer, deserializer)

Bases: object

DscCompilationJobStreamOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

list_by_job(resource_group_name: str, automation_account_name: str, job_id: str, **kwargs: Any) → ’_models.JobStreamListResult’

Retrieve all the job streams for the compilation Job.

Parameters

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

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

• job_id (str) – The job id.

Keyword Arguments

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

Returns

JobStreamListResult, or the result of cls(response)

Return type

JobStreamListResult

Raises

~azure.core.exceptions.HttpResponseError

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

class azure.mgmt.automation.operations.DscNodeConfigurationOperations(client, config, serializer, deserializer)

Bases: object

DscNodeConfigurationOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

begin_create_or_update(resource_group_name: str, automation_account_name: str, node_configuration_name: str, parameters: ‘_models.DscNodeConfigurationCreateOrUpdateParameters’, **kwargs: Any) → LROPoller[‘_models.DscNodeConfiguration’]

Create the node configuration identified by node configuration name.

Parameters

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

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

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

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

Keyword Arguments

• 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) – True for ARMPolling, False for no polling, or a polling object for 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

HttpResponseError –

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

Delete the Dsc node configurations by node configuration.

Parameters

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

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

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

Keyword Arguments

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

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

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

Retrieve the Dsc node configurations by node configuration.

Parameters

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

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

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

Keyword Arguments

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

Returns

DscNodeConfiguration, or the result of cls(response)

Return type

DscNodeConfiguration

Raises

~azure.core.exceptions.HttpResponseError

list_by_automation_account(resource_group_name: str, automation_account_name: str, filter: Optional[str] = None, skip: Optional[int] = None, top: Optional[int] = None, inlinecount: Optional[str] = None, **kwargs: Any) → Iterable[‘_models.DscNodeConfigurationListResult’]

Retrieve a list of dsc node configurations.

Parameters

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

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

• filter (str) – The filter to apply on the operation.

• skip (int) – The number of rows to skip.

• top (int) – The number of rows to take.

• inlinecount (str) – Return total rows.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[DscNodeConfigurationListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

class azure.mgmt.automation.operations.NodeCountInformationOperations(client, config, serializer, deserializer)

Bases: object

NodeCountInformationOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

get(resource_group_name: str, automation_account_name: str, count_type: Union[str, ‘_models.CountType’], **kwargs: Any) → ’_models.NodeCounts’

Retrieve counts for Dsc Nodes.

Parameters

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

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

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

Keyword Arguments

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

Returns

NodeCounts, or the result of cls(response)

Return type

NodeCounts

Raises

~azure.core.exceptions.HttpResponseError

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

class azure.mgmt.automation.operations.SoftwareUpdateConfigurationRunsOperations(client, config, serializer, deserializer)

Bases: object

SoftwareUpdateConfigurationRunsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

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) → ’_models.SoftwareUpdateConfigurationRun’

Get a single software update configuration Run by Id.

Parameters

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

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

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

• client_request_id (str) – Identifies this specific client request.

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

SoftwareUpdateConfigurationRun

Raises

~azure.core.exceptions.HttpResponseError

list(resource_group_name: str, automation_account_name: str, client_request_id: Optional[str] = None, filter: Optional[str] = None, skip: Optional[str] = None, top: Optional[str] = None, **kwargs: Any) → ’_models.SoftwareUpdateConfigurationRunListResult’

Return list of software update configuration runs.

Parameters

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

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

• client_request_id (str) – Identifies this specific client request.

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

• skip (str) – Number of entries you skip before returning results.

• top (str) – Maximum number of entries returned in the results collection.

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

SoftwareUpdateConfigurationRunListResult

Raises

~azure.core.exceptions.HttpResponseError

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

class azure.mgmt.automation.operations.SoftwareUpdateConfigurationMachineRunsOperations(client, config, serializer, deserializer)

Bases: object

SoftwareUpdateConfigurationMachineRunsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

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) → ’_models.SoftwareUpdateConfigurationMachineRun’

Get a single software update configuration machine run by Id.

Parameters

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

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

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

• client_request_id (str) – Identifies this specific client request.

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

SoftwareUpdateConfigurationMachineRun

Raises

~azure.core.exceptions.HttpResponseError

list(resource_group_name: str, automation_account_name: str, client_request_id: Optional[str] = None, filter: Optional[str] = None, skip: Optional[str] = None, top: Optional[str] = None, **kwargs: Any) → ’_models.SoftwareUpdateConfigurationMachineRunListResult’

Return list of software update configuration machine runs.

Parameters

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

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

• client_request_id (str) – Identifies this specific client request.

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

• skip (str) – number of entries you skip before returning results.

• top (str) – Maximum number of entries returned in the results collection.

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

SoftwareUpdateConfigurationMachineRunListResult

Raises

~azure.core.exceptions.HttpResponseError

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

class azure.mgmt.automation.operations.SourceControlOperations(client, config, serializer, deserializer)

Bases: object

SourceControlOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

create_or_update(resource_group_name: str, automation_account_name: str, source_control_name: str, parameters: ‘_models.SourceControlCreateOrUpdateParameters’, **kwargs: Any) → ’_models.SourceControl’

Create a source control.

Parameters

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

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

• source_control_name (str) – The source control name.

• parameters (SourceControlCreateOrUpdateParameters) – The parameters supplied to the create or update source control operation.

Keyword Arguments

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

Returns

SourceControl, or the result of cls(response)

Return type

SourceControl

Raises

~azure.core.exceptions.HttpResponseError

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

Delete the source control.

Parameters

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

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

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

Keyword Arguments

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

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

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

Retrieve the source control identified by source control name.

Parameters

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

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

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

Keyword Arguments

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

Returns

SourceControl, or the result of cls(response)

Return type

SourceControl

Raises

~azure.core.exceptions.HttpResponseError

list_by_automation_account(resource_group_name: str, automation_account_name: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[‘_models.SourceControlListResult’]

Retrieve a list of source controls.

Parameters

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

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

• filter (str) – The filter to apply on the operation.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[SourceControlListResult]

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, automation_account_name: str, source_control_name: str, parameters: ‘_models.SourceControlUpdateParameters’, **kwargs: Any) → ’_models.SourceControl’

Update a source control.

Parameters

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

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

• source_control_name (str) – The source control name.

• parameters (SourceControlUpdateParameters) – The parameters supplied to the update source control operation.

Keyword Arguments

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

Returns

SourceControl, or the result of cls(response)

Return type

SourceControl

Raises

~azure.core.exceptions.HttpResponseError

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

class azure.mgmt.automation.operations.SourceControlSyncJobOperations(client, config, serializer, deserializer)

Bases: object

SourceControlSyncJobOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

create(resource_group_name: str, automation_account_name: str, source_control_name: str, source_control_sync_job_id: str, parameters: ‘_models.SourceControlSyncJobCreateParameters’, **kwargs: Any) → ’_models.SourceControlSyncJob’

Creates the sync job for a source control.

Parameters

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

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

• source_control_name (str) – The source control name.

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

• parameters (SourceControlSyncJobCreateParameters) – The parameters supplied to the create source control sync job operation.

Keyword Arguments

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

Returns

SourceControlSyncJob, or the result of cls(response)

Return type

SourceControlSyncJob

Raises

~azure.core.exceptions.HttpResponseError

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

Retrieve the source control sync job identified by job id.

Parameters

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

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

• source_control_name (str) – The source control name.

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

Keyword Arguments

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

Returns

SourceControlSyncJobById, or the result of cls(response)

Return type

SourceControlSyncJobById

Raises

~azure.core.exceptions.HttpResponseError

list_by_automation_account(resource_group_name: str, automation_account_name: str, source_control_name: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[‘_models.SourceControlSyncJobListResult’]

Retrieve a list of source control sync jobs.

Parameters

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

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

• source_control_name (str) – The source control name.

• filter (str) – The filter to apply on the operation.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[SourceControlSyncJobListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

class azure.mgmt.automation.operations.SourceControlSyncJobStreamsOperations(client, config, serializer, deserializer)

Bases: object

SourceControlSyncJobStreamsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

get(resource_group_name: str, automation_account_name: str, source_control_name: str, source_control_sync_job_id: str, stream_id: str, **kwargs: Any) → ’_models.SourceControlSyncJobStreamById’

Retrieve a sync job stream identified by stream id.

Parameters

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

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

• source_control_name (str) – The source control name.

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

• stream_id (str) – The id of the sync job stream.

Keyword Arguments

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

Returns

SourceControlSyncJobStreamById, or the result of cls(response)

Return type

SourceControlSyncJobStreamById

Raises

~azure.core.exceptions.HttpResponseError

list_by_sync_job(resource_group_name: str, automation_account_name: str, source_control_name: str, source_control_sync_job_id: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[‘_models.SourceControlSyncJobStreamsListBySyncJob’]

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

Parameters

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

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

• source_control_name (str) – The source control name.

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

• filter (str) – The filter to apply on the operation.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[SourceControlSyncJobStreamsListBySyncJob]

Raises

~azure.core.exceptions.HttpResponseError

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

class azure.mgmt.automation.operations.JobOperations(client, config, serializer, deserializer)

Bases: object

JobOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

create(resource_group_name: str, automation_account_name: str, job_name: str, parameters: ‘_models.JobCreateParameters’, client_request_id: Optional[str] = None, **kwargs: Any) → ’_models.Job’

Create a job of the runbook.

Parameters

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

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

• job_name (str) – The job name.

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

• client_request_id (str) – Identifies this specific client request.

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

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, automation_account_name: str, job_name: str, client_request_id: Optional[str] = None, **kwargs: Any) → ’_models.Job’

Retrieve the job identified by job name.

Parameters

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

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

• job_name (str) – The job name.

• client_request_id (str) – Identifies this specific client request.

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

~azure.core.exceptions.HttpResponseError

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

Retrieve the job output identified by job name.

Parameters

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

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

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

• client_request_id (str) – Identifies this specific client request.

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

~azure.core.exceptions.HttpResponseError

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

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

Parameters

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

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

• job_name (str) – The job name.

• client_request_id (str) – Identifies this specific client request.

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

~azure.core.exceptions.HttpResponseError

list_by_automation_account(resource_group_name: str, automation_account_name: str, filter: Optional[str] = None, client_request_id: Optional[str] = None, **kwargs: Any) → Iterable[‘_models.JobListResultV2’]

Retrieve a list of jobs.

Parameters

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

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

• filter (str) – The filter to apply on the operation.

• client_request_id (str) – Identifies this specific client request.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[JobListResultV2]

Raises

~azure.core.exceptions.HttpResponseError

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

Resume the job identified by jobName.

Parameters

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

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

• job_name (str) – The job name.

• client_request_id (str) – Identifies this specific client request.

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

None

Raises

~azure.core.exceptions.HttpResponseError

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

Stop the job identified by jobName.

Parameters

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

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

• job_name (str) – The job name.

• client_request_id (str) – Identifies this specific client request.

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

None

Raises

~azure.core.exceptions.HttpResponseError

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

Suspend the job identified by job name.

Parameters

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

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

• job_name (str) – The job name.

• client_request_id (str) – Identifies this specific client request.

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

None

Raises

~azure.core.exceptions.HttpResponseError

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

class azure.mgmt.automation.operations.JobStreamOperations(client, config, serializer, deserializer)

Bases: object

JobStreamOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

get(resource_group_name: str, automation_account_name: str, job_name: str, job_stream_id: str, client_request_id: Optional[str] = None, **kwargs: Any) → ’_models.JobStream’

Retrieve the job stream identified by job stream id.

Parameters

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

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

• job_name (str) – The job name.

• job_stream_id (str) – The job stream id.

• client_request_id (str) – Identifies this specific client request.

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

~azure.core.exceptions.HttpResponseError

list_by_job(resource_group_name: str, automation_account_name: str, job_name: str, filter: Optional[str] = None, client_request_id: Optional[str] = None, **kwargs: Any) → Iterable[‘_models.JobStreamListResult’]

Retrieve a list of jobs streams identified by job name.

Parameters

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

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

• job_name (str) – The job name.

• filter (str) – The filter to apply on the operation.

• client_request_id (str) – Identifies this specific client request.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[JobStreamListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

class azure.mgmt.automation.operations.AutomationAccountOperations(client, config, serializer, deserializer)

Bases: object

AutomationAccountOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

create_or_update(resource_group_name: str, automation_account_name: str, parameters: ‘_models.AutomationAccountCreateOrUpdateParameters’, **kwargs: Any) → ’_models.AutomationAccount’

Create or update automation account.

Parameters

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

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

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

Keyword Arguments

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

Returns

AutomationAccount, or the result of cls(response)

Return type

AutomationAccount

Raises

~azure.core.exceptions.HttpResponseError

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

Delete an automation account.

Parameters

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

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

Keyword Arguments

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

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

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

Get information about an Automation Account.

Parameters

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

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

Keyword Arguments

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

Returns

AutomationAccount, or the result of cls(response)

Return type

AutomationAccount

Raises

~azure.core.exceptions.HttpResponseError

list(**kwargs: Any) → Iterable[‘_models.AutomationAccountListResult’]

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 AutomationAccountListResult or the result of cls(response)

Return type

ItemPaged[AutomationAccountListResult]

Raises

~azure.core.exceptions.HttpResponseError

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[‘_models.AutomationAccountListResult’]

Retrieve a list of accounts within a given resource group.

Parameters

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[AutomationAccountListResult]

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, automation_account_name: str, parameters: ‘_models.AutomationAccountUpdateParameters’, **kwargs: Any) → ’_models.AutomationAccount’

Update an automation account.

Parameters

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

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

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

Keyword Arguments

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

Returns

AutomationAccount, or the result of cls(response)

Return type

AutomationAccount

Raises

~azure.core.exceptions.HttpResponseError

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

class azure.mgmt.automation.operations.StatisticsOperations(client, config, serializer, deserializer)

Bases: object

StatisticsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

list_by_automation_account(resource_group_name: str, automation_account_name: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[‘_models.StatisticsListResult’]

Retrieve the statistics for the account.

Parameters

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

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

• filter (str) – The filter to apply on the operation.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[StatisticsListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

class azure.mgmt.automation.operations.UsagesOperations(client, config, serializer, deserializer)

Bases: object

UsagesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

list_by_automation_account(resource_group_name: str, automation_account_name: str, **kwargs: Any) → Iterable[‘_models.UsageListResult’]

Retrieve the usage for the account id.

Parameters

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

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[UsageListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

class azure.mgmt.automation.operations.KeysOperations(client, config, serializer, deserializer)

Bases: object

KeysOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

list_by_automation_account(resource_group_name: str, automation_account_name: str, **kwargs: Any) → ’_models.KeyListResult’

Retrieve the automation keys for an account.

Parameters

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

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

Keyword Arguments

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

Returns

KeyListResult, or the result of cls(response)

Return type

KeyListResult

Raises

~azure.core.exceptions.HttpResponseError

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

class azure.mgmt.automation.operations.CertificateOperations(client, config, serializer, deserializer)

Bases: object

CertificateOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

create_or_update(resource_group_name: str, automation_account_name: str, certificate_name: str, parameters: ‘_models.CertificateCreateOrUpdateParameters’, **kwargs: Any) → ’_models.Certificate’

Create a certificate.

Parameters

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

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

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

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

Keyword Arguments

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

Returns

Certificate, or the result of cls(response)

Return type

Certificate

Raises

~azure.core.exceptions.HttpResponseError

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

Delete the certificate.

Parameters

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

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

• certificate_name (str) – The name of certificate.

Keyword Arguments

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

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

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

Retrieve the certificate identified by certificate name.

Parameters

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

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

• certificate_name (str) – The name of certificate.

Keyword Arguments

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

Returns

Certificate, or the result of cls(response)

Return type

Certificate

Raises

~azure.core.exceptions.HttpResponseError

list_by_automation_account(resource_group_name: str, automation_account_name: str, **kwargs: Any) → Iterable[‘_models.CertificateListResult’]

Retrieve a list of certificates.

Parameters

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

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[CertificateListResult]

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, automation_account_name: str, certificate_name: str, parameters: ‘_models.CertificateUpdateParameters’, **kwargs: Any) → ’_models.Certificate’

Update a certificate.

Parameters

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

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

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

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

Keyword Arguments

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

Returns

Certificate, or the result of cls(response)

Return type

Certificate

Raises

~azure.core.exceptions.HttpResponseError

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

class azure.mgmt.automation.operations.ConnectionOperations(client, config, serializer, deserializer)

Bases: object

ConnectionOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

create_or_update(resource_group_name: str, automation_account_name: str, connection_name: str, parameters: ‘_models.ConnectionCreateOrUpdateParameters’, **kwargs: Any) → ’_models.Connection’

Create or update a connection.

Parameters

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

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

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

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

Keyword Arguments

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

Returns

Connection, or the result of cls(response)

Return type

Connection

Raises

~azure.core.exceptions.HttpResponseError

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

Delete the connection.

Parameters

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

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

• connection_name (str) – The name of connection.

Keyword Arguments

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

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

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

Retrieve the connection identified by connection name.

Parameters

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

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

• connection_name (str) – The name of connection.

Keyword Arguments

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

Returns

Connection, or the result of cls(response)

Return type

Connection

Raises

~azure.core.exceptions.HttpResponseError

list_by_automation_account(resource_group_name: str, automation_account_name: str, **kwargs: Any) → Iterable[‘_models.ConnectionListResult’]

Retrieve a list of connections.

Parameters

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

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ConnectionListResult]

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, automation_account_name: str, connection_name: str, parameters: ‘_models.ConnectionUpdateParameters’, **kwargs: Any) → ’_models.Connection’

Update a connection.

Parameters

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

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

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

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

Keyword Arguments

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

Returns

Connection, or the result of cls(response)

Return type

Connection

Raises

~azure.core.exceptions.HttpResponseError

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

class azure.mgmt.automation.operations.ConnectionTypeOperations(client, config, serializer, deserializer)

Bases: object

ConnectionTypeOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

create_or_update(resource_group_name: str, automation_account_name: str, connection_type_name: str, parameters: ‘_models.ConnectionTypeCreateOrUpdateParameters’, **kwargs: Any) → ’_models.ConnectionType’

Create a connection type.

Parameters

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

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

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

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

Keyword Arguments

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

Returns

ConnectionType, or the result of cls(response)

Return type

ConnectionType

Raises

~azure.core.exceptions.HttpResponseError

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

Delete the connection type.

Parameters

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

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

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

Keyword Arguments

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

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

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

Retrieve the connection type identified by connection type name.

Parameters

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

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

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

Keyword Arguments

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

Returns

ConnectionType, or the result of cls(response)

Return type

ConnectionType

Raises

~azure.core.exceptions.HttpResponseError

list_by_automation_account(resource_group_name: str, automation_account_name: str, **kwargs: Any) → Iterable[‘_models.ConnectionTypeListResult’]

Retrieve a list of connection types.

Parameters

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

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ConnectionTypeListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

class azure.mgmt.automation.operations.CredentialOperations(client, config, serializer, deserializer)

Bases: object

CredentialOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

create_or_update(resource_group_name: str, automation_account_name: str, credential_name: str, parameters: ‘_models.CredentialCreateOrUpdateParameters’, **kwargs: Any) → ’_models.Credential’

Create a credential.

Parameters

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

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

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

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

Keyword Arguments

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

Returns

Credential, or the result of cls(response)

Return type

Credential

Raises

~azure.core.exceptions.HttpResponseError

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

Delete the credential.

Parameters

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

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

• credential_name (str) – The name of credential.

Keyword Arguments

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

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

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

Retrieve the credential identified by credential name.

Parameters

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

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

• credential_name (str) – The name of credential.

Keyword Arguments

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

Returns

Credential, or the result of cls(response)

Return type

Credential

Raises

~azure.core.exceptions.HttpResponseError

list_by_automation_account(resource_group_name: str, automation_account_name: str, **kwargs: Any) → Iterable[‘_models.CredentialListResult’]

Retrieve a list of credentials.

Parameters

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

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[CredentialListResult]

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, automation_account_name: str, credential_name: str, parameters: ‘_models.CredentialUpdateParameters’, **kwargs: Any) → ’_models.Credential’

Update a credential.

Parameters

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

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

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

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

Keyword Arguments

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

Returns

Credential, or the result of cls(response)

Return type

Credential

Raises

~azure.core.exceptions.HttpResponseError

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

class azure.mgmt.automation.operations.DscConfigurationOperations(client, config, serializer, deserializer)

Bases: object

DscConfigurationOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

create_or_update(resource_group_name: str, automation_account_name: str, configuration_name: str, parameters: Union[str, ‘_models.DscConfigurationCreateOrUpdateParameters’], **kwargs: Any) → ’_models.DscConfiguration’

Create the configuration identified by configuration name.

Parameters

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

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

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

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

Keyword Arguments

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

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

Returns

DscConfiguration, or the result of cls(response)

Return type

DscConfiguration

Raises

~azure.core.exceptions.HttpResponseError

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

Delete the dsc configuration identified by configuration name.

Parameters

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

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

• configuration_name (str) – The configuration name.

Keyword Arguments

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

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

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

Retrieve the configuration identified by configuration name.

Parameters

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

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

• configuration_name (str) – The configuration name.

Keyword Arguments

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

Returns

DscConfiguration, or the result of cls(response)

Return type

DscConfiguration

Raises

~azure.core.exceptions.HttpResponseError

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

Retrieve the configuration script identified by configuration name.

Parameters

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

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

• configuration_name (str) – The configuration name.

Keyword Arguments

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

Returns

str, or the result of cls(response)

Return type

str

Raises

~azure.core.exceptions.HttpResponseError

list_by_automation_account(resource_group_name: str, automation_account_name: str, filter: Optional[str] = None, skip: Optional[int] = None, top: Optional[int] = None, inlinecount: Optional[str] = None, **kwargs: Any) → Iterable[‘_models.DscConfigurationListResult’]

Retrieve a list of configurations.

Parameters

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

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

• filter (str) – The filter to apply on the operation.

• skip (int) – The number of rows to skip.

• top (int) – The number of rows to take.

• inlinecount (str) – Return total rows.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[DscConfigurationListResult]

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, automation_account_name: str, configuration_name: str, parameters: Optional[Union[str, ‘_models.DscConfigurationUpdateParameters’]] = None, **kwargs: Any) → ’_models.DscConfiguration’

Create the configuration identified by configuration name.

Parameters

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

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

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

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

Keyword Arguments

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

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

Returns

DscConfiguration, or the result of cls(response)

Return type

DscConfiguration

Raises

~azure.core.exceptions.HttpResponseError

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

class azure.mgmt.automation.operations.SoftwareUpdateConfigurationsOperations(client, config, serializer, deserializer)

Bases: object

SoftwareUpdateConfigurationsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

create(resource_group_name: str, automation_account_name: str, software_update_configuration_name: str, parameters: ‘_models.SoftwareUpdateConfiguration’, client_request_id: Optional[str] = None, **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.

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

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

• parameters (SoftwareUpdateConfiguration) – Request body.

• client_request_id (str) – Identifies this specific client request.

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

SoftwareUpdateConfiguration

Raises

~azure.core.exceptions.HttpResponseError

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

delete a specific software update configuration.

Parameters

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

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

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

• client_request_id (str) – Identifies this specific client request.

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

None

Raises

~azure.core.exceptions.HttpResponseError

get_by_name(resource_group_name: str, automation_account_name: str, software_update_configuration_name: str, client_request_id: Optional[str] = None, **kwargs: Any) → ’_models.SoftwareUpdateConfiguration’

Get a single software update configuration by name.

Parameters

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

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

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

• client_request_id (str) – Identifies this specific client request.

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

SoftwareUpdateConfiguration

Raises

~azure.core.exceptions.HttpResponseError

list(resource_group_name: str, automation_account_name: str, client_request_id: Optional[str] = None, filter: Optional[str] = None, **kwargs: Any) → ’_models.SoftwareUpdateConfigurationListResult’

Get all software update configurations for the account.

Parameters

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

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

• client_request_id (str) – Identifies this specific client request.

• filter (str) – The filter to apply on the operation.

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

SoftwareUpdateConfigurationListResult

Raises

~azure.core.exceptions.HttpResponseError

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

class azure.mgmt.automation.operations.HybridRunbookWorkerGroupOperations(client, config, serializer, deserializer)

Bases: object

HybridRunbookWorkerGroupOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

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

Delete a hybrid runbook worker group.

Parameters

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

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

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

Keyword Arguments

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

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

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

Retrieve a hybrid runbook worker group.

Parameters

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

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

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

Keyword Arguments

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

Returns

HybridRunbookWorkerGroup, or the result of cls(response)

Return type

HybridRunbookWorkerGroup

Raises

~azure.core.exceptions.HttpResponseError

list_by_automation_account(resource_group_name: str, automation_account_name: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[‘_models.HybridRunbookWorkerGroupsListResult’]

Retrieve a list of hybrid runbook worker groups.

Parameters

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

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

• filter (str) – The filter to apply on the operation.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[HybridRunbookWorkerGroupsListResult]

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, automation_account_name: str, hybrid_runbook_worker_group_name: str, parameters: ‘_models.HybridRunbookWorkerGroupUpdateParameters’, **kwargs: Any) → ’_models.HybridRunbookWorkerGroup’

Update a hybrid runbook worker group.

Parameters

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

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

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

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

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

~azure.core.exceptions.HttpResponseError

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

class azure.mgmt.automation.operations.JobScheduleOperations(client, config, serializer, deserializer)

Bases: object

JobScheduleOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

create(resource_group_name: str, automation_account_name: str, job_schedule_id: str, parameters: ‘_models.JobScheduleCreateParameters’, **kwargs: Any) → ’_models.JobSchedule’

Create a job schedule.

Parameters

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

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

• job_schedule_id (str) – The job schedule name.

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

Keyword Arguments

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

Returns

JobSchedule, or the result of cls(response)

Return type

JobSchedule

Raises

~azure.core.exceptions.HttpResponseError

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

Delete the job schedule identified by job schedule name.

Parameters

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

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

• job_schedule_id (str) – The job schedule name.

Keyword Arguments

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

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

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

Retrieve the job schedule identified by job schedule name.

Parameters

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

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

• job_schedule_id (str) – The job schedule name.

Keyword Arguments

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

Returns

JobSchedule, or the result of cls(response)

Return type

JobSchedule

Raises

~azure.core.exceptions.HttpResponseError

list_by_automation_account(resource_group_name: str, automation_account_name: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[‘_models.JobScheduleListResult’]

Retrieve a list of job schedules.

Parameters

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

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

• filter (str) – The filter to apply on the operation.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[JobScheduleListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

class azure.mgmt.automation.operations.LinkedWorkspaceOperations(client, config, serializer, deserializer)

Bases: object

LinkedWorkspaceOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

get(resource_group_name: str, automation_account_name: str, **kwargs: Any) → ’_models.LinkedWorkspace’

Retrieve the linked workspace for the account id.

Parameters

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

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

Keyword Arguments

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

Returns

LinkedWorkspace, or the result of cls(response)

Return type

LinkedWorkspace

Raises

~azure.core.exceptions.HttpResponseError

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

class azure.mgmt.automation.operations.ActivityOperations(client, config, serializer, deserializer)

Bases: object

ActivityOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

get(resource_group_name: str, automation_account_name: str, module_name: str, activity_name: str, **kwargs: Any) → ’_models.Activity’

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

Parameters

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

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

• module_name (str) – The name of module.

• activity_name (str) – The name of activity.

Keyword Arguments

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

Returns

Activity, or the result of cls(response)

Return type

Activity

Raises

~azure.core.exceptions.HttpResponseError

list_by_module(resource_group_name: str, automation_account_name: str, module_name: str, **kwargs: Any) → Iterable[‘_models.ActivityListResult’]

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

Parameters

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

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

• module_name (str) – The name of module.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ActivityListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

class azure.mgmt.automation.operations.ModuleOperations(client, config, serializer, deserializer)

Bases: object

ModuleOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

create_or_update(resource_group_name: str, automation_account_name: str, module_name: str, parameters: ‘_models.ModuleCreateOrUpdateParameters’, **kwargs: Any) → ’_models.Module’

Create or Update the module identified by module name.

Parameters

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

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

• module_name (str) – The name of module.

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

Keyword Arguments

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

Returns

Module, or the result of cls(response)

Return type

Module

Raises

~azure.core.exceptions.HttpResponseError

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

Delete the module by name.

Parameters

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

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

• module_name (str) – The module name.

Keyword Arguments

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

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

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

Retrieve the module identified by module name.

Parameters

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

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

• module_name (str) – The module name.

Keyword Arguments

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

Returns

Module, or the result of cls(response)

Return type

Module

Raises

~azure.core.exceptions.HttpResponseError

list_by_automation_account(resource_group_name: str, automation_account_name: str, **kwargs: Any) → Iterable[‘_models.ModuleListResult’]

Retrieve a list of modules.

Parameters

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

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ModuleListResult]

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, automation_account_name: str, module_name: str, parameters: ‘_models.ModuleUpdateParameters’, **kwargs: Any) → ’_models.Module’

Update the module identified by module name.

Parameters

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

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

• module_name (str) – The name of module.

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

Keyword Arguments

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

Returns

Module, or the result of cls(response)

Return type

Module

Raises

~azure.core.exceptions.HttpResponseError

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

class azure.mgmt.automation.operations.ObjectDataTypesOperations(client, config, serializer, deserializer)

Bases: object

ObjectDataTypesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

list_fields_by_module_and_type(resource_group_name: str, automation_account_name: str, module_name: str, type_name: str, **kwargs: Any) → Iterable[‘_models.TypeFieldListResult’]

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

Parameters

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

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

• module_name (str) – The name of module.

• type_name (str) – The name of type.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[TypeFieldListResult]

Raises

~azure.core.exceptions.HttpResponseError

list_fields_by_type(resource_group_name: str, automation_account_name: str, type_name: str, **kwargs: Any) → Iterable[‘_models.TypeFieldListResult’]

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

Parameters

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

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

• type_name (str) – The name of type.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[TypeFieldListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

class azure.mgmt.automation.operations.FieldsOperations(client, config, serializer, deserializer)

Bases: object

FieldsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

list_by_type(resource_group_name: str, automation_account_name: str, module_name: str, type_name: str, **kwargs: Any) → Iterable[‘_models.TypeFieldListResult’]

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

Parameters

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

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

• module_name (str) – The name of module.

• type_name (str) – The name of type.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[TypeFieldListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

class azure.mgmt.automation.operations.Operations(client, config, serializer, deserializer)

Bases: object

Operations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

list(**kwargs: Any) → Iterable[‘_models.OperationListResult’]

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 OperationListResult or the result of cls(response)

Return type

ItemPaged[OperationListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

class azure.mgmt.automation.operations.ScheduleOperations(client, config, serializer, deserializer)

Bases: object

ScheduleOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

create_or_update(resource_group_name: str, automation_account_name: str, schedule_name: str, parameters: ‘_models.ScheduleCreateOrUpdateParameters’, **kwargs: Any) → Optional[‘_models.Schedule’]

Create a schedule.

Parameters

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

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

• schedule_name (str) – The schedule name.

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

Keyword Arguments

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

Returns

Schedule, or the result of cls(response)

Return type

Schedule or None

Raises

~azure.core.exceptions.HttpResponseError

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

Delete the schedule identified by schedule name.

Parameters

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

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

• schedule_name (str) – The schedule name.

Keyword Arguments

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

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

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

Retrieve the schedule identified by schedule name.

Parameters

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

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

• schedule_name (str) – The schedule name.

Keyword Arguments

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

Returns

Schedule, or the result of cls(response)

Return type

Schedule

Raises

~azure.core.exceptions.HttpResponseError

list_by_automation_account(resource_group_name: str, automation_account_name: str, **kwargs: Any) → Iterable[‘_models.ScheduleListResult’]

Retrieve a list of schedules.

Parameters

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

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ScheduleListResult]

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, automation_account_name: str, schedule_name: str, parameters: ‘_models.ScheduleUpdateParameters’, **kwargs: Any) → ’_models.Schedule’

Update the schedule identified by schedule name.

Parameters

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

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

• schedule_name (str) – The schedule name.

• parameters (ScheduleUpdateParameters) – The parameters supplied to the update schedule operation.

Keyword Arguments

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

Returns

Schedule, or the result of cls(response)

Return type

Schedule

Raises

~azure.core.exceptions.HttpResponseError

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

class azure.mgmt.automation.operations.VariableOperations(client, config, serializer, deserializer)

Bases: object

VariableOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

create_or_update(resource_group_name: str, automation_account_name: str, variable_name: str, parameters: ‘_models.VariableCreateOrUpdateParameters’, **kwargs: Any) → ’_models.Variable’

Create a variable.

Parameters

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

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

• variable_name (str) – The variable name.

• parameters (VariableCreateOrUpdateParameters) – The parameters supplied to the create or update variable operation.

Keyword Arguments

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

Returns

Variable, or the result of cls(response)

Return type

Variable

Raises

~azure.core.exceptions.HttpResponseError

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

Delete the variable.

Parameters

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

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

• variable_name (str) – The name of variable.

Keyword Arguments

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

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, automation_account_name: str, variable_name: str, **kwargs: Any) → ’_models.Variable’

Retrieve the variable identified by variable name.

Parameters

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

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

• variable_name (str) – The name of variable.

Keyword Arguments

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

Returns

Variable, or the result of cls(response)

Return type

Variable

Raises

~azure.core.exceptions.HttpResponseError

list_by_automation_account(resource_group_name: str, automation_account_name: str, **kwargs: Any) → Iterable[‘_models.VariableListResult’]

Retrieve a list of variables.

Parameters

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

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[VariableListResult]

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, automation_account_name: str, variable_name: str, parameters: ‘_models.VariableUpdateParameters’, **kwargs: Any) → ’_models.Variable’

Update a variable.

Parameters

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

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

• variable_name (str) – The variable name.

• parameters (VariableUpdateParameters) – The parameters supplied to the update variable operation.

Keyword Arguments

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

Returns

Variable, or the result of cls(response)

Return type

Variable

Raises

~azure.core.exceptions.HttpResponseError

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

class azure.mgmt.automation.operations.WatcherOperations(client, config, serializer, deserializer)

Bases: object

WatcherOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

create_or_update(resource_group_name: str, automation_account_name: str, watcher_name: str, parameters: ‘_models.Watcher’, **kwargs: Any) → ’_models.Watcher’

Create the watcher identified by watcher name.

Parameters

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

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

• watcher_name (str) – The watcher name.

• parameters (Watcher) – The create or update parameters for watcher.

Keyword Arguments

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

Returns

Watcher, or the result of cls(response)

Return type

Watcher

Raises

~azure.core.exceptions.HttpResponseError

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

Delete the watcher by name.

Parameters

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

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

• watcher_name (str) – The watcher name.

Keyword Arguments

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

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, automation_account_name: str, watcher_name: str, **kwargs: Any) → ’_models.Watcher’

Retrieve the watcher identified by watcher name.

Parameters

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

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

• watcher_name (str) – The watcher name.

Keyword Arguments

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

Returns

Watcher, or the result of cls(response)

Return type

Watcher

Raises

~azure.core.exceptions.HttpResponseError

list_by_automation_account(resource_group_name: str, automation_account_name: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[‘_models.WatcherListResult’]

Retrieve a list of watchers.

Parameters

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

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

• filter (str) – The filter to apply on the operation.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[WatcherListResult]

Raises

~azure.core.exceptions.HttpResponseError

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

Resume the watcher identified by watcher name.

Parameters

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

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

• watcher_name (str) – The watcher name.

Keyword Arguments

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

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

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

Resume the watcher identified by watcher name.

Parameters

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

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

• watcher_name (str) – The watcher name.

Keyword Arguments

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

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, automation_account_name: str, watcher_name: str, parameters: ‘_models.WatcherUpdateParameters’, **kwargs: Any) → ’_models.Watcher’

Update the watcher identified by watcher name.

Parameters

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

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

• watcher_name (str) – The watcher name.

• parameters (WatcherUpdateParameters) – The update parameters for watcher.

Keyword Arguments

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

Returns

Watcher, or the result of cls(response)

Return type

Watcher

Raises

~azure.core.exceptions.HttpResponseError

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

class azure.mgmt.automation.operations.WebhookOperations(client, config, serializer, deserializer)

Bases: object

WebhookOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

• client – Client for service requests.

• config – Configuration of service client.

• serializer – An object model serializer.

• deserializer – An object model deserializer.

create_or_update(resource_group_name: str, automation_account_name: str, webhook_name: str, parameters: ‘_models.WebhookCreateOrUpdateParameters’, **kwargs: Any) → ’_models.Webhook’

Create the webhook identified by webhook name.

Parameters

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

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

• webhook_name (str) – The webhook name.

• parameters (WebhookCreateOrUpdateParameters) – The create or update parameters for webhook.

Keyword Arguments

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

Returns

Webhook, or the result of cls(response)

Return type

Webhook

Raises

~azure.core.exceptions.HttpResponseError

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

Delete the webhook by name.

Parameters

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

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

• webhook_name (str) – The webhook name.

Keyword Arguments

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

Returns

None, or the result of cls(response)

Return type

None

Raises

~azure.core.exceptions.HttpResponseError

generate_uri(resource_group_name: str, automation_account_name: str, **kwargs: Any) → str

Generates a Uri for use in creating a webhook.

Parameters

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

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

Keyword Arguments

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

Returns

str, or the result of cls(response)

Return type

str

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, automation_account_name: str, webhook_name: str, **kwargs: Any) → ’_models.Webhook’

Retrieve the webhook identified by webhook name.

Parameters

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

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

• webhook_name (str) – The webhook name.

Keyword Arguments

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

Returns

Webhook, or the result of cls(response)

Return type

Webhook

Raises

~azure.core.exceptions.HttpResponseError

list_by_automation_account(resource_group_name: str, automation_account_name: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[‘_models.WebhookListResult’]

Retrieve a list of webhooks.

Parameters

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

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

• filter (str) – The filter to apply on the operation.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[WebhookListResult]

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, automation_account_name: str, webhook_name: str, parameters: ‘_models.WebhookUpdateParameters’, **kwargs: Any) → ’_models.Webhook’

Update the webhook identified by webhook name.

Parameters

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

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

• webhook_name (str) – The webhook name.

• parameters (WebhookUpdateParameters) – The update parameters for webhook.

Keyword Arguments

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

Returns

Webhook, or the result of cls(response)

Return type

Webhook

Raises

~azure.core.exceptions.HttpResponseError

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