Skip to content

Commit 0cf3afd

Browse files
authored
refresh portal package (Azure#22510)
* refresh portal package * refresh portal package Co-authored-by: ZiWei Chen (WICRESOFT NORTH AMERICA LTD) <v-ziweichen@microsoft.com>
1 parent 095ae6e commit 0cf3afd

File tree

11 files changed

+114
-84
lines changed

11 files changed

+114
-84
lines changed

common/config/rush/pnpm-lock.yaml

Lines changed: 17 additions & 17 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

sdk/portal/arm-portal/CHANGELOG.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,13 @@
1-
## Release History
2-
3-
### 1.0.0-beta.4 (Unreleased)
4-
5-
#### Features Added
6-
7-
#### Breaking Changes
8-
9-
#### Bugs Fixed
10-
11-
#### Other Changes
1+
# Release History
2+
3+
## 1.0.0-beta.4 (2022-07-08)
4+
5+
**Features**
126

7+
- Added Interface Configuration
8+
- Added Interface MarkdownPartMetadata
9+
- Added Interface ProxyResource
10+
1311
### 1.0.0-beta.3 (2022-04-28)
1412

1513
**Features**

sdk/portal/arm-portal/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Azure Service client library for JavaScript
1+
# Azure Portal client library for JavaScript
22

3-
This package contains an isomorphic SDK (runs both in Node.js and in browsers) for Azure Service client.
3+
This package contains an isomorphic SDK (runs both in Node.js and in browsers) for Azure Portal client.
44

55
Allows creation and deletion of Azure Shared Dashboards.
66

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

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

27-
Install the Azure Service client library for JavaScript with `npm`:
27+
Install the Azure Portal client library for JavaScript with `npm`:
2828

2929
```bash
3030
npm install @azure/arm-portal
3131
```
3232

3333
### Create and authenticate a `Portal`
3434

35-
To create a client object to access the Azure Service API, you will need the `endpoint` of your Azure Service resource and a `credential`. The Azure Service client can use Azure Active Directory credentials to authenticate.
36-
You can find the endpoint for your Azure Service resource in the [Azure Portal][azure_portal].
35+
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.
36+
You can find the endpoint for your Azure Portal resource in the [Azure Portal][azure_portal].
3737

3838
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).
3939

@@ -43,7 +43,7 @@ To use the [DefaultAzureCredential][defaultazurecredential] provider shown below
4343
npm install @azure/identity
4444
```
4545

46-
You will also need to **register a new AAD application and grant access to Azure Service** by assigning the suitable role to your service principal (note: roles such as `"Owner"` will not grant the necessary permissions).
46+
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).
4747
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`.
4848

4949
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).
@@ -72,7 +72,7 @@ To use this client library in the browser, first you need to use a bundler. For
7272

7373
### Portal
7474

