Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion sdk/advisor/arm-advisor/LICENSE.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2020 Microsoft
Copyright (c) 2021 Microsoft

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
9 changes: 4 additions & 5 deletions sdk/advisor/arm-advisor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ npm install @azure/arm-advisor

### How to use

#### nodejs - Authentication, client creation and get recommendationMetadata as an example written in TypeScript.
#### nodejs - client creation and get recommendationMetadata as an example written in TypeScript.

##### Install @azure/ms-rest-nodeauth

Expand All @@ -26,11 +26,10 @@ npm install @azure/ms-rest-nodeauth@"^3.0.0"

##### Sample code

While the below sample uses the interactive login, other authentication options can be found in the [README.md file of @azure/ms-rest-nodeauth](https://www.npmjs.com/package/@azure/ms-rest-nodeauth) package
```typescript
import * as msRest from "@azure/ms-rest-js";
import * as msRestAzure from "@azure/ms-rest-azure-js";
import * as msRestNodeAuth from "@azure/ms-rest-nodeauth";
import { AdvisorManagementClient, AdvisorManagementModels, AdvisorManagementMappers } from "@azure/arm-advisor";
const msRestNodeAuth = require("@azure/ms-rest-nodeauth");
const { AdvisorManagementClient } = require("@azure/arm-advisor");
const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"];

msRestNodeAuth.interactiveLogin().then((creds) => {
Expand Down
4 changes: 2 additions & 2 deletions sdk/advisor/arm-advisor/rollup.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ const config = {
"@azure/ms-rest-azure-js": "msRestAzure"
},
banner: `/*
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
* Copyright (c) Microsoft Corporation.
* Licensed under the MIT License.
*
* Code generated by Microsoft (R) AutoRest Code Generator.
* Changes may cause incorrect behavior and will be lost if the code is regenerated.
Expand Down
5 changes: 2 additions & 3 deletions sdk/advisor/arm-advisor/src/advisorManagementClient.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
/*
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for
* license information.
* Copyright (c) Microsoft Corporation.
* Licensed under the MIT License.
*
* Code generated by Microsoft (R) AutoRest Code Generator.
* Changes may cause incorrect behavior and will be lost if the code is
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
/*
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for
* license information.
* Copyright (c) Microsoft Corporation.
* Licensed under the MIT License.
*
* Code generated by Microsoft (R) AutoRest Code Generator.
* Changes may cause incorrect behavior and will be lost if the code is
Expand Down
4 changes: 2 additions & 2 deletions sdk/advisor/arm-advisor/src/models/configurationsMappers.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
* Copyright (c) Microsoft Corporation.
* Licensed under the MIT License.
*
* Code generated by Microsoft (R) AutoRest Code Generator.
* Changes may cause incorrect behavior and will be lost if the code is regenerated.
Expand Down
98 changes: 88 additions & 10 deletions sdk/advisor/arm-advisor/src/models/index.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
* Copyright (c) Microsoft Corporation.
* Licensed under the MIT License.
*
* Code generated by Microsoft (R) AutoRest Code Generator.
* Changes may cause incorrect behavior and will be lost if the code is regenerated.
Expand Down Expand Up @@ -181,6 +181,18 @@ export interface ResourceMetadata {
* Source from which recommendation is generated
*/
source?: string;
/**
* The action to view resource.
*/
action?: { [propertyName: string]: any };
/**
* The singular user friendly name of resource type. eg: virtual machine
*/
singular?: string;
/**
* The plural user friendly name of resource type. eg: virtual machines
*/
plural?: string;
}

/**
Expand Down Expand Up @@ -237,6 +249,34 @@ export interface ResourceRecommendationBase extends Resource {
* Metadata of resource that was assessed
*/
resourceMetadata?: ResourceMetadata;
/**
* The detailed description of recommendation.
*/
description?: string;
/**
* The label of recommendation.
*/
label?: string;
/**
* The link to learn more about recommendation and generation logic.
*/
learnMoreLink?: string;
/**
* The potential benefit of implementing recommendation.
*/
potentialBenefits?: string;
/**
* The list of recommended actions to implement recommendation.
*/
actions?: { [propertyName: string]: any }[];
/**
* The automated way to apply recommendation.
*/
remediation?: { [propertyName: string]: any };
/**
* The recommendation metadata properties exposed to customer to provide additional information.
*/
exposedMetadataProperties?: { [propertyName: string]: any };
}

/**
Expand Down Expand Up @@ -288,14 +328,43 @@ export interface SuppressionContract extends Resource {
* The duration for which the suppression is valid.
*/
ttl?: string;
/**
* Gets or sets the expiration time stamp.
* **NOTE: This property will not be serialized. It can only be populated by the server.**
*/
readonly expirationTimeStamp?: Date;
}

/**
* Optional Parameters.
*/
export interface RecommendationsListOptionalParams extends msRest.RequestOptionsBase {
/**
* The filter to apply to the recommendations.
* The filter to apply to the recommendations.<br>Filter can be applied to properties
* ['ResourceId', 'ResourceGroup', 'RecommendationTypeGuid', '[Category](#category)'] with
* operators ['eq', 'and', 'or'].<br>Example:<br>- $filter=Category eq 'Cost' and ResourceGroup
* eq 'MyResourceGroup'
*/
filter?: string;
/**
* The number of recommendations per page if a paged version of this API is being used.
*/
top?: number;
/**
* The page-continuation token to use with a paged version of this API.
*/
skipToken?: string;
}

