Skip to content

Commit 6f98059

Browse files
colawwjcolawwj
authored
videoanalyzer-track2-ga (Azure#19321)
1 parent 9451c84 commit 6f98059

28 files changed

+230
-250
lines changed

‎common/config/rush/pnpm-lock.yaml‎

Lines changed: 2 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎sdk/videoanalyzer/arm-videoanalyzer/CHANGELOG.md‎

Lines changed: 20 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,23 @@
1-
## Release History
2-
3-
### 1.0.0-beta.2 (Unreleased)
4-
5-
#### Features Added
6-
7-
#### Breaking Changes
8-
9-
#### Bugs Fixed
10-
11-
#### Other Changes
12-
13-
### 1.0.0-beta.1 (2021-10-27)
1+
# Release History
2+
3+
## 1.0.0-beta.2 (2021-12-14)
4+
5+
**Features**
6+
7+
- Added Interface VideoAnalyzerManagementClientOptionalParams
8+
- Added Class VideoAnalyzerManagementClient
9+
- Added Type Alias VideoAnalyzer
10+
- Add parameters of VideoAnalyzer to TypeAlias VideoAnalyzersUpdateResponse
11+
12+
**Breaking Changes**
13+
14+
- Operation VideoAnalyzers.beginCreateOrUpdate has a new signature
15+
- Operation VideoAnalyzers.beginCreateOrUpdateAndWait has a new signature
16+
- Deleted Class VideoAnalyzer
17+
- Deleted Class VideoAnalyzerContext
18+
- Delete parameters of VideoAnalyzer_2 in TypeAlias VideoAnalyzersUpdateResponse
19+
20+
## 1.0.0-beta.1 (2021-10-27)
1421

1522
This is the first preview for the new version of the `@azure/arm-videoanalyzer` package that follows the new [guidelines for TypeScript SDKs](https://azure.github.io/azure-sdk/typescript_introduction.html) for Azure services.
1623

‎sdk/videoanalyzer/arm-videoanalyzer/README.md‎

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Azure Service client library for JavaScript
1+
# Azure VideoAnalyzerManagement client library for JavaScript
22

3-
This package contains an isomorphic SDK (runs both in Node.js and in browsers) for Azure Service client.
3+
This package contains an isomorphic SDK (runs both in Node.js and in browsers) for Azure VideoAnalyzerManagement client.
44

55
Azure Video Analyzer provides a platform for you to build intelligent video applications that span the edge and the cloud
66

@@ -22,16 +22,16 @@ Azure Video Analyzer provides a platform for you to build intelligent video appl
2222

2323
### Install the `@azure/arm-videoanalyzer` package
2424

25-
Install the Azure Service client library for JavaScript with `npm`:
25+
Install the Azure VideoAnalyzerManagement client library for JavaScript with `npm`:
2626

2727
```bash
2828
npm install @azure/arm-videoanalyzer
2929
```
3030

31-
### Create and authenticate a `VideoAnalyzer`
31+
### Create and authenticate a `VideoAnalyzerManagementClient`
3232

33-
To create a client object to access the Azure Service API, you will need the `endpoint` of your Azure Service resource and a `credential`. The Azure Service client can use Azure Active Directory credentials to authenticate.
34-
You can find the endpoint for your Azure Service resource in the [Azure Portal][azure_portal].
33+
To create a client object to access the Azure VideoAnalyzerManagement API, you will need the `endpoint` of your Azure VideoAnalyzerManagement resource and a `credential`. The Azure VideoAnalyzerManagement client can use Azure Active Directory credentials to authenticate.
34+
You can find the endpoint for your Azure VideoAnalyzerManagement resource in the [Azure Portal][azure_portal].
3535

3636
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).
3737

@@ -41,23 +41,27 @@ To use the [DefaultAzureCredential][defaultazurecredential] provider shown below
4141
npm install @azure/identity
4242
```
4343

44-
You will also need to **register a new AAD application and grant access to Azure Service** by assigning the suitable role to your service principal (note: roles such as `"Owner"` will not grant the necessary permissions).
44+
You will also need to **register a new AAD application and grant access to Azure VideoAnalyzerManagement** by assigning the suitable role to your service principal (note: roles such as `"Owner"` will not grant the necessary permissions).
4545
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`.
4646

4747
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).
4848

