Microsoft Azure SDK for Python

这是Microsoft Azure CDN管理客户端库。此包已在Python 3.8+上进行了测试。要查看Azure库的完整视图，请参阅azure sdk python发布。

免责声明

Azure SDK Python 2.7支持已于2022年1月1日结束。有关更多信息问题，请参阅https://github.com/Azure/azure-sdk-for-python/issues/20691

入门

先决条件

• 使用此包需要Python 3.8及以上版本。
• Azure订阅

安装包

pip install azure-mgmt-cdn
pip install azure-identity

身份验证

默认情况下，Azure Active Directory令牌身份验证依赖于以下环境变量的正确配置。

• AZURE_CLIENT_ID用于Azure客户端ID。
• AZURE_TENANT_ID用于Azure租户ID。
• AZURE_CLIENT_SECRET用于Azure客户端密钥。

此外，可以通过环境变量AZURE_SUBSCRIPTION_ID配置Azure订阅ID。

以上配置后，客户端可以通过以下代码进行身份验证

from azure.identity import DefaultAzureCredential
from azure.mgmt.cdn import CdnManagementClient
import os

sub_id = os.getenv("AZURE_SUBSCRIPTION_ID")
client = CdnManagementClient(credential=DefaultAzureCredential(), subscription_id=sub_id)

示例

此包的代码示例可以在以下位置找到

• 在docs.microsoft.com上搜索CDN管理
• Azure Python Mgmt SDK 示例存储库

故障排除

下一步

提供反馈

如果您遇到任何错误或有任何建议，请在项目的问题部分提交问题。

发布历史

13.1.1 (2024-06-12)

已修复的错误

• 修复在设置具有azure.core.serialization.NULL的模型属性时的序列化错误

13.1.0 (2024-04-15)

添加的功能

• 模型配置文件有一个新的参数log_scrubbing
• Model ProfileUpdateParameters有一个新的参数log_scrubbing

13.0.0 (2023-10-23)

添加的功能

• 添加了操作AFDProfilesOperations.begin_upgrade
• 添加了操作AFDProfilesOperations.check_endpoint_name_availability
• 添加了操作AFDProfilesOperations.validate_secret
• 添加了操作ProfilesOperations.begin_can_migrate
• 添加了操作ProfilesOperations.begin_migrate
• 添加了操作ProfilesOperations.begin_migration_commit
• 模型AFDDomain有一个新的参数extended_properties
• 模型AFDDomainProperties有一个新的参数extended_properties
• 模型AzureFirstPartyManagedCertificateParameters有一个新的参数certificate_authority
• 模型AzureFirstPartyManagedCertificateParameters有一个新的参数expiration_date
• 模型AzureFirstPartyManagedCertificateParameters有一个新的参数secret_source
• 模型AzureFirstPartyManagedCertificateParameters有一个新的参数subject
• 模型AzureFirstPartyManagedCertificateParameters有一个新的参数subject_alternative_names
• 模型AzureFirstPartyManagedCertificateParameters有一个新的参数thumbprint
• 模型CdnWebApplicationFirewallPolicy有一个新的参数extended_properties
• 模型Profile有一个新的参数extended_properties
• 模型Profile有一个新的参数identity
• 模型ProfileUpdateParameters有一个新的参数identity

重大变更

• 移除了操作组ValidateOperations
• 将操作CustomDomainsOperations.disable_custom_https重命名为CustomDomainsOperations.begin_disable_custom_https
• 将操作CustomDomainsOperations.enable_custom_https重命名为CustomDomainsOperations.begin_enable_custom_https

12.1.0b1 (2022-10-21)

重大变更

• 将操作CustomDomainsOperations.disable_custom_https重命名为CustomDomainsOperations.begin_disable_custom_https
• 将操作CustomDomainsOperations.enable_custom_https重命名为CustomDomainsOperations.begin_enable_custom_https

12.0.0 (2022-03-22)

功能

