AfdOriginGroups interface

Package:

@azure/arm-cdn

Interface representing a AfdOriginGroups.

Methods

beginCreate(string, string, string, AFDOriginGroup, AfdOriginGroupsCreateOptionalParams)	Creates a new origin group within the specified profile.
beginCreateAndWait(string, string, string, AFDOriginGroup, AfdOriginGroupsCreateOptionalParams)	Creates a new origin group within the specified profile.
beginDelete(string, string, string, AfdOriginGroupsDeleteOptionalParams)	Deletes an existing origin group within a profile.
beginDeleteAndWait(string, string, string, AfdOriginGroupsDeleteOptionalParams)	Deletes an existing origin group within a profile.
beginUpdate(string, string, string, AFDOriginGroupUpdateParameters, AfdOriginGroupsUpdateOptionalParams)	Updates an existing origin group within a profile.
beginUpdateAndWait(string, string, string, AFDOriginGroupUpdateParameters, AfdOriginGroupsUpdateOptionalParams)	Updates an existing origin group within a profile.
get(string, string, string, AfdOriginGroupsGetOptionalParams)	Gets an existing origin group within a profile.
listByProfile(string, string, AfdOriginGroupsListByProfileOptionalParams)	Lists all of the existing origin groups within a profile.
listResourceUsage(string, string, string, AfdOriginGroupsListResourceUsageOptionalParams)	Checks the quota and actual usage of endpoints under the given Azure Front Door profile..

Method Details

beginCreate(string, string, string, AFDOriginGroup, AfdOriginGroupsCreateOptionalParams)

Creates a new origin group within the specified profile.

function beginCreate(resourceGroupName: string, profileName: string, originGroupName: string, originGroup: AFDOriginGroup, options?: AfdOriginGroupsCreateOptionalParams): Promise<SimplePollerLike<OperationState<AFDOriginGroup>, AFDOriginGroup>>

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.

originGroupName

string

Name of the origin group which is unique within the endpoint.

originGroup

AFDOriginGroup

Origin group properties

options

AfdOriginGroupsCreateOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<AFDOriginGroup>, AFDOriginGroup>>

beginCreateAndWait(string, string, string, AFDOriginGroup, AfdOriginGroupsCreateOptionalParams)

Creates a new origin group within the specified profile.

function beginCreateAndWait(resourceGroupName: string, profileName: string, originGroupName: string, originGroup: AFDOriginGroup, options?: AfdOriginGroupsCreateOptionalParams): Promise<AFDOriginGroup>

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.

originGroupName

string

Name of the origin group which is unique within the endpoint.

originGroup

AFDOriginGroup

Origin group properties

options

AfdOriginGroupsCreateOptionalParams

The options parameters.

Returns

Promise<AFDOriginGroup>

beginDelete(string, string, string, AfdOriginGroupsDeleteOptionalParams)

Deletes an existing origin group within a profile.

function beginDelete(resourceGroupName: string, profileName: string, originGroupName: string, options?: AfdOriginGroupsDeleteOptionalParams): 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.

originGroupName

string

Name of the origin group which is unique within the profile.

options

AfdOriginGroupsDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, string, AfdOriginGroupsDeleteOptionalParams)

Deletes an existing origin group within a profile.

function beginDeleteAndWait(resourceGroupName: string, profileName: string, originGroupName: string, options?: AfdOriginGroupsDeleteOptionalParams): 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.

originGroupName

string

Name of the origin group which is unique within the profile.

options

AfdOriginGroupsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, string, AFDOriginGroupUpdateParameters, AfdOriginGroupsUpdateOptionalParams)

Updates an existing origin group within a profile.

function beginUpdate(resourceGroupName: string, profileName: string, originGroupName: string, originGroupUpdateProperties: AFDOriginGroupUpdateParameters, options?: AfdOriginGroupsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<AFDOriginGroup>, AFDOriginGroup>>

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.

originGroupName

string

Name of the origin group which is unique within the profile.

originGroupUpdateProperties

AFDOriginGroupUpdateParameters

Origin group properties

options

AfdOriginGroupsUpdateOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<AFDOriginGroup>, AFDOriginGroup>>

beginUpdateAndWait(string, string, string, AFDOriginGroupUpdateParameters, AfdOriginGroupsUpdateOptionalParams)

Updates an existing origin group within a profile.

function beginUpdateAndWait(resourceGroupName: string, profileName: string, originGroupName: string, originGroupUpdateProperties: AFDOriginGroupUpdateParameters, options?: AfdOriginGroupsUpdateOptionalParams): Promise<AFDOriginGroup>

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.

originGroupName

string

Name of the origin group which is unique within the profile.

originGroupUpdateProperties

AFDOriginGroupUpdateParameters

Origin group properties

options

AfdOriginGroupsUpdateOptionalParams

The options parameters.

Returns

Promise<AFDOriginGroup>

get(string, string, string, AfdOriginGroupsGetOptionalParams)

Gets an existing origin group within a profile.

function get(resourceGroupName: string, profileName: string, originGroupName: string, options?: AfdOriginGroupsGetOptionalParams): Promise<AFDOriginGroup>

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.

originGroupName

string

Name of the origin group which is unique within the endpoint.

options

AfdOriginGroupsGetOptionalParams

The options parameters.

Returns

Promise<AFDOriginGroup>

listByProfile(string, string, AfdOriginGroupsListByProfileOptionalParams)

Lists all of the existing origin groups within a profile.

function listByProfile(resourceGroupName: string, profileName: string, options?: AfdOriginGroupsListByProfileOptionalParams): PagedAsyncIterableIterator<AFDOriginGroup, AFDOriginGroup[], 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

AfdOriginGroupsListByProfileOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<AFDOriginGroup, AFDOriginGroup[], PageSettings>

listResourceUsage(string, string, string, AfdOriginGroupsListResourceUsageOptionalParams)

Checks the quota and actual usage of endpoints under the given Azure Front Door profile..

function listResourceUsage(resourceGroupName: string, profileName: string, originGroupName: string, options?: AfdOriginGroupsListResourceUsageOptionalParams): PagedAsyncIterableIterator<Usage, Usage[], 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.

originGroupName

string

Name of the origin group which is unique within the endpoint.

options

AfdOriginGroupsListResourceUsageOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Usage, Usage[], PageSettings>