Skip to content

Commit 270eeb7

Browse files
sahilpwrsahilpwr
authored
[Hub Generated] Review request for Microsoft.Help to add version preview/2023-09-01-preview (#25604)
* Adds base for updating Microsoft.Help from version stable/2023-06-01 to version 2023-09-01-preview * Updates readme * Updates API version in new specs and examples * adding swagger for public preview * update readme * updating documentation * adding documentation * fix list * addressing comments * updating description * updating continue GT * fixing errors * fixing enum * fix prettier check * adding Guidance * update * Update GT documentation * Update GT example * fix GT doc errors * fix doc * fix error
1 parent 6c4fc92 commit 270eeb7

17 files changed

+3133
-2
lines changed

‎specification/help/resource-manager/Microsoft.Help/preview/2023-09-01-preview/examples/CheckNameAvailabilityForDiagnosticWhenNameIsAvailable.json‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"parameters": {
3+
"api-version": "2023-09-01-preview",
4+
"scope": "subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6",
5+
"CheckNameAvailabilityRequest": {
6+
"name": "sampleName",
7+
"type": "Microsoft.Help/diagnostics"
8+
}
9+
},
10+
"responses": {
11+
"200": {
12+
"body": {
13+
"nameAvailable": true
14+
}
15+
}
16+
}
17+
}

‎specification/help/resource-manager/Microsoft.Help/preview/2023-09-01-preview/examples/CheckNameAvailabilityForDiagnosticWhenNameIsNotAvailable.json‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
{
2+
"parameters": {
3+
"api-version": "2023-09-01-preview",
4+
"scope": "subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6",
5+
"CheckNameAvailabilityRequest": {
6+
"name": "sampleName",
7+
"type": "Microsoft.Help/diagnostics"
8+
}
9+
},
10+
"responses": {
11+
"200": {
12+
"body": {
13+
"nameAvailable": false,
14+
"reason": "Name is already in use",
15+
"message": "Name not available"
16+
}
17+
}
18+
}
19+
}

‎specification/help/resource-manager/Microsoft.Help/preview/2023-09-01-preview/examples/CreateDiagnosticForKeyVaultResource.json‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
{
2+
"parameters": {
3+
"api-version": "2023-09-01-preview",
4+
"scope": "subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourceGroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read",
5+
"diagnosticsResourceName": "VMNotWorkingInsight",
6+
"diagnosticItemRequest": {
7+
"properties": {
8+
"insights": [
9+
{
10+
"solutionId": "SampleSolutionId",
11+
"additionalParameters": {
12+
"serverName": "testServer"
13+
}
14+
}
15+
],
16+
"globalParameters": {
17+
"startTime": "2020-07-01"
18+
}
19+
}
20+
}
21+
},
22+
"responses": {
23+
"201": {
24+
"body": {
25+
"id": "/subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourceGroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read/providers/Microsoft.Help/diagnostics/VMNotWorkingInsight",
26+
"name": "VMNotWorkingInsight",
27+
"type": "Microsoft.Help/diagnostics",
28+
"properties": {
29+
"provisioningState": "Succeeded",
30+
"acceptedAt": "2023-03-10T03:04:40Z"
31+
}
32+
}
33+
},
34+
"200": {
35+
"body": {
36+
"id": "/subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourceGroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read/providers/Microsoft.Help/diagnostics/VMNotWorkingInsight",
37+
"type": "VMNotWorkingInsight",
38+
"name": "Microsoft.Help/diagnostics",
39+
"properties": {
40+
"acceptedAt": "2023-03-10T03:04:40Z",
41+
"provisioningState": "Succeeded",
42+
"diagnostics": [
43+
{
44+
"solutionId": "sampleSolutionId",
45+
"status": "Succeeded",
46+
"insights": [
47+
{
48+
"id": "InsightArticleId",
49+
"title": "An example title for an Insight",
50+
"results": "Article Content",
51+
"importanceLevel": "Critical"
52+
}
53+
],
54+
"error": {
55+
"code": "errorCode",
56+
"message": "errorMessage"
57+
}
58+
}
59+
]
60+
}
61+
}
62+
}
63+
}
64+
}

