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

Applications - Get

获取指定应用程序的属性。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/applications/{applicationName}?api-version=2021-06-01

URI 参数

Name In Required Type Description
applicationName
path True
  • string

应用程序名称的常量值。

clusterName
path True
  • string

群集的名称。

resourceGroupName
path True
  • string

资源组的名称。

subscriptionId
path True
  • string

唯一标识Microsoft Azure订阅的订阅凭据。 此订阅 ID 是每个服务调用的 URI 的一部分。

api-version
query True
  • string

HDInsight 客户端 API 版本。

响应

Name Type Description
200 OK

没问题。 请求已成功。

Other Status Codes

描述操作失败原因的错误响应。

安全性

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 模拟用户帐户

示例

Get application on HDInsight cluster creation in progress
Get application on HDInsight cluster successfully created.

Get application on HDInsight cluster creation in progress

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/applications/app?api-version=2021-06-01

Sample Response

{
  "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/applications/app",
  "name": "app",
  "type": "Microsoft.HDInsight/clusters/applications",
  "etag": "2C128F8E-BB26-4637-99E4-18EBC39FD51F",
  "tags": {
    "key1": "val1"
  },
  "properties": {
    "computeProfile": {
      "roles": [
        {
          "name": "edgenode",
          "targetInstanceCount": 1,
          "hardwareProfile": {
            "vmSize": "Standard_D3"
          }
        }
      ]
    },
    "installScriptActions": [
      {
        "name": "app-Install",
        "uri": "https://app.com/azure/app_install.sh",
        "roles": [
          "edgenode"
        ]
      }
    ],
    "uninstallScriptActions": [],
    "httpsEndpoints": [
      {
        "accessModes": [
          "WebPage"
        ],
        "location": "location",
        "destinationPort": 18630,
        "publicPort": 443
      }
    ],
    "sshEndpoints": [],
    "provisioningState": "InProgress",
    "applicationState": "AzureVMConfiguration",
    "createdDate": "2017-03-28T02:01:25.107",
    "applicationType": "CustomApplication",
    "marketplaceIdentifier": "id"
  }
}

Get application on HDInsight cluster successfully created.

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/applications/app?api-version=2021-06-01

Sample Response

{
  "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/applications/app",
  "name": "app",
  "type": "Microsoft.HDInsight/clusters/applications",
  "etag": "CF938302-6B4D-44A0-A6D2-C0D67E847AEC",
  "tags": {
    "key1": "val1"
  },
  "properties": {
    "computeProfile": {
      "roles": [
        {
          "name": "edgenode",
          "targetInstanceCount": 1,
          "hardwareProfile": {
            "vmSize": "Standard_D12_v2"
          }
        }
      ]
    },
    "installScriptActions": [
      {
        "name": "app-install",
        "uri": "http://app.com/public/hdi-app/20170301/app-install.sh",
        "roles": [
          "edgenode"
        ]
      }
    ],
    "uninstallScriptActions": [],
    "httpsEndpoints": [
      {
        "accessModes": [
          "WebPage"
        ],
        "location": "https://cluster1.apps.azurehdinsight.net:443",
        "destinationPort": 20000,
        "publicPort": 443
      }
    ],
    "sshEndpoints": [
      {
        "location": "cluster1-ssh.azurehdinsight.net:22",
        "destinationPort": 22,
        "publicPort": 22
      }
    ],
    "provisioningState": "Succeeded",
    "applicationState": "Running",
    "createdDate": "2017-03-22T21:34:39.293",
    "applicationType": "CustomApplication",
    "marketplaceIdentifier": "appMarketId"
  }
}

定义

Application

HDInsight 群集应用程序

ApplicationGetEndpoint

获取应用程序 SSH 终结点

ApplicationGetHttpsEndpoint

获取应用程序 HTTP 终结点。

ApplicationProperties

HDInsight 群集应用程序 GET 响应。

Autoscale

自动缩放请求参数

AutoscaleCapacity

基于负载的自动缩放请求参数

AutoscaleRecurrence

基于计划的自动缩放请求参数

AutoscaleSchedule

基于计划的自动缩放规则的参数,包括天数数组 + 时间和容量

AutoscaleTimeAndCapacity

时间和容量请求参数

ComputeProfile

