Skip to content

Commit 581b2ae

Browse files
authored
release extendedlocation package (Azure#22653)
* release extendedlocation package * Update ci.mgmt.yml Co-authored-by: ZiWei Chen (WICRESOFT NORTH AMERICA LTD) <v-ziweichen@microsoft.com>
1 parent aae5c89 commit 581b2ae

File tree

75 files changed

+3579
-323
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

75 files changed

+3579
-323
lines changed

common/config/rush/pnpm-lock.yaml

Lines changed: 8 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Lines changed: 39 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,44 @@
1-
## Release History
1+
# Release History
2+
3+
## 1.0.0-beta.2 (2022-07-20)
4+
5+
**Features**
26

3-
### 1.0.0-beta.2 (Unreleased)
7+
- Added operation group ResourceSyncRules
8+
- Added operation CustomLocations.findTargetResourceGroup
9+
- Added Interface CustomLocation
10+
- Added Interface CustomLocationFindTargetResourceGroupProperties
11+
- Added Interface CustomLocationFindTargetResourceGroupResult
12+
- Added Interface CustomLocationsFindTargetResourceGroupOptionalParams
13+
- Added Interface EnabledResourceType
14+
- Added Interface MatchExpressionsProperties
15+
- Added Interface PatchableResourceSyncRule
16+
- Added Interface ProxyResource
17+
- Added Interface ResourceSyncRule
18+
- Added Interface ResourceSyncRuleListResult
19+
- Added Interface ResourceSyncRulePropertiesSelector
20+
- Added Interface ResourceSyncRulesCreateOrUpdateOptionalParams
21+
- Added Interface ResourceSyncRulesDeleteOptionalParams
22+
- Added Interface ResourceSyncRulesGetOptionalParams
23+
- Added Interface ResourceSyncRulesListByCustomLocationIDNextOptionalParams
24+
- Added Interface ResourceSyncRulesListByCustomLocationIDOptionalParams
25+
- Added Interface ResourceSyncRulesUpdateOptionalParams
26+
- Added Interface TrackedResource
27+
- Added Type Alias CustomLocationsFindTargetResourceGroupResponse
28+
- Added Type Alias ResourceSyncRulesCreateOrUpdateResponse
29+
- Added Type Alias ResourceSyncRulesGetResponse
30+
- Added Type Alias ResourceSyncRulesListByCustomLocationIDNextResponse
31+
- Added Type Alias ResourceSyncRulesListByCustomLocationIDResponse
32+
- Added Type Alias ResourceSyncRulesUpdateResponse
33+
- Class CustomLocationsManagementClient has a new parameter $host
34+
- Class CustomLocationsManagementClient has a new parameter apiVersion
35+
- Class CustomLocationsManagementClient has a new parameter resourceSyncRules
36+
- Class CustomLocationsManagementClient has a new parameter subscriptionId
437

5-
#### Features Added
38+
**Breaking Changes**
639

7-
#### Breaking Changes
8-
9-
#### Bugs Fixed
10-
11-
#### Other Changes
12-
13-
### 1.0.0-beta.1 (2021-10-08)
40+
- Deleted Class CustomLocationsManagementClientContext
41+
42+
## 1.0.0-beta.1 (2021-10-08)
1443

1544
- Initial Release

sdk/extendedlocation/arm-extendedlocation/LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2021 Microsoft
3+
Copyright (c) 2022 Microsoft
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

sdk/extendedlocation/arm-extendedlocation/README.md

Lines changed: 23 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# Azure customLocationsManagement client library for JavaScript
1+
# Azure CustomLocationsManagement client library for JavaScript
22

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

55
The customLocations Rest API spec.
66

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

1212
## Getting started
@@ -16,22 +16,24 @@ The customLocations Rest API spec.
1616
- [LTS versions of Node.js](https://nodejs.org/about/releases/)
1717
- Latest versions of Safari, Chrome, Edge and Firefox.
1818

19+
See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details.
20+
1921
### Prerequisites
2022

2123
- An [Azure subscription][azure_sub].
2224

2325
### Install the `@azure/arm-extendedlocation` package
2426

25-
Install the Azure customLocationsManagement client library for JavaScript with `npm`:
27+
Install the Azure CustomLocationsManagement client library for JavaScript with `npm`:
2628

2729
```bash
2830
npm install @azure/arm-extendedlocation
2931
```
3032

3133
### Create and authenticate a `CustomLocationsManagementClient`
3234

33-
To create a client object to access the Azure customLocationsManagement API, you will need the `endpoint` of your Azure customLocationsManagement resource and a `credential`. The Azure customLocationsManagement client can use Azure Active Directory credentials to authenticate.
34-
You can find the endpoint for your Azure customLocationsManagement resource in the [Azure Portal][azure_portal].
35+
To create a client object to access the Azure CustomLocationsManagement API, you will need the `endpoint` of your Azure CustomLocationsManagement resource and a `credential`. The Azure CustomLocationsManagement client can use Azure Active Directory credentials to authenticate.
36+
You can find the endpoint for your Azure CustomLocationsManagement resource in the [Azure Portal][azure_portal].
3537

3638
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).
3739

@@ -41,23 +43,36 @@ To use the [DefaultAzureCredential][defaultazurecredential] provider shown below
4143
npm install @azure/identity
4244
```
4345

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

4749
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).
4850

4951
```javascript
5052
const { CustomLocationsManagementClient } = require("@azure/arm-extendedlocation");
5153
const { DefaultAzureCredential } = require("@azure/identity");
54+
// For client-side applications running in the browser, use InteractiveBrowserCredential instead of DefaultAzureCredential. See https://aka.ms/azsdk/js/identity/examples for more details.
55+
5256
const subscriptionId = "00000000-0000-0000-0000-000000000000";
5357
const client = new CustomLocationsManagementClient(new DefaultAzureCredential(), subscriptionId);
58+
59+
// For client-side applications running in the browser, use this code instead:
60+
// const credential = new InteractiveBrowserCredential({
61+
// tenantId: "<YOUR_TENANT_ID>",
62+
// clientId: "<YOUR_CLIENT_ID>"
63+
// });
64+
// const client = new CustomLocationsManagementClient(credential, subscriptionId);
5465
```
5566

67+
68+
### JavaScript Bundle
69+
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).
70+
5671
## Key concepts
5772

5873
### CustomLocationsManagementClient
5974

60-
`CustomLocationsManagementClient` is the primary interface for developers using the Azure customLocationsManagement client library. Explore the methods on this client object to understand the different features of the Azure customLocationsManagement service that you can access.
75+
`CustomLocationsManagementClient` is the primary interface for developers using the Azure CustomLocationsManagement client library. Explore the methods on this client object to understand the different features of the Azure CustomLocationsManagement service that you can access.
6176

6277
## Troubleshooting
6378

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
{
2-
"commit": "5cf3e4a0c30ad5167088ac839453578b2e8e9afc",
2+
"commit": "ca5d9600e4950afdae3c23c71d9407b6aa3fce63",
33
"readme": "specification/extendedlocation/resource-manager/readme.md",
4-
"autorest_command": "autorest --version=3.1.3 --typescript --modelerfour.lenient-model-deduplication --head-as-boolean=true --license-header=MICROSOFT_MIT_NO_VERSION --generate-test --typescript-sdks-folder=D:\\mydev\\azure-sdk-for-js ../azure-rest-api-specs/specification/extendedlocation/resource-manager/readme.md --use=@autorest/typescript@6.0.0-beta.13",
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\\extendedlocation\\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-
"use": "@autorest/typescript@6.0.0-beta.13"
6+
"release_tool": "@azure-tools/js-sdk-release-tools@2.4.0",
7+
"use": "@autorest/typescript@6.0.0-rc.1"
78
}
Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,31 @@
11
{
22
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
33
"mainEntryPointFilePath": "./dist-esm/src/index.d.ts",
4-
"docModel": { "enabled": true },
5-
"apiReport": { "enabled": true, "reportFolder": "./review" },
4+
"docModel": {
5+
"enabled": true
6+
},
7+
"apiReport": {
8+
"enabled": true,
9+
"reportFolder": "./review"
10+
},
611
"dtsRollup": {
712
"enabled": true,
813
"untrimmedFilePath": "",
914
"publicTrimmedFilePath": "./types/arm-extendedlocation.d.ts"
1015
},
1116
"messages": {
12-
"tsdocMessageReporting": { "default": { "logLevel": "none" } },
17+
"tsdocMessageReporting": {
18+
"default": {
19+
"logLevel": "none"
20+
}
21+
},
1322
"extractorMessageReporting": {
14-
"ae-missing-release-tag": { "logLevel": "none" },
15-
"ae-unresolved-link": { "logLevel": "none" }
23+
"ae-missing-release-tag": {
24+
"logLevel": "none"
25+
},
26+
"ae-unresolved-link": {
27+
"logLevel": "none"
28+
}
1629
}
1730
}
18-
}
31+
}

sdk/extendedlocation/arm-extendedlocation/package.json

Lines changed: 37 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@
1010
"dependencies": {
1111
"@azure/core-lro": "^2.2.0",
1212
"@azure/abort-controller": "^1.0.0",
13-
"@azure/core-paging": "^1.1.1",
14-
"@azure/core-client": "^1.0.0",
13+
"@azure/core-paging": "^1.2.0",
14+
"@azure/core-client": "^1.5.0",
1515
"@azure/core-auth": "^1.3.0",
16-
"@azure/core-rest-pipeline": "^1.1.0",
16+
"@azure/core-rest-pipeline": "^1.8.0",
1717
"tslib": "^2.2.0"
1818
},
1919
"keywords": [
@@ -30,18 +30,23 @@
3030
"devDependencies": {
3131
"@microsoft/api-extractor": "7.18.11",
3232
"@rollup/plugin-commonjs": "^21.0.1",
33-
"@rollup/plugin-json": "^4.0.0",
34-
"@rollup/plugin-multi-entry": "^3.0.0",
35-
"@rollup/plugin-node-resolve": "^8.0.0",
33+
"@rollup/plugin-json": "^4.1.0",
34+
"@rollup/plugin-multi-entry": "^4.1.0",
35+
"@rollup/plugin-node-resolve": "^13.1.3",
3636
"mkdirp": "^1.0.4",
37-
"rollup": "^2.0.0",
38-
"rollup-plugin-sourcemaps": "^0.4.2",
37+
"rollup": "^2.66.1",
38+
"rollup-plugin-sourcemaps": "^0.6.3",
3939
"typescript": "~4.2.0",
4040
"uglify-js": "^3.4.9",
41+
"rimraf": "^3.0.0",
4142
"@azure/identity": "^2.0.1",
42-
"@azure-tools/test-recorder": "^1.0.0",
43+
"@azure-tools/test-recorder": "^2.0.0",
44+
"@azure-tools/test-credential": "^1.0.0",
4345
"mocha": "^7.1.1",
44-
"cross-env": "^7.0.2"
46+
"@types/chai": "^4.2.8",
47+
"chai": "^4.2.0",
48+
"cross-env": "^7.0.2",
49+
"@azure/dev-tool": "^1.0.0"
4550
},
4651
"homepage": "https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/extendedlocation/arm-extendedlocation",
4752
"repository": {
@@ -70,14 +75,14 @@
7075
"types/*"
7176
],
7277
"scripts": {
73-
"build": "tsc && rollup -c 2>&1 && npm run minify && mkdirp ./review && npm run extract-api",
78+
"build": "npm run clean && tsc && rollup -c 2>&1 && npm run minify && mkdirp ./review && npm run extract-api",
7479
"minify": "uglifyjs -c -m --comments --source-map \"content='./dist/index.js.map'\" -o ./dist/index.min.js ./dist/index.js",
7580
"prepack": "npm run build",
7681
"pack": "npm pack 2>&1",
7782
"extract-api": "api-extractor run --local",
7883
"lint": "echo skipped",
7984
"audit": "echo skipped",
80-
"clean": "echo skipped",
85+
"clean": "rimraf dist dist-browser dist-esm test-dist temp types *.tgz *.log",
8186
"build:node": "echo skipped",
8287
"build:browser": "echo skipped",
8388
"build:test": "echo skipped",
@@ -86,17 +91,31 @@
8691
"execute:samples": "echo skipped",
8792
"format": "echo skipped",
8893
"test": "npm run integration-test",
89-
"prebuild": "echo skipped",
9094
"test:node": "echo skipped",
9195
"test:browser": "echo skipped",
9296
"unit-test": "npm run unit-test:node && npm run unit-test:browser",
9397
"unit-test:node": "cross-env TEST_MODE=playback npm run integration-test:node",
9498
"unit-test:browser": "echo skipped",
9599
"integration-test": "npm run integration-test:node && npm run integration-test:browser",
96-
"integration-test:node": "mocha -r esm --require ts-node/register --timeout 1200000 --full-trace test/*.ts",
97-
"integration-test:browser": "echo skipped",
98-
"docs": "echo skipped"
100+
"integration-test:node": "dev-tool run test:node-ts-input -- --timeout 1200000 'test/*.ts'",
101+
"integration-test:browser": "echo skipped"
99102
},
100103
"sideEffects": false,
101-
"autoPublish": true
102-
}
104+
"//metadata": {
105+
"constantPaths": [
106+
{
107+
"path": "src/customLocationsManagementClient.ts",
108+
"prefix": "packageDetails"
109+
}
110+
]
111+
},
112+
"autoPublish": true,
113+
"//sampleConfiguration": {
114+
"productName": "",
115+
"productSlugs": [
116+
"azure"
117+
],
118+
"disableDocsMs": true,
119+
"apiRefLink": "https://docs.microsoft.com/javascript/api/@azure/arm-extendedlocation?view=azure-node-preview"
120+
}
121+
}

sdk/extendedlocation/arm-extendedlocation/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.

0 commit comments

Comments
 (0)