ConfigurationServices interface

Package:

@azure/arm-appplatform

Interface representing a ConfigurationServices.

Methods

beginCreateOrUpdate(string, string, string, ConfigurationServiceResource, ConfigurationServicesCreateOrUpdateOptionalParams)	Create the default Application Configuration Service or update the existing Application Configuration Service.
beginCreateOrUpdateAndWait(string, string, string, ConfigurationServiceResource, ConfigurationServicesCreateOrUpdateOptionalParams)	Create the default Application Configuration Service or update the existing Application Configuration Service.
beginDelete(string, string, string, ConfigurationServicesDeleteOptionalParams)	Disable the default Application Configuration Service.
beginDeleteAndWait(string, string, string, ConfigurationServicesDeleteOptionalParams)	Disable the default Application Configuration Service.
beginValidate(string, string, string, ConfigurationServiceSettings, ConfigurationServicesValidateOptionalParams)	Check if the Application Configuration Service settings are valid.
beginValidateAndWait(string, string, string, ConfigurationServiceSettings, ConfigurationServicesValidateOptionalParams)	Check if the Application Configuration Service settings are valid.
beginValidateResource(string, string, string, ConfigurationServiceResource, ConfigurationServicesValidateResourceOptionalParams)	Check if the Application Configuration Service resource is valid.
beginValidateResourceAndWait(string, string, string, ConfigurationServiceResource, ConfigurationServicesValidateResourceOptionalParams)	Check if the Application Configuration Service resource is valid.
get(string, string, string, ConfigurationServicesGetOptionalParams)	Get the Application Configuration Service and its properties.
list(string, string, ConfigurationServicesListOptionalParams)	Handles requests to list all resources in a Service.

Method Details

beginCreateOrUpdate(string, string, string, ConfigurationServiceResource, ConfigurationServicesCreateOrUpdateOptionalParams)

Create the default Application Configuration Service or update the existing Application Configuration Service.

function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, configurationServiceName: string, configurationServiceResource: ConfigurationServiceResource, options?: ConfigurationServicesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ConfigurationServiceResource>, ConfigurationServiceResource>>

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.

configurationServiceName

string

The name of Application Configuration Service.

configurationServiceResource

ConfigurationServiceResource

Parameters for the update operation

options

ConfigurationServicesCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, string, ConfigurationServiceResource, ConfigurationServicesCreateOrUpdateOptionalParams)

Create the default Application Configuration Service or update the existing Application Configuration Service.

function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, configurationServiceName: string, configurationServiceResource: ConfigurationServiceResource, options?: ConfigurationServicesCreateOrUpdateOptionalParams): Promise<ConfigurationServiceResource>

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.

configurationServiceName

string

The name of Application Configuration Service.

configurationServiceResource

ConfigurationServiceResource

Parameters for the update operation

options

ConfigurationServicesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<ConfigurationServiceResource>

beginDelete(string, string, string, ConfigurationServicesDeleteOptionalParams)

Disable the default Application Configuration Service.

function beginDelete(resourceGroupName: string, serviceName: string, configurationServiceName: string, options?: ConfigurationServicesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

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.

configurationServiceName

string

The name of Application Configuration Service.

options

ConfigurationServicesDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, string, ConfigurationServicesDeleteOptionalParams)

Disable the default Application Configuration Service.

function beginDeleteAndWait(resourceGroupName: string, serviceName: string, configurationServiceName: string, options?: ConfigurationServicesDeleteOptionalParams): Promise<void>

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.

configurationServiceName

string

The name of Application Configuration Service.

options

ConfigurationServicesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginValidate(string, string, string, ConfigurationServiceSettings, ConfigurationServicesValidateOptionalParams)

Check if the Application Configuration Service settings are valid.

function beginValidate(resourceGroupName: string, serviceName: string, configurationServiceName: string, settings: ConfigurationServiceSettings, options?: ConfigurationServicesValidateOptionalParams): Promise<SimplePollerLike<OperationState<ConfigurationServiceSettingsValidateResult>, ConfigurationServiceSettingsValidateResult>>

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.

configurationServiceName

string

The name of Application Configuration Service.

settings

ConfigurationServiceSettings

Application Configuration Service settings to be validated

options

ConfigurationServicesValidateOptionalParams

The options parameters.

Returns

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

beginValidateAndWait(string, string, string, ConfigurationServiceSettings, ConfigurationServicesValidateOptionalParams)

Check if the Application Configuration Service settings are valid.

function beginValidateAndWait(resourceGroupName: string, serviceName: string, configurationServiceName: string, settings: ConfigurationServiceSettings, options?: ConfigurationServicesValidateOptionalParams): Promise<ConfigurationServiceSettingsValidateResult>

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.

configurationServiceName

string

The name of Application Configuration Service.

settings

ConfigurationServiceSettings

Application Configuration Service settings to be validated

options

ConfigurationServicesValidateOptionalParams

The options parameters.

Returns

Promise<ConfigurationServiceSettingsValidateResult>

beginValidateResource(string, string, string, ConfigurationServiceResource, ConfigurationServicesValidateResourceOptionalParams)

Check if the Application Configuration Service resource is valid.

function beginValidateResource(resourceGroupName: string, serviceName: string, configurationServiceName: string, configurationServiceResource: ConfigurationServiceResource, options?: ConfigurationServicesValidateResourceOptionalParams): Promise<SimplePollerLike<OperationState<ConfigurationServiceSettingsValidateResult>, ConfigurationServiceSettingsValidateResult>>

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.

configurationServiceName

string

The name of Application Configuration Service.

configurationServiceResource

ConfigurationServiceResource

Application Configuration Service resource to be validated

options

ConfigurationServicesValidateResourceOptionalParams

The options parameters.

Returns

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

beginValidateResourceAndWait(string, string, string, ConfigurationServiceResource, ConfigurationServicesValidateResourceOptionalParams)

Check if the Application Configuration Service resource is valid.

function beginValidateResourceAndWait(resourceGroupName: string, serviceName: string, configurationServiceName: string, configurationServiceResource: ConfigurationServiceResource, options?: ConfigurationServicesValidateResourceOptionalParams): Promise<ConfigurationServiceSettingsValidateResult>

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.

configurationServiceName

string

The name of Application Configuration Service.

configurationServiceResource

ConfigurationServiceResource

Application Configuration Service resource to be validated

options

ConfigurationServicesValidateResourceOptionalParams

The options parameters.

Returns

Promise<ConfigurationServiceSettingsValidateResult>

get(string, string, string, ConfigurationServicesGetOptionalParams)

Get the Application Configuration Service and its properties.

function get(resourceGroupName: string, serviceName: string, configurationServiceName: string, options?: ConfigurationServicesGetOptionalParams): Promise<ConfigurationServiceResource>

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.

configurationServiceName

string

The name of Application Configuration Service.

options

ConfigurationServicesGetOptionalParams

The options parameters.

Returns

Promise<ConfigurationServiceResource>

list(string, string, ConfigurationServicesListOptionalParams)

Handles requests to list all resources in a Service.

function list(resourceGroupName: string, serviceName: string, options?: ConfigurationServicesListOptionalParams): PagedAsyncIterableIterator<ConfigurationServiceResource, ConfigurationServiceResource[], PageSettings>

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

ConfigurationServicesListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ConfigurationServiceResource, ConfigurationServiceResource[], PageSettings>