Assessments Operations - Download Url

服务:

Azure Migrate

API 版本:

2023-03-15

获取评估报告的下载 URL。
获取以报表格式下载评估的 URL。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/groups/{groupName}/assessments/{assessmentName}/downloadUrl?api-version=2023-03-15

URI 参数

名称	在	必需	类型	说明
assessmentName	path	True	string pattern: ^[^<>&:\?/#]{1,260}$	计算机评估 ARM 名称
groupName	path	True	string pattern: ^[^<>&:\?/#]{1,260}$	组 ARM 名称
projectName	path	True	string pattern: ^[^<>&:\?/#]{1,260}$	评估项目名称
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。 名称不区分大小写。
subscriptionId	path	True	string minLength: 1	目标订阅的 ID。
api-version	query	True	string minLength: 1	用于此作的 API 版本。

请求正文

名称	类型	说明
body	object	作请求的内容

响应

名称	类型	说明
200 OK	DownloadUrl	ARM作已成功完成。
202 Accepted		已接受资源作。 标头 Retry-After: integer Location: string
Other Status Codes	ErrorResponse	意外的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

AssessmentsOperations_DownloadUrl_MaximumSet_Gen

示例请求

HTTP

POST https://management.azure.com/subscriptions/4bd2aa0f-2bd2-4d67-91a8-5a4533d58600/resourceGroups/ayagrawrg/providers/Microsoft.Migrate/assessmentProjects/app18700project/groups/kuchatur-test/assessments/asm1/downloadUrl?api-version=2023-03-15

{}

JavaScript

const { AzureMigrateAssessmentService } = require("@azure/arm-migrationassessment");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Get the URL for downloading the assessment in a report format.
 *
 * @summary Get the URL for downloading the assessment in a report format.
 * x-ms-original-file: specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2023-03-15/examples/AssessmentsOperations_DownloadUrl_MaximumSet_Gen.json
 */
async function assessmentsOperationsDownloadUrlMaximumSetGen() {
  const subscriptionId =
    process.env["MIGRATE_SUBSCRIPTION_ID"] || "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600";
  const resourceGroupName = process.env["MIGRATE_RESOURCE_GROUP"] || "ayagrawrg";
  const projectName = "app18700project";
  const groupName = "kuchatur-test";
  const assessmentName = "asm1";
  const body = {};
  const credential = new DefaultAzureCredential();
  const client = new AzureMigrateAssessmentService(credential, subscriptionId);
  const result = await client.assessmentsOperations.beginDownloadUrlAndWait(
    resourceGroupName,
    projectName,
    groupName,
    assessmentName,
    body,
  );
  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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Migration.Assessment.Models;
using Azure.ResourceManager.Migration.Assessment;

// Generated from example definition: specification/migrate/resource-manager/Microsoft.Migrate/AssessmentProjects/stable/2023-03-15/examples/AssessmentsOperations_DownloadUrl_MaximumSet_Gen.json
// this example is just showing the usage of "AssessmentsOperations_DownloadUrl" 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 MigrationAssessmentResource created on azure
// for more information of creating MigrationAssessmentResource, please refer to the document of MigrationAssessmentResource
string subscriptionId = "4bd2aa0f-2bd2-4d67-91a8-5a4533d58600";
string resourceGroupName = "ayagrawrg";
string projectName = "app18700project";
string groupName = "kuchatur-test";
string assessmentName = "asm1";
ResourceIdentifier migrationAssessmentResourceId = MigrationAssessmentResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, projectName, groupName, assessmentName);
MigrationAssessmentResource migrationAssessment = client.GetMigrationAssessmentResource(migrationAssessmentResourceId);

// invoke the operation
BinaryData body = BinaryData.FromObjectAsJson(new object());
ArmOperation<AssessmentReportDownloadUri> lro = await migrationAssessment.DownloadUrlAsync(WaitUntil.Completed, body);
AssessmentReportDownloadUri result = lro.Value;

Console.WriteLine($"Succeeded: {result}");

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

示例响应

状态代码:

200

{
  "assessmentReportUrl": "uri/uri/uri",
  "expirationTime": "2023-09-26T09:36:57.114Z"
}

状态代码:

202

location: https://contoso.com/operationstatus

定义

名称	说明
DownloadUrl	评估报表的下载 URL 的数据模型。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应

DownloadUrl

Object

评估报表的下载 URL 的数据模型。

名称	类型	说明
assessmentReportUrl	string	用于下载报表的超链接。
expirationTime	string (date-time)	下载 URL 的到期日期。

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

Object

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。