Microsoft Azure SDK for Python

This is the Microsoft Azure Hybrid Kubernetes Management Client Library. This package has been tested with Python 3.10+. 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.10+ is required to use this package.
• Azure subscription

Install the package

pip install azure-mgmt-hybridkubernetes
pip install azure-identity

Authentication

By default, Microsoft Entra token authentication depends on correct configuration of the 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.hybridkubernetes import ConnectedKubernetesClient
import os

sub_id = os.getenv("AZURE_SUBSCRIPTION_ID")
client = ConnectedKubernetesClient(credential=DefaultAzureCredential(), subscription_id=sub_id)

Examples

Code samples for this package can be found at:

• Search Hybrid Kubernetes Management 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

2.0.0 (2026-07-20)

Features Added

• Client ConnectedKubernetesClient added method send_request
• Model ConnectedCluster added property kind
• Enum ConnectivityStatus added member AGENT_NOT_INSTALLED
• Model HybridConnectionConfig added property relay_tid
• Model HybridConnectionConfig added property relay_type
• Model Operation added property action_type
• Model Operation added property is_data_action
• Model Operation added property origin
• Model Resource added property system_data
• Model TrackedResource added property system_data
• Added model AadProfile
• Added enum ActionType
• Added model AgentError
• Added model ArcAgentProfile
• Added model ArcAgentryConfigurations
• Added enum AutoUpgradeOptions
• Added enum AzureHybridBenefit
• Added enum ConnectedClusterKind
• Added model ConnectedClusterPatchProperties
• Added model Gateway
• Added model OidcIssuerProfile
• Added enum Origin
• Added enum PrivateLinkState
• Added model SecurityProfile
• Added model SecurityProfileWorkloadIdentity
• Added model SystemComponent

Breaking Changes

• This version introduces new hybrid models which have dual dictionary and model nature. Please follow https://aka.ms/azsdk/python/migrate/hybrid-models for migration.
• Model ConnectedCluster moved instance variable agent_public_key_certificate, agent_version, connectivity_status, distribution, infrastructure, kubernetes_version, last_connectivity_time, managed_identity_certificate_expiration_time, offering, provisioning_state, total_core_count and total_node_count under property properties whose type is ConnectedClusterProperties
• Model SystemData renamed type of property last_modified_by_type from LastModifiedByType to CreatedByType
• Operation group ConnectedClusterOperations renamed method begin_create to begin_create_or_replace
• Operation group ConnectedClusterOperations renamed method update to begin_update_async

Other Changes

• Deleted model ConnectedClusterList/OperationList which actually were not used by SDK users

2.0.0b1 (2026-05-20)

Features Added

• Client ConnectedKubernetesClient added method send_request
• Model ConnectedCluster added property kind
• Enum ConnectivityStatus added member AGENT_NOT_INSTALLED
• Model HybridConnectionConfig added property relay_tid
• Model HybridConnectionConfig added property relay_type
• Model Operation added property is_data_action
• Model Operation added property origin
• Model Operation added property action_type
• Model Resource added property system_data
• Model TrackedResource added property system_data
• Added model AadProfile
• Added enum ActionType
• Added model AgentError
• Added model ArcAgentProfile
• Added model ArcAgentryConfigurations
• Added enum AutoUpgradeOptions
• Added enum AzureHybridBenefit
• Added enum ConnectedClusterKind
• Added model ConnectedClusterPatchProperties
• Added model Gateway
• Added model OidcIssuerProfile
• Added enum Origin
• Added enum PrivateLinkState
• Added model SecurityProfile
• Added model SecurityProfileWorkloadIdentity
• Added model SystemComponent

Breaking Changes

• Model SystemData renamed type of property last_modified_by_type from LastModifiedByType to CreatedByType
• Operation group ConnectedClusterOperations renamed method begin_create to begin_create_or_replace
• Operation group ConnectedClusterOperations renamed method update to begin_update_async

Other Changes

• Deleted model ConnectedClusterList/OperationList which actually were not used by SDK users

1.2.0 (2026-04-23)

Other Changes

• Regenerate SDK code with latest code generator tool

1.2.0b2 (2025-03-24)

Features Added

• Model ConnectedCluster added property kind
• Model ConnectedCluster added property distribution_version
• Model ConnectedCluster added property private_link_state
• Model ConnectedCluster added property private_link_scope_resource_id
• Model ConnectedCluster added property azure_hybrid_benefit
• Model ConnectedCluster added property aad_profile
• Model ConnectedCluster added property arc_agent_profile
• Model ConnectedCluster added property security_profile
• Model ConnectedCluster added property oidc_issuer_profile
• Model ConnectedCluster added property gateway
• Model ConnectedCluster added property arc_agentry_configurations
• Model ConnectedCluster added property miscellaneous_properties
• Model ConnectedClusterPatch added property distribution
• Model ConnectedClusterPatch added property distribution_version
• Model ConnectedClusterPatch added property azure_hybrid_benefit
• Enum ConnectivityStatus added member AGENT_NOT_INSTALLED
• Model HybridConnectionConfig added property relay_tid
• Model HybridConnectionConfig added property relay_type
• Added model AadProfile
• Added model AgentError
• Added model ArcAgentProfile
• Added model ArcAgentryConfigurations
• Added enum AutoUpgradeOptions
• Added enum AzureHybridBenefit
• Added enum ConnectedClusterKind
• Added model Gateway
• Added model OidcIssuerProfile
• Added enum PrivateLinkState
• Added model SecurityProfile
• Added model SecurityProfileWorkloadIdentity
• Added model SystemComponent
• Model ConnectedClusterOperations added method begin_create_or_replace

Breaking Changes

• Model ConnectedClusterPatch deleted or renamed its instance variable properties
• Deleted or renamed method ConnectedClusterOperations.begin_create

1.2.0b1 (2022-11-09)

Other Changes

• Added generated samples in github repo
• Drop support for python<3.7.0

1.1.0 (2021-10-20)

Features

• Added operation ConnectedClusterOperations.list_cluster_user_credential

1.0.0 (2021-05-19)

Features

• Model ConnectedCluster has a new parameter system_data

Breaking changes

• Model ConnectedCluster no longer has parameter aad_profile
• Removed operation ConnectedClusterOperations.list_cluster_user_credentials
• Model ConnectedClusterPatch has a new signature

1.0.0b1 (2020-12-09)

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:

  • 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

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.1.0 (2020-05-18)

• Initial Release