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
182 changes: 180 additions & 2 deletions sdk/advisor/arm-advisor/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,183 @@
# Release History

## 4.0.0-beta.1 (2025-05-13)
Compared with version 3.2.0

### Features Added

- Added operation group AdvisorScores
- Added operation group Assessments
- Added operation group AssessmentTypes
- Added operation group ResiliencyReviews
- Added operation group TriageRecommendations
- Added operation group TriageResources
- Added operation group Workloads
- Added operation Recommendations.patch
- Added Interface AdvisorScoreEntity
- Added Interface AdvisorScoreResponse
- Added Interface AdvisorScoresGetOptionalParams
- Added Interface AdvisorScoresListOptionalParams
- Added Interface AssessmentListResult
- Added Interface AssessmentResult
- Added Interface AssessmentsDeleteOptionalParams
- Added Interface AssessmentsGetOptionalParams
- Added Interface AssessmentsListNextOptionalParams
- Added Interface AssessmentsListOptionalParams
- Added Interface AssessmentsPutOptionalParams
- Added Interface AssessmentTypeListResult
- Added Interface AssessmentTypeResult
- Added Interface AssessmentTypesListNextOptionalParams
- Added Interface AssessmentTypesListOptionalParams
- Added Interface ConfigDataListResult
- Added Interface ConfigurationsListByResourceGroupNextOptionalParams
- Added Interface ErrorAdditionalInfo
- Added Interface ErrorDetail
- Added Interface ErrorResponse
- Added Interface Operation
- Added Interface OperationDisplay
- Added Interface OperationListResult
- Added Interface PredictionRequest
- Added Interface PredictionResponse
- Added Interface PredictOptionalParams
- Added Interface ProxyResource
- Added Interface RecommendationPropertiesResourceWorkload
- Added Interface RecommendationPropertiesReview
- Added Interface RecommendationRejectBody
- Added Interface RecommendationsGetGenerateStatusHeaders
- Added Interface RecommendationsPatchOptionalParams
- Added Interface ResiliencyReview
- Added Interface ResiliencyReviewCollection
- Added Interface ResiliencyReviewsGetOptionalParams
- Added Interface ResiliencyReviewsListNextOptionalParams
- Added Interface ResiliencyReviewsListOptionalParams
- Added Interface ScoreEntity
- Added Interface SystemData
- Added Interface TimeSeriesEntityItem
- Added Interface TrackedRecommendationProperties
- Added Interface TrackedRecommendationPropertiesPayload
- Added Interface TrackedRecommendationPropertiesPayloadProperties
- Added Interface TriageRecommendation
- Added Interface TriageRecommendationCollection
- Added Interface TriageRecommendationsApproveTriageRecommendationOptionalParams
- Added Interface TriageRecommendationsGetOptionalParams
- Added Interface TriageRecommendationsListNextOptionalParams
- Added Interface TriageRecommendationsListOptionalParams
- Added Interface TriageRecommendationsRejectTriageRecommendationOptionalParams
- Added Interface TriageRecommendationsResetTriageRecommendationOptionalParams
- Added Interface TriageResource
- Added Interface TriageResourceCollection
- Added Interface TriageResourcesGetOptionalParams
- Added Interface TriageResourcesListNextOptionalParams
- Added Interface TriageResourcesListOptionalParams
- Added Interface WorkloadListResult
- Added Interface WorkloadResult
- Added Interface WorkloadsListNextOptionalParams
- Added Interface WorkloadsListOptionalParams
- Added Type Alias ActionType
- Added Type Alias AdvisorScoresGetResponse
- Added Type Alias AdvisorScoresListResponse
- Added Type Alias Aggregated
- Added Type Alias AssessmentsGetResponse
- Added Type Alias AssessmentsListNextResponse
- Added Type Alias AssessmentsListResponse
- Added Type Alias AssessmentsPutResponse
- Added Type Alias AssessmentTypesListNextResponse
- Added Type Alias AssessmentTypesListResponse
- Added Type Alias ConfigurationsListByResourceGroupNextResponse
- Added Type Alias CreatedByType
- Added Type Alias Duration
- Added Type Alias Origin
- Added Type Alias PredictionType
- Added Type Alias PredictResponse
- Added Type Alias Priority
- Added Type Alias PriorityName
- Added Type Alias Reason
- Added Type Alias ReasonForRejectionName
- Added Type Alias RecommendationsGetGenerateStatusResponse
- Added Type Alias RecommendationsPatchResponse
- Added Type Alias RecommendationStatusName
- Added Type Alias ResiliencyReviewsGetResponse
- Added Type Alias ResiliencyReviewsListNextResponse
- Added Type Alias ResiliencyReviewsListResponse
- Added Type Alias ReviewStatus
- Added Type Alias State
- Added Type Alias TriageRecommendationsGetResponse
- Added Type Alias TriageRecommendationsListNextResponse
- Added Type Alias TriageRecommendationsListResponse
- Added Type Alias TriageResourcesGetResponse
- Added Type Alias TriageResourcesListNextResponse
- Added Type Alias TriageResourcesListResponse
- Added Type Alias WorkloadsListNextResponse
- Added Type Alias WorkloadsListResponse
- Interface ConfigData has a new optional parameter duration
- Interface Resource has a new optional parameter systemData
- Interface ResourceRecommendationBase has a new optional parameter notes
- Interface ResourceRecommendationBase has a new optional parameter resourceWorkload
- Interface ResourceRecommendationBase has a new optional parameter review
- Interface ResourceRecommendationBase has a new optional parameter sourceSystem
- Interface ResourceRecommendationBase has a new optional parameter tracked
- Interface ResourceRecommendationBase has a new optional parameter trackedProperties
- Added Enum KnownActionType
- Added Enum KnownAggregated
- Added Enum KnownCreatedByType
- Added Enum KnownDuration
- Added Enum KnownOrigin
- Added Enum KnownPredictionType
- Added Enum KnownPriority
- Added Enum KnownPriorityName
- Added Enum KnownReason
- Added Enum KnownReasonForRejectionName
- Added Enum KnownRecommendationStatusName
- Added Enum KnownReviewStatus
- Added Enum KnownState

