Microsoft Azure Image Builder Client Library for Python
Project description
Microsoft Azure SDK for Python
This is the Microsoft Azure Image Builder Client Library. This package has been tested with Python 3.8+. For a more complete view of Azure libraries, see the azure sdk python release.
Disclaimer
Azure SDK Python packages support for Python 2.7 has ended 01 January 2022. For more information and questions, please refer to https://github.com/Azure/azure-sdk-for-python/issues/20691
Getting started
Prerequisites
- Python 3.8+ is required to use this package.
- Azure subscription
Install the package
pip install azure-mgmt-imagebuilder
pip install azure-identity
Authentication
By default, Azure Active Directory token authentication depends on correct configure of following environment variables.
AZURE_CLIENT_ID
for Azure client ID.AZURE_TENANT_ID
for Azure tenant ID.AZURE_CLIENT_SECRET
for Azure client secret.
In addition, Azure subscription ID can be configured via environment variable AZURE_SUBSCRIPTION_ID
.
With above configuration, client can be authenticated by following code:
from azure.identity import DefaultAzureCredential
from azure.mgmt.imagebuilder import ImageBuilderClient
import os
sub_id = os.getenv("AZURE_SUBSCRIPTION_ID")
client = ImageBuilderClient(credential=DefaultAzureCredential(), subscription_id=sub_id)
Examples
Code samples for this package can be found at:
- Search Image Builder on docs.microsoft.com
- Azure Python Mgmt SDK Samples Repo
Troubleshooting
Next steps
Provide Feedback
If you encounter any bugs or have suggestions, please file an issue in the Issues section of the project.
Release History
1.4.0 (2024-06-17)
Features Added
- Model ImageTemplate has a new parameter auto_run
- Model ImageTemplate has a new parameter managed_resource_tags
- Model ImageTemplateUpdateParametersProperties has a new parameter vm_profile
- Model VirtualNetworkConfig has a new parameter container_instance_subnet_id
1.3.0 (2023-12-18)
Features Added
- Model ImageTemplate has a new parameter error_handling
- Model ImageTemplateUpdateParameters has a new parameter properties
1.2.0 (2023-04-20)
Features Added
- Added operation group TriggersOperations
- Model ImageTemplate has a new parameter optimize
- Model ImageTemplateSharedImageDistributor has a new parameter target_regions
- Model ImageTemplateSharedImageDistributor has a new parameter versioning
- Model ImageTemplateSharedImageVersionSource has a new parameter exact_version
- Model ImageTemplateVhdDistributor has a new parameter uri
1.2.0b1 (2022-11-28)
Other Changes
- Added generated samples in github repo
- Drop support for python<3.7.0
1.1.0 (2022-06-07)
Features
- Model ImageTemplate has a new parameter exact_staging_resource_group
- Model ImageTemplate has a new parameter staging_resource_group
- Model ImageTemplate has a new parameter validate
- Model Resource has a new parameter system_data
- Model RunOutput has a new parameter system_data
- Model TrackedResource has a new parameter system_data
1.0.0 (2021-12-07)
Features
- Model ImageTemplate has a new parameter system_data
- Model VirtualNetworkConfig has a new parameter proxy_vm_size
- Model ImageTemplateVmProfile has a new parameter user_assigned_identities
- Model ImageTemplatePlatformImageSource has a new parameter exact_version
Breaking changes
- Model Resource no longer has parameter tags
- Model Resource no longer has parameter location
1.0.0b1 (2021-05-25)
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 changes
-
Credential system has been completly revamped:
azure.common.credentials
ormsrestazure.azure_active_directory
instances are no longer supported, use theazure-identity
classes instead: https://pypi.org/project/azure-identity/credentials
parameter has been renamedcredential
-
The
config
attribute 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 the parameters accept in init documentation of azure-core -
You can't import a
version
module anymore, use__version__
instead -
Operations that used to return a
msrest.polling.LROPoller
now returns aazure.core.polling.LROPoller
and are prefixed withbegin_
. -
Exceptions tree have been simplified and most exceptions are now
azure.core.exceptions.HttpResponseError
(CloudError
has been removed). -
Most of the operation kwarg have changed. Some of the most noticeable:
raw
has been removed. Equivalent feature can be found usingcls
, a callback that will give access to internal HTTP response for advanced user- For a complete set of supported options, see the parameters accept in Request documentation of azure-core
General new features
- Type annotations support using
typing
. SDKs are mypy ready. - This client has now stable and official support for async. Check the
aio
namespace of your package to find the async client. - This client now support natively tracing library like OpenCensus or OpenTelemetry. See this tracing quickstart for an overview.
0.4.0 (2020-05-07)
Features
- Model Operation has a new parameter is_data_action
- Model ImageTemplateSharedImageDistributor has a new parameter exclude_from_latest
- Model ImageTemplateSharedImageDistributor has a new parameter storage_account_type
- Model ImageTemplatePlatformImageSource has a new parameter plan_info
- Model ImageTemplateVmProfile has a new parameter vnet_config
- Model ImageTemplateVmProfile has a new parameter os_disk_size_gb
- Added operation VirtualMachineImageTemplatesOperations.cancel
Breaking changes
- Parameter identity of model ImageTemplate is now required
0.3.0 (2019-11-19)
Features
- Model ImageTemplatePowerShellCustomizer has a new parameter run_elevated
- Model ImageTemplatePowerShellCustomizer has a new parameter sha256_checksum
- Model ImageTemplate has a new parameter vm_profile
- Model ImageTemplateFileCustomizer has a new parameter sha256_checksum
- Model ImageTemplateShellCustomizer has a new parameter sha256_checksum
General breaking changes
This version uses a next-generation code generator that might introduce breaking changes if from some import. 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.
- ImageBuilderClient cannot be imported from
azure.mgmt.imagebuilder.image_builder_client
anymore (import fromazure.mgmt.imagebuilder
works like before) - ImageBuilderClientConfiguration import has been moved from
azure.mgmt.imagebuilder.image_builder_client
toazure.mgmt.imagebuilder
- A model
MyClass
from a "models" sub-module cannot be imported anymore usingazure.mgmt.imagebuilder.models.my_class
(import fromazure.mgmt.imagebuilder.models
works like before) - An operation class
MyClassOperations
from anoperations
sub-module cannot be imported anymore usingazure.mgmt.imagebuilder.operations.my_class_operations
(import fromazure.mgmt.imagebuilder.operations
works 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.
0.2.1 (2019-04-25)
Bugfixes
- Add missing build_timeout_in_minutes
- Fix some regexp checking
0.2.0 (2019-04-12)
- New API version 2019-05-01-preview
0.1.0 (2019-04-09)
- Initial Release
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for azure-mgmt-imagebuilder-1.4.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e6c2d573abef26222fc14491803d4cb01f86fc61292d4cf7c4729eb4bae4891c |
|
MD5 | 31023301b3427482ce4dcbcb02952036 |
|
BLAKE2b-256 | d7eee8368bdc0c8dd48929952bdc7c5d94fb1c9168329a809151102cc9e4be25 |
Hashes for azure_mgmt_imagebuilder-1.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6ba8129cd10a3930c8128fad3f80b599be6c762d7e9a36bfcf51a0c1eb6d7fa7 |
|
MD5 | 9324cd1400304c79649cd34103fb0616 |
|
BLAKE2b-256 | ca538c0fa2372f769d922205a7c72cde3f8e1b4f0375758939a662f82839fe66 |