Microsoft Azure SDK for Python

This is the Microsoft Azure Hybridconnectivity 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-hybridconnectivity
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.hybridconnectivity import HybridConnectivityMgmtClient
import os

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

Examples

Code samples for this package can be found at:

• Search Hybridconnectivity 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-08-21)

Features Added

• Client HybridConnectivityMgmtClient added parameter cloud_setting in method __init__
• Client HybridConnectivityMgmtClient added parameter polling_interval in method __init__
• Client HybridConnectivityMgmtClient added method send_request
• Client HybridConnectivityMgmtClient added operation group generate_aws_template
• Client HybridConnectivityMgmtClient added operation group generate_gcp_template
• Client HybridConnectivityMgmtClient added operation group inventory
• Client HybridConnectivityMgmtClient added operation group public_cloud_connectors
• Client HybridConnectivityMgmtClient added operation group solution_configurations
• Client HybridConnectivityMgmtClient added operation group solution_types
• Added model AwsCloudProfile
• Added model AwsCloudProfileUpdate
• Added enum CloudNativeType
• Added model ExtensionResource
• Added model GcpCloudProfile
• Added model GcpCloudProfileUpdate
• Added model GcpOrganizationProperties
• Added model GcpOrganizationPropertiesUpdate
• Added model GcpProjectProperties
• Added enum GcpTemplateFormat
• Added model GenerateAwsTemplateRequest
• Added model GenerateAwsTemplateResponse
• Added model GenerateGcpTemplateRequest
• Added model GenerateGcpTemplateResponse
• Added enum HostType
• Added model InventoryProperties
• Added model InventoryResource
• Added model OperationStatusResult
• Added model PublicCloudConnector
• Added model PublicCloudConnectorProperties
• Added model PublicCloudConnectorPropertiesUpdate
• Added model PublicCloudConnectorUpdate
• Added enum ResourceProvisioningState
• Added model SolutionConfiguration
• Added model SolutionConfigurationProperties
• Added model SolutionConfigurationPropertiesUpdate
• Added enum SolutionConfigurationStatus
• Added model SolutionConfigurationUpdate
• Added model SolutionSettings
• Added model SolutionTypeProperties
• Added model SolutionTypeResource
• Added model SolutionTypeSettings
• Added model SolutionTypeSettingsProperties
• Added model TrackedResource
• Added model TrackedResourceUpdate
• Added operation group GenerateAwsTemplateOperations
• Added operation group GenerateGcpTemplateOperations
• Added operation group InventoryOperations
• Added operation group PublicCloudConnectorsOperations
• Added operation group SolutionConfigurationsOperations
• Added operation group SolutionTypesOperations

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.
• For the method breakings, please refer to https://aka.ms/azsdk/python/migrate/operations for migration.
• Method HybridConnectivityMgmtClient.__init__ inserted a positional_or_keyword parameter subscription_id
• Model EndpointAccessResource moved instance variable access_key, expires_on, hybrid_connection_name, namespace_name, namespace_name_suffix and service_configuration_token under property relay whose type is RelayNamespaceAccessProperties
• Model IngressGatewayResource moved instance variable access_key, expires_on, hybrid_connection_name, namespace_name, namespace_name_suffix and service_configuration_token under property relay whose type is RelayNamespaceAccessProperties
• Model IngressGatewayResource moved instance variable hostname under property ingress whose type is IngressProfileProperties
• Model IngressGatewayResource moved instance variable server_id and tenant_id under property ingress.aad_profile whose type is AADProfileProperties
• Model ServiceConfigurationResource moved instance variable port, provisioning_state, resource_id and service_name under property properties whose type is ServiceConfigurationProperties
• Model ServiceConfigurationResourcePatch moved instance variable port under property properties whose type is ServiceConfigurationPropertiesPatch
• Parameter expiresin of EndpointsOperations.list_credentials is now optional
• Method EndpointsOperations.list_credentials changed its parameter expiresin from positional_or_keyword to keyword_only
• Parameter expiresin of EndpointsOperations.list_ingress_gateway_credentials is now optional
• Method EndpointsOperations.list_ingress_gateway_credentials changed its parameter expiresin from positional_or_keyword to keyword_only

