Skip to content

Commit 52fc486

Browse files
author
SDKAuto
committed
CodeGen from PR 19117 in Azure/azure-rest-api-specs
Support.json Get Support Ticket serviceId + ProbClassId filter changes (Azure#19117) * Support.json Get Support Ticket serviceId + ProbClassId filter changes * Add list tickets service + probClassId examples * Reference example files in support.json * List Support tickets example files formatting * Service Id problem class id example prettier format fix
1 parent f36d6b5 commit 52fc486

File tree

8 files changed

+82
-65
lines changed

8 files changed

+82
-65
lines changed

sdk/support/arm-support/_meta.json

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
2-
"commit": "d600759c3516b61a7c353bc8682bccbab85a6f65",
3-
"readme": "specification\\support\\resource-manager\\readme.md",
4-
"autorest_command": "autorest --version=3.7.3 --typescript --modelerfour.lenient-model-deduplication --head-as-boolean=true --license-header=MICROSOFT_MIT_NO_VERSION --generate-test --typescript-sdks-folder=D:\\work\\azure-sdk-for-js ..\\azure-rest-api-specs\\specification\\support\\resource-manager\\readme.md --use=@autorest/typescript@6.0.0-alpha.19.20220408.1 --generate-sample=true",
2+
"commit": "8dac2febba482c00f1a472cc62a63ca5d83dc9f9",
3+
"readme": "specification/support/resource-manager/readme.md",
4+
"autorest_command": "autorest --version=3.7.3 --typescript --modelerfour.lenient-model-deduplication --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/support/resource-manager/readme.md --use=@autorest/typescript@6.0.0-alpha.19.20220425.1",
55
"repository_url": "https://github.com/Azure/azure-rest-api-specs.git",
6-
"release_tool": "@azure-tools/js-sdk-release-tools@2.3.0",
7-
"use": "@autorest/typescript@6.0.0-alpha.19.20220408.1"
8-
}
6+
"release_tool": "@azure-tools/js-sdk-release-tools@2.3.1",
7+
"use": "@autorest/typescript@6.0.0-alpha.19.20220425.1"
8+
}

sdk/support/arm-support/package.json

Lines changed: 8 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"sdk-type": "mgmt",
44
"author": "Microsoft Corporation",
55
"description": "A generated SDK for MicrosoftSupport.",
6-
"version": "2.0.2",
6+
"version": "2.0.3",
77
"engines": {
88
"node": ">=12.0.0"
99
},
@@ -40,9 +40,11 @@
4040
"uglify-js": "^3.4.9",
4141
"rimraf": "^3.0.0",
4242
"@azure/identity": "^2.0.1",
43-
"@azure-tools/test-recorder": "^1.0.0",
43+
"@azure-tools/test-recorder": "^2.0.0",
44+
"@azure-tools/test-credential": "^1.0.0",
4445
"mocha": "^7.1.1",
45-
"cross-env": "^7.0.2"
46+
"cross-env": "^7.0.2",
47+
"@azure/dev-tool": "^1.0.0"
4648
},
4749
"homepage": "https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/support/arm-support",
4850
"repository": {
@@ -93,7 +95,7 @@
9395
"unit-test:node": "cross-env TEST_MODE=playback npm run integration-test:node",
9496
"unit-test:browser": "echo skipped",
9597
"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 --reporter ../../../common/tools/mocha-multi-reporter.js",
98+
"integration-test:node": "dev-tool run test:node-ts-input -- --timeout 1200000 'test/*.ts'",
9799
"integration-test:browser": "echo skipped",
98100
"docs": "echo skipped"
99101
},
@@ -106,13 +108,5 @@
106108
}
107109
]
108110
},
109-
"autoPublish": true,
110-
"//sampleConfiguration": {
111-
"productName": "",
112-
"productSlugs": [
113-
"azure"
114-
],
115-
"disableDocsMs": true,
116-
"apiRefLink": "https://docs.microsoft.com/javascript/api/@azure/arm-support?view=azure-node-preview"
117-
}
118-
}
111+
"autoPublish": true
112+
}

sdk/support/arm-support/src/microsoftSupport.ts

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,11 @@
88

