Package version:

Interface ConfigServers

Interface representing a ConfigServers.

Hierarchy

ConfigServers

Index

Methods

beginUpdatePatch beginUpdatePatchAndWait beginUpdatePut beginUpdatePutAndWait beginValidate beginValidateAndWait get

Methods

beginUpdatePatch

beginUpdatePatch(resourceGroupName: string, serviceName: string, configServerResource: ConfigServerResource, options?: ConfigServersUpdatePatchOptionalParams): Promise<PollerLike<PollOperationState<ConfigServerResource>, ConfigServerResource>>
Update the config server.
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
- Optional options: ConfigServersUpdatePatchOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<ConfigServerResource>, ConfigServerResource>>
- Defined in operationsInterfaces/configServers.ts:78

beginUpdatePatchAndWait

beginUpdatePatchAndWait(resourceGroupName: string, serviceName: string, configServerResource: ConfigServerResource, options?: ConfigServersUpdatePatchOptionalParams): Promise<ConfigServerResource>
Update the config server.
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
- Optional options: ConfigServersUpdatePatchOptionalParams
  
  The options parameters.
Returns Promise<ConfigServerResource>
- Defined in operationsInterfaces/configServers.ts:97

beginUpdatePut

beginUpdatePut(resourceGroupName: string, serviceName: string, configServerResource: ConfigServerResource, options?: ConfigServersUpdatePutOptionalParams): Promise<PollerLike<PollOperationState<ConfigServerResource>, ConfigServerResource>>
Update the config server.
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
- Optional options: ConfigServersUpdatePutOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<ConfigServerResource>, ConfigServerResource>>
- Defined in operationsInterfaces/configServers.ts:45

beginUpdatePutAndWait

beginUpdatePutAndWait(resourceGroupName: string, serviceName: string, configServerResource: ConfigServerResource, options?: ConfigServersUpdatePutOptionalParams): Promise<ConfigServerResource>
Update the config server.
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
- Optional options: ConfigServersUpdatePutOptionalParams
  
  The options parameters.
Returns Promise<ConfigServerResource>
- Defined in operationsInterfaces/configServers.ts:64

beginValidate

beginValidate(resourceGroupName: string, serviceName: string, configServerSettings: ConfigServerSettings, options?: ConfigServersValidateOptionalParams): Promise<PollerLike<PollOperationState<ConfigServerSettingsValidateResult>, ConfigServerSettingsValidateResult>>
Check if the config server settings are valid.
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
- Optional options: ConfigServersValidateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<ConfigServerSettingsValidateResult>, ConfigServerSettingsValidateResult>>
- Defined in operationsInterfaces/configServers.ts:111

beginValidateAndWait

beginValidateAndWait(resourceGroupName: string, serviceName: string, configServerSettings: ConfigServerSettings, options?: ConfigServersValidateOptionalParams): Promise<ConfigServerSettingsValidateResult>
Check if the config server settings are valid.
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
- Optional options: ConfigServersValidateOptionalParams
  
  The options parameters.
Returns Promise<ConfigServerSettingsValidateResult>
- Defined in operationsInterfaces/configServers.ts:130

get

get(resourceGroupName: string, serviceName: string, options?: ConfigServersGetOptionalParams): Promise<ConfigServerResource>
Get the config server and its properties.
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.
- Optional options: ConfigServersGetOptionalParams
  
  The options parameters.
Returns Promise<ConfigServerResource>
- Defined in operationsInterfaces/configServers.ts:32

Interface ConfigServers

Hierarchy

Index

Methods

Methods

beginUpdatePatch

Parameters

resourceGroupName: string

serviceName: string

configServerResource: ConfigServerResource

Optional options: ConfigServersUpdatePatchOptionalParams

Returns Promise<PollerLike<PollOperationState<ConfigServerResource>, ConfigServerResource>>

beginUpdatePatchAndWait

Parameters

resourceGroupName: string

serviceName: string

configServerResource: ConfigServerResource

Optional options: ConfigServersUpdatePatchOptionalParams

Returns Promise<ConfigServerResource>

beginUpdatePut

Parameters

resourceGroupName: string

serviceName: string

configServerResource: ConfigServerResource

Optional options: ConfigServersUpdatePutOptionalParams

Returns Promise<PollerLike<PollOperationState<ConfigServerResource>, ConfigServerResource>>

beginUpdatePutAndWait

Parameters

resourceGroupName: string

serviceName: string

configServerResource: ConfigServerResource

Optional options: ConfigServersUpdatePutOptionalParams

Returns Promise<ConfigServerResource>

beginValidate

Parameters

resourceGroupName: string

serviceName: string

configServerSettings: ConfigServerSettings

Optional options: ConfigServersValidateOptionalParams

Returns Promise<PollerLike<PollOperationState<ConfigServerSettingsValidateResult>, ConfigServerSettingsValidateResult>>

beginValidateAndWait

Parameters

resourceGroupName: string

serviceName: string

configServerSettings: ConfigServerSettings

Optional options: ConfigServersValidateOptionalParams

Returns Promise<ConfigServerSettingsValidateResult>

get

Parameters

resourceGroupName: string

serviceName: string

Optional options: ConfigServersGetOptionalParams

Returns Promise<ConfigServerResource>

Settings

Member Visibility

Theme

`Optional` options: ConfigServersUpdatePatchOptionalParams

`Optional` options: ConfigServersUpdatePatchOptionalParams

`Optional` options: ConfigServersUpdatePutOptionalParams

`Optional` options: ConfigServersUpdatePutOptionalParams

`Optional` options: ConfigServersValidateOptionalParams

`Optional` options: ConfigServersValidateOptionalParams

`Optional` options: ConfigServersGetOptionalParams