通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Apps - Update

服务:
IoT Central
API 版本:
2021-06-01

更新 IoT Central 应用程序的元数据。

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTCentral/iotApps/{resourceName}?api-version=2021-06-01

URI 参数

名称 在 必需 类型 说明
resourceGroupName
 path True

string

包含 IoT Central 应用程序的资源组的名称。
resourceName
 path True

string

IoT Central 应用程序的 ARM 资源名称。
subscriptionId
 path True

string

订阅标识符。
api-version
 query True

string

API 的版本。

请求正文

名称 类型 说明
identity

SystemAssignedServiceIdentity

IoT Central 应用程序的托管标识。
properties.displayName

string

应用程序的显示名称。
properties.subdomain

string

应用程序的子域。
properties.template

string

应用程序模板的 ID，它是一个蓝图，用于定义应用程序的特征和行为。 自选;如果未指定，则默认为空白蓝图，并允许从头开始定义应用程序。
sku

AppSkuInfo

有效的实例 SKU。
tags

object

实例标记

响应

名称 类型 说明
200 OK

App

这是作为对创建或更新作的状态轮询请求的响应返回的。 正文包含指示过渡性预配状态的资源表示形式。
202 Accepted

已接受 - 接受请求;作将以异步方式完成。
Other Status Codes

CloudError

DefaultErrorResponse

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

Apps_Update

示例请求

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.IoTCentral/iotApps/myIoTCentralApp?api-version=2021-06-01

{
  "properties": {
    "displayName": "My IoT Central App 2"
  },
  "identity": {
    "type": "SystemAssigned"
  }
}

示例响应

状态代码:
200 
code: 200
message: OK
target: ResourceHandler.ExecutePatchRequest
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.IoTCentral/IoTApps/myIoTCentralApp",
  "location": "westus",
  "type": "Microsoft.IoTCentral/IoTApps",
  "name": "myIoTCentralApp",
  "tags": {
    "key": "value"
  },
  "properties": {
    "applicationId": "6ebd8fd3-6e34-419e-908f-9be61ec6f6d6",
    "displayName": "My IoT Central App 2",
    "subdomain": "my-iot-central-app-2",
    "template": "iotc-pnp-preview@1.0.0",
    "state": "created"
  },
  "sku": {
    "name": "ST2"
  },
  "identity": {
    "type": "SystemAssigned",
    "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd",
    "principalId": "8988ab15-3e7a-4586-8a1c-ed07a73a53e9"
  }
}
状态代码:
202
状态代码:
default 
{
  "error": {
    "code": "Error code",
    "message": "Error message",
    "target": "Error target"
  }
}

定义

名称 说明
App

IoT Central 应用程序。
AppPatch

IoT Central 应用程序的说明。
AppSku

SKU 的名称。
AppSkuInfo

有关 IoT Central 应用程序的 SKU 的信息。
AppState

应用程序的当前状态。
CloudError

错误详细信息。
CloudErrorBody

错误响应的详细信息。
SystemAssignedServiceIdentity

托管服务标识（系统分配或无）
SystemAssignedServiceIdentityType

托管服务标识的类型（系统分配或无）。

App

Object

IoT Central 应用程序。

名称 类型 说明
id

string

ARM 资源标识符。
identity

SystemAssignedServiceIdentity

IoT Central 应用程序的托管标识。
location

string

资源位置。
name

string

pattern: ^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,99}[a-zA-Z0-9]$

ARM 资源名称。
properties.applicationId

string

应用程序的 ID。
properties.displayName

string

应用程序的显示名称。
properties.state

AppState

应用程序的当前状态。
properties.subdomain

string

应用程序的子域。
properties.template

string

应用程序模板的 ID，它是一个蓝图，用于定义应用程序的特征和行为。 自选;如果未指定，则默认为空白蓝图，并允许从头开始定义应用程序。
sku

AppSkuInfo

有效的实例 SKU。
tags

object

资源标记。
type

string

资源类型。

AppPatch

Object

IoT Central 应用程序的说明。

名称 类型 说明
identity

SystemAssignedServiceIdentity

IoT Central 应用程序的托管标识。
properties.applicationId

string

应用程序的 ID。
properties.displayName

string

应用程序的显示名称。
properties.state

AppState

应用程序的当前状态。
properties.subdomain

string

应用程序的子域。
properties.template

string

应用程序模板的 ID，它是一个蓝图，用于定义应用程序的特征和行为。 自选;如果未指定，则默认为空白蓝图，并允许从头开始定义应用程序。
sku

AppSkuInfo

有效的实例 SKU。
tags

object

实例标记

AppSku

枚举

SKU 的名称。

值 说明
ST0
ST1
ST2

AppSkuInfo

Object

有关 IoT Central 应用程序的 SKU 的信息。

名称 类型 说明
name

AppSku

SKU 的名称。

AppState

枚举

应用程序的当前状态。

值 说明
created
suspended

CloudError

Object

错误详细信息。

名称 类型 说明
error.code

string

错误代码。
error.details

CloudErrorBody[]

有关错误的其他详细信息的列表。
error.message

string

错误消息。
error.target

string

特定错误的目标。

CloudErrorBody

Object

错误响应的详细信息。

名称 类型 说明
code

string

错误代码。
details

CloudErrorBody[]

有关错误的其他详细信息的列表。
message

string

错误消息。
target

string

特定错误的目标。

SystemAssignedServiceIdentity

Object

托管服务标识（系统分配或无）

名称 类型 说明
principalId

string (uuid)

系统分配标识的服务主体 ID。 此属性仅针对系统分配的标识提供。
tenantId

string (uuid)

系统分配标识的租户 ID。 此属性仅针对系统分配的标识提供。
type

SystemAssignedServiceIdentityType

托管服务标识的类型（系统分配或无）。

SystemAssignedServiceIdentityType

枚举

托管服务标识的类型（系统分配或无）。

值 说明
None
SystemAssigned