Microsoft Azure SDK for Python

这是Microsoft Azure SignalR客户端库。此包已在Python 3.7+上进行了测试。有关Azure库的更完整视图，请参阅azure sdk python发布。

免责声明

Azure SDK Python包对Python 2.7的支持已于2022年1月1日结束。有关更多信息问题，请参阅https://github.com/Azure/azure-sdk-for-python/issues/20691

入门

先决条件

• 使用此包需要Python 3.7+。
• Azure订阅

安装包

pip install azure-mgmt-signalr
pip install azure-identity

身份验证

默认情况下，Azure Active Directory令牌身份验证依赖于以下环境变量的正确配置。

• AZURE_CLIENT_ID 用于 Azure 客户端 ID。
• AZURE_TENANT_ID 用于 Azure 租户 ID。
• AZURE_CLIENT_SECRET 用于 Azure 客户端密钥。

此外，可以通过环境变量 AZURE_SUBSCRIPTION_ID 配置 Azure 订阅 ID。

以上配置后，可以通过以下代码进行客户端认证

from azure.identity import DefaultAzureCredential
from azure.mgmt.signalr import SignalRManagementClient
import os

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

示例

此包的代码示例可在 SignalR 上找到，网址为 docs.microsoft.com，以及 示例存储库

故障排除

下一步

提供反馈

如果您遇到任何错误或有建议，请在项目的 问题 部分提交问题。

版本历史

1.2.0 (2023-03-20)

新增功能

• SignalRResource 模型新增参数 serverless

1.2.0b1 (2022-11-15)

新增功能

• SignalRResource 模型新增参数 serverless

1.1.0 (2022-03-28)

新增功能

• 添加了 SignalRCustomCertificatesOperations 操作组
• 添加了 SignalRCustomDomainsOperations 操作组
• SignalRResource 模型新增参数 live_trace_configuration

1.0.0 (2021-11-01)

新增功能

• SignalRResource 模型新增参数 disable_aad_auth
• SignalRResource 模型新增参数 host_name_prefix
• SignalRResource 模型新增参数 resource_log_configuration
• SignalRResource 模型新增参数 disable_local_auth
• SignalRResource 模型新增参数 public_network_access
• PrivateEndpointConnection 模型新增参数 group_ids
• 添加了 SignalROperations.list_skus 操作

1.0.0b2 (2021-05-20)

新增功能

• SignalRResource 模型新增参数 shared_private_link_resources
• SignalRResource 模型新增参数 system_data
• PrivateLinkResource 模型新增参数 shareable_private_link_resource_types
• PrivateEndpointConnection 模型新增参数 system_data
• 添加了 SignalRPrivateEndpointConnectionsOperations.list 操作
• 添加了 SignalRSharedPrivateLinkResourcesOperations 操作组

1.0.0b1 (2020-12-02)

这是测试预览版。

此版本使用下一代代码生成器，引入了重要的破坏性更改，但也引入了重要的新功能（如统一身份验证和异步编程）。

一般破坏性更改

• 凭据系统已被完全重写

  • azure.common.credentials 或 msrestazure.azure_active_directory 实例不再受支持，请使用 azure-identity 类：[https://pypi.ac.cn/project/azure-identity/](https://pypi.ac.cn/project/azure-identity/)
  • credentials 参数已被重命名为 credential

• 客户端上的 config 属性不再存在，配置应作为 kwarg 传递。例如：`MyClient(credential, subscription_id, enable_logging=True)`。有关支持选项的完整集合，请参阅 azure-core 初始化文档中的参数接受

• 现在不能再导入 version 模块了，请使用 __version__ 代替

• 曾经返回 msrest.polling.LROPoller 的操作现在返回 azure.core.polling.LROPoller，并带有前缀 begin_。

• 异常树已被简化，大多数异常现在都是 azure.core.exceptions.HttpResponseError（已删除 CloudError）。

• 大多数操作 kwarg 都已更改。以下是一些最引人注目的更改

  • raw 已被删除。等效功能可以通过使用 cls 找到，这是一个回调，将提供对内部 HTTP 响应的访问，适用于高级用户
  • 有关支持选项的完整集合，请参阅 azure-core 请求文档中的参数接受

一般新功能

• 支持使用 typing 的类型注解。SDKs 已准备好 mypy。
• 此客户端现在具有稳定且官方的异步支持。检查您的包中的 aio 命名空间以找到异步客户端。
• 此客户端现在原生支持 OpenCensus 或 OpenTelemetry 等跟踪库。请参阅此 跟踪快速入门 以获取概述。

0.4.0 (2020-05-29)

新增功能

• ServiceSpecification 模型新增参数 log_specifications
• 模型 SignalRResource 新增参数 network_ac_ls
• 模型 SignalRResource 新增参数 upstream
• 模型 SignalRResource 新增参数 private_endpoint_connections
• 模型 SignalRResource 新增参数 kind
• 模型 Operation 新增参数 is_data_action
• 模型 SignalRCreateOrUpdateProperties 新增参数 upstream
• 模型 SignalRCreateOrUpdateProperties 新增参数 network_ac_ls
• 新增操作组 SignalRPrivateEndpointConnectionsOperations
• 新增操作组 SignalRPrivateLinkResourcesOperations

一般性重大变更

本版本使用下一代代码生成器，可能会引入重大变更。总之，一些模块被错误地可见或可导入，并已重命名。这解决了由于使用本来不应该使用的类而引起的一些问题。

• 无法从 azure.mgmt.signalr.signalr_client 导入 SignalRClient（从 azure.mgmt.signalr 导入与之前一样工作）
• SignalRClientConfiguration 的导入已从 azure.mgmt.signalr.signalr_client 移至 azure.mgmt.signalr
• 从 "models" 子模块的模型 MyClass 无法使用 azure.mgmt.signalr.models.my_class 导入（从 azure.mgmt.signalr.models 导入与之前一样工作）
• 从 operations 子模块的操作类 MyClassOperations 无法使用 azure.mgmt.signalr.operations.my_class_operations 导入（从 azure.mgmt.signalr.operations 导入与之前一样工作）

最后但同样重要的是，HTTP 连接池现在默认启用。您应始终将客户端作为上下文管理器使用，或调用 close()，或每个进程使用不超过一个客户端。

0.3.0 (2019-08-06)

新增功能

• 模型 SignalRResource 新增参数 cors
• 模型 SignalRResource 新增参数 features
• 模型 SignalRCreateOrUpdateProperties 新增参数 cors
• 模型 SignalRCreateOrUpdateProperties 新增参数 feature

0.2.0 (2019-05-21)

• 添加重启操作

0.1.1 (2018-09-04)

新增功能

• 模型 SignalRKeys 新增参数 secondary_connection_string
• 模型 SignalRKeys 新增参数 primary_connection_string
• 模型 MetricSpecification 新增参数 dimensions
• 模型 SignalRResource 新增参数 version
• 添加 UsagesOperations 操作组

0.1.0 (2018-05-07)

• 初始发布