‎specification/help/resource-manager/Microsoft.Help/preview/2023-09-01-preview/examples/GetDiagnosticForKeyVaultResource.json‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
{
2+
"parameters": {
3+
"api-version": "2023-09-01-preview",
4+
"scope": "subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourceGroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read",
5+
"diagnosticsResourceName": "VMNotWorkingInsight"
6+
},
7+
"responses": {
8+
"200": {
9+
"body": {
10+
"id": "/subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourceGroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read/providers/Microsoft.Help/diagnostics/VMNotWorkingInsight",
11+
"type": "VMNotWorkingInsight",
12+
"name": "Microsoft.Help/diagnostics",
13+
"properties": {
14+
"acceptedAt": "2023-03-10T03:04:40Z",
15+
"provisioningState": "Succeeded",
16+
"diagnostics": [
17+
{
18+
"solutionId": "sampleSolutionId",
19+
"status": "Succeeded",
20+
"insights": [
21+
{
22+
"id": "InsightArticleId",
23+
"title": "An example title for an Insight",
24+
"results": "Article Content",
25+
"importanceLevel": "Critical"
26+
}
27+
],
28+
"error": {
29+
"code": "errorCode",
30+
"message": "errorMessage"
31+
}
32+
}
33+
]
34+
}
35+
}
36+
}
37+
}
38+
}

‎specification/help/resource-manager/Microsoft.Help/preview/2023-09-01-preview/examples/ListDiscoverySolutionsAtResourceScope.json‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
{
2+
"parameters": {
3+
"api-version": "2023-09-01-preview",
4+
"$filter": "ProblemClassificationId eq 'SampleProblemClassificationId1'",
5+
"scope": "subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read"
6+
},
7+
"responses": {
8+
"200": {
9+
"body": {
10+
"value": [
11+
{
12+
"id": "/subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourceGroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read/providers/Microsoft.Help/discoverySolutions/SampleProblemClassificationId1",
13+
"name": "SampleProblemClassificationId1",
14+
"type": "Microsoft.Help/discoverySolutions",
15+
"properties": {
16+
"solutions": [
17+
{
18+
"solutionId": "SampleSolutionId1",
19+
"solutionType": "Diagnostics",
20+
"description": "This is an azure solution to troubleshoot subscription issues.",
21+
"requiredInputs": [
22+
"SubscriptionId"
23+
]
24+
}
25+
]
26+
}
27+
}
28+
]
29+
}
30+
}
31+
}
32+
}

‎specification/help/resource-manager/Microsoft.Help/preview/2023-09-01-preview/examples/ListDiscoverySolutionsAtSubscriptionScope.json‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
{
2+
"parameters": {
3+
"api-version": "2023-09-01-preview",
4+
"$filter": "ProblemClassificationId eq 'SampleProblemClassificationId1'",
5+
"scope": "subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6"
6+
},
7+
"responses": {
8+
"200": {
9+
"body": {
10+
"value": [
11+
{
12+
"id": "/subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/providers/Microsoft.Help/discoverySolutions/SampleProblemClassificationId1",
13+
"name": "SampleProblemClassificationId1",
14+
"type": "Microsoft.Help/discoverySolutions",
15+
"properties": {
16+
"solutions": [
17+
{
18+
"solutionId": "SampleSolutionId1",
19+
"solutionType": "Diagnostics",
20+
"description": "This is an azure solution to troubleshoot subscription issues.",
21+
"requiredInputs": [
22+
"SubscriptionId"
23+
]
24+
}
25+
]
26+
}
27+
}
28+
]
29+
}
30+
}
31+
}
32+
}

‎specification/help/resource-manager/Microsoft.Help/preview/2023-09-01-preview/examples/ListOperations.json‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
{
2+
"parameters": {
3+
"api-version": "2023-09-01-preview"
4+
},
5+
"responses": {
6+
"200": {
7+
"body": {
8+
"value": [
9+
{
10+
"name": "Microsoft.Help/diagnostics/read",
11+
"isDataAction": false,
12+
"display": {
13+
"provider": "Microsoft.Diagnostics",
14+
"resource": "Diagnostics",
15+
"operation": "Create/Read a Diagnostic",
16+
"description": "Created and Reads a diagnostic resource to troubleshoot an issue with a resource."
17+
}
18+
},
19+
{
20+
"name": "Microsoft.Help/discoverySolutions/read",
21+
"isDataAction": false,
22+
"display": {
23+
"provider": "Microsoft.Help",
24+
"resource": "DiscoverySolutions",
25+
"operation": "List of available solutions.",
26+
"description": "Returns list of solutions based on ResourceType or ProblemClassficationId"
27+
}
28+
}
29+
]
30+
}
31+
}
32+
}
33+
}

0 commit comments

Comments
 (0)