azure.mgmt.cdn.operations module¶
-
class
azure.mgmt.cdn.operations.ProfilesOperations(client, config, serializer, deserializer)[source]¶ Bases:
objectProfilesOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Current version is 2017-04-02. Constant value: “2020-04-15”.
-
create(resource_group_name, profile_name, profile, custom_headers=None, raw=False, polling=True, **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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns Profile or ClientRawResponse<Profile> if raw==True
- Return type
AzureOperationPoller[Profile] or AzureOperationPoller[ClientRawResponse[Profile]]
- Raises
-
delete(resource_group_name, profile_name, custom_headers=None, raw=False, polling=True, **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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
- Return type
AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
- Raises
-
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. Supplemental 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_config – Operation configuration overrides.
- Returns
SsoUri or ClientRawResponse if raw=true
- Return type
SsoUri or ClientRawResponse
- Raises
-
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_config – Operation configuration overrides.
- Returns
Profile or ClientRawResponse if raw=true
- Return type
Profile or ClientRawResponse
- Raises
-
list(custom_headers=None, raw=False, **operation_config)[source]¶ Lists all of the CDN profiles within an Azure subscription.
- Parameters
- Returns
An iterator like instance of Profile
- Return type
- Raises
-
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
- Returns
An iterator like instance of Profile
- Return type
- Raises
-
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_config – Operation configuration overrides.
- Returns
An iterator like instance of ResourceUsage
- Return type
- Raises
-
list_supported_optimization_types(resource_group_name, profile_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the supported optimization types for the current profile. A user can create an endpoint with an optimization type from the listed values.
- 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_config – Operation configuration overrides.
- Returns
SupportedOptimizationTypesListResult or ClientRawResponse if raw=true
- Return type
SupportedOptimizationTypesListResult or ClientRawResponse
- Raises
-
update(resource_group_name, profile_name, tags=None, custom_headers=None, raw=False, polling=True, **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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns Profile or ClientRawResponse<Profile> if raw==True
- Return type
AzureOperationPoller[Profile] or AzureOperationPoller[ClientRawResponse[Profile]]
- Raises
-
models= <module 'azure.mgmt.cdn.models' from '/home/vsts/work/1/s/sdk/cdn/azure-mgmt-cdn/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/cdn/models/__init__.py'>¶
-
class
azure.mgmt.cdn.operations.EndpointsOperations(client, config, serializer, deserializer)[source]¶ Bases:
objectEndpointsOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Current version is 2017-04-02. Constant value: “2020-04-15”.
-
create(resource_group_name, profile_name, endpoint_name, endpoint, custom_headers=None, raw=False, polling=True, **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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns Endpoint or ClientRawResponse<Endpoint> if raw==True
- Return type
AzureOperationPoller[Endpoint] or AzureOperationPoller[ClientRawResponse[Endpoint]]
- Raises
-
delete(resource_group_name, profile_name, endpoint_name, custom_headers=None, raw=False, polling=True, **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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
- Return type
AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
- Raises
-
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_config – Operation configuration overrides.
- Returns
Endpoint or ClientRawResponse if raw=true
- Return type
Endpoint or ClientRawResponse
- Raises
-
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_config – Operation configuration overrides.
- Returns
An iterator like instance of Endpoint
- Return type
- Raises
-
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_config – Operation configuration overrides.
- Returns
An iterator like instance of ResourceUsage
- Return type
- Raises
-
load_content(resource_group_name, profile_name, endpoint_name, content_paths, custom_headers=None, raw=False, polling=True, **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[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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
- Return type
AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
- Raises
-
purge_content(resource_group_name, profile_name, endpoint_name, content_paths, custom_headers=None, raw=False, polling=True, **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[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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
- Return type
AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
- Raises
-
start(resource_group_name, profile_name, endpoint_name, custom_headers=None, raw=False, polling=True, **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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns Endpoint or ClientRawResponse<Endpoint> if raw==True
- Return type
AzureOperationPoller[Endpoint] or AzureOperationPoller[ClientRawResponse[Endpoint]]
- Raises
-
stop(resource_group_name, profile_name, endpoint_name, custom_headers=None, raw=False, polling=True, **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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns Endpoint or ClientRawResponse<Endpoint> if raw==True
- Return type
AzureOperationPoller[Endpoint] or AzureOperationPoller[ClientRawResponse[Endpoint]]
- Raises
-
update(resource_group_name, profile_name, endpoint_name, endpoint_update_properties, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ 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.
- 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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns Endpoint or ClientRawResponse<Endpoint> if raw==True
- Return type
AzureOperationPoller[Endpoint] or AzureOperationPoller[ClientRawResponse[Endpoint]]
- Raises
-
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_config – Operation configuration overrides.
- Returns
ValidateCustomDomainOutput or ClientRawResponse if raw=true
- Return type
ValidateCustomDomainOutput or ClientRawResponse
- Raises
-
models= <module 'azure.mgmt.cdn.models' from '/home/vsts/work/1/s/sdk/cdn/azure-mgmt-cdn/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/cdn/models/__init__.py'>¶
-
class
azure.mgmt.cdn.operations.OriginsOperations(client, config, serializer, deserializer)[source]¶ Bases:
objectOriginsOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Current version is 2017-04-02. Constant value: “2020-04-15”.
-
create(resource_group_name, profile_name, endpoint_name, origin_name, origin, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Creates a new origin within the specified 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 that is unique within the endpoint.
origin (Origin) – Origin properties
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns Origin or ClientRawResponse<Origin> if raw==True
- Return type
AzureOperationPoller[Origin] or AzureOperationPoller[ClientRawResponse[Origin]]
- Raises
-
delete(resource_group_name, profile_name, endpoint_name, origin_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Deletes 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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
- Return type
AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
- Raises
-
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_config – Operation configuration overrides.
- Returns
Origin or ClientRawResponse if raw=true
- Return type
Origin or ClientRawResponse
- Raises
-
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_config – Operation configuration overrides.
- Returns
An iterator like instance of Origin
- Return type
- Raises
-
update(resource_group_name, profile_name, endpoint_name, origin_name, origin_update_properties, custom_headers=None, raw=False, polling=True, **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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns Origin or ClientRawResponse<Origin> if raw==True
- Return type
AzureOperationPoller[Origin] or AzureOperationPoller[ClientRawResponse[Origin]]
- Raises
-
models= <module 'azure.mgmt.cdn.models' from '/home/vsts/work/1/s/sdk/cdn/azure-mgmt-cdn/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/cdn/models/__init__.py'>¶
-
class
azure.mgmt.cdn.operations.OriginGroupsOperations(client, config, serializer, deserializer)[source]¶ Bases:
objectOriginGroupsOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Current version is 2017-04-02. Constant value: “2020-04-15”.
-
create(resource_group_name, profile_name, endpoint_name, origin_group_name, origin_group, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Creates a new origin group within the specified 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_group_name (str) – Name of the origin group which is unique within the endpoint.
origin_group (OriginGroup) – Origin group properties
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns OriginGroup or ClientRawResponse<OriginGroup> if raw==True
- Return type
AzureOperationPoller[OriginGroup] or AzureOperationPoller[ClientRawResponse[OriginGroup]]
- Raises
-
delete(resource_group_name, profile_name, endpoint_name, origin_group_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Deletes an existing origin group 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_group_name (str) – Name of the origin group which is unique within the endpoint.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
- Return type
AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
- Raises
-
get(resource_group_name, profile_name, endpoint_name, origin_group_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets an existing origin group 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_group_name (str) – Name of the origin group 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_config – Operation configuration overrides.
- Returns
OriginGroup or ClientRawResponse if raw=true
- Return type
OriginGroup or ClientRawResponse
- Raises
-
list_by_endpoint(resource_group_name, profile_name, endpoint_name, custom_headers=None, raw=False, **operation_config)[source]¶ Lists all of the existing origin groups 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_config – Operation configuration overrides.
- Returns
An iterator like instance of OriginGroup
- Return type
- Raises
-
update(resource_group_name, profile_name, endpoint_name, origin_group_name, origin_group_update_properties, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Updates an existing origin group 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_group_name (str) – Name of the origin group which is unique within the endpoint.
origin_group_update_properties (OriginGroupUpdateParameters) – Origin group properties
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns OriginGroup or ClientRawResponse<OriginGroup> if raw==True
- Return type
AzureOperationPoller[OriginGroup] or AzureOperationPoller[ClientRawResponse[OriginGroup]]
- Raises
-
models= <module 'azure.mgmt.cdn.models' from '/home/vsts/work/1/s/sdk/cdn/azure-mgmt-cdn/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/cdn/models/__init__.py'>¶
-
class
azure.mgmt.cdn.operations.CustomDomainsOperations(client, config, serializer, deserializer)[source]¶ Bases:
objectCustomDomainsOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Current version is 2017-04-02. Constant value: “2020-04-15”.
-
create(resource_group_name, profile_name, endpoint_name, custom_domain_name, host_name, custom_headers=None, raw=False, polling=True, **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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns CustomDomain or ClientRawResponse<CustomDomain> if raw==True
- Return type
AzureOperationPoller[CustomDomain] or AzureOperationPoller[ClientRawResponse[CustomDomain]]
- Raises
-
delete(resource_group_name, profile_name, endpoint_name, custom_domain_name, custom_headers=None, raw=False, polling=True, **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) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns CustomDomain or ClientRawResponse<CustomDomain> if raw==True
- Return type
AzureOperationPoller[CustomDomain] or AzureOperationPoller[ClientRawResponse[CustomDomain]]
- Raises
-
disable_custom_https(resource_group_name, profile_name, endpoint_name, custom_domain_name, custom_headers=None, raw=False, **operation_config)[source]¶ Disable https delivery of the custom domain.
- 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_config – Operation configuration overrides.
- Returns
CustomDomain or ClientRawResponse if raw=true
- Return type
CustomDomain or ClientRawResponse
- Raises
-
enable_custom_https(resource_group_name, profile_name, endpoint_name, custom_domain_name, custom_domain_https_parameters=None, custom_headers=None, raw=False, **operation_config)[source]¶ Enable https delivery of the custom domain.
- 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_domain_https_parameters (CustomDomainHttpsParameters) – The configuration specifying how to enable HTTPS for the custom domain - using CDN managed certificate or user’s own certificate. If not specified, enabling ssl uses CDN managed certificate by default.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
CustomDomain or ClientRawResponse if raw=true
- Return type
CustomDomain or ClientRawResponse
- Raises
-
get(resource_group_name, profile_name, endpoint_name, custom_domain_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets 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
operation_config – Operation configuration overrides.
- Returns
CustomDomain or ClientRawResponse if raw=true
- Return type
CustomDomain or ClientRawResponse
- Raises
-
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_config – Operation configuration overrides.
- Returns
An iterator like instance of CustomDomain
- Return type
- Raises
-
models= <module 'azure.mgmt.cdn.models' from '/home/vsts/work/1/s/sdk/cdn/azure-mgmt-cdn/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/cdn/models/__init__.py'>¶
-
class
azure.mgmt.cdn.operations.ResourceUsageOperations(client, config, serializer, deserializer)[source]¶ Bases:
objectResourceUsageOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Current version is 2017-04-02. Constant value: “2020-04-15”.
-
list(custom_headers=None, raw=False, **operation_config)[source]¶ Check the quota and actual usage of the CDN profiles under the given subscription.
- Parameters
- Returns
An iterator like instance of ResourceUsage
- Return type
- Raises
-
models= <module 'azure.mgmt.cdn.models' from '/home/vsts/work/1/s/sdk/cdn/azure-mgmt-cdn/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/cdn/models/__init__.py'>¶
-
class
azure.mgmt.cdn.operations.Operations(client, config, serializer, deserializer)[source]¶ Bases:
objectOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Current version is 2017-04-02. Constant value: “2020-04-15”.
-
list(custom_headers=None, raw=False, **operation_config)[source]¶ Lists all of the available CDN REST API operations.
- Parameters
- Returns
An iterator like instance of Operation
- Return type
- Raises
-
models= <module 'azure.mgmt.cdn.models' from '/home/vsts/work/1/s/sdk/cdn/azure-mgmt-cdn/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/cdn/models/__init__.py'>¶
-
class
azure.mgmt.cdn.operations.EdgeNodesOperations(client, config, serializer, deserializer)[source]¶ Bases:
objectEdgeNodesOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Current version is 2017-04-02. Constant value: “2020-04-15”.
-
list(custom_headers=None, raw=False, **operation_config)[source]¶ Edgenodes are the global Point of Presence (POP) locations used to deliver CDN content to end users.
- Parameters
- Returns
An iterator like instance of EdgeNode
- Return type
- Raises
-
models= <module 'azure.mgmt.cdn.models' from '/home/vsts/work/1/s/sdk/cdn/azure-mgmt-cdn/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/cdn/models/__init__.py'>¶
-
class
azure.mgmt.cdn.operations.PoliciesOperations(client, config, serializer, deserializer)[source]¶ Bases:
objectPoliciesOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Current version is 2017-04-02. Constant value: “2020-04-15”.
-
create_or_update(resource_group_name, policy_name, cdn_web_application_firewall_policy, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Create or update policy with specified rule set name within a resource group.
- Parameters
resource_group_name (str) – Name of the Resource group within the Azure subscription.
policy_name (str) – The name of the CdnWebApplicationFirewallPolicy.
cdn_web_application_firewall_policy (CdnWebApplicationFirewallPolicy) – Policy to be created.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns CdnWebApplicationFirewallPolicy or ClientRawResponse<CdnWebApplicationFirewallPolicy> if raw==True
- Return type
AzureOperationPoller[CdnWebApplicationFirewallPolicy] or AzureOperationPoller[ClientRawResponse[CdnWebApplicationFirewallPolicy]]
- Raises
-
delete(resource_group_name, policy_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Deletes Policy.
- Parameters
resource_group_name (str) – Name of the Resource group within the Azure subscription.
policy_name (str) – The name of the CdnWebApplicationFirewallPolicy.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
- Return type
AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
- Raises
CloudError
-
get(resource_group_name, policy_name, custom_headers=None, raw=False, **operation_config)[source]¶ Retrieve protection policy with specified name within a resource group.
- Parameters
resource_group_name (str) – Name of the Resource group within the Azure subscription.
policy_name (str) – The name of the CdnWebApplicationFirewallPolicy.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
CdnWebApplicationFirewallPolicy or ClientRawResponse if raw=true
- Return type
CdnWebApplicationFirewallPolicy or ClientRawResponse
- Raises
-
list(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶ Lists all of the protection policies within a resource group.
- Parameters
- Returns
An iterator like instance of CdnWebApplicationFirewallPolicy
- Return type
CdnWebApplicationFirewallPolicyPaged[CdnWebApplicationFirewallPolicy]
- Raises
-
update(resource_group_name, policy_name, tags=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Update an existing CdnWebApplicationFirewallPolicy with the specified policy name under the specified subscription and resource group.
- Parameters
resource_group_name (str) – Name of the Resource group within the Azure subscription.
policy_name (str) – The name of the CdnWebApplicationFirewallPolicy.
tags (dict[str, str]) – CdnWebApplicationFirewallPolicy tags
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns CdnWebApplicationFirewallPolicy or ClientRawResponse<CdnWebApplicationFirewallPolicy> if raw==True
- Return type
AzureOperationPoller[CdnWebApplicationFirewallPolicy] or AzureOperationPoller[ClientRawResponse[CdnWebApplicationFirewallPolicy]]
- Raises
-
models= <module 'azure.mgmt.cdn.models' from '/home/vsts/work/1/s/sdk/cdn/azure-mgmt-cdn/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/cdn/models/__init__.py'>¶
-
class
azure.mgmt.cdn.operations.ManagedRuleSetsOperations(client, config, serializer, deserializer)[source]¶ Bases:
objectManagedRuleSetsOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Current version is 2017-04-02. Constant value: “2020-04-15”.
-
list(custom_headers=None, raw=False, **operation_config)[source]¶ Lists all available managed rule sets.
- Parameters
- Returns
An iterator like instance of ManagedRuleSetDefinition
- Return type
- Raises
-
models= <module 'azure.mgmt.cdn.models' from '/home/vsts/work/1/s/sdk/cdn/azure-mgmt-cdn/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/cdn/models/__init__.py'>¶
-
class
azure.mgmt.cdn.operations.CdnManagementClientOperationsMixin[source]¶ Bases:
object-
check_name_availability(name, custom_headers=None, raw=False, **operation_config)[source]¶ Check the availability of a resource name. This is needed for resources where name is globally unique, such as a CDN endpoint.
- Parameters
- Returns
CheckNameAvailabilityOutput or ClientRawResponse if raw=true
- Return type
CheckNameAvailabilityOutput or ClientRawResponse
- Raises
-
check_name_availability_with_subscription(name, custom_headers=None, raw=False, **operation_config)[source]¶ Check the availability of a resource name. This is needed for resources where name is globally unique, such as a CDN endpoint.
- Parameters
- Returns
CheckNameAvailabilityOutput or ClientRawResponse if raw=true
- Return type
CheckNameAvailabilityOutput or ClientRawResponse
- Raises
-
validate_probe(probe_url, custom_headers=None, raw=False, **operation_config)[source]¶ Check if the probe path is a valid path and the file can be accessed. Probe path is the path to a file hosted on the origin server to help accelerate the delivery of dynamic content via the CDN endpoint. This path is relative to the origin path specified in the endpoint configuration.
- Parameters
- Returns
ValidateProbeOutput or ClientRawResponse if raw=true
- Return type
ValidateProbeOutput or ClientRawResponse
- Raises
-