4949
```javascript
50-
const { VideoAnalyzer } = require("@azure/arm-videoanalyzer");
50+
const { VideoAnalyzerManagementClient } = require("@azure/arm-videoanalyzer");
5151
const { DefaultAzureCredential } = require("@azure/identity");
5252
const subscriptionId = "00000000-0000-0000-0000-000000000000";
53-
const client = new VideoAnalyzer(new DefaultAzureCredential(), subscriptionId);
53+
const client = new VideoAnalyzerManagementClient(new DefaultAzureCredential(), subscriptionId);
5454
```
5555

56+
57+
### JavaScript Bundle
58+
To use this client library in the browser, first you need to use a bundler. For details on how to do this, please refer to our [bundling documentation](https://aka.ms/AzureSDKBundling).
59+
5660
## Key concepts
5761

58-
### VideoAnalyzer
62+
### VideoAnalyzerManagementClient
5963

60-
`VideoAnalyzer` is the primary interface for developers using the Azure Service client library. Explore the methods on this client object to understand the different features of the Azure Service service that you can access.
64+
`VideoAnalyzerManagementClient` is the primary interface for developers using the Azure VideoAnalyzerManagement client library. Explore the methods on this client object to understand the different features of the Azure VideoAnalyzerManagement service that you can access.
6165

6266
## Troubleshooting
6367

‎sdk/videoanalyzer/arm-videoanalyzer/_meta.json‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
2-
"commit": "f6a8a2ef54e892943b8c32358b2d731e01441d00",
2+
"commit": "ea0f7b072ad3aaff203ea9003246b9e584b819ff",
33
"readme": "specification/videoanalyzer/resource-manager/readme.md",
4-
"autorest_command": "autorest --version=3.1.3 --typescript --modelerfour.lenient-model-deduplication --head-as-boolean=true --license-header=MICROSOFT_MIT_NO_VERSION --generate-test --typescript-sdks-folder=D:\\mydev\\azure-sdk-for-js ../azure-rest-api-specs/specification/videoanalyzer/resource-manager/readme.md --use=@autorest/typescript@6.0.0-beta.13",
4+
"autorest_command": "autorest --version=3.1.3 --typescript --modelerfour.lenient-model-deduplication --head-as-boolean=true --license-header=MICROSOFT_MIT_NO_VERSION --generate-test --typescript-sdks-folder=D:\\mydev\\azure-sdk-for-js ../azure-rest-api-specs/specification/videoanalyzer/resource-manager/readme.md --use=@autorest/typescript@6.0.0-alpha.16.20211207.1",
55
"repository_url": "https://github.com/Azure/azure-rest-api-specs.git",
6-
"use": "@autorest/typescript@6.0.0-beta.13"
6+
"use": "@autorest/typescript@6.0.0-alpha.16.20211207.1"
77
}

‎sdk/videoanalyzer/arm-videoanalyzer/package.json‎

