Package: azure-mgmt-containerinstance
Microsoft Azure SDK for PythonThis 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 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-containerinstance
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.containerinstanceimportContainerInstanceManagementClientimportossub_id=os.getenv("AZURE_SUBSCRIPTION_ID")client=ContainerInstanceManagementClient(credential=DefaultAzureCredential(),subscription_id=sub_id)ExamplesCode samples for this package can be found at:Search Container Instanceon 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.1.0 (2023-04-21)Features AddedModel Container has a new parameter security_contextModel ContainerGroup has a new parameter confidential_compute_propertiesModel ContainerGroup has a new parameter extensionsModel ContainerGroup has a new parameter priorityModel ContainerGroupProperties has a new parameter confidential_compute_propertiesModel ContainerGroupProperties has a new parameter extensionsModel ContainerGroupProperties has a new parameter priorityModel EncryptionProperties has a new parameter identityModel InitContainerDefinition has a new parameter security_context10.1.0b2 (2023-04-20)Features AddedModel ContainerGroup has a new parameter is_custom_provisioning_timeoutModel ContainerGroup has a new parameter provisioning_timeout_in_secondsModel ContainerGroupProperties has a new parameter is_custom_provisioning_timeoutModel ContainerGroupProperties has a new parameter provisioning_timeout_in_secondsBreaking ChangesModel ContainerGroup no longer has parameter confidential_compute_propertiesModel ContainerGroup no longer has parameter priorityModel ContainerGroupProperties no longer has parameter confidential_compute_propertiesModel ContainerGroupProperties no longer has parameter priority10.1.0b1 (2022-12-26)Features AddedModel ContainerGroup has a new parameter confidential_compute_propertiesModel ContainerGroup has a new parameter extensionsModel ContainerGroup has a new parameter priorityModel ContainerGroupProperties has a new parameter confidential_compute_propertiesModel ContainerGroupProperties has a new parameter extensionsModel ContainerGroupProperties has a new parameter priorityModel EncryptionProperties has a new parameter identity10.0.0 (2022-08-29)Features AddedAdded operation group SubnetServiceAssociationLinkOperationsModel IpAddress has a new parameter auto_generated_domain_name_label_scopeModel Usage has a new parameter idBreaking ChangesModel IpAddress no longer has parameter dns_name_label_reuse_policy9.2.0 (2022-04-15)FeaturesModel IpAddress has a new parameter dns_name_label_reuse_policy9.1.0 (2021-10-13)FeaturesModel ContainerGroup has a new parameter zonesModel Resource has a new parameter zones9.0.0 (2021-09-17)FeaturesModel ImageRegistryCredential has a new parameter identity_urlModel ImageRegistryCredential has a new parameter identityModel ContainerGroup has a new parameter subnet_idsAdded operation ContainerGroupsOperations.get_outbound_network_dependencies_endpointsBreaking changesModel ContainerGroup no longer has parameter network_profile8.0.0 (2021-07-20)FeaturesModel LogAnalytics has a new parameter workspace_resource_idModel ContainerHttpGet has a new parameter http_headersAdded operation ContainersOperations.attachBreaking changesOperation ContainersOperations.list_logs has a new signature7.0.0 (2020-11-25)GA release7.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.2.0.0 (2020-06-24)FeaturesModel ContainerGroup has a new parameter init_containersModel ContainerGroup has a new parameter skuModel ContainerGroup has a new parameter encryption_propertiesAdded operation group ContainersOperationsAdded operation group LocationOperationsBreaking changesModel CachedImages no longer has parameter idRemoved operation group ContainerGroupUsageOperationsRemoved operation group ServiceAssociationLinkOperationsRemoved operation group ContainerOperations1.5.0 (2019-05-22)FeaturesAdd client level operations list_cached_images and
list_capabilities1.4.1 (2019-04-01)BugfixFix incorrect wheel METADATA caused by setuptools 40.6.01.4.0 (2018-11-12)FeaturesAdd container_groups.start1.3.0 (2018-11-05)FeaturesModel ResourceLimits has a new parameter gpuModel ResourceRequests has a new parameter gpuModel ContainerGroup has a new parameter dns_config1.2.1 (2018-10-16)BugfixFix sdist broken in 1.2.0. No code change.1.2.0 (2018-10-08)FeaturesModel ContainerGroup has a new parameter identity (MSI support)Added operation group ServiceAssociationLinkOperationsNoteazure-mgmt-nspkg is not installed anymore on Python 3 (PEP420-based
namespace package)1.1.0 (2018-09-06)FeaturesModel LogAnalytics has a new parameter log_typeModel LogAnalytics has a new parameter metadataModel ContainerGroup has a new parameter network_profileAdded operation ContainerGroupsOperations.stopAdded operation ContainerGroupsOperations.restart1.0.0 (2018-06-13)FeaturesModel Container has a new parameter liveness_probeModel Container has a new parameter readiness_probeModel ContainerGroup has a new parameter diagnosticsModel EnvironmentVariable has a new parameter secure_valueClient 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.0.4.0 (2018-03-19)Breaking changescontainer_groups.create_or_update is now a Long Running operationFeaturesNew start_container operation group0.3.1 (2018-02-05)Fix dnsnamelabel to dns_name_label0.3.0 (2018-02-01)Add dnsnamelabelAdd fqdnAdd container_group_usage operation groupsAdd git_repo and secret to volumesAdd container_groups.updateAPI version is now 2018-02-01-preview0.2.0 (2017-10-20)Added on-failure/never container group retry policyAdded container volumes mount supportAdded operations APIAdded container group instance viewRenamed event class0.1.0 (2017-07-27)Initial preview release