Origins interface

Package:

@azure/arm-cdn

Interface representing a Origins.

Methods

beginCreate(string, string, string, string, Origin, OriginsCreateOptionalParams)	Creates a new origin within the specified endpoint.
beginCreateAndWait(string, string, string, string, Origin, OriginsCreateOptionalParams)	Creates a new origin within the specified endpoint.
beginDelete(string, string, string, string, OriginsDeleteOptionalParams)	Deletes an existing origin within an endpoint.
beginDeleteAndWait(string, string, string, string, OriginsDeleteOptionalParams)	Deletes an existing origin within an endpoint.
beginUpdate(string, string, string, string, OriginUpdateParameters, OriginsUpdateOptionalParams)	Updates an existing origin within an endpoint.
beginUpdateAndWait(string, string, string, string, OriginUpdateParameters, OriginsUpdateOptionalParams)	Updates an existing origin within an endpoint.
get(string, string, string, string, OriginsGetOptionalParams)	Gets an existing origin within an endpoint.
listByEndpoint(string, string, string, OriginsListByEndpointOptionalParams)	Lists all of the existing origins within an endpoint.

Method Details

beginCreate(string, string, string, string, Origin, OriginsCreateOptionalParams)

Creates a new origin within the specified endpoint.

function beginCreate(resourceGroupName: string, profileName: string, endpointName: string, originName: string, origin: Origin, options?: OriginsCreateOptionalParams): Promise<SimplePollerLike<OperationState<Origin>, Origin>>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

profileName

string

Name of the CDN profile which is unique within the resource group.

endpointName

string

Name of the endpoint under the profile which is unique globally.

originName

string

Name of the origin that is unique within the endpoint.

origin

Origin

Origin properties

options

OriginsCreateOptionalParams

The options parameters.

Returns

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

beginCreateAndWait(string, string, string, string, Origin, OriginsCreateOptionalParams)

Creates a new origin within the specified endpoint.

function beginCreateAndWait(resourceGroupName: string, profileName: string, endpointName: string, originName: string, origin: Origin, options?: OriginsCreateOptionalParams): Promise<Origin>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

profileName

string

Name of the CDN profile which is unique within the resource group.

endpointName

string

Name of the endpoint under the profile which is unique globally.

originName

string

Name of the origin that is unique within the endpoint.

origin

Origin

Origin properties

options

OriginsCreateOptionalParams

The options parameters.

Returns

Promise<Origin>

beginDelete(string, string, string, string, OriginsDeleteOptionalParams)

Deletes an existing origin within an endpoint.

function beginDelete(resourceGroupName: string, profileName: string, endpointName: string, originName: string, options?: OriginsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

profileName

string

Name of the CDN profile which is unique within the resource group.

endpointName

string

Name of the endpoint under the profile which is unique globally.

originName

string

Name of the origin which is unique within the endpoint.

options

OriginsDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, string, string, OriginsDeleteOptionalParams)

Deletes an existing origin within an endpoint.

function beginDeleteAndWait(resourceGroupName: string, profileName: string, endpointName: string, originName: string, options?: OriginsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

profileName

string

Name of the CDN profile which is unique within the resource group.

endpointName

string

Name of the endpoint under the profile which is unique globally.

originName

string

Name of the origin which is unique within the endpoint.

options

OriginsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, string, string, OriginUpdateParameters, OriginsUpdateOptionalParams)

Updates an existing origin within an endpoint.

function beginUpdate(resourceGroupName: string, profileName: string, endpointName: string, originName: string, originUpdateProperties: OriginUpdateParameters, options?: OriginsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Origin>, Origin>>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

profileName

string

Name of the CDN profile which is unique within the resource group.

endpointName

string

Name of the endpoint under the profile which is unique globally.

originName

string

Name of the origin which is unique within the endpoint.

originUpdateProperties

OriginUpdateParameters

Origin properties

options

OriginsUpdateOptionalParams

The options parameters.

Returns

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

beginUpdateAndWait(string, string, string, string, OriginUpdateParameters, OriginsUpdateOptionalParams)

Updates an existing origin within an endpoint.

function beginUpdateAndWait(resourceGroupName: string, profileName: string, endpointName: string, originName: string, originUpdateProperties: OriginUpdateParameters, options?: OriginsUpdateOptionalParams): Promise<Origin>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

profileName

string

Name of the CDN profile which is unique within the resource group.

endpointName

string

Name of the endpoint under the profile which is unique globally.

originName

string

Name of the origin which is unique within the endpoint.

originUpdateProperties

OriginUpdateParameters

Origin properties

options

OriginsUpdateOptionalParams

The options parameters.

Returns

Promise<Origin>

get(string, string, string, string, OriginsGetOptionalParams)

Gets an existing origin within an endpoint.

function get(resourceGroupName: string, profileName: string, endpointName: string, originName: string, options?: OriginsGetOptionalParams): Promise<Origin>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

profileName

string

Name of the CDN profile which is unique within the resource group.

endpointName

string

Name of the endpoint under the profile which is unique globally.

originName

string

Name of the origin which is unique within the endpoint.

options

OriginsGetOptionalParams

The options parameters.

Returns

Promise<Origin>

listByEndpoint(string, string, string, OriginsListByEndpointOptionalParams)

Lists all of the existing origins within an endpoint.

function listByEndpoint(resourceGroupName: string, profileName: string, endpointName: string, options?: OriginsListByEndpointOptionalParams): PagedAsyncIterableIterator<Origin, Origin[], PageSettings>

Parameters

resourceGroupName

string

Name of the Resource group within the Azure subscription.

profileName

string

Name of the CDN profile which is unique within the resource group.

endpointName

string

Name of the endpoint under the profile which is unique globally.

options

OriginsListByEndpointOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Origin, Origin[], PageSettings>