Skip to content

Commit 4fcab27

Browse files
Alex-wdyAlex-AZPSwyunchi-ms
authored
[PS->Portal] Provide resource type of top 10 services used in Portal for SDK based cmdlets (#20102)
* Add UX files for Compute * Add UX file for SQL * Add UX files for Compute/CosmosDB * Update src/Sql/Sql/UX/Microsoft.Sql/sqlDatabase.json Co-authored-by: Alex Wang <[email protected]> Co-authored-by: Yunchi Wang <[email protected]>
1 parent e961ed0 commit 4fcab27

File tree

10 files changed

+830
-0
lines changed

10 files changed

+830
-0
lines changed

‎src/Compute/Compute/UX/Microsoft.Compute/disks.json

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
{
2+
"resourceType":"disks",
3+
"apiVersion":"2022-07-02",
4+
"learnMore":{
5+
"url":"https://learn.microsoft.com/powershell/module/az.compute/#compute"
6+
},
7+
"commands":[
8+
{
9+
"name":"Get-AzDisk",
10+
"description":"Gets the properties of a Managed disk.",
11+
"path":"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/disks/{diskName}",
12+
"confirmation":false,
13+
"help":{
14+
"learnMore":{
15+
"url":"https://learn.microsoft.com/powershell/module/az.compute/get-azdisk"
16+
},
17+
"parameterSets":[
18+
{
19+
"parameters":[
20+
"[[-ResourceGroupName] <System.String>]",
21+
"[[-DiskName] <String>]"
22+
]
23+
}
24+
]
25+
},
26+
"examples":[
27+
{
28+
"description":"Gets the properties of a Managed disk.",
29+
"parameters":[
30+
{
31+
"name":"-ResourceGroupName",
32+
"value":"[path.resourceGroupName]"
33+
},
34+
{
35+
"name":"-DiskName",
36+
"value":"[path.diskName]"
37+
}
38+
]
39+
}
40+
]
41+
},
42+
{
43+
"name":"Remove-AzDisk",
44+
"description":"Removes a disk.",
45+
"path":"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/disks/{diskName}",
46+
"confirmation":false,
47+
"help":{
48+
"learnMore":{
49+
"url":"https://learn.microsoft.com/powershell/module/az.compute/remove-azdisk"
50+
},
51+
"parameterSets":[
52+
{
53+
"parameters":[
54+
"[[-ResourceGroupName] <System.String>]",
55+
"[[-DiskName] <String>]"
56+
]
57+
}
58+
]
59+
},
60+
"examples":[
61+
{
62+
"description":"Removes a disk.",
63+
"parameters":[
64+
{
65+
"name":"-ResourceGroupName",
66+
"value":"[path.resourceGroupName]"
67+
},
68+
{
69+
"name":"-DiskName",
70+
"value":"[path.diskName]"
71+
}
72+
]
73+
}
74+
]
75+
}
76+
]
77+
}

‎src/Compute/Compute/UX/Microsoft.Compute/virtualMachines.json

Lines changed: 145 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,145 @@
1+
{
2+
"resourceType":"subscriptions",
3+
"apiVersion":"2022-08-01",
4+
"learnMore":{
5+
"url":"https://learn.microsoft.com/powershell/module/az.compute/#virtual-machines"
6+
},
7+
"commands":[
8+
{
9+
"name":"Get-AzVM",
10+
"description":"Gets the properties of a virtual machine.",
11+
"path":"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{VMName}",
12+
"confirmation":false,
13+
"help":{
14+
"learnMore":{
15+
"url":"https://learn.microsoft.com/powershell/module/az.compute/get-azvm"
16+
},
17+
"parameterSets":[
18+
{
19+
"parameters":[
20+
"[[-ResourceGroupName] <System.String>]",
21+
"[[-VMName] <String>]"
22+
]
23+
}
24+
]
25+
},
26+
"examples":[
27+
{
28+
"description":"Gets the properties of a virtual machine.",
29+
"parameters":[
30+
{
31+
"name":"-ResourceGroupName",
32+
"value":"[path.resourceGroupName]"
33+
},
34+
{
35+
"name":"-Name",
36+
"value":"[path.VMName]"
37+
}
38+
]
39+
}
40+
]
41+
},
42+
{
43+
"name":"Stop-AzVM",
44+
"description":"Stops an Azure virtual machine.",
45+
"path":"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{VMName}",
46+
"confirmation":false,
47+
"help":{
48+
"learnMore":{
49+
"url":"https://learn.microsoft.com/powershell/module/az.compute/stop-azvm"
50+
},
51+
"parameterSets":[
52+
{
53+
"parameters":[
54+
"[-ResourceGroupName] <System.String>",
55+
"[-VMName] <System.String>"
56+
]
57+
}
58+
]
59+
},
60+
"examples":[
61+
{
62+
"description":"Stops an Azure virtual machine.",
63+
"parameters":[
64+
{
65+
"name":"-ResourceGroupName",
66+
"value":"[path.resourceGroupName]"
67+
},
68+
{
69+
"name":"-Name",
70+
"value":"[path.VMName]"
71+
}
72+
]
73+
}
74+
]
75+
},
76+
{
77+
"name":"Start-AzVM",
78+
"description":"Starts an Azure virtual machine.",
79+
"path":"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{VMName}",
80+
"confirmation":false,
81+
"help":{
82+
"learnMore":{
83+
"url":"https://learn.microsoft.com/powershell/module/az.compute/start-azvm"
84+
},
85+
"parameterSets":[
86+
{
87+
"parameters":[
88+
"[-ResourceGroupName] <System.String>",
89+
"[-VMName] <System.String>"
90+
]
91+
}
92+
]
93+
},
94+
"examples":[
95+
{
96+
"description":"Starts an Azure virtual machine.",
97+
"parameters":[
98+
{
99+
"name":"-ResourceGroupName",
100+
"value":"[path.resourceGroupName]"
101+
},
102+
{
103+
"name":"-Name",
104+
"value":"[path.VMName]"
105+
}
106+
]
107+
}
108+
]
109+
},
110+
{
111+
"name":"Restart-AzVM",
112+
"description":"Restarts an Azure virtual machine.",
113+
"path":"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{VMName}",
114+
"confirmation":false,
115+
"help":{
116+
"learnMore":{
117+
"url":"https://learn.microsoft.com/powershell/module/az.compute/restart-azvm"
118+
},
119+
"parameterSets":[
120+
{
121+
"parameters":[
122+
"[-ResourceGroupName] <System.String>",
123+
"[-VMName] <System.String>"
124+
]
125+
}
126+
]
127+
},
128+
"examples":[
129+
{
130+
"description":"Restarts an Azure virtual machine.",
131+
"parameters":[
132+
{
133+
"name":"-ResourceGroupName",
134+
"value":"[path.resourceGroupName]"
135+
},
136+
{
137+
"name":"-Name",
138+
"value":"[path.VMName]"
139+
}
140+
]
141+
}
142+
]
143+
}
144+
]
145+
}

‎src/CosmosDB/CosmosDB/UX/Microsoft.CosmosDB/databaseAccounts.json

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
{
2+
"resourceType": "databaseAccounts",
3+
"apiVersion": "2022-02-15-preview",
4+
"learnMore": {
5+
"url": "https://learn.microsoft.com/powershell/module/az.cosmosdb/#cosmosdb"
6+
},
7+
"commands": [
8+
{
9+
"name": "Get-AzCosmosDBAccount",
10+
"description": "Get CosmosDB Account.",
11+
"path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{name}",
12+
"confirmation": false,
13+
"help": {
14+
"learnMore": {
15+
"url": "https://learn.microsoft.com/powershell/module/az.cosmosdb/get-azcosmosdbaccount"
16+
},
17+
"parameterSets": [
18+
{
19+
"parameters": [
20+
"[-Name <String>]",
21+
"[-ResourceGroupName <String>]"
22+
]
23+
}
24+
]
25+
},
26+
"examples": [
27+
{
28+
"description": "Get CosmosDB Account.",
29+
"parameters": [
30+
{
31+
"name": "-ResourceGroupName",
32+
"value": "[path.resourceGroupName]"
33+
},
34+
{
35+
"name": "-Name",
36+
"value": "[path.name]"
37+
}
38+
]
39+
}
40+
]
41+
},
42+
{
43+
"name": "Remove-AzCosmosDBAccount",
44+
"description": "Remove a CosmosDB Account.",
45+
"path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{name}",
46+
"confirmation": false,
47+
"help": {
48+
"learnMore": {
49+
"url": "https://learn.microsoft.com/powershell/module/az.cosmosdb/remove-azcosmosdbaccount"
50+
},
51+
"parameterSets": [
52+
{
53+
"parameters": [
54+
"[-Name <String>]",
55+
"[-ResourceGroupName <String>]"
56+
]
57+
}
58+
]
59+
},
60+
"examples": [
61+
{
62+
"description": "Remove a CosmosDB Account.",
63+
"parameters": [
64+
{
65+
"name": "-ResourceGroupName",
66+
"value": "[path.resourceGroupName]"
67+
},
68+
{
69+
"name": "-Name",
70+
"value": "[path.name]"
71+
}
72+
]
73+
}
74+
]
75+
}
76+
]
77+
}

‎src/DataFactory/DataFactories/UX/Microsoft.Datafactory/factories.json

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
{
2+
"resourceType":"factories",
3+
"apiVersion":"2018-06-01",
4+
"learnMore":{
5+
"url":"https://learn.microsoft.com/powershell/module/az.datafactory/#datafactory"
6+
},
7+
"commands":[
8+
{
9+
"name":"Get-AzDataFactoryV2",
10+
"description":"Gets information about Data Factory.",
11+
"path":"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{dataFactoryName}",
12+
"confirmation":false,
13+
"help":{
14+
"learnMore":{
15+
"url":"https://learn.microsoft.com/powershell/module/az.datafactory/get-azdatafactoryv2"
16+
},
17+
"parameterSets":[
18+
{
19+
"parameters":[
20+
"[[-ResourceGroupName] <System.String>]"
21+
]
22+
}
23+
]
24+
},
25+
"examples":[
26+
{
27+
"description":"Gets information about Data Factory.",
28+
"parameters":[
29+
{
30+
"name":"-ResourceGroupName",
31+
"value":"[path.resourceGroupName]"
32+
}
33+
]
34+
}
35+
]
36+
},
37+
{
38+
"name":"Remove-AzDataFactoryV2",
39+
"description":"Removes a data factory.",
40+
"path":"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{dataFactoryName}",
41+
"confirmation":false,
42+
"help":{
43+
"learnMore":{
44+
"url":"https://learn.microsoft.com/powershell/module/az.datafactory/remove-azdatafactoryv2"
45+
},
46+
"parameterSets":[
47+
{
48+
"parameters":[
49+
"[[-ResourceGroupName] <System.String>]"
50+
]
51+
}
52+
]
53+
},
54+
"examples":[
55+
{
56+
"description":"Removes a data factory.",
57+
"parameters":[
58+
{
59+
"name":"-ResourceGroupName",
60+
"value":"[path.resourceGroupName]"
61+
}
62+
]
63+
}
64+
]
65+
}
66+
]
67+
}

0 commit comments

Comments
 (0)