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

Name	Description
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

Name	Description
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: str | DscConfigurationCreateOrUpdateParameters, **kwargs) -> DscConfiguration

Parameters

Name	Description
resource_group_name Required	str Name of an Azure Resource group.
automation_account_name Required	str The name of the automation account.
configuration_name Required	str The create or update parameters for configuration.
parameters Required	str or DscConfigurationCreateOrUpdateParameters The create or update parameters for configuration.

Keyword-Only Parameters

Name	Description
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

Type	Description
DscConfiguration	DscConfiguration, or the result of cls(response)

Exceptions

Type	Description
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

Name	Description
resource_group_name Required	str Name of an Azure Resource group.
automation_account_name Required	str The name of the automation account.
configuration_name Required	str The configuration name.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
None	None, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Retrieve the configuration identified by configuration name.

async get(resource_group_name: str, automation_account_name: str, configuration_name: str, **kwargs) -> DscConfiguration

Parameters

Name	Description
resource_group_name Required	str Name of an Azure Resource group.
automation_account_name Required	str The name of the automation account.
configuration_name Required	str The configuration name.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
DscConfiguration	DscConfiguration, or the result of cls(response)

Exceptions

Type	Description
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

Name	Description
resource_group_name Required	str Name of an Azure Resource group.
automation_account_name Required	str The name of the automation account.
configuration_name Required	str The configuration name.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
IO	IO, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_automation_account

Retrieve a list of configurations.

list_by_automation_account(resource_group_name: str, automation_account_name: str, filter: str | None = None, skip: int | None = None, top: int | None = None, inlinecount: str | None = None, **kwargs) -> AsyncIterable[DscConfigurationListResult]

Parameters

Name	Description
resource_group_name Required	str Name of an Azure Resource group.
automation_account_name Required	str The name of the automation account.
filter	str The filter to apply on the operation. default value: None
skip	int The number of rows to skip. default value: None
top	int The number of rows to take. default value: None
inlinecount	str Return total rows. default value: None

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
AsyncItemPaged[DscConfigurationListResult]	An iterator like instance of either DscConfigurationListResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

update

Create the configuration identified by configuration name.

async update(resource_group_name: str, automation_account_name: str, configuration_name: str, parameters: str | DscConfigurationUpdateParameters | None = None, **kwargs) -> DscConfiguration

Parameters

Name	Description
resource_group_name Required	str Name of an Azure Resource group.
automation_account_name Required	str The name of the automation account.
configuration_name Required	str The create or update parameters for configuration.
parameters	str or DscConfigurationUpdateParameters The create or update parameters for configuration. default value: None

Keyword-Only Parameters

Name	Description
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

Type	Description
DscConfiguration	DscConfiguration, or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

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