描述计算配置文件。

createdByType

创建资源的标识的类型。

DataDisksGroups

角色的数据磁盘组。

ErrorResponse

描述错误响应的格式。

Errors

与群集创建关联的错误消息。

HardwareProfile

硬件配置文件。

IPConfiguration

专用链接服务的 IP 配置。

LinuxOperatingSystemProfile

ssh 用户名、密码和 ssh 公钥。

OsProfile

Linux 操作系统配置文件。

PrivateIPAllocationMethod

分配专用 IP 地址的方法。

PrivateLinkConfiguration

专用链接配置。

PrivateLinkConfigurationProvisioningState

专用链接配置预配状态,该状态仅在响应中显示。

ResourceId

Azure 资源 ID。

Role

描述群集上的角色。

RuntimeScriptAction

描述正在运行的群集上的脚本操作。

ScriptAction

介绍群集上角色的脚本操作。

SshProfile

SSH 公钥列表。

SshPublicKey

群集节点的 SSH 公钥。

systemData

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

VirtualNetworkProfile

虚拟网络属性。

Application

HDInsight 群集应用程序

Name Type Description
etag
  • string

应用程序的 ETag

id
  • string

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

name
  • string

资源的名称

properties

应用程序的属性。

systemData

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

tags
  • object

应用程序的标记。

type
  • string

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

ApplicationGetEndpoint

获取应用程序 SSH 终结点

Name Type Description
destinationPort
  • integer

要连接到的目标端口。

location
  • string

终结点的位置。

privateIPAddress
  • string

终结点的专用 IP 地址。

publicPort
  • integer

要连接到的公共端口。

ApplicationGetHttpsEndpoint

获取应用程序 HTTP 终结点。

Name Type Description
accessModes
  • string[]

应用程序的访问模式列表。

destinationPort
  • integer

要连接到的目标端口。

disableGatewayAuth
  • boolean

该值指示是否禁用 GatewayAuth。

location
  • string

终结点的位置。

privateIPAddress
  • string

终结点的专用 IP 地址。

publicPort
  • integer

要连接到的公共端口。

subDomainSuffix
  • string

应用程序的子域后缀。

ApplicationProperties

HDInsight 群集应用程序 GET 响应。

Name Type Description
applicationState
  • string

应用程序状态。

applicationType
  • string

应用程序类型。

computeProfile

群集中的角色列表。

createdDate
  • string

应用程序创建日期时间。

errors

错误列表。

httpsEndpoints

应用程序 HTTPS 终结点的列表。

installScriptActions

安装脚本操作的列表。

marketplaceIdentifier
  • string

市场标识符。

privateLinkConfigurations

专用链接配置。

provisioningState
  • string

应用程序的预配状态。

sshEndpoints

应用程序 SSH 终结点的列表。

uninstallScriptActions

卸载脚本操作的列表。

Autoscale

自动缩放请求参数

Name Type Description
capacity

基于负载的自动缩放的参数

recurrence

基于计划的自动缩放的参数

AutoscaleCapacity

基于负载的自动缩放请求参数

Name Type Description
maxInstanceCount
  • integer

群集的最大实例计数

minInstanceCount
  • integer

群集的最小实例计数

AutoscaleRecurrence

基于计划的自动缩放请求参数

Name Type Description
schedule

基于计划的自动缩放规则的数组

timeZone
  • string

自动缩放计划时间的时区

AutoscaleSchedule

基于计划的自动缩放规则的参数,包括天数数组 + 时间和容量

Name Type Description
days
  • string[]

基于计划的自动缩放规则的一周中的天数

timeAndCapacity

基于计划的自动缩放规则的时间和容量

AutoscaleTimeAndCapacity

时间和容量请求参数

Name Type Description
maxInstanceCount
  • integer

群集的最大实例计数

minInstanceCount
  • integer

群集的最小实例计数

time
  • string

格式为 xx:xx 的 24 小时时间

ComputeProfile

描述计算配置文件。

Name Type Description
roles

群集中的角色列表。

createdByType

创建资源的标识的类型。

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

DataDisksGroups

角色的数据磁盘组。

Name Type Description
diskSizeGB
  • integer

ReadOnly。 DiskSize(以 GB 为单位)。 不要设置此值。

disksPerNode
  • integer