99
import * as coreClient from "@azure/core-client";
1010
import * as coreRestPipeline from "@azure/core-rest-pipeline";
11+
import {
12+
PipelineRequest,
13+
PipelineResponse,
14+
SendRequest
15+
} from "@azure/core-rest-pipeline";
1116
import * as coreAuth from "@azure/core-auth";
1217
import {
1318
OperationsImpl,
@@ -57,7 +62,7 @@ export class MicrosoftSupport extends coreClient.ServiceClient {
5762
credential: credentials
5863
};
5964

60-
const packageDetails = `azsdk-js-arm-support/2.0.2`;
65+
const packageDetails = `azsdk-js-arm-support/2.0.3`;
6166
const userAgentPrefix =
6267
options.userAgentOptions && options.userAgentOptions.userAgentPrefix
6368
? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
@@ -110,6 +115,35 @@ export class MicrosoftSupport extends coreClient.ServiceClient {
110115
this.problemClassifications = new ProblemClassificationsImpl(this);
111116
this.supportTickets = new SupportTicketsImpl(this);
112117
this.communications = new CommunicationsImpl(this);
118+
this.addCustomApiVersionPolicy(options.apiVersion);
119+
}
120+
121+
/** A function that adds a policy that sets the api-version (or equivalent) to reflect the library version. */
122+
private addCustomApiVersionPolicy(apiVersion?: string) {
123+
if (!apiVersion) {
124+
return;
125+
}
126+
const apiVersionPolicy = {
127+
name: "CustomApiVersionPolicy",
128+
async sendRequest(
129+
request: PipelineRequest,
130+
next: SendRequest
131+
): Promise<PipelineResponse> {
132+
const param = request.url.split("?");
133+
if (param.length > 1) {
134+
const newParams = param[1].split("&").map((item) => {
135+
if (item.indexOf("api-version") > -1) {
136+
return item.replace(/(?<==).*$/, apiVersion);
137+
} else {
138+
return item;
139+
}
140+
});
141+
request.url = param[0] + "?" + newParams.join("&");
142+
}
143+
return next(request);
144+
}
145+
};
146+
this.pipeline.addPolicy(apiVersionPolicy);
113147
}
114148

115149
operations: Operations;

sdk/support/arm-support/src/models/index.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -546,7 +546,7 @@ export interface SupportTicketsListOptionalParams
546546
extends coreClient.OperationOptions {
547547
/** The number of values to return in the collection. Default is 25 and max is 100. */
548548
top?: number;
549-
/** The filter to apply on the operation. We support 'odata v4.0' filter semantics. [Learn more](https://docs.microsoft.com/odata/concepts/queryoptions-overview). _Status_ filter can only be used with Equals ('eq') operator. For _CreatedDate_ filter, the supported operators are Greater Than ('gt') and Greater Than or Equals ('ge'). When using both filters, combine them using the logical 'AND'. */
549+
/** The filter to apply on the operation. We support 'odata v4.0' filter semantics. [Learn more](https://docs.microsoft.com/odata/concepts/queryoptions-overview). _Status_, _ServiceId_, and _ProblemClassificationId_ filters can only be used with Equals ('eq') operator. For _CreatedDate_ filter, the supported operators are Greater Than ('gt') and Greater Than or Equals ('ge'). When using both filters, combine them using the logical 'AND'. */
550550
filter?: string;
551551
}
552552

@@ -584,7 +584,7 @@ export interface SupportTicketsListNextOptionalParams
584584
extends coreClient.OperationOptions {
585585
/** The number of values to return in the collection. Default is 25 and max is 100. */
586586
top?: number;
587-
/** The filter to apply on the operation. We support 'odata v4.0' filter semantics. [Learn more](https://docs.microsoft.com/odata/concepts/queryoptions-overview). _Status_ filter can only be used with Equals ('eq') operator. For _CreatedDate_ filter, the supported operators are Greater Than ('gt') and Greater Than or Equals ('ge'). When using both filters, combine them using the logical 'AND'. */
587+
/** The filter to apply on the operation. We support 'odata v4.0' filter semantics. [Learn more](https://docs.microsoft.com/odata/concepts/queryoptions-overview). _Status_, _ServiceId_, and _ProblemClassificationId_ filters can only be used with Equals ('eq') operator. For _CreatedDate_ filter, the supported operators are Greater Than ('gt') and Greater Than or Equals ('ge'). When using both filters, combine them using the logical 'AND'. */
588588
filter?: string;
589589
}
590590

sdk/support/arm-support/src/operations/supportTickets.ts

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -47,10 +47,10 @@ export class SupportTicketsImpl implements SupportTickets {
4747

4848
/**
4949
* Lists all the support tickets for an Azure subscription. You can also filter the support tickets by
50-
* _Status_ or _CreatedDate_ using the $filter parameter. Output will be a paged result with
51-
* _nextLink_, using which you can retrieve the next set of support tickets. <br/><br/>Support ticket
52-
* data is available for 18 months after ticket creation. If a ticket was created more than 18 months
53-
* ago, a request for data might cause an error.
50+
* _Status_, _CreatedDate_, _ServiceId_, and _ProblemClassificationId_ using the $filter parameter.
51+
* Output will be a paged result with _nextLink_, using which you can retrieve the next set of support
52+
* tickets. <br/><br/>Support ticket data is available for 18 months after ticket creation. If a ticket
53+
* was created more than 18 months ago, a request for data might cause an error.
5454
* @param options The options parameters.
5555
*/
5656
public list(
@@ -109,10 +109,10 @@ export class SupportTicketsImpl implements SupportTickets {
109109

110110
/**
111111
* Lists all the support tickets for an Azure subscription. You can also filter the support tickets by
112-
* _Status_ or _CreatedDate_ using the $filter parameter. Output will be a paged result with
113-
* _nextLink_, using which you can retrieve the next set of support tickets. <br/><br/>Support ticket
114-
* data is available for 18 months after ticket creation. If a ticket was created more than 18 months
115-
* ago, a request for data might cause an error.
112+
* _Status_, _CreatedDate_, _ServiceId_, and _ProblemClassificationId_ using the $filter parameter.
113+
* Output will be a paged result with _nextLink_, using which you can retrieve the next set of support
114+
* tickets. <br/><br/>Support ticket data is available for 18 months after ticket creation. If a ticket
115+
* was created more than 18 months ago, a request for data might cause an error.
116116
* @param options The options parameters.
117117
*/
118118
private _list(

sdk/support/arm-support/src/operationsInterfaces/supportTickets.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,10 @@ import {
2828
export interface SupportTickets {
2929
/**
3030
* Lists all the support tickets for an Azure subscription. You can also filter the support tickets by
31-
* _Status_ or _CreatedDate_ using the $filter parameter. Output will be a paged result with
32-
* _nextLink_, using which you can retrieve the next set of support tickets. <br/><br/>Support ticket
33-
* data is available for 18 months after ticket creation. If a ticket was created more than 18 months
34-
* ago, a request for data might cause an error.
31+
* _Status_, _CreatedDate_, _ServiceId_, and _ProblemClassificationId_ using the $filter parameter.
32+
* Output will be a paged result with _nextLink_, using which you can retrieve the next set of support
33+
* tickets. <br/><br/>Support ticket data is available for 18 months after ticket creation. If a ticket
34+
* was created more than 18 months ago, a request for data might cause an error.
3535
* @param options The options parameters.
3636
*/
3737
list(

sdk/support/arm-support/test/sampleTest.ts

Lines changed: 17 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -7,35 +7,30 @@
77
*/
88

99
import {
10-
env,
11-
record,
12-
RecorderEnvironmentSetup,
13-
Recorder
10+
Recorder,
11+
RecorderStartOptions,
12+
env
1413
} from "@azure-tools/test-recorder";
15-
import * as assert from "assert";
14+
import { assert } from "chai";
15+
import { Context } from "mocha";
1616

17-
const recorderEnvSetup: RecorderEnvironmentSetup = {
18-
replaceableVariables: {
19-
AZURE_CLIENT_ID: "azure_client_id",
20-
AZURE_CLIENT_SECRET: "azure_client_secret",
21-
AZURE_TENANT_ID: "88888888-8888-8888-8888-888888888888",
22-
SUBSCRIPTION_ID: "azure_subscription_id"
23-
},
24-
customizationsOnRecordings: [
25-
(recording: any): any =>
26-
recording.replace(
27-
/"access_token":"[^"]*"/g,
28-
`"access_token":"access_token"`
29-
)
30-
],
31-
queryParametersToSkip: []
17+
const replaceableVariables: Record<string, string> = {
18+
AZURE_CLIENT_ID: "azure_client_id",
19+
AZURE_CLIENT_SECRET: "azure_client_secret",
20+
AZURE_TENANT_ID: "88888888-8888-8888-8888-888888888888",
21+
SUBSCRIPTION_ID: "azure_subscription_id"
22+
};
23+
24+
const recorderOptions: RecorderStartOptions = {
25+
envSetupForPlayback: replaceableVariables
3226
};
3327

3428
describe("My test", () => {
3529
let recorder: Recorder;
3630

37-
beforeEach(async function() {
38-
recorder = record(this, recorderEnvSetup);
31+
beforeEach(async function(this: Context) {
32+
recorder = new Recorder(this.currentTest);
33+
await recorder.start(recorderOptions);
3934
});
4035

4136
afterEach(async function() {

sdk/support/arm-support/tsconfig.json

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,17 +15,11 @@
1515
],
1616
"declaration": true,
1717
"outDir": "./dist-esm",
18-
"importHelpers": true,
19-
"paths": {
20-
"@azure/arm-support": [
21-
"./src/index"
22-
]
23-
}
18+
"importHelpers": true
2419
},
2520
"include": [
2621
"./src/**/*.ts",
27-
"./test/**/*.ts",
28-
"samples-dev/**/*.ts"
22+
"./test/**/*.ts"
2923
],
3024
"exclude": [
3125
"node_modules"

0 commit comments

Comments
 (0)