Microsoft Azure SDK for Python

This is the Microsoft Azure Confluent 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-confluent
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.confluent import ConfluentManagementClient
import os

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

Examples

Code samples for this package can be found at:

• Search Confluent 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

3.0.0b2 (2026-07-16)

Features Added

• Client ConfluentManagementClient added operation group access_point_resources
• Client ConfluentManagementClient added operation group network_gateway_resources
• Added model AccessPointProperties
• Added model AccessPointResource
• Added model ActivateSaaSParameterRequest
• Added model KeyValuePair
• Added model LatestLinkedSaaSResponse
• Added model NetworkGatewayProperties
• Added model NetworkGatewayResource
• Added model SaaSData
• Added model SaaSResourceDetailsResponse
• Added model VnetInjectionDetails
• Operation group OrganizationOperations added method begin_activate_resource
• Operation group OrganizationOperations added method begin_link_saa_s
• Operation group OrganizationOperations added method latest_linked_saa_s
• Added operation group AccessPointResourcesOperations
• Added operation group NetworkGatewayResourcesOperations

3.0.0b1 (2026-03-16)

Features Added

• Model ConfluentManagementClient added parameter cloud_setting in method __init__
• Client ConfluentManagementClient added method send_request
• Client ConfluentManagementClient added operation group environment
• Client ConfluentManagementClient added operation group cluster
• Client ConfluentManagementClient added operation group connector
• Client ConfluentManagementClient added operation group topics
• Model APIKeyRecord added property properties
• Model ConfluentAgreementResource added property properties
• Model RegionRecord added property properties
• Model SCClusterRecord added property properties
• Model SCClusterRecord added property type
• Model SCClusterRecord added property system_data
• Model SCClusterSpecEntity added property package
• Model SCEnvironmentRecord added property properties
• Model SCEnvironmentRecord added property type
• Model SCEnvironmentRecord added property system_data
• Model SchemaRegistryClusterRecord added property properties
• Added model APIKeyProperties
• Added enum AuthType
• Added model AzureBlobStorageSinkConnectorServiceInfo
• Added model AzureBlobStorageSourceConnectorServiceInfo
• Added model AzureCosmosDBSinkConnectorServiceInfo
• Added model AzureCosmosDBSourceConnectorServiceInfo
• Added model AzureSynapseAnalyticsSinkConnectorServiceInfo
• Added model ClusterProperties
• Added model ConfluentAgreementProperties
• Added enum ConnectorClass
• Added model ConnectorInfoBase
• Added model ConnectorResource
• Added model ConnectorResourceProperties
• Added enum ConnectorServiceType
• Added model ConnectorServiceTypeInfoBase
• Added enum ConnectorStatus
• Added enum ConnectorType
• Added enum DataFormatType
• Added model EnvironmentProperties
• Added model ErrorAdditionalInfo
• Added model ErrorDetail
• Added model ErrorResponse
• Added model KafkaAzureBlobStorageSinkConnectorInfo
• Added model KafkaAzureBlobStorageSourceConnectorInfo
• Added model KafkaAzureCosmosDBSinkConnectorInfo
• Added model KafkaAzureCosmosDBSourceConnectorInfo
• Added model KafkaAzureSynapseAnalyticsSinkConnectorInfo
• Added enum Package
• Added enum PartnerConnectorType
• Added model PartnerInfoBase
• Added model ProxyResource
• Added model RegionProperties
• Added model Resource
• Added model SchemaRegistryClusterProperties
• Added model StreamGovernanceConfig
• Added model TopicMetadataEntity
• Added model TopicProperties
• Added model TopicRecord
• Added model TopicsInputConfig
• Added model TopicsRelatedLink
• Added model TrackedResource
• Added operation group ClusterOperations
• Added operation group ConnectorOperations
• Added operation group EnvironmentOperations
• Added operation group TopicsOperations

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.
• Model APIKeyRecord moved instance variable metadata and spec under property properties
• Model ConfluentAgreementResource moved instance variable publisher, product, plan, license_text_link, privacy_policy_link, retrieve_datetime, signature and accepted under property properties
• Model RegionRecord moved instance variable metadata and spec under property properties
• Model SCClusterRecord moved instance variable metadata, spec and status under property properties
• Model SCEnvironmentRecord moved instance variable metadata under property properties
• Model SchemaRegistryClusterRecord moved instance variable metadata, spec and status under property properties
• Method OrganizationOperations.list_clusters changed its parameter page_size/page_token from positional_or_keyword to keyword_only
• Method OrganizationOperations.list_environments changed its parameter page_size/page_token from positional_or_keyword to keyword_only
• Method OrganizationOperations.list_schema_registry_clusters changed its parameter page_size/page_token from positional_or_keyword to keyword_only

