Package: azure-mgmt-containerregistry
Microsoft Azure SDK for PythonThis is the Microsoft Azure Container Registry 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-containerregistry
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.containerregistryimportContainerRegistryManagementClientimportossub_id=os.getenv("AZURE_SUBSCRIPTION_ID")client=ContainerRegistryManagementClient(credential=DefaultAzureCredential(),subscription_id=sub_id)ExamplesCode samples for this package can be found at:Search Container Registryon 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 History10.3.0 (2023-11-20)Features AddedModel Registry has a new parameter metadata_searchModel RegistryUpdateParameters has a new parameter metadata_search10.2.0 (2023-09-21)Features AddedAdded operation group ArchiveVersionsOperationsAdded operation group ArchivesOperations10.1.0 (2023-02-15)Features AddedAdded operation group CacheRulesOperationsAdded operation group CredentialSetsOperations10.0.0 (2022-05-26)FeaturesModel Policies has a new parameter azure_ad_authentication_as_arm_policyModel Policies has a new parameter soft_delete_policyBreaking changesModel NetworkRuleSet no longer has parameter virtual_network_rules9.1.0 (2022-03-03)FeaturesAdded operation RegistriesOperations.begin_generate_credentialsModel NetworkRuleSet has a new parameter virtual_network_rulesModel Registry has a new parameter anonymous_pull_enabledModel RegistryUpdateParameters has a new parameter anonymous_pull_enabled9.0.0 (2022-01-19)FeaturesAdded operation RegistriesOperations.get_private_link_resourceBreaking changesModel NetworkRuleSet no longer has parameter virtual_network_rulesModel Registry no longer has parameter anonymous_pull_enabledModel RegistryUpdateParameters no longer has parameter anonymous_pull_enabledRemoved operation RegistriesOperations.begin_generate_credentials8.2.0 (2021-10-26)FeaturesModel ConnectedRegistryUpdateParameters has a new parameter notifications_listModel ConnectedRegistry has a new parameter notifications_list8.1.0 (2021-07-22)FeaturesModel Policies has a new parameter export_policyModel OperationDefinition has a new parameter is_data_action8.0.0 (2021-05-25)FeaturesModel PipelineRun has a new parameter system_dataModel TaskRunRequest has a new parameter log_templateModel TaskUpdateParameters has a new parameter log_templateModel Token has a new parameter system_dataModel EncodedTaskRunRequest has a new parameter log_templateModel ScopeMap has a new parameter system_dataModel AgentPool has a new parameter system_dataModel RegistryUpdateParameters has a new parameter anonymous_pull_enabledModel RegistryUpdateParameters has a new parameter network_rule_bypass_optionsModel ExportPipeline has a new parameter system_dataModel KeyVaultProperties has a new parameter key_rotation_enabledModel KeyVaultProperties has a new parameter last_key_rotation_timestampModel Run has a new parameter log_artifactModel Run has a new parameter system_dataModel FileTaskRunRequest has a new parameter log_templateModel RunRequest has a new parameter log_templateModel OperationServiceSpecificationDefinition has a new parameter log_specificationsModel Webhook has a new parameter system_dataModel ProxyResource has a new parameter system_dataModel TaskRun has a new parameter system_dataModel DockerBuildRequest has a new parameter log_templateModel Task has a new parameter is_system_taskModel Task has a new parameter system_dataModel Task has a new parameter log_templateModel Registry has a new parameter zone_redundancyModel Registry has a new parameter anonymous_pull_enabledModel Registry has a new parameter system_dataModel Registry has a new parameter network_rule_bypass_optionsModel ImportPipeline has a new parameter system_dataModel Resource has a new parameter system_dataModel PrivateEndpointConnection has a new parameter system_dataModel Replication has a new parameter zone_redundancyModel Replication has a new parameter system_dataAdded operation group ConnectedRegistriesOperationsBreaking changesParameter type of model QuickBuildRequest is now requiredParameter type of model BuildStepProperties is now requiredParameter type of model BuildStepPropertiesUpdateParameters is now requiredParameter type of model QueueBuildRequest is now requiredParameter type of model BuildTaskBuildRequest is now requiredModel TokenCredentialsProperties no longer has parameter active_directory_objectModel Registry no longer has parameter storage_accountRemoved operation RegistriesOperations.get_build_source_upload_urlRemoved operation RegistriesOperations.begin_schedule_run8.0.0b1 (2020-10-12)This is beta preview version.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.3.0.0rc15(2020-9-16)FeaturesModel FileTaskRunRequest has a new parameter log_templateModel Run has a new parameter log_artifactModel EncodedTaskRunRequest has a new parameter log_templateModel ImportPipeline has a new parameter locationModel TaskRunRequest has a new parameter log_templateModel Task has a new parameter log_templateModel Task has a new parameter is_system_taskModel RunRequest has a new parameter log_templateModel ExportPipeline has a new parameter locationModel TaskUpdateParameters has a new parameter log_templateModel TaskRunUpdateParameters has a new parameter locationModel DockerBuildRequest has a new parameter log_templateBreaking changesModel TaskRun no longer has parameter tags3.0.0rc14(2020-06-15)FeaturesModel RunGetLogResult has a new parameter log_artifact_link3.0.0rc13 (2020-05-15)FeaturesModel Replication has a new parameter region_endpoint_enabledModel ReplicationUpdateParameters has a new parameter region_endpoint_enabledBreaking changesOperation ReplicationsOperations.create has a new signatureOperation ReplicationsOperations.update has a new signatureOperation ReplicationsOperations.create has a new signature3.0.0rc12(2020-05-06)FeaturesModel Registry has a new parameter public_network_accessModel ErrorResponseBody has a new parameter detailsModel ErrorResponseBody has a new parameter targetModel RegistryUpdateParameters has a new parameter public_network_accessAdded operation group PipelineRunsOperationsAdded operation group ImportPipelinesOperationsAdded operation group ExportPipelinesOperations3.0.0rc11 (2020-03-25)Breaking changesOperation PrivateEndpointConnectionsOperations.create_or_update has a new signatureOperation PrivateEndpointConnectionsOperations.create_or_update has a new signature3.0.0rc10 (2020-03-11)FeaturesModel FileTaskRunRequest has a new parameter agent_pool_nameModel RunRequest has a new parameter agent_pool_nameModel RunFilter has a new parameter agent_pool_nameModel DockerBuildRequest has a new parameter agent_pool_nameModel TaskRunRequest has a new parameter agent_pool_nameModel EncodedTaskRunRequest has a new parameter agent_pool_nameModel TaskUpdateParameters has a new parameter agent_pool_nameModel Run has a new parameter agent_pool_nameModel Task has a new parameter agent_pool_nameAdded operation TaskRunsOperations.get_detailsAdded operation group AgentPoolsOperations3.0.0rc9 (2020-03-02)FeaturesModel Registry has a new parameter encryptionModel Registry has a new parameter data_endpoint_host_namesModel Registry has a new parameter private_endpoint_connectionsModel Registry has a new parameter identityModel Registry has a new parameter data_endpoint_enabledModel TokenCredentialsProperties has a new parameter active_directory_objectModel RegistryUpdateParameters has a new parameter identityModel RegistryUpdateParameters has a new parameter data_endpoint_enabledModel RegistryUpdateParameters has a new parameter encryptionAdded operation RegistriesOperations.list_private_link_resourcesAdded operation group PrivateEndpointConnectionsOperationsBreaking changesModel Token no longer has parameter object_id3.0.0rc8 (2020-01-10)FeaturesAdded operation group TaskRunsOperations3.0.0rc7 (2019-10-23)BugfixesMinor fixes in ScopeMaps3.0.0rc6 (2019-10-03)FeaturesAdded operation RegistriesOperations.generate_credentials3.0.0rc5 (2019-08-02)BugfixesReverting API version back to 2019-05-013.0.0rc4 (2019-07-10)BugfixesFix incorrect default API version from 2019-05-01 to 2017-10-013.0.0rc3 (2019-07-01)New preview API version 2019-06-01-preview contains:FeaturesModel BaseImageTriggerUpdateParameters has a new parameter
update_trigger_payload_typeModel BaseImageTriggerUpdateParameters has a new parameter
update_trigger_endpointModel RegistryUpdateParameters has a new parameter policiesModel Registry has a new parameter policiesModel TaskRunRequest has a new parameter
override_task_step_propertiesModel BaseImageTrigger has a new parameter
update_trigger_payload_typeModel BaseImageTrigger has a new parameter update_trigger_endpointModel Run has a new parameter update_trigger_tokenAdded operation RegistriesOperations.get_build_source_upload_urlAdded operation RegistriesOperations.schedule_runBreaking changesModel RegistryUpdateParameters no longer has parameter
storage_accountModel TaskRunRequest no longer has parameter task_nameModel TaskRunRequest no longer has parameter valuesModel TaskRunRequest has a new required parameter task_idRemoved operation RegistriesOperations.list_policiesRemoved operation RegistriesOperations.generate_credentialsRemoved operation RegistriesOperations.update_policies3.0.0rc2 (2019-06-12)FeaturesModel Run has a new parameter timer_triggerGeneral Breaking changesThis version uses a next-generation code generator thatmightintroduce breaking changes while using imports. 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.ContainerRegistryManagementClient cannot be imported fromazure.mgmt.containerregistry.containerregistry_management_clientanymore (import fromazure.mgmt.containerregistryworks like
before)ContainerRegistryManagementClientConfiguration import has been moved
fromazure.mgmt.containerregistry.containerregistry_management_clienttoazure.mgmt.containerregistryContainerRegistryManagementClient cannot be imported fromazure.mgmt.containerregistry.v20xx_yy_zz.containerregistry_management_clientanymore (import fromazure.mgmt.containerregistry.v20xx_yy_zzworks like before)ContainerRegistryManagementClientConfiguration import has been moved
fromazure.mgmt.containerregistry.v20xx_yy_zz.containerregistry_management_clienttoazure.mgmt.containerregistry.v20xx_yy_zzA modelMyClassfrom a "models" sub-module cannot be imported
anymore usingazure.mgmt.containerregistry.v20xx_yy_zz.models.my_class(import fromazure.mgmt.containerregistry.v20xx_yy_zz.modelsworks like before)An operation classMyClassOperationsfrom anoperationssub-module cannot be imported anymore usingazure.mgmt.containerregistry.v20xx_yy_zz.operations.my_class_operations(import fromazure.mgmt.containerregistry.v20xx_yy_zz.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 containerregistry mgmt client per process.3.0.0rc1 (2019-05-24)FeaturesModel Registry has a new parameter policiesModel RegistryUpdateParameters has a new parameter policiesAdd preview ScopeMaps (2019-05-01-preview API version)Breaking changesModel RegistryUpdateParameters no longer has parameter
storage_accountRemoved operation RegistriesOperations.update_policiesRemoved operation RegistriesOperations.list_policies2.8.0 (2019-04-30)FeaturesModel CustomRegistryCredentials has a new parameter identityModel Run has a new parameter run_error_messageModel Task has a new parameter identityModel TaskUpdateParameters has a new parameter identityModel Target has a new parameter nameModel Target has a new parameter versionModel TriggerProperties has a new parameter timer_triggersModel TriggerUpdateParameters has a new parameter timer_triggers2.7.0 (2019-01-25)FeaturesModel Run has a new parameter custom_registriesModel Run has a new parameter source_registry_authModel DockerBuildStepUpdateParameters has a new parameter targetModel FileTaskRunRequest has a new parameter credentialsModel DockerBuildRequest has a new parameter credentialsModel DockerBuildRequest has a new parameter targetModel TaskUpdateParameters has a new parameter credentialsModel Task has a new parameter credentialsModel EncodedTaskRunRequest has a new parameter credentialsModel DockerBuildStep has a new parameter target2.6.0 (2019-01-02)FeaturesAdd IP rulesBugfixesRename incorrect "id" to "virtual_network_resource_id"2.5.0 (2018-12-10)FeaturesAdd network rule set to registry properties2.4.0 (2018-11-05)FeaturesAdd context token to task step2.3.0 (2018-10-17)Support context path, source location URL, and pull request based
triggers for task/run.Allow specifying credentials for source registry on import image.2.2.0 (2018-09-11)FeaturesAdded operation RegistriesOperations.get_build_source_upload_urlAdded operation RegistriesOperations.schedule_runAdded operation group RunsOperationsAdded operation group TasksOperationsDefault API version is now 2018-09-012.1.0 (2018-07-26)FeaturesModel OperationDefinition has a new parameter service_specificationModel OperationDefinition has a new parameter originAdded operation RegistriesOperations.list_policiesAdded operation RegistriesOperations.update_policies2.0.0 (2018-04-30)FeaturesSupport for build steps/taks (ApiVersion 2018-02-01-preview)Support for Azure ProfilesClient 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.01.0.1 (2017-10-09)Rename Managed_Basic, Managed_Standard, Managed_Premium to Basic,
Standard, Premium.1.0.0 (2017-09-22)New default API version 2017-10-01.Remove support for API Version 2017-06-01-previewNew support for managed registries with three Managed SKUs.New support for registry webhooks and replications.Rename Basic SKU to Classic SKU.0.3.1 (2017-06-30)Support for registry SKU update (2017-06-01-preview)New listUsages API to get the quota usages for a container registry
(2017-06-01-preview)0.3.0 (2017-06-15)This package now supports an additional ApiVersion
2017-06-01-preview0.2.1 (2017-04-20)This wheel package is now built with the azure wheel extension0.2.0 (2017-03-20)New ApiVersion 2017-03-01Update getCredentials to listCredentials to support multiple login
credentials.Refine regenerateCredential to support regenerate the specified
login credential.Add Sku to registry properties as a required property.Rename GetProperties to Get.Change CreateOrUpdate to Create, add registry create parameters.0.1.1 (2016-12-12)BugfixesFix random error on Create and Delete operation0.1.0 (2016-11-04)Initial Release