75-
`Portal` is the primary interface for developers using the Azure Service client library. Explore the methods on this client object to understand the different features of the Azure Service service that you can access.
75+
`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.
7676

7777
## Troubleshooting
7878

sdk/portal/arm-portal/_meta.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
22
"commit": "0cd7b3e83d5e7e21222dcc4bdde4565562da0cdf",
33
"readme": "specification\\portal\\resource-manager\\readme.md",
4-
"autorest_command": "autorest --version=3.7.3 --typescript --modelerfour.lenient-model-deduplication --head-as-boolean=true --license-header=MICROSOFT_MIT_NO_VERSION --generate-test --typescript-sdks-folder=D:\\work\\azure-sdk-for-js ..\\azure-rest-api-specs\\specification\\portal\\resource-manager\\readme.md --use=@autorest/typescript@6.0.0-alpha.19.20220408.1 --generate-sample=true",
4+
"autorest_command": "autorest --version=3.7.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\\portal\\resource-manager\\readme.md --use=@autorest/typescript@6.0.0-rc.1 --generate-sample=true",
55
"repository_url": "https://github.com/Azure/azure-rest-api-specs.git",
6-
"release_tool": "@azure-tools/js-sdk-release-tools@2.3.0",
7-
"use": "@autorest/typescript@6.0.0-alpha.19.20220408.1"
8-
}
6+
"release_tool": "@azure-tools/js-sdk-release-tools@2.4.0",
7+
"use": "@autorest/typescript@6.0.0-rc.1"
8+
}

sdk/portal/arm-portal/package.json

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,13 @@
3838
"uglify-js": "^3.4.9",
3939
"rimraf": "^3.0.0",
4040
"@azure/identity": "^2.0.1",
41-
"@azure-tools/test-recorder": "^1.0.0",
41+
"@azure-tools/test-recorder": "^2.0.0",
42+
"@azure-tools/test-credential": "^1.0.0",
4243
"mocha": "^7.1.1",
43-
"cross-env": "^7.0.2"
44+
"@types/chai": "^4.2.8",
45+
"chai": "^4.2.0",
46+
"cross-env": "^7.0.2",
47+
"@azure/dev-tool": "^1.0.0"
4448
},
4549
"homepage": "https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/portal/arm-portal",
4650
"repository": {
@@ -91,9 +95,8 @@
9195
"unit-test:node": "cross-env TEST_MODE=playback npm run integration-test:node",
9296
"unit-test:browser": "echo skipped",
9397
"integration-test": "npm run integration-test:node && npm run integration-test:browser",
94-
"integration-test:node": "mocha -r esm --require ts-node/register --timeout 1200000 --full-trace test/*.ts --reporter ../../../common/tools/mocha-multi-reporter.js",
95-
"integration-test:browser": "echo skipped",
96-
"docs": "echo skipped"
98+
"integration-test:node": "dev-tool run test:node-ts-input -- --timeout 1200000 'test/*.ts'",
99+
"integration-test:browser": "echo skipped"
97100
},
98101
"sideEffects": false,
99102
"//metadata": {
@@ -113,4 +116,4 @@
113116
"disableDocsMs": true,
114117
"apiRefLink": "https://docs.microsoft.com/javascript/api/@azure/arm-portal?view=azure-node-preview"
115118
}
116-
}
119+
}

sdk/portal/arm-portal/recordings/node/my_test/recording_sample_test.js

Lines changed: 0 additions & 5 deletions
This file was deleted.

sdk/portal/arm-portal/recordings/node/my_test/recording_sample_test.json

Lines changed: 4 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

sdk/portal/arm-portal/review/arm-portal.api.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ import * as coreClient from '@azure/core-client';
99
import { PagedAsyncIterableIterator } from '@azure/core-paging';
1010

1111
// @public
12-
export type Configuration = ProxyResource & {
12+
export interface Configuration extends ProxyResource {
1313
enforcePrivateMarkdownStorage?: boolean;
14-
};
14+
}
1515

1616
// @public
1717
export interface ConfigurationList {
@@ -155,7 +155,6 @@ export interface ErrorResponse {
155155

156156
// @public
157157
export enum KnownConfigurationName {
158-
// (undocumented)
159158
Default = "default"
160159
}
161160

@@ -179,11 +178,11 @@ export interface ListTenantConfigurationViolationsListOptionalParams extends cor
179178
export type ListTenantConfigurationViolationsListResponse = ViolationsList;
180179

181180
// @public
182-
export type MarkdownPartMetadata = DashboardPartMetadata & {
183-
type: "Extension/HubsExtension/PartType/MarkdownPart";
181+
export interface MarkdownPartMetadata extends DashboardPartMetadata {
184182
inputs?: Record<string, unknown>[];
185183
settings?: MarkdownPartMetadataSettings;
186-
};
184+
type: "Extension/HubsExtension/PartType/MarkdownPart";
185+
}
187186

188187
// @public
189188
export interface MarkdownPartMetadataSettings {
@@ -261,7 +260,8 @@ export interface PortalOptionalParams extends coreClient.ServiceClientOptions {
261260
}
262261

263262
// @public
264-
export type ProxyResource = Resource & {};
263+
export interface ProxyResource extends Resource {
264+
}
265265

266266
// @public
267267
export interface Resource {

sdk/portal/arm-portal/src/models/index.ts

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -233,26 +233,27 @@ export interface MarkdownPartMetadataSettingsContentSettings {
233233
}
234234

235235
/** Markdown part metadata. */
236-
export type MarkdownPartMetadata = DashboardPartMetadata & {
236+
export interface MarkdownPartMetadata extends DashboardPartMetadata {
237237
/** Polymorphic discriminator, which specifies the different types this object can be */
238238
type: "Extension/HubsExtension/PartType/MarkdownPart";
239239
/** Input to dashboard part. */
240240
inputs?: Record<string, unknown>[];
241241
/** Markdown part settings. */
242242
settings?: MarkdownPartMetadataSettings;
243-
};
243+
}
244244

245245
/** The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location */
246-
export type ProxyResource = Resource & {};
246+
export interface ProxyResource extends Resource {}
247247

248248
/** Tenant configuration. */
249-
export type Configuration = ProxyResource & {
249+
export interface Configuration extends ProxyResource {
250250
/** When flag is set to true Markdown tile will require external storage configuration (URI). The inline content configuration will be prohibited. */
251251
enforcePrivateMarkdownStorage?: boolean;
252-
};
252+
}
253253

254254
/** Known values of {@link ConfigurationName} that the service accepts. */
255255
export enum KnownConfigurationName {
256+
/** Default */
256257
Default = "default"
257258
}
258259

0 commit comments

Comments
 (0)