### Breaking Changes

- Interface MetadataEntity no longer has parameter id
- Interface MetadataEntity no longer has parameter name
- Interface MetadataEntity no longer has parameter type
- Interface RecommendationsGenerateHeaders no longer has parameter location
- Parameter value of interface ConfigurationListResult is now required
- Parameter value of interface MetadataEntityListResult is now required
- Parameter value of interface ResourceRecommendationBaseListResult is now required
- Parameter value of interface SuppressionContractListResult is now required
- Type of parameter retryAfter of interface RecommendationsGenerateHeaders is changed from string to number
- Type of parameter action of interface ResourceMetadata is changed from {
[propertyName: string]: Record<string, unknown>;
} to {
[propertyName: string]: {
[propertyName: string]: any;
};
}
- Type of parameter actions of interface ResourceRecommendationBase is changed from {
[propertyName: string]: Record<string, unknown>;
}[] to {
[propertyName: string]: {
[propertyName: string]: any;
};
}[]
- Type of parameter exposedMetadataProperties of interface ResourceRecommendationBase is changed from {
[propertyName: string]: Record<string, unknown>;
} to {
[propertyName: string]: {
[propertyName: string]: any;
};
}
- Type of parameter metadata of interface ResourceRecommendationBase is changed from {
[propertyName: string]: Record<string, unknown>;
} to {
[propertyName: string]: {
[propertyName: string]: any;
};
}
- Type of parameter remediation of interface ResourceRecommendationBase is changed from {
[propertyName: string]: Record<string, unknown>;
} to {
[propertyName: string]: {
[propertyName: string]: any;
};
}

## 3.2.0 (2023-08-03)

### Features Added
Expand Down Expand Up @@ -33,7 +211,7 @@

## 3.0.1 (2022-03-22)

### Features Added
**features**

- bug fix

