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

Apps - List By Resource Group

获取资源组中的所有 IoT Central 应用程序。

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

URI 参数

Name In Required Type Description
resourceGroupName
path True
  • string

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

subscriptionId
path True
  • string

订阅标识符。

api-version
query True
  • string

API 的版本。

响应

Name Type Description
200 OK

这是同步操作。 正文包含资源组中所有 IoT Central 应用程序的元数据的 JSON 序列化数组。

Other Status Codes

DefaultErrorResponse

安全性

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation 模拟用户帐户

示例

Apps_ListByResourceGroup

Sample Request

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

Sample Response

Code: 200
{
  "value": [
    {
      "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",
        "subdomain": "my-iot-central-app",
        "template": "iotc-pnp-preview@1.0.0",
        "state": "created",
        "publicNetworkAccess": "Enabled",
        "networkRuleSets": {
          "applyToDevices": true,
          "applyToIoTCentral": false,
          "defaultAction": "Deny",
          "ipRules": [
            {
              "filterName": "My Computer",
              "ipMask": "21.19.35.40/24"
            }
          ]
        },
        "privateEndpointConnections": [
          {
            "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.IoTCentral/iotApps/myIoTCentralApp/PrivateEndpointConnections/myIoTCentralAppEndpoint.a791c6b5-874d-4f03-9092-718490d33770",
            "name": "myIoTCentralAppEndpoint.a791c6b5-874d-4f03-9092-718490d33770",
            "type": "Microsoft.IoTCentral/iotApps/privateEndpointConnections",
            "properties": {
              "groupIds": [
                "iotApp"
              ],
              "privateEndpoint": {
                "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/privateEndpoints/myIoTCentralAppEndpoint"
              },
              "privateLinkServiceConnectionState": {
                "status": "Approved",
                "description": "Auto-approved",
                "actionsRequired": "None"
              }
            }
          }
        ]
      },
      "sku": {
        "name": "F1"
      },
      "identity": {
        "type": "SystemAssigned",
        "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd",
        "principalId": "8988ab15-3e7a-4586-8a1c-ed07a73a53e9"
      }
    }
  ],
  "nextLink": null
}

定义

App

IoT Central 应用程序。

AppListResult

包含下一个链接的 IoT Central 应用程序列表。

AppSku

SKU 的名称。

AppSkuInfo

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

AppState

应用程序的当前状态。

createdByType

创建资源的标识的类型。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

IpRuleAction

IP 掩码的网络操作。

NetworkAction

是允许还是拒绝网络流量。

NetworkRuleSetIpRule

将允许访问的 IP 范围的对象。

NetworkRuleSets

此 IoT Central 应用程序的网络规则集属性。

PrivateEndpoint

专用终结点资源。

PrivateEndpointConnection

专用终结点连接资源。

PrivateEndpointConnectionProvisioningState

当前预配状态。

PrivateEndpointServiceConnectionStatus

专用终结点连接状态。

PrivateLinkServiceConnectionState

有关服务使用者与提供程序之间的连接状态的信息集合。

ProvisioningState

应用程序的预配状态。

PublicNetworkAccess

是否允许来自公共网络的请求。

SystemAssignedServiceIdentity

托管服务标识 (分配的系统或无)

SystemAssignedServiceIdentityType

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

systemData

与创建和上次修改资源相关的元数据。

App

IoT Central 应用程序。

Name Type Default Value Description
id
  • string

资源的完全限定的资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

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

location
  • string

资源所在的地理位置

name
  • string

资源的名称

properties.applicationId
  • string

应用程序的 ID。

properties.displayName
  • string

应用程序的显示名称。

properties.networkRuleSets

此 IoT Central 应用程序的网络规则集属性。

properties.privateEndpointConnections

在此 IoT Central 应用程序上创建的专用终结点连接。

properties.provisioningState

应用程序的预配状态。

properties.publicNetworkAccess Enabled

是否允许来自公共网络的请求。

properties.state

应用程序的当前状态。

properties.subdomain
  • string

应用程序的子域。

properties.template
  • string

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

sku

有效的实例 SKU。

systemData

Azure 资源管理器包含 createdBy 和 modifiedBy 信息的元数据。

tags
  • object

资源标记。

type
  • string

资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft”。存储/storageAccounts”

