Package: azure-mgmt-cdn
Microsoft Azure SDK for PythonThis is the Microsoft Azure CDN Management Client Library.
This package has been tested with Python 3.7+.
For a more complete view of Azure libraries, see theazure sdk python release.DisclaimerAzure SDK Python packages support for Python 2.7 has ended 01 January 2022. For more information and questions, please refer tohttps://github.com/Azure/azure-sdk-for-python/issues/20691Getting startedPrerequisitesPython 3.7+ is required to use this package.Azure subscriptionInstall the packagepipinstallazure-mgmt-cdn
pipinstallazure-identityAuthenticationBy default,Azure Active Directorytoken authentication depends on correct configure of following environment variables.AZURE_CLIENT_IDfor Azure client ID.AZURE_TENANT_IDfor Azure tenant ID.AZURE_CLIENT_SECRETfor Azure client secret.In addition, Azure subscription ID can be configured via environment variableAZURE_SUBSCRIPTION_ID.With above configuration, client can be authenticated by following code:fromazure.identityimportDefaultAzureCredentialfromazure.mgmt.cdnimportCdnManagementClientimportossub_id=os.getenv("AZURE_SUBSCRIPTION_ID")client=CdnManagementClient(credential=DefaultAzureCredential(),subscription_id=sub_id)ExamplesCode samples for this package can be found at:Search CDN Managementon docs.microsoft.comAzure Python Mgmt SDK Samples RepoTroubleshootingNext stepsProvide FeedbackIf you encounter any bugs or have suggestions, please file an issue in theIssuessection of the project.Release History13.0.0 (2023-10-23)Features AddedAdded operation AFDProfilesOperations.begin_upgradeAdded operation AFDProfilesOperations.check_endpoint_name_availabilityAdded operation AFDProfilesOperations.validate_secretAdded operation ProfilesOperations.begin_can_migrateAdded operation ProfilesOperations.begin_migrateAdded operation ProfilesOperations.begin_migration_commitModel AFDDomain has a new parameter extended_propertiesModel AFDDomainProperties has a new parameter extended_propertiesModel AzureFirstPartyManagedCertificateParameters has a new parameter certificate_authorityModel AzureFirstPartyManagedCertificateParameters has a new parameter expiration_dateModel AzureFirstPartyManagedCertificateParameters has a new parameter secret_sourceModel AzureFirstPartyManagedCertificateParameters has a new parameter subjectModel AzureFirstPartyManagedCertificateParameters has a new parameter subject_alternative_namesModel AzureFirstPartyManagedCertificateParameters has a new parameter thumbprintModel CdnWebApplicationFirewallPolicy has a new parameter extended_propertiesModel Profile has a new parameter extended_propertiesModel Profile has a new parameter identityModel ProfileUpdateParameters has a new parameter identityBreaking ChangesRemoved operation group ValidateOperationsRenamed operation CustomDomainsOperations.disable_custom_https to CustomDomainsOperations.begin_disable_custom_httpsRenamed operation CustomDomainsOperations.enable_custom_https to CustomDomainsOperations.begin_enable_custom_https12.1.0b1 (2022-10-21)Breaking ChangesRenamed operation CustomDomainsOperations.disable_custom_https to CustomDomainsOperations.begin_disable_custom_httpsRenamed operation CustomDomainsOperations.enable_custom_https to CustomDomainsOperations.begin_enable_custom_https12.0.0 (2022-03-22)FeaturesAdded operation CdnManagementClientOperationsMixin.check_endpoint_name_availabilityAdded operation RuleSetsOperations.createModel AFDDomain has a new parameter pre_validated_custom_domain_resource_idModel AFDDomain has a new parameter profile_nameModel AFDDomainProperties has a new parameter pre_validated_custom_domain_resource_idModel AFDDomainProperties has a new parameter profile_nameModel AFDDomainUpdateParameters has a new parameter pre_validated_custom_domain_resource_idModel AFDDomainUpdateParameters has a new parameter profile_nameModel AFDDomainUpdatePropertiesParameters has a new parameter pre_validated_custom_domain_resource_idModel AFDDomainUpdatePropertiesParameters has a new parameter profile_nameModel AFDEndpoint has a new parameter auto_generated_domain_name_label_scopeModel AFDEndpoint has a new parameter profile_nameModel AFDEndpointProperties has a new parameter auto_generated_domain_name_label_scopeModel AFDEndpointProperties has a new parameter profile_nameModel AFDEndpointPropertiesUpdateParameters has a new parameter profile_nameModel AFDEndpointUpdateParameters has a new parameter profile_nameModel AFDOrigin has a new parameter enforce_certificate_name_checkModel AFDOrigin has a new parameter origin_group_nameModel AFDOriginGroup has a new parameter profile_nameModel AFDOriginGroupProperties has a new parameter profile_nameModel AFDOriginGroupUpdateParameters has a new parameter profile_nameModel AFDOriginGroupUpdatePropertiesParameters has a new parameter profile_nameModel AFDOriginProperties has a new parameter enforce_certificate_name_checkModel AFDOriginProperties has a new parameter origin_group_nameModel AFDOriginUpdateParameters has a new parameter enforce_certificate_name_checkModel AFDOriginUpdateParameters has a new parameter origin_group_nameModel AFDOriginUpdatePropertiesParameters has a new parameter enforce_certificate_name_checkModel AFDOriginUpdatePropertiesParameters has a new parameter origin_group_nameModel Certificate has a new parameter typeModel CustomDomain has a new parameter custom_https_parametersModel CustomerCertificate has a new parameter secret_sourceModel CustomerCertificate has a new parameter secret_versionModel CustomerCertificate has a new parameter typeModel CustomerCertificateParameters has a new parameter expiration_dateModel CustomerCertificateParameters has a new parameter subjectModel CustomerCertificateParameters has a new parameter thumbprintModel DeepCreatedOrigin has a new parameter private_endpoint_statusModel Endpoint has a new parameter custom_domainsModel EndpointProperties has a new parameter custom_domainsModel ErrorResponse has a new parameter errorModel HttpVersionMatchConditionParameters has a new parameter transformsModel ManagedCertificate has a new parameter typeModel ManagedCertificateParameters has a new parameter expiration_dateModel ManagedCertificateParameters has a new parameter subjectModel Operation has a new parameter is_data_actionModel Operation has a new parameter originModel Operation has a new parameter service_specificationModel OperationDisplay has a new parameter descriptionModel Profile has a new parameter front_door_idModel Profile has a new parameter kindModel Profile has a new parameter origin_response_timeout_secondsModel ProfileUpdateParameters has a new parameter origin_response_timeout_secondsModel RequestMethodMatchConditionParameters has a new parameter transformsModel RequestSchemeMatchConditionParameters has a new parameter transformsModel Route has a new parameter cache_configurationModel Route has a new parameter endpoint_nameModel RouteProperties has a new parameter cache_configurationModel RouteProperties has a new parameter endpoint_nameModel RouteUpdateParameters has a new parameter cache_configurationModel RouteUpdateParameters has a new parameter endpoint_nameModel RouteUpdatePropertiesParameters has a new parameter cache_configurationModel RouteUpdatePropertiesParameters has a new parameter endpoint_nameModel Rule has a new parameter rule_set_nameModel RuleProperties has a new parameter rule_set_nameModel RuleSet has a new parameter profile_nameModel RuleSetProperties has a new parameter profile_nameModel RuleUpdateParameters has a new parameter rule_set_nameModel RuleUpdatePropertiesParameters has a new parameter rule_set_nameModel Secret has a new parameter profile_nameModel SecretProperties has a new parameter profile_nameModel SecurityPolicy has a new parameter profile_nameModel SecurityPolicyProperties has a new parameter profile_nameModel ValidateSecretInput has a new parameter secret_versionBreaking changesModel AFDEndpoint no longer has parameter origin_response_timeout_secondsModel AFDEndpointProperties no longer has parameter origin_response_timeout_secondsModel AFDEndpointPropertiesUpdateParameters no longer has parameter origin_response_timeout_secondsModel AFDEndpointUpdateParameters no longer has parameter origin_response_timeout_secondsModel AFDOriginGroup no longer has parameter response_based_afd_origin_error_detection_settingsModel AFDOriginGroupProperties no longer has parameter response_based_afd_origin_error_detection_settingsModel AFDOriginGroupUpdateParameters no longer has parameter response_based_afd_origin_error_detection_settingsModel AFDOriginGroupUpdatePropertiesParameters no longer has parameter response_based_afd_origin_error_detection_settingsModel CacheExpirationActionParameters has a new required parameter type_nameModel CacheExpirationActionParameters no longer has parameter odata_typeModel CacheKeyQueryStringActionParameters has a new required parameter type_nameModel CacheKeyQueryStringActionParameters no longer has parameter odata_typeModel CdnCertificateSourceParameters has a new required parameter type_nameModel CdnCertificateSourceParameters no longer has parameter odata_typeModel Certificate no longer has parameter thumbprintModel CookiesMatchConditionParameters has a new required parameter type_nameModel CookiesMatchConditionParameters no longer has parameter odata_typeModel CustomerCertificate no longer has parameter certificate_urlModel CustomerCertificate no longer has parameter versionModel ErrorResponse no longer has parameter codeModel ErrorResponse no longer has parameter messageModel HeaderActionParameters has a new required parameter type_nameModel HeaderActionParameters no longer has parameter odata_typeModel HttpVersionMatchConditionParameters has a new required parameter type_nameModel HttpVersionMatchConditionParameters no longer has parameter odata_typeModel IsDeviceMatchConditionParameters has a new required parameter type_nameModel IsDeviceMatchConditionParameters no longer has parameter odata_typeModel KeyVaultCertificateSourceParameters has a new required parameter type_nameModel KeyVaultCertificateSourceParameters no longer has parameter odata_typeModel KeyVaultSigningKeyParameters has a new required parameter type_nameModel KeyVaultSigningKeyParameters no longer has parameter odata_typeModel ManagedCertificate no longer has parameter thumbprintModel OriginGroupOverrideActionParameters has a new required parameter type_nameModel OriginGroupOverrideActionParameters no longer has parameter odata_typeModel PostArgsMatchConditionParameters has a new required parameter type_nameModel PostArgsMatchConditionParameters no longer has parameter odata_typeModel Profile no longer has parameter frontdoor_idModel QueryStringMatchConditionParameters has a new required parameter type_nameModel QueryStringMatchConditionParameters no longer has parameter odata_typeModel RemoteAddressMatchConditionParameters has a new required parameter type_nameModel RemoteAddressMatchConditionParameters no longer has parameter odata_typeModel RequestBodyMatchConditionParameters has a new required parameter type_nameModel RequestBodyMatchConditionParameters no longer has parameter odata_typeModel RequestHeaderMatchConditionParameters has a new required parameter type_nameModel RequestHeaderMatchConditionParameters no longer has parameter odata_typeModel RequestMethodMatchConditionParameters has a new required parameter type_nameModel RequestMethodMatchConditionParameters no longer has parameter odata_typeModel RequestSchemeMatchConditionParameters has a new required parameter type_nameModel RequestSchemeMatchConditionParameters no longer has parameter odata_typeModel RequestUriMatchConditionParameters has a new required parameter type_nameModel RequestUriMatchConditionParameters no longer has parameter odata_typeModel Route no longer has parameter compression_settingsModel Route no longer has parameter query_string_caching_behaviorModel RouteProperties no longer has parameter compression_settingsModel RouteProperties no longer has parameter query_string_caching_behaviorModel RouteUpdateParameters no longer has parameter compression_settingsModel RouteUpdateParameters no longer has parameter query_string_caching_behaviorModel RouteUpdatePropertiesParameters no longer has parameter compression_settingsModel RouteUpdatePropertiesParameters no longer has parameter query_string_caching_behaviorModel UrlFileExtensionMatchConditionParameters has a new required parameter type_nameModel UrlFileExtensionMatchConditionParameters no longer has parameter odata_typeModel UrlFileNameMatchConditionParameters has a new required parameter type_nameModel UrlFileNameMatchConditionParameters no longer has parameter odata_typeModel UrlPathMatchConditionParameters has a new required parameter type_nameModel UrlPathMatchConditionParameters no longer has parameter odata_typeModel UrlRedirectActionParameters has a new required parameter type_nameModel UrlRedirectActionParameters no longer has parameter odata_typeModel UrlRewriteActionParameters has a new required parameter type_nameModel UrlRewriteActionParameters no longer has parameter odata_typeModel UrlSigningActionParameters has a new required parameter type_nameModel UrlSigningActionParameters no longer has parameter odata_typeOperation SecurityPoliciesOperations.begin_patch has a new signatureRemoved operation RuleSetsOperations.begin_createRemoved operation SecretsOperations.begin_update11.0.0 (2021-03-29)FeaturesModel ManagedRuleSetDefinition has a new parameter system_dataModel Resource has a new parameter system_dataBreaking changesOperation SecurityPoliciesOperations.begin_patch has a new signatureOperation RuleSetsOperations.begin_create has a new signatureModel RouteUpdatePropertiesParameters no longer has parameter optimization_typeModel CustomerCertificateParameters no longer has parameter thumbprintModel CustomerCertificateParameters no longer has parameter subjectModel CustomerCertificateParameters no longer has parameter expiration_dateModel RouteProperties no longer has parameter optimization_typeModel Route no longer has parameter optimization_typeModel RouteUpdateParameters no longer has parameter optimization_typeOperation LogAnalyticsOperations.get_log_analytics_metrics has a new signatureModel ManagedCertificateParameters has a new signature10.0.0 (2021-01-19)FeaturesModel ProxyResource has a new parameter system_dataModel OriginGroup has a new parameter system_dataModel Endpoint has a new parameter system_dataModel EdgeNode has a new parameter system_dataModel Origin has a new parameter system_dataModel TrackedResource has a new parameter system_dataModel Profile has a new parameter system_dataModel Profile has a new parameter frontdoor_idModel CdnWebApplicationFirewallPolicy has a new parameter system_dataModel CustomDomain has a new parameter system_dataAdded operation group AFDOriginsOperationsAdded operation group AFDProfilesOperationsAdded operation group AFDEndpointsOperationsAdded operation group RoutesOperationsAdded operation group LogAnalyticsOperationsAdded operation group RulesOperationsAdded operation group ValidateOperationsAdded operation group AFDOriginGroupsOperationsAdded operation group SecretsOperationsAdded operation group SecurityPoliciesOperationsAdded operation group AFDCustomDomainsOperationsAdded operation group RuleSetsOperationsBreaking changesParameter odata_type of model UrlSigningActionParameters is now requiredOperation PoliciesOperations.begin_update has a new signatureOperation EndpointsOperations.validate_custom_domain has a new signatureOperation EndpointsOperations.begin_load_content has a new signatureOperation EndpointsOperations.begin_purge_content has a new signatureOperation ProfilesOperations.begin_update has a new signatureOperation CdnManagementClientOperationsMixin.check_name_availability has a new signatureOperation CdnManagementClientOperationsMixin.check_name_availability_with_subscription has a new signatureOperation CdnManagementClientOperationsMixin.validate_probe has a new signatureOperation CustomDomainsOperations.begin_create has a new signatureModel UrlSigningActionParameters no longer has parameter ip_subnetsModel UrlSigningActionParameters no longer has parameter key_id10.0.0b1 (2020-10-31)This is beta preview version.
For detailed changelog please refer to equivalent stable version 5.1.0 (https://pypi.org/project/azure-mgmt-cdn/5.1.0/)This version uses a next-generation code generator that introduces important breaking changes, but also important new features (like unified authentication and async programming).General breaking changesCredential system has been completly revamped:azure.common.credentialsormsrestazure.azure_active_directoryinstances are no longer supported, use theazure-identityclasses instead:https://pypi.org/project/azure-identity/credentialsparameter has been renamedcredentialTheconfigattribute no longer exists on a client, configuration should be passed as kwarg. Example:MyClient(credential, subscription_id, enable_logging=True). For a complete set of
supported options, see theparameters accept in init documentation of azure-coreYou can't import aversionmodule anymore, use__version__insteadOperations that used to return amsrest.polling.LROPollernow returns aazure.core.polling.LROPollerand are prefixed withbegin_.Exceptions tree have been simplified and most exceptions are nowazure.core.exceptions.HttpResponseError(CloudErrorhas been removed).Most of the operation kwarg have changed. Some of the most noticeable:rawhas been removed. Equivalent feature can be found usingcls, a callback that will give access to internal HTTP response for advanced userFor a complete set of supported options, see theparameters accept in Request documentation of azure-coreGeneral new featuresType annotations support usingtyping. SDKs are mypy ready.This client has now stable and official support for async. Check theaionamespace of your package to find the async client.This client now support natively tracing library like OpenCensus or OpenTelemetry. See thistracing quickstartfor an overview.5.1.0 (2020-08-10)FeaturesAdd UrlSigningAction5.0.0 (2020-07-21)FeaturesModel Origin has a new parameter private_link_approval_messageModel Origin has a new parameter enabledModel Origin has a new parameter weightModel Origin has a new parameter origin_host_headerModel Origin has a new parameter private_link_resource_idModel Origin has a new parameter private_link_locationModel Origin has a new parameter private_link_aliasModel Origin has a new parameter priorityModel Origin has a new parameter private_endpoint_statusModel EndpointUpdateParameters has a new parameter url_signing_keysModel EndpointUpdateParameters has a new parameter default_origin_groupModel Endpoint has a new parameter url_signing_keysModel Endpoint has a new parameter origin_groupsModel Endpoint has a new parameter default_origin_groupAdded operation OriginsOperations.createAdded operation OriginsOperations.deleteAdded operation group OriginGroupsOperationsBreaking changesModel Origin no longer has parameter locationModel Origin no longer has parameter tagsModel CustomDomain no longer has parameter custom_https_parametersModel DeepCreatedOrigin has a new signatureModel OriginUpdateParameters has a new signature4.1.0rc1 (2020-01-18)FeaturesModel Endpoint has a new parameter
web_application_firewall_policy_linkModel EndpointUpdateParameters has a new parameter
web_application_firewall_policy_linkAdded operation group PoliciesOperationsAdded operation group ManagedRuleSetsOperations4.0.0 (2019-11-25)FeaturesModel DeliveryRule has a new parameter nameModel CdnManagedHttpsParameters has a new parameter
minimum_tls_versionModel UserManagedHttpsParameters has a new parameter
minimum_tls_versionModel CustomDomainHttpsParameters has a new parameter
minimum_tls_versionModel CustomDomain has a new parameter custom_https_parametersAdded operation group CdnManagementClientOperationsMixinGeneral Breaking ChangesThis version uses a next-generation code generator thatmightintroduce breaking changes. In summary, some modules were incorrectly
visible/importable and have been renamed. This fixed several issues
caused by usage of classes that were not supposed to be used in the
first place.CdnManagementClient cannot be imported fromazure.mgmt.cdn.cdn_management_clientanymore (import fromazure.mgmt.cdnworks like before)CdnManagementClientConfiguration import has been moved fromazure.mgmt.cdn.cdn_management_clienttoazure.mgmt.cdnA modelMyClassfrom a "models" sub-module cannot be imported
anymore usingazure.mgmt.cdn.models.my_class(import fromazure.mgmt.cdn.modelsworks like before)An operation classMyClassOperationsfrom anoperationssub-module cannot be imported anymore usingazure.mgmt.cdn.operations.my_class_operations(import fromazure.mgmt.cdn.operationsworks like before)Last but not least, HTTP connection pooling is now enabled by default.
You should always use a client as a context manager, or call close(), or
use no more than one client per process.3.1.0 (2019-03-05)FeaturesAdd custom_domain_https_parameters support3.0.0 (2018-05-25)FeaturesAdd client method check_name_availability_with_subscriptionModel EndpointUpdateParameters has a new parameter delivery_policyModel Endpoint has a new parameter delivery_policyClient class can be used as a context manager to keep the underlying
HTTP session open for performanceGeneral Breaking changesThis version uses a next-generation code generator thatmightintroduce breaking changes.Model signatures now use only keyword-argument syntax. All
positional arguments must be re-written as keyword-arguments. To
keep auto-completion in most cases, models are now generated for
Python 2 and Python 3. Python 3 uses the "*" syntax for
keyword-only arguments.Enum types now use the "str" mixin (class AzureEnum(str, Enum)) to
improve the behavior when unrecognized enum values are encountered.
While this is not a breaking change, the distinctions are important,
and are documented here:https://docs.python.org/3/library/enum.html#othersAt a glance:"is" should not be used at all."format" will return the string value, where "%s" string
formatting will returnNameOfEnum.stringvalue. Format syntax
should be prefered.New Long Running Operation:Return type changes frommsrestazure.azure_operation.AzureOperationPollertomsrest.polling.LROPoller. External API is the same.Return type is nowalwaysamsrest.polling.LROPoller,
regardless of the optional parameters used.The behavior has changed when usingraw=True. Instead of
returning the initial call result asClientRawResponse,
without polling, now this returns an LROPoller. After polling,
the final resource will be returned as aClientRawResponse.Newpollingparameter. The default behavior isPolling=Truewhich will poll using ARM algorithm. WhenPolling=False, the response of the initial call will be
returned without polling.pollingparameter accepts instances of subclasses ofmsrest.polling.PollingMethod.add_done_callbackwill no longer raise if called after
polling is finished, but will instead execute the callback right
away.BugfixesCompatibility of the sdist with wheel 0.31.02.0.0 (2017-10-26)FeaturesAdd probe operations and in some modelsAdd list_supported_optimization_typesBreaking changesmove resource_usage into its own operation groupmove operations list into its own operation groupApi version changed from 2016-10-02 to 2017-04-021.0.0 (2017-06-30)FeaturesAdd disable_custom_https and enable_custom_httpsBreaking changesRename check_resource_usage to list_resource_usagelist EdgeNode now returns an iterator of EdgeNode, not a
EdgenodeResult instance with an attribute "value" being a list of
EdgeNode0.30.3 (2017-05-15)This wheel package is now built with the azure wheel extension0.30.2 (2016-12-22)Fix EdgeNode attributes content0.30.1 (2016-12-15)Fix list EdgeNodes method return type0.30.0 (2016-12-14)Initial preview release (API Version 2016-10-02)Major breaking changes from 0.30.0rc60.30.0rc6 (2016-09-02)Initial alpha release (API Version 2016-04-02)