• 添加了操作CdnManagementClientOperationsMixin.check_endpoint_name_availability
• 添加了操作RuleSetsOperations.create
• 模型AFDDomain有一个新的参数pre_validated_custom_domain_resource_id
• 模型AFDDomain有一个新的参数profile_name
• 模型AFDDomainProperties有一个新的参数pre_validated_custom_domain_resource_id
• 模型AFDDomainProperties有一个新的参数profile_name
• 模型AFDDomainUpdateParameters有一个新的参数pre_validated_custom_domain_resource_id
• 模型AFDDomainUpdateParameters有一个新的参数profile_name
• 模型AFDDomainUpdatePropertiesParameters有一个新的参数pre_validated_custom_domain_resource_id
• 模型AFDDomainUpdatePropertiesParameters有一个新的参数profile_name
• 模型AFDEndpoint有一个新的参数auto_generated_domain_name_label_scope
• 模型AFDEndpoint有一个新的参数profile_name
• 模型AFDEndpointProperties有一个新的参数auto_generated_domain_name_label_scope
• 模型AFDEndpointProperties有一个新的参数profile_name
• 模型AFDEndpointPropertiesUpdateParameters有一个新的参数profile_name
• 模型AFDEndpointUpdateParameters有一个新的参数profile_name
• 模型AFDOrigin有一个新的参数enforce_certificate_name_check
• 模型AFDOrigin有一个新的参数origin_group_name
• 模型AFDOriginGroup有一个新的参数profile_name
• 模型AFDOriginGroupProperties有一个新的参数profile_name
• 模型AFDOriginGroupUpdateParameters有一个新的参数profile_name
• 模型AFDOriginGroupUpdatePropertiesParameters新增参数profile_name
• 模型AFDOriginProperties新增参数enforce_certificate_name_check
• 模型AFDOriginProperties新增参数origin_group_name
• 模型AFDOriginUpdateParameters新增参数enforce_certificate_name_check
• 模型AFDOriginUpdateParameters新增参数origin_group_name
• 模型AFDOriginUpdatePropertiesParameters新增参数enforce_certificate_name_check
• 模型AFDOriginUpdatePropertiesParameters新增参数origin_group_name
• 模型Certificate新增参数type
• 模型CustomDomain新增参数custom_https_parameters
• 模型CustomerCertificate新增参数secret_source
• 模型CustomerCertificate新增参数secret_version
• 模型CustomerCertificate新增参数type
• 模型CustomerCertificateParameters新增参数expiration_date
• 模型CustomerCertificateParameters新增参数subject
• 模型CustomerCertificateParameters新增参数thumbprint
• 模型DeepCreatedOrigin新增参数private_endpoint_status
• 模型Endpoint新增参数custom_domains
• 模型EndpointProperties新增参数custom_domains
• 模型ErrorResponse新增参数error
• 模型HttpVersionMatchConditionParameters新增参数transforms
• 模型ManagedCertificate新增参数type
• 模型ManagedCertificateParameters新增参数expiration_date
• 模型ManagedCertificateParameters新增参数subject
• 模型Operation新增参数is_data_action
• 模型Operation新增参数origin
• 模型Operation新增参数service_specification
• 模型OperationDisplay新增参数description
• 模型Profile新增参数front_door_id
• 模型Profile新增参数kind
• 模型Profile新增参数origin_response_timeout_seconds
• 模型ProfileUpdateParameters新增参数origin_response_timeout_seconds
• 模型RequestMethodMatchConditionParameters新增参数transforms
• 模型RequestSchemeMatchConditionParameters新增参数transforms
• 模型Route新增参数cache_configuration
• 模型Route新增参数endpoint_name
• 模型RouteProperties新增参数cache_configuration
• 模型RouteProperties新增参数endpoint_name
• 模型RouteUpdateParameters新增参数cache_configuration
• 模型RouteUpdateParameters新增参数endpoint_name
• 模型RouteUpdatePropertiesParameters新增参数cache_configuration
• 模型RouteUpdatePropertiesParameters新增参数endpoint_name
• 模型Rule新增参数rule_set_name
• 模型RuleProperties新增参数rule_set_name
• 模型RuleSet新增参数profile_name
• 模型RuleSetProperties新增参数profile_name
• 模型RuleUpdateParameters新增参数rule_set_name
• 模型RuleUpdatePropertiesParameters新增参数rule_set_name
• 模型Secret新增参数profile_name
• 模型SecretProperties新增参数profile_name
• 模型SecurityPolicy新增参数profile_name
• 模型SecurityPolicyProperties新增参数profile_name
• 模型ValidateSecretInput新增参数secret_version

