azure.mgmt.cdn.operations module

class azure.mgmt.cdn.operations.ProfilesOperations(client, config, serializer, deserializer)[source]

Bases: object

ProfilesOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
create(resource_group_name, profile_name, profile, custom_headers=None, raw=False, **operation_config)[source]

Creates a new CDN profile with a profile name under the specified subscription and resource group.

Parameters:
  • resource_group_name (str) – Name of the Resource group within the Azure subscription.
  • profile_name (str) – Name of the CDN profile which is unique within the resource group.
  • profile (Profile) – Profile properties needed to create a new profile.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns Profile

Return type:

ClientRawResponse if raw=true

Raises:

ErrorResponseException

delete(resource_group_name, profile_name, custom_headers=None, raw=False, **operation_config)[source]

Deletes an existing CDN profile with the specified parameters. Deleting a profile will result in the deletion of all of the sub-resources including endpoints, origins and custom domains.

Parameters:
  • resource_group_name (str) – Name of the Resource group within the Azure subscription.
  • profile_name (str) – Name of the CDN profile which is unique within the resource group.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns None

Return type:

ClientRawResponse if raw=true

Raises:

ErrorResponseException

generate_sso_uri(resource_group_name, profile_name, custom_headers=None, raw=False, **operation_config)[source]

Generates a dynamic SSO URI used to sign in to the CDN supplemental portal. Supplemnetal portal is used to configure advanced feature capabilities that are not yet available in the Azure portal, such as core reports in a standard profile; rules engine, advanced HTTP reports, and real-time stats and alerts in a premium profile. The SSO URI changes approximately every 10 minutes.

Parameters:
  • resource_group_name (str) – Name of the Resource group within the Azure subscription.
  • profile_name (str) – Name of the CDN profile which is unique within the resource group.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

SsoUri

Return type:

ClientRawResponse if raw=true

Raises:

ErrorResponseException

get(resource_group_name, profile_name, custom_headers=None, raw=False, **operation_config)[source]

Gets a CDN profile with the specified profile name under the specified subscription and resource group.

Parameters:
  • resource_group_name (str) – Name of the Resource group within the Azure subscription.
  • profile_name (str) – Name of the CDN profile which is unique within the resource group.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

Profile

Return type:

ClientRawResponse if raw=true

Raises:

ErrorResponseException

list(custom_headers=None, raw=False, **operation_config)[source]

Lists all of the CDN profiles within an Azure subscription.

Parameters:
Return type:

ProfilePaged

Raises:

ErrorResponseException

list_by_resource_group(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]

Lists all of the CDN profiles within a resource group.

Parameters:
  • resource_group_name (str) – Name of the Resource group within the Azure subscription.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

ProfilePaged

Raises:

ErrorResponseException

list_resource_usage(resource_group_name, profile_name, custom_headers=None, raw=False, **operation_config)[source]

Checks the quota and actual usage of endpoints under the given CDN profile.

Parameters:
  • resource_group_name (str) – Name of the Resource group within the Azure subscription.
  • profile_name (str) – Name of the CDN profile which is unique within the resource group.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

ResourceUsagePaged

Raises:

ErrorResponseException

update(resource_group_name, profile_name, tags, custom_headers=None, raw=False, **operation_config)[source]

Updates an existing CDN profile with the specified profile name under the specified subscription and resource group.

Parameters:
  • resource_group_name (str) – Name of the Resource group within the Azure subscription.
  • profile_name (str) – Name of the CDN profile which is unique within the resource group.
  • tags (dict) – Profile tags
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns Profile

Return type:

ClientRawResponse if raw=true

Raises:

ErrorResponseException

class azure.mgmt.cdn.operations.EndpointsOperations(client, config, serializer, deserializer)[source]

Bases: object

EndpointsOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
create(resource_group_name, profile_name, endpoint_name, endpoint, custom_headers=None, raw=False, **operation_config)[source]

Creates a new CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.

Parameters:
  • resource_group_name (str) – Name of the Resource group within the Azure subscription.
  • profile_name (str) – Name of the CDN profile which is unique within the resource group.
  • endpoint_name (str) – Name of the endpoint under the profile which is unique globally.
  • endpoint (Endpoint) – Endpoint properties
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns Endpoint

Return type:

ClientRawResponse if raw=true

Raises:

ErrorResponseException

delete(resource_group_name, profile_name, endpoint_name, custom_headers=None, raw=False, **operation_config)[source]

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

Parameters:
  • resource_group_name (str) – Name of the Resource group within the Azure subscription.
  • profile_name (str) – Name of the CDN profile which is unique within the resource group.
  • endpoint_name (str) – Name of the endpoint under the profile which is unique globally.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns None

Return type:

ClientRawResponse if raw=true

Raises:

ErrorResponseException

get(resource_group_name, profile_name, endpoint_name, custom_headers=None, raw=False, **operation_config)[source]

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

