azure-mgmt-relay 2.0.0

Microsoft Azure Relay Management Client Library for Python

Microsoft Azure SDK for Python

This is the Microsoft Azure Relay 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-relay
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.relay import RelayAPIMgmtClient
import os

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

Examples

Code samples for this package can be found at:

• Search Relay 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-29)

Features Added

• Model AuthorizationRule added property location
• Model AuthorizationRule added property system_data
• Model HybridConnection added property location
• Model HybridConnection added property system_data
• Model Operation added property action_type
• Model Operation added property is_data_action
• Model Operation added property origin
• Model OperationDisplay added property description
• Model RelayNamespace added property system_data
• Model RelayUpdateParameters added property system_data
• Model Resource added property system_data
• Model ResourceNamespacePatch added property system_data
• Model TrackedResource added property system_data
• Model WcfRelay added property location
• Model WcfRelay added property system_data
• Added enum ActionType
• Added model ConnectionState
• Added enum CreatedByType
• Added enum DefaultAction
• Added enum EndPointProvisioningState
• Added model ErrorAdditionalInfo
• Added model NWRuleSetIpRules
• Added enum NetworkRuleIPAction
• Added model NetworkRuleSet
• Added model NetworkRuleSetProperties
• Added enum Origin
• Added model PrivateEndpoint
• Added model PrivateEndpointConnection
• Added model PrivateEndpointConnectionProperties
• Added enum PrivateLinkConnectionStatus
• Added model PrivateLinkResource
• Added model PrivateLinkResourceProperties
• Added model PrivateLinkResourcesListResult
• Added model ProxyResource
• Added enum PublicNetworkAccess
• Added enum SkuName
• Added enum SkuTier
• Added model SystemData
• Operation group NamespacesOperations added method create_or_update_network_rule_set
• Operation group NamespacesOperations added method get_network_rule_set
• Added operation group PrivateEndpointConnectionsOperations
• Added operation group PrivateLinkResourcesOperations

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.
• Renamed client RelayAPI to RelayAPIMgmtClient
• Model AuthorizationRule moved instance variable rights under property properties whose type is AuthorizationRuleProperties
• Model ErrorResponse moved instance variable code and message under property error whose type is ErrorDetail
• Model HybridConnection moved instance variable created_at, updated_at, listener_count, requires_client_authorization and user_metadata under property properties whose type is HybridConnectionProperties
• Model RelayNamespace moved instance variable provisioning_state, created_at, updated_at, service_bus_endpoint and metric_id under property properties whose type is RelayNamespaceProperties
• Model RelayUpdateParameters moved instance variable provisioning_state, created_at, updated_at, service_bus_endpoint and metric_id under property properties whose type is RelayNamespaceProperties
• Model WcfRelay moved instance variable is_dynamic, created_at, updated_at, listener_count, relay_type, requires_client_authorization, requires_transport_security and user_metadata under property properties whose type is WcfRelayProperties
• Deleted or renamed enum ProvisioningStateEnum

Other Changes

• Deleted model AuthorizationRuleListResult/HybridConnectionListResult/OperationListResult/RelayNamespaceListResult/WcfRelaysListResult which actually were not used by SDK users

2.0.0b2 (2026-07-06)

Features Added