破坏性更改

• 模型AFDEndpoint不再具有参数origin_response_timeout_seconds
• 模型AFDEndpointProperties不再具有参数origin_response_timeout_seconds
• 模型AFDEndpointPropertiesUpdateParameters不再具有参数origin_response_timeout_seconds
• 模型AFDEndpointUpdateParameters不再具有参数origin_response_timeout_seconds
• 模型AFDOriginGroup不再具有参数response_based_afd_origin_error_detection_settings
• 模型AFDOriginGroupProperties不再具有参数response_based_afd_origin_error_detection_settings
• 模型AFDOriginGroupUpdateParameters不再具有参数response_based_afd_origin_error_detection_settings
• 模型AFDOriginGroupUpdatePropertiesParameters不再具有参数response_based_afd_origin_error_detection_settings
• 模型CacheExpirationActionParameters新增必需参数type_name
• 模型CacheExpirationActionParameters不再具有参数odata_type
• 模型 CacheKeyQueryStringActionParameters 新增必需参数类型 type_name
• 模型 CacheKeyQueryStringActionParameters 已移除参数 odata_type
• 模型 CdnCertificateSourceParameters 新增必需参数类型 type_name
• 模型 CdnCertificateSourceParameters 已移除参数 odata_type
• 模型 Certificate 已移除参数 thumbprint
• 模型 CookiesMatchConditionParameters 新增必需参数类型 type_name
• 模型 CookiesMatchConditionParameters 已移除参数 odata_type
• 模型 CustomerCertificate 已移除参数 certificate_url
• 模型 CustomerCertificate 已移除参数 version
• 模型 ErrorResponse 已移除参数 code
• 模型 ErrorResponse 已移除参数 message
• 模型 HeaderActionParameters 新增必需参数类型 type_name
• 模型 HeaderActionParameters 已移除参数 odata_type
• 模型 HttpVersionMatchConditionParameters 新增必需参数类型 type_name
• 模型 HttpVersionMatchConditionParameters 已移除参数 odata_type
• 模型 IsDeviceMatchConditionParameters 新增必需参数类型 type_name
• 模型 IsDeviceMatchConditionParameters 已移除参数 odata_type
• 模型 KeyVaultCertificateSourceParameters 新增必需参数类型 type_name
• 模型 KeyVaultCertificateSourceParameters 已移除参数 odata_type
• 模型 KeyVaultSigningKeyParameters 新增必需参数类型 type_name
• 模型 KeyVaultSigningKeyParameters 已移除参数 odata_type
• 模型 ManagedCertificate 已移除参数 thumbprint
• 模型 OriginGroupOverrideActionParameters 新增必需参数类型 type_name
• 模型 OriginGroupOverrideActionParameters 已移除参数 odata_type
• 模型 PostArgsMatchConditionParameters 新增必需参数类型 type_name
• 模型 PostArgsMatchConditionParameters 已移除参数 odata_type
• 模型 Profile 已移除参数 frontdoor_id
• 模型 QueryStringMatchConditionParameters 新增必需参数类型 type_name
• 模型 QueryStringMatchConditionParameters 已移除参数 odata_type
• 模型 RemoteAddressMatchConditionParameters 新增必需参数类型 type_name
• 模型 RemoteAddressMatchConditionParameters 已移除参数 odata_type
• 模型 RequestBodyMatchConditionParameters 新增必需参数类型 type_name
• 模型 RequestBodyMatchConditionParameters 已移除参数 odata_type
• 模型 RequestHeaderMatchConditionParameters 新增必需参数类型 type_name
• 模型 RequestHeaderMatchConditionParameters 已移除参数 odata_type
• 模型 RequestMethodMatchConditionParameters 新增必需参数类型 type_name
• 模型 RequestMethodMatchConditionParameters 已移除参数 odata_type
• 模型 RequestSchemeMatchConditionParameters 新增必需参数类型 type_name
• 模型 RequestSchemeMatchConditionParameters 已移除参数 odata_type
• 模型 RequestUriMatchConditionParameters 新增必需参数类型 type_name
• 模型 RequestUriMatchConditionParameters 已移除参数 odata_type
• 模型 Route 已移除参数 compression_settings
• 模型 Route 已移除参数 query_string_caching_behavior
• 模型 RouteProperties 已移除参数 compression_settings
• 模型 RouteProperties 已移除参数 query_string_caching_behavior
• 模型 RouteUpdateParameters 已移除参数 compression_settings
• 模型 RouteUpdateParameters 已移除参数 query_string_caching_behavior
• 模型 RouteUpdatePropertiesParameters 已移除参数 compression_settings
• 模型 RouteUpdatePropertiesParameters 已移除参数 query_string_caching_behavior
• 模型 UrlFileExtensionMatchConditionParameters 新增必需参数类型 type_name
• 模型 UrlFileExtensionMatchConditionParameters 已移除参数 odata_type
• 模型 UrlFileNameMatchConditionParameters 新增必需参数类型 type_name
• 模型 UrlFileNameMatchConditionParameters 已移除参数 odata_type
• 模型 UrlPathMatchConditionParameters 新增必需参数类型 type_name
• 模型 UrlPathMatchConditionParameters 已移除参数 odata_type
• 模型 UrlRedirectActionParameters 新增必需参数类型 type_name
• 模型 UrlRedirectActionParameters 已移除参数 odata_type
• 模型UrlRewriteActionParameters新增必填参数type_name
• 模型UrlRewriteActionParameters不再包含参数odata_type
• 模型UrlSigningActionParameters新增必填参数type_name
• 模型UrlSigningActionParameters不再包含参数odata_type
• 操作SecurityPoliciesOperations.begin_patch有新的签名
• 移除了操作RuleSetsOperations.begin_create
• 移除了操作SecretsOperations.begin_update