AppListResult

包含下一个链接的 IoT Central 应用程序列表。

Name Type Description
nextLink
  • string

用于获取 IoT Central 应用程序的下一页的链接。

value

IoT Central 应用程序列表。

AppSku

SKU 的名称。

Name Type Description
ST0
  • string
ST1
  • string
ST2
  • string

AppSkuInfo

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

Name Type Description
name

SKU 的名称。

AppState

应用程序的当前状态。

Name Type Description
created
  • string
suspended
  • string

createdByType

创建资源的标识的类型。

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

ErrorAdditionalInfo

资源管理错误附加信息。

Name Type Description
info
  • object

其他信息。

type
  • string

其他信息类型。

ErrorDetail

错误详细信息。

Name Type Description
additionalInfo

错误附加信息。

code
  • string

错误代码。

details

错误详细信息。

message
  • string

错误消息。

target
  • string

错误目标。

ErrorResponse

错误响应

Name Type Description
error

错误对象。

IpRuleAction

IP 掩码的网络操作。

Name Type Description
Allow
  • string

NetworkAction

是允许还是拒绝网络流量。

Name Type Description
Allow
  • string
Deny
  • string

NetworkRuleSetIpRule

将允许访问的 IP 范围的对象。

Name Type Description
action

IP 掩码的网络操作。

filterName
  • string

IP 规则的可读名称。

ipMask
  • string

定义 IP 范围的 CIDR 块。

NetworkRuleSets

此 IoT Central 应用程序的网络规则集属性。

Name Type Default Value Description
applyToDevices
  • boolean
false

这些规则是否适用于与此应用程序关联的IoT 中心和设备预配服务的设备连接。

applyToIoTCentral
  • boolean
false

这些规则是否适用于通过 IoT Central Web 门户和 API 建立连接。

defaultAction Allow

要应用的默认网络操作。

ipRules

IP 规则列表。

PrivateEndpoint

专用终结点资源。

Name Type Description
id
  • string

专用终结点的 ARM 标识符。

PrivateEndpointConnection

专用终结点连接资源。

Name Type Description
id
  • string

资源的完全限定的资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name
  • string

资源的名称

properties.groupIds
  • string[]

专用终结点资源的组 ID。

properties.privateEndpoint

专用终结点资源。

properties.privateLinkServiceConnectionState

有关服务使用者与提供程序之间的连接状态的信息集合。

properties.provisioningState

专用终结点连接资源的预配状态。

systemData

Azure 资源管理器包含 createdBy 和 modifiedBy 信息的元数据。

type
  • string

资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft”。存储/storageAccounts”

PrivateEndpointConnectionProvisioningState

当前预配状态。

Name Type Description
Creating
  • string
Deleting
  • string
Failed
  • string
Succeeded
  • string

PrivateEndpointServiceConnectionStatus

专用终结点连接状态。

Name Type Description
Approved
  • string
Pending
  • string
Rejected
  • string

PrivateLinkServiceConnectionState

有关服务使用者与提供程序之间的连接状态的信息集合。

Name Type Description
actionsRequired
  • string

一条消息,指示服务提供商上的更改是否需要对使用者进行任何更新。

description
  • string

批准/拒绝连接的原因。

status

指示连接是否已由服务的所有者批准/拒绝/删除。

ProvisioningState

应用程序的预配状态。

Name Type Description
Canceled
  • string
Creating
  • string
Deleting
  • string
Failed
  • string
Succeeded
  • string
Updating
  • string

PublicNetworkAccess

是否允许来自公共网络的请求。

Name Type Description
Disabled
  • string
Enabled
  • string

SystemAssignedServiceIdentity

托管服务标识 (分配的系统或无)

Name Type Description
principalId
  • string

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

tenantId
  • string

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

type

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

SystemAssignedServiceIdentityType

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

Name Type Description
None
  • string
SystemAssigned
  • string

systemData

与创建和上次修改资源相关的元数据。

Name Type Description
createdAt
  • string

资源创建时间戳 (UTC) 。

createdBy
  • string

创建资源的标识。

createdByType

创建资源的标识的类型。

lastModifiedAt
  • string

资源上次修改的时间戳 (UTC)

lastModifiedBy
  • string

上次修改资源的标识。

lastModifiedByType

上次修改资源的标识的类型。