Parameters:
  • resource_group_name (str) – Name of the Resource group within the Azure subscription.
  • profile_name (str) – Name of the CDN profile which is unique within the resource group.
  • endpoint_name (str) – Name of the endpoint under the profile which is unique globally.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

Endpoint

Return type:

ClientRawResponse if raw=true

Raises:

ErrorResponseException

list_by_profile(resource_group_name, profile_name, custom_headers=None, raw=False, **operation_config)[source]

Lists existing CDN endpoints.

Parameters:
  • resource_group_name (str) – Name of the Resource group within the Azure subscription.
  • profile_name (str) – Name of the CDN profile which is unique within the resource group.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

EndpointPaged

Raises:

ErrorResponseException

list_resource_usage(resource_group_name, profile_name, endpoint_name, custom_headers=None, raw=False, **operation_config)[source]

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

Parameters:
  • resource_group_name (str) – Name of the Resource group within the Azure subscription.
  • profile_name (str) – Name of the CDN profile which is unique within the resource group.
  • endpoint_name (str) – Name of the endpoint under the profile which is unique globally.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

ResourceUsagePaged

Raises:

ErrorResponseException

load_content(resource_group_name, profile_name, endpoint_name, content_paths, custom_headers=None, raw=False, **operation_config)[source]

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

Parameters:
  • resource_group_name (str) – Name of the Resource group within the Azure subscription.
  • profile_name (str) – Name of the CDN profile which is unique within the resource group.
  • endpoint_name (str) – Name of the endpoint under the profile which is unique globally.
  • content_paths (list of str) – The path to the content to be loaded. Path should be a relative file URL of the origin.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns None

Return type:

ClientRawResponse if raw=true

Raises:

ErrorResponseException

purge_content(resource_group_name, profile_name, endpoint_name, content_paths, custom_headers=None, raw=False, **operation_config)[source]

Removes a content from CDN.

Parameters:
  • resource_group_name (str) – Name of the Resource group within the Azure subscription.
  • profile_name (str) – Name of the CDN profile which is unique within the resource group.
  • endpoint_name (str) – Name of the endpoint under the profile which is unique globally.
  • content_paths (list of str) – The path to the content to be purged. Can describe a file path or a wild card directory.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns None

Return type:

ClientRawResponse if raw=true

Raises:

ErrorResponseException

start(resource_group_name, profile_name, endpoint_name, custom_headers=None, raw=False, **operation_config)[source]

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

Parameters:
  • resource_group_name (str) – Name of the Resource group within the Azure subscription.
  • profile_name (str) – Name of the CDN profile which is unique within the resource group.
  • endpoint_name (str) – Name of the endpoint under the profile which is unique globally.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns Endpoint

Return type:

ClientRawResponse if raw=true

Raises:

ErrorResponseException

stop(resource_group_name, profile_name, endpoint_name, custom_headers=None, raw=False, **operation_config)[source]

Stops an existing running CDN endpoint.

Parameters:
  • resource_group_name (str) – Name of the Resource group within the Azure subscription.
  • profile_name (str) – Name of the CDN profile which is unique within the resource group.
  • endpoint_name (str) – Name of the endpoint under the profile which is unique globally.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns Endpoint

Return type:

ClientRawResponse if raw=true

Raises:

ErrorResponseException

update(resource_group_name, profile_name, endpoint_name, endpoint_update_properties, custom_headers=None, raw=False, **operation_config)[source]

Updates an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile. Only tags and Origin HostHeader can be updated after creating an endpoint. To update origins, use the Update Origin operation. To update custom domains, use the Update Custom Domain operation.

Parameters:
  • resource_group_name (str) – Name of the Resource group within the Azure subscription.
  • profile_name (str) – Name of the CDN profile which is unique within the resource group.
  • endpoint_name (str) – Name of the endpoint under the profile which is unique globally.
  • endpoint_update_properties (EndpointUpdateParameters) – Endpoint update properties
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns Endpoint

Return type:

ClientRawResponse if raw=true

Raises:

ErrorResponseException

validate_custom_domain(resource_group_name, profile_name, endpoint_name, host_name, custom_headers=None, raw=False, **operation_config)[source]

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

Parameters:
  • resource_group_name (str) – Name of the Resource group within the Azure subscription.
  • profile_name (str) – Name of the CDN profile which is unique within the resource group.
  • endpoint_name (str) – Name of the endpoint under the profile which is unique globally.
  • host_name (str) – The host name of the custom domain. Must be a domain name.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

ValidateCustomDomainOutput

Return type:

ClientRawResponse if raw=true

Raises:

ErrorResponseException

class azure.mgmt.cdn.operations.OriginsOperations(client, config, serializer, deserializer)[source]

Bases: object

OriginsOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
get(resource_group_name, profile_name, endpoint_name, origin_name, custom_headers=None, raw=False, **operation_config)[source]

