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-compute] Add batch tag to compute and containerinstance in readme.go.md #5575

Closed
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
50 changes: 20 additions & 30 deletions sdk/compute/arm-compute/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This package contains an isomorphic SDK (runs both in node.js and in browsers) f
### 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-compute` 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-compute @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,7 +36,6 @@ npm install --save @azure/arm-compute @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 list operations as an example written in JavaScript.

##### Sample code
Expand All @@ -53,24 +49,20 @@ const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"];
// Please note that you can also use credentials from the `@azure/ms-rest-nodeauth` package instead.
const creds = new DefaultAzureCredential();
const client = new ComputeManagementClient(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);
});
client.operations.list().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.

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 @@ -88,21 +80,19 @@ 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.ArmCompute.ComputeManagementClient(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);
});
client.operations.list().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
2 changes: 1 addition & 1 deletion sdk/compute/arm-compute/package.json
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/compute/arm-compute",
"homepage": "https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/compute/arm-compute",
"repository": {
"type": "git",
"url": "https://github.com/Azure/azure-sdk-for-js.git"
Expand Down
23 changes: 9 additions & 14 deletions sdk/compute/arm-compute/src/computeManagementClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import * as Mappers from "./models/mappers";
import * as operations from "./operations";
import { ComputeManagementClientContext } from "./computeManagementClientContext";


class ComputeManagementClient extends ComputeManagementClientContext {
// Operation groups
operations: operations.Operations;
Expand All @@ -33,6 +34,8 @@ class ComputeManagementClient extends ComputeManagementClientContext {
images: operations.Images;
restorePointCollections: operations.RestorePointCollections;
restorePoints: operations.RestorePoints;
capacityReservationGroups: operations.CapacityReservationGroups;
capacityReservations: operations.CapacityReservations;
virtualMachineScaleSetExtensions: operations.VirtualMachineScaleSetExtensions;
virtualMachineScaleSetRollingUpgrades: operations.VirtualMachineScaleSetRollingUpgrades;
virtualMachineScaleSetVMExtensions: operations.VirtualMachineScaleSetVMExtensions;
Expand Down Expand Up @@ -73,11 +76,7 @@ class ComputeManagementClient extends ComputeManagementClientContext {
* subscription. The subscription ID forms part of the URI for every service call.
* @param [options] The parameter options
*/
constructor(
credentials: msRest.ServiceClientCredentials | TokenCredential,
subscriptionId: string,
options?: Models.ComputeManagementClientOptions
) {
constructor(credentials: msRest.ServiceClientCredentials | TokenCredential, subscriptionId: string, options?: Models.ComputeManagementClientOptions) {
super(credentials, subscriptionId, options);
this.operations = new operations.Operations(this);
this.availabilitySets = new operations.AvailabilitySets(this);
Expand All @@ -96,19 +95,15 @@ class ComputeManagementClient extends ComputeManagementClientContext {
this.images = new operations.Images(this);
this.restorePointCollections = new operations.RestorePointCollections(this);
this.restorePoints = new operations.RestorePoints(this);
this.capacityReservationGroups = new operations.CapacityReservationGroups(this);
this.capacityReservations = new operations.CapacityReservations(this);
this.virtualMachineScaleSetExtensions = new operations.VirtualMachineScaleSetExtensions(this);
this.virtualMachineScaleSetRollingUpgrades = new operations.VirtualMachineScaleSetRollingUpgrades(
this
);
this.virtualMachineScaleSetVMExtensions = new operations.VirtualMachineScaleSetVMExtensions(
this
);
this.virtualMachineScaleSetRollingUpgrades = new operations.VirtualMachineScaleSetRollingUpgrades(this);
this.virtualMachineScaleSetVMExtensions = new operations.VirtualMachineScaleSetVMExtensions(this);
this.virtualMachineScaleSetVMs = new operations.VirtualMachineScaleSetVMs(this);
this.logAnalytics = new operations.LogAnalytics(this);
this.virtualMachineRunCommands = new operations.VirtualMachineRunCommands(this);
this.virtualMachineScaleSetVMRunCommands = new operations.VirtualMachineScaleSetVMRunCommands(
this
);
this.virtualMachineScaleSetVMRunCommands = new operations.VirtualMachineScaleSetVMRunCommands(this);
this.resourceSkus = new operations.ResourceSkus(this);
this.disks = new operations.Disks(this);
this.snapshots = new operations.Snapshots(this);
Expand Down
17 changes: 5 additions & 12 deletions sdk/compute/arm-compute/src/computeManagementClientContext.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,16 +31,12 @@ export class ComputeManagementClientContext extends msRestAzure.AzureServiceClie
* subscription. The subscription ID forms part of the URI for every service call.
* @param [options] The parameter options
*/
constructor(
credentials: msRest.ServiceClientCredentials | TokenCredential,
subscriptionId: string,
options?: Models.ComputeManagementClientOptions
) {
constructor(credentials: msRest.ServiceClientCredentials | TokenCredential, subscriptionId: string, options?: Models.ComputeManagementClientOptions) {
if (credentials == undefined) {
throw new Error("'credentials' cannot be null.");
throw new Error('\'credentials\' cannot be null.');
}
if (subscriptionId == undefined) {
throw new Error("'subscriptionId' cannot be null.");
throw new Error('\'subscriptionId\' cannot be null.');
}

if (!options) {
Expand All @@ -53,7 +49,7 @@ export class ComputeManagementClientContext extends msRestAzure.AzureServiceClie

super(credentials, options);

this.acceptLanguage = "en-US";
this.acceptLanguage = 'en-US';
this.longRunningOperationRetryTimeout = 30;
this.baseUri = options.baseUri || this.baseUri || "https://management.azure.com";
this.requestContentType = "application/json; charset=utf-8";
Expand All @@ -63,10 +59,7 @@ export class ComputeManagementClientContext extends msRestAzure.AzureServiceClie
if (options.acceptLanguage !== null && options.acceptLanguage !== undefined) {
this.acceptLanguage = options.acceptLanguage;
}
if (
options.longRunningOperationRetryTimeout !== null &&
options.longRunningOperationRetryTimeout !== undefined
) {
if (options.longRunningOperationRetryTimeout !== null && options.longRunningOperationRetryTimeout !== undefined) {
this.longRunningOperationRetryTimeout = options.longRunningOperationRetryTimeout;
}
}
Expand Down
10 changes: 10 additions & 0 deletions sdk/compute/arm-compute/src/models/availabilitySetsMappers.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,15 @@ export {
BillingProfile,
BootDiagnostics,
BootDiagnosticsInstanceView,
CapacityReservation,
CapacityReservationGroup,
CapacityReservationGroupInstanceView,
CapacityReservationGroupUpdate,
CapacityReservationInstanceView,
CapacityReservationInstanceViewWithName,
CapacityReservationProfile,
CapacityReservationUpdate,
CapacityReservationUtilization,
CloudError,
CloudService,
CloudServiceExtensionProfile,
Expand Down Expand Up @@ -163,6 +172,7 @@ export {
Snapshot,
SnapshotSku,
SourceVault,
SpotRestorePolicy,
SshConfiguration,
SshPublicKey,
SshPublicKeyResource,
Expand Down
Loading