Expand All @@ -45,4 +223,4 @@ To understand the detail of the change, please refer to [Changelog](https://aka.

To migrate the existing applications to the latest version, please refer to [Migration Guide](https://aka.ms/js-track2-migration-guide).

To learn more, please refer to our documentation [Quick Start](https://aka.ms/azsdk/js/mgmt/quickstart ).
To learn more, please refer to our documentation [Quick Start](https://aka.ms/azsdk/js/mgmt/quickstart).
2 changes: 1 addition & 1 deletion sdk/advisor/arm-advisor/LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
SOFTWARE.
16 changes: 7 additions & 9 deletions sdk/advisor/arm-advisor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ REST APIs for Azure Advisor

[Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/advisor/arm-advisor) |
[Package (NPM)](https://www.npmjs.com/package/@azure/arm-advisor) |
[API reference documentation](https://learn.microsoft.com/javascript/api/@azure/arm-advisor) |
[API reference documentation](https://learn.microsoft.com/javascript/api/@azure/arm-advisor?view=azure-node-preview) |
[Samples](https://github.com/Azure-Samples/azure-samples-js-management)

## Getting started
Expand Down Expand Up @@ -44,13 +44,12 @@ npm install @azure/identity
```

You will also need to **register a new AAD application and grant access to Azure AdvisorManagement** by assigning the suitable role to your service principal (note: roles such as `"Owner"` will not grant the necessary permissions).
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 information about how to create an Azure AD Application check out [this guide](https://learn.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal).

Using Node.js and Node-like environments, you can use the `DefaultAzureCredential` class to authenticate the client.

```ts snippet:AdvisorManagementClientAuth_Node
```ts snippet:ReadmeSampleCreateClient_Node
import { AdvisorManagementClient } from "@azure/arm-advisor";
import { DefaultAzureCredential } from "@azure/identity";

Expand All @@ -60,20 +59,18 @@ const client = new AdvisorManagementClient(new DefaultAzureCredential(), subscri

For browser environments, use the `InteractiveBrowserCredential` from the `@azure/identity` package to authenticate.

```ts snippet:AdvisorManagementClientAuth_Browser
```ts snippet:ReadmeSampleCreateClient_Browser
import { InteractiveBrowserCredential } from "@azure/identity";
import { AdvisorManagementClient } from "@azure/arm-advisor";

const subscriptionId = "00000000-0000-0000-0000-000000000000";
const credential = new InteractiveBrowserCredential({
tenantId: "<YOUR_TENANT_ID>",
clientId: "<YOUR_CLIENT_ID>",
});
clientId: "<YOUR_CLIENT_ID>"
});
const client = new AdvisorManagementClient(credential, subscriptionId);
```

### JavaScript Bundle

To use this client library in the browser, first you need to use a bundler. For details on how to do this, please refer to our [bundling documentation](https://aka.ms/AzureSDKBundling).

## Key concepts
Expand All @@ -88,7 +85,7 @@ To use this client library in the browser, first you need to use a bundler. For

Enabling logging may help uncover useful information about failures. In order to see a log of HTTP requests and responses, set the `AZURE_LOG_LEVEL` environment variable to `info`. Alternatively, logging can be enabled at runtime by calling `setLogLevel` in the `@azure/logger`:

```ts snippet:setLogLevel
```ts snippet:SetLogLevel
import { setLogLevel } from "@azure/logger";

setLogLevel("info");
Expand All @@ -108,6 +105,7 @@ If you'd like to contribute to this library, please read the [contributing guide

- [Microsoft Azure SDK for JavaScript](https://github.com/Azure/azure-sdk-for-js)


[azure_cli]: https://learn.microsoft.com/cli/azure
[azure_sub]: https://azure.microsoft.com/free/
[azure_sub]: https://azure.microsoft.com/free/
Expand Down
10 changes: 5 additions & 5 deletions sdk/advisor/arm-advisor/_meta.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"commit": "54ee1a9eb50c13e0790627749f986c886ad4f4db",
"readme": "specification\\advisor\\resource-manager\\readme.md",
"autorest_command": "autorest --version=3.9.3 --typescript --modelerfour.lenient-model-deduplication --azure-arm --head-as-boolean=true --license-header=MICROSOFT_MIT_NO_VERSION --generate-test --typescript-sdks-folder=D:\\Git\\azure-sdk-for-js ..\\azure-rest-api-specs\\specification\\advisor\\resource-manager\\readme.md --use=@autorest/[email protected].5 --generate-sample=true",
"commit": "b522c37144b473d6d247989f92d25212ea4f57b6",
"readme": "specification/advisor/resource-manager/readme.md",
"autorest_command": "autorest --version=3.9.7 --typescript --modelerfour.lenient-model-deduplication --azure-arm --head-as-boolean=true --license-header=MICROSOFT_MIT_NO_VERSION --generate-test --typescript-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-js ../azure-rest-api-specs/specification/advisor/resource-manager/readme.md --use=@autorest/typescript@^6.0.12",
"repository_url": "https://github.com/Azure/azure-rest-api-specs.git",
"release_tool": "@azure-tools/[email protected].0",
"use": "@autorest/[email protected].5"
"release_tool": "@azure-tools/[email protected].27",
"use": "@autorest/typescript@^6.0.12"
}
2 changes: 1 addition & 1 deletion sdk/advisor/arm-advisor/api-extractor.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@
}
}
}
}
}
Loading