Skip to content
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

[AutoPR @azure/arm-recoveryservicesbackup] Fixing swagger correctness and completeness issues for RecoveryServicesBackup #5385

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
61 changes: 24 additions & 37 deletions sdk/recoveryservicesbackup/arm-recoveryservicesbackup/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
## Azure RecoveryServicesBackupClient SDK for JavaScript

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

### Currently supported environments

- [LTS versions of Node.js](https://nodejs.org/about/releases/)
- Latest versions of Safari, Chrome, Edge, and Firefox.
- Latest versions of Safari, Chrome, Edge and Firefox.

### Prerequisites

Expand All @@ -14,18 +14,15 @@ 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-recoveryservicesbackup` 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 --save @azure/arm-recoveryservicesbackup @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.
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

Expand All @@ -39,8 +36,7 @@ npm install --save @azure/arm-recoveryservicesbackup @azure/identity

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 get backupResourceVaultConfigs as an example written in JavaScript.
#### nodejs - Authentication, client creation, and get backupResourceStorageConfigsNonCRR as an example written in JavaScript.

##### Sample code

Expand All @@ -55,24 +51,20 @@ const creds = new DefaultAzureCredential();
const client = new RecoveryServicesBackupClient(creds, subscriptionId);
const vaultName = "testvaultName";
const resourceGroupName = "testresourceGroupName";
client.backupResourceVaultConfigs
.get(vaultName, resourceGroupName)
.then((result) => {
console.log("The result is:");
console.log(result);
})
.catch((err) => {
console.log("An error occurred:");
console.error(err);
});
client.backupResourceStorageConfigsNonCRR.get(vaultName, resourceGroupName).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 get backupResourceVaultConfigs as an example written in JavaScript.
#### browser - Authentication, client creation, and get backupResourceStorageConfigsNonCRR as an example written in JavaScript.

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.
- 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

Expand All @@ -90,26 +82,21 @@ In browser applications, we recommend using the `InteractiveBrowserCredential` t
const subscriptionId = "<Subscription_Id>";
// 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({
const credential = new InteractiveBrowserCredential(
{
clientId: "<client id for your Azure AD app>",
tenant: "<optional tenant for your organization>"
});
const client = new Azure.ArmRecoveryservicesbackup.RecoveryServicesBackupClient(
creds,
subscriptionId
);
const client = new Azure.ArmRecoveryservicesbackup.RecoveryServicesBackupClient(creds, subscriptionId);
const vaultName = "testvaultName";
const resourceGroupName = "testresourceGroupName";
client.backupResourceVaultConfigs
.get(vaultName, resourceGroupName)
.then((result) => {
console.log("The result is:");
console.log(result);
})
.catch((err) => {
console.log("An error occurred:");
console.error(err);
});
client.backupResourceStorageConfigsNonCRR.get(vaultName, resourceGroupName).then((result) => {
console.log("The result is:");
console.log(result);
}).catch((err) => {
console.log("An error occurred:");
console.error(err);
});
</script>
</head>
<body></body>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
"rollup-plugin-sourcemaps": "^0.4.2",
"uglify-js": "^3.6.0"
},
"homepage": "https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/recoveryservicesbackup/arm-recoveryservicesbackup",
"homepage": "https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/recoveryservicesbackup/arm-recoveryservicesbackup",
"repository": {
"type": "git",
"url": "https://github.com/Azure/azure-sdk-for-js.git"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,10 @@ import sourcemaps from "rollup-plugin-sourcemaps";
*/
const config = {
input: "./esm/recoveryServicesBackupClient.js",
external: ["@azure/ms-rest-js", "@azure/ms-rest-azure-js"],
external: [
"@azure/ms-rest-js",
"@azure/ms-rest-azure-js"
],
output: {
file: "./dist/arm-recoveryservicesbackup.js",
format: "umd",
Expand All @@ -25,7 +28,10 @@ const config = {
* Changes may cause incorrect behavior and will be lost if the code is regenerated.
*/`
},
plugins: [nodeResolve({ mainFields: ["module", "main"] }), sourcemaps()]
plugins: [
nodeResolve({ mainFields: ['module', 'main'] }),
sourcemaps()
]
};

