Skip to content
This repository has been archived by the owner on May 5, 2023. It is now read-only.

[AutoPR] sql/resource-manager #4731

Closed
wants to merge 2 commits into from
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
2 changes: 1 addition & 1 deletion lib/services/sqlManagement2/LICENSE.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2018 Microsoft
Copyright (c) 2019 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
35 changes: 19 additions & 16 deletions lib/services/sqlManagement2/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,41 +3,44 @@ uid: azure-arm-sql
summary: *content

---
# Microsoft Azure SDK for Node.js - SqlManagementClient
**This SDK will be deprecated next year and will be replaced by a new TypeScript-based isomorphic SDK (found at https://github.com/Azure/azure-sdk-for-js) which works on Node.js and browsers.**
## Microsoft Azure SDK for Node.js - SqlManagementClient

This project provides a Node.js package for accessing Azure. Right now it supports:
- **Node.js version 6.x.x or higher**

## Features
### Features


## How to Install
### How to Install

```bash
npm install azure-arm-sql
```

## How to use
### How to use

### Authentication, client creation and get recoverableDatabases as an example.
#### Authentication, client creation, and get recoverableDatabases as an example.

```javascript
const msRestAzure = require("ms-rest-azure");
const SqlManagementClient = require("azure-arm-sql");
msRestAzure.interactiveLogin().then((creds) => {
const subscriptionId = "<Subscription_Id>";
const client = new SqlManagementClient(creds, subscriptionId);
const resourceGroupName = "testresourceGroupName";
const serverName = "testserverName";
const databaseName = "testdatabaseName";
return client.recoverableDatabases.get(resourceGroupName, serverName, databaseName).then((result) => {
console.log("The result is:");
console.log(result);
});
const subscriptionId = "<Subscription_Id>";
const client = new SqlManagementClient(creds, subscriptionId);
const resourceGroupName = "testresourceGroupName";
const serverName = "testserverName";
const databaseName = "testdatabaseName";

return client.recoverableDatabases.get(resourceGroupName, serverName, databaseName).then((result) => {
console.log("The result is:");
console.log(result);
});
}).catch((err) => {
console.log('An error occurred:');
console.dir(err, {depth: null, colors: true});
});

## Related projects
```
### Related projects

- [Microsoft Azure SDK for Node.js](https://github.com/Azure/azure-sdk-for-node)
10 changes: 5 additions & 5 deletions lib/services/sqlManagement2/lib/models/automaticTuningOptions.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@
class AutomaticTuningOptions {
/**
* Create a AutomaticTuningOptions.
* @member {string} [desiredState] Automatic tuning option desired state.
* @property {string} [desiredState] Automatic tuning option desired state.
* Possible values include: 'Off', 'On', 'Default'
* @member {string} [actualState] Automatic tuning option actual state.
* @property {string} [actualState] Automatic tuning option actual state.
* Possible values include: 'Off', 'On'
* @member {number} [reasonCode] Reason code if desired and actual state are
* different.
* @member {string} [reasonDesc] Reason description if desired and actual
* @property {number} [reasonCode] Reason code if desired and actual state
* are different.
* @property {string} [reasonDesc] Reason description if desired and actual
* state are different. Possible values include: 'Default', 'Disabled',
* 'AutoConfigured', 'InheritedFromServer', 'QueryStoreOff',
* 'QueryStoreReadOnly', 'NotSupported'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@
class AutomaticTuningServerOptions {
/**
* Create a AutomaticTuningServerOptions.
* @member {string} [desiredState] Automatic tuning option desired state.
* @property {string} [desiredState] Automatic tuning option desired state.
* Possible values include: 'Off', 'On', 'Default'
* @member {string} [actualState] Automatic tuning option actual state.
* @property {string} [actualState] Automatic tuning option actual state.
* Possible values include: 'Off', 'On'
* @member {number} [reasonCode] Reason code if desired and actual state are
* different.
* @member {string} [reasonDesc] Reason description if desired and actual
* @property {number} [reasonCode] Reason code if desired and actual state
* are different.
* @property {string} [reasonDesc] Reason description if desired and actual
* state are different. Possible values include: 'Default', 'Disabled',
* 'AutoConfigured'
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,13 @@ const models = require('./index');
class BackupLongTermRetentionPolicy extends models['ProxyResource'] {
/**
* Create a BackupLongTermRetentionPolicy.
* @member {string} [weeklyRetention] The weekly retention policy for an LTR
* backup in an ISO 8601 format.
* @member {string} [monthlyRetention] The monthly retention policy for an
* @property {string} [weeklyRetention] The weekly retention policy for an
* LTR backup in an ISO 8601 format.
* @member {string} [yearlyRetention] The yearly retention policy for an LTR
* backup in an ISO 8601 format.
* @member {number} [weekOfYear] The week of year to take the yearly backup
* @property {string} [monthlyRetention] The monthly retention policy for an
* LTR backup in an ISO 8601 format.
* @property {string} [yearlyRetention] The yearly retention policy for an
* LTR backup in an ISO 8601 format.
* @property {number} [weekOfYear] The week of year to take the yearly backup
* in an ISO 8601 format.
*/
constructor() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ const models = require('./index');
class BackupShortTermRetentionPolicy extends models['ProxyResource'] {
/**
* Create a BackupShortTermRetentionPolicy.
* @member {number} [retentionDays] The backup retention period in days. This
* is how many days Point-in-Time Restore will be supported.
* @property {number} [retentionDays] The backup retention period in days.
* This is how many days Point-in-Time Restore will be supported.
*/
constructor() {
super();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
class BackupShortTermRetentionPolicyListResult extends Array {
/**
* Create a BackupShortTermRetentionPolicyListResult.
* @member {string} [nextLink] Link to retrieve next page of results.
* @property {string} [nextLink] Link to retrieve next page of results.
*/
constructor() {
super();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
class CheckNameAvailabilityRequest {
/**
* Create a CheckNameAvailabilityRequest.
* @member {string} name The name whose availability is to be checked.
* @property {string} name The name whose availability is to be checked.
*/
constructor() {
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@
class CheckNameAvailabilityResponse {
/**
* Create a CheckNameAvailabilityResponse.
* @member {boolean} [available] True if the name is available, otherwise
* @property {boolean} [available] True if the name is available, otherwise
* false.
* @member {string} [message] A message explaining why the name is
* @property {string} [message] A message explaining why the name is
* unavailable. Will be null if the name is available.
* @member {string} [name] The name whose availability was checked.
* @member {string} [reason] The reason code explaining why the name is
* @property {string} [name] The name whose availability was checked.
* @property {string} [reason] The reason code explaining why the name is
* unavailable. Will be null if the name is available. Possible values
* include: 'Invalid', 'AlreadyExists'
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
class CompleteDatabaseRestoreDefinition {
/**
* Create a CompleteDatabaseRestoreDefinition.
* @member {string} lastBackupName The last backup name to apply
* @property {string} lastBackupName The last backup name to apply
*/
constructor() {
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
class CreateDatabaseRestorePointDefinition {
/**
* Create a CreateDatabaseRestorePointDefinition.
* @member {string} restorePointLabel The restore point label to apply
* @property {string} restorePointLabel The restore point label to apply
*/
constructor() {
}
Expand Down
12 changes: 6 additions & 6 deletions lib/services/sqlManagement2/lib/models/dataMaskingPolicy.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,18 +20,18 @@ const models = require('./index');
class DataMaskingPolicy extends models['ProxyResource'] {
/**
* Create a DataMaskingPolicy.
* @member {string} dataMaskingState The state of the data masking policy.
* @property {string} dataMaskingState The state of the data masking policy.
* Possible values include: 'Disabled', 'Enabled'
* @member {string} [exemptPrincipals] The list of the exempt principals.
* @property {string} [exemptPrincipals] The list of the exempt principals.
* Specifies the semicolon-separated list of database users for which the
* data masking policy does not apply. The specified users receive data
* results without masking for all of the database queries.
* @member {string} [applicationPrincipals] The list of the application
* @property {string} [applicationPrincipals] The list of the application
* principals. This is a legacy parameter and is no longer used.
* @member {string} [maskingLevel] The masking level. This is a legacy
* @property {string} [maskingLevel] The masking level. This is a legacy
* parameter and is no longer used.
* @member {string} [location] The location of the data masking policy.
* @member {string} [kind] The kind of data masking policy. Metadata, used
* @property {string} [location] The location of the data masking policy.
* @property {string} [kind] The kind of data masking policy. Metadata, used
* for Azure portal.
*/
constructor() {
Expand Down
40 changes: 20 additions & 20 deletions lib/services/sqlManagement2/lib/models/dataMaskingRule.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,42 +20,42 @@ const models = require('./index');
class DataMaskingRule extends models['ProxyResource'] {
/**
* Create a DataMaskingRule.
* @member {string} [dataMaskingRuleId] The rule Id.
* @member {string} [aliasName] The alias name. This is a legacy parameter
* @property {string} [dataMaskingRuleId] The rule Id.
* @property {string} [aliasName] The alias name. This is a legacy parameter
* and is no longer used.
* @member {string} [ruleState] The rule state. Used to delete a rule. To
* @property {string} [ruleState] The rule state. Used to delete a rule. To
* delete an existing rule, specify the schemaName, tableName, columnName,
* maskingFunction, and specify ruleState as disabled. However, if the rule
* doesn't already exist, the rule will be created with ruleState set to
* enabled, regardless of the provided value of ruleState. Possible values
* include: 'Disabled', 'Enabled'
* @member {string} schemaName The schema name on which the data masking rule
* @property {string} schemaName The schema name on which the data masking
* rule is applied.
* @property {string} tableName The table name on which the data masking rule
* is applied.
* @member {string} tableName The table name on which the data masking rule
* is applied.
* @member {string} columnName The column name on which the data masking rule
* is applied.
* @member {string} maskingFunction The masking function that is used for the
* data masking rule. Possible values include: 'Default', 'CCN', 'Email',
* @property {string} columnName The column name on which the data masking
* rule is applied.
* @property {string} maskingFunction The masking function that is used for
* the data masking rule. Possible values include: 'Default', 'CCN', 'Email',
* 'Number', 'SSN', 'Text'
* @member {string} [numberFrom] The numberFrom property of the masking rule.
* Required if maskingFunction is set to Number, otherwise this parameter
* will be ignored.
* @member {string} [numberTo] The numberTo property of the data masking
* @property {string} [numberFrom] The numberFrom property of the masking
* rule. Required if maskingFunction is set to Number, otherwise this
* parameter will be ignored.
* @property {string} [numberTo] The numberTo property of the data masking
* rule. Required if maskingFunction is set to Number, otherwise this
* parameter will be ignored.
* @member {string} [prefixSize] If maskingFunction is set to Text, the
* @property {string} [prefixSize] If maskingFunction is set to Text, the
* number of characters to show unmasked in the beginning of the string.
* Otherwise, this parameter will be ignored.
* @member {string} [suffixSize] If maskingFunction is set to Text, the
* @property {string} [suffixSize] If maskingFunction is set to Text, the
* number of characters to show unmasked at the end of the string. Otherwise,
* this parameter will be ignored.
* @member {string} [replacementString] If maskingFunction is set to Text,
* @property {string} [replacementString] If maskingFunction is set to Text,
* the character to use for masking the unexposed part of the string.
* Otherwise, this parameter will be ignored.
* @member {string} [location] The location of the data masking rule.
* @member {string} [kind] The kind of Data Masking Rule. Metadata, used for
* Azure portal.
* @property {string} [location] The location of the data masking rule.
* @property {string} [kind] The kind of Data Masking Rule. Metadata, used
* for Azure portal.
*/
constructor() {
super();
Expand Down
Loading