CdnEndpointResource Class

Definition

A class representing a CdnEndpoint along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct a CdnEndpointResource from an instance of ArmClient using the GetResource method. Otherwise you can get one from its parent resource ProfileResource using the GetCdnEndpoints method.

public class CdnEndpointResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Cdn.CdnEndpointData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Cdn.CdnEndpointData>
type CdnEndpointResource = class
    inherit ArmResource
    interface IJsonModel<CdnEndpointData>
    interface IPersistableModel<CdnEndpointData>
Public Class CdnEndpointResource
Inherits ArmResource
Implements IJsonModel(Of CdnEndpointData), IPersistableModel(Of CdnEndpointData)
Inheritance
CdnEndpointResource
Implements

Constructors

Name Description
CdnEndpointResource()

Initializes a new instance of CdnEndpointResource for mocking.

Fields

Name Description
ResourceType

Gets the resource type for the operations.

Properties

Name Description
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

Name Description
AddTag(String, String, CancellationToken)

Add a tag to the current resource.

AddTagAsync(String, String, CancellationToken)

Add a tag to the current resource.

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, String)

Generate the resource identifier for this resource.

Delete(WaitUntil, CancellationToken)

Deletes an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}.
  • Operation Id. : Endpoints_Delete.
  • Default Api Version. : 2025-09-01-preview.
  • Resource. : CdnEndpointResource.
DeleteAsync(WaitUntil, CancellationToken)

Deletes an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}.
  • Operation Id. : Endpoints_Delete.
  • Default Api Version. : 2025-09-01-preview.
  • Resource. : CdnEndpointResource.
Get(CancellationToken)

Gets an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}.
  • Operation Id. : Endpoints_Get.
  • Default Api Version. : 2025-09-01-preview.
  • Resource. : CdnEndpointResource.
GetAsync(CancellationToken)

Gets an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}.
  • Operation Id. : Endpoints_Get.
  • Default Api Version. : 2025-09-01-preview.
  • Resource. : CdnEndpointResource.
GetAvailableLocations(CancellationToken)

Lists all available geo-locations.

(Inherited from ArmResource)
GetAvailableLocationsAsync(CancellationToken)

Lists all available geo-locations.

(Inherited from ArmResource)
GetCdnCustomDomain(String, CancellationToken)

Gets an existing custom domain within an endpoint.

GetCdnCustomDomainAsync(String, CancellationToken)

Gets an existing custom domain within an endpoint.

GetCdnCustomDomains()

Gets a collection of CdnCustomDomains in the CdnEndpointResource.

GetCdnOrigin(String, CancellationToken)

Gets an existing origin within an endpoint.

GetCdnOriginAsync(String, CancellationToken)

Gets an existing origin within an endpoint.

GetCdnOriginGroup(String, CancellationToken)

Gets an existing origin group within an endpoint.

GetCdnOriginGroupAsync(String, CancellationToken)

Gets an existing origin group within an endpoint.

GetCdnOriginGroups()

Gets a collection of CdnOriginGroups in the CdnEndpointResource.

GetCdnOrigins()

Gets a collection of CdnOrigins in the CdnEndpointResource.

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)
GetResourceUsages(CancellationToken)

Checks the quota and usage of geo filters and custom domains under the given endpoint.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/checkResourceUsage.
  • Operation Id. : Endpoints_ListResourceUsage.
  • Default Api Version. : 2025-09-01-preview.
  • Resource. : CdnEndpointResource.
GetResourceUsagesAsync(CancellationToken)

Checks the quota and usage of geo filters and custom domains under the given endpoint.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/checkResourceUsage.
  • Operation Id. : Endpoints_ListResourceUsage.
  • Default Api Version. : 2025-09-01-preview.
  • Resource. : CdnEndpointResource.
GetTagResource()

Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource.

(Inherited from ArmResource)
LoadContent(WaitUntil, LoadContent, CancellationToken)

Pre-loads a content to CDN. Available for Verizon Profiles.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/load.
  • Operation Id. : Endpoints_LoadContent.
  • Default Api Version. : 2025-09-01-preview.
  • Resource. : CdnEndpointResource.
LoadContentAsync(WaitUntil, LoadContent, CancellationToken)

Pre-loads a content to CDN. Available for Verizon Profiles.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/load.
  • Operation Id. : Endpoints_LoadContent.
  • Default Api Version. : 2025-09-01-preview.
  • Resource. : CdnEndpointResource.
