azure-mgmt-redhatopenshift 4.0.0

Microsoft Azure Redhatopenshift Management Client Library for Python

Microsoft Azure SDK for Python

This is the Microsoft Azure Red Hat Openshift 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-redhatopenshift
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.redhatopenshift import AzureRedHatOpenShiftClient
import os

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

Examples

Code samples for this package can be found at:

• Search Red Hat Openshift 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

4.0.0 (2026-07-13)

Features Added

• Client AzureRedHatOpenShiftClient added method send_request
• Added model CloudError

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 OpenShiftCluster moved instance variable apiserver_profile, cluster_profile, console_profile, ingress_profiles, master_profile, network_profile, platform_workload_identity_profile, provisioning_state, service_principal_profile, worker_profiles and worker_profiles_status under property properties whose type is OpenShiftClusterProperties
• Model OpenShiftClusterUpdate moved instance variable apiserver_profile, cluster_profile, console_profile, ingress_profiles, master_profile, network_profile, platform_workload_identity_profile, provisioning_state, service_principal_profile, worker_profiles and worker_profiles_status under property properties whose type is OpenShiftClusterProperties
• Model OpenShiftVersion moved instance variable version under property properties whose type is OpenShiftVersionProperties
• Model PlatformWorkloadIdentityRoleSet moved instance variable open_shift_version and platform_workload_identity_roles under property properties whose type is PlatformWorkloadIdentityRoleSetProperties

Other Changes

• Deleted model OpenShiftClusterList/OpenShiftVersionList/OperationList/PlatformWorkloadIdentityRoleSetList which actually were not used by SDK users

4.0.0b1 (2026-05-26)

Features Added

• Client AzureRedHatOpenShiftClient added method send_request
• Added model CloudError

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 OpenShiftClusterUpdate moved instance variable provisioning_state, cluster_profile, console_profile, service_principal_profile, platform_workload_identity_profile, network_profile, master_profile, worker_profiles, worker_profiles_status, apiserver_profile and ingress_profiles under property properties whose type is OpenShiftClusterProperties

Other Changes

• Deleted model OpenShiftClusterList/OpenShiftVersionList/OperationList/PlatformWorkloadIdentityRoleSetList which actually were not used by SDK users

3.0.0 (2026-02-06)

Features Added

• Model AzureRedHatOpenShiftClient added parameter cloud_setting in method __init__
• Client AzureRedHatOpenShiftClient added operation group platform_workload_identity_role_sets
• Client AzureRedHatOpenShiftClient added operation group platform_workload_identity_role_set
• Model ClusterProfile added property oidc_issuer
• Model OpenShiftCluster added property identity
• Model OpenShiftCluster added property platform_workload_identity_profile
• Model OpenShiftClusterUpdate added property identity
• Model OpenShiftClusterUpdate added property platform_workload_identity_profile
• Added model ManagedServiceIdentity
• Added enum ManagedServiceIdentityType
• Added model PlatformWorkloadIdentity
• Added model PlatformWorkloadIdentityProfile
• Added model PlatformWorkloadIdentityRole
• Added model PlatformWorkloadIdentityRoleSet
• Added model PlatformWorkloadIdentityRoleSetList
• Added model UserAssignedIdentity
• Added operation group PlatformWorkloadIdentityRoleSetOperations
• Added operation group PlatformWorkloadIdentityRoleSetsOperations

Breaking Changes

• Deleted or renamed client operation group AzureRedHatOpenShiftClient.machine_pools
• Deleted or renamed client operation group AzureRedHatOpenShiftClient.secrets
• Deleted or renamed client operation group AzureRedHatOpenShiftClient.sync_identity_providers
• Deleted or renamed client operation group AzureRedHatOpenShiftClient.sync_sets
• Model OpenShiftClusterUpdate deleted or renamed its instance variable system_data
• Deleted or renamed model MachinePool
• Deleted or renamed model MachinePoolList
• Deleted or renamed model MachinePoolUpdate
• Deleted or renamed model Secret
• Deleted or renamed model SecretList
• Deleted or renamed model SecretUpdate
• Deleted or renamed model SyncIdentityProvider
• Deleted or renamed model SyncIdentityProviderList
• Deleted or renamed model SyncIdentityProviderUpdate
• Deleted or renamed model SyncSet
• Deleted or renamed model SyncSetList
• Deleted or renamed model SyncSetUpdate
• Deleted or renamed operation group MachinePoolsOperations
• Deleted or renamed operation group SecretsOperations
• Deleted or renamed operation group SyncIdentityProvidersOperations
• Deleted or renamed operation group SyncSetsOperations

2.0.0 (2024-10-30)

Breaking Changes

• This package now only targets the latest Api-Version available on Azure and removes APIs of other Api-Version. After this change, the package can have much smaller size. If your application requires a specific and non-latest Api-Version, it's recommended to pin this package to the previous released version; If your application always only use latest Api-Version, please ignore this change.

1.5.0 (2024-07-22)

Features Added

• Model NetworkProfile has a new parameter load_balancer_profile

1.4.0 (2023-10-23)

Features Added

• Model NetworkProfile has a new parameter preconfigured_nsg
• Model OpenShiftCluster has a new parameter worker_profiles_status
• Model OpenShiftClusterUpdate has a new parameter worker_profiles_status

1.3.0 (2023-08-18)

Features Added

• Model NetworkProfile has a new parameter outbound_type

1.3.0b1 (2023-02-16)

Other Changes

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

1.2.0 (2023-01-17)

Features Added

• Added operation group MachinePoolsOperations
• Added operation group OpenShiftVersionsOperations
• Added operation group SecretsOperations
• Added operation group SyncIdentityProvidersOperations
• Added operation group SyncSetsOperations
• Model Resource has a new parameter system_data
• Model TrackedResource has a new parameter system_data

1.1.0 (2022-05-10)

Features

• Added operation OpenShiftClustersOperations.list_admin_credentials
• Model ClusterProfile has a new parameter fips_validated_modules
• Model MasterProfile has a new parameter disk_encryption_set_id
• Model MasterProfile has a new parameter encryption_at_host
• Model OpenShiftCluster has a new parameter system_data
• Model OpenShiftClusterUpdate has a new parameter system_data
• Model WorkerProfile has a new parameter disk_encryption_set_id
• Model WorkerProfile has a new parameter encryption_at_host

1.0.0 (2021-05-20)

• GA release

1.0.0b1 (2020-12-10)

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-03-28)

• Initial Release