Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Adding restart network virtual appliance swagger changes #27467

Merged
merged 11 commits into from
Feb 1, 2024
+106 −0
Merged

Adding restart network virtual appliance swagger changes #27467

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
74e1687
Adding restart network virtual appliance swagger changes
Jan 20, 2024
9cffcab
Resolving issues - prettier
Jan 20, 2024
c630e07
Fixing the error messages thrown by the PR check
Jan 20, 2024
6be5a19
Fixed the examples references
Jan 21, 2024
a672262
Correcting the nva.json
Jan 22, 2024
c7b6e74
prettier
Jan 22, 2024
d302919
prettier 2
Jan 22, 2024
ab02ecd
Editing schema
Jan 22, 2024
14e0431
adding lint changes
Jan 22, 2024
eac9d7f
replying to comment on PR
Jan 30, 2024
c1c1962
Adding description
Jan 30, 2024
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
15 changes: 15 additions & 0 deletions ...ger/Microsoft.Network/stable/2023-11-01/examples/NetworkVirtualApplianceEmptyRestart.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"parameters": {
"api-version": "2023-11-01",
"subscriptionId": "subid",
"resourceGroupName": "rg1",
"networkVirtualApplianceName": "nva"
},
"responses": {
"200": {
"headers": {
"location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/westus/nfvOperations/00000000-0000-0000-0000-000000000000?api-version=2023-11-01"
}
}
}
}
19 changes: 19 additions & 0 deletions .../Microsoft.Network/stable/2023-11-01/examples/NetworkVirtualApplianceSpecificRestart.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"parameters": {
"api-version": "2023-11-01",
"subscriptionId": "subid",
"resourceGroupName": "rg1",
"networkVirtualApplianceName": "nva",
"instanceIds": [
"0",
"1"
]
},
"responses": {
"200": {
"headers": {
"location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/westus/nfvOperations/00000000-0000-0000-0000-000000000000?api-version=2023-11-01"
}
}
}
}
73 changes: 73 additions & 0 deletions ...network/resource-manager/Microsoft.Network/stable/2023-11-01/networkVirtualAppliance.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -285,6 +285,67 @@
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances/{networkVirtualApplianceName}/restart": {
arsheen marked this conversation as resolved.
Show resolved Hide resolved
"post": {
"tags": [
"NetworkVirtualAppliances"
],
"operationId": "NetworkVirtualAppliances_Restart",
"description": "Restarts one or more VMs belonging to the specified Network Virtual Appliance.",
"parameters": [
{
"name": "resourceGroupName",
"in": "path",
"required": true,
"type": "string",
"description": "The name of the resource group."
},
{
"name": "networkVirtualApplianceName",
"in": "path",
"required": true,
"type": "string",
"description": "The name of Network Virtual Appliance."
arsheen marked this conversation as resolved.
Show resolved Hide resolved
},
{
"$ref": "./network.json#/parameters/ApiVersionParameter"
},
{
"$ref": "./network.json#/parameters/SubscriptionIdParameter"
},
{
"name": "NetworkVirtualApplianceInstanceIds",
Copy link
Contributor

@visingla-ms visingla-ms Jan 30, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Parameter should have a description.

Copy link
Contributor Author

@arsheen arsheen Jan 30, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've added the description in the schema. Do I need to add it here as well?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added description here as well

"in": "body",
"required": false,
"schema": {
"$ref": "#/definitions/NetworkVirtualApplianceInstanceIds"
}
}
],
"responses": {
"200": {
"description": "Request successful. The operation restarts one or more Network Virtual Appliance VM resources.",
"schema": {
"$ref": "#/definitions/NetworkVirtualApplianceInstanceIds"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "./network.json#/definitions/CloudError"
}
}
},
"x-ms-examples": {
"Restart All NetworkVirtualAppliance VMs in VM Scale Set": {
"$ref": "./examples/NetworkVirtualApplianceEmptyRestart.json"
},
"Restart Specific NetworkVirtualAppliance VMs in VM Scale Set": {
"$ref": "./examples/NetworkVirtualApplianceSpecificRestart.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances": {
"get": {
"tags": [
Expand Down Expand Up @@ -1325,6 +1386,18 @@
}
},
"description": "Properties of the partner managed resource."
},
"NetworkVirtualApplianceInstanceIds": {
"type": "object",
"properties": {
"instanceIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "The network virtual appliance instance ids. Omitting the network virtual appliance instance ids will result in the operation being performed on all virtual machines belonging to the network virtual appliance."
}
}
}
}
}