Skip to content

Commit

Permalink
CodeGen from PR 14749 in Azure/azure-rest-api-specs
Browse files Browse the repository at this point in the history
Merge ffd67dc25f4c353226b06d70657f533c41f924c0 into 682c9680fd6ac7746d701bcf0c69948a3199671a
  • Loading branch information
SDKAuto committed Jun 29, 2021
1 parent c8126be commit a7a71d6
Show file tree
Hide file tree
Showing 36 changed files with 4,408 additions and 1,974 deletions.
2 changes: 1 addition & 1 deletion sdk/servicebus/arm-servicebus/LICENSE.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2020 Microsoft
Copyright (c) 2021 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
105 changes: 58 additions & 47 deletions sdk/servicebus/arm-servicebus/README.md
Original file line number Diff line number Diff line change
@@ -1,90 +1,101 @@
## Azure ServiceBusManagementClient SDK for JavaScript

This package contains an isomorphic SDK for ServiceBusManagementClient.
This package contains an isomorphic SDK (runs both in node.js and in browsers) for ServiceBusManagementClient.

### Currently supported environments

- Node.js version 6.x.x or higher
- Browser JavaScript
- [LTS versions of Node.js](https://nodejs.org/about/releases/)
- Latest versions of Safari, Chrome, Edge and Firefox.

### How to Install
### Prerequisites

You must have an [Azure subscription](https://azure.microsoft.com/free/).

### How to install

To use this SDK in your project, you will need to install two packages.
- `@azure/arm-servicebus` that contains the client.
- `@azure/identity` that provides different mechanisms for the client to authenticate your requests using Azure Active Directory.

Install both packages using the below command:
```bash
npm install @azure/arm-servicebus
npm install --save @azure/arm-servicebus @azure/identity
```
> **Note**: You may have used either `@azure/ms-rest-nodeauth` or `@azure/ms-rest-browserauth` in the past. These packages are in maintenance mode receiving critical bug fixes, but no new features.
If you are on a [Node.js that has LTS status](https://nodejs.org/about/releases/), or are writing a client side browser application, we strongly encourage you to upgrade to `@azure/identity` which uses the latest versions of Azure Active Directory and MSAL APIs and provides more authentication options.

### How to use

#### nodejs - Authentication, client creation and list operations as an example written in TypeScript.
- If you are writing a client side browser application,
- Follow the instructions in the section on Authenticating client side browser applications in [Azure Identity examples](https://aka.ms/azsdk/js/identity/examples) to register your application in the Microsoft identity platform and set the right permissions.
- Copy the client ID and tenant ID from the Overview section of your app registration in Azure portal and use it in the browser sample below.
- If you are writing a server side application,
- [Select a credential from `@azure/identity` based on the authentication method of your choice](https://aka.ms/azsdk/js/identity/examples)
- Complete the set up steps required by the credential if any.
- Use the credential you picked in the place of `DefaultAzureCredential` in the Node.js sample below.

##### Install @azure/ms-rest-nodeauth

- Please install minimum version of `"@azure/ms-rest-nodeauth": "^3.0.0"`.
```bash
npm install @azure/ms-rest-nodeauth@"^3.0.0"
```
In the below samples, we pass the credential and the Azure subscription id to instantiate the client.
Once the client is created, explore the operations on it either in your favorite editor or in our [API reference documentation](https://docs.microsoft.com/javascript/api) to get started.
#### nodejs - Authentication, client creation, and listIpFilterRules namespaces as an example written in JavaScript.

##### Sample code

```typescript
import * as msRest from "@azure/ms-rest-js";
import * as msRestAzure from "@azure/ms-rest-azure-js";
import * as msRestNodeAuth from "@azure/ms-rest-nodeauth";
import { ServiceBusManagementClient, ServiceBusManagementModels, ServiceBusManagementMappers } from "@azure/arm-servicebus";
```javascript
const { DefaultAzureCredential } = require("@azure/identity");
const { ServiceBusManagementClient } = require("@azure/arm-servicebus");
const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"];

msRestNodeAuth.interactiveLogin().then((creds) => {
const client = new ServiceBusManagementClient(creds, subscriptionId);
client.operations.list().then((result) => {
console.log("The result is:");
console.log(result);
});
// Use `DefaultAzureCredential` or any other credential of your choice based on https://aka.ms/azsdk/js/identity/examples
// Please note that you can also use credentials from the `@azure/ms-rest-nodeauth` package instead.
const creds = new DefaultAzureCredential();
const client = new ServiceBusManagementClient(creds, subscriptionId);
const resourceGroupName = "testresourceGroupName";
const namespaceName = "testnamespaceName";
client.namespaces.listIpFilterRules(resourceGroupName, namespaceName).then((result) => {
console.log("The result is:");
console.log(result);
}).catch((err) => {
console.log("An error occurred:");
console.error(err);
});
```

#### browser - Authentication, client creation and list operations as an example written in JavaScript.
#### browser - Authentication, client creation, and listIpFilterRules namespaces as an example written in JavaScript.

##### Install @azure/ms-rest-browserauth

```bash
npm install @azure/ms-rest-browserauth
```
In browser applications, we recommend using the `InteractiveBrowserCredential` that interactively authenticates using the default system browser.
- See [Single-page application: App registration guide](https://docs.microsoft.com/azure/active-directory/develop/scenario-spa-app-registration) to configure your app registration for the browser.
- Note down the client Id from the previous step and use it in the browser sample below.

##### Sample code

See https://github.com/Azure/ms-rest-browserauth to learn how to authenticate to Azure in the browser.

- index.html

```html
<!DOCTYPE html>
<html lang="en">
<head>
<title>@azure/arm-servicebus sample</title>
<script src="node_modules/@azure/ms-rest-js/dist/msRest.browser.js"></script>
<script src="node_modules/@azure/ms-rest-azure-js/dist/msRestAzure.js"></script>
<script src="node_modules/@azure/ms-rest-browserauth/dist/msAuth.js"></script>
<script src="node_modules/@azure/identity/dist/index.js"></script>
<script src="node_modules/@azure/arm-servicebus/dist/arm-servicebus.js"></script>
<script type="text/javascript">
const subscriptionId = "<Subscription_Id>";
const authManager = new msAuth.AuthManager({
// Create credentials using the `@azure/identity` package.
// Please note that you can also use credentials from the `@azure/ms-rest-browserauth` package instead.
const credential = new InteractiveBrowserCredential(
{
clientId: "<client id for your Azure AD app>",
tenant: "<optional tenant for your organization>"
});
authManager.finalizeLogin().then((res) => {
if (!res.isLoggedIn) {
// may cause redirects
authManager.login();
}
const client = new Azure.ArmServicebus.ServiceBusManagementClient(res.creds, subscriptionId);
client.operations.list().then((result) => {
console.log("The result is:");
console.log(result);
}).catch((err) => {
console.log("An error occurred:");
console.error(err);
});
const client = new Azure.ArmServicebus.ServiceBusManagementClient(creds, subscriptionId);
const resourceGroupName = "testresourceGroupName";
const namespaceName = "testnamespaceName";
client.namespaces.listIpFilterRules(resourceGroupName, namespaceName).then((result) => {
console.log("The result is:");
console.log(result);
}).catch((err) => {
console.log("An error occurred:");
console.error(err);
});
</script>
</head>
Expand Down
9 changes: 5 additions & 4 deletions sdk/servicebus/arm-servicebus/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@
"description": "ServiceBusManagementClient Library with typescript type definitions for node.js and browser.",
"version": "4.0.0",
"dependencies": {
"@azure/ms-rest-azure-js": "^2.0.1",
"@azure/ms-rest-js": "^2.0.4",
"@azure/ms-rest-azure-js": "^2.1.0",
"@azure/ms-rest-js": "^2.2.0",
"@azure/core-auth": "^1.1.4",
"tslib": "^1.10.0"
},
"keywords": [
Expand All @@ -20,13 +21,13 @@
"module": "./esm/serviceBusManagementClient.js",
"types": "./esm/serviceBusManagementClient.d.ts",
"devDependencies": {
"typescript": "^3.5.3",
"typescript": "^3.6.0",
"rollup": "^1.18.0",
"rollup-plugin-node-resolve": "^5.2.0",
"rollup-plugin-sourcemaps": "^0.4.2",
"uglify-js": "^3.6.0"
},
"homepage": "https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/servicebus/arm-servicebus",
"homepage": "https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/servicebus/arm-servicebus",
"repository": {
"type": "git",
"url": "https://github.com/Azure/azure-sdk-for-js.git"
Expand Down
4 changes: 2 additions & 2 deletions sdk/servicebus/arm-servicebus/rollup.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ const config = {
"@azure/ms-rest-azure-js": "msRestAzure"
},
banner: `/*
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
* Copyright (c) Microsoft Corporation.
* Licensed under the MIT License.
*
* Code generated by Microsoft (R) AutoRest Code Generator.
* Changes may cause incorrect behavior and will be lost if the code is regenerated.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
* Copyright (c) Microsoft Corporation.
* Licensed under the MIT License.
*
* Code generated by Microsoft (R) AutoRest Code Generator.
* Changes may cause incorrect behavior and will be lost if the code is regenerated.
Expand All @@ -15,17 +15,27 @@ export {
CaptureDescription,
CheckNameAvailability,
CheckNameAvailabilityResult,
ConnectionState,
CorrelationFilter,
Destination,
Encryption,
ErrorAdditionalInfo,
ErrorResponse,
ErrorResponseError,
Eventhub,
FailoverProperties,
Identity,
IpFilterRule,
KeyVaultProperties,
MessageCountDetails,
MigrationConfigProperties,
NetworkRuleSet,
NWRuleSetIpRules,
NWRuleSetVirtualNetworkRules,
PremiumMessagingRegions,
PremiumMessagingRegionsProperties,
PrivateEndpoint,
PrivateEndpointConnection,
Resource,
ResourceNamespacePatch,
Rule,
Expand All @@ -40,5 +50,6 @@ export {
SqlFilter,
SqlRuleAction,
Subnet,
TrackedResource
TrackedResource,
VirtualNetworkRule
} from "../models/mappers";
16 changes: 13 additions & 3 deletions sdk/servicebus/arm-servicebus/src/models/eventHubsMappers.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
* Copyright (c) Microsoft Corporation.
* Licensed under the MIT License.
*
* Code generated by Microsoft (R) AutoRest Code Generator.
* Changes may cause incorrect behavior and will be lost if the code is regenerated.
Expand All @@ -11,18 +11,27 @@ export {
ArmDisasterRecovery,
BaseResource,
CaptureDescription,
ConnectionState,
CorrelationFilter,
Destination,
Encryption,
ErrorAdditionalInfo,
ErrorResponse,
ErrorResponseError,
Eventhub,
EventHubListResult,
Identity,
IpFilterRule,
KeyVaultProperties,
MessageCountDetails,
MigrationConfigProperties,
NetworkRuleSet,
NWRuleSetIpRules,
NWRuleSetVirtualNetworkRules,
PremiumMessagingRegions,
PremiumMessagingRegionsProperties,
PrivateEndpoint,
PrivateEndpointConnection,
Resource,
ResourceNamespacePatch,
Rule,
Expand All @@ -36,5 +45,6 @@ export {
SqlFilter,
SqlRuleAction,
Subnet,
TrackedResource
TrackedResource,
VirtualNetworkRule
} from "../models/mappers";
Loading

0 comments on commit a7a71d6

Please sign in to comment.