ConfigServersOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

AppPlatformManagementClient's

<xref:config_servers> attribute.

Inheritance
builtins.object
ConfigServersOperations

Constructor

ConfigServersOperations(*args, **kwargs)

Methods

begin_update_patch

Update the config server.

begin_update_put

Update the config server.

begin_validate

Check if the config server settings are valid.

get

Get the config server and its properties.

begin_update_patch

Update the config server.

begin_update_patch(resource_group_name: str, service_name: str, config_server_resource: _models.ConfigServerResource, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.ConfigServerResource]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.

service_name
Required
str

The name of the Service resource. Required.

config_server_resource
Required

Parameters for the update operation. Is either a ConfigServerResource type or a IO type. Required.

Keyword-Only Parameters

Name Description
content_type
str

Body Parameter content-type. Known values are: 'application/json'. Default value is None.

cls

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

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

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

Exceptions

Type Description

begin_update_put

Update the config server.

begin_update_put(resource_group_name: str, service_name: str, config_server_resource: _models.ConfigServerResource, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.ConfigServerResource]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.

service_name
Required
str

The name of the Service resource. Required.

config_server_resource
Required

Parameters for the update operation. Is either a ConfigServerResource type or a IO type. Required.

Keyword-Only Parameters

Name Description
content_type
str

Body Parameter content-type. Known values are: 'application/json'. Default value is None.

cls

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

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

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

Exceptions

Type Description

begin_validate

Check if the config server settings are valid.

begin_validate(resource_group_name: str, service_name: str, config_server_settings: _models.ConfigServerSettings, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.ConfigServerSettingsValidateResult]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.

service_name
Required
str

The name of the Service resource. Required.

config_server_settings
Required

Config server settings to be validated. Is either a ConfigServerSettings type or a IO type. Required.

Keyword-Only Parameters

Name Description
content_type
str

Body Parameter content-type. Known values are: 'application/json'. Default value is None.

cls

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

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

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

Exceptions

Type Description

get

Get the config server and its properties.

get(resource_group_name: str, service_name: str, **kwargs: Any) -> ConfigServerResource

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. Required.

service_name
Required
str

The name of the Service resource. Required.

Keyword-Only Parameters

Name Description
cls

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

Returns

Type Description

ConfigServerResource or the result of cls(response)

Exceptions

Type Description

Attributes

models

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