OriginGroups interface
Interface representing a OriginGroups.
Methods
Method Details
beginCreate(string, string, string, string, OriginGroup, OriginGroupsCreateOptionalParams)
Creates a new origin group within the specified endpoint.
function beginCreate(resourceGroupName: string, profileName: string, endpointName: string, originGroupName: string, originGroup: OriginGroup, options?: OriginGroupsCreateOptionalParams): Promise<SimplePollerLike<OperationState<OriginGroup>, OriginGroup>>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.
- originGroupName
-
string
Name of the origin group which is unique within the endpoint.
- originGroup
- OriginGroup
Origin group properties
- options
- OriginGroupsCreateOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<OriginGroup>, OriginGroup>>
beginCreateAndWait(string, string, string, string, OriginGroup, OriginGroupsCreateOptionalParams)
Creates a new origin group within the specified endpoint.
function beginCreateAndWait(resourceGroupName: string, profileName: string, endpointName: string, originGroupName: string, originGroup: OriginGroup, options?: OriginGroupsCreateOptionalParams): Promise<OriginGroup>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.
- originGroupName
-
string
Name of the origin group which is unique within the endpoint.
- originGroup
- OriginGroup
Origin group properties
- options
- OriginGroupsCreateOptionalParams
The options parameters.
Returns
Promise<OriginGroup>
beginDelete(string, string, string, string, OriginGroupsDeleteOptionalParams)
Deletes an existing origin group within an endpoint.
function beginDelete(resourceGroupName: string, profileName: string, endpointName: string, originGroupName: string, options?: OriginGroupsDeleteOptionalParams): 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.
- originGroupName
-
string
Name of the origin group which is unique within the endpoint.
- options
- OriginGroupsDeleteOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, string, string, OriginGroupsDeleteOptionalParams)
Deletes an existing origin group within an endpoint.
function beginDeleteAndWait(resourceGroupName: string, profileName: string, endpointName: string, originGroupName: string, options?: OriginGroupsDeleteOptionalParams): 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.
- originGroupName
-
string
Name of the origin group which is unique within the endpoint.
- options
- OriginGroupsDeleteOptionalParams
The options parameters.
Returns
Promise<void>
beginUpdate(string, string, string, string, OriginGroupUpdateParameters, OriginGroupsUpdateOptionalParams)
Updates an existing origin group within an endpoint.
function beginUpdate(resourceGroupName: string, profileName: string, endpointName: string, originGroupName: string, originGroupUpdateProperties: OriginGroupUpdateParameters, options?: OriginGroupsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<OriginGroup>, OriginGroup>>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.
- originGroupName
-
string
Name of the origin group which is unique within the endpoint.
- originGroupUpdateProperties
- OriginGroupUpdateParameters
Origin group properties
- options
- OriginGroupsUpdateOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<OriginGroup>, OriginGroup>>
beginUpdateAndWait(string, string, string, string, OriginGroupUpdateParameters, OriginGroupsUpdateOptionalParams)
Updates an existing origin group within an endpoint.
function beginUpdateAndWait(resourceGroupName: string, profileName: string, endpointName: string, originGroupName: string, originGroupUpdateProperties: OriginGroupUpdateParameters, options?: OriginGroupsUpdateOptionalParams): Promise<OriginGroup>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.
- originGroupName
-
string
Name of the origin group which is unique within the endpoint.
- originGroupUpdateProperties
- OriginGroupUpdateParameters
Origin group properties
- options
- OriginGroupsUpdateOptionalParams
The options parameters.
Returns
Promise<OriginGroup>
get(string, string, string, string, OriginGroupsGetOptionalParams)
Gets an existing origin group within an endpoint.
function get(resourceGroupName: string, profileName: string, endpointName: string, originGroupName: string, options?: OriginGroupsGetOptionalParams): Promise<OriginGroup>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.
- originGroupName
-
string
Name of the origin group which is unique within the endpoint.
- options
- OriginGroupsGetOptionalParams
The options parameters.
Returns
Promise<OriginGroup>
listByEndpoint(string, string, string, OriginGroupsListByEndpointOptionalParams)
Lists all of the existing origin groups within an endpoint.
function listByEndpoint(resourceGroupName: string, profileName: string, endpointName: string, options?: OriginGroupsListByEndpointOptionalParams): PagedAsyncIterableIterator<OriginGroup, OriginGroup[], 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.
The options parameters.