Lines changed: 9 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2,27 +2,19 @@
22
"name": "@azure/arm-videoanalyzer",
33
"sdk-type": "mgmt",
44
"author": "Microsoft Corporation",
5-
"description": "A generated SDK for VideoAnalyzer.",
5+
"description": "A generated SDK for VideoAnalyzerManagementClient.",
66
"version": "1.0.0-beta.2",
7-
"engines": {
8-
"node": ">=12.0.0"
9-
},
7+
"engines": { "node": ">=12.0.0" },
108
"dependencies": {
119
"@azure/core-lro": "^2.2.0",
1210
"@azure/abort-controller": "^1.0.0",
13-
"@azure/core-paging": "^1.1.1",
11+
"@azure/core-paging": "^1.2.0",
1412
"@azure/core-client": "^1.0.0",
1513
"@azure/core-auth": "^1.3.0",
1614
"@azure/core-rest-pipeline": "^1.1.0",
1715
"tslib": "^2.2.0"
1816
},
19-
"keywords": [
20-
"node",
21-
"azure",
22-
"typescript",
23-
"browser",
24-
"isomorphic"
25-
],
17+
"keywords": ["node", "azure", "typescript", "browser", "isomorphic"],
2618
"license": "MIT",
2719
"main": "./dist/index.js",
2820
"module": "./dist-esm/src/index.js",
@@ -38,6 +30,7 @@
3830
"rollup-plugin-sourcemaps": "^0.4.2",
3931
"typescript": "~4.2.0",
4032
"uglify-js": "^3.4.9",
33+
"rimraf": "^3.0.0",
4134
"@azure/identity": "^2.0.1",
4235
"@azure-tools/test-recorder": "^1.0.0",
4336
"mocha": "^7.1.1",
@@ -48,9 +41,7 @@
4841
"type": "git",
4942
"url": "https://github.com/Azure/azure-sdk-for-js.git"
5043
},
51-
"bugs": {
52-
"url": "https://github.com/Azure/azure-sdk-for-js/issues"
53-
},
44+
"bugs": { "url": "https://github.com/Azure/azure-sdk-for-js/issues" },
5445
"files": [
5546
"dist/**/*.js",
5647
"dist/**/*.js.map",
@@ -70,14 +61,14 @@
7061
"types/*"
7162
],
7263
"scripts": {
73-
"build": "tsc && rollup -c 2>&1 && npm run minify && mkdirp ./review && npm run extract-api",
64+
"build": "npm run clean && tsc && rollup -c 2>&1 && npm run minify && mkdirp ./review && npm run extract-api",
7465
"minify": "uglifyjs -c -m --comments --source-map \"content='./dist/index.js.map'\" -o ./dist/index.min.js ./dist/index.js",
7566
"prepack": "npm run build",
7667
"pack": "npm pack 2>&1",
7768
"extract-api": "api-extractor run --local",
7869
"lint": "echo skipped",
7970
"audit": "echo skipped",
80-
"clean": "echo skipped",
71+
"clean": "rimraf dist dist-browser dist-esm test-dist temp types *.tgz *.log",
8172
"build:node": "echo skipped",
8273
"build:browser": "echo skipped",
8374
"build:test": "echo skipped",
@@ -86,14 +77,13 @@
8677
"execute:samples": "echo skipped",
8778
"format": "echo skipped",
8879
"test": "npm run integration-test",
89-
"prebuild": "echo skipped",
9080
"test:node": "echo skipped",
9181
"test:browser": "echo skipped",
9282
"unit-test": "npm run unit-test:node && npm run unit-test:browser",
9383
"unit-test:node": "cross-env TEST_MODE=playback npm run integration-test:node",
9484
"unit-test:browser": "echo skipped",
9585
"integration-test": "npm run integration-test:node && npm run integration-test:browser",
96-
"integration-test:node": "mocha -r esm --require ts-node/register --timeout 1200000 --full-trace test/*.ts",
86+
"integration-test:node": "mocha -r esm --require ts-node/register --timeout 1200000 --full-trace test/*.ts --reporter ../../../common/tools/mocha-multi-reporter.js",
9787
"integration-test:browser": "echo skipped",
9888
"docs": "echo skipped"
9989
},

‎sdk/videoanalyzer/arm-videoanalyzer/review/arm-videoanalyzer.api.md‎

Lines changed: 47 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1246,12 +1246,45 @@ export type UsernamePasswordCredentials = CredentialsBase & {
12461246
password: string;
12471247
};
12481248