• Model Operation added property action_type
• Model PrivateLinkResource added property system_data
• Model ProxyResource added property system_data
• Model RelayUpdateParameters added property system_data
• Model Resource added property system_data
• Model ResourceNamespacePatch added property system_data
• Model TrackedResource added property system_data
• Added enum ActionType
• Added enum Origin

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.
• Renamed client RelayAPI to RelayAPIMgmtClient
• Model AuthorizationRule moved instance variable rights under property properties whose type is AuthorizationRuleProperties
• Model HybridConnection moved instance variable created_at, updated_at, listener_count, requires_client_authorization and user_metadata under property properties whose type is HybridConnectionProperties
• Model NetworkRuleSet moved instance variable default_action, public_network_access and ip_rules under property properties whose type is NetworkRuleSetProperties
• Model Operation deleted or renamed its instance variable properties
• Model PrivateEndpointConnection moved instance variable private_endpoint, private_link_service_connection_state and provisioning_state under property properties whose type is PrivateEndpointConnectionProperties
• Model PrivateLinkResource moved instance variable group_id, required_members and required_zone_names under property properties whose type is PrivateLinkResourceProperties
• Model ProxyResource deleted or renamed its instance variable location
• Model RelayNamespace moved instance variable provisioning_state, status, created_at, updated_at, service_bus_endpoint, metric_id, private_endpoint_connections and public_network_access under property properties whose type is RelayNamespaceProperties
• Model RelayUpdateParameters moved instance variable provisioning_state, status, created_at, updated_at, service_bus_endpoint, metric_id, private_endpoint_connections and public_network_access under property properties whose type is RelayNamespaceProperties
• Model WcfRelay moved instance variable is_dynamic, created_at, updated_at, listener_count, relay_type, requires_client_authorization, requires_transport_security and user_metadata under property properties whose type is WcfRelayProperties

Other Changes

• Deleted model AuthorizationRuleListResult/HybridConnectionListResult/OperationListResult/PrivateEndpointConnectionListResult/RelayNamespaceListResult/WcfRelaysListResult which actually were not used by SDK users

1.1.1 (2026-05-09)

Other Changes

• Regenerated with latest code generator tool

2.0.0b1 (2022-11-08)

Features Added

• Added operation NamespacesOperations.create_or_update_network_rule_set
• Added operation NamespacesOperations.get_network_rule_set
• Added operation group PrivateEndpointConnectionsOperations
• Added operation group PrivateLinkResourcesOperations
• Model AuthorizationRule has a new parameter location
• Model AuthorizationRule has a new parameter system_data
• Model ErrorResponse has a new parameter error
• Model HybridConnection has a new parameter location
• Model HybridConnection has a new parameter system_data
• Model Operation has a new parameter is_data_action
• Model Operation has a new parameter origin
• Model Operation has a new parameter properties
• Model OperationDisplay has a new parameter description
• Model RelayNamespace has a new parameter private_endpoint_connections
• Model RelayNamespace has a new parameter public_network_access
• Model RelayNamespace has a new parameter status
• Model RelayNamespace has a new parameter system_data
• Model RelayUpdateParameters has a new parameter private_endpoint_connections
• Model RelayUpdateParameters has a new parameter public_network_access
• Model RelayUpdateParameters has a new parameter status
• Model WcfRelay has a new parameter location
• Model WcfRelay has a new parameter system_data

Breaking Changes

• Model ErrorResponse no longer has parameter code
• Model ErrorResponse no longer has parameter message

1.1.0 (2021-09-06)

Features

• generated by new autorest

1.0.0 (2020-12-22)

• GA release

1.0.0b1 (2020-10-28)

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.2.0 (2019-05-16)

Note

• azure-mgmt-nspkg is not installed anymore on Python 3 (PEP420-based namespace package)

Features

• Client class can be used as a context manager to keep the underlying HTTP session open for performance

General Breaking changes

This version uses a next-generation code generator that might introduce 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#others At a glance:
  • "is" should not be used at all.
  • "format" will return the string value, where "%s" string formatting will return NameOfEnum.stringvalue. Format syntax should be prefered.
• New Long Running Operation:
  • Return type changes from msrestazure.azure_operation.AzureOperationPoller to msrest.polling.LROPoller. External API is the same.
  • Return type is now always a msrest.polling.LROPoller, regardless of the optional parameters used.
  • The behavior has changed when using raw=True. Instead of returning the initial call result as ClientRawResponse, without polling, now this returns an LROPoller. After polling, the final resource will be returned as a ClientRawResponse.
  • New polling parameter. The default behavior is Polling=True which will poll using ARM algorithm. When Polling=False, the response of the initial call will be returned without polling.
  • polling parameter accepts instances of subclasses of msrest.polling.PollingMethod.
  • add_done_callback will no longer raise if called after polling is finished, but will instead execute the callback right away.

Bugfixes

• Compatibility of the sdist with wheel 0.31.0

0.1.0 (2018-05-02)

• Initial Release