适用于 Python 的 Microsoft Azure 容器注册表客户端库
项目描述
适用于 Python 的 Microsoft Azure SDK
这是 Microsoft Azure 容器注册表客户端库。这个包已经用 Python 3.6+ 进行了测试。有关 Azure 库的更完整视图,请参阅azure sdk python release。
免责声明
Azure SDK Python 包对 Python 2.7 的支持已于 2022 年 1 月 1 日结束。有关更多信息和问题,请参阅https://github.com/Azure/azure-sdk-for-python/issues/20691
用法
要了解如何使用此软件包,请参阅快速入门指南
有关文档和参考,请参阅Python SDK 参考 此包的代码示例可在 docs.microsoft.com上的Container Registry中找到。Samples Repo中提供了针对不同 Azure 服务的其他代码示例
提供反馈意见
如果您遇到任何错误或有建议,请在项目的 问题 部分提出问题。
发布历史
10.0.0 (2022-05-26)
特征
- 模型策略有一个新参数 azure_ad_authentication_as_arm_policy
- 模型策略有一个新参数 soft_delete_policy
重大变化
- 模型 NetworkRuleSet 不再具有参数 virtual_network_rules
9.1.0 (2022-03-03)
特征
- 添加操作 RegistriesOperations.begin_generate_credentials
- 模型 NetworkRuleSet 有一个新参数 virtual_network_rules
- 模型注册表有一个新参数 anonymous_pull_enabled
- 模型 RegistryUpdateParameters 有一个新参数 anonymous_pull_enabled
9.0.0 (2022-01-19)
特征
- 添加操作 RegistriesOperations.get_private_link_resource
重大变化
- 模型 NetworkRuleSet 不再具有参数 virtual_network_rules
- 模型注册表不再具有参数 anonymous_pull_enabled
- 模型 RegistryUpdateParameters 不再具有参数 anonymous_pull_enabled
- 删除操作 RegistriesOperations.begin_generate_credentials
8.2.0 (2021-10-26)
特征
- 模型 ConnectedRegistryUpdateParameters 有一个新参数 notifications_list
- 模型 ConnectedRegistry 有一个新参数 notify_list
8.1.0 (2021-07-22)
特征
- 模型策略有一个新参数 export_policy
- 模型 OperationDefinition 有一个新参数 is_data_action
8.0.0 (2021-05-25)
特征
- 模型 PipelineRun 有一个新参数 system_data
- 模型 TaskRunRequest 有一个新参数 log_template
- 模型 TaskUpdateParameters 有一个新参数 log_template
- Model Token 新增参数 system_data
- 模型 EncodedTaskRunRequest 有一个新参数 log_template
- 模型 ScopeMap 有一个新参数 system_data
- 模型 AgentPool 有一个新参数 system_data
- 模型 RegistryUpdateParameters 有一个新参数 anonymous_pull_enabled
- 模型 RegistryUpdateParameters 有一个新参数 network_rule_bypass_options
- 模型 ExportPipeline 有一个新参数 system_data
- 模型 KeyVaultProperties 有一个新参数 key_rotation_enabled
- 模型 KeyVaultProperties 有一个新参数 last_key_rotation_timestamp
- Model Run 有一个新参数 log_artifact
- 模型运行有一个新参数 system_data
- 模型 FileTaskRunRequest 有一个新参数 log_template
- 模型 RunRequest 有一个新参数 log_template
- 模型 OperationServiceSpecificationDefinition 有一个新参数 log_specifications
- 模型 Webhook 有一个新参数 system_data
- 模型 ProxyResource 有一个新参数 system_data
- 模型 TaskRun 有一个新参数 system_data
- 模型 DockerBuildRequest 有一个新参数 log_template
- 模型任务有一个新参数 is_system_task
- 模型任务有一个新参数 system_data
- 模型任务有一个新参数 log_template
- 模型注册表有一个新参数 zone_redundancy
- 模型注册表有一个新参数 anonymous_pull_enabled
- 模型注册表有一个新参数 system_data
- 模型注册表有一个新参数 network_rule_bypass_options
- 模型 ImportPipeline 有一个新参数 system_data
- 模型资源有一个新参数 system_data
- 模型 PrivateEndpointConnection 有一个新参数 system_data
- 模型复制有一个新参数 zone_redundancy
- 模型复制有一个新参数 system_data
- 添加了操作组 ConnectedRegistriesOperations
重大变化
- 现在需要模型 QuickBuildRequest 的参数类型
- 现在需要模型 BuildStepProperties 的参数类型
- 现在需要模型 BuildStepPropertiesUpdateParameters 的参数类型
- 现在需要模型 QueueBuildRequest 的参数类型
- 现在需要模型 BuildTaskBuildRequest 的参数类型
- 模型 TokenCredentialsProperties 不再具有参数 active_directory_object
- 模型注册表不再有参数 storage_account
- 删除操作 RegistriesOperations.get_build_source_upload_url
- 删除操作 RegistriesOperations.begin_schedule_run
8.0.0b1 (2020-10-12)
这是测试预览版。
此版本使用下一代代码生成器,该生成器引入了重要的重大更改,以及重要的新功能(如统一身份验证和异步编程)。
一般重大更改
-
凭证系统已完全改版:
azure.common.credentials或msrestazure.azure_active_directory不再支持实例,请改用azure-identity类:https ://pypi.org/project/azure-identity/credentials参数已重命名credential
-
该
config属性不再存在于客户端上,配置应作为 kwarg 传递。示例:MyClient(credential, subscription_id, enable_logging=True)。有关支持的完整选项集,请参阅azure-core 的 init 文档中的参数 accept -
您不能再导入
version模块,请__version__改用 -
以前返回 a 的操作
msrest.polling.LROPoller现在返回 aazure.core.polling.LROPoller并以 . 为前缀begin_。 -
异常树已被简化,现在大多数异常
azure.core.exceptions.HttpResponseError(CloudError已被删除)。 -
大部分操作 kwarg 都发生了变化。一些最引人注目的:
raw已被删除。可以使用回调找到等效功能cls,该回调将为高级用户提供对内部 HTTP 响应的访问权限- 有关支持的完整选项集,请参阅azure-core 的请求文档中的参数 accept
一般新功能
- 类型注释支持使用
typing. SDK 已准备好 mypy。 - 这个客户端现在对异步有稳定的官方支持。检查
aio包的命名空间以找到异步客户端。 - 此客户端现在支持本机跟踪库,如 OpenCensus 或 OpenTelemetry。有关概述,请参阅此跟踪快速入门。
3.0.0rc15(2020-9-16)
特征
- 模型 FileTaskRunRequest 有一个新参数 log_template
- Model Run 有一个新参数 log_artifact
- 模型 EncodedTaskRunRequest 有一个新参数 log_template
- 模型 ImportPipeline 有一个新的参数位置
- 模型 TaskRunRequest 有一个新参数 log_template
- 模型任务有一个新参数 log_template
- 模型任务有一个新参数 is_system_task
- 模型 RunRequest 有一个新参数 log_template
- 模型 ExportPipeline 有一个新的参数位置
- 模型 TaskUpdateParameters 有一个新参数 log_template
- 模型 TaskRunUpdateParameters 有一个新的参数位置
- 模型 DockerBuildRequest 有一个新参数 log_template
重大变化
- 模型 TaskRun 不再有参数标签
3.0.0rc14(2020-06-15)
特征
- 模型 RunGetLogResult 有一个新参数 log_artifact_link
3.0.0rc13 (2020-05-15)
特征
- 模型复制有一个新参数 region_endpoint_enabled
- 模型 ReplicationUpdateParameters 有一个新参数 region_endpoint_enabled
重大变化
- 操作 ReplicationsOperations.create 具有新签名
- 操作 ReplicationsOperations.update 具有新签名
- 操作 ReplicationsOperations.create 具有新签名
3.0.0rc12(2020-05-06)
特征
- 模型注册表有一个新参数 public_network_access
- 模型 ErrorResponseBody 有一个新的参数 details
- 模型 ErrorResponseBody 有一个新的参数 target
- 模型 RegistryUpdateParameters 有一个新参数 public_network_access
- 添加了操作组 PipelineRunsOperations
- 添加了操作组 ImportPipelinesOperations
- 添加了操作组 ExportPipelinesOperations
3.0.0rc11 (2020-03-25)
重大变化
- 操作 PrivateEndpointConnectionsOperations.create_or_update 具有新签名
- 操作 PrivateEndpointConnectionsOperations.create_or_update 具有新签名
3.0.0rc10 (2020-03-11)
特征
- 模型 FileTaskRunRequest 有一个新参数 agent_pool_name
- 模型 RunRequest 有一个新参数 agent_pool_name
- 模型 RunFilter 有一个新参数 agent_pool_name
- 模型 DockerBuildRequest 有一个新参数 agent_pool_name
- 模型 TaskRunRequest 有一个新参数 agent_pool_name
- 模型 EncodedTaskRunRequest 有一个新参数 agent_pool_name
- 模型 TaskUpdateParameters 有一个新参数 agent_pool_name
- Model Run 有一个新参数 agent_pool_name
- 模型任务有一个新参数 agent_pool_name
- 添加了操作 TaskRunsOperations.get_details
- 添加了操作组 AgentPoolsOperations
3.0.0rc9 (2020-03-02)
特征
- 模型注册表有一个新的参数加密
- 模型注册表有一个新参数 data_endpoint_host_names
- 模型注册表有一个新参数 private_endpoint_connections
- 模型注册表具有新的参数标识
- 模型注册表有一个新参数 data_endpoint_enabled
- 模型 TokenCredentialsProperties 有一个新参数 active_directory_object
- 模型 RegistryUpdateParameters 具有新的参数标识
- 模型 RegistryUpdateParameters 有一个新参数 data_endpoint_enabled
- 模型 RegistryUpdateParameters 有一个新的参数加密
- 添加操作 RegistriesOperations.list_private_link_resources
- 添加了操作组 PrivateEndpointConnectionsOperations
重大变化
- Model Token 不再有参数 object_id
3.0.0rc8 (2020-01-10)
特征
- 添加了操作组 TaskRunsOperations
3.0.0rc7 (2019-10-23)
Bug修复
- ScopeMaps 中的小修复
3.0.0rc6 (2019-10-03)
特征
- 添加操作 RegistriesOperations.generate_credentials
3.0.0rc5 (2019-08-02)
Bug修复
- 将 API 版本恢复到 2019-05-01
3.0.0rc4 (2019-07-10)
Bug修复
- 从 2019-05-01 到 2017-10-01 修复不正确的默认 API 版本
3.0.0rc3 (2019-07-01)
新的预览 API 版本 2019-06-01-preview 包含:
特征
- 模型 BaseImageTriggerUpdateParameters 有一个新参数 update_trigger_payload_type
- 模型 BaseImageTriggerUpdateParameters 有一个新参数 update_trigger_endpoint
- 模型 RegistryUpdateParameters 有一个新的参数策略
- 模型注册表有一个新的参数策略
- 模型 TaskRunRequest 有一个新参数 override_task_step_properties
- 模型 BaseImageTrigger 有一个新参数 update_trigger_payload_type
- 模型 BaseImageTrigger 有一个新参数 update_trigger_endpoint
- Model Run 有一个新参数 update_trigger_token
- 添加操作 RegistriesOperations.get_build_source_upload_url
- 添加操作 RegistriesOperations.schedule_run
重大变化
- 模型 RegistryUpdateParameters 不再具有参数 storage_account
- 模型 TaskRunRequest 不再有参数 task_name
- 模型 TaskRunRequest 不再有参数值
- 模型 TaskRunRequest 有一个新的必需参数 task_id
- 删除操作 RegistriesOperations.list_policies
- 删除操作 RegistriesOperations.generate_credentials
- 删除操作 RegistriesOperations.update_policies
3.0.0rc2 (2019-06-12)
特征
- 模型运行有一个新参数 timer_trigger
一般重大更改
此版本使用下一代代码生成器,在使用导入时可能会 引入重大更改。总之,一些模块不正确地可见/可导入并且已被重命名。这解决了由于使用最初不应该使用的类而导致的几个问题。
- ContainerRegistryManagementClient 不能再被导入
azure.mgmt.containerregistry.containerregistry_management_client(像以前一样从azure.mgmt.containerregistry作品导入) - ContainerRegistryManagementClientConfiguration 导入已从
azure.mgmt.containerregistry.containerregistry_management_client移至azure.mgmt.containerregistry - ContainerRegistryManagementClient 不能再被导入
azure.mgmt.containerregistry.v20xx_yy_zz.containerregistry_management_client(像以前一样从azure.mgmt.containerregistry.v20xx_yy_zz作品导入) - ContainerRegistryManagementClientConfiguration 导入已从
azure.mgmt.containerregistry.v20xx_yy_zz.containerregistry_management_client移至azure.mgmt.containerregistry.v20xx_yy_zz MyClass无法再使用“模型”子模块中的模型导入 (azure.mgmt.containerregistry.v20xx_yy_zz.models.my_class从azure.mgmt.containerregistry.v20xx_yy_zz.models以前的作品中导入)MyClassOperations子模块中的操作类operations不能再使用azure.mgmt.containerregistry.v20xx_yy_zz.operations.my_class_operations(import fromazure.mgmt.containerregistry.v20xx_yy_zz.operationsworks like before)导入
最后但同样重要的是,现在默认启用 HTTP 连接池。您应该始终将客户端用作上下文管理器,或者调用 close(),或者每个进程使用不超过一个 containerregistry mgmt 客户端。
3.0.0rc1 (2019-05-24)
特征
- 模型注册表有一个新的参数策略
- 模型 RegistryUpdateParameters 有一个新的参数策略
- 添加预览ScopeMaps(2019-05-01-preview API版本)
重大变化
- 模型 RegistryUpdateParameters 不再具有参数 storage_account
- 删除操作 RegistriesOperations.update_policies
- 删除操作 RegistriesOperations.list_policies
2.8.0 (2019-04-30)
特征
- 模型 CustomRegistryCredentials 有一个新的参数标识
- 模型运行有一个新参数 run_error_message
- 模型任务有一个新的参数标识
- 模型 TaskUpdateParameters 具有新的参数标识
- 模型目标有一个新的参数名称
- 模型目标有一个新的参数版本
- 模型 TriggerProperties 有一个新参数 timer_triggers
- 模型 TriggerUpdateParameters 有一个新参数 timer_triggers
2.7.0 (2019-01-25)
特征
- 模型运行有一个新参数 custom_registries
- 模型运行有一个新参数 source_registry_auth
- 模型 DockerBuildStepUpdateParameters 有一个新的参数目标
- 模型 FileTaskRunRequest 有一个新的参数 credentials
- 模型 DockerBuildRequest 有一个新的参数 credentials
- 模型 DockerBuildRequest 有一个新的参数 target
- 模型 TaskUpdateParameters 有一个新的参数凭据
- 模型任务有一个新的参数凭据
- 模型 EncodedTaskRunRequest 有一个新的参数 credentials
- 模型 DockerBuildStep 有一个新的参数 target
2.6.0 (2019-01-02)
特征
- 添加 IP 规则
Bug修复
- 将不正确的“id”重命名为“virtual_network_resource_id”
2.5.0 (2018-12-10)
特征
- 将网络规则集添加到注册表属性
2.4.0 (2018-11-05)
特征
- 将上下文标记添加到任务步骤
2.3.0 (2018-10-17)
- 支持任务/运行的上下文路径、源位置 URL 和基于拉取请求的触发器。
- 允许在导入映像上为源注册表指定凭据。
2.2.0 (2018-09-11)
特征
- 添加操作 RegistriesOperations.get_build_source_upload_url
- 添加操作 RegistriesOperations.schedule_run
- 添加了操作组 RunsOperations
- 添加了操作组TasksOperations
默认 API 版本现在是 2018-09-01
2.1.0 (2018-07-26)
特征
- 模型 OperationDefinition 有一个新参数 service_specification
- 模型 OperationDefinition 有一个新参数 origin
- 添加了操作 RegistriesOperations.list_policies
- 添加操作 RegistriesOperations.update_policies
2.0.0 (2018-04-30)
特征
- 支持构建步骤/任务(ApiVersion 2018-02-01-preview)
- 支持 Azure 配置文件
- 客户端类可用作上下文管理器,以保持底层 HTTP 会话打开以提高性能
一般重大更改
此版本使用可能 引入重大更改的下一代代码生成器。
- 模型签名现在仅使用关键字参数语法。所有位置参数都必须重写为关键字参数。为了在大多数情况下保持自动完成,现在为 Python 2 和 Python 3 生成模型。Python 3 对仅关键字参数使用“*”语法。
- 枚举类型现在使用“str”混合(类 AzureEnum(str, Enum))来改进遇到无法识别的枚举值时的行为。虽然这不是一个重大变化,但区别很重要,并在此处记录:
https ://docs.python.org/3/library/enum.html#others概览:
- 根本不应该使用“is”。
- "format" 将返回字符串值,其中 "%s" 字符串格式化将返回
NameOfEnum.stringvalue。格式语法应该是首选。
- 新的长期运行:
- 返回类型从
msrestazure.azure_operation.AzureOperationPoller变为msrest.polling.LROPoller。外部 API 相同。 - 无论使用什么可选参数,返回类型现在始终是 a 。
msrest.polling.LROPoller - 使用
raw=True. 现在,这将返回一个 LROPoller,而不是将初始调用结果返回为ClientRawResponse,而不进行轮询。轮询后,最终资源将以ClientRawResponse. - 新
polling参数。默认行为是Polling=True使用 ARM 算法进行轮询。当 时Polling=False,将返回初始调用的响应而不进行轮询。 polling参数接受 的子类的实例msrest.polling.PollingMethod。add_done_callback如果在轮询完成后调用,将不再引发,而是立即执行回调。
- 返回类型从
Bug修复
- sdist 与 wheel 0.31.0 的兼容性
1.0.1 (2017-10-09)
- 将 Managed_Basic、Managed_Standard、Managed_Premium 重命名为 Basic、Standard、Premium。
1.0.0 (2017-09-22)
- 新的默认 API 版本 2017-10-01。
- 删除对 API 版本 2017-06-01-preview 的支持
- 对具有三个托管 SKU 的托管注册表的新支持。
- 对注册表 Webhook 和复制的新支持。
- 将基本 SKU 重命名为经典 SKU。
0.3.1 (2017-06-30)
- 支持注册表 SKU 更新 (2017-06-01-preview)
- 用于获取容器注册表配额使用情况的新 listUsages API (2017-06-01-preview)
0.3.0 (2017-06-15)
- 此软件包现在支持额外的 ApiVersion 2017-06-01-preview
0.2.1 (2017-04-20)
这个轮子包现在是用天蓝色轮子扩展构建的
0.2.0 (2017-03-20)
- 新的 API 版本 2017-03-01
- 将 getCredentials 更新为 listCredentials 以支持多个登录凭据。
- 优化 regenerateCredential 以支持重新生成指定的登录凭据。
- 将 Sku 作为必需属性添加到注册表属性。
- 将 GetProperties 重命名为 Get。
- 将 CreateOrUpdate 更改为 Create,添加注册表创建参数。
0.1.1 (2016-12-12)
Bug修复
- 修复创建和删除操作的随机错误
0.1.0 (2016-11-04)
- 初始发行