Interface FrontDoors
public interface FrontDoors
Resource collection API of FrontDoors.
-
Method Summary
Modifier and TypeMethodDescriptionBegins definition for a new FrontDoor resource.void
Deletes an existing Front Door with the specified parameters.void
deleteById
(String id) Deletes an existing Front Door with the specified parameters.void
deleteByIdWithResponse
(String id, com.azure.core.util.Context context) Deletes an existing Front Door with the specified parameters.void
deleteByResourceGroup
(String resourceGroupName, String frontDoorName) Deletes an existing Front Door with the specified parameters.Gets a Front Door with the specified Front Door name under the specified subscription and resource group.com.azure.core.http.rest.Response<FrontDoor>
getByIdWithResponse
(String id, com.azure.core.util.Context context) Gets a Front Door with the specified Front Door name under the specified subscription and resource group.getByResourceGroup
(String resourceGroupName, String frontDoorName) Gets a Front Door with the specified Front Door name under the specified subscription and resource group.com.azure.core.http.rest.Response<FrontDoor>
getByResourceGroupWithResponse
(String resourceGroupName, String frontDoorName, com.azure.core.util.Context context) Gets a Front Door with the specified Front Door name under the specified subscription and resource group.com.azure.core.http.rest.PagedIterable<FrontDoor>
list()
Lists all of the Front Doors within an Azure subscription.com.azure.core.http.rest.PagedIterable<FrontDoor>
list
(com.azure.core.util.Context context) Lists all of the Front Doors within an Azure subscription.com.azure.core.http.rest.PagedIterable<FrontDoor>
listByResourceGroup
(String resourceGroupName) Lists all of the Front Doors within a resource group under a subscription.com.azure.core.http.rest.PagedIterable<FrontDoor>
listByResourceGroup
(String resourceGroupName, com.azure.core.util.Context context) Lists all of the Front Doors within a resource group under a subscription.validateCustomDomain
(String resourceGroupName, String frontDoorName, ValidateCustomDomainInput customDomainProperties) Validates the custom domain mapping to ensure it maps to the correct Front Door endpoint in DNS.com.azure.core.http.rest.Response<ValidateCustomDomainOutput>
validateCustomDomainWithResponse
(String resourceGroupName, String frontDoorName, ValidateCustomDomainInput customDomainProperties, com.azure.core.util.Context context) Validates the custom domain mapping to ensure it maps to the correct Front Door endpoint in DNS.
-
Method Details
-
list
com.azure.core.http.rest.PagedIterable<FrontDoor> list()Lists all of the Front Doors within an Azure subscription.- Returns:
- result of the request to list Front Doors as paginated response with
PagedIterable
. - Throws:
com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
list
Lists all of the Front Doors within an Azure subscription.- Parameters:
context
- The context to associate with this operation.- Returns:
- result of the request to list Front Doors as paginated response with
PagedIterable
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
listByResourceGroup
Lists all of the Front Doors within a resource group under a subscription.- Parameters:
resourceGroupName
- Name of the Resource group within the Azure subscription.- Returns:
- result of the request to list Front Doors as paginated response with
PagedIterable
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
listByResourceGroup
com.azure.core.http.rest.PagedIterable<FrontDoor> listByResourceGroup(String resourceGroupName, com.azure.core.util.Context context) Lists all of the Front Doors within a resource group under a subscription.- Parameters:
resourceGroupName
- Name of the Resource group within the Azure subscription.context
- The context to associate with this operation.- Returns:
- result of the request to list Front Doors as paginated response with
PagedIterable
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
getByResourceGroupWithResponse
com.azure.core.http.rest.Response<FrontDoor> getByResourceGroupWithResponse(String resourceGroupName, String frontDoorName, com.azure.core.util.Context context) Gets a Front Door with the specified Front Door name under the specified subscription and resource group.- Parameters:
resourceGroupName
- Name of the Resource group within the Azure subscription.frontDoorName
- Name of the Front Door which is globally unique.context
- The context to associate with this operation.- Returns:
- a Front Door with the specified Front Door name under the specified subscription and resource group along
with
Response
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
getByResourceGroup
Gets a Front Door with the specified Front Door name under the specified subscription and resource group.- Parameters:
resourceGroupName
- Name of the Resource group within the Azure subscription.frontDoorName
- Name of the Front Door which is globally unique.- Returns:
- a Front Door with the specified Front Door name under the specified subscription and resource group.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
deleteByResourceGroup
Deletes an existing Front Door with the specified parameters.- Parameters:
resourceGroupName
- Name of the Resource group within the Azure subscription.frontDoorName
- Name of the Front Door which is globally unique.- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
delete
Deletes an existing Front Door with the specified parameters.- Parameters:
resourceGroupName
- Name of the Resource group within the Azure subscription.frontDoorName
- Name of the Front Door which is globally unique.context
- The context to associate with this operation.- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
validateCustomDomainWithResponse
com.azure.core.http.rest.Response<ValidateCustomDomainOutput> validateCustomDomainWithResponse(String resourceGroupName, String frontDoorName, ValidateCustomDomainInput customDomainProperties, com.azure.core.util.Context context) Validates the custom domain mapping to ensure it maps to the correct Front Door endpoint in DNS.- Parameters:
resourceGroupName
- Name of the Resource group within the Azure subscription.frontDoorName
- Name of the Front Door which is globally unique.customDomainProperties
- Custom domain to be validated.context
- The context to associate with this operation.- Returns:
- output of custom domain validation along with
Response
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
validateCustomDomain
ValidateCustomDomainOutput validateCustomDomain(String resourceGroupName, String frontDoorName, ValidateCustomDomainInput customDomainProperties) Validates the custom domain mapping to ensure it maps to the correct Front Door endpoint in DNS.- Parameters:
resourceGroupName
- Name of the Resource group within the Azure subscription.frontDoorName
- Name of the Front Door which is globally unique.customDomainProperties
- Custom domain to be validated.- Returns:
- output of custom domain validation.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
getById
Gets a Front Door with the specified Front Door name under the specified subscription and resource group.- Parameters:
id
- the resource ID.- Returns:
- a Front Door with the specified Front Door name under the specified subscription and resource group along
with
Response
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
getByIdWithResponse
com.azure.core.http.rest.Response<FrontDoor> getByIdWithResponse(String id, com.azure.core.util.Context context) Gets a Front Door with the specified Front Door name under the specified subscription and resource group.- Parameters:
id
- the resource ID.context
- The context to associate with this operation.- Returns:
- a Front Door with the specified Front Door name under the specified subscription and resource group along
with
Response
. - Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
deleteById
Deletes an existing Front Door with the specified parameters.- Parameters:
id
- the resource ID.- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
deleteByIdWithResponse
Deletes an existing Front Door with the specified parameters.- Parameters:
id
- the resource ID.context
- The context to associate with this operation.- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
define
Begins definition for a new FrontDoor resource.- Parameters:
name
- resource name.- Returns:
- the first stage of the new FrontDoor definition.
-