Alias interface

Interface representing a Alias.

Methods

beginCreate(string, PutAliasRequest, AliasCreateOptionalParams)

Create Alias Subscription.

beginCreateAndWait(string, PutAliasRequest, AliasCreateOptionalParams)

Create Alias Subscription.

delete(string, AliasDeleteOptionalParams)

Delete Alias.

get(string, AliasGetOptionalParams)

Get Alias Subscription.

list(AliasListOptionalParams)

List Alias Subscription.

Method Details

beginCreate(string, PutAliasRequest, AliasCreateOptionalParams)

Create Alias Subscription.

function beginCreate(aliasName: string, body: PutAliasRequest, options?: AliasCreateOptionalParams): Promise<PollerLike<PollOperationState<SubscriptionAliasResponse>, SubscriptionAliasResponse>>

Parameters

aliasName

string

AliasName is the name for the subscription creation request. Note that this is not the same as subscription name and this doesn’t have any other lifecycle need beyond the request for subscription creation.

body
PutAliasRequest

The parameters required to create a new subscription.

options
AliasCreateOptionalParams

The options parameters.

Returns

Promise<PollerLike<@azure/core-lro.PollOperationState<SubscriptionAliasResponse>, SubscriptionAliasResponse>>

beginCreateAndWait(string, PutAliasRequest, AliasCreateOptionalParams)

Create Alias Subscription.

function beginCreateAndWait(aliasName: string, body: PutAliasRequest, options?: AliasCreateOptionalParams): Promise<SubscriptionAliasResponse>

Parameters

aliasName

string

AliasName is the name for the subscription creation request. Note that this is not the same as subscription name and this doesn’t have any other lifecycle need beyond the request for subscription creation.

body
PutAliasRequest

The parameters required to create a new subscription.

options
AliasCreateOptionalParams

The options parameters.

Returns

delete(string, AliasDeleteOptionalParams)

Delete Alias.

function delete(aliasName: string, options?: AliasDeleteOptionalParams): Promise<void>

Parameters

aliasName

string

AliasName is the name for the subscription creation request. Note that this is not the same as subscription name and this doesn’t have any other lifecycle need beyond the request for subscription creation.

options
AliasDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, AliasGetOptionalParams)

Get Alias Subscription.

function get(aliasName: string, options?: AliasGetOptionalParams): Promise<SubscriptionAliasResponse>

Parameters

aliasName

string

AliasName is the name for the subscription creation request. Note that this is not the same as subscription name and this doesn’t have any other lifecycle need beyond the request for subscription creation.

options
AliasGetOptionalParams

The options parameters.

Returns

list(AliasListOptionalParams)

List Alias Subscription.

function list(options?: AliasListOptionalParams): Promise<SubscriptionAliasListResult>

Parameters

options
AliasListOptionalParams

The options parameters.

Returns