AfdEndpoints interface
Interface representing a AfdEndpoints.
Methods
| begin |
Creates a new AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile. |
| begin |
Creates a new AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile. |
| begin |
Deletes an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile. |
| begin |
Deletes an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile. |
| begin |
Removes a content from AzureFrontDoor. |
| begin |
Removes a content from AzureFrontDoor. |
| begin |
Updates an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile. Only tags can be updated after creating an endpoint. To update origins, use the Update Origin operation. To update origin groups, use the Update Origin group operation. To update domains, use the Update Custom Domain operation. |
| begin |
Updates an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile. Only tags can be updated after creating an endpoint. To update origins, use the Update Origin operation. To update origin groups, use the Update Origin group operation. To update domains, use the Update Custom Domain operation. |
| get(string, string, string, Afd |
Gets an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile. |
| list |
Lists existing AzureFrontDoor endpoints. |
| list |
Checks the quota and actual usage of endpoints under the given Azure Front Door profile. |
| validate |
Validates the custom domain mapping to ensure it maps to the correct Azure Front Door endpoint in DNS. |
Method Details
beginCreate(string, string, string, AFDEndpoint, AfdEndpointsCreateOptionalParams)
Creates a new AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile.
function beginCreate(resourceGroupName: string, profileName: string, endpointName: string, endpoint: AFDEndpoint, options?: AfdEndpointsCreateOptionalParams): Promise<SimplePollerLike<OperationState<AFDEndpoint>, AFDEndpoint>>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.
- endpointName
-
string
Name of the endpoint under the profile which is unique globally.
- endpoint
- AFDEndpoint
Endpoint properties
- options
- AfdEndpointsCreateOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<AFDEndpoint>, AFDEndpoint>>
beginCreateAndWait(string, string, string, AFDEndpoint, AfdEndpointsCreateOptionalParams)
Creates a new AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile.
function beginCreateAndWait(resourceGroupName: string, profileName: string, endpointName: string, endpoint: AFDEndpoint, options?: AfdEndpointsCreateOptionalParams): Promise<AFDEndpoint>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.
- endpointName
-
string
Name of the endpoint under the profile which is unique globally.
- endpoint
- AFDEndpoint
Endpoint properties
- options
- AfdEndpointsCreateOptionalParams
The options parameters.
Returns
Promise<AFDEndpoint>
beginDelete(string, string, string, AfdEndpointsDeleteOptionalParams)
Deletes an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile.
function beginDelete(resourceGroupName: string, profileName: string, endpointName: string, options?: AfdEndpointsDeleteOptionalParams): 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.
- endpointName
-
string
Name of the endpoint under the profile which is unique globally.
- options
- AfdEndpointsDeleteOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, string, AfdEndpointsDeleteOptionalParams)
Deletes an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile.
function beginDeleteAndWait(resourceGroupName: string, profileName: string, endpointName: string, options?: AfdEndpointsDeleteOptionalParams): 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.
- endpointName
-
string
Name of the endpoint under the profile which is unique globally.
- options
- AfdEndpointsDeleteOptionalParams
The options parameters.
Returns
Promise<void>
beginPurgeContent(string, string, string, AfdPurgeParameters, AfdEndpointsPurgeContentOptionalParams)
Removes a content from AzureFrontDoor.
function beginPurgeContent(resourceGroupName: string, profileName: string, endpointName: string, contents: AfdPurgeParameters, options?: AfdEndpointsPurgeContentOptionalParams): 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.
- endpointName
-
string
Name of the endpoint under the profile which is unique globally.
- contents
- AfdPurgeParameters
The list of paths to the content and the list of linked domains to be purged. Path can be a full URL, e.g. '/pictures/city.png' which removes a single file, or a directory with a wildcard, e.g. '/pictures/*' which removes all folders and files in the directory.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginPurgeContentAndWait(string, string, string, AfdPurgeParameters, AfdEndpointsPurgeContentOptionalParams)
Removes a content from AzureFrontDoor.
function beginPurgeContentAndWait(resourceGroupName: string, profileName: string, endpointName: string, contents: AfdPurgeParameters, options?: AfdEndpointsPurgeContentOptionalParams): 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.
- endpointName
-
string
Name of the endpoint under the profile which is unique globally.
- contents
- AfdPurgeParameters
The list of paths to the content and the list of linked domains to be purged. Path can be a full URL, e.g. '/pictures/city.png' which removes a single file, or a directory with a wildcard, e.g. '/pictures/*' which removes all folders and files in the directory.
The options parameters.
Returns
Promise<void>
beginUpdate(string, string, string, AFDEndpointUpdateParameters, AfdEndpointsUpdateOptionalParams)
Updates an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile. Only tags can be updated after creating an endpoint. To update origins, use the Update Origin operation. To update origin groups, use the Update Origin group operation. To update domains, use the Update Custom Domain operation.
function beginUpdate(resourceGroupName: string, profileName: string, endpointName: string, endpointUpdateProperties: AFDEndpointUpdateParameters, options?: AfdEndpointsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<AFDEndpoint>, AFDEndpoint>>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.
- endpointName
-
string
Name of the endpoint under the profile which is unique globally.
- endpointUpdateProperties
- AFDEndpointUpdateParameters
Endpoint update properties
- options
- AfdEndpointsUpdateOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<AFDEndpoint>, AFDEndpoint>>
beginUpdateAndWait(string, string, string, AFDEndpointUpdateParameters, AfdEndpointsUpdateOptionalParams)
Updates an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile. Only tags can be updated after creating an endpoint. To update origins, use the Update Origin operation. To update origin groups, use the Update Origin group operation. To update domains, use the Update Custom Domain operation.
function beginUpdateAndWait(resourceGroupName: string, profileName: string, endpointName: string, endpointUpdateProperties: AFDEndpointUpdateParameters, options?: AfdEndpointsUpdateOptionalParams): Promise<AFDEndpoint>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.
- endpointName
-
string
Name of the endpoint under the profile which is unique globally.
- endpointUpdateProperties
- AFDEndpointUpdateParameters
Endpoint update properties
- options
- AfdEndpointsUpdateOptionalParams
The options parameters.
Returns
Promise<AFDEndpoint>
get(string, string, string, AfdEndpointsGetOptionalParams)
Gets an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile.
function get(resourceGroupName: string, profileName: string, endpointName: string, options?: AfdEndpointsGetOptionalParams): Promise<AFDEndpoint>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.
- endpointName
-
string
Name of the endpoint under the profile which is unique globally.
- options
- AfdEndpointsGetOptionalParams
The options parameters.
Returns
Promise<AFDEndpoint>
listByProfile(string, string, AfdEndpointsListByProfileOptionalParams)
Lists existing AzureFrontDoor endpoints.
function listByProfile(resourceGroupName: string, profileName: string, options?: AfdEndpointsListByProfileOptionalParams): PagedAsyncIterableIterator<AFDEndpoint, AFDEndpoint[], 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.
The options parameters.
Returns
listResourceUsage(string, string, string, AfdEndpointsListResourceUsageOptionalParams)
Checks the quota and actual usage of endpoints under the given Azure Front Door profile.
function listResourceUsage(resourceGroupName: string, profileName: string, endpointName: string, options?: AfdEndpointsListResourceUsageOptionalParams): 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.
- endpointName
-
string
Name of the endpoint under the profile which is unique globally.
The options parameters.
Returns
validateCustomDomain(string, string, string, ValidateCustomDomainInput, AfdEndpointsValidateCustomDomainOptionalParams)
Validates the custom domain mapping to ensure it maps to the correct Azure Front Door endpoint in DNS.
function validateCustomDomain(resourceGroupName: string, profileName: string, endpointName: string, customDomainProperties: ValidateCustomDomainInput, options?: AfdEndpointsValidateCustomDomainOptionalParams): Promise<ValidateCustomDomainOutput>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.
- endpointName
-
string
Name of the endpoint under the profile which is unique globally.
- customDomainProperties
- ValidateCustomDomainInput
Custom domain to be validated.
The options parameters.
Returns
Promise<ValidateCustomDomainOutput>