AfdOrigins interface

Package:

@azure/arm-cdn

Interface representing a AfdOrigins.

Methods

beginCreate(string, string, string, string, AFDOrigin, AfdOriginsCreateOptionalParams)	Creates a new origin within the specified origin group.
beginCreateAndWait(string, string, string, string, AFDOrigin, AfdOriginsCreateOptionalParams)	Creates a new origin within the specified origin group.
beginDelete(string, string, string, string, AfdOriginsDeleteOptionalParams)	Deletes an existing origin within an origin group.
beginDeleteAndWait(string, string, string, string, AfdOriginsDeleteOptionalParams)	Deletes an existing origin within an origin group.
beginUpdate(string, string, string, string, AFDOriginUpdateParameters, AfdOriginsUpdateOptionalParams)	Updates an existing origin within an origin group.
beginUpdateAndWait(string, string, string, string, AFDOriginUpdateParameters, AfdOriginsUpdateOptionalParams)	Updates an existing origin within an origin group.
get(string, string, string, string, AfdOriginsGetOptionalParams)	Gets an existing origin within an origin group.
listByOriginGroup(string, string, string, AfdOriginsListByOriginGroupOptionalParams)	Lists all of the existing origins within an origin group.

Method Details

beginCreate(string, string, string, string, AFDOrigin, AfdOriginsCreateOptionalParams)

Creates a new origin within the specified origin group.

function beginCreate(resourceGroupName: string, profileName: string, originGroupName: string, originName: string, origin: AFDOrigin, options?: AfdOriginsCreateOptionalParams): Promise<SimplePollerLike<OperationState<AFDOrigin>, AFDOrigin>>

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.

originName

string

Name of the origin that is unique within the profile.

origin

AFDOrigin

Origin properties

options

AfdOriginsCreateOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<AFDOrigin>, AFDOrigin>>

beginCreateAndWait(string, string, string, string, AFDOrigin, AfdOriginsCreateOptionalParams)

Creates a new origin within the specified origin group.

function beginCreateAndWait(resourceGroupName: string, profileName: string, originGroupName: string, originName: string, origin: AFDOrigin, options?: AfdOriginsCreateOptionalParams): Promise<AFDOrigin>

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.

originName

string

Name of the origin that is unique within the profile.

origin

AFDOrigin

Origin properties

options

AfdOriginsCreateOptionalParams

The options parameters.

Returns

Promise<AFDOrigin>

beginDelete(string, string, string, string, AfdOriginsDeleteOptionalParams)

Deletes an existing origin within an origin group.

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

originName

string

Name of the origin which is unique within the profile.

options

AfdOriginsDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, string, string, AfdOriginsDeleteOptionalParams)

Deletes an existing origin within an origin group.

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

originName

string

Name of the origin which is unique within the profile.

options

AfdOriginsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, string, string, AFDOriginUpdateParameters, AfdOriginsUpdateOptionalParams)

Updates an existing origin within an origin group.

function beginUpdate(resourceGroupName: string, profileName: string, originGroupName: string, originName: string, originUpdateProperties: AFDOriginUpdateParameters, options?: AfdOriginsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<AFDOrigin>, AFDOrigin>>

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.

originName

string

Name of the origin which is unique within the profile.

originUpdateProperties

AFDOriginUpdateParameters

Origin properties

options

AfdOriginsUpdateOptionalParams

The options parameters.

Returns

Promise<SimplePollerLike<OperationState<AFDOrigin>, AFDOrigin>>

beginUpdateAndWait(string, string, string, string, AFDOriginUpdateParameters, AfdOriginsUpdateOptionalParams)

Updates an existing origin within an origin group.

function beginUpdateAndWait(resourceGroupName: string, profileName: string, originGroupName: string, originName: string, originUpdateProperties: AFDOriginUpdateParameters, options?: AfdOriginsUpdateOptionalParams): Promise<AFDOrigin>

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.

originName

string

Name of the origin which is unique within the profile.

originUpdateProperties

AFDOriginUpdateParameters

Origin properties

options

AfdOriginsUpdateOptionalParams

The options parameters.

Returns

Promise<AFDOrigin>

get(string, string, string, string, AfdOriginsGetOptionalParams)

Gets an existing origin within an origin group.

function get(resourceGroupName: string, profileName: string, originGroupName: string, originName: string, options?: AfdOriginsGetOptionalParams): Promise<AFDOrigin>

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.

originName

string

Name of the origin which is unique within the profile.

options

AfdOriginsGetOptionalParams

The options parameters.

Returns

Promise<AFDOrigin>

listByOriginGroup(string, string, string, AfdOriginsListByOriginGroupOptionalParams)

Lists all of the existing origins within an origin group.

function listByOriginGroup(resourceGroupName: string, profileName: string, originGroupName: string, options?: AfdOriginsListByOriginGroupOptionalParams): PagedAsyncIterableIterator<AFDOrigin, AFDOrigin[], 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 profile.

options

AfdOriginsListByOriginGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<AFDOrigin, AFDOrigin[], PageSettings>