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-machinelearning] Update documentation for OnlineEndpoints.AuthMode and OnlineEndpoint.RegenerateKeysRequest to reflect deprecated support for all API versions #9903

Closed
wants to merge 1 commit 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
696 changes: 696 additions & 0 deletions sdk/machinelearning/arm-machinelearning/CHANGELOG.md

Large diffs are not rendered by default.

24 changes: 12 additions & 12 deletions sdk/machinelearning/arm-machinelearning/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# AzureMachineLearningWorkspaces client library for JavaScript
# AzureMachineLearningServicesMgmt 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 AzureMachineLearningServicesMgmt client.

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

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 AzureMachineLearningServicesMgmt client library for JavaScript with `npm`:

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

### Create and authenticate a `AzureMachineLearningWorkspaces`
### Create and authenticate a `AzureMachineLearningServicesMgmtClient`

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 AzureMachineLearningServicesMgmt API, you will need the `endpoint` of your AzureMachineLearningServicesMgmt resource and a `credential`. The AzureMachineLearningServicesMgmt client can use Azure Active Directory credentials to authenticate.
You can find the endpoint for your AzureMachineLearningServicesMgmt 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 AzureMachineLearningServicesMgmt** 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 { AzureMachineLearningServicesMgmtClient } = 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 AzureMachineLearningServicesMgmtClient(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 AzureMachineLearningServicesMgmtClient(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
### AzureMachineLearningServicesMgmtClient

`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.
`AzureMachineLearningServicesMgmtClient` is the primary interface for developers using the AzureMachineLearningServicesMgmt client library. Explore the methods on this client object to understand the different features of the AzureMachineLearningServicesMgmt 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",
"readme": "specification\\machinelearningservices\\resource-manager\\readme.md",
"autorest_command": "autorest --version=3.9.7 --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/packages/autorest.typescript/ --generate-sample=true",
"commit": "539d543a23a1f696016b28b6e5dc24ebf3ef17c8",
"readme": "specification/machinelearningservices/resource-manager/readme.md",
"autorest_command": "autorest --version=3.9.7 --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.12",
"repository_url": "https://github.com/Azure/azure-rest-api-specs.git",
"release_tool": "@azure-tools/js-sdk-release-tools@2.7.9",
"use": "../autorest.typescript/packages/autorest.typescript/"
"use": "@autorest/typescript@^6.0.12"
}
20 changes: 6 additions & 14 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.2.0",
"description": "A generated SDK for AzureMachineLearningServicesMgmtClient.",
"version": "3.0.0",
"engines": {
"node": ">=18.0.0"
},
Expand Down Expand Up @@ -37,7 +37,7 @@
"@azure/dev-tool": "^1.0.0",
"@azure/identity": "^4.0.1",
"@azure-tools/test-recorder": "^3.0.0",
"@azure-tools/test-credential": "^1.1.0",
"@azure-tools/test-credential": "^1.0.0",
"mocha": "^10.0.0",
"@types/mocha": "^10.0.0",
"tsx": "^4.7.1",
Expand Down Expand Up @@ -100,19 +100,11 @@
"//metadata": {
"constantPaths": [
{
"path": "src/azureMachineLearningWorkspaces.ts",
"path": "src/azureMachineLearningServicesMgmtClient.ts",
"prefix": "packageDetails"
}
]
},
"autoPublish": true,
"homepage": "https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/machinelearning/arm-machinelearning",
"//sampleConfiguration": {
"productName": "",
"productSlugs": [
"azure"
],
"disableDocsMs": true,
"apiRefLink": "https://docs.microsoft.com/javascript/api/@azure/arm-machinelearning?view=azure-node-preview"
}
}
"homepage": "https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/machinelearning/arm-machinelearning"
}
Loading