11.0.0 (2021-03-29)

功能

• 模型ManagedRuleSetDefinition新增参数system_data
• 模型Resource新增参数system_data

破坏性更改

• 操作SecurityPoliciesOperations.begin_patch有新的签名
• 操作RuleSetsOperations.begin_create有新的签名
• 模型RouteUpdatePropertiesParameters不再包含参数optimization_type
• 模型CustomerCertificateParameters不再包含参数thumbprint
• 模型CustomerCertificateParameters不再包含参数subject
• 模型CustomerCertificateParameters不再包含参数expiration_date
• 模型RouteProperties不再包含参数optimization_type
• 模型Route不再包含参数optimization_type
• 模型RouteUpdateParameters不再包含参数optimization_type
• 操作LogAnalyticsOperations.get_log_analytics_metrics有新的签名
• 模型ManagedCertificateParameters有新的签名

10.0.0 (2021-01-19)

功能

• 模型ProxyResource新增参数system_data
• 模型OriginGroup新增参数system_data
• 模型Endpoint新增参数system_data
• 模型EdgeNode新增参数system_data
• 模型Origin新增参数system_data
• 模型TrackedResource新增参数system_data
• 模型Profile新增参数system_data
• 模型Profile新增参数frontdoor_id
• 模型CdnWebApplicationFirewallPolicy新增参数system_data
• 模型CustomDomain新增参数system_data
• 新增操作组AFDOriginsOperations
• 新增操作组AFDProfilesOperations
• 新增操作组AFDEndpointsOperations
• 新增操作组RoutesOperations
• 新增操作组LogAnalyticsOperations
• 新增操作组RulesOperations
• 新增操作组ValidateOperations
• 新增操作组AFDOriginGroupsOperations
• 新增操作组SecretsOperations
• 新增操作组SecurityPoliciesOperations
• 新增操作组AFDCustomDomainsOperations
• 新增操作组RuleSetsOperations

破坏性更改

• 模型UrlSigningActionParameters的参数odata_type现在是必填的
• 操作PoliciesOperations.begin_update有新的签名
• 操作EndpointsOperations.validate_custom_domain有新的签名
• 操作EndpointsOperations.begin_load_content有新的签名
• 操作EndpointsOperations.begin_purge_content有新的签名
• 操作ProfilesOperations.begin_update有新的签名
• 操作CdnManagementClientOperationsMixin.check_name_availability有新的签名
• 操作CdnManagementClientOperationsMixin.check_name_availability_with_subscription有新的签名
• 操作CdnManagementClientOperationsMixin.validate_probe有新的签名
• 操作CustomDomainsOperations.begin_create有新的签名
• 模型UrlSigningActionParameters不再包含参数ip_subnets
• 模型UrlSigningActionParameters不再包含参数key_id