PurgeContent(WaitUntil, PurgeContent, CancellationToken)

Removes a content from CDN.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/purge.
  • Operation Id. : Endpoints_PurgeContent.
  • Default Api Version. : 2025-09-01-preview.
  • Resource. : CdnEndpointResource.
PurgeContentAsync(WaitUntil, PurgeContent, CancellationToken)

Removes a content from CDN.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/purge.
  • Operation Id. : Endpoints_PurgeContent.
  • Default Api Version. : 2025-09-01-preview.
  • Resource. : CdnEndpointResource.
RemoveTag(String, CancellationToken)

Removes a tag by key from the resource.

RemoveTagAsync(String, CancellationToken)

Removes a tag by key from the resource.

SetTags(IDictionary<String,String>, CancellationToken)

Replace the tags on the resource with the given set.

SetTagsAsync(IDictionary<String,String>, CancellationToken)

Replace the tags on the resource with the given set.

Start(WaitUntil, CancellationToken)

Starts an existing CDN endpoint that is on a stopped state.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/start.
  • Operation Id. : Endpoints_Start.
  • Default Api Version. : 2025-09-01-preview.
  • Resource. : CdnEndpointResource.
StartAsync(WaitUntil, CancellationToken)

Starts an existing CDN endpoint that is on a stopped state.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/start.
  • Operation Id. : Endpoints_Start.
  • Default Api Version. : 2025-09-01-preview.
  • Resource. : CdnEndpointResource.
Stop(WaitUntil, CancellationToken)

Stops an existing running CDN endpoint.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/stop.
  • Operation Id. : Endpoints_Stop.
  • Default Api Version. : 2025-09-01-preview.
  • Resource. : CdnEndpointResource.
StopAsync(WaitUntil, CancellationToken)

Stops an existing running CDN endpoint.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/stop.
  • Operation Id. : Endpoints_Stop.
  • Default Api Version. : 2025-09-01-preview.
  • Resource. : CdnEndpointResource.
TryGetApiVersion(ResourceType, String)

Gets the api version override if it has been set for the current client options.

(Inherited from ArmResource)
Update(WaitUntil, CdnEndpointPatch, CancellationToken)

Updates an existing CDN 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 custom domains, use the Update Custom Domain operation.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}.
  • Operation Id. : Endpoints_Update.
  • Default Api Version. : 2025-09-01-preview.
  • Resource. : CdnEndpointResource.
UpdateAsync(WaitUntil, CdnEndpointPatch, CancellationToken)

Updates an existing CDN 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 custom domains, use the Update Custom Domain operation.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}.
  • Operation Id. : Endpoints_Update.
  • Default Api Version. : 2025-09-01-preview.
  • Resource. : CdnEndpointResource.
ValidateCustomDomain(ValidateCustomDomainContent, CancellationToken)

Validates the custom domain mapping to ensure it maps to the correct CDN endpoint in DNS.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/validateCustomDomain.
  • Operation Id. : Endpoints_ValidateCustomDomain.
  • Default Api Version. : 2025-09-01-preview.
  • Resource. : CdnEndpointResource.
ValidateCustomDomainAsync(ValidateCustomDomainContent, CancellationToken)

Validates the custom domain mapping to ensure it maps to the correct CDN endpoint in DNS.

  • Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/validateCustomDomain.
  • Operation Id. : Endpoints_ValidateCustomDomain.
  • Default Api Version. : 2025-09-01-preview.
  • Resource. : CdnEndpointResource.

Explicit Interface Implementations

Name Description
IJsonModel<CdnEndpointData>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<CdnEndpointData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<CdnEndpointData>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<CdnEndpointData>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<CdnEndpointData>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Extension Methods

Name Description
GetAuthorizationRoleDefinition(ArmResource, ResourceIdentifier, CancellationToken)

Gets the role definition identified by roleDefinitionId at this resource scope.

GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken)

Gets the role definition identified by roleDefinitionId at this resource scope.

GetAuthorizationRoleDefinitions(ArmResource)

Gets a collection of AuthorizationRoleDefinitionCollection objects within the specified scope.

GetDenyAssignment(ArmResource, String, CancellationToken)

Get the specified deny assignment.

GetDenyAssignmentAsync(ArmResource, String, CancellationToken)

Get the specified deny assignment.

GetDenyAssignments(ArmResource)

Gets a collection of DenyAssignmentCollection objects within the specified scope.

GetLinkerResource(ArmResource, String, CancellationToken)

Returns Linker resource for a given name.

  • Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
  • Operation Id: Linker_Get
  • Default Api Version: 2022-05-01
  • Resource: LinkerResource
<item>MockingTo mock this method, please mock GetLinkerResource(String, CancellationToken) instead.</item>
GetLinkerResourceAsync(ArmResource, String, CancellationToken)

Returns Linker resource for a given name.

  • Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
  • Operation Id: Linker_Get
  • Default Api Version: 2022-05-01
  • Resource: LinkerResource
<item>MockingTo mock this method, please mock GetLinkerResourceAsync(String, CancellationToken) instead.</item>
GetLinkerResources(ArmResource)

Gets a collection of LinkerResources in the ArmResource. <item>MockingTo mock this method, please mock GetLinkerResources() instead.</item>

GetRoleAssignment(ArmResource, String, String, CancellationToken)

Get a role assignment by scope and name.

GetRoleAssignmentAsync(ArmResource, String, String, CancellationToken)

Get a role assignment by scope and name.

GetRoleAssignments(ArmResource)

Gets a collection of RoleAssignmentCollection objects within the specified scope.

GetRoleAssignmentSchedule(ArmResource, String, CancellationToken)

Get the specified role assignment schedule for a resource scope.

GetRoleAssignmentScheduleAsync(ArmResource, String, CancellationToken)

Get the specified role assignment schedule for a resource scope.

GetRoleAssignmentScheduleInstance(ArmResource, String, CancellationToken)

Gets the specified role assignment schedule instance.

GetRoleAssignmentScheduleInstanceAsync(ArmResource, String, CancellationToken)

Gets the specified role assignment schedule instance.

GetRoleAssignmentScheduleInstances(ArmResource)

Gets a collection of RoleAssignmentScheduleInstanceCollection objects within the specified scope.

GetRoleAssignmentScheduleRequest(ArmResource, String, CancellationToken)

Get the specified role assignment schedule request.

GetRoleAssignmentScheduleRequestAsync(ArmResource, String, CancellationToken)

Get the specified role assignment schedule request.

GetRoleAssignmentScheduleRequests(ArmResource)

Gets a collection of RoleAssignmentScheduleRequestCollection objects within the specified scope.

GetRoleAssignmentSchedules(ArmResource)

Gets a collection of RoleAssignmentScheduleCollection objects within the specified scope.

GetRoleEligibilitySchedule(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule for a resource scope.

GetRoleEligibilityScheduleAsync(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule for a resource scope.

GetRoleEligibilityScheduleInstance(ArmResource, String, CancellationToken)

Gets the specified role eligibility schedule instance.

GetRoleEligibilityScheduleInstanceAsync(ArmResource, String, CancellationToken)

Gets the specified role eligibility schedule instance.

GetRoleEligibilityScheduleInstances(ArmResource)

Gets a collection of RoleEligibilityScheduleInstanceCollection objects within the specified scope.

GetRoleEligibilityScheduleRequest(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule request.

GetRoleEligibilityScheduleRequestAsync(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule request.

GetRoleEligibilityScheduleRequests(ArmResource)

Gets a collection of RoleEligibilityScheduleRequestCollection objects within the specified scope.

GetRoleEligibilitySchedules(ArmResource)

Gets a collection of RoleEligibilityScheduleCollection objects within the specified scope.

GetRoleManagementPolicies(ArmResource)

Gets a collection of RoleManagementPolicyCollection objects within the specified scope.

GetRoleManagementPolicy(ArmResource, String, CancellationToken)

Get the specified role management policy for a resource scope.

GetRoleManagementPolicyAssignment(ArmResource, String, CancellationToken)

Get the specified role management policy assignment for a resource scope.

GetRoleManagementPolicyAssignmentAsync(ArmResource, String, CancellationToken)

Get the specified role management policy assignment for a resource scope.

GetRoleManagementPolicyAssignments(ArmResource)

Gets a collection of RoleManagementPolicyAssignmentCollection objects within the specified scope.

GetRoleManagementPolicyAsync(ArmResource, String, CancellationToken)

Get the specified role management policy for a resource scope.

GetSystemAssignedIdentity(ArmResource)

Gets an object representing a SystemAssignedIdentityResource along with the instance operations that can be performed on it in the ArmResource scope.

Applies to