FrontDoorResource Class

Definition

Namespace:

Azure.ResourceManager.FrontDoor

Assembly:

Azure.ResourceManager.FrontDoor.dll

Package:

Azure.ResourceManager.FrontDoor v1.3.0

Source:

FrontDoorResource.cs

A Class representing a FrontDoor along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct a FrontDoorResource from an instance of ArmClient using the GetFrontDoorResource method. Otherwise you can get one from its parent resource ResourceGroupResource using the GetFrontDoor method.

public class FrontDoorResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.FrontDoor.FrontDoorData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.FrontDoor.FrontDoorData>

type FrontDoorResource = class
    inherit ArmResource
    interface IJsonModel<FrontDoorData>
    interface IPersistableModel<FrontDoorData>

Public Class FrontDoorResource
Inherits ArmResource
Implements IJsonModel(Of FrontDoorData), IPersistableModel(Of FrontDoorData)

Inheritance

Object

ArmResource

FrontDoorResource

Implements

IJsonModel<FrontDoorData> IPersistableModel<FrontDoorData> IPersistableModel<T>

Constructors

FrontDoorResource()

Initializes a new instance of the FrontDoorResource class for mocking.

Fields

ResourceType

Gets the resource type for the operations.

Properties

Client	Gets the ArmClient this resource client was created from. (Inherited from ArmResource)
Data	Gets the data representing this Feature.
Diagnostics	Gets the diagnostic options for this resource client. (Inherited from ArmResource)
Endpoint	Gets the base uri for this resource client. (Inherited from ArmResource)
HasData	Gets whether or not the current instance has data.
Id	Gets the resource identifier. (Inherited from ArmResource)
Pipeline	Gets the pipeline for this resource client. (Inherited from ArmResource)

Methods