Other Changes

• Deleted model ConfluentAgreementResourceListResponse/GetEnvironmentsResponse/ListClustersSuccessResponse/ListSchemaRegistryClustersResponse/SCConfluentListMetadata which actually were not used by SDK users

2.1.0 (2024-03-18)

Features Added

• Added operation AccessOperations.create_role_binding
• Added operation AccessOperations.delete_role_binding
• Added operation AccessOperations.list_role_binding_name_list
• Added operation OrganizationOperations.create_api_key
• Added operation OrganizationOperations.delete_cluster_api_key
• Added operation OrganizationOperations.get_cluster_api_key
• Added operation OrganizationOperations.get_cluster_by_id
• Added operation OrganizationOperations.get_environment_by_id
• Added operation OrganizationOperations.get_schema_registry_cluster_by_id
• Added operation OrganizationOperations.list_clusters
• Added operation OrganizationOperations.list_environments
• Added operation OrganizationOperations.list_regions
• Added operation OrganizationOperations.list_schema_registry_clusters

2.0.0 (2023-11-20)

Features Added

• Added operation group AccessOperations
• Added operation group ValidationsOperations
• Model ConfluentAgreementResource has a new parameter system_data
• Model OfferDetail has a new parameter private_offer_id
• Model OfferDetail has a new parameter private_offer_ids
• Model OfferDetail has a new parameter term_id
• Model OrganizationResource has a new parameter link_organization
• Model OrganizationResource has a new parameter system_data
• Model UserDetail has a new parameter aad_email
• Model UserDetail has a new parameter user_principal_name

Breaking Changes

• Parameter email_address of model UserDetail is now required
• Parameter id of model OfferDetail is now required
• Parameter offer_detail of model OrganizationResource is now required
• Parameter plan_id of model OfferDetail is now required
• Parameter plan_name of model OfferDetail is now required
• Parameter publisher_id of model OfferDetail is now required
• Parameter term_unit of model OfferDetail is now required
• Parameter user_detail of model OrganizationResource is now required

2.0.0b2 (2022-11-02)

Features Added

• Added operation group ValidationsOperations
• Model ConfluentAgreementResource has a new parameter system_data
• Model OrganizationResource has a new parameter system_data

Breaking Changes

• Parameter email_address of model UserDetail is now required
• Parameter id of model OfferDetail is now required
• Parameter offer_detail of model OrganizationResource is now required
• Parameter plan_id of model OfferDetail is now required
• Parameter plan_name of model OfferDetail is now required
• Parameter publisher_id of model OfferDetail is now required
• Parameter term_unit of model OfferDetail is now required
• Parameter user_detail of model OrganizationResource is now required

2.0.0b1 (2021-05-24)

Features

• Model ConfluentAgreementResource has a new parameter system_data
• Model OrganizationResource has a new parameter system_data
• Added operation group ValidationsOperations

Breaking changes

• Parameter offer_detail of model OrganizationResource is now required
• Parameter user_detail of model OrganizationResource is now required
• Parameter email_address of model UserDetail is now required
• Parameter plan_name of model OfferDetail is now required
• Parameter term_unit of model OfferDetail is now required
• Parameter plan_id of model OfferDetail is now required
• Parameter publisher_id of model OfferDetail is now required
• Parameter id of model OfferDetail is now required

1.0.0 (2021-01-18)

Features

• Model OperationResult has a new parameter is_data_action

Breaking changes

• Operation MarketplaceAgreementsOperations.create has a new signature
• Operation OrganizationOperations.update has a new signature
• Model ConfluentAgreementResource has a new signature

1.0.0b1 (2020-11-23)

• Initial Release