每个节点的磁盘数。

storageAccountType
  • string

ReadOnly。 存储帐户类型。 不要设置此值。

ErrorResponse

描述错误响应的格式。

Name Type Description
code
  • string

错误代码

message
  • string

指示操作失败的原因的错误消息。

Errors

与群集创建关联的错误消息。

Name Type Description
code
  • string

错误代码。

message
  • string

错误消息。

HardwareProfile

硬件配置文件。

Name Type Description
vmSize
  • string

VM 的大小

IPConfiguration

专用链接服务的 IP 配置。

Name Type Description
id
  • string

专用链接 IP 配置 ID。

name
  • string

专用链接 IP 配置的名称。

properties.primary
  • boolean

指示此 IP 配置是否是相应 NIC 的主要配置。

properties.privateIPAddress
  • string

IP 地址。

properties.privateIPAllocationMethod

分配专用 IP 地址的方法。

properties.provisioningState

专用链接配置预配状态,该状态仅在响应中显示。

properties.subnet

子网资源 ID。

type
  • string

专用链接 IP 配置的类型。

LinuxOperatingSystemProfile

ssh 用户名、密码和 ssh 公钥。

Name Type Description
password
  • string

密码。

sshProfile

SSH 配置文件。

username
  • string

用户名。

OsProfile

Linux 操作系统配置文件。

Name Type Description
linuxOperatingSystemProfile

Linux OS 配置文件。

PrivateIPAllocationMethod

分配专用 IP 地址的方法。

Name Type Description
dynamic
  • string
static
  • string

PrivateLinkConfiguration

专用链接配置。

Name Type Description
id
  • string

专用链接配置 ID。

name
  • string

专用链接配置的名称。

properties.groupId
  • string

要向其应用专用链接配置的 HDInsight 专用可链接子资源名称。 例如,“headnode”、“gateway”、“edgenode”。

properties.ipConfigurations

专用链接服务的 IP 配置。

properties.provisioningState

专用链接配置预配状态,该状态仅在响应中显示。

type
  • string

专用链接配置的类型。

PrivateLinkConfigurationProvisioningState

专用链接配置预配状态,该状态仅在响应中显示。

Name Type Description
Canceled
  • string
Deleting
  • string
Failed
  • string
InProgress
  • string
Succeeded
  • string

ResourceId

Azure 资源 ID。

Name Type Description
id
  • string

Azure 资源 ID。

Role

描述群集上的角色。

Name Type Default Value Description
VMGroupName
  • string

虚拟机组的名称。

autoscale

自动缩放配置。

dataDisksGroups

角色的数据磁盘组。

encryptDataDisks
  • boolean
False

指示是否加密数据磁盘。

hardwareProfile

硬件配置文件。

minInstanceCount
  • integer

群集的最小实例计数。

name
  • string

角色的名称。

osProfile

操作系统配置文件。

scriptActions

角色上的脚本操作列表。

targetInstanceCount
  • integer

群集的实例计数。

virtualNetworkProfile

虚拟网络配置文件。

RuntimeScriptAction

描述正在运行的群集上的脚本操作。

Name Type Description
applicationName
  • string

脚本操作的应用程序名称(如果有)。

name
  • string

脚本操作的名称。

parameters
  • string

脚本的参数

roles
  • string[]

将执行脚本的角色列表。

uri
  • string

脚本的 URI。

ScriptAction

介绍群集上角色的脚本操作。

Name Type Description
name
  • string

脚本操作的名称。

parameters
  • string

提供的脚本的参数。

uri
  • string

脚本的 URI。

SshProfile

SSH 公钥列表。

Name Type Description
publicKeys

SSH 公钥列表。

SshPublicKey

群集节点的 SSH 公钥。

Name Type Description
certificateData
  • string

SSH 证书。

systemData

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

Name Type Description
createdAt
  • string

资源创建时间戳 (UTC) 。

createdBy
  • string

创建资源的标识。

createdByType

创建资源的标识的类型。

lastModifiedAt
  • string

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

lastModifiedBy
  • string

上次修改资源的标识。

lastModifiedByType

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

VirtualNetworkProfile

虚拟网络属性。

Name Type Description
id
  • string

虚拟网络的 ID。

subnet
  • string

子网的名称。