/**
* Optional Parameters.
*/
export interface RecommendationsListNextOptionalParams extends msRest.RequestOptionsBase {
/**
* The filter to apply to the recommendations.<br>Filter can be applied to properties
* ['ResourceId', 'ResourceGroup', 'RecommendationTypeGuid', '[Category](#category)'] with
* operators ['eq', 'and', 'or'].<br>Example:<br>- $filter=Category eq 'Cost' and ResourceGroup
* eq 'MyResourceGroup'
*/
filter?: string;
/**
Expand All @@ -322,6 +391,20 @@ export interface SuppressionsListOptionalParams extends msRest.RequestOptionsBas
skipToken?: string;
}

/**
* Optional Parameters.
*/
export interface SuppressionsListNextOptionalParams extends msRest.RequestOptionsBase {
/**
* The number of suppressions per page if a paged version of this API is being used.
*/
top?: number;
/**
* The page-continuation token to use with a paged version of this API.
*/
skipToken?: string;
}

/**
* An interface representing AdvisorManagementClientOptions.
*/
Expand Down Expand Up @@ -456,12 +539,7 @@ export type Risk = 'Error' | 'Warning' | 'None';
/**
* Contains response data for the get operation.
*/
export type RecommendationMetadataGetResponse = {
/**
* The parsed response body.
*/
body: any;

export type RecommendationMetadataGetResponse = MetadataEntity & {
/**
* The underlying HTTP response.
*/
Expand All @@ -474,7 +552,7 @@ export type RecommendationMetadataGetResponse = {
/**
* The response body as parsed JSON or XML
*/
parsedBody: any;
parsedBody: MetadataEntity;
};
};

Expand Down
96 changes: 94 additions & 2 deletions sdk/advisor/arm-advisor/src/models/mappers.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
* Copyright (c) Microsoft Corporation.
* Licensed under the MIT License.
*
* Code generated by Microsoft (R) AutoRest Code Generator.
* Changes may cause incorrect behavior and will be lost if the code is regenerated.
Expand Down Expand Up @@ -297,6 +297,29 @@ export const ResourceMetadata: msRest.CompositeMapper = {
type: {
name: "String"
}
},
action: {
serializedName: "action",
type: {
name: "Dictionary",
value: {
type: {
name: "Object"
}
}
}
},
singular: {
serializedName: "singular",
type: {
name: "String"
}
},
plural: {
serializedName: "plural",
type: {
name: "String"
}
}
}
}
Expand Down Expand Up @@ -397,6 +420,68 @@ export const ResourceRecommendationBase: msRest.CompositeMapper = {
name: "Composite",
className: "ResourceMetadata"
}
},
description: {
serializedName: "properties.description",
type: {
name: "String"
}
},
label: {
serializedName: "properties.label",
type: {
name: "String"
}
},
learnMoreLink: {
serializedName: "properties.learnMoreLink",
type: {
name: "String"
}
},
potentialBenefits: {
serializedName: "properties.potentialBenefits",
type: {
name: "String"
}
},
actions: {
serializedName: "properties.actions",
type: {
name: "Sequence",
element: {
type: {
name: "Dictionary",
value: {
type: {
name: "Object"
}
}
}
}
}
},
remediation: {
serializedName: "properties.remediation",
type: {
name: "Dictionary",
value: {
type: {
name: "Object"
}
}
}
},
exposedMetadataProperties: {
serializedName: "properties.exposedMetadataProperties",
type: {
name: "Dictionary",
value: {
type: {
name: "Object"
}
}
}
}
}
}
Expand Down Expand Up @@ -477,6 +562,13 @@ export const SuppressionContract: msRest.CompositeMapper = {
type: {
name: "String"
}
},
expirationTimeStamp: {
readOnly: true,
serializedName: "properties.expirationTimeStamp",
type: {
name: "DateTime"
}
}
}
}
Expand Down
7 changes: 4 additions & 3 deletions sdk/advisor/arm-advisor/src/models/operationsMappers.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
/*
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
* Copyright (c) Microsoft Corporation.
* Licensed under the MIT License.
*
* Code generated by Microsoft (R) AutoRest Code Generator.
* Changes may cause incorrect behavior and will be lost if the code is regenerated.
*/

export {
CloudError,
ArmErrorResponse,
ARMErrorResponseBody,
OperationDisplayInfo,
OperationEntity,
OperationEntityListResult
Expand Down
5 changes: 2 additions & 3 deletions sdk/advisor/arm-advisor/src/models/parameters.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
/*
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for
* license information.
* Copyright (c) Microsoft Corporation.
* Licensed under the MIT License.
*
* Code generated by Microsoft (R) AutoRest Code Generator.
* Changes may cause incorrect behavior and will be lost if the code is
Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
/*
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
* Copyright (c) Microsoft Corporation.
* Licensed under the MIT License.
*
* Code generated by Microsoft (R) AutoRest Code Generator.
* Changes may cause incorrect behavior and will be lost if the code is regenerated.
*/

export {
ArmErrorResponse,
ARMErrorResponseBody,
CloudError,
MetadataEntity,
MetadataEntityListResult,
MetadataSupportedValueDetail
Expand Down
Loading