Gets an existing origin within an endpoint.

Parameters:
  • resource_group_name (str) – Name of the Resource group within the Azure subscription.
  • profile_name (str) – Name of the CDN profile which is unique within the resource group.
  • endpoint_name (str) – Name of the endpoint under the profile which is unique globally.
  • origin_name (str) – Name of the origin which is unique within the endpoint.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

Origin

Return type:

ClientRawResponse if raw=true

Raises:

ErrorResponseException

list_by_endpoint(resource_group_name, profile_name, endpoint_name, custom_headers=None, raw=False, **operation_config)[source]

Lists all of the existing origins within an endpoint.

Parameters:
  • resource_group_name (str) – Name of the Resource group within the Azure subscription.
  • profile_name (str) – Name of the CDN profile which is unique within the resource group.
  • endpoint_name (str) – Name of the endpoint under the profile which is unique globally.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

OriginPaged

Raises:

ErrorResponseException

update(resource_group_name, profile_name, endpoint_name, origin_name, origin_update_properties, custom_headers=None, raw=False, **operation_config)[source]

Updates an existing origin within an endpoint.

Parameters:
  • resource_group_name (str) – Name of the Resource group within the Azure subscription.
  • profile_name (str) – Name of the CDN profile which is unique within the resource group.
  • endpoint_name (str) – Name of the endpoint under the profile which is unique globally.
  • origin_name (str) – Name of the origin which is unique within the endpoint.
  • origin_update_properties (OriginUpdateParameters) – Origin properties
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns Origin

Return type:

ClientRawResponse if raw=true

Raises:

ErrorResponseException

class azure.mgmt.cdn.operations.CustomDomainsOperations(client, config, serializer, deserializer)[source]

Bases: object

CustomDomainsOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
create(resource_group_name, profile_name, endpoint_name, custom_domain_name, host_name, custom_headers=None, raw=False, **operation_config)[source]

Creates a new custom domain within an endpoint.

Parameters:
  • resource_group_name (str) – Name of the Resource group within the Azure subscription.
  • profile_name (str) – Name of the CDN profile which is unique within the resource group.
  • endpoint_name (str) – Name of the endpoint under the profile which is unique globally.
  • custom_domain_name (str) – Name of the custom domain within an endpoint.
  • host_name (str) – The host name of the custom domain. Must be a domain name.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns CustomDomain

Return type:

ClientRawResponse if raw=true

Raises:

ErrorResponseException

delete(resource_group_name, profile_name, endpoint_name, custom_domain_name, custom_headers=None, raw=False, **operation_config)[source]

Deletes an existing custom domain within an endpoint.

Parameters:
  • resource_group_name (str) – Name of the Resource group within the Azure subscription.
  • profile_name (str) – Name of the CDN profile which is unique within the resource group.
  • endpoint_name (str) – Name of the endpoint under the profile which is unique globally.
  • custom_domain_name (str) – Name of the custom domain within an endpoint.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
Return type:

AzureOperationPoller instance that returns CustomDomain

Return type:

ClientRawResponse if raw=true

Raises:

ErrorResponseException

get(resource_group_name, profile_name, endpoint_name, custom_domain_name, custom_headers=None, raw=False, **operation_config)[source]

Gets an exisitng custom domain within an endpoint.

Parameters:
  • resource_group_name (str) – Name of the Resource group within the Azure subscription.
  • profile_name (str) – Name of the CDN profile which is unique within the resource group.
  • endpoint_name (str) – Name of the endpoint under the profile which is unique globally.
  • custom_domain_name (str) – Name of the custom domain within an endpoint.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

CustomDomain

Return type:

ClientRawResponse if raw=true

Raises:

ErrorResponseException

list_by_endpoint(resource_group_name, profile_name, endpoint_name, custom_headers=None, raw=False, **operation_config)[source]

Lists all of the existing custom domains within an endpoint.

Parameters:
  • resource_group_name (str) – Name of the Resource group within the Azure subscription.
  • profile_name (str) – Name of the CDN profile which is unique within the resource group.
  • endpoint_name (str) – Name of the endpoint under the profile which is unique globally.
  • custom_headers (dict) – headers that will be added to the request
  • raw (bool) – returns the direct response alongside the deserialized response
  • operation_configOperation configuration overrides.
Return type:

CustomDomainPaged

Raises:

ErrorResponseException

class azure.mgmt.cdn.operations.EdgeNodesOperations(client, config, serializer, deserializer)[source]

Bases: object

EdgeNodesOperations operations.

Parameters:
  • client – Client for service requests.
  • config – Configuration of service client.
  • serializer – An object model serializer.
  • deserializer – An objec model deserializer.
list(custom_headers=None, raw=False, **operation_config)[source]

Lists all the edge nodes of a CDN service.

Parameters:
Return type:

EdgenodeResult

Return type:

ClientRawResponse if raw=true

Raises:

ErrorResponseException