AddTag(String, String, CancellationToken)	Add a tag to the current resource. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName} Operation Id: FrontDoors_Get Default Api Version: 2021-06-01 Resource: FrontDoorResource
AddTagAsync(String, String, CancellationToken)	Add a tag to the current resource. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName} Operation Id: FrontDoors_Get Default Api Version: 2021-06-01 Resource: FrontDoorResource
CanUseTagResource(CancellationToken)	Checks to see if the TagResource API is deployed in the current environment. (Inherited from ArmResource)
CanUseTagResourceAsync(CancellationToken)	Checks to see if the TagResource API is deployed in the current environment. (Inherited from ArmResource)
CreateResourceIdentifier(String, String, String)	Generate the resource identifier of a FrontDoorResource instance.
Delete(WaitUntil, CancellationToken)	Deletes an existing Front Door with the specified parameters. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName} Operation Id: FrontDoors_Delete Default Api Version: 2021-06-01 Resource: FrontDoorResource
DeleteAsync(WaitUntil, CancellationToken)	Deletes an existing Front Door with the specified parameters. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName} Operation Id: FrontDoors_Delete Default Api Version: 2021-06-01 Resource: FrontDoorResource
Get(CancellationToken)	Gets a Front Door with the specified Front Door name under the specified subscription and resource group. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName} Operation Id: FrontDoors_Get Default Api Version: 2021-06-01 Resource: FrontDoorResource
GetAsync(CancellationToken)	Gets a Front Door with the specified Front Door name under the specified subscription and resource group. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName} Operation Id: FrontDoors_Get Default Api Version: 2021-06-01 Resource: FrontDoorResource
GetAvailableLocations(CancellationToken)	Lists all available geo-locations. (Inherited from ArmResource)
GetAvailableLocationsAsync(CancellationToken)	Lists all available geo-locations. (Inherited from ArmResource)
GetFrontDoorRulesEngine(String, CancellationToken)	Gets a Rules Engine Configuration with the specified name within the specified Front Door. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName}/rulesEngines/{rulesEngineName} Operation Id: RulesEngines_Get Default Api Version: 2021-06-01 Resource: FrontDoorRulesEngineResource
GetFrontDoorRulesEngineAsync(String, CancellationToken)	Gets a Rules Engine Configuration with the specified name within the specified Front Door. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName}/rulesEngines/{rulesEngineName} Operation Id: RulesEngines_Get Default Api Version: 2021-06-01 Resource: FrontDoorRulesEngineResource
GetFrontDoorRulesEngines()	Gets a collection of FrontDoorRulesEngineResources in the FrontDoor.
GetFrontendEndpoint(String, CancellationToken)	Gets a Frontend endpoint with the specified name within the specified Front Door. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName}/frontendEndpoints/{frontendEndpointName} Operation Id: FrontendEndpoints_Get Default Api Version: 2021-06-01 Resource: FrontendEndpointResource
GetFrontendEndpointAsync(String, CancellationToken)	Gets a Frontend endpoint with the specified name within the specified Front Door. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName}/frontendEndpoints/{frontendEndpointName} Operation Id: FrontendEndpoints_Get Default Api Version: 2021-06-01 Resource: FrontendEndpointResource
GetFrontendEndpoints()	Gets a collection of FrontendEndpointResources in the FrontDoor.
GetManagementLock(String, CancellationToken)	Get a management lock by scope. Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName} Operation Id: ManagementLocks_GetByScope Default Api Version: 2020-05-01 Resource: ManagementLockResource (Inherited from ArmResource)
GetManagementLockAsync(String, CancellationToken)	Get a management lock by scope. Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName} Operation Id: ManagementLocks_GetByScope Default Api Version: 2020-05-01 Resource: ManagementLockResource (Inherited from ArmResource)
GetManagementLocks()	Gets a collection of ManagementLockResources in the ArmResource. (Inherited from ArmResource)
GetPolicyAssignment(String, CancellationToken)	This operation retrieves a single policy assignment, given its name and the scope it was created at. Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName} Operation Id: PolicyAssignments_Get Default Api Version: 2022-06-01 Resource: PolicyAssignmentResource (Inherited from ArmResource)
GetPolicyAssignmentAsync(String, CancellationToken)	This operation retrieves a single policy assignment, given its name and the scope it was created at. Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName} Operation Id: PolicyAssignments_Get Default Api Version: 2022-06-01 Resource: PolicyAssignmentResource (Inherited from ArmResource)
GetPolicyAssignments()	Gets a collection of PolicyAssignmentResources in the ArmResource. (Inherited from ArmResource)
GetTagResource()	Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource. (Inherited from ArmResource)
PurgeContent(WaitUntil, FrontDoorEndpointPurgeContent, CancellationToken)	Removes a content from Front Door. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName}/purge Operation Id: Endpoints_PurgeContent Default Api Version: 2021-06-01
PurgeContentAsync(WaitUntil, FrontDoorEndpointPurgeContent, CancellationToken)	Removes a content from Front Door. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName}/purge Operation Id: Endpoints_PurgeContent Default Api Version: 2021-06-01
RemoveTag(String, CancellationToken)	Removes a tag by key from the resource. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName} Operation Id: FrontDoors_Get Default Api Version: 2021-06-01 Resource: FrontDoorResource
RemoveTagAsync(String, CancellationToken)	Removes a tag by key from the resource. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName} Operation Id: FrontDoors_Get Default Api Version: 2021-06-01 Resource: FrontDoorResource
SetTags(IDictionary<String,String>, CancellationToken)	Replace the tags on the resource with the given set. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName} Operation Id: FrontDoors_Get Default Api Version: 2021-06-01 Resource: FrontDoorResource
SetTagsAsync(IDictionary<String,String>, CancellationToken)	Replace the tags on the resource with the given set. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName} Operation Id: FrontDoors_Get Default Api Version: 2021-06-01 Resource: FrontDoorResource
TryGetApiVersion(ResourceType, String)	Gets the api version override if it has been set for the current client options. (Inherited from ArmResource)
Update(WaitUntil, FrontDoorData, CancellationToken)	Creates a new Front Door with a Front Door name under the specified subscription and resource group. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName} Operation Id: FrontDoors_CreateOrUpdate Default Api Version: 2021-06-01 Resource: FrontDoorResource
UpdateAsync(WaitUntil, FrontDoorData, CancellationToken)	Creates a new Front Door with a Front Door name under the specified subscription and resource group. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName} Operation Id: FrontDoors_CreateOrUpdate Default Api Version: 2021-06-01 Resource: FrontDoorResource
ValidateCustomDomain(FrontDoorValidateCustomDomainContent, CancellationToken)	Validates the custom domain mapping to ensure it maps to the correct Front Door endpoint in DNS. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName}/validateCustomDomain Operation Id: FrontDoors_ValidateCustomDomain Default Api Version: 2021-06-01 Resource: FrontDoorResource
ValidateCustomDomainAsync(FrontDoorValidateCustomDomainContent, CancellationToken)	Validates the custom domain mapping to ensure it maps to the correct Front Door endpoint in DNS. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName}/validateCustomDomain Operation Id: FrontDoors_ValidateCustomDomain Default Api Version: 2021-06-01 Resource: FrontDoorResource

Explicit Interface Implementations

IJsonModel<FrontDoorData>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<FrontDoorData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<FrontDoorData>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<FrontDoorData>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<FrontDoorData>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.

Extension Methods