export default config;
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,8 @@ export {
BackupResourceConfig,
BackupResourceConfigResource,
BackupResourceEncryptionConfig,
BackupResourceEncryptionConfigExtended,
BackupResourceEncryptionConfigExtendedResource,
BackupResourceEncryptionConfigResource,
BackupResourceVaultConfig,
BackupResourceVaultConfigResource,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,8 @@ export {
BackupResourceConfig,
BackupResourceConfigResource,
BackupResourceEncryptionConfig,
BackupResourceEncryptionConfigExtended,
BackupResourceEncryptionConfigExtendedResource,
BackupResourceEncryptionConfigResource,
BackupResourceVaultConfig,
BackupResourceVaultConfigResource,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,8 @@ export {
BackupResourceConfig,
BackupResourceConfigResource,
BackupResourceEncryptionConfig,
BackupResourceEncryptionConfigExtended,
BackupResourceEncryptionConfigExtendedResource,
BackupResourceEncryptionConfigResource,
BackupResourceVaultConfig,
BackupResourceVaultConfigResource,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,8 @@ export {
BackupResourceConfig,
BackupResourceConfigResource,
BackupResourceEncryptionConfig,
BackupResourceEncryptionConfigExtended,
BackupResourceEncryptionConfigExtendedResource,
BackupResourceEncryptionConfigResource,
BackupResourceVaultConfig,
BackupResourceVaultConfigResource,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,8 @@ export {
BackupResourceConfig,
BackupResourceConfigResource,
BackupResourceEncryptionConfig,
BackupResourceEncryptionConfigExtended,
BackupResourceEncryptionConfigExtendedResource,
BackupResourceEncryptionConfigResource,
BackupResourceVaultConfig,
BackupResourceVaultConfigResource,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,7 @@
* Changes may cause incorrect behavior and will be lost if the code is regenerated.
*/

export { discriminators, CloudError } from "../models/mappers";
export {
discriminators,
CloudError
} from "../models/mappers";
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,8 @@ export {
BackupResourceConfig,
BackupResourceConfigResource,
BackupResourceEncryptionConfig,
BackupResourceEncryptionConfigExtended,
BackupResourceEncryptionConfigExtendedResource,
BackupResourceEncryptionConfigResource,
BackupResourceVaultConfig,
BackupResourceVaultConfigResource,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,8 @@ export {
BackupResourceConfig,
BackupResourceConfigResource,
BackupResourceEncryptionConfig,
BackupResourceEncryptionConfigExtended,
BackupResourceEncryptionConfigExtendedResource,
BackupResourceEncryptionConfigResource,
BackupResourceVaultConfig,
BackupResourceVaultConfigResource,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,8 @@ export {
BackupResourceConfig,
BackupResourceConfigResource,
BackupResourceEncryptionConfig,
BackupResourceEncryptionConfigExtended,
BackupResourceEncryptionConfigExtendedResource,
BackupResourceEncryptionConfigResource,
BackupResourceVaultConfig,
BackupResourceVaultConfigResource,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,8 @@ export {
BackupResourceConfig,
BackupResourceConfigResource,
BackupResourceEncryptionConfig,
BackupResourceEncryptionConfigExtended,
BackupResourceEncryptionConfigExtendedResource,
BackupResourceEncryptionConfigResource,
BackupResourceVaultConfig,
BackupResourceVaultConfigResource,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,8 @@ export {
BackupResourceConfig,
BackupResourceConfigResource,
BackupResourceEncryptionConfig,
BackupResourceEncryptionConfigExtended,
BackupResourceEncryptionConfigExtendedResource,
BackupResourceEncryptionConfigResource,
BackupResourceVaultConfig,
BackupResourceVaultConfigResource,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,8 @@ export {
BackupResourceConfig,
BackupResourceConfigResource,
BackupResourceEncryptionConfig,
BackupResourceEncryptionConfigExtended,
BackupResourceEncryptionConfigExtendedResource,
BackupResourceEncryptionConfigResource,
BackupResourceVaultConfig,
BackupResourceVaultConfigResource,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,8 @@ export {
BackupResourceConfig,
BackupResourceConfigResource,
BackupResourceEncryptionConfig,
BackupResourceEncryptionConfigExtended,
BackupResourceEncryptionConfigExtendedResource,
BackupResourceEncryptionConfigResource,
BackupResourceVaultConfig,
BackupResourceVaultConfigResource,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,8 @@ export {
BackupResourceConfig,
BackupResourceConfigResource,
BackupResourceEncryptionConfig,
BackupResourceEncryptionConfigExtended,
BackupResourceEncryptionConfigExtendedResource,
BackupResourceEncryptionConfigResource,
BackupResourceVaultConfig,
BackupResourceVaultConfigResource,
Expand Down
Loading