Skip to content

[AutoPR @azure/arm-portal] Batch 6 sdk gen test #11349

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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
801 changes: 401 additions & 400 deletions common/config/rush/pnpm-lock.yaml

Large diffs are not rendered by default.

72 changes: 60 additions & 12 deletions sdk/portal/arm-portal/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,84 @@
# Release History

## 1.0.0-beta.6 (Unreleased)


## 1.0.0-beta.6 (2024-08-28)
Compared with version 1.0.0-beta.5

### Features Added

### Breaking Changes

### Bugs Fixed
- Added Interface ConfigurationListResult
- Added Interface ConfigurationProperties
- Added Interface DashboardProperties
- Added Interface DashboardPropertiesWithProvisioningState
- Added Interface ErrorAdditionalInfo
- Added Interface ErrorDetail
- Added Interface Operation
- Added Interface OperationDisplay
- Added Interface OperationListResult
- Added Interface PortalForTestingOptionalParams
- Added Interface SystemData
- Added Interface TrackedResource
- Added Class PortalForTesting
- Added Type Alias ActionType
- Added Type Alias CreatedByType
- Added Type Alias DashboardPartMetadataType
- Added Type Alias Origin
- Added Type Alias ResourceProvisioningState
- Interface Configuration has a new optional parameter properties
- Interface Dashboard has a new optional parameter properties
- Interface PatchableDashboard has a new optional parameter properties
- Interface Resource has a new optional parameter systemData
- Added Enum KnownActionType
- Added Enum KnownCreatedByType
- Added Enum KnownDashboardPartMetadataType
- Added Enum KnownOrigin
- Added Enum KnownResourceProvisioningState

### Other Changes
### Breaking Changes

- Operation TenantConfigurations.create has a new signature
- Operation TenantConfigurations.delete has a new signature
- Operation TenantConfigurations.get has a new signature
- Deleted Class Portal
- Interface Configuration no longer has parameter enforcePrivateMarkdownStorage
- Interface Dashboard no longer has parameter id
- Interface Dashboard no longer has parameter lenses
- Interface Dashboard no longer has parameter metadata
- Interface Dashboard no longer has parameter name
- Interface Dashboard no longer has parameter type
- Interface PatchableDashboard no longer has parameter lenses
- Interface PatchableDashboard no longer has parameter metadata
- Parameter value of interface DashboardListResult is now required
- Parameter value of interface ViolationsList is now required
- Type of parameter metadata of interface DashboardLens is changed from {
[propertyName: string]: Record<string, unknown>;
} to Record<string, unknown>
- Type of parameter metadata of interface DashboardPartsPosition is changed from {
[propertyName: string]: Record<string, unknown>;
} to Record<string, unknown>
- Type of parameter error of interface ErrorResponse is changed from ErrorDefinition to ErrorDetail
- Removed Enum KnownConfigurationName

## 1.0.0-beta.5 (2023-02-02)

**Features**
### Features Added

- Exposes `getContinuationToken` helper function to extract continuation token

**Bugs Fixed**
### Bugs Fixed

- A series of small bug fixs relevant to authentication and apiVersion policy

## 1.0.0-beta.4 (2022-07-08)

**Features**
### Features Added

- Added Interface Configuration
- Added Interface MarkdownPartMetadata
- Added Interface ProxyResource

## 1.0.0-beta.3 (2022-04-28)

**Features**
### Features Added

- Bug fix

Expand All @@ -42,4 +90,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/portal/arm-portal/LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2023 Microsoft
Copyright (c) 2024 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
24 changes: 12 additions & 12 deletions sdk/portal/arm-portal/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Azure Portal client library for JavaScript
# Azure PortalForTesting client library for JavaScript

This package contains an isomorphic SDK (runs both in Node.js and in browsers) for Azure Portal client.
This package contains an isomorphic SDK (runs both in Node.js and in browsers) for Azure PortalForTesting client.

Allows creation and deletion of Azure Shared Dashboards.

Expand All @@ -24,16 +24,16 @@ See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUP

### Install the `@azure/arm-portal` package

Install the Azure Portal client library for JavaScript with `npm`:
Install the Azure PortalForTesting client library for JavaScript with `npm`:

```bash
npm install @azure/arm-portal
```

### Create and authenticate a `Portal`
### Create and authenticate a `PortalForTesting`

To create a client object to access the Azure Portal API, you will need the `endpoint` of your Azure Portal resource and a `credential`. The Azure Portal client can use Azure Active Directory credentials to authenticate.
You can find the endpoint for your Azure Portal resource in the [Azure Portal][azure_portal].
To create a client object to access the Azure PortalForTesting API, you will need the `endpoint` of your Azure PortalForTesting resource and a `credential`. The Azure PortalForTesting client can use Azure Active Directory credentials to authenticate.
You can find the endpoint for your Azure PortalForTesting resource in the [Azure Portal][azure_portal].

