# 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](https://aka.ms/azsdk/python/all).
## _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](https://azure.microsoft.com/free/)
### Install the package
```bash
pip install azure-mgmt-imagebuilder
pip install azure-identity
```
### Authentication
By default, [Azure Active Directory](https://aka.ms/awps/aad) 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:
```python
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](https://docs.microsoft.com/samples/browse/?languages=python&term=Getting%20started%20-%20Managing&terms=Getting%20started%20-%20Managing) on docs.microsoft.com
- [Azure Python Mgmt SDK Samples Repo](https://aka.ms/azsdk/python/mgmt/samples)
## Troubleshooting
## Next steps
## Provide Feedback
If you encounter any bugs or have suggestions, please file an issue in the
[Issues](https://github.com/Azure/azure-sdk-for-python/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` or `msrestazure.azure_active_directory` instances are no longer supported, use the `azure-identity` classes instead: https://pypi.org/project/azure-identity/
- `credentials` parameter has been renamed `credential`
- 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](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#available-policies)
- You can't import a `version` module anymore, use `__version__` instead
- Operations that used to return a `msrest.polling.LROPoller` now returns a `azure.core.polling.LROPoller` and are prefixed with `begin_`.
- 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 using `cls`, 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](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#available-policies)
**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](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/core/azure-core-tracing-opentelemetry) 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
from `azure.mgmt.imagebuilder` works like before)
- ImageBuilderClientConfiguration import has been moved from
`azure.mgmt.imagebuilder.image_builder_client` to
`azure.mgmt.imagebuilder`
- A model `MyClass` from a "models" sub-module cannot be imported
anymore using `azure.mgmt.imagebuilder.models.my_class` (import
from `azure.mgmt.imagebuilder.models` works like before)
- An operation class `MyClassOperations` from an `operations`
sub-module cannot be imported anymore using
`azure.mgmt.imagebuilder.operations.my_class_operations` (import
from `azure.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
Raw data
{
"_id": null,
"home_page": "https://github.com/Azure/azure-sdk-for-python",
"name": "azure-mgmt-imagebuilder",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "azure, azure sdk",
"author": "Microsoft Corporation",
"author_email": "azpysdkhelp@microsoft.com",
"download_url": "https://files.pythonhosted.org/packages/d7/ee/e8368bdc0c8dd48929952bdc7c5d94fb1c9168329a809151102cc9e4be25/azure-mgmt-imagebuilder-1.4.0.tar.gz",
"platform": null,
"description": "# Microsoft Azure SDK for Python\n\nThis is the Microsoft Azure Image Builder Client Library.\nThis package has been tested with Python 3.8+.\nFor a more complete view of Azure libraries, see the [azure sdk python release](https://aka.ms/azsdk/python/all).\n\n## _Disclaimer_\n\n_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_\n\n## Getting started\n\n### Prerequisites\n\n- Python 3.8+ is required to use this package.\n- [Azure subscription](https://azure.microsoft.com/free/)\n\n### Install the package\n\n```bash\npip install azure-mgmt-imagebuilder\npip install azure-identity\n```\n\n### Authentication\n\nBy default, [Azure Active Directory](https://aka.ms/awps/aad) token authentication depends on correct configure of following environment variables.\n\n- `AZURE_CLIENT_ID` for Azure client ID.\n- `AZURE_TENANT_ID` for Azure tenant ID.\n- `AZURE_CLIENT_SECRET` for Azure client secret.\n\nIn addition, Azure subscription ID can be configured via environment variable `AZURE_SUBSCRIPTION_ID`.\n\nWith above configuration, client can be authenticated by following code:\n\n```python\nfrom azure.identity import DefaultAzureCredential\nfrom azure.mgmt.imagebuilder import ImageBuilderClient\nimport os\n\nsub_id = os.getenv(\"AZURE_SUBSCRIPTION_ID\")\nclient = ImageBuilderClient(credential=DefaultAzureCredential(), subscription_id=sub_id)\n```\n\n## Examples\n\nCode samples for this package can be found at:\n- [Search Image Builder](https://docs.microsoft.com/samples/browse/?languages=python&term=Getting%20started%20-%20Managing&terms=Getting%20started%20-%20Managing) on docs.microsoft.com\n- [Azure Python Mgmt SDK Samples Repo](https://aka.ms/azsdk/python/mgmt/samples)\n\n\n## Troubleshooting\n\n## Next steps\n\n## Provide Feedback\n\nIf you encounter any bugs or have suggestions, please file an issue in the\n[Issues](https://github.com/Azure/azure-sdk-for-python/issues)\nsection of the project. \n\n\n# Release History\n\n## 1.4.0 (2024-06-17)\n\n### Features Added\n\n - Model ImageTemplate has a new parameter auto_run\n - Model ImageTemplate has a new parameter managed_resource_tags\n - Model ImageTemplateUpdateParametersProperties has a new parameter vm_profile\n - Model VirtualNetworkConfig has a new parameter container_instance_subnet_id\n\n## 1.3.0 (2023-12-18)\n\n### Features Added\n\n - Model ImageTemplate has a new parameter error_handling\n - Model ImageTemplateUpdateParameters has a new parameter properties\n\n## 1.2.0 (2023-04-20)\n\n### Features Added\n\n - Added operation group TriggersOperations\n - Model ImageTemplate has a new parameter optimize\n - Model ImageTemplateSharedImageDistributor has a new parameter target_regions\n - Model ImageTemplateSharedImageDistributor has a new parameter versioning\n - Model ImageTemplateSharedImageVersionSource has a new parameter exact_version\n - Model ImageTemplateVhdDistributor has a new parameter uri\n\n## 1.2.0b1 (2022-11-28)\n\n### Other Changes\n\n - Added generated samples in github repo\n - Drop support for python<3.7.0\n\n## 1.1.0 (2022-06-07)\n\n**Features**\n\n - Model ImageTemplate has a new parameter exact_staging_resource_group\n - Model ImageTemplate has a new parameter staging_resource_group\n - Model ImageTemplate has a new parameter validate\n - Model Resource has a new parameter system_data\n - Model RunOutput has a new parameter system_data\n - Model TrackedResource has a new parameter system_data\n\n## 1.0.0 (2021-12-07)\n\n**Features**\n\n - Model ImageTemplate has a new parameter system_data\n - Model VirtualNetworkConfig has a new parameter proxy_vm_size\n - Model ImageTemplateVmProfile has a new parameter user_assigned_identities\n - Model ImageTemplatePlatformImageSource has a new parameter exact_version\n\n**Breaking changes**\n\n - Model Resource no longer has parameter tags\n - Model Resource no longer has parameter location\n\n## 1.0.0b1 (2021-05-25)\n\nThis is beta preview version.\n\nThis version uses a next-generation code generator that introduces important breaking changes, but also important new features (like unified authentication and async programming).\n\n**General breaking changes**\n\n- Credential system has been completly revamped:\n\n - `azure.common.credentials` or `msrestazure.azure_active_directory` instances are no longer supported, use the `azure-identity` classes instead: https://pypi.org/project/azure-identity/\n - `credentials` parameter has been renamed `credential`\n\n- 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\n supported options, see the [parameters accept in init documentation of azure-core](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#available-policies)\n- You can't import a `version` module anymore, use `__version__` instead\n- Operations that used to return a `msrest.polling.LROPoller` now returns a `azure.core.polling.LROPoller` and are prefixed with `begin_`.\n- Exceptions tree have been simplified and most exceptions are now `azure.core.exceptions.HttpResponseError` (`CloudError` has been removed).\n- Most of the operation kwarg have changed. Some of the most noticeable:\n\n - `raw` has been removed. Equivalent feature can be found using `cls`, a callback that will give access to internal HTTP response for advanced user\n - For a complete set of\n supported options, see the [parameters accept in Request documentation of azure-core](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#available-policies)\n\n**General new features**\n\n- Type annotations support using `typing`. SDKs are mypy ready.\n- This client has now stable and official support for async. Check the `aio` namespace of your package to find the async client.\n- This client now support natively tracing library like OpenCensus or OpenTelemetry. See this [tracing quickstart](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/core/azure-core-tracing-opentelemetry) for an overview.\n\n## 0.4.0 (2020-05-07)\n\n**Features**\n\n - Model Operation has a new parameter is_data_action\n - Model ImageTemplateSharedImageDistributor has a new parameter exclude_from_latest\n - Model ImageTemplateSharedImageDistributor has a new parameter storage_account_type\n - Model ImageTemplatePlatformImageSource has a new parameter plan_info\n - Model ImageTemplateVmProfile has a new parameter vnet_config\n - Model ImageTemplateVmProfile has a new parameter os_disk_size_gb\n - Added operation VirtualMachineImageTemplatesOperations.cancel\n\n**Breaking changes**\n\n - Parameter identity of model ImageTemplate is now required\n\n## 0.3.0 (2019-11-19)\n\n**Features**\n\n - Model ImageTemplatePowerShellCustomizer has a new parameter\n run_elevated\n - Model ImageTemplatePowerShellCustomizer has a new parameter\n sha256_checksum\n - Model ImageTemplate has a new parameter vm_profile\n - Model ImageTemplateFileCustomizer has a new parameter\n sha256_checksum\n - Model ImageTemplateShellCustomizer has a new parameter\n sha256_checksum\n\n**General breaking changes**\n\nThis version uses a next-generation code generator that *might*\nintroduce breaking changes if from some import. In summary, some modules\nwere incorrectly visible/importable and have been renamed. This fixed\nseveral issues caused by usage of classes that were not supposed to be\nused in the first place.\n\n - ImageBuilderClient cannot be imported from\n `azure.mgmt.imagebuilder.image_builder_client` anymore (import\n from `azure.mgmt.imagebuilder` works like before)\n - ImageBuilderClientConfiguration import has been moved from\n `azure.mgmt.imagebuilder.image_builder_client` to\n `azure.mgmt.imagebuilder`\n - A model `MyClass` from a \"models\" sub-module cannot be imported\n anymore using `azure.mgmt.imagebuilder.models.my_class` (import\n from `azure.mgmt.imagebuilder.models` works like before)\n - An operation class `MyClassOperations` from an `operations`\n sub-module cannot be imported anymore using\n `azure.mgmt.imagebuilder.operations.my_class_operations` (import\n from `azure.mgmt.imagebuilder.operations` works like before)\n\nLast but not least, HTTP connection pooling is now enabled by default.\nYou should always use a client as a context manager, or call close(), or\nuse no more than one client per process.\n\n## 0.2.1 (2019-04-25)\n\n**Bugfixes**\n\n - Add missing build_timeout_in_minutes\n - Fix some regexp checking\n\n## 0.2.0 (2019-04-12)\n\n - New API version 2019-05-01-preview\n\n## 0.1.0 (2019-04-09)\n\n - Initial Release\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Microsoft Azure Image Builder Client Library for Python",
"version": "1.4.0",
"project_urls": {
"Homepage": "https://github.com/Azure/azure-sdk-for-python"
},
"split_keywords": [
"azure",
" azure sdk"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "ca538c0fa2372f769d922205a7c72cde3f8e1b4f0375758939a662f82839fe66",
"md5": "9324cd1400304c79649cd34103fb0616",
"sha256": "6ba8129cd10a3930c8128fad3f80b599be6c762d7e9a36bfcf51a0c1eb6d7fa7"
},
"downloads": -1,
"filename": "azure_mgmt_imagebuilder-1.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9324cd1400304c79649cd34103fb0616",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 77942,
"upload_time": "2024-06-20T05:46:49",
"upload_time_iso_8601": "2024-06-20T05:46:49.536327Z",
"url": "https://files.pythonhosted.org/packages/ca/53/8c0fa2372f769d922205a7c72cde3f8e1b4f0375758939a662f82839fe66/azure_mgmt_imagebuilder-1.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "d7eee8368bdc0c8dd48929952bdc7c5d94fb1c9168329a809151102cc9e4be25",
"md5": "31023301b3427482ce4dcbcb02952036",
"sha256": "e6c2d573abef26222fc14491803d4cb01f86fc61292d4cf7c4729eb4bae4891c"
},
"downloads": -1,
"filename": "azure-mgmt-imagebuilder-1.4.0.tar.gz",
"has_sig": false,
"md5_digest": "31023301b3427482ce4dcbcb02952036",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 65883,
"upload_time": "2024-06-20T05:46:43",
"upload_time_iso_8601": "2024-06-20T05:46:43.376529Z",
"url": "https://files.pythonhosted.org/packages/d7/ee/e8368bdc0c8dd48929952bdc7c5d94fb1c9168329a809151102cc9e4be25/azure-mgmt-imagebuilder-1.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-20 05:46:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Azure",
"github_project": "azure-sdk-for-python",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "azure-mgmt-imagebuilder"
}
JSON