1249+
// @public
1250+
export type VideoAnalyzer = TrackedResource & {
1251+
identity?: VideoAnalyzerIdentity;
1252+
storageAccounts?: StorageAccount[];
1253+
readonly endpoints?: Endpoint[];
1254+
encryption?: AccountEncryption;
1255+
iotHubs?: IotHub[];
1256+
publicNetworkAccess?: PublicNetworkAccess;
1257+
networkAccessControl?: NetworkAccessControl;
1258+
readonly provisioningState?: ProvisioningState;
1259+
readonly privateEndpointConnections?: PrivateEndpointConnection[];
1260+
};
1261+
1262+
// @public
1263+
export interface VideoAnalyzerCollection {
1264+
value?: VideoAnalyzer[];
1265+
}
1266+
1267+
// @public
1268+
export type VideoAnalyzerEndpointType = string;
1269+
1270+
// @public
1271+
export interface VideoAnalyzerIdentity {
1272+
type: string;
1273+
userAssignedIdentities?: {
1274+
[propertyName: string]: UserAssignedManagedIdentity;
1275+
};
1276+
}
1277+
12491278
// @public (undocumented)
1250-
export class VideoAnalyzer extends VideoAnalyzerContext {
1251-
constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: VideoAnalyzerOptionalParams);
1279+
export class VideoAnalyzerManagementClient extends coreClient.ServiceClient {
1280+
// (undocumented)
1281+
$host: string;
1282+
constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: VideoAnalyzerManagementClientOptionalParams);
12521283
// (undocumented)
12531284
accessPolicies: AccessPolicies;
12541285
// (undocumented)
1286+
apiVersion: string;
1287+
// (undocumented)
12551288
edgeModules: EdgeModules;
12561289
// (undocumented)
12571290
livePipelineOperationStatuses: LivePipelineOperationStatuses;
@@ -1276,6 +1309,8 @@ export class VideoAnalyzer extends VideoAnalyzerContext {
12761309
// (undocumented)
12771310
privateLinkResources: PrivateLinkResources;
12781311
// (undocumented)
1312+
subscriptionId: string;
1313+
// (undocumented)
12791314
videoAnalyzerOperationResults: VideoAnalyzerOperationResults;
12801315
// (undocumented)
12811316
videoAnalyzerOperationStatuses: VideoAnalyzerOperationStatuses;
@@ -1286,31 +1321,10 @@ export class VideoAnalyzer extends VideoAnalyzerContext {
12861321
}
12871322

12881323
// @public
1289-
export interface VideoAnalyzerCollection {
1290-
// Warning: (ae-forgotten-export) The symbol "VideoAnalyzer" needs to be exported by the entry point index.d.ts
1291-
value?: VideoAnalyzer_2[];
1292-
}
1293-
1294-
// @public (undocumented)
1295-
export class VideoAnalyzerContext extends coreClient.ServiceClient {
1296-
// (undocumented)
1297-
$host: string;
1298-
constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: VideoAnalyzerOptionalParams);
1299-
// (undocumented)
1300-
apiVersion: string;
1301-
// (undocumented)
1302-
subscriptionId: string;
1303-
}
1304-
1305-
// @public
1306-
export type VideoAnalyzerEndpointType = string;
1307-
1308-
// @public
1309-
export interface VideoAnalyzerIdentity {
1310-
type: string;
1311-
userAssignedIdentities?: {
1312-
[propertyName: string]: UserAssignedManagedIdentity;
1313-
};
1324+
export interface VideoAnalyzerManagementClientOptionalParams extends coreClient.ServiceClientOptions {
1325+
$host?: string;
1326+
apiVersion?: string;
1327+
endpoint?: string;
13141328
}
13151329

13161330
// @public
@@ -1323,7 +1337,7 @@ export interface VideoAnalyzerOperationResultsGetOptionalParams extends coreClie
13231337
}
13241338

13251339
// @public
1326-
export type VideoAnalyzerOperationResultsGetResponse = VideoAnalyzer_2;
1340+
export type VideoAnalyzerOperationResultsGetResponse = VideoAnalyzer;
13271341

