Skip to content
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
42 changes: 21 additions & 21 deletions packages/@azure/arm-cognitiveservices/LICENSE.txt
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
The MIT License (MIT)

Copyright (c) 2018 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
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
The MIT License (MIT)
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
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
203 changes: 100 additions & 103 deletions packages/@azure/arm-cognitiveservices/README.md
Original file line number Diff line number Diff line change
@@ -1,103 +1,100 @@
## Azure CognitiveServicesManagementClient SDK for JavaScript

This package contains an isomorphic SDK for CognitiveServicesManagementClient.

### Currently supported environments

- Node.js version 6.x.x or higher
- Browser JavaScript

### How to Install

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

### How to use

#### nodejs - Authentication, client creation and getProperties accounts as an example written in TypeScript.

##### Install @azure/ms-rest-nodeauth

```bash
npm install @azure/ms-rest-nodeauth
```

##### Sample code

```typescript
import * as msRest from "@azure/ms-rest-js";
import * as msRestAzure from "@azure/ms-rest-azure-js";
import * as msRestNodeAuth from "@azure/ms-rest-nodeauth";
import { CognitiveServicesManagementClient, CognitiveServicesManagementModels, CognitiveServicesManagementMappers } from "@azure/arm-cognitiveservices";
const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"];

msRestNodeAuth.interactiveLogin().then((creds) => {
const client = new CognitiveServicesManagementClient(creds, subscriptionId);
const resourceGroupName = "testresourceGroupName";
const accountName = "testaccountName";
client.accounts.getProperties(resourceGroupName, accountName).then((result) => {
console.log("The result is:");
console.log(result);
});
}).catch((err) => {
console.error(err);
});
```

#### browser - Authentication, client creation and getProperties accounts as an example written in JavaScript.

##### Install @azure/ms-rest-browserauth

```bash
npm install @azure/ms-rest-browserauth
```

##### Sample code

See https://github.com/Azure/ms-rest-browserauth to learn how to authenticate to Azure in the browser.

- index.html
```html
<!DOCTYPE html>
<html lang="en">
<head>
<title>@azure/arm-cognitiveservices sample</title>
<script src="node_modules/@azure/ms-rest-js/dist/msRest.browser.js"></script>
<script src="node_modules/@azure/ms-rest-azure-js/dist/msRestAzure.js"></script>
<script src="node_modules/@azure/ms-rest-browserauth/dist/msAuth.js"></script>
<script src="node_modules/@azure/arm-cognitiveservices/dist/arm-cognitiveservices.js"></script>
<script type="text/javascript">
const subscriptionId = "<Subscription_Id>";
const authManager = new msAuth.AuthManager({
clientId: "<client id for your Azure AD app>",
tenant: "<optional tenant for your organization>"
});
authManager.finalizeLogin().then((res) => {
if (!res.isLoggedIn) {
// may cause redirects
authManager.login();
}
const client = new Azure.ArmCognitiveservices.CognitiveServicesManagementClient(res.creds, subscriptionId);
const resourceGroupName = "testresourceGroupName";
const accountName = "testaccountName";
client.accounts.getProperties(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>
</html>
```

## Related projects

