Azure Resource Manager
Azure 资源管理器公开用于管理所有 Azure 资源的 API。
此连接器在以下产品和区域中可用:
| 服务 | Class | 区域 |
|---|---|---|
| Copilot Studio | 高级 | 所有 Power Automate 区域 |
| 逻辑应用程序 | 标准 | 所有 逻辑应用区域 |
| Power Apps | 高级 | 所有 Power Apps 区域 |
| Power Automate | 高级 | 所有 Power Automate 区域 |
| 联系人 | |
|---|---|
| Name | Microsoft |
| URL |
Microsoft LogicApps 支持 Microsoft Power Automate 支持 Microsoft Power Apps 支持 |
| 连接器元数据 | |
|---|---|
| 发布者 | Microsoft |
| 网站 | https://azure.microsoft.com/features/resource-manager/ |
已知问题和限制
- 如果出现错误消息 “在 APIM 令牌标头中找不到连接引用名称”shared_office365“的任何有效连接,可以通过执行以下作进行故障排除:
- 清除浏览器的缓存。
- 删除连接,然后重新添加。
- 列表订阅资源标记作可能会拉取已删除的标记数据,因为基础服务中管理标记数据的限制。
- 解决方法是使用 Azure Resource Graph(https://learn.microsoft.com/en-us/rest/api/azureresourcegraph/resourcegraph/resources/resources?view=rest-azureresourcegraph-resourcegraph-2022-10-01&tabs=HTTP) 使用 Http 连接器进行调用。
- 根据设计,Power Automate 中的 ARM 连接器不支持 Azure Key Vault 机密的直接用户角色分配。
正在创建连接
连接器支持以下身份验证类型:
| 默认 | 用于创建连接的参数。 | 所有区域 | 不可共享 |
违约
适用:所有区域
用于创建连接的参数。
这是不可共享的连接。 如果 Power App 与另一个用户共享,系统会提示其他用户显式创建新连接。
限制
| 名称 | 调用 | 续订期 |
|---|---|---|
| 每个连接的 API 调用数 | 1200 | 60 秒 |
操作
| 列出模板部署 |
列出所有资源组模板部署。 此作可用于了解到目前为止已预配的内容。 |
| 列出模板部署作 |
列出所有模板部署作。 这对于排查失败的模板部署问题非常有用。 |
| 列出订阅 |
获取主体有权访问的所有订阅的列表。 |
| 列出订阅位置 |
列出可用于订阅的位置。 |
| 列出订阅资源标记 |
列出所有订阅资源标记。 |
| 列出资源提供程序 |
列出可用于订阅的资源提供程序。 |
| 列出资源组 |
列出订阅中的所有资源组。 结果分页为 1,000 多个记录。 |
| 创建或更新模板部署 |
创建或更新命名的资源组模板部署。 请求成功需要模板和参数。 |
| 创建或更新订阅资源标记值 |
创建或更新订阅资源标记值。 |
| 创建或更新订阅资源标记名称 |
创建或更新订阅资源标记名称。 |
| 创建或更新资源 |
创建或更新资源。 响应代码可用于区分创建(201)或更新(200)。 |
| 创建或更新资源组 |
创建或更新资源组。 响应代码可用于区分创建(201)或更新(200)。 |
| 删除模板部署 |
删除资源组模板部署。 不会删除资源;仅有关模板部署的元数据。 |
| 删除订阅资源标记值 |
删除订阅资源标记值。 |
| 删除订阅资源标记名称 |
删除订阅资源标记名称。 |
| 删除资源 |
删除资源。 |
| 删除资源组 |
删除订阅中的特定资源组。 |
| 取消模板部署 |
取消当前正在运行的模板部署。 所有挂起的模板作都将挂起。 |
| 在提供程序中调用资源作 |
对 Azure 资源调用作。 |
| 导出资源组模板 |
从现有资源组导出部署模板。 仅当基础资源具有由Microsoft定义的架构时,才能成功。 |
| 导出部署模板 |
从过去的资源组部署导出模板。 |
| 按订阅列出资源 |
读取特定订阅下的所有资源。 结果分页为 1,000 多个记录。 |
| 按资源组列出资源 |
列出资源组下的所有资源。 |
| 更新现有资源组 |
更新现有资源组。 如果资源不存在,此请求将失败。 |
| 注册资源提供程序 |
注册要用于订阅的资源提供程序。 这会将服务的权限预配到订阅中。 |
| 注销资源提供程序 |
从订阅中注销提供程序。 如果订阅中存在来自该资源提供程序的任何资源,此作将失败。 |
| 读取提供程序中的资源 |
读取资源对象。 |
| 读取模板部署 |
读取资源组中的模板部署。 |
| 读取模板部署作 |
读取特定的资源组模板部署作。 这对于排查失败的模板部署问题非常有用。 |
| 读取订阅 |
读取特定订阅的详细信息。 |
| 读取资源 |
读取资源对象。 |
| 读取资源提供程序 |
读取订阅中的特定资源提供程序。 |
| 读取资源组 |
读取订阅中的特定资源组。 |
| 调用资源作 |
对 Azure 资源调用作。 |
| 验证模板部署 |
验证部署模板。 此作没有副作用,可用于测试模板部署的语法或逻辑错误。 |
列出模板部署
列出所有资源组模板部署。 此作可用于了解到目前为止已预配的内容。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Subscription
|
subscriptionId | True | string |
Microsoft Azure 订阅的唯一标识符。 订阅 ID 构成了每个 Azure 资源的 ID 的一部分。 |
|
资源组
|
resourceGroupName | True | string |
资源组名称。 |
|
过滤器
|
$filter | string |
要应用于作的筛选器。 |
|
|
Top
|
$top | integer |
查询参数。 如果未传递任何值,则返回所有值。 |
返回
部署列表。
- Body
- DeploymentListResult
列出模板部署作
列出所有模板部署作。 这对于排查失败的模板部署问题非常有用。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Subscription
|
subscriptionId | True | string |
Microsoft Azure 订阅的唯一标识符。 订阅 ID 构成了每个 Azure 资源的 ID 的一部分。 |
|
资源组
|
resourceGroupName | True | string |
资源组名称。 |
|
部署名称
|
deploymentName | True | string |
资源组模板部署的名称。 |
|
Top
|
$top | integer |
查询参数。 如果未传递任何值,则返回所有值。 |
返回
部署作列表。
列出订阅
列出订阅位置
列出可用于订阅的位置。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Subscription
|
subscriptionId | True | string |
Microsoft Azure 订阅的唯一标识符。 订阅 ID 构成了每个 Azure 资源的 ID 的一部分。 |
返回
位置列表作响应。
- Body
- LocationListResult
列出订阅资源标记
列出所有订阅资源标记。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Subscription
|
subscriptionId | True | string |
Microsoft Azure 订阅的唯一标识符。 订阅 ID 构成了每个 Azure 资源的 ID 的一部分。 |
返回
订阅标记列表。
- Body
- TagsListResult
列出资源提供程序
列出可用于订阅的资源提供程序。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Subscription
|
subscriptionId | True | string |
Microsoft Azure 订阅的唯一标识符。 订阅 ID 构成了每个 Azure 资源的 ID 的一部分。 |
|
Top
|
$top | integer |
查询参数。 如果未传递任何值,则返回所有值。 |
|
|
展开
|
$expand | string |
$expand查询参数。 |
返回
资源提供程序列表。
- Body
- ProviderListResult
列出资源组
列出订阅中的所有资源组。 结果分页为 1,000 多个记录。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Subscription
|
subscriptionId | True | string |
Microsoft Azure 订阅的唯一标识符。 订阅 ID 构成了每个 Azure 资源的 ID 的一部分。 |
|
过滤器
|
$filter | string |
要应用于作的筛选器。 |
|
|
Top
|
$top | integer |
查询参数。 如果未传递任何值,则返回所有值。 |
返回
资源组列表。
创建或更新模板部署
创建或更新命名的资源组模板部署。 请求成功需要模板和参数。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Subscription
|
subscriptionId | True | string |
Microsoft Azure 订阅的唯一标识符。 订阅 ID 构成了每个 Azure 资源的 ID 的一部分。 |
|
资源组
|
resourceGroupName | True | string |
资源组名称。 |
|
部署名称
|
deploymentName | True | string |
部署的名称。 |
|
模板内容
|
template | object |
模板内容。 它可以是 JObject 或格式良好的 JSON 字符串。 仅使用模板或 TemplateLink 之一。 |
|
|
模板 URI
|
uri | True | string |
引用模板的 URI。 |
|
模板内容版本
|
contentVersion | string |
如果包含它必须与模板中的 ContentVersion 匹配。 |
|
|
参数
|
parameters | object |
部署参数。 它可以是 JObject 或格式良好的 JSON 字符串。 仅使用一个 Parameters 或 ParametersLink。 |
|
|
参数 URI
|
uri | True | string |
引用模板的 URI。 |
|
参数内容版本
|
contentVersion | string |
如果包含它必须与模板中的 ContentVersion 匹配。 |
|
|
部署模式
|
mode | True | string |
部署模式。 |
|
详细信息级别
|
detailLevel | string |
调试详细信息级别。 |
|
|
等待部署
|
wait | boolean |
如果作应等到部署完成 |
返回
部署信息。
- Body
- DeploymentExtended
创建或更新订阅资源标记值
创建或更新订阅资源标记值。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Subscription
|
subscriptionId | True | string |
Microsoft Azure 订阅的唯一标识符。 订阅 ID 构成了每个 Azure 资源的 ID 的一部分。 |
|
标记名称
|
tagName | True | string |
标签的名称。 |
|
标记值
|
tagValue | True | string |
标记的值。 |
返回
标记信息。
- Body
- TagValue
创建或更新订阅资源标记名称
创建或更新订阅资源标记名称。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Subscription
|
subscriptionId | True | string |
Microsoft Azure 订阅的唯一标识符。 订阅 ID 构成了每个 Azure 资源的 ID 的一部分。 |
|
标记名称
|
tagName | True | string |
标签的名称。 |
返回
标记详细信息。
- Body
- TagDetails
创建或更新资源
创建或更新资源。 响应代码可用于区分创建(201)或更新(200)。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Subscription
|
subscriptionId | True | string |
Microsoft Azure 订阅的唯一标识符。 订阅 ID 构成了每个 Azure 资源的 ID 的一部分。 |
|
资源组
|
resourceGroupName | True | string |
资源组名称。 |
|
资源提供商
|
resourceProviderNamespace | True | string |
资源提供程序的命名空间。 |
|
短资源 ID
|
shortResourceId | True | string |
资源的短 ID,包括资源名称和资源类型。 例如,sites/mySite |
|
客户端 API 版本
|
x-ms-api-version | True | string |
要使用的 Api 版本。 |
|
Id
|
id | string |
资源 ID |
|
|
Name
|
name | string |
资源名称 |
|
|
类型
|
type | string |
资源类型 |
|
|
位置
|
location | string |
资源位置 |
|
|
标记
|
tags | object |
资源标记 |
|
|
Id
|
name | string |
计划 ID。 |
|
|
发布者
|
publisher | string |
发布者 ID。 |
|
|
产品
|
product | string |
产品/服务 ID。 |
|
|
促销代码
|
promotionCode | string |
促销代码。 |
|
|
种类
|
kind | string |
资源的种类。 |
|
|
管理者
|
managedBy | string |
管理此资源的资源的 ID。 |
|
|
Name
|
name | string |
SKU 名称。 |
|
|
层
|
tier | string |
SKU 层。 |
|
|
尺寸
|
size | string |
SKU 大小。 |
|
|
家庭
|
family | string |
SKU 系列。 |
|
|
型号
|
model | string |
SKU 模型。 |
|
|
Capacity
|
capacity | integer |
SKU 容量。 |
|
|
主体 ID
|
principalId | string |
资源标识的主体 ID。 |
|
|
租户 ID
|
tenantId | string |
资源的租户 ID。 |
|
|
类型
|
type | string |
标识类型。 |
|
|
属性
|
properties | object |
资源属性。 |
返回
资源信息。
- Body
- GenericResource
创建或更新资源组
创建或更新资源组。 响应代码可用于区分创建(201)或更新(200)。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Subscription
|
subscriptionId | True | string |
Microsoft Azure 订阅的唯一标识符。 订阅 ID 构成了每个 Azure 资源的 ID 的一部分。 |
|
资源组名称
|
resourceGroupName | True | string |
要创建或更新的资源组的名称。 |
|
Id
|
id | string |
资源组的 ID(例如 /subscriptions/XXX/resourceGroups/YYY)。 |
|
|
Name
|
name | string |
资源组的名称。 |
|
|
位置
|
location | True | string |
资源组的位置。 创建资源组后,无法更改它。 必须是受支持的 Azure 位置之一,例如美国西部、美国东部、西欧、东亚等。 |
|
管理者
|
managedBy | string |
管理此资源组的资源的 ID。 |
|
|
标记
|
tags | object |
附加到资源组的标记。 |
|
|
预配状态
|
provisioningState | string |
预配状态。 |
返回
资源组信息。
- Body
- ResourceGroup
删除模板部署
删除资源组模板部署。 不会删除资源;仅有关模板部署的元数据。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Subscription
|
subscriptionId | True | string |
Microsoft Azure 订阅的唯一标识符。 订阅 ID 构成了每个 Azure 资源的 ID 的一部分。 |
|
资源组
|
resourceGroupName | True | string |
资源组名称。 |
|
部署名称
|
deploymentName | True | string |
资源组模板部署的名称。 |
删除订阅资源标记值
删除订阅资源标记值。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Subscription
|
subscriptionId | True | string |
Microsoft Azure 订阅的唯一标识符。 订阅 ID 构成了每个 Azure 资源的 ID 的一部分。 |
|
标记名称
|
tagName | True | string |
标签的名称。 |
|
标记值
|
tagValue | True | string |
标记的值。 |
删除订阅资源标记名称
删除订阅资源标记名称。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Subscription
|
subscriptionId | True | string |
Microsoft Azure 订阅的唯一标识符。 订阅 ID 构成了每个 Azure 资源的 ID 的一部分。 |
|
标记名称
|
tagName | True | string |
标签的名称。 |
删除资源
删除资源。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Subscription
|
subscriptionId | True | string |
Microsoft Azure 订阅的唯一标识符。 订阅 ID 构成了每个 Azure 资源的 ID 的一部分。 |
|
资源组
|
resourceGroupName | True | string |
资源组名称。 |
|
资源提供商
|
resourceProviderNamespace | True | string |
资源提供程序的命名空间。 |
|
短资源 ID
|
shortResourceId | True | string |
资源的短 ID,包括资源名称和资源类型。 例如,sites/mySite |
|
客户端 API 版本
|
x-ms-api-version | True | string |
要使用的 Api 版本。 |
删除资源组
删除订阅中的特定资源组。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Subscription
|
subscriptionId | True | string |
Microsoft Azure 订阅的唯一标识符。 订阅 ID 构成了每个 Azure 资源的 ID 的一部分。 |
|
资源组
|
resourceGroupName | True | string |
资源组名称。 |
取消模板部署
取消当前正在运行的模板部署。 所有挂起的模板作都将挂起。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Subscription
|
subscriptionId | True | string |
Microsoft Azure 订阅的唯一标识符。 订阅 ID 构成了每个 Azure 资源的 ID 的一部分。 |
|
资源组
|
resourceGroupName | True | string |
资源组名称。 |
|
部署名称
|
deploymentName | True | string |
资源组模板部署的名称。 |
在提供程序中调用资源作
对 Azure 资源调用作。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Subscription
|
subscriptionId | True | string |
Microsoft Azure 订阅的唯一标识符。 订阅 ID 构成了每个 Azure 资源的 ID 的一部分。 |
|
资源提供商
|
resourceProviderNamespace | True | string |
资源提供程序的命名空间。 |
|
短资源 ID
|
shortResourceId | True | string |
资源的短 ID,包括资源名称和资源类型。 例如,sites/mySite |
|
客户端 API 版本
|
x-ms-api-version | True | string |
要使用的 Api 版本。 |
返回
作的响应。
- 响应
- object
导出资源组模板
从现有资源组导出部署模板。 仅当基础资源具有由Microsoft定义的架构时,才能成功。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Subscription
|
subscriptionId | True | string |
Microsoft Azure 订阅的唯一标识符。 订阅 ID 构成了每个 Azure 资源的 ID 的一部分。 |
|
资源组
|
resourceGroupName | True | string |
资源组名称。 |
|
资源
|
resources | array of string |
资源的 ID。 目前唯一受支持的字符串是“*”(所有资源)。 未来的 API 更新将支持导出特定资源。 |
|
|
options
|
options | string |
导出模板选项。 支持的值包括“IncludeParameterDefaultValue”、“IncludeComments”或“IncludeParameterDefaultValue,IncludeComments |
返回
导出部署模板
从过去的资源组部署导出模板。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Subscription
|
subscriptionId | True | string |
Microsoft Azure 订阅的唯一标识符。 订阅 ID 构成了每个 Azure 资源的 ID 的一部分。 |
|
资源组
|
resourceGroupName | True | string |
资源组名称。 |
|
部署名称
|
deploymentName | True | string |
资源组模板部署的名称。 |
返回
部署导出结果。
按订阅列出资源
读取特定订阅下的所有资源。 结果分页为 1,000 多个记录。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Subscription
|
subscriptionId | True | string |
Microsoft Azure 订阅的唯一标识符。 订阅 ID 构成了每个 Azure 资源的 ID 的一部分。 |
|
过滤器
|
$filter | string |
要应用于作的筛选器。 |
|
|
展开
|
$expand | string |
$expand查询参数。 |
|
|
Top
|
$top | integer |
查询参数。 如果未传递任何值,则返回所有值。 |
返回
资源列表。
- Body
- ResourceListResult
按资源组列出资源
列出资源组下的所有资源。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Subscription
|
subscriptionId | True | string |
Microsoft Azure 订阅的唯一标识符。 订阅 ID 构成了每个 Azure 资源的 ID 的一部分。 |
|
资源组
|
resourceGroupName | True | string |
资源组名称。 |
|
过滤器
|
$filter | string |
要应用于作的筛选器。 |
|
|
展开
|
$expand | string |
$expand查询参数。 |
|
|
Top
|
$top | integer |
查询参数。 如果未传递任何值,则返回所有值。 |
返回
资源列表。
- Body
- ResourceListResult
更新现有资源组
更新现有资源组。 如果资源不存在,此请求将失败。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Subscription
|
subscriptionId | True | string |
Microsoft Azure 订阅的唯一标识符。 订阅 ID 构成了每个 Azure 资源的 ID 的一部分。 |
|
资源组
|
resourceGroupName | True | string |
资源组名称。 |
|
Id
|
id | string |
资源组的 ID(例如 /subscriptions/XXX/resourceGroups/YYY)。 |
|
|
Name
|
name | string |
资源组的名称。 |
|
|
位置
|
location | True | string |
资源组的位置。 创建资源组后,无法更改它。 必须是受支持的 Azure 位置之一,例如美国西部、美国东部、西欧、东亚等。 |
|
管理者
|
managedBy | string |
管理此资源组的资源的 ID。 |
|
|
标记
|
tags | object |
附加到资源组的标记。 |
|
|
预配状态
|
provisioningState | string |
预配状态。 |
返回
资源组信息。
- Body
- ResourceGroup
注册资源提供程序
注册要用于订阅的资源提供程序。 这会将服务的权限预配到订阅中。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Subscription
|
subscriptionId | True | string |
Microsoft Azure 订阅的唯一标识符。 订阅 ID 构成了每个 Azure 资源的 ID 的一部分。 |
|
资源提供商
|
resourceProviderNamespace | True | string |
资源提供程序的命名空间。 |
返回
资源提供程序信息。
- Body
- Provider
注销资源提供程序
从订阅中注销提供程序。 如果订阅中存在来自该资源提供程序的任何资源,此作将失败。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Subscription
|
subscriptionId | True | string |
Microsoft Azure 订阅的唯一标识符。 订阅 ID 构成了每个 Azure 资源的 ID 的一部分。 |
|
资源提供商
|
resourceProviderNamespace | True | string |
资源提供程序的命名空间。 |
返回
资源提供程序信息。
- Body
- Provider
读取提供程序中的资源
读取资源对象。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Subscription
|
subscriptionId | True | string |
Microsoft Azure 订阅的唯一标识符。 订阅 ID 构成了每个 Azure 资源的 ID 的一部分。 |
|
资源提供商
|
resourceProviderNamespace | True | string |
资源提供程序的命名空间。 |
|
短资源 ID
|
shortResourceId | True | string |
资源的短 ID,包括资源名称和资源类型。 例如,sites/mySite |
|
客户端 API 版本
|
x-ms-api-version | True | string |
要使用的 Api 版本。 |
返回
资源信息。
- Body
- GenericResource
读取模板部署
读取资源组中的模板部署。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Subscription
|
subscriptionId | True | string |
Microsoft Azure 订阅的唯一标识符。 订阅 ID 构成了每个 Azure 资源的 ID 的一部分。 |
|
资源组
|
resourceGroupName | True | string |
资源组名称。 |
|
部署名称
|
deploymentName | True | string |
资源组模板部署的名称。 |
|
等待部署
|
wait | boolean |
如果作应等到部署完成 |
返回
部署信息。
- Body
- DeploymentExtended
读取模板部署作
读取特定的资源组模板部署作。 这对于排查失败的模板部署问题非常有用。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Subscription
|
subscriptionId | True | string |
Microsoft Azure 订阅的唯一标识符。 订阅 ID 构成了每个 Azure 资源的 ID 的一部分。 |
|
资源组
|
resourceGroupName | True | string |
资源组名称。 |
|
部署名称
|
deploymentName | True | string |
资源组模板部署的名称。 |
|
作 ID
|
operationId | True | string |
作 ID。 |
返回
部署作信息。
- Body
- DeploymentOperation
读取订阅
读取特定订阅的详细信息。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Subscription
|
subscriptionId | True | string |
Microsoft Azure 订阅的唯一标识符。 订阅 ID 构成了每个 Azure 资源的 ID 的一部分。 |
返回
订阅信息。
- Body
- Subscription
读取资源
读取资源对象。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Subscription
|
subscriptionId | True | string |
Microsoft Azure 订阅的唯一标识符。 订阅 ID 构成了每个 Azure 资源的 ID 的一部分。 |
|
资源组
|
resourceGroupName | True | string |
资源组名称。 |
|
资源提供商
|
resourceProviderNamespace | True | string |
资源提供程序的命名空间。 |
|
短资源 ID
|
shortResourceId | True | string |
资源的短 ID,包括资源名称和资源类型。 例如,sites/mySite |
|
客户端 API 版本
|
x-ms-api-version | True | string |
要使用的 Api 版本。 |
返回
资源信息。
- Body
- GenericResource
读取资源提供程序
读取订阅中的特定资源提供程序。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Subscription
|
subscriptionId | True | string |
Microsoft Azure 订阅的唯一标识符。 订阅 ID 构成了每个 Azure 资源的 ID 的一部分。 |
|
资源提供商
|
resourceProviderNamespace | True | string |
资源提供程序的命名空间。 |
|
展开
|
$expand | string |
$expand查询参数。 |
返回
资源提供程序信息。
- Body
- Provider
读取资源组
读取订阅中的特定资源组。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Subscription
|
subscriptionId | True | string |
Microsoft Azure 订阅的唯一标识符。 订阅 ID 构成了每个 Azure 资源的 ID 的一部分。 |
|
资源组
|
resourceGroupName | True | string |
资源组名称。 |
返回
资源组信息。
- Body
- ResourceGroup
调用资源作
对 Azure 资源调用作。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Subscription
|
subscriptionId | True | string |
Microsoft Azure 订阅的唯一标识符。 订阅 ID 构成了每个 Azure 资源的 ID 的一部分。 |
|
资源组
|
resourceGroupName | True | string |
资源组名称。 |
|
资源提供商
|
resourceProviderNamespace | True | string |
资源提供程序的命名空间。 |
|
短资源 ID
|
shortResourceId | True | string |
资源的短 ID,包括资源名称和资源类型。 例如,sites/mySite |
|
客户端 API 版本
|
x-ms-api-version | True | string |
要使用的 Api 版本。 |
|
操作名称
|
actionName | True | string |
要调用的资源作的名称 |
返回
作作的响应。
- 作响应
- object
验证模板部署
验证部署模板。 此作没有副作用,可用于测试模板部署的语法或逻辑错误。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Subscription
|
subscriptionId | True | string |
Microsoft Azure 订阅的唯一标识符。 订阅 ID 构成了每个 Azure 资源的 ID 的一部分。 |
|
资源组
|
resourceGroupName | True | string |
资源组名称。 |
|
部署名称
|
deploymentName | True | string |
资源组模板部署的名称。 |
|
模板内容
|
template | object |
模板内容。 它可以是 JObject 或格式良好的 JSON 字符串。 仅使用模板或 TemplateLink 之一。 |
|
|
模板 URI
|
uri | True | string |
引用模板的 URI。 |
|
模板内容版本
|
contentVersion | string |
如果包含它必须与模板中的 ContentVersion 匹配。 |
|
|
参数
|
parameters | object |
部署参数。 它可以是 JObject 或格式良好的 JSON 字符串。 仅使用一个 Parameters 或 ParametersLink。 |
|
|
参数 URI
|
uri | True | string |
引用模板的 URI。 |
|
参数内容版本
|
contentVersion | string |
如果包含它必须与模板中的 ContentVersion 匹配。 |
|
|
部署模式
|
mode | True | string |
部署模式。 |
|
详细信息级别
|
detailLevel | string |
调试详细信息级别。 |
返回
来自验证模板部署响应的信息。
定义
位置
位置信息。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Id
|
id | string |
位置的完全限定 ID。 例如,/subscriptions/00000000-0000-0000-0000-000000000000/locations/westus。 |
|
订阅 ID
|
subscriptionId | string |
订阅 ID。 |
|
位置名称
|
name | string |
位置名称。 |
|
显示名称
|
displayName | string |
位置的显示名称。 |
|
Latitude
|
latitude | string |
位置的纬度。 |
|
Longitude
|
longitude | string |
位置的经度。 |
LocationListResult
位置列表作响应。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
value
|
value | array of Location |
位置。 |
Subscription
订阅信息。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Id
|
id | string |
完全限定的 ID。例如,/subscriptions/00000000-0000-0000-0000-0000000000000。 |
|
订阅 ID
|
subscriptionId | string |
订阅 ID。 |
|
租户 ID
|
tenantId | string |
租户 ID。 |
|
显示名称
|
displayName | string |
订阅显示名称。 |
|
State
|
state | string |
订阅状态。 |
|
订阅策略
|
subscriptionPolicies | SubscriptionPolicies |
订阅策略。 |
|
授权源
|
authorizationSource | string |
请求的授权源。 有效值为旧版、RoleBased、Bypassed、Direct 和 Management 的一个或多个组合。 例如,“旧版,RoleBased”。 |
SubscriptionPolicies
订阅策略。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
位置放置 ID
|
locationPlacementId | string |
订阅位置放置 ID。ID 指示哪些区域对订阅可见。 例如,位置位置 ID 为 Public_2014-09-01 的订阅有权访问 Azure 公共区域。 |
|
配额 ID
|
quotaId | string |
订阅配额 ID。 |
|
支出限制
|
spendingLimit | string |
订阅支出限制。 |
SubscriptionListResult
订阅列表作响应。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
value
|
value | array of Subscription |
订阅。 |
|
下一个链接
|
nextLink | string |
用于获取下一组结果的 URL。 |
模板链接
表示对模板的引用的实体。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
模板 URI
|
uri | string |
引用模板的 URI。 |
|
模板内容版本
|
contentVersion | string |
如果包含它必须与模板中的 ContentVersion 匹配。 |
参数Link
表示对部署参数的引用的实体。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
参数 URI
|
uri | string |
引用模板的 URI。 |
|
参数内容版本
|
contentVersion | string |
如果包含它必须与模板中的 ContentVersion 匹配。 |
调试设置
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
详细信息级别
|
detailLevel | string |
调试详细信息级别。 |
DeploymentExportResult
部署导出结果。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Template
|
template | object |
模板内容。 |
ResourceManagementErrorWithDetails
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
代码
|
code | string |
从服务器返回的错误代码。 |
|
消息
|
message | string |
从服务器返回的错误消息。 |
|
目标
|
target | string |
错误的目标。 |
|
详情
|
details | array of object |
验证错误。 |
AliasPathType
别名的路径的类型。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
路径
|
path | string |
别名的路径。 |
|
api版本
|
apiVersions | array of string |
API 版本。 |
AliasType
别名类型。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
姓名
|
name | string |
别名。 |
|
路径
|
paths | array of AliasPathType |
别名的路径。 |
ProviderResourceType
资源提供程序管理的资源类型。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
resourceType
|
resourceType | string |
资源类型。 |
|
位置
|
locations | array of ObjectWithoutType |
可在其中创建此资源类型的位置的集合。 |
|
aliases
|
aliases | array of AliasType |
此资源类型支持的别名。 |
|
api版本
|
apiVersions | array of string |
API 版本。 |
|
属性
|
properties | object |
属性。 |
Provider
资源提供程序信息。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Id
|
id | string |
提供程序 ID。 |
|
Namespace
|
namespace | string |
提供程序的命名空间。 |
|
注册状态
|
registrationState | string |
提供程序的注册状态。 |
|
资源类型
|
resourceTypes | array of ProviderResourceType |
提供程序资源类型的集合。 |
BasicDependency
部署依赖项信息。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
id
|
id | string |
依赖项的 ID。 |
|
resourceType
|
resourceType | string |
依赖项资源类型。 |
|
resourceName
|
resourceName | string |
依赖项资源名称。 |
依赖项
部署依赖项信息。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
dependsOn
|
dependsOn | array of BasicDependency |
依赖项列表。 |
|
id
|
id | string |
依赖项的 ID。 |
|
resourceType
|
resourceType | string |
依赖项资源类型。 |
|
resourceName
|
resourceName | string |
依赖项资源名称。 |
DeploymentPropertiesExtended
具有更多详细信息的部署属性。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
provisioningState
|
provisioningState | string |
预配的状态。 |
|
correlationId
|
correlationId | string |
部署的相关 ID。 |
|
时间戳
|
timestamp | date-time |
模板部署的时间戳。 |
|
输出
|
outputs | object |
表示 deploymentoutput 的键/值对。 |
|
providers
|
providers | array of Provider |
部署所需的资源提供程序列表。 |
|
依赖关系
|
dependencies | array of Dependency |
部署依赖项的列表。 |
|
模板
|
template | object |
模板内容。 仅使用模板或 TemplateLink 之一。 |
|
template链接
|
templateLink | TemplateLink |
表示对模板的引用的实体。 |
|
parameters
|
parameters | object |
部署参数。 仅使用一个 Parameters 或 ParametersLink。 |
|
参数链接
|
parametersLink | ParametersLink |
表示对部署参数的引用的实体。 |
|
部署模式
|
mode | string |
部署模式。 |
|
调试设置
|
debugSetting | DebugSetting |
DeploymentValidateResult
来自验证模板部署响应的信息。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
错误
|
error | ResourceManagementErrorWithDetails | |
|
属性
|
properties | DeploymentPropertiesExtended |
具有更多详细信息的部署属性。 |
DeploymentExtended
部署信息。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Id
|
id | string |
部署的 ID。 |
|
Name
|
name | string |
部署的名称。 |
|
属性
|
properties | DeploymentPropertiesExtended |
具有更多详细信息的部署属性。 |
DeploymentListResult
部署列表。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
value
|
value | array of DeploymentExtended |
部署列表。 |
|
下一个链接
|
nextLink | string |
用于获取下一组结果的 URL。 |
ProviderListResult
资源提供程序列表。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
value
|
value | array of Provider |
资源提供程序的列表。 |
|
nextLink
|
nextLink | string |
用于获取下一组结果的 URL。 |
GenericResource
资源信息。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Id
|
id | string |
资源 ID |
|
Name
|
name | string |
资源名称 |
|
类型
|
type | string |
资源类型 |
|
位置
|
location | string |
资源位置 |
|
标记
|
tags | object |
资源标记 |
|
计划
|
plan | Plan |
规划资源。 |
|
种类
|
kind | string |
资源的种类。 |
|
管理者
|
managedBy | string |
管理此资源的资源的 ID。 |
|
SKU
|
sku | Sku |
资源的 SKU。 |
|
身份
|
identity | Identity |
资源的标识。 |
|
属性
|
properties | object |
资源属性。 |
计划
规划资源。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Id
|
name | string |
计划 ID。 |
|
发布者
|
publisher | string |
发布者 ID。 |
|
产品
|
product | string |
产品/服务 ID。 |
|
促销代码
|
promotionCode | string |
促销代码。 |
Sku
资源的 SKU。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Name
|
name | string |
SKU 名称。 |
|
层
|
tier | string |
SKU 层。 |
|
尺寸
|
size | string |
SKU 大小。 |
|
家庭
|
family | string |
SKU 系列。 |
|
型号
|
model | string |
SKU 模型。 |
|
Capacity
|
capacity | integer |
SKU 容量。 |
身份
资源的标识。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
主体 ID
|
principalId | string |
资源标识的主体 ID。 |
|
租户 ID
|
tenantId | string |
资源的租户 ID。 |
|
类型
|
type | string |
标识类型。 |
ResourceListResult
资源列表。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
value
|
value | array of GenericResource |
资源列表。 |
|
下一个链接
|
nextLink | string |
用于获取下一组结果的 URL。 |
ResourceGroup
资源组信息。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Id
|
id | string |
资源组的 ID(例如 /subscriptions/XXX/resourceGroups/YYY)。 |
|
Name
|
name | string |
资源组的名称。 |
|
位置
|
location | string |
资源组的位置。 创建资源组后,无法更改它。 必须是受支持的 Azure 位置之一,例如美国西部、美国东部、西欧、东亚等。 |
|
管理者
|
managedBy | string |
管理此资源组的资源的 ID。 |
|
标记
|
tags | object |
附加到资源组的标记。 |
|
属性
|
properties | ResourceGroupProperties |
资源组属性。 |
ResourceGroupProperties
资源组属性。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
预配状态
|
provisioningState | string |
预配状态。 |
ResourceGroupListResult
资源组列表。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
value
|
value | array of ResourceGroup |
资源组的列表。 |
|
下一个链接
|
nextLink | string |
用于获取下一组结果的 URL。 |
TagCount
标记计数。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
类型
|
type | string |
计数类型。 |
|
价值
|
value | integer |
计数值。 |
TagValue
标记信息。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
标记 ID
|
id | string |
标记 ID。 |
|
标记值
|
tagValue | string |
标记值。 |
|
标记计数
|
count | TagCount |
标记计数。 |
TagDetails
标记详细信息。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Id
|
id | string |
标记 ID。 |
|
Name
|
tagName | string |
标记名称。 |
|
标记计数
|
count | TagCount |
标记计数。 |
|
values
|
values | array of TagValue |
标记值的列表。 |
TagsListResult
订阅标记列表。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
value
|
value | array of TagDetails |
标记列表。 |
|
nextLink
|
nextLink | string |
用于获取下一组结果的 URL。 |
TargetResource
目标资源。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Id
|
id | string |
资源的 ID。 |
|
Name
|
resourceName | string |
资源的名称。 |
|
类型
|
resourceType | string |
资源类型。 |
HttpMessage
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
内容
|
content | object |
HTTP 消息内容。 |
DeploymentOperationProperties
部署作属性。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
provisioningState
|
provisioningState | string |
预配的状态。 |
|
时间戳
|
timestamp | date-time |
作的日期和时间。 |
|
serviceRequestId
|
serviceRequestId | string |
部署作服务请求 ID。 |
|
状态码
|
statusCode | string |
作状态代码。 |
|
statusMessage
|
statusMessage | object |
作状态消息。 |
|
目标资源
|
targetResource | TargetResource |
目标资源。 |
|
申请
|
request | HttpMessage | |
|
response
|
response | HttpMessage |
DeploymentOperation
部署作信息。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Id
|
id | string |
完整部署作 ID。 |
|
作 ID
|
operationId | string |
部署作 ID。 |
|
属性
|
properties | DeploymentOperationProperties |
部署作属性。 |
DeploymentOperationsListResult
部署作列表。
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
value
|
value | array of DeploymentOperation |
部署列表。 |
|
下一个链接
|
nextLink | string |
用于获取下一组结果的 URL。 |
ResourceGroupExportResult
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Template
|
template | object |
模板内容。 |
|
错误
|
error | ResourceManagementErrorWithDetails |
ObjectWithoutType
对象
这是类型“object”。