DscConfigurationOperations Class

DscConfigurationOperations async 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.

Inheritance

builtins.object

DscConfigurationOperations

Constructor

DscConfigurationOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

Methods

create_or_update	Create the configuration identified by configuration name.
delete	Delete the dsc configuration identified by configuration name.
get	Retrieve the configuration identified by configuration name.
get_content	Retrieve the configuration script identified by configuration name.
list_by_automation_account	Retrieve a list of configurations.
update	Create the configuration identified by configuration name.

create_or_update

Create the configuration identified by configuration name.

async create_or_update(resource_group_name: str, automation_account_name: str, configuration_name: str, parameters: Union[str, azure.mgmt.automation.models._models_py3.DscConfigurationCreateOrUpdateParameters], **kwargs) -> azure.mgmt.automation.models._models_py3.DscConfiguration

Parameters

resource_group_name

str

Required

Name of an Azure Resource group.

automation_account_name

str

Required

The name of the automation account.

configuration_name

str

Required

The create or update parameters for configuration.

parameters

str or DscConfigurationCreateOrUpdateParameters

Required

The create or update parameters for configuration.

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

Exceptions

HttpResponseError

delete

Delete the dsc configuration identified by configuration name.

async delete(resource_group_name: str, automation_account_name: str, configuration_name: str, **kwargs) -> None

Parameters

resource_group_name

str

Required

Name of an Azure Resource group.

automation_account_name

str

Required

The name of the automation account.

configuration_name

str

Required

The configuration name.

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

Exceptions

HttpResponseError

get

Retrieve the configuration identified by configuration name.

async get(resource_group_name: str, automation_account_name: str, configuration_name: str, **kwargs) -> azure.mgmt.automation.models._models_py3.DscConfiguration

Parameters

resource_group_name

str

Required

Name of an Azure Resource group.

automation_account_name

str

Required

The name of the automation account.

configuration_name

str

Required

The configuration name.

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

Exceptions

HttpResponseError

get_content

Retrieve the configuration script identified by configuration name.

async get_content(resource_group_name: str, automation_account_name: str, configuration_name: str, **kwargs) -> IO

Parameters

resource_group_name

str

Required

Name of an Azure Resource group.

automation_account_name

str

Required

The name of the automation account.

configuration_name

str

Required

The configuration name.

cls

callable

A custom type or function that will be passed the direct response

Returns

IO, or the result of cls(response)

Return type

<xref:IO>

Exceptions

HttpResponseError

list_by_automation_account

Retrieve a list of configurations.

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) -> AsyncIterable[azure.mgmt.automation.models._models_py3.DscConfigurationListResult]

Parameters

resource_group_name

str

Required

Name of an Azure Resource group.

automation_account_name

str

Required

The name of the automation account.

filter

str

default value: None

The filter to apply on the operation.

skip

int

default value: None

The number of rows to skip.

top

int

default value: None

The number of rows to take.

inlinecount

str

default value: None

Return total rows.

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

AsyncItemPaged[DscConfigurationListResult]

Exceptions

HttpResponseError

update

Create the configuration identified by configuration name.

async update(resource_group_name: str, automation_account_name: str, configuration_name: str, parameters: Optional[Union[str, azure.mgmt.automation.models._models_py3.DscConfigurationUpdateParameters]] = None, **kwargs) -> azure.mgmt.automation.models._models_py3.DscConfiguration

Parameters

resource_group_name

str

Required

Name of an Azure Resource group.

automation_account_name

str

Required

The name of the automation account.

configuration_name

str

Required

The create or update parameters for configuration.

parameters

str or DscConfigurationUpdateParameters

default value: None

The create or update parameters for configuration.

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

Exceptions

HttpResponseError

Attributes

models

models = <module 'azure.mgmt.automation.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\automation\\models\\__init__.py'>