Other Changes

• Deleted model EndpointsList/OperationListResult/ServiceConfigurationList which actually were not used by SDK users

2.0.0b1 (2025-04-01)

Features Added

• Client HybridConnectivityMgmtClient added operation group generate_aws_template
• Client HybridConnectivityMgmtClient added operation group public_cloud_connectors
• Client HybridConnectivityMgmtClient added operation group solution_configurations
• Client HybridConnectivityMgmtClient added operation group inventory
• Client HybridConnectivityMgmtClient added operation group solution_types
• Model ServiceConfigurationResource added property properties
• Added model AADProfileProperties
• Added model AwsCloudProfile
• Added model AwsCloudProfileUpdate
• Added enum CloudNativeType
• Added model ExtensionResource
• Added model GenerateAwsTemplateRequest
• Added enum HostType
• Added model IngressProfileProperties
• Added model InventoryProperties
• Added model InventoryResource
• Added model OperationStatusResult
• Added model PublicCloudConnector
• Added model PublicCloudConnectorProperties
• Added model PublicCloudConnectorPropertiesUpdate
• Added model PublicCloudConnectorUpdate
• Added model RelayNamespaceAccessProperties
• Added enum ResourceProvisioningState
• Added model ServiceConfigurationProperties
• Added model ServiceConfigurationPropertiesPatch
• Added model SolutionConfiguration
• Added model SolutionConfigurationProperties
• Added model SolutionConfigurationPropertiesUpdate
• Added enum SolutionConfigurationStatus
• Added model SolutionConfigurationUpdate
• Added model SolutionSettings
• Added model SolutionTypeProperties
• Added model SolutionTypeResource
• Added model SolutionTypeSettings
• Added model SolutionTypeSettingsProperties
• Added model TrackedResource
• Added model TrackedResourceUpdate
• Added operation group GenerateAwsTemplateOperations
• Added operation group InventoryOperations
• Added operation group PublicCloudConnectorsOperations
• Added operation group SolutionConfigurationsOperations
• Added operation group SolutionTypesOperations

Breaking Changes

• Model EndpointAccessResource deleted or renamed its instance variable namespace_name
• Model EndpointAccessResource deleted or renamed its instance variable namespace_name_suffix
• Model EndpointAccessResource deleted or renamed its instance variable hybrid_connection_name
• Model EndpointAccessResource deleted or renamed its instance variable access_key
• Model EndpointAccessResource deleted or renamed its instance variable expires_on
• Model EndpointAccessResource deleted or renamed its instance variable service_configuration_token
• Model IngressGatewayResource deleted or renamed its instance variable hostname
• Model IngressGatewayResource deleted or renamed its instance variable server_id
• Model IngressGatewayResource deleted or renamed its instance variable tenant_id
• Model IngressGatewayResource deleted or renamed its instance variable namespace_name
• Model IngressGatewayResource deleted or renamed its instance variable namespace_name_suffix
• Model IngressGatewayResource deleted or renamed its instance variable hybrid_connection_name
• Model IngressGatewayResource deleted or renamed its instance variable access_key
• Model IngressGatewayResource deleted or renamed its instance variable expires_on
• Model IngressGatewayResource deleted or renamed its instance variable service_configuration_token
• Model ServiceConfigurationResource deleted or renamed its instance variable service_name
• Model ServiceConfigurationResource deleted or renamed its instance variable resource_id
• Model ServiceConfigurationResource deleted or renamed its instance variable port
• Model ServiceConfigurationResource deleted or renamed its instance variable provisioning_state
• Model ServiceConfigurationResourcePatch deleted or renamed its instance variable port
• Deleted or renamed model EndpointsList
• Deleted or renamed model ServiceConfigurationList
• Parameter expiresin of method EndpointsOperations.list_credentials is now required
• Parameter expiresinof method EndpointsOperations.list_ingress_gateway_credentials is now required

1.0.0 (2023-09-20)

Other Changes

• First GA

1.0.0b1 (2023-09-20)

• Initial Release