ConfigServers interface

Package:

@azure/arm-appplatform

Interface representing a ConfigServers.

Methods

beginUpdatePatch(string, string, ConfigServerResource, ConfigServersUpdatePatchOptionalParams)	Update the config server.
beginUpdatePatchAndWait(string, string, ConfigServerResource, ConfigServersUpdatePatchOptionalParams)	Update the config server.
beginUpdatePut(string, string, ConfigServerResource, ConfigServersUpdatePutOptionalParams)	Update the config server.
beginUpdatePutAndWait(string, string, ConfigServerResource, ConfigServersUpdatePutOptionalParams)	Update the config server.
beginValidate(string, string, ConfigServerSettings, ConfigServersValidateOptionalParams)	Check if the config server settings are valid.
beginValidateAndWait(string, string, ConfigServerSettings, ConfigServersValidateOptionalParams)	Check if the config server settings are valid.
get(string, string, ConfigServersGetOptionalParams)	Get the config server and its properties.

Method Details

beginUpdatePatch(string, string, ConfigServerResource, ConfigServersUpdatePatchOptionalParams)

Update the config server.

function beginUpdatePatch(resourceGroupName: string, serviceName: string, configServerResource: ConfigServerResource, options?: ConfigServersUpdatePatchOptionalParams): Promise<SimplePollerLike<OperationState<ConfigServerResource>, ConfigServerResource>>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the Service resource.

configServerResource

ConfigServerResource

Parameters for the update operation

options

ConfigServersUpdatePatchOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<ConfigServerResource>, ConfigServerResource>>

beginUpdatePatchAndWait(string, string, ConfigServerResource, ConfigServersUpdatePatchOptionalParams)

Update the config server.

function beginUpdatePatchAndWait(resourceGroupName: string, serviceName: string, configServerResource: ConfigServerResource, options?: ConfigServersUpdatePatchOptionalParams): Promise<ConfigServerResource>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the Service resource.

configServerResource

ConfigServerResource

Parameters for the update operation

options

ConfigServersUpdatePatchOptionalParams

The options parameters.

Returns

Promise<ConfigServerResource>

beginUpdatePut(string, string, ConfigServerResource, ConfigServersUpdatePutOptionalParams)

Update the config server.

function beginUpdatePut(resourceGroupName: string, serviceName: string, configServerResource: ConfigServerResource, options?: ConfigServersUpdatePutOptionalParams): Promise<SimplePollerLike<OperationState<ConfigServerResource>, ConfigServerResource>>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the Service resource.

configServerResource

ConfigServerResource

Parameters for the update operation

options

ConfigServersUpdatePutOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<ConfigServerResource>, ConfigServerResource>>

beginUpdatePutAndWait(string, string, ConfigServerResource, ConfigServersUpdatePutOptionalParams)

Update the config server.

function beginUpdatePutAndWait(resourceGroupName: string, serviceName: string, configServerResource: ConfigServerResource, options?: ConfigServersUpdatePutOptionalParams): Promise<ConfigServerResource>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the Service resource.

configServerResource

ConfigServerResource

Parameters for the update operation

options

ConfigServersUpdatePutOptionalParams

The options parameters.

Returns

Promise<ConfigServerResource>

beginValidate(string, string, ConfigServerSettings, ConfigServersValidateOptionalParams)

Check if the config server settings are valid.

function beginValidate(resourceGroupName: string, serviceName: string, configServerSettings: ConfigServerSettings, options?: ConfigServersValidateOptionalParams): Promise<SimplePollerLike<OperationState<ConfigServerSettingsValidateResult>, ConfigServerSettingsValidateResult>>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the Service resource.

configServerSettings

ConfigServerSettings

Config server settings to be validated

options

ConfigServersValidateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<ConfigServerSettingsValidateResult>, ConfigServerSettingsValidateResult>>

beginValidateAndWait(string, string, ConfigServerSettings, ConfigServersValidateOptionalParams)

Check if the config server settings are valid.

function beginValidateAndWait(resourceGroupName: string, serviceName: string, configServerSettings: ConfigServerSettings, options?: ConfigServersValidateOptionalParams): Promise<ConfigServerSettingsValidateResult>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the Service resource.

configServerSettings

ConfigServerSettings

Config server settings to be validated

options

ConfigServersValidateOptionalParams

The options parameters.

Returns

Promise<ConfigServerSettingsValidateResult>

get(string, string, ConfigServersGetOptionalParams)

Get the config server and its properties.

function get(resourceGroupName: string, serviceName: string, options?: ConfigServersGetOptionalParams): Promise<ConfigServerResource>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the Service resource.

options

ConfigServersGetOptionalParams

The options parameters.

Returns

Promise<ConfigServerResource>