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

[ReleasePR @azure/arm-cognitiveservices] [Go] Add batch tag 03/31/2022 #16158

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
57 changes: 22 additions & 35 deletions sdk/cognitiveservices/arm-cognitiveservices/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ This package contains an isomorphic SDK (runs both in node.js and in browsers) f

### Currently supported environments

- Node.js version 8.x.x or higher
- Browser JavaScript
- [LTS versions of Node.js](https://nodejs.org/about/releases/)
- 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-cognitiveservices` 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-cognitiveservices @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-cognitiveservices @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 accounts as an example written in JavaScript.

##### Sample code
Expand All @@ -55,24 +51,20 @@ const creds = new DefaultAzureCredential();
const client = new CognitiveServicesManagementClient(creds, subscriptionId);
const resourceGroupName = "testresourceGroupName";
const accountName = "testaccountName";
client.accounts
.get(resourceGroupName, accountName)
.then((result) => {
console.log("The result is:");
console.log(result);
})
.catch((err) => {
console.log("An error occurred:");
console.error(err);
});
client.accounts.get(resourceGroupName, accountName).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 accounts 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.ArmCognitiveservices.CognitiveServicesManagementClient(
creds,
subscriptionId
);
const client = new Azure.ArmCognitiveservices.CognitiveServicesManagementClient(creds, subscriptionId);
const resourceGroupName = "testresourceGroupName";
const accountName = "testaccountName";
client.accounts
.get(resourceGroupName, accountName)
.then((result) => {
console.log("The result is:");
console.log(result);
})
.catch((err) => {
console.log("An error occurred:");
console.error(err);
});
client.accounts.get(resourceGroupName, accountName).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/cognitiveservices/arm-cognitiveservices/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/cognitiveservices/arm-cognitiveservices",
"homepage": "https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/cognitiveservices/arm-cognitiveservices",
"repository": {
"type": "git",
"url": "https://github.com/Azure/azure-sdk-for-js.git"
Expand Down
10 changes: 8 additions & 2 deletions sdk/cognitiveservices/arm-cognitiveservices/rollup.config.js
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/cognitiveServicesManagementClient.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-cognitiveservices.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 @@ -15,6 +15,7 @@ import * as Parameters from "./models/parameters";
import * as operations from "./operations";
import { CognitiveServicesManagementClientContext } from "./cognitiveServicesManagementClientContext";


class CognitiveServicesManagementClient extends CognitiveServicesManagementClientContext {
// Operation groups
accounts: operations.Accounts;
Expand All @@ -35,11 +36,7 @@ class CognitiveServicesManagementClient extends CognitiveServicesManagementClien
* @param subscriptionId The ID of the target subscription.
* @param [options] The parameter options
*/
constructor(
credentials: msRest.ServiceClientCredentials | TokenCredential,
subscriptionId: string,
options?: Models.CognitiveServicesManagementClientOptions
) {
constructor(credentials: msRest.ServiceClientCredentials | TokenCredential, subscriptionId: string, options?: Models.CognitiveServicesManagementClientOptions) {
super(credentials, subscriptionId, options);
this.accounts = new operations.Accounts(this);
this.deletedAccounts = new operations.DeletedAccounts(this);
Expand All @@ -58,27 +55,15 @@ class CognitiveServicesManagementClient extends CognitiveServicesManagementClien
* @param [options] The optional parameters
* @returns Promise<Models.CheckSkuAvailabilityResponse>
*/
checkSkuAvailability(
location: string,
skus: string[],
kind: string,
type: string,
options?: msRest.RequestOptionsBase
): Promise<Models.CheckSkuAvailabilityResponse>;
checkSkuAvailability(location: string, skus: string[], kind: string, type: string, options?: msRest.RequestOptionsBase): Promise<Models.CheckSkuAvailabilityResponse>;
/**
* @param location Resource location.
* @param skus The SKU of the resource.
* @param kind The Kind of the resource.
* @param type The Type of the resource.
* @param callback The callback
*/
checkSkuAvailability(
location: string,
skus: string[],
kind: string,
type: string,
callback: msRest.ServiceCallback<Models.SkuAvailabilityListResult>
): void;
checkSkuAvailability(location: string, skus: string[], kind: string, type: string, callback: msRest.ServiceCallback<Models.SkuAvailabilityListResult>): void;
/**
* @param location Resource location.
* @param skus The SKU of the resource.
Expand All @@ -87,22 +72,8 @@ class CognitiveServicesManagementClient extends CognitiveServicesManagementClien
* @param options The optional parameters
* @param callback The callback
*/
checkSkuAvailability(
location: string,
skus: string[],
kind: string,
type: string,
options: msRest.RequestOptionsBase,
callback: msRest.ServiceCallback<Models.SkuAvailabilityListResult>
): void;
checkSkuAvailability(
location: string,
skus: string[],
kind: string,
type: string,
options?: msRest.RequestOptionsBase | msRest.ServiceCallback<Models.SkuAvailabilityListResult>,
callback?: msRest.ServiceCallback<Models.SkuAvailabilityListResult>
): Promise<Models.CheckSkuAvailabilityResponse> {
checkSkuAvailability(location: string, skus: string[], kind: string, type: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<Models.SkuAvailabilityListResult>): void;
checkSkuAvailability(location: string, skus: string[], kind: string, type: string, options?: msRest.RequestOptionsBase | msRest.ServiceCallback<Models.SkuAvailabilityListResult>, callback?: msRest.ServiceCallback<Models.SkuAvailabilityListResult>): Promise<Models.CheckSkuAvailabilityResponse> {
return this.sendOperationRequest(
{
location,
Expand All @@ -112,8 +83,7 @@ class CognitiveServicesManagementClient extends CognitiveServicesManagementClien
options
},
checkSkuAvailabilityOperationSpec,
callback
) as Promise<Models.CheckSkuAvailabilityResponse>;
callback) as Promise<Models.CheckSkuAvailabilityResponse>;
}

/**
Expand All @@ -123,60 +93,47 @@ class CognitiveServicesManagementClient extends CognitiveServicesManagementClien
* @param [options] The optional parameters
* @returns Promise<Models.CheckDomainAvailabilityResponse>
*/
checkDomainAvailability(
subdomainName: string,
type: string,
options?: msRest.RequestOptionsBase
): Promise<Models.CheckDomainAvailabilityResponse>;
checkDomainAvailability(subdomainName: string, type: string, options?: msRest.RequestOptionsBase): Promise<Models.CheckDomainAvailabilityResponse>;
/**
* @param subdomainName The subdomain name to use.
* @param type The Type of the resource.
* @param callback The callback
*/
checkDomainAvailability(
subdomainName: string,
type: string,
callback: msRest.ServiceCallback<Models.DomainAvailability>
): void;
checkDomainAvailability(subdomainName: string, type: string, callback: msRest.ServiceCallback<Models.DomainAvailability>): void;
/**
* @param subdomainName The subdomain name to use.
* @param type The Type of the resource.
* @param options The optional parameters
* @param callback The callback
*/
checkDomainAvailability(
subdomainName: string,
type: string,
options: msRest.RequestOptionsBase,
callback: msRest.ServiceCallback<Models.DomainAvailability>
): void;
checkDomainAvailability(
subdomainName: string,
type: string,
options?: msRest.RequestOptionsBase | msRest.ServiceCallback<Models.DomainAvailability>,
callback?: msRest.ServiceCallback<Models.DomainAvailability>
): Promise<Models.CheckDomainAvailabilityResponse> {
checkDomainAvailability(subdomainName: string, type: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<Models.DomainAvailability>): void;
checkDomainAvailability(subdomainName: string, type: string, options?: msRest.RequestOptionsBase | msRest.ServiceCallback<Models.DomainAvailability>, callback?: msRest.ServiceCallback<Models.DomainAvailability>): Promise<Models.CheckDomainAvailabilityResponse> {
return this.sendOperationRequest(
{
subdomainName,
type,
options
},
checkDomainAvailabilityOperationSpec,
callback
) as Promise<Models.CheckDomainAvailabilityResponse>;
callback) as Promise<Models.CheckDomainAvailabilityResponse>;
}
}

// Operation Specifications
const serializer = new msRest.Serializer(Mappers);
const checkSkuAvailabilityOperationSpec: msRest.OperationSpec = {
httpMethod: "POST",
path:
"subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/locations/{location}/checkSkuAvailability",
urlParameters: [Parameters.subscriptionId, Parameters.location],
queryParameters: [Parameters.apiVersion],
headerParameters: [Parameters.acceptLanguage],
path: "subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/locations/{location}/checkSkuAvailability",
urlParameters: [
Parameters.subscriptionId,
Parameters.location
],
queryParameters: [
Parameters.apiVersion
],
headerParameters: [
Parameters.acceptLanguage
],
requestBody: {
parameterPath: {
skus: "skus",
Expand All @@ -201,11 +158,16 @@ const checkSkuAvailabilityOperationSpec: msRest.OperationSpec = {

const checkDomainAvailabilityOperationSpec: msRest.OperationSpec = {
httpMethod: "POST",
path:
"subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/checkDomainAvailability",
urlParameters: [Parameters.subscriptionId],
queryParameters: [Parameters.apiVersion],
headerParameters: [Parameters.acceptLanguage],
path: "subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/checkDomainAvailability",
urlParameters: [
Parameters.subscriptionId
],
queryParameters: [
Parameters.apiVersion
],
headerParameters: [
Parameters.acceptLanguage
],
requestBody: {
parameterPath: {
subdomainName: "subdomainName",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,16 +31,12 @@ export class CognitiveServicesManagementClientContext extends msRestAzure.AzureS
* @param subscriptionId The ID of the target subscription.
* @param [options] The parameter options
*/
constructor(
credentials: msRest.ServiceClientCredentials | TokenCredential,
subscriptionId: string,
options?: Models.CognitiveServicesManagementClientOptions
) {
constructor(credentials: msRest.ServiceClientCredentials | TokenCredential, subscriptionId: string, options?: Models.CognitiveServicesManagementClientOptions) {
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,8 +49,8 @@ export class CognitiveServicesManagementClientContext extends msRestAzure.AzureS

super(credentials, options);

this.apiVersion = "2021-04-30";
this.acceptLanguage = "en-US";
this.apiVersion = '2021-04-30';
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 @@ -64,10 +60,7 @@ export class CognitiveServicesManagementClientContext extends msRestAzure.AzureS
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
Loading