Skip to content

Commit

Permalink
refresh relay package (Azure#22505)
Browse files Browse the repository at this point in the history
* refresh relay package

* refresh relay package

* refresh relay package

* refresh relay package

Co-authored-by: ZiWei Chen (WICRESOFT NORTH AMERICA LTD) <[email protected]>
  • Loading branch information
kazrael2119 and kazrael2119 authored Jul 8, 2022
1 parent 25a043b commit 96efd3b
Show file tree
Hide file tree
Showing 35 changed files with 1,895 additions and 3,429 deletions.
5 changes: 3 additions & 2 deletions common/config/rush/pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

22 changes: 12 additions & 10 deletions sdk/relay/arm-relay/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
# Release History

## 3.1.0 (2022-07-08)

**Features**

## 3.0.2 (Unreleased)

### Features Added

### Breaking Changes

### Bugs Fixed

### Other Changes

- Added Interface AuthorizationRule
- Added Interface HybridConnection
- Added Interface RelayNamespace
- Added Interface RelayUpdateParameters
- Added Interface ResourceNamespacePatch
- Added Interface TrackedResource
- Added Interface WcfRelay

## 3.0.1 (2022-04-29)

**Features**
Expand Down
14 changes: 7 additions & 7 deletions sdk/relay/arm-relay/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Azure Service client library for JavaScript
# Azure RelayApi client library for JavaScript

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

Use these API to manage Azure Relay resources through Azure Resource Manager.

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-relay` package

Install the Azure Service client library for JavaScript with `npm`:
Install the Azure RelayApi client library for JavaScript with `npm`:

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

### Create and authenticate a `RelayAPI`

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.
You can find the endpoint for your Azure Service resource in the [Azure Portal][azure_portal].
To create a client object to access the Azure RelayApi API, you will need the `endpoint` of your Azure RelayApi resource and a `credential`. The Azure RelayApi client can use Azure Active Directory credentials to authenticate.
You can find the endpoint for your Azure RelayApi 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,7 +43,7 @@ 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 Service** 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 RelayApi** 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).
Expand Down Expand Up @@ -72,7 +72,7 @@ To use this client library in the browser, first you need to use a bundler. For

### RelayAPI

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

## Troubleshooting

Expand Down
8 changes: 4 additions & 4 deletions sdk/relay/arm-relay/_meta.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"commit": "0cd7b3e83d5e7e21222dcc4bdde4565562da0cdf",
"readme": "specification\\relay\\resource-manager\\readme.md",
"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\\relay\\resource-manager\\readme.md --use=@autorest/[email protected]alpha.19.20220408.1 --generate-sample=true",
"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\\relay\\resource-manager\\readme.md --use=@autorest/[email protected]rc.1 --generate-sample=true",
"repository_url": "https://github.com/Azure/azure-rest-api-specs.git",
"release_tool": "@azure-tools/js-sdk-release-tools@2.3.0",
"use": "@autorest/[email protected]alpha.19.20220408.1"
}
"release_tool": "@azure-tools/js-sdk-release-tools@2.4.0",
"use": "@autorest/[email protected]rc.1"
}
17 changes: 10 additions & 7 deletions sdk/relay/arm-relay/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"sdk-type": "mgmt",
"author": "Microsoft Corporation",
"description": "A generated SDK for RelayAPI.",
"version": "3.0.2",
"version": "3.1.0",
"engines": {
"node": ">=12.0.0"
},
Expand Down Expand Up @@ -40,9 +40,13 @@
"uglify-js": "^3.4.9",
"rimraf": "^3.0.0",
"@azure/identity": "^2.0.1",
"@azure-tools/test-recorder": "^1.0.0",
"@azure-tools/test-recorder": "^2.0.0",
"@azure-tools/test-credential": "^1.0.0",
"mocha": "^7.1.1",
"cross-env": "^7.0.2"
"@types/chai": "^4.2.8",
"chai": "^4.2.0",
"cross-env": "^7.0.2",
"@azure/dev-tool": "^1.0.0"
},
"homepage": "https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/relay/arm-relay",
"repository": {
Expand Down Expand Up @@ -93,9 +97,8 @@
"unit-test:node": "cross-env TEST_MODE=playback npm run integration-test:node",
"unit-test:browser": "echo skipped",
"integration-test": "npm run integration-test:node && npm run integration-test:browser",
"integration-test:node": "mocha -r esm --require ts-node/register --timeout 1200000 --full-trace test/*.ts --reporter ../../../common/tools/mocha-multi-reporter.js",
"integration-test:browser": "echo skipped",
"docs": "echo skipped"
"integration-test:node": "dev-tool run test:node-ts-input -- --timeout 1200000 'test/*.ts'",
"integration-test:browser": "echo skipped"
},
"sideEffects": false,
"//metadata": {
Expand All @@ -115,4 +118,4 @@
"disableDocsMs": true,
"apiRefLink": "https://docs.microsoft.com/javascript/api/@azure/arm-relay?view=azure-node-preview"
}
}
}
Loading

0 comments on commit 96efd3b

Please sign in to comment.