Skip to content

Add edgeZone parameter for image discovery APIs #11302

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

Closed
viananth wants to merge 6 commits into from
Closed

Add edgeZone parameter for image discovery APIs #11302

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
373ec8b
Add edgeZone parameter for image discovery APIs
viananth Oct 20, 2020
c2ea47c
Add new APIs for edgezone pir images
viananth Oct 20, 2020
414f95c
Update op id and desc; edgezone required to true
viananth Oct 20, 2020
74ac8bf
remove extra underscore in op id
viananth Oct 20, 2020
88ea700
Handle lint errors
viananth Oct 20, 2020
53754af
Add extended location to VM image resource
viananth Oct 21, 2020
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
361 changes: 361 additions & 0 deletions specification/compute/resource-manager/Microsoft.Compute/stable/2020-12-01/compute.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2128,6 +2128,335 @@
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/edgeZones/{edgeZone}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus/{skus}/versions/{version}": {
"get": {
"tags": [
"VirtualMachineImages"
],
"operationId": "VirtualMachineImagesEdgeZone_Get",
"description": "Gets a virtual machine image in an edge zone.",
"parameters": [
{
"name": "location",
"in": "path",
"required": true,
"type": "string",
"description": "The name of a supported Azure region."
},
{
"name": "edgeZone",
"in": "path",
"required": true,
"type": "string",
"description": "The name of the edge zone."
},
{
"name": "publisherName",
"in": "path",
"required": true,
"type": "string",
"description": "A valid image publisher."
},
{
"name": "offer",
"in": "path",
"required": true,
"type": "string",
"description": "A valid image publisher offer."
},
{
"name": "skus",
"in": "path",
"required": true,
"type": "string",
"description": "A valid image SKU."
},
{
"name": "version",
"in": "path",
"required": true,
"type": "string",
"description": "A valid image SKU version."
},
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"$ref": "#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/VirtualMachineImage"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/edgeZones/{edgeZone}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus/{skus}/versions": {
"get": {
"tags": [
"VirtualMachineImages"
],
"operationId": "VirtualMachineImagesEdgeZone_List",
"description": "Gets a list of all virtual machine image versions for the specified location, edge zone, publisher, offer, and SKU.",
"parameters": [
{
"name": "location",
"in": "path",
"required": true,
"type": "string",
"description": "The name of a supported Azure region."
},
{
"name": "edgeZone",
"in": "path",
"required": true,
"type": "string",
"description": "The name of the edge zone."
},
{
"name": "publisherName",
"in": "path",
"required": true,
"type": "string",
"description": "A valid image publisher."
},
{
"name": "offer",
"in": "path",
"required": true,
"type": "string",
"description": "A valid image publisher offer."
},
{
"name": "skus",
"in": "path",
"required": true,
"type": "string",
"description": "A valid image SKU."
},
{
"name": "$expand",
"in": "query",
"required": false,
"type": "string",
"description": "The expand expression to apply on the operation."
},
{
"name": "$top",
"in": "query",
"required": false,
"type": "integer",
"format": "int32",
"description": "An integer value specifying the number of images to return that matches supplied values."
},
{
"name": "$orderby",
"in": "query",
"required": false,
"type": "string",
"description": "Specifies the order of the results returned. Formatted as an OData query."
},
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"$ref": "#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/VirtualMachineImageResource"
}
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/edgeZones/{edgeZone}/publishers/{publisherName}/artifacttypes/vmimage/offers": {
"get": {
"tags": [
"VirtualMachineImages"
],
"operationId": "VirtualMachineImagesEdgeZone_ListOffers",
"description": "Gets a list of virtual machine image offers for the specified location, edge zone and publisher.",
"parameters": [
{
"name": "location",
"in": "path",
"required": true,
"type": "string",
"description": "The name of a supported Azure region."
},
{
"name": "edgeZone",
"in": "path",
"required": true,
"type": "string",
"description": "The name of the edge zone."
},
{
"name": "publisherName",
"in": "path",
"required": true,
"type": "string",
"description": "A valid image publisher."
},
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"$ref": "#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/VirtualMachineImageResource"
}
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/edgeZones/{edgeZone}/publishers": {
"get": {
"tags": [
"VirtualMachineImages"
],
"operationId": "VirtualMachineImagesEdgeZone_ListPublishers",
"description": "Gets a list of virtual machine image publishers for the specified Azure location and edge zone.",
"parameters": [
{
"name": "location",
"in": "path",
"required": true,
"type": "string",
"description": "The name of a supported Azure region."
},
{
"name": "edgeZone",
"in": "path",
"required": true,
"type": "string",
"description": "The name of the edge zone."
},
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"$ref": "#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/VirtualMachineImageResource"
}
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/edgeZones/{edgeZone}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus": {
"get": {
"tags": [
"VirtualMachineImages"
],
"operationId": "VirtualMachineImagesEdgeZone_ListSkus",
"description": "Gets a list of virtual machine image SKUs for the specified location, edge zone, publisher, and offer.",
"parameters": [
{
"name": "location",
"in": "path",
"required": true,
"type": "string",
"description": "The name of a supported Azure region."
},
{
"name": "edgeZone",
"in": "path",
"required": true,
"type": "string",
"description": "The name of the edge zone."
},
{
"name": "publisherName",
"in": "path",
"required": true,
"type": "string",
"description": "A valid image publisher."
},
{
"name": "offer",
"in": "path",
"required": true,
"type": "string",
"description": "A valid image publisher offer."
},
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"$ref": "#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/VirtualMachineImageResource"
}
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/usages": {
"get": {
"tags": [
Expand Down Expand Up @@ -7192,6 +7521,10 @@
"type": "string"
},
"description": "Specifies the tags that are assigned to the virtual machine. For more information about using tags, see [Using tags to organize your Azure resources](https://docs.microsoft.com/azure/azure-resource-manager/resource-group-using-tags.md)."
},
"extendedLocation": {
"$ref": "#/definitions/ExtendedLocation",
"description": "The extended location of the Virtual Machine."
}
},
"required": [
Expand Down Expand Up @@ -11401,6 +11734,34 @@
},
"x-ms-azure-resource": true
},
"ExtendedLocationType": {
"type": "string",
"description": "The supported ExtendedLocation types. Currently only EdgeZone is supported in Microsoft.Compute resources.",
"enum": [
"EdgeZone"
],
"x-ms-enum": {
"name": "ExtendedLocationTypes",
"modelAsString": true
}
},
"ExtendedLocation": {
"description": "ExtendedLocation complex type.",
"properties": {
"name": {
"type": "string",
"description": "The name of the extended location."
},
"type": {
"$ref": "#/definitions/ExtendedLocationType",
"description": "The type of the extended location."
}
},
"required": [
"name",
"type"
]
},
"RecoveryWalkResponse": {
"properties": {
"walkPerformed": {
Expand Down