Replicas interface

Package:

@azure/arm-appconfiguration

Interface representing a Replicas.

Methods

beginCreate(string, string, string, Replica, ReplicasCreateOptionalParams)	Creates a replica with the specified parameters.
beginCreateAndWait(string, string, string, Replica, ReplicasCreateOptionalParams)	Creates a replica with the specified parameters.
beginDelete(string, string, string, ReplicasDeleteOptionalParams)	Deletes a replica.
beginDeleteAndWait(string, string, string, ReplicasDeleteOptionalParams)	Deletes a replica.
get(string, string, string, ReplicasGetOptionalParams)	Gets the properties of the specified replica.
listByConfigurationStore(string, string, ReplicasListByConfigurationStoreOptionalParams)	Lists the replicas for a given configuration store.

Method Details

beginCreate(string, string, string, Replica, ReplicasCreateOptionalParams)

Creates a replica with the specified parameters.

function beginCreate(resourceGroupName: string, configStoreName: string, replicaName: string, replicaCreationParameters: Replica, options?: ReplicasCreateOptionalParams): Promise<SimplePollerLike<OperationState<Replica>, Replica>>

Parameters

resourceGroupName

string

The name of the resource group to which the container registry belongs.

configStoreName

string

The name of the configuration store.

replicaName

string

The name of the replica.

replicaCreationParameters

Replica

The parameters for creating a replica.

options

ReplicasCreateOptionalParams

The options parameters.

Returns

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

beginCreateAndWait(string, string, string, Replica, ReplicasCreateOptionalParams)

Creates a replica with the specified parameters.

function beginCreateAndWait(resourceGroupName: string, configStoreName: string, replicaName: string, replicaCreationParameters: Replica, options?: ReplicasCreateOptionalParams): Promise<Replica>

Parameters

resourceGroupName

string

The name of the resource group to which the container registry belongs.

configStoreName

string

The name of the configuration store.

replicaName

string

The name of the replica.

replicaCreationParameters

Replica

The parameters for creating a replica.

options

ReplicasCreateOptionalParams

The options parameters.

Returns

Promise<Replica>

beginDelete(string, string, string, ReplicasDeleteOptionalParams)

Deletes a replica.

function beginDelete(resourceGroupName: string, configStoreName: string, replicaName: string, options?: ReplicasDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group to which the container registry belongs.

configStoreName

string

The name of the configuration store.

replicaName

string

The name of the replica.

options

ReplicasDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, string, ReplicasDeleteOptionalParams)

Deletes a replica.

function beginDeleteAndWait(resourceGroupName: string, configStoreName: string, replicaName: string, options?: ReplicasDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group to which the container registry belongs.

configStoreName

string

The name of the configuration store.

replicaName

string

The name of the replica.

options

ReplicasDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, ReplicasGetOptionalParams)

Gets the properties of the specified replica.

function get(resourceGroupName: string, configStoreName: string, replicaName: string, options?: ReplicasGetOptionalParams): Promise<Replica>

Parameters

resourceGroupName

string

The name of the resource group to which the container registry belongs.

configStoreName

string

The name of the configuration store.

replicaName

string

The name of the replica.

options

ReplicasGetOptionalParams

The options parameters.

Returns

Promise<Replica>

listByConfigurationStore(string, string, ReplicasListByConfigurationStoreOptionalParams)

Lists the replicas for a given configuration store.

function listByConfigurationStore(resourceGroupName: string, configStoreName: string, options?: ReplicasListByConfigurationStoreOptionalParams): PagedAsyncIterableIterator<Replica, Replica[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group to which the container registry belongs.

configStoreName

string

The name of the configuration store.

options

ReplicasListByConfigurationStoreOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Replica, Replica[], PageSettings>