Azure SDK for Python 中使用 send_request 方法发送自定义请求-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00210/article/details/148508154

Azure SDK for Python 中使用 send_request 方法发送自定义请求

azure-sdk-for-python This repository is for active development of the Azure SDK for Python. For consumers of the SDK we recommend visiting our public developer docs at https://docs.microsoft.com/python/azure/ or our versioned developer docs at https://azure.github.io/azure-sdk-for-python. 项目地址: https://gitcode.com/gh_mirrors/az/azure-sdk-for-python

前言

在开发云服务应用时，我们经常需要与各种 RESTful API 进行交互。Azure SDK for Python 提供了一种灵活的方式，允许开发者直接构建和发送自定义 HTTP 请求。本文将详细介绍如何使用 send_request 方法来实现这一功能。

什么是 send_request 方法

send_request 是 Azure SDK for Python 客户端类中提供的一个核心方法，它允许开发者：

构建自定义的 HTTP 请求
通过已认证的客户端发送请求
处理服务返回的响应

这种方法特别适合以下场景：

需要调用 SDK 尚未封装的 API 端点
需要发送非标准格式的请求
需要对请求和响应进行更精细的控制

准备工作

在使用 send_request 方法前，需要先初始化客户端并进行身份认证。以下是基本设置：

from azure.identity import DefaultAzureCredential
from azure.example.service import ExampleClient

# 初始化客户端
client = ExampleClient(
    endpoint="https://www.example.org/",
    credential=DefaultAzureCredential()
)

构建 HTTP 请求

Azure SDK 提供了 HttpRequest 类来帮助构建请求。以下是构建请求的基本方法：

from azure.core.rest import HttpRequest

# 构建 GET 请求示例
request = HttpRequest(
    method="GET",
    url="/api/resource",  # 相对路径，会附加到客户端 endpoint
    params={"param1": "value1"}  # 查询参数
)

# 构建 POST 请求示例
request = HttpRequest(
    method="POST",
    url="/api/resource",
    json={"key": "value"},  # JSON 请求体
    headers={"Custom-Header": "value"}  # 自定义头
)

请求参数说明

method: HTTP 方法 (GET, POST, PUT, DELETE 等)
url: 可以是相对路径或完整 URL
json: 自动序列化为 JSON 的请求体
data: 原始请求体数据
params: URL 查询参数
headers: 自定义请求头

发送请求

构建好请求后，可以通过客户端的 send_request 方法发送：

response = client.send_request(request)

处理响应

send_request 返回的是 HttpResponse 对象，它提供了多种方法来处理响应：

基本响应处理

# 获取响应状态码
status_code = response.status_code

# 获取响应头
content_type = response.headers["Content-Type"]

# 获取响应文本内容
text_content = response.text()

# 获取二进制内容
binary_content = response.content

JSON 响应处理

如果响应是 JSON 格式，可以直接解析：

json_data = response.json()

错误处理

默认情况下，send_request 不会自动抛出异常，需要手动检查：

from azure.core.exceptions import HttpResponseError

try:
    response.raise_for_status()  # 如果状态码表示错误，抛出异常
    # 处理成功响应
    data = response.json()
except HttpResponseError as error:
    print(f"请求失败: {error}")

完整示例

同步客户端示例

from azure.identity import DefaultAzureCredential
from azure.example.service import ExampleClient
from azure.core.rest import HttpRequest
from azure.core.exceptions import HttpResponseError

# 初始化客户端
client = ExampleClient(
    endpoint="https://example.org",
    credential=DefaultAzureCredential()
)

# 构建请求
request = HttpRequest(
    method="POST",
    url="/api/data",
    json={"name": "Azure SDK", "version": "1.0.0"},
    params={"verbose": "true"}
)

# 发送请求并处理响应
try:
    response = client.send_request(request)
    response.raise_for_status()
    
    result = response.json()
    print(f"操作成功: {result}")
    
except HttpResponseError as error:
    print(f"请求失败: {error}")

异步客户端示例

from azure.identity.aio import DefaultAzureCredential
from azure.example.service.aio import ExampleClient
from azure.core.rest import HttpRequest
from azure.core.exceptions import HttpResponseError

async def main():
    # 初始化客户端
    client = ExampleClient(
        endpoint="https://example.org",
        credential=DefaultAzureCredential()
    )
    
    # 构建请求
    request = HttpRequest(
        method="GET",
        url="/api/status",
        params={"detail": "full"}
    )
    
    try:
        # 发送请求
        response = await client.send_request(request)
        await response.raise_for_status()
        
        # 处理响应
        data = await response.json()
        print(f"获取状态成功: {data}")
        
    except HttpResponseError as error:
        print(f"请求失败: {error}")
    finally:
        await client.close()

高级主题

日志记录

为了调试目的，可以启用客户端的详细日志记录：

client = ExampleClient(
    endpoint="https://example.org",
    credential=DefaultAzureCredential(),
    logging_enable=True  # 启用详细日志
)

这将记录请求和响应的详细信息，包括头信息和正文内容。