10.0.0b1 (2020-10-31)

这是beta预览版本。有关详细的变更日志，请参阅等效的稳定版本5.1.0（https://pypi.ac.cn/project/azure-mgmt-cdn/5.1.0/）

本版本使用新一代代码生成器，引入了重要的破坏性变更，但也引入了重要的新功能（如统一认证和异步编程）。

一般破坏性变更

• 凭证系统已被完全重写

  • azure.common.credentials 或 msrestazure.azure_active_directory 实例不再受支持，请使用 azure-identity 类： https://pypi.ac.cn/project/azure-identity/
  • credentials 参数已被重命名为 credential

• 客户端上的 config 属性不再存在，配置应作为 kwarg 传递。示例： MyClient(credential, subscription_id, enable_logging=True)。有关支持的完整选项集，请参阅 azure-core 初始化文档中的参数接受

• 您不能再导入 version 模块，请使用 __version__ 代替

• 之前返回 msrest.polling.LROPoller 的操作现在返回 azure.core.polling.LROPoller，并且以 begin_ 为前缀。

• 异常树已经简化，大多数异常现在都是 azure.core.exceptions.HttpResponseError（已移除 CloudError）。

• 大多数操作kwarg已经更改。一些最明显的更改包括

  • 已移除 raw。等效功能可以通过使用 cls（一个将提供访问内部HTTP响应的回调，适用于高级用户）来找到。
  • 有关支持选项的完整集合，请参阅azure-core 请求文档中的参数接受

一般新特性

• 支持使用 typing 进行类型注解。SDK已准备好mypy。
• 该客户端现在对异步操作提供了稳定和官方的支持。检查您包中的 aio 命名空间以找到异步客户端。
• 该客户端现在原生支持像OpenCensus或OpenTelemetry这样的跟踪库。有关概述，请参阅此跟踪快速入门。

5.1.0 (2020-08-10)

功能

• 添加了UrlSigningAction

5.0.0 (2020-07-21)

功能

• 模型Origin有一个新的参数private_link_approval_message
• 模型Origin有一个新的参数enabled
• 模型Origin有一个新的参数weight
• 模型Origin有一个新的参数origin_host_header
• 模型Origin有一个新的参数private_link_resource_id
• 模型Origin有一个新的参数private_link_location
• 模型Origin有一个新的参数private_link_alias
• 模型Origin有一个新的参数priority
• 模型Origin有一个新的参数private_endpoint_status
• 模型EndpointUpdateParameters有一个新的参数url_signing_keys
• 模型EndpointUpdateParameters有一个新的参数default_origin_group
• 模型Endpoint有一个新的参数url_signing_keys
• 模型Endpoint有一个新的参数origin_groups
• 模型Endpoint有一个新的参数default_origin_group
• 添加了操作OriginsOperations.create
• 添加了操作OriginsOperations.delete
• 添加了操作组OriginGroupsOperations

破坏性更改

• 模型Origin不再有参数location
• 模型Origin不再有参数tags
• 模型CustomDomain不再有参数custom_https_parameters
• 模型DeepCreatedOrigin有一个新的签名
• 模型OriginUpdateParameters有一个新的签名

4.1.0rc1（2020-01-18）

功能

• 模型Endpoint有一个新的参数web_application_firewall_policy_link
• 模型EndpointUpdateParameters有一个新的参数web_application_firewall_policy_link
• 添加了操作组PoliciesOperations
• 添加了操作组ManagedRuleSetsOperations

4.0.0 (2019-11-25)

功能

• 模型DeliveryRule有一个新的参数name
• 模型CdnManagedHttpsParameters有一个新的参数minimum_tls_version
• 模型UserManagedHttpsParameters有一个新的参数minimum_tls_version
• 模型CustomDomainHttpsParameters有一个新的参数minimum_tls_version
• 模型CustomDomain新增参数custom_https_parameters
• 添加了操作组CdnManagementClientOperationsMixin