You can authenticate with Azure Active Directory using a credential from the [@azure/identity][azure_identity] library or [an existing AAD Token](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/identity/identity/samples/AzureIdentityExamples.md#authenticating-with-a-pre-fetched-access-token).

Expand All @@ -43,25 +43,25 @@ To use the [DefaultAzureCredential][defaultazurecredential] provider shown below
npm install @azure/identity
```

You will also need to **register a new AAD application and grant access to Azure Portal** by assigning the suitable role to your service principal (note: roles such as `"Owner"` will not grant the necessary permissions).
You will also need to **register a new AAD application and grant access to Azure PortalForTesting** 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://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal).

```javascript
const { Portal } = require("@azure/arm-portal");
const { PortalForTesting } = require("@azure/arm-portal");
const { DefaultAzureCredential } = require("@azure/identity");
// For client-side applications running in the browser, use InteractiveBrowserCredential instead of DefaultAzureCredential. See https://aka.ms/azsdk/js/identity/examples for more details.

const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new Portal(new DefaultAzureCredential(), subscriptionId);
const client = new PortalForTesting(new DefaultAzureCredential(), subscriptionId);

// For client-side applications running in the browser, use this code instead:
// const credential = new InteractiveBrowserCredential({
// tenantId: "<YOUR_TENANT_ID>",
// clientId: "<YOUR_CLIENT_ID>"
// });
// const client = new Portal(credential, subscriptionId);
// const client = new PortalForTesting(credential, subscriptionId);
```


Expand All @@ -70,9 +70,9 @@ To use this client library in the browser, first you need to use a bundler. For

## Key concepts

### Portal
### PortalForTesting

`Portal` is the primary interface for developers using the Azure Portal client library. Explore the methods on this client object to understand the different features of the Azure Portal service that you can access.
`PortalForTesting` is the primary interface for developers using the Azure PortalForTesting client library. Explore the methods on this client object to understand the different features of the Azure PortalForTesting service that you can access.

## Troubleshooting

Expand Down
12 changes: 6 additions & 6 deletions sdk/portal/arm-portal/_meta.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"commit": "0cd7b3e83d5e7e21222dcc4bdde4565562da0cdf",
"readme": "specification\\portal\\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=F:\\azure-sdk-for-js ..\\azure-rest-api-specs\\specification\\portal\\resource-manager\\readme.md --use=@autorest/[email protected].0-rc.7 --generate-sample=true",
"repository_url": "https://github.com/Azure/azure-rest-api-specs.git",
"release_tool": "@azure-tools/js-sdk-release-tools@2.6.0",
"use": "@autorest/[email protected].0-rc.7"
"commit": "1060fcd8c4857cf9321bc9c66964cadef23e4805",
"readme": "specification/portal/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/portal/resource-manager/readme.md --use=@autorest/typescript@^6.0.12",
"repository_url": "https://github.com/test-repo-billy/azure-rest-api-specs.git",
"release_tool": "js-sdk-release-tools@2.7.21-beta",
"use": "@autorest/typescript@^6.0.12"
}
36 changes: 14 additions & 22 deletions sdk/portal/arm-portal/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@
"name": "@azure/arm-portal",
"sdk-type": "mgmt",
"author": "Microsoft Corporation",
"description": "A generated SDK for Portal.",
"description": "A generated SDK for PortalForTesting.",
"version": "1.0.0-beta.6",
"engines": {
"node": ">=18.0.0"
},
"dependencies": {
"@azure/core-paging": "^1.2.0",
"@azure/core-client": "^1.6.1",
"@azure/core-auth": "^1.3.0",
"@azure/core-rest-pipeline": "^1.8.0",
"@azure/core-client": "^1.7.0",
"@azure/core-auth": "^1.6.0",
"@azure/core-rest-pipeline": "^1.14.0",
"tslib": "^2.2.0"
},
"keywords": [
Expand All @@ -30,19 +30,20 @@
"mkdirp": "^3.0.1",
"typescript": "~5.5.3",
"uglify-js": "^3.4.9",
"rimraf": "^5.0.5",
"rimraf": "^5.0.0",
"dotenv": "^16.0.0",
"@azure/identity": "^4.0.1",
"@azure/dev-tool": "^1.0.0",
"@azure/identity": "^4.2.1",
"@azure-tools/test-recorder": "^3.0.0",
"@azure-tools/test-credential": "^1.0.0",
"@azure-tools/test-credential": "^1.1.0",
"mocha": "^10.0.0",
"@types/mocha": "^10.0.0",
"tsx": "^4.7.1",
"@types/chai": "^4.2.8",
"chai": "^4.2.0",
"cross-env": "^7.0.2",
"@types/node": "^18.0.0",
"@azure/dev-tool": "^1.0.0",
"ts-node": "^10.0.0",
"@types/mocha": "^10.0.0"
"ts-node": "^10.0.0"
},
"repository": {
"type": "git",
Expand Down Expand Up @@ -75,7 +76,6 @@
"pack": "npm pack 2>&1",
"extract-api": "dev-tool run extract-api",
"lint": "echo skipped",
"audit": "echo skipped",
"clean": "rimraf --glob dist dist-browser dist-esm test-dist temp types *.tgz *.log",
"build:node": "echo skipped",
"build:browser": "echo skipped",
Expand All @@ -98,19 +98,11 @@
"//metadata": {
"constantPaths": [
{
"path": "src/portal.ts",
"path": "src/portalForTesting.ts",
"prefix": "packageDetails"
}
]
},
"autoPublish": true,
"homepage": "https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/portal/arm-portal",
"//sampleConfiguration": {
"productName": "",
"productSlugs": [
"azure"
],
"disableDocsMs": true,
"apiRefLink": "https://docs.microsoft.com/javascript/api/@azure/arm-portal?view=azure-node-preview"
}
}
"homepage": "https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/portal/arm-portal"
}
Loading