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

Applications - Get

参考

Service:: HDInsight

API Version:: 2021-06-01

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

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

URI 参数

名称	在	必需	类型	说明
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 版本。

响应

名称	类型	说明
200 OK	Application	没问题。请求已成功。
Other Status Codes	ErrorResponse	描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

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

Scopes

名称	说明
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

import com.azure.core.util.Context;

/** Samples for Applications Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/GetApplicationInProgress.json
     */
    /**
     * Sample code: Get application on HDInsight cluster creation in progress.
     *
     * @param manager Entry point to HDInsightManager.
     */
    public static void getApplicationOnHDInsightClusterCreationInProgress(
        com.azure.resourcemanager.hdinsight.HDInsightManager manager) {
        manager.applications().getWithResponse("rg1", "cluster1", "app", Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential
from azure.mgmt.hdinsight import HDInsightManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-hdinsight
# USAGE
    python get_application_in_progress.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = HDInsightManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.applications.get(
        resource_group_name="rg1",
        cluster_name="cluster1",
        application_name="app",
    )
    print(response)


# x-ms-original-file: specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/GetApplicationInProgress.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armhdinsight_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hdinsight/armhdinsight"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/GetApplicationInProgress.json
func ExampleApplicationsClient_Get_getApplicationOnHdInsightClusterCreationInProgress() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armhdinsight.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewApplicationsClient().Get(ctx, "rg1", "cluster1", "app", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Application = armhdinsight.Application{
	// 	Name: to.Ptr("app"),
	// 	Type: to.Ptr("Microsoft.HDInsight/clusters/applications"),
	// 	ID: to.Ptr("/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/applications/app"),
	// 	Etag: to.Ptr("2C128F8E-BB26-4637-99E4-18EBC39FD51F"),
	// 	Properties: &armhdinsight.ApplicationProperties{
	// 		ApplicationState: to.Ptr("AzureVMConfiguration"),
	// 		ApplicationType: to.Ptr("CustomApplication"),
	// 		ComputeProfile: &armhdinsight.ComputeProfile{
	// 			Roles: []*armhdinsight.Role{
	// 				{
	// 					Name: to.Ptr("edgenode"),
	// 					HardwareProfile: &armhdinsight.HardwareProfile{
	// 						VMSize: to.Ptr("Standard_D3"),
	// 					},
	// 					TargetInstanceCount: to.Ptr[int32](1),
	// 			}},
	// 		},
	// 		CreatedDate: to.Ptr("2017-03-28T02:01:25.107"),
	// 		HTTPSEndpoints: []*armhdinsight.ApplicationGetHTTPSEndpoint{
	// 			{
	// 				AccessModes: []*string{
	// 					to.Ptr("WebPage")},
	// 					DestinationPort: to.Ptr[int32](18630),
	// 					Location: to.Ptr("location"),
	// 					PublicPort: to.Ptr[int32](443),
	// 			}},
	// 			InstallScriptActions: []*armhdinsight.RuntimeScriptAction{
	// 				{
	// 					Name: to.Ptr("app-Install"),
	// 					Roles: []*string{
	// 						to.Ptr("edgenode")},
	// 						URI: to.Ptr("https://app.com/azure/app_install.sh"),
	// 				}},
	// 				MarketplaceIdentifier: to.Ptr("id"),
	// 				ProvisioningState: to.Ptr("Succeeded"),
	// 				SSHEndpoints: []*armhdinsight.ApplicationGetEndpoint{
	// 				},
	// 				UninstallScriptActions: []*armhdinsight.RuntimeScriptAction{
	// 				},
	// 			},
	// 			Tags: map[string]*string{
	// 				"key1": to.Ptr("val1"),
	// 			},
	// 		}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { HDInsightManagementClient } = require("@azure/arm-hdinsight");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets properties of the specified application.
 *
 * @summary Gets properties of the specified application.
 * x-ms-original-file: specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/GetApplicationInProgress.json
 */
async function getApplicationOnHdInsightClusterCreationInProgress() {
  const subscriptionId = process.env["HDINSIGHT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["HDINSIGHT_RESOURCE_GROUP"] || "rg1";
  const clusterName = "cluster1";
  const applicationName = "app";
  const credential = new DefaultAzureCredential();
  const client = new HDInsightManagementClient(credential, subscriptionId);
  const result = await client.applications.get(resourceGroupName, clusterName, applicationName);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.HDInsight;
using Azure.ResourceManager.HDInsight.Models;

// Generated from example definition: specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/GetApplicationInProgress.json
// this example is just showing the usage of "Applications_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this HDInsightApplicationResource created on azure
// for more information of creating HDInsightApplicationResource, please refer to the document of HDInsightApplicationResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string clusterName = "cluster1";
string applicationName = "app";
ResourceIdentifier hdInsightApplicationResourceId = HDInsightApplicationResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, clusterName, applicationName);
HDInsightApplicationResource hdInsightApplication = client.GetHDInsightApplicationResource(hdInsightApplicationResourceId);

// invoke the operation
HDInsightApplicationResource result = await hdInsightApplication.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
HDInsightApplicationData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

{
  "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

import com.azure.core.util.Context;

/** Samples for Applications Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/GetApplicationCreated.json
     */
    /**
     * Sample code: Get application on HDInsight cluster successfully created.
     *
     * @param manager Entry point to HDInsightManager.
     */
    public static void getApplicationOnHDInsightClusterSuccessfullyCreated(
        com.azure.resourcemanager.hdinsight.HDInsightManager manager) {
        manager.applications().getWithResponse("rg1", "cluster1", "app", Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential
from azure.mgmt.hdinsight import HDInsightManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-hdinsight
# USAGE
    python get_application_created.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = HDInsightManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.applications.get(
        resource_group_name="rg1",
        cluster_name="cluster1",
        application_name="app",
    )
    print(response)


# x-ms-original-file: specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/GetApplicationCreated.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armhdinsight_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hdinsight/armhdinsight"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7a2ac91de424f271cf91cc8009f3fe9ee8249086/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/GetApplicationCreated.json
func ExampleApplicationsClient_Get_getApplicationOnHdInsightClusterSuccessfullyCreated() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armhdinsight.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewApplicationsClient().Get(ctx, "rg1", "cluster1", "app", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Application = armhdinsight.Application{
	// 	Name: to.Ptr("app"),
	// 	Type: to.Ptr("Microsoft.HDInsight/clusters/applications"),
	// 	ID: to.Ptr("/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/applications/app"),
	// 	Etag: to.Ptr("CF938302-6B4D-44A0-A6D2-C0D67E847AEC"),
	// 	Properties: &armhdinsight.ApplicationProperties{
	// 		ApplicationState: to.Ptr("Running"),
	// 		ApplicationType: to.Ptr("CustomApplication"),
	// 		ComputeProfile: &armhdinsight.ComputeProfile{
	// 			Roles: []*armhdinsight.Role{
	// 				{
	// 					Name: to.Ptr("edgenode"),
	// 					HardwareProfile: &armhdinsight.HardwareProfile{
	// 						VMSize: to.Ptr("Standard_D12_v2"),
	// 					},
	// 					TargetInstanceCount: to.Ptr[int32](1),
	// 			}},
	// 		},
	// 		CreatedDate: to.Ptr("2017-03-22T21:34:39.293"),
	// 		HTTPSEndpoints: []*armhdinsight.ApplicationGetHTTPSEndpoint{
	// 			{
	// 				AccessModes: []*string{
	// 					to.Ptr("WebPage")},
	// 					DestinationPort: to.Ptr[int32](20000),
	// 					Location: to.Ptr("https://cluster1.apps.azurehdinsight.net:443"),
	// 					PublicPort: to.Ptr[int32](443),
	// 			}},
	// 			InstallScriptActions: []*armhdinsight.RuntimeScriptAction{
	// 				{
	// 					Name: to.Ptr("app-install"),
	// 					Roles: []*string{
	// 						to.Ptr("edgenode")},
	// 						URI: to.Ptr("http://app.com/public/hdi-app/20170301/app-install.sh"),
	// 				}},
	// 				MarketplaceIdentifier: to.Ptr("appMarketId"),
	// 				ProvisioningState: to.Ptr("Succeeded"),
	// 				SSHEndpoints: []*armhdinsight.ApplicationGetEndpoint{
	// 					{
	// 						DestinationPort: to.Ptr[int32](22),
	// 						Location: to.Ptr("cluster1-ssh.azurehdinsight.net:22"),
	// 						PublicPort: to.Ptr[int32](22),
	// 				}},
	// 				UninstallScriptActions: []*armhdinsight.RuntimeScriptAction{
	// 				},
	// 			},
	// 			Tags: map[string]*string{
	// 				"key1": to.Ptr("val1"),
	// 			},
	// 		}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { HDInsightManagementClient } = require("@azure/arm-hdinsight");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets properties of the specified application.
 *
 * @summary Gets properties of the specified application.
 * x-ms-original-file: specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/GetApplicationCreated.json
 */
async function getApplicationOnHdInsightClusterSuccessfullyCreated() {
  const subscriptionId = process.env["HDINSIGHT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["HDINSIGHT_RESOURCE_GROUP"] || "rg1";
  const clusterName = "cluster1";
  const applicationName = "app";
  const credential = new DefaultAzureCredential();
  const client = new HDInsightManagementClient(credential, subscriptionId);
  const result = await client.applications.get(resourceGroupName, clusterName, applicationName);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.HDInsight;
using Azure.ResourceManager.HDInsight.Models;

// Generated from example definition: specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/GetApplicationCreated.json
// this example is just showing the usage of "Applications_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this HDInsightApplicationResource created on azure
// for more information of creating HDInsightApplicationResource, please refer to the document of HDInsightApplicationResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string clusterName = "cluster1";
string applicationName = "app";
ResourceIdentifier hdInsightApplicationResourceId = HDInsightApplicationResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, clusterName, applicationName);
HDInsightApplicationResource hdInsightApplication = client.GetHDInsightApplicationResource(hdInsightApplicationResourceId);

// invoke the operation
HDInsightApplicationResource result = await hdInsightApplication.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
HDInsightApplicationData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

{
  "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	角色的数据磁盘组。
DaysOfWeek	基于计划的自动缩放规则的星期几
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 群集应用程序

名称	类型	说明
etag	string	应用程序的 ETag
id	string	资源的完全限定的资源 ID。例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	资源的名称
properties	ApplicationProperties	应用程序的属性。
systemData	systemData	与资源的创建和上次修改相关的元数据。
tags	object	应用程序的标记。
type	string	资源类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

ApplicationGetEndpoint

获取应用程序 SSH 终结点

名称	类型	说明
destinationPort	integer	要连接到的目标端口。
location	string	终结点的位置。
privateIPAddress	string	终结点的专用 IP 地址。
publicPort	integer	要连接到的公共端口。

ApplicationGetHttpsEndpoint

获取应用程序 HTTP 终结点。

名称	类型	说明
accessModes	string[]	应用程序的访问模式列表。
destinationPort	integer	要连接到的目标端口。
disableGatewayAuth	boolean	值指示是否禁用 GatewayAuth。
location	string	终结点的位置。
privateIPAddress	string	终结点的专用 IP 地址。
publicPort	integer	要连接到的公共端口。
subDomainSuffix	string	应用程序的子域后缀。

ApplicationProperties

HDInsight 群集应用程序 GET 响应。

名称	类型	说明
applicationState	string	应用程序状态。
applicationType	string	应用程序类型。
computeProfile	ComputeProfile	群集中的角色列表。
createdDate	string	应用程序创建日期时间。
errors	Errors[]	错误列表。
httpsEndpoints	ApplicationGetHttpsEndpoint[]	应用程序 HTTPS 终结点的列表。
installScriptActions	RuntimeScriptAction[]	安装脚本操作的列表。
marketplaceIdentifier	string	市场标识符。
privateLinkConfigurations	PrivateLinkConfiguration[]	专用链接配置。
provisioningState	string	应用程序的预配状态。
sshEndpoints	ApplicationGetEndpoint[]	应用程序 SSH 终结点的列表。
uninstallScriptActions	RuntimeScriptAction[]	卸载脚本操作的列表。

Autoscale

自动缩放请求参数

名称	类型	说明
capacity	AutoscaleCapacity	基于负载的自动缩放的参数
recurrence	AutoscaleRecurrence	基于计划的自动缩放的参数

AutoscaleCapacity

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

名称	类型	说明
maxInstanceCount	integer	群集的最大实例计数
minInstanceCount	integer	群集的最小实例计数

AutoscaleRecurrence

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

名称	类型	说明
schedule	AutoscaleSchedule[]	基于计划的自动缩放规则数组
timeZone	string	自动缩放计划时间的时区

AutoscaleSchedule

基于计划的自动缩放规则的参数，由一组天 + 一个时间和容量组成

名称	类型	说明
days	DaysOfWeek[]	基于计划的自动缩放规则的星期几
timeAndCapacity	AutoscaleTimeAndCapacity	基于计划的自动缩放规则的时间和容量

AutoscaleTimeAndCapacity

时间和容量请求参数

名称	类型	说明
maxInstanceCount	integer	群集的最大实例计数
minInstanceCount	integer	群集的最小实例计数
time	string	24 小时时间，格式为 xx：xx

ComputeProfile

描述计算配置文件。

名称	类型	说明
roles	Role[]	群集中的角色列表。

createdByType

创建资源的标识类型。

名称	类型	说明
Application	string
Key	string
ManagedIdentity	string
User	string

DataDisksGroups

角色的数据磁盘组。

名称	类型	说明
diskSizeGB	integer	ReadOnly。 DiskSize（以 GB 为单位）。请勿设置此值。
disksPerNode	integer	每个节点的磁盘数。
storageAccountType	string	ReadOnly。存储帐户类型。请勿设置此值。

DaysOfWeek

基于计划的自动缩放规则的星期几

名称	类型	说明
Friday	string
Monday	string
Saturday	string
Sunday	string
Thursday	string
Tuesday	string
Wednesday	string

ErrorResponse

描述错误响应的格式。

名称	类型	说明
code	string	错误代码
message	string	指示操作失败原因的错误消息。

Errors

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

名称	类型	说明
code	string	错误代码。
message	string	错误消息。

HardwareProfile

硬件配置文件。

名称	类型	说明
vmSize	string	VM 的大小

IPConfiguration

专用链接服务的 IP 配置。

名称	类型	说明
id	string	专用链接 IP 配置 ID。
name	string	专用链接 IP 配置的名称。
properties.primary	boolean	指示此 IP 配置是否是相应 NIC 的主配置。
properties.privateIPAddress	string	IP 地址。
properties.privateIPAllocationMethod	PrivateIPAllocationMethod	分配专用 IP 地址的方法。
properties.provisioningState	PrivateLinkConfigurationProvisioningState	专用链接配置预配状态，该状态仅显示在响应中。
properties.subnet	ResourceId	子网资源 ID。
type	string	专用链接 IP 配置的类型。

LinuxOperatingSystemProfile

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

名称	类型	说明
password	string	密码。
sshProfile	SshProfile	SSH 配置文件。
username	string	用户名。

OsProfile

Linux 操作系统配置文件。

名称	类型	说明
linuxOperatingSystemProfile	LinuxOperatingSystemProfile	Linux OS 配置文件。

PrivateIPAllocationMethod

分配专用 IP 地址的方法。

名称	类型	说明
dynamic	string
static	string

PrivateLinkConfiguration

专用链接配置。

名称	类型	说明
id	string	专用链接配置 ID。
name	string	专用链接配置的名称。
properties.groupId	string	要向其应用专用链接配置的 HDInsight 专用可链接子资源名称。例如，“headnode”、“gateway”、“edgenode”。
properties.ipConfigurations	IPConfiguration[]	专用链接服务的 IP 配置。
properties.provisioningState	PrivateLinkConfigurationProvisioningState	专用链接配置预配状态，该状态仅显示在响应中。
type	string	专用链接配置的类型。

PrivateLinkConfigurationProvisioningState

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

名称	类型	说明
Canceled	string
Deleting	string
Failed	string
InProgress	string
Succeeded	string

ResourceId

Azure 资源 ID。

名称	类型	说明
id	string	Azure 资源 ID。

Role

描述群集上的角色。

名称	类型	默认值	说明
VMGroupName	string		虚拟机组的名称。
autoscale	Autoscale		自动缩放配置。
dataDisksGroups	DataDisksGroups[]		角色的数据磁盘组。
encryptDataDisks	boolean	False	指示是否加密数据磁盘。
hardwareProfile	HardwareProfile		硬件配置文件。
minInstanceCount	integer		群集的最小实例计数。
name	string		角色的名称。
osProfile	OsProfile		操作系统配置文件。
scriptActions	ScriptAction[]		角色上的脚本操作列表。
targetInstanceCount	integer		群集的实例计数。
virtualNetworkProfile	VirtualNetworkProfile		虚拟网络配置文件。

RuntimeScriptAction

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

名称	类型	说明
applicationName	string	脚本操作的应用程序名称（如果有）。
name	string	脚本操作的名称。
parameters	string	脚本的参数
roles	string[]	将执行脚本的角色列表。
uri	string	脚本的 URI。

ScriptAction

描述群集上角色的脚本操作。

名称	类型	说明
name	string	脚本操作的名称。
parameters	string	提供的脚本的参数。
uri	string	脚本的 URI。

SshProfile

SSH 公钥的列表。

名称	类型	说明
publicKeys	SshPublicKey[]	SSH 公钥的列表。

SshPublicKey

群集节点的 SSH 公钥。

名称	类型	说明
certificateData	string	SSH 证书。

systemData

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

名称	类型	说明
createdAt	string	资源的创建时间戳 (UTC) 。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识类型。
lastModifiedAt	string	资源上次修改的时间戳 (UTC)
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识类型。

VirtualNetworkProfile

虚拟网络属性。

名称	类型	说明
id	string	虚拟网络的 ID。
subnet	string	子网的名称。

Applications - Get

URI 参数

响应

安全性

azure_auth

Scopes

示例

Get application on HDInsight cluster creation in progress

Sample Request

Sample Response

Get application on HDInsight cluster successfully created.

Sample Request

Sample Response

定义

Application

ApplicationGetEndpoint

ApplicationGetHttpsEndpoint

ApplicationProperties

Autoscale

AutoscaleCapacity

AutoscaleRecurrence

AutoscaleSchedule

AutoscaleTimeAndCapacity

ComputeProfile

createdByType

DataDisksGroups

DaysOfWeek

ErrorResponse

Errors

HardwareProfile

IPConfiguration

LinuxOperatingSystemProfile

OsProfile

PrivateIPAllocationMethod

PrivateLinkConfiguration

PrivateLinkConfigurationProvisioningState

ResourceId

Role

RuntimeScriptAction

ScriptAction

SshProfile

SshPublicKey

systemData

VirtualNetworkProfile

其他资源