Skip to content

Commit

Permalink
CodeGen from PR 21761 in Azure/azure-rest-api-specs
Browse files Browse the repository at this point in the history
Merge 1d347916d83461126d013debb247b7464bc1e3a9 into 23b62d4e4dab07dccda851cfe50f6c6afb705a3b
  • Loading branch information
SDKAuto committed Dec 9, 2022
1 parent 05f6998 commit 4638c09
Show file tree
Hide file tree
Showing 63 changed files with 16,595 additions and 2,738 deletions.
393 changes: 385 additions & 8 deletions sdk/machinelearning/arm-machinelearning/CHANGELOG.md

Large diffs are not rendered by default.

26 changes: 13 additions & 13 deletions sdk/machinelearning/arm-machinelearning/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# AzureMachineLearningWorkspaces client library for JavaScript
# Azure Machine Learning client library for JavaScript

This package contains an isomorphic SDK (runs both in Node.js and in browsers) for AzureMachineLearningWorkspaces client.
This package contains an isomorphic SDK (runs both in Node.js and in browsers) for Azure Machine Learning client.

These APIs allow end users to operate on Azure Machine Learning Workspace resources.

[Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/machinelearning/arm-machinelearning) |
[Package (NPM)](https://www.npmjs.com/package/@azure/arm-machinelearning) |
[API reference documentation](https://docs.microsoft.com/javascript/api/@azure/arm-machinelearning) |
[API reference documentation](https://docs.microsoft.com/javascript/api/@azure/arm-machinelearning?view=azure-node-preview) |
[Samples](https://github.com/Azure-Samples/azure-samples-js-management)

## Getting started
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-machinelearning` package

Install the AzureMachineLearningWorkspaces client library for JavaScript with `npm`:
Install the Azure Machine Learning client library for JavaScript with `npm`:

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

### Create and authenticate a `AzureMachineLearningWorkspaces`
### Create and authenticate a `AzureMachineLearningServices`

To create a client object to access the AzureMachineLearningWorkspaces API, you will need the `endpoint` of your AzureMachineLearningWorkspaces resource and a `credential`. The AzureMachineLearningWorkspaces client can use Azure Active Directory credentials to authenticate.
You can find the endpoint for your AzureMachineLearningWorkspaces resource in the [Azure Portal][azure_portal].
To create a client object to access the Azure Machine Learning API, you will need the `endpoint` of your Azure Machine Learning resource and a `credential`. The Azure Machine Learning client can use Azure Active Directory credentials to authenticate.
You can find the endpoint for your Azure Machine Learning 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,25 +43,25 @@ 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 AzureMachineLearningWorkspaces** 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 Machine Learning** 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).

```javascript
const { AzureMachineLearningWorkspaces } = require("@azure/arm-machinelearning");
const { AzureMachineLearningServices } = require("@azure/arm-machinelearning");
const { DefaultAzureCredential } = require("@azure/identity");
// For client-side applications running in the browser, use InteractiveBrowserCredential instead of DefaultAzureCredential. See https://aka.ms/azsdk/js/identity/examples for more details.

const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new AzureMachineLearningWorkspaces(new DefaultAzureCredential(), subscriptionId);
const client = new AzureMachineLearningServices(new DefaultAzureCredential(), subscriptionId);

// For client-side applications running in the browser, use this code instead:
// const credential = new InteractiveBrowserCredential({
// tenantId: "<YOUR_TENANT_ID>",
// clientId: "<YOUR_CLIENT_ID>"
// });
// const client = new AzureMachineLearningWorkspaces(credential, subscriptionId);
// const client = new AzureMachineLearningServices(credential, subscriptionId);
```


Expand All @@ -70,9 +70,9 @@ To use this client library in the browser, first you need to use a bundler. For

## Key concepts

### AzureMachineLearningWorkspaces
### AzureMachineLearningServices

`AzureMachineLearningWorkspaces` is the primary interface for developers using the AzureMachineLearningWorkspaces client library. Explore the methods on this client object to understand the different features of the AzureMachineLearningWorkspaces service that you can access.
`AzureMachineLearningServices` is the primary interface for developers using the Azure Machine Learning client library. Explore the methods on this client object to understand the different features of the Azure Machine Learning service that you can access.

## Troubleshooting

Expand Down
8 changes: 4 additions & 4 deletions sdk/machinelearning/arm-machinelearning/_meta.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"commit": "1fefe3f5cee88319b17c08a2dbf95e1e983a9f8c",
"commit": "282b8accbf40ca2ed6237259c5d8f2e50ba5e0ea",
"readme": "specification/machinelearningservices/resource-manager/readme.md",
"autorest_command": "autorest --version=3.8.4 --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\\machinelearningservices\\resource-manager\\readme.md --use=@autorest/typescript@6.0.0-rc.3.20221108.1 --generate-sample=true",
"autorest_command": "autorest --version=3.9.3 --typescript --modelerfour.lenient-model-deduplication --azure-arm --head-as-boolean=true --license-header=MICROSOFT_MIT_NO_VERSION --generate-test --typescript-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-js ../azure-rest-api-specs/specification/machinelearningservices/resource-manager/readme.md --use=@autorest/typescript@6.0.0-rc.4",
"repository_url": "https://github.com/Azure/azure-rest-api-specs.git",
"release_tool": "@azure-tools/js-sdk-release-tools@2.4.2",
"use": "@autorest/typescript@6.0.0-rc.3.20221108.1"
"release_tool": "@azure-tools/js-sdk-release-tools@2.5.2",
"use": "@autorest/typescript@6.0.0-rc.4"
}
18 changes: 5 additions & 13 deletions sdk/machinelearning/arm-machinelearning/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
"name": "@azure/arm-machinelearning",
"sdk-type": "mgmt",
"author": "Microsoft Corporation",
"description": "A generated SDK for AzureMachineLearningWorkspaces.",
"version": "2.1.2",
"description": "A generated SDK for AzureMachineLearningServices.",
"version": "3.0.0-beta.1",
"engines": {
"node": ">=14.0.0"
},
Expand Down Expand Up @@ -105,18 +105,10 @@
"//metadata": {
"constantPaths": [
{
"path": "src/azureMachineLearningWorkspaces.ts",
"path": "src/azureMachineLearningServices.ts",
"prefix": "packageDetails"
}
]
},
"autoPublish": true,
"//sampleConfiguration": {
"productName": "",
"productSlugs": [
"azure"
],
"disableDocsMs": true,
"apiRefLink": "https://docs.microsoft.com/javascript/api/@azure/arm-machinelearning?view=azure-node-preview"
}
}
"autoPublish": true
}
Loading

0 comments on commit 4638c09

Please sign in to comment.