13281342
// @public
13291343
export interface VideoAnalyzerOperationStatus {
@@ -1347,13 +1361,6 @@ export interface VideoAnalyzerOperationStatusesGetOptionalParams extends coreCli
13471361
// @public
13481362
export type VideoAnalyzerOperationStatusesGetResponse = VideoAnalyzerOperationStatus;
13491363

1350-
// @public
1351-
export interface VideoAnalyzerOptionalParams extends coreClient.ServiceClientOptions {
1352-
$host?: string;
1353-
apiVersion?: string;
1354-
endpoint?: string;
1355-
}
1356-
13571364
// @public
13581365
export interface VideoAnalyzerPrivateEndpointConnectionOperationStatus {
13591366
endTime?: string;
@@ -1366,8 +1373,8 @@ export interface VideoAnalyzerPrivateEndpointConnectionOperationStatus {
13661373

13671374
// @public
13681375
export interface VideoAnalyzers {
1369-
beginCreateOrUpdate(resourceGroupName: string, accountName: string, parameters: VideoAnalyzer_2, options?: VideoAnalyzersCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<VideoAnalyzersCreateOrUpdateResponse>, VideoAnalyzersCreateOrUpdateResponse>>;
1370-
beginCreateOrUpdateAndWait(resourceGroupName: string, accountName: string, parameters: VideoAnalyzer_2, options?: VideoAnalyzersCreateOrUpdateOptionalParams): Promise<VideoAnalyzersCreateOrUpdateResponse>;
1376+
beginCreateOrUpdate(resourceGroupName: string, accountName: string, parameters: VideoAnalyzer, options?: VideoAnalyzersCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<VideoAnalyzersCreateOrUpdateResponse>, VideoAnalyzersCreateOrUpdateResponse>>;
1377+
beginCreateOrUpdateAndWait(resourceGroupName: string, accountName: string, parameters: VideoAnalyzer, options?: VideoAnalyzersCreateOrUpdateOptionalParams): Promise<VideoAnalyzersCreateOrUpdateResponse>;
13711378
beginUpdate(resourceGroupName: string, accountName: string, parameters: VideoAnalyzerUpdate, options?: VideoAnalyzersUpdateOptionalParams): Promise<PollerLike<PollOperationState<VideoAnalyzersUpdateResponse>, VideoAnalyzersUpdateResponse>>;
13721379
beginUpdateAndWait(resourceGroupName: string, accountName: string, parameters: VideoAnalyzerUpdate, options?: VideoAnalyzersUpdateOptionalParams): Promise<VideoAnalyzersUpdateResponse>;
13731380
delete(resourceGroupName: string, accountName: string, options?: VideoAnalyzersDeleteOptionalParams): Promise<void>;
@@ -1390,7 +1397,7 @@ export interface VideoAnalyzersCreateOrUpdateOptionalParams extends coreClient.O
13901397
}
13911398

13921399
// @public
1393-
export type VideoAnalyzersCreateOrUpdateResponse = VideoAnalyzer_2;
1400+
export type VideoAnalyzersCreateOrUpdateResponse = VideoAnalyzer;
13941401

13951402
// @public
13961403
export interface VideoAnalyzersDeleteOptionalParams extends coreClient.OperationOptions {
@@ -1401,7 +1408,7 @@ export interface VideoAnalyzersGetOptionalParams extends coreClient.OperationOpt
14011408
}
14021409

14031410
// @public
1404-
export type VideoAnalyzersGetResponse = VideoAnalyzer_2;
1411+
export type VideoAnalyzersGetResponse = VideoAnalyzer;
14051412

14061413
// @public
14071414
export interface VideoAnalyzersListBySubscriptionOptionalParams extends coreClient.OperationOptions {
@@ -1431,7 +1438,7 @@ export interface VideoAnalyzersUpdateOptionalParams extends coreClient.Operation
14311438
}
14321439

14331440
// @public
1434-
export type VideoAnalyzersUpdateResponse = VideoAnalyzersUpdateHeaders & VideoAnalyzer_2;
1441+
export type VideoAnalyzersUpdateResponse = VideoAnalyzersUpdateHeaders & VideoAnalyzer;
14351442

14361443
// @public
14371444
export interface VideoAnalyzerUpdate {
@@ -1626,7 +1633,6 @@ export type VideosUpdateResponse = VideoEntity;
16261633
// @public
16271634
export type VideoType = string;
16281635

1629-
16301636
// (No @packageDocumentation comment for this package)
16311637

16321638
```

‎sdk/videoanalyzer/arm-videoanalyzer/src/index.ts‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,5 @@
88

99
/// <reference lib="esnext.asynciterable" />
1010
export * from "./models";
11-
export { VideoAnalyzer } from "./videoAnalyzer";
12-
export { VideoAnalyzerContext } from "./videoAnalyzerContext";
11+
export { VideoAnalyzerManagementClient } from "./videoAnalyzerManagementClient";
1312
export * from "./operationsInterfaces";

0 commit comments

Comments
 (0)