- [Microsoft Azure SDK for Javascript](https://github.com/Azure/azure-sdk-for-js)


![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js%2Fpackages%2F%40azure%2Farm-cognitiveservices%2FREADME.png)
## Azure CognitiveServicesManagementClient SDK for JavaScript

This package contains an isomorphic SDK for CognitiveServicesManagementClient.

### Currently supported environments

- Node.js version 6.x.x or higher
- Browser JavaScript

### How to Install

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

### How to use

#### nodejs - Authentication, client creation and getProperties accounts as an example written in TypeScript.

##### Install @azure/ms-rest-nodeauth

```bash
npm install @azure/ms-rest-nodeauth
```

##### Sample code

```typescript
import * as msRest from "@azure/ms-rest-js";
import * as msRestAzure from "@azure/ms-rest-azure-js";
import * as msRestNodeAuth from "@azure/ms-rest-nodeauth";
import { CognitiveServicesManagementClient, CognitiveServicesManagementModels, CognitiveServicesManagementMappers } from "@azure/arm-cognitiveservices";
const subscriptionId = process.env["AZURE_SUBSCRIPTION_ID"];

msRestNodeAuth.interactiveLogin().then((creds) => {
const client = new CognitiveServicesManagementClient(creds, subscriptionId);
const resourceGroupName = "testresourceGroupName";
const accountName = "testaccountName";
client.accounts.getProperties(resourceGroupName, accountName).then((result) => {
console.log("The result is:");
console.log(result);
});
}).catch((err) => {
console.error(err);
});
```

#### browser - Authentication, client creation and getProperties accounts as an example written in JavaScript.

##### Install @azure/ms-rest-browserauth

```bash
npm install @azure/ms-rest-browserauth
```

##### Sample code

See https://github.com/Azure/ms-rest-browserauth to learn how to authenticate to Azure in the browser.

- index.html
```html
<!DOCTYPE html>
<html lang="en">
<head>
<title>@azure/arm-cognitiveservices sample</title>
<script src="node_modules/@azure/ms-rest-js/dist/msRest.browser.js"></script>
<script src="node_modules/@azure/ms-rest-azure-js/dist/msRestAzure.js"></script>
<script src="node_modules/@azure/ms-rest-browserauth/dist/msAuth.js"></script>
<script src="node_modules/@azure/arm-cognitiveservices/dist/arm-cognitiveservices.js"></script>
<script type="text/javascript">
const subscriptionId = "<Subscription_Id>";
const authManager = new msAuth.AuthManager({
clientId: "<client id for your Azure AD app>",
tenant: "<optional tenant for your organization>"
});
authManager.finalizeLogin().then((res) => {
if (!res.isLoggedIn) {
// may cause redirects
authManager.login();
}
const client = new Azure.ArmCognitiveservices.CognitiveServicesManagementClient(res.creds, subscriptionId);
const resourceGroupName = "testresourceGroupName";
const accountName = "testaccountName";
client.accounts.getProperties(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>
</html>
```

## Related projects

- [Microsoft Azure SDK for Javascript](https://github.com/Azure/azure-sdk-for-js)
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ class CognitiveServicesManagementClient extends CognitiveServicesManagementClien
resourceSkus: operations.ResourceSkus;
operations: operations.Operations;
checkSkuAvailability: operations.CheckSkuAvailability;
locations: operations.Locations;

/**
* Initializes a new instance of the CognitiveServicesManagementClient class.
Expand All @@ -34,6 +35,7 @@ class CognitiveServicesManagementClient extends CognitiveServicesManagementClien
this.resourceSkus = new operations.ResourceSkus(this);
this.operations = new operations.Operations(this);
this.checkSkuAvailability = new operations.CheckSkuAvailability(this);
this.locations = new operations.Locations(this);
}
}

Expand Down
16 changes: 16 additions & 0 deletions packages/@azure/arm-cognitiveservices/lib/models/accountMappers.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
/*
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for
* license information.
*
* Code generated by Microsoft (R) AutoRest Code Generator.
* Changes may cause incorrect behavior and will be lost if the code is
* regenerated.
*/

export {
CheckDomainAvailabilityParameter,
CheckDomainAvailabilityResult,
CloudError
} from "../models/mappers";

67 changes: 67 additions & 0 deletions packages/@azure/arm-cognitiveservices/lib/models/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,11 @@ export interface CognitiveServicesAccount extends BaseResource {
* @member {string} [internalId] The internal identifier.
*/
internalId?: string;
/**
* @member {string} [customSubDomainName] Optional subdomain name used for
* token-based authentication.
*/
customSubDomainName?: string;
/**
* @member {Sku} [sku] The SKU of Cognitive Services account.
*/
Expand Down Expand Up @@ -421,6 +426,23 @@ export interface CheckSkuAvailabilityParameter {
type: string;
}

/**
* @interface
* An interface representing CheckDomainAvailabilityParameter.
* Check Domain availability parameter.
*
*/
export interface CheckDomainAvailabilityParameter {
/**
* @member {string} subdomainName The subdomain name to use.
*/
subdomainName: string;
/**
* @member {string} type The Type of the resource.
*/
type: string;
}

/**
* @interface
* An interface representing CheckSkuAvailabilityResult.
Expand Down Expand Up @@ -469,6 +491,32 @@ export interface CheckSkuAvailabilityResultList {
value?: CheckSkuAvailabilityResult[];
}

/**
* @interface
* An interface representing CheckDomainAvailabilityResult.
* Check Domain availability result.
*
*/
export interface CheckDomainAvailabilityResult {
/**
* @member {boolean} [isSubdomainAvailable] Indicates the given SKU is
* available or not.
*/
isSubdomainAvailable?: boolean;
/**
* @member {string} [reason] Reason why the SKU is not available.
*/
reason?: string;
/**
* @member {string} [subdomainName] The subdomain name to use.
*/
subdomainName?: string;
/**
* @member {string} [type] The Type of the resource.
*/
type?: string;
}

/**
* @interface
* An interface representing ResourceSkuRestrictionInfo.
Expand Down Expand Up @@ -1032,3 +1080,22 @@ export type CheckSkuAvailabilityListResponse = CheckSkuAvailabilityResultList &
parsedBody: CheckSkuAvailabilityResultList;
};
};

/**
* Contains response data for the checkDomainAvailabilityPost operation.
*/
export type LocationsCheckDomainAvailabilityPostResponse = CheckDomainAvailabilityResult & {
/**
* The underlying HTTP response.
*/
_response: msRest.HttpResponse & {
/**
* The response body as text (string format)
*/
bodyAsText: string;
/**
* The response body as parsed JSON or XML
*/
parsedBody: CheckDomainAvailabilityResult;
};
};
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
/*
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for
* license information.
*
* Code generated by Microsoft (R) AutoRest Code Generator.
* Changes may cause incorrect behavior and will be lost if the code is
* regenerated.
*/

export {
CheckDomainAvailabilityParameter,
CheckDomainAvailabilityResult,
CloudError
} from "../models/mappers";

Loading