一般重大更改

本版本使用下一代代码生成器，可能会引入重大更改。总之，一些模块不正确可见或可导入，并且已被重命名。这解决了由于使用本来不应该使用的类而引起的一些问题。

• CdnManagementClient不能再从 azure.mgmt.cdn.cdn_management_client 导入（从 azure.mgmt.cdn 导入与之前相同）
• CdnManagementClientConfiguration的导入已从 azure.mgmt.cdn.cdn_management_client 移动到 azure.mgmt.cdn
• 来自 "models" 子模块的模型 MyClass 不能再使用 azure.mgmt.cdn.models.my_class 导入（从 azure.mgmt.cdn.models 导入与之前相同）
• 来自 operations 子模块的操作类 MyClassOperations 不能再使用 azure.mgmt.cdn.operations.my_class_operations 导入（从 azure.mgmt.cdn.operations 导入与之前相同）

最后但同样重要的是，HTTP连接池现在默认启用。您应始终使用客户端作为上下文管理器，或者调用close()，或者每个进程使用不超过一个客户端。

3.1.0 (2019-03-05)

功能

• 添加了自定义域名HTTPS参数支持

3.0.0 (2018-05-25)

功能

• 添加了客户端方法check_name_availability_with_subscription
• Model EndpointUpdateParameters有一个新参数delivery_policy
• Model Endpoint有一个新参数delivery_policy
• 客户端类可以用作上下文管理器，以保持底层HTTP会话打开以优化性能

一般重大更改

本版本使用下一代代码生成器，可能会引入重大更改。

• 模型签名现在仅使用关键字参数语法。所有位置参数必须重写为关键字参数。为了在大多数情况下保持自动完成，现在为Python 2和Python 3生成模型。Python 3使用“*”语法表示关键字仅参数。
• 枚举类型现在使用“str”混合（类AzureEnum(str, Enum)）来改进遇到未识别枚举值时的行为。虽然这不是一个重大更改，但区别很重要，这里进行了说明：[https://docs.pythonlang.cn/3/library/enum.html#others](https://docs.pythonlang.cn/3/library/enum.html#others) 概述
  • 不应使用“is”。
  • “format”将返回字符串值，而“%s”字符串格式化将返回NameOfEnum.stringvalue。应优先使用格式化语法。
• 新的长时间运行的操作
  • 返回类型从msrestazure.azure_operation.AzureOperationPoller更改为msrest.polling.LROPoller。外部API相同。
  • 现在返回类型始终为msrest.polling.LROPoller，无论使用哪些可选参数。
  • 使用raw=True时的行为已更改。现在不再返回初始调用结果作为ClientRawResponse，而不进行轮询，而是返回LROPoller。轮询后，最终资源将作为ClientRawResponse返回。
  • 新增了polling参数。默认行为是Polling=True，将使用ARM算法进行轮询。当Polling=False时，将返回初始调用的响应，而不进行轮询。
  • polling参数接受msrest.polling.PollingMethod子类的实例。
  • 调用add_done_callback后不再抛出异常，而是立即执行回调。

错误修复

• sdist与wheel 0.31.0的兼容性

2.0.0 (2017-10-26)

功能

• 添加了探测操作并在某些模型中
• 添加了list_supported_optimization_types

破坏性更改

• 将resource_usage移动到自己的操作组
• 将操作列表移动到自己的操作组

API版本从2016-10-02更改为2017-04-02

1.0.0 (2017-06-30)

功能

• 添加了disable_custom_https和enable_custom_https

破坏性更改

• 将check_resource_usage重命名为list_resource_usage
• list EdgeNode现在返回EdgeNode的迭代器，而不是具有“value”属性（其值为EdgeNode列表）的EdgenodeResult实例

0.30.3 (2017-05-15)

• 此wheel软件包现在使用azure wheel扩展构建

0.30.2 (2016-12-22)

• 修复EdgeNode属性内容

0.30.1 (2016-12-15)

• 修复list EdgeNodes方法返回类型

0.30.0 (2016-12-14)

• 初始预览版本（API版本2016-10-02）
• 从0.30.0rc6的重大更改

0.30.0rc6（2016-09-02）

• 初始alpha版本（API版本2016-04-02）