ConfigurationsOperations Class

  • Reference

ConfigurationsOperations 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
ConfigurationsOperations

Constructor

ConfigurationsOperations(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

begin_update

Configures the HTTP settings on the specified cluster. This API is deprecated, please use UpdateGatewaySettings in cluster endpoint instead.
get

The configuration object for the specified cluster. This API is not recommended and might be removed in the future. Please consider using List configurations API instead.
list

Gets all configuration information for an HDI cluster.

begin_update

Configures the HTTP settings on the specified cluster. This API is deprecated, please use UpdateGatewaySettings in cluster endpoint instead.

begin_update(resource_group_name: str, cluster_name: str, configuration_name: str, parameters: Dict[str, str], **kwargs: Any) -> LROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group.
cluster_name
Required
str

The name of the cluster.
configuration_name
Required
str

The name of the cluster configuration.
parameters
Required
dict[str, str]

The cluster configurations.

Keyword-Only Parameters

Name Description
cls
callable

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

A continuation token to restart a poller from a saved state.
polling
bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type Description
LROPoller[None]

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

Exceptions

Type Description
HttpResponseError

get

The configuration object for the specified cluster. This API is not recommended and might be removed in the future. Please consider using List configurations API instead.

get(resource_group_name: str, cluster_name: str, configuration_name: str, **kwargs: Any) -> Dict[str, str]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group.
cluster_name
Required
str

The name of the cluster.
configuration_name
Required
str

The name of the cluster configuration.

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
dict[str, str]

dict mapping str to str, or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list

Gets all configuration information for an HDI cluster.

list(resource_group_name: str, cluster_name: str, **kwargs: Any) -> _models.ClusterConfigurations

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group.
cluster_name
Required
str

The name of the cluster.

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
ClusterConfigurations

ClusterConfigurations, or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

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