GetAuthorizationRoleDefinition(ArmResource, ResourceIdentifier, CancellationToken)	Get role definition by name (GUID). Request Path: /{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId} Operation Id: RoleDefinitions_Get Default Api Version: 2022-04-01 Resource: AuthorizationRoleDefinitionResource
GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken)	Get role definition by name (GUID). Request Path: /{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId} Operation Id: RoleDefinitions_Get Default Api Version: 2022-04-01 Resource: AuthorizationRoleDefinitionResource
GetAuthorizationRoleDefinitions(ArmResource)	Gets a collection of AuthorizationRoleDefinitionResources in the ArmResource. MockingTo mock this method, please mock GetAuthorizationRoleDefinitions() instead.
GetDenyAssignment(ArmResource, String, CancellationToken)	Get the specified deny assignment. Request Path: /{scope}/providers/Microsoft.Authorization/denyAssignments/{denyAssignmentId} Operation Id: DenyAssignments_Get Default Api Version: 2022-04-01 Resource: DenyAssignmentResource
GetDenyAssignmentAsync(ArmResource, String, CancellationToken)	Get the specified deny assignment. Request Path: /{scope}/providers/Microsoft.Authorization/denyAssignments/{denyAssignmentId} Operation Id: DenyAssignments_Get Default Api Version: 2022-04-01 Resource: DenyAssignmentResource
GetDenyAssignments(ArmResource)	Gets a collection of DenyAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetDenyAssignments() instead.
GetRoleAssignment(ArmResource, String, String, CancellationToken)	Get a role assignment by scope and name. Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName} Operation Id: RoleAssignments_Get Default Api Version: 2022-04-01 Resource: RoleAssignmentResource
GetRoleAssignmentAsync(ArmResource, String, String, CancellationToken)	Get a role assignment by scope and name. Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName} Operation Id: RoleAssignments_Get Default Api Version: 2022-04-01 Resource: RoleAssignmentResource
GetRoleAssignments(ArmResource)	Gets a collection of RoleAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignments() instead.
GetRoleAssignmentSchedule(ArmResource, String, CancellationToken)	Get the specified role assignment schedule for a resource scope Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentSchedules/{roleAssignmentScheduleName} Operation Id: RoleAssignmentSchedules_Get Default Api Version: 2020-10-01 Resource: RoleAssignmentScheduleResource
GetRoleAssignmentScheduleAsync(ArmResource, String, CancellationToken)	Get the specified role assignment schedule for a resource scope Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentSchedules/{roleAssignmentScheduleName} Operation Id: RoleAssignmentSchedules_Get Default Api Version: 2020-10-01 Resource: RoleAssignmentScheduleResource
GetRoleAssignmentScheduleInstance(ArmResource, String, CancellationToken)	Gets the specified role assignment schedule instance. Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleInstances/{roleAssignmentScheduleInstanceName} Operation Id: RoleAssignmentScheduleInstances_Get Default Api Version: 2020-10-01 Resource: RoleAssignmentScheduleInstanceResource
GetRoleAssignmentScheduleInstanceAsync(ArmResource, String, CancellationToken)	Gets the specified role assignment schedule instance. Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleInstances/{roleAssignmentScheduleInstanceName} Operation Id: RoleAssignmentScheduleInstances_Get Default Api Version: 2020-10-01 Resource: RoleAssignmentScheduleInstanceResource
GetRoleAssignmentScheduleInstances(ArmResource)	Gets a collection of RoleAssignmentScheduleInstanceResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentScheduleInstances() instead.
GetRoleAssignmentScheduleRequest(ArmResource, String, CancellationToken)	Get the specified role assignment schedule request. Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleRequests/{roleAssignmentScheduleRequestName} Operation Id: RoleAssignmentScheduleRequests_Get Default Api Version: 2020-10-01 Resource: RoleAssignmentScheduleRequestResource
GetRoleAssignmentScheduleRequestAsync(ArmResource, String, CancellationToken)	Get the specified role assignment schedule request. Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleRequests/{roleAssignmentScheduleRequestName} Operation Id: RoleAssignmentScheduleRequests_Get Default Api Version: 2020-10-01 Resource: RoleAssignmentScheduleRequestResource
GetRoleAssignmentScheduleRequests(ArmResource)	Gets a collection of RoleAssignmentScheduleRequestResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentScheduleRequests() instead.
GetRoleAssignmentSchedules(ArmResource)	Gets a collection of RoleAssignmentScheduleResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentSchedules() instead.
GetRoleEligibilitySchedule(ArmResource, String, CancellationToken)	Get the specified role eligibility schedule for a resource scope Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilitySchedules/{roleEligibilityScheduleName} Operation Id: RoleEligibilitySchedules_Get Default Api Version: 2020-10-01 Resource: RoleEligibilityScheduleResource
GetRoleEligibilityScheduleAsync(ArmResource, String, CancellationToken)	Get the specified role eligibility schedule for a resource scope Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilitySchedules/{roleEligibilityScheduleName} Operation Id: RoleEligibilitySchedules_Get Default Api Version: 2020-10-01 Resource: RoleEligibilityScheduleResource
GetRoleEligibilityScheduleInstance(ArmResource, String, CancellationToken)	Gets the specified role eligibility schedule instance. Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleInstances/{roleEligibilityScheduleInstanceName} Operation Id: RoleEligibilityScheduleInstances_Get Default Api Version: 2020-10-01 Resource: RoleEligibilityScheduleInstanceResource
GetRoleEligibilityScheduleInstanceAsync(ArmResource, String, CancellationToken)	Gets the specified role eligibility schedule instance. Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleInstances/{roleEligibilityScheduleInstanceName} Operation Id: RoleEligibilityScheduleInstances_Get Default Api Version: 2020-10-01 Resource: RoleEligibilityScheduleInstanceResource
GetRoleEligibilityScheduleInstances(ArmResource)	Gets a collection of RoleEligibilityScheduleInstanceResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilityScheduleInstances() instead.
GetRoleEligibilityScheduleRequest(ArmResource, String, CancellationToken)	Get the specified role eligibility schedule request. Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleRequests/{roleEligibilityScheduleRequestName} Operation Id: RoleEligibilityScheduleRequests_Get Default Api Version: 2020-10-01 Resource: RoleEligibilityScheduleRequestResource
GetRoleEligibilityScheduleRequestAsync(ArmResource, String, CancellationToken)	Get the specified role eligibility schedule request. Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleRequests/{roleEligibilityScheduleRequestName} Operation Id: RoleEligibilityScheduleRequests_Get Default Api Version: 2020-10-01 Resource: RoleEligibilityScheduleRequestResource
GetRoleEligibilityScheduleRequests(ArmResource)	Gets a collection of RoleEligibilityScheduleRequestResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilityScheduleRequests() instead.
GetRoleEligibilitySchedules(ArmResource)	Gets a collection of RoleEligibilityScheduleResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilitySchedules() instead.
GetRoleManagementPolicies(ArmResource)	Gets a collection of RoleManagementPolicyResources in the ArmResource. MockingTo mock this method, please mock GetRoleManagementPolicies() instead.
GetRoleManagementPolicy(ArmResource, String, CancellationToken)	Get the specified role management policy for a resource scope Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicies/{roleManagementPolicyName} Operation Id: RoleManagementPolicies_Get Default Api Version: 2020-10-01 Resource: RoleManagementPolicyResource
GetRoleManagementPolicyAssignment(ArmResource, String, CancellationToken)	Get the specified role management policy assignment for a resource scope Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicyAssignments/{roleManagementPolicyAssignmentName} Operation Id: RoleManagementPolicyAssignments_Get Default Api Version: 2020-10-01 Resource: RoleManagementPolicyAssignmentResource
GetRoleManagementPolicyAssignmentAsync(ArmResource, String, CancellationToken)	Get the specified role management policy assignment for a resource scope Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicyAssignments/{roleManagementPolicyAssignmentName} Operation Id: RoleManagementPolicyAssignments_Get Default Api Version: 2020-10-01 Resource: RoleManagementPolicyAssignmentResource
GetRoleManagementPolicyAssignments(ArmResource)	Gets a collection of RoleManagementPolicyAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetRoleManagementPolicyAssignments() instead.
GetRoleManagementPolicyAsync(ArmResource, String, CancellationToken)	Get the specified role management policy for a resource scope Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicies/{roleManagementPolicyName} Operation Id: RoleManagementPolicies_Get Default Api Version: 2020-10-01 Resource: RoleManagementPolicyResource
GetSystemAssignedIdentity(ArmResource)	Gets an object representing a SystemAssignedIdentityResource along with the instance operations that can be performed on it in the ArmResource. MockingTo mock this method, please mock GetSystemAssignedIdentity() instead.
GetLinkerResource(ArmResource, String, CancellationToken)	Returns Linker resource for a given name. Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName} Operation Id: Linker_Get
GetLinkerResourceAsync(ArmResource, String, CancellationToken)	Returns Linker resource for a given name. Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName} Operation Id: Linker_Get
GetLinkerResources(ArmResource)	Gets a collection of LinkerResources in the ArmResource. MockingTo mock this method, please mock GetLinkerResources() instead.