Microsoft Azure SDK for Python
This is the Microsoft Azure Container Instance Client Library.
This package has been tested with Python 3.7+.
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
Install the package
pip install azure-mgmt-containerinstance
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.containerinstance import ContainerInstanceManagementClient
import os
sub_id = os.getenv("AZURE_SUBSCRIPTION_ID")
client = ContainerInstanceManagementClient(credential=DefaultAzureCredential(), subscription_id=sub_id)
Examples
Code samples for this package can be found at:
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
10.1.0 (2023-04-21)
Features Added
- Model Container has a new parameter security_context
- Model ContainerGroup has a new parameter confidential_compute_properties
- Model ContainerGroup has a new parameter extensions
- Model ContainerGroup has a new parameter priority
- Model ContainerGroupProperties has a new parameter confidential_compute_properties
- Model ContainerGroupProperties has a new parameter extensions
- Model ContainerGroupProperties has a new parameter priority
- Model EncryptionProperties has a new parameter identity
- Model InitContainerDefinition has a new parameter security_context
10.1.0b2 (2023-04-20)
Features Added
- Model ContainerGroup has a new parameter is_custom_provisioning_timeout
- Model ContainerGroup has a new parameter provisioning_timeout_in_seconds
- Model ContainerGroupProperties has a new parameter is_custom_provisioning_timeout
- Model ContainerGroupProperties has a new parameter provisioning_timeout_in_seconds
Breaking Changes
- Model ContainerGroup no longer has parameter confidential_compute_properties
- Model ContainerGroup no longer has parameter priority
- Model ContainerGroupProperties no longer has parameter confidential_compute_properties
- Model ContainerGroupProperties no longer has parameter priority
10.1.0b1 (2022-12-26)
Features Added
- Model ContainerGroup has a new parameter confidential_compute_properties
- Model ContainerGroup has a new parameter extensions
- Model ContainerGroup has a new parameter priority
- Model ContainerGroupProperties has a new parameter confidential_compute_properties
- Model ContainerGroupProperties has a new parameter extensions
- Model ContainerGroupProperties has a new parameter priority
- Model EncryptionProperties has a new parameter identity
10.0.0 (2022-08-29)
Features Added
- Added operation group SubnetServiceAssociationLinkOperations
- Model IpAddress has a new parameter auto_generated_domain_name_label_scope
- Model Usage has a new parameter id
Breaking Changes
- Model IpAddress no longer has parameter dns_name_label_reuse_policy
9.2.0 (2022-04-15)
Features
- Model IpAddress has a new parameter dns_name_label_reuse_policy
9.1.0 (2021-10-13)
Features
- Model ContainerGroup has a new parameter zones
- Model Resource has a new parameter zones
9.0.0 (2021-09-17)
Features
- Model ImageRegistryCredential has a new parameter identity_url
- Model ImageRegistryCredential has a new parameter identity
- Model ContainerGroup has a new parameter subnet_ids
- Added operation ContainerGroupsOperations.get_outbound_network_dependencies_endpoints
Breaking changes
- Model ContainerGroup no longer has parameter network_profile
8.0.0 (2021-07-20)
Features
- Model LogAnalytics has a new parameter workspace_resource_id
- Model ContainerHttpGet has a new parameter http_headers
- Added operation ContainersOperations.attach
Breaking changes
- Operation ContainersOperations.list_logs has a new signature
7.0.0 (2020-11-25)
7.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 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
-
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:
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.
2.0.0 (2020-06-24)
Features
- Model ContainerGroup has a new parameter init_containers
- Model ContainerGroup has a new parameter sku
- Model ContainerGroup has a new parameter encryption_properties
- Added operation group ContainersOperations
- Added operation group LocationOperations
Breaking changes
- Model CachedImages no longer has parameter id
- Removed operation group ContainerGroupUsageOperations
- Removed operation group ServiceAssociationLinkOperations
- Removed operation group ContainerOperations
1.5.0 (2019-05-22)
Features
- Add client level operations list_cached_images and
list_capabilities
1.4.1 (2019-04-01)
Bugfix
- Fix incorrect wheel METADATA caused by setuptools 40.6.0
1.4.0 (2018-11-12)
Features
- Add container_groups.start
1.3.0 (2018-11-05)
Features
- Model ResourceLimits has a new parameter gpu
- Model ResourceRequests has a new parameter gpu
- Model ContainerGroup has a new parameter dns_config
1.2.1 (2018-10-16)
Bugfix
- Fix sdist broken in 1.2.0. No code change.
1.2.0 (2018-10-08)
Features
- Model ContainerGroup has a new parameter identity (MSI support)
- Added operation group ServiceAssociationLinkOperations
Note
- azure-mgmt-nspkg is not installed anymore on Python 3 (PEP420-based
namespace package)
1.1.0 (2018-09-06)
Features
- Model LogAnalytics has a new parameter log_type
- Model LogAnalytics has a new parameter metadata
- Model ContainerGroup has a new parameter network_profile
- Added operation ContainerGroupsOperations.stop
- Added operation ContainerGroupsOperations.restart
1.0.0 (2018-06-13)
Features
- Model Container has a new parameter liveness_probe
- Model Container has a new parameter readiness_probe
- Model ContainerGroup has a new parameter diagnostics
- Model EnvironmentVariable has a new parameter secure_value
- Client class can be used as a context manager to keep the underlying
HTTP session open for performance
General Breaking changes
This version uses a next-generation code generator that might
introduce 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#others At a glance:
- "is" should not be used at all.
- "format" will return the string value, where "%s" string
formatting will return
NameOfEnum.stringvalue
. Format syntax
should be prefered.
- New Long Running Operation:
- Return type changes from
msrestazure.azure_operation.AzureOperationPoller
to
msrest.polling.LROPoller
. External API is the same.
- Return type is now always a
msrest.polling.LROPoller
,
regardless of the optional parameters used.
- The behavior has changed when using
raw=True
. Instead of
returning the initial call result as ClientRawResponse
,
without polling, now this returns an LROPoller. After polling,
the final resource will be returned as a ClientRawResponse
.
- New
polling
parameter. The default behavior is
Polling=True
which will poll using ARM algorithm. When
Polling=False
, the response of the initial call will be
returned without polling.
polling
parameter accepts instances of subclasses of
msrest.polling.PollingMethod
.
add_done_callback
will no longer raise if called after
polling is finished, but will instead execute the callback right
away.
0.4.0 (2018-03-19)
Breaking changes
- container_groups.create_or_update is now a Long Running operation
Features
- New start_container operation group
0.3.1 (2018-02-05)
- Fix dnsnamelabel to dns_name_label
0.3.0 (2018-02-01)
- Add dnsnamelabel
- Add fqdn
- Add container_group_usage operation groups
- Add git_repo and secret to volumes
- Add container_groups.update
API version is now 2018-02-01-preview
0.2.0 (2017-10-20)
- Added on-failure/never container group retry policy
- Added container volumes mount support
- Added operations API
- Added container group instance view
- Renamed event class
0.1.0 (2017-07-27)