Secrets interface

Package:

@azure/arm-cdn

Interface representing a Secrets.

Methods

beginCreate(string, string, string, Secret, SecretsCreateOptionalParams)	Creates a new Secret within the specified profile.
beginCreateAndWait(string, string, string, Secret, SecretsCreateOptionalParams)	Creates a new Secret within the specified profile.
beginDelete(string, string, string, SecretsDeleteOptionalParams)	Deletes an existing Secret within profile.
beginDeleteAndWait(string, string, string, SecretsDeleteOptionalParams)	Deletes an existing Secret within profile.
get(string, string, string, SecretsGetOptionalParams)	Gets an existing Secret within a profile.
listByProfile(string, string, SecretsListByProfileOptionalParams)	Lists existing AzureFrontDoor secrets.

Method Details

beginCreate(string, string, string, Secret, SecretsCreateOptionalParams)

Creates a new Secret within the specified profile.

function beginCreate(resourceGroupName: string, profileName: string, secretName: string, secret: Secret, options?: SecretsCreateOptionalParams): Promise<SimplePollerLike<OperationState<Secret>, Secret>>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

profileName

string

Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.

secretName

string

Name of the Secret under the profile.

secret

Secret

The Secret properties.

options

SecretsCreateOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<Secret>, Secret>>

beginCreateAndWait(string, string, string, Secret, SecretsCreateOptionalParams)

Creates a new Secret within the specified profile.

function beginCreateAndWait(resourceGroupName: string, profileName: string, secretName: string, secret: Secret, options?: SecretsCreateOptionalParams): Promise<Secret>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

profileName

string

Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.

secretName

string

Name of the Secret under the profile.

secret

Secret

The Secret properties.

options

SecretsCreateOptionalParams

The options parameters.

Returns

Promise<Secret>

beginDelete(string, string, string, SecretsDeleteOptionalParams)

Deletes an existing Secret within profile.

function beginDelete(resourceGroupName: string, profileName: string, secretName: string, options?: SecretsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

profileName

string

Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.

secretName

string

Name of the Secret under the profile.

options

SecretsDeleteOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, string, SecretsDeleteOptionalParams)

Deletes an existing Secret within profile.

function beginDeleteAndWait(resourceGroupName: string, profileName: string, secretName: string, options?: SecretsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

profileName

string

Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.

secretName

string

Name of the Secret under the profile.

options

SecretsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, SecretsGetOptionalParams)

Gets an existing Secret within a profile.

function get(resourceGroupName: string, profileName: string, secretName: string, options?: SecretsGetOptionalParams): Promise<Secret>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

profileName

string

Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.

secretName

string

Name of the Secret under the profile.

options

SecretsGetOptionalParams

The options parameters.

Returns

Promise<Secret>

listByProfile(string, string, SecretsListByProfileOptionalParams)

Lists existing AzureFrontDoor secrets.

function listByProfile(resourceGroupName: string, profileName: string, options?: SecretsListByProfileOptionalParams): PagedAsyncIterableIterator<Secret, Secret[], PageSettings>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

profileName

string

Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.

options

SecretsListByProfileOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Secret, Secret[], PageSettings>