EndpointsOperations Class
EndpointsOperations operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Inheritance
-
builtins.objectEndpointsOperations
Constructor
EndpointsOperations(client, config, serializer, deserializer)Parameters
- client
Client for service requests.
- config
Configuration of service client.
- serializer
An object model serializer.
- deserializer
An object model deserializer.
Variables
- models
Alias to model classes used in this operation group.
Methods
| begin_create |
Creates a new CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile. |
| begin_delete |
Deletes an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile. |
| begin_load_content |
Pre-loads a content to CDN. Available for Verizon Profiles. |
| begin_purge_content |
Removes a content from CDN. |
| begin_start |
Starts an existing CDN endpoint that is on a stopped state. |
| begin_stop |
Stops an existing running CDN endpoint. |
| begin_update |
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. |
| get |
Gets an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile. |
| list_by_profile |
Lists existing CDN endpoints. |
| list_resource_usage |
Checks the quota and usage of geo filters and custom domains under the given endpoint. |
| validate_custom_domain |
Validates the custom domain mapping to ensure it maps to the correct CDN endpoint in DNS. |
begin_create
Creates a new CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.
begin_create(resource_group_name: str, profile_name: str, endpoint_name: str, endpoint: azure.mgmt.cdn.models._models_py3.Endpoint, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.cdn.models._models_py3.Endpoint]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or PollingMethod
By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of LROPoller that returns either Endpoint or the result of cls(response)
Return type
Exceptions
begin_delete
Deletes an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.
begin_delete(resource_group_name: str, profile_name: str, endpoint_name: str, **kwargs: Any) -> azure.core.polling._poller.LROPoller[None]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or PollingMethod
By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of LROPoller that returns either None or the result of cls(response)
Return type
Exceptions
begin_load_content
Pre-loads a content to CDN. Available for Verizon Profiles.
begin_load_content(resource_group_name: str, profile_name: str, endpoint_name: str, content_file_paths: azure.mgmt.cdn.models._models_py3.LoadParameters, **kwargs: Any) -> azure.core.polling._poller.LROPoller[None]Parameters
- content_file_paths
- LoadParameters
The path to the content to be loaded. Path should be a full URL, e.g. '/pictures/city.png' which loads a single file.
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or PollingMethod
By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of LROPoller that returns either None or the result of cls(response)
Return type
Exceptions
begin_purge_content
Removes a content from CDN.
begin_purge_content(resource_group_name: str, profile_name: str, endpoint_name: str, content_file_paths: azure.mgmt.cdn.models._models_py3.PurgeParameters, **kwargs: Any) -> azure.core.polling._poller.LROPoller[None]Parameters
- content_file_paths
- PurgeParameters
The path to the content 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.
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or PollingMethod
By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of LROPoller that returns either None or the result of cls(response)
Return type
Exceptions
begin_start
Starts an existing CDN endpoint that is on a stopped state.
begin_start(resource_group_name: str, profile_name: str, endpoint_name: str, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.cdn.models._models_py3.Endpoint]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or PollingMethod
By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of LROPoller that returns either Endpoint or the result of cls(response)
Return type
Exceptions
begin_stop
Stops an existing running CDN endpoint.
begin_stop(resource_group_name: str, profile_name: str, endpoint_name: str, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.cdn.models._models_py3.Endpoint]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or PollingMethod
By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of LROPoller that returns either Endpoint or the result of cls(response)
Return type
Exceptions
begin_update
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.
begin_update(resource_group_name: str, profile_name: str, endpoint_name: str, endpoint_update_properties: azure.mgmt.cdn.models._models_py3.EndpointUpdateParameters, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.cdn.models._models_py3.Endpoint]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or PollingMethod
By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of LROPoller that returns either Endpoint or the result of cls(response)
Return type
Exceptions
get
Gets an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.
get(resource_group_name: str, profile_name: str, endpoint_name: str, **kwargs: Any) -> azure.mgmt.cdn.models._models_py3.EndpointParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
Endpoint, or the result of cls(response)
Return type
Exceptions
list_by_profile
Lists existing CDN endpoints.
list_by_profile(resource_group_name: str, profile_name: str, **kwargs: Any) -> Iterable[azure.mgmt.cdn.models._models_py3.EndpointListResult]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either EndpointListResult or the result of cls(response)
Return type
Exceptions
list_resource_usage
Checks the quota and usage of geo filters and custom domains under the given endpoint.
list_resource_usage(resource_group_name: str, profile_name: str, endpoint_name: str, **kwargs: Any) -> Iterable[azure.mgmt.cdn.models._models_py3.ResourceUsageListResult]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either ResourceUsageListResult or the result of cls(response)
Return type
Exceptions
validate_custom_domain
Validates the custom domain mapping to ensure it maps to the correct CDN endpoint in DNS.
validate_custom_domain(resource_group_name: str, profile_name: str, endpoint_name: str, custom_domain_properties: azure.mgmt.cdn.models._models_py3.ValidateCustomDomainInput, **kwargs: Any) -> azure.mgmt.cdn.models._models_py3.ValidateCustomDomainOutputParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
ValidateCustomDomainOutput, or the result of cls(response)
Return type
Exceptions
Attributes
models
models = <module 'azure.mgmt.cdn.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\cdn\\models\\__init__.py'>Feedback
Submit and view feedback for