From 5f3be89e0f6502b1886b67e835282d405481cac9 Mon Sep 17 00:00:00 2001 From: Cigdem Celik Aydin Date: Wed, 26 Jun 2019 17:10:04 -0700 Subject: [PATCH 01/22] Update compute.json --- .../stable/2019-03-01/compute.json | 265 ++++++++++++++++++ 1 file changed, 265 insertions(+) diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json index f3d83ab1d77d..c871bbf75ce7 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json @@ -4928,6 +4928,267 @@ ], "description": "The List Proximity Placement Group operation response." }, + "DedicatedHostGroupProperties": { + "properties": { + "platformFaultDomainCount": { + "type": "integer", + "format": "int32", + "description": "Number of fault domains that the host group can span. Supported values 1,2,3." + }, + "hosts": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResourceReadOnly" + }, + "readOnly": true, + "description": "A list of references to all dedicated hosts in the dedicated host group." + } + }, + "description": "Dedicated Host Group Properties." + }, + "DedicatedHostGroup": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DedicatedHostGroupProperties" + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Availability Zone to use for this host group – only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforce each host in the group is in the same zone." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Specifies information about the dedicated host group that the dedicated hosts should be assigned to.

Currently, a Dedicated host can only be added to Dedicated Host Group at creation time. An existing Dedicated Host cannot be added to a dedicated host group." + }, + "DedicatedHostGroupUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DedicatedHostGroupProperties" + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Availability Zone to use for this host group – only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforce each host in the group is in the same zone." + } + }, + "allOf": [ + { + "$ref": "#/definitions/UpdateResource" + } + ], + "description": "Specifies information about the dedicated host group that the dedicated host should be assigned to. Only tags may be updated." + }, + "DedicatedHostGroupListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DedicatedHostGroup" + }, + "description": "The list of dedicated host groups" + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of Dedicated Host Groups. Call ListNext() with this URI to fetch the next page of Dedicated Host Groups." + } + }, + "required": [ + "value" + ], + "description": "The List Dedicated Host Group with resource group response." + }, + "DedicatedHostLicenseType": { + "type": "string", + "description": "Specifies the software license type that will be applied to the VMs deployed on the dedicated host.

Possible values are:

**None**

**Windows_Server_Hybrid**

**Windows_Server_Perpetual**

Default: **None**", + "enum": [ + "None", + "Windows_Server_Hybrid", + "Windows_Server_Perpetual" + ], + "x-ms-enum": { + "name": "DedicatedHostLicenseTypes", + "modelAsString": false + } + }, + "DedicatedHostCapacity": { + "properties": { + "totalCores": { + "type": "number", + "format": "double", + "description": "The total number of cores." + }, + "totalVCpus": { + "type": "number", + "format": "double", + "description": "The total number of CPUs." + } + }, + "description": "Dedicated host total capacity." + }, + "DedicatedHostAllocatableVM": { + "properties": { + "vmSize": { + "type": "string", + "description": "VM size in terms of which the unutilized capacity is represented." + }, + "count": { + "type": "number", + "format": "long", + "description": "Maximum number of VMs of size vmSize that can fit in the dedicated host's remaining capacity." + } + }, + "description": "Represents the dedicated host unutilized capacity in terms of a specific VM size." + }, + "DedicatedHostAvailableCapacity": { + "properties": { + "availableVCpus": { + "type": "number", + "format": "double", + "description": "The total number of CPUs." + }, + "allocatableVMs": { + "type": "array", + "items": { + "$ref": "#/definitions/DedicatedHostAllocatableVM" + }, + "description": "The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host." + } + }, + "description": "Dedicated host unutilized capacity." + }, + "DedicatedHostInstanceView": { + "properties": { + "assetId": { + "readOnly": true, + "type": "string", + "description": "Specifies the unique of the dedicated physical machine on which the dedicated host resides." + }, + "capacity": { + "$ref": "#/definitions/DedicatedHostCapacity", + "description": "The total capacity of the dedicated host." + }, + "availableCapacity": { + "$ref": "#/definitions/DedicatedHostAvailableCapacity", + "description": "Unutilized capacity of the dedicated host." + }, + "statuses": { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "The resource status information." + } + }, + "description": "The instance view of a dedicated host." + }, + "DedicatedHostProperties": { + "properties": { + "platformFaultDomain": { + "type": "integer", + "format": "int32", + "description": "Fault domain of the host within a group. Supported values 0,1,2." + }, + "autoReplaceOnFailure": { + "type": "boolean", + "description": "Whether the host should be replaced automatically in case of a failure. The value is defaulted to true when not provided." + }, + "hostId": { + "readOnly": true, + "type": "string", + "description": "A unique id generated and assigned to the dedicated host by the platform." + }, + "virtualMachines": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResourceReadOnly" + }, + "readOnly": true, + "description": "A list of references to all virtual machines in the Dedicated Host." + }, + "licenseType": { + "$ref": "#/definitions/DedicatedHostLicenseType", + "description": "Specifies the software license type that will be applied to the VMs deployed on the dedicated host.

Possible values are:

**None**

**Windows_Server_Hybrid**

**Windows_Server_Perpetual**

Default: **None**" + }, + "provisioningTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The date when the host was first created." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + }, + "instanceView": { + "$ref": "#/definitions/DedicatedHostInstanceView", + "readOnly": true, + "description": "The dedicated host instance view." + }, + }, + "description": "Properties of the dedicated host." + }, + "DedicatedHost": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DedicatedHostProperties" + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "Sku of the dedicated host for Hardware Generation and VM family, The only name is required to be set. See DedicatedHostSkuTypes for possible set of values." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Specifies information about the Dedicated host." + }, + "DedicatedHostUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DedicatedHostProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/UpdateResource" + } + ], + "description": "Specifies information about the dedicated host. Only tags, autoReplaceOnFailure and licenseType may be updated." + }, + "DedicatedHostListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DedicatedHost" + }, + "description": "The list of dedicated hosts" + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of Dedicated hosts. Call ListNext() with this URI to fetch the next page of Dedicated hosts." + } + }, + "required": [ + "value" + ], + "description": "The List Dedicated Host operation response." + }, "VirtualMachineSize": { "properties": { "name": { @@ -6496,6 +6757,10 @@ "$ref": "#/definitions/SubResource", "description": "Specifies information about the proximity placement group that the virtual machine should be assigned to.

Minimum api-version: 2018-04-01." }, + "host": { + "$ref": "#/definitions/SubResource", + "description": "Specifies information about the dedicated host that the virtual machine resides in.

Minimum api-version: 2018-10-01." + }, "provisioningState": { "readOnly": true, "type": "string", From 023aaf96d902b55536505f1d51e06310dca17f4f Mon Sep 17 00:00:00 2001 From: Cigdem Celik Aydin Date: Wed, 26 Jun 2019 18:15:37 -0700 Subject: [PATCH 02/22] Added DedicatedHostGroup and DedicateHost operations --- .../stable/2019-03-01/compute.json | 521 ++++++++++++++++++ .../examples/CreateADedicatedHost.json | 40 ++ .../examples/CreateADedicatedHostGroup.json | 33 ++ .../examples/GetADedicatedHost.json | 68 +++ .../examples/GetADedicatedHostGroup.json | 32 ++ 5 files changed, 694 insertions(+) create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateADedicatedHost.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateADedicatedHostGroup.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/GetADedicatedHost.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/GetADedicatedHostGroup.json diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json index c871bbf75ce7..a86c15d60171 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json @@ -601,6 +601,527 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}": { + "put": { + "tags": [ + "DedicatedHostGroups" + ], + "operationId": "DedicatedHostGroups_CreateOrUpdate", + "description": "Create or update a dedicated host group. For details of Dedicated Host and Dedicated Host Groups please see [Dedicated Host Documentation] (https://go.microsoft.com/fwlink/?linkid=2082596)", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host group." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DedicatedHostGroup" + }, + "description": "Parameters supplied to the Create Dedicated Host Group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHostGroup" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/DedicatedHostGroup" + } + } + }, + "x-ms-examples": { + "Create a dedicated host group.": { + "$ref": "./examples/CreateADedicatedHostGroup.json" + } + } + }, + "patch": { + "tags": [ + "DedicatedHostGroups" + ], + "operationId": "DedicatedHostGroups_Update", + "description": "Update an dedicated host group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host group." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DedicatedHostGroupUpdate" + }, + "description": "Parameters supplied to the Update Dedicated Host Group operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHostGroup" + } + } + } + }, + "delete": { + "tags": [ + "DedicatedHostGroups" + ], + "operationId": "DedicatedHostGroups_Delete", + "description": "Delete a dedicated host group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + } + } + }, + "get": { + "tags": [ + "DedicatedHostGroups" + ], + "operationId": "DedicatedHostGroups_Get", + "description": "Retrieves information about a dedicated host group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHostGroup" + } + } + }, + "x-ms-examples": { + "Create a dedicated host group.": { + "$ref": "./examples/GetADedicatedHostGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups": { + "get": { + "tags": [ + "DedicatedHostGroups" + ], + "operationId": "DedicatedHostGroups_ListByResourceGroup", + "description": "Lists all of the dedicated host groups in the specified resource group. Use the nextLink property in the response to get the next page of dedicated host groups.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHostGroupListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/hostGroups": { + "get": { + "tags": [ + "DedicatedHostGroups" + ], + "operationId": "DedicatedHostGroups_ListBySubscription", + "description": "Lists all of the dedicated host groups in the subscription. Use the nextLink property in the response to get the next page of dedicated host groups.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHostGroupListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}/hosts/{hostName}": { + "put": { + "tags": [ + "DedicatedHosts" + ], + "operationId": "DedicatedHosts_CreateOrUpdate", + "description": "Create or update a dedicated host .", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host group." + }, + { + "name": "hostName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host ." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DedicatedHost" + }, + "description": "Parameters supplied to the Create Dedicated Host ." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHost" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/DedicatedHost" + } + } + }, + "x-ms-examples": { + "Create a dedicated host .": { + "$ref": "./examples/CreateADedicatedHost.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "DedicatedHosts" + ], + "operationId": "DedicatedHosts_Update", + "description": "Update an dedicated host .", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host group." + }, + { + "name": "hostName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host ." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DedicatedHostUpdate" + }, + "description": "Parameters supplied to the Update Dedicated Host operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHost" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "DedicatedHosts" + ], + "operationId": "DedicatedHosts_Delete", + "description": "Delete a dedicated host.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host group." + }, + { + "name": "hostName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "DedicatedHosts" + ], + "operationId": "DedicatedHosts_Get", + "description": "Retrieves information about a dedicated host.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host group." + }, + { + "name": "hostName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation.", + "enum": [ + "instanceView" + ], + "x-ms-enum": { + "name": "InstanceViewTypes", + "modelAsString": false + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHost" + } + } + }, + "x-ms-examples": { + "Get a dedicated host.": { + "$ref": "./examples/GetADedicatedHost.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}/hosts": { + "get": { + "tags": [ + "DedicatedHost" + ], + "operationId": "DedicatedHosts_ListByHostGroup", + "description": "Lists all of the dedicated hosts in the specified dedicated host group. Use the nextLink property in the response to get the next page of dedicated hosts.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHostListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmextension/types/{type}/versions/{version}": { "get": { "tags": [ diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateADedicatedHost.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateADedicatedHost.json new file mode 100644 index 000000000000..d83049df537e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateADedicatedHost.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-10-01", + "hostGroupName": "myDedicatedHostGroup", + "hostName": "myDedicatedHost", + "sku": { + "name": "DSv3-Type1" + }, + "parameters": { + "location": "westus", + "tags": { + "department": "HR" + } + } + }, + "responses": { + "201": { + "body": { + "name": "myDedicatedHost", + "location": "westus", + "type": "Microsoft.Compute/HostGroups/Hosts", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup/hosts/myDedicatedHost", + "hostGroup": { "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup"}, + "tags": { + "department": "HR" + }, + "sku": { + "name": "DSv3-Type1" + }, + "properties": { + "platformFaultDomain": 1, + "autoReplaceOnFailure": true, + "hostId": "{GUID}", + } + } + } + } +} \ No newline at end of file diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateADedicatedHostGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateADedicatedHostGroup.json new file mode 100644 index 000000000000..b47ddd0b4862 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateADedicatedHostGroup.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-10-01", + "hostGroupName": "myDedicatedHostGroup", + "parameters": { + "location": "westus", + "zones": [ "1" ], + "tags": { + "department": "finance" + } + } + }, + "responses": { + "200": { + "body": { + "name": "myDedicatedHostGroup", + "location": "westus", + "type": "Microsoft.Compute/HostGroups", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup", + "tags": { + "department": "finance" + }, + "zones": [ "1" ], + "properties": { + "platformFaultDomainCount": 3, + "hosts": [ ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/GetADedicatedHost.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/GetADedicatedHost.json new file mode 100644 index 000000000000..8f1f85e6e0b0 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/GetADedicatedHost.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-10-01", + "HostGroupName": "myDedicatedHostGroup", + "HostName": "myHost" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "platformFaultDomain": 1, + "autoReplaceOnFailure": true, + "hostId": "{GUID}", + "hostGroup": { "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup"}, + "provisioningTime": "2019-06-27T01:02:38.3138469+00:00", + "virtualMachines": [ + { "id": "/subscriptions/subId/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/vm1" } + ], + "provisioningState": "Succeeded", + "instanceView": { + "assetId": "eb3f58b8-b4e8-4882-b69f-301a01812407", + "capacity": { + "totalCores": 30.0, + "totalVCpus": 60.0 + }, + "availableCapacity": { + "availableVCpus": 40.0, + "allocatableVMs": [ + { + "vmSize": "Standard_A1", + "count": 10 + } + ] + }, + "statuses": [ + { + "code": "ProvisioningState/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded" + }, + { + "code": "HealthState/available", + "level": "Info", + "displayStatus": "Host available" + } + ] + } + }, + }, + "type": "Microsoft.Compute/Host", + "location": "westus", + "tags": { + "department": "HR" + }, + "sku": { + "name": "DSv3-Type1" + }, + "name": "myHost" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/GetADedicatedHostGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/GetADedicatedHostGroup.json new file mode 100644 index 000000000000..8e0a13d9aaeb --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/GetADedicatedHostGroup.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-10-01", + "availabilitySetName": "myDedicatedHostGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "platformFaultDomainCount": 3, + "hosts": [ + { "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/myDedicatedHostGroup/myHostGroup/Hosts/myHost1" }, + { "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/myDedicatedHostGroup/myHostGroup/Hosts/myHost2" } + ] + }, + "type": "Microsoft.Compute/HostGroups", + "location": "westus", + "tags": { + "{tagName}": "{tagValue}" + }, + "zones": [ "3" ], + "name": "myDedicatedHostGroup" + } + ] + } + } + } +} \ No newline at end of file From c8a2ec7b1a899e78d138b5be5248f78f459e34c8 Mon Sep 17 00:00:00 2001 From: Cigdem Celik Aydin Date: Thu, 27 Jun 2019 12:27:23 -0700 Subject: [PATCH 03/22] Fixed dedicated host and group examples --- .../examples/CreateADedicatedHost.json | 27 +++--- .../examples/CreateADedicatedHostGroup.json | 22 +++-- .../examples/GetADedicatedHost.json | 93 +++++++++---------- .../examples/GetADedicatedHostGroup.json | 19 ++-- 4 files changed, 86 insertions(+), 75 deletions(-) diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateADedicatedHost.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateADedicatedHost.json index d83049df537e..83e1c7fb6914 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateADedicatedHost.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateADedicatedHost.json @@ -3,37 +3,38 @@ "subscriptionId": "{subscription-id}", "resourceGroupName": "myResourceGroup", "api-version": "2018-10-01", - "hostGroupName": "myDedicatedHostGroup", - "hostName": "myDedicatedHost", - "sku": { - "name": "DSv3-Type1" - }, "parameters": { "location": "westus", "tags": { "department": "HR" + }, + "properties": { + "platformFaultDomain": "1" + }, + "sku": { + "name": "DSv3-Type1" } - } + }, + "hostGroupName": "myDedicatedHostGroup", + "hostName": "myDedicatedHost" }, "responses": { "201": { "body": { "name": "myDedicatedHost", "location": "westus", - "type": "Microsoft.Compute/HostGroups/Hosts", "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup/hosts/myDedicatedHost", - "hostGroup": { "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup"}, "tags": { "department": "HR" }, "sku": { "name": "DSv3-Type1" }, - "properties": { - "platformFaultDomain": 1, - "autoReplaceOnFailure": true, - "hostId": "{GUID}", - } + "properties": { + "platformFaultDomain": 1, + "autoReplaceOnFailure": true, + "hostId": "{GUID}" + } } } } diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateADedicatedHostGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateADedicatedHostGroup.json index b47ddd0b4862..0de25b43ddf0 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateADedicatedHostGroup.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateADedicatedHostGroup.json @@ -3,12 +3,17 @@ "subscriptionId": "{subscription-id}", "resourceGroupName": "myResourceGroup", "api-version": "2018-10-01", - "hostGroupName": "myDedicatedHostGroup", + "resourceName": "myDedicatedHostGroup", "parameters": { "location": "westus", - "zones": [ "1" ], "tags": { "department": "finance" + }, + "zones": [ + "1" + ], + "properties": { + "platformFaultDomainCount": "3" } } }, @@ -17,16 +22,17 @@ "body": { "name": "myDedicatedHostGroup", "location": "westus", - "type": "Microsoft.Compute/HostGroups", "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup", "tags": { "department": "finance" }, - "zones": [ "1" ], - "properties": { - "platformFaultDomainCount": 3, - "hosts": [ ] - } + "zones": [ + "1" + ], + "properties": { + "platformFaultDomainCount": 3, + "hosts": [] + } } } } diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/GetADedicatedHost.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/GetADedicatedHost.json index 8f1f85e6e0b0..c82fcd1dc1db 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/GetADedicatedHost.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/GetADedicatedHost.json @@ -3,8 +3,8 @@ "subscriptionId": "{subscriptionId}", "resourceGroupName": "myResourceGroup", "api-version": "2018-10-01", - "HostGroupName": "myDedicatedHostGroup", - "HostName": "myHost" + "hostGroupName": "myDedicatedHostGroup", + "hostName": "myHost" }, "responses": { "200": { @@ -12,53 +12,52 @@ "value": [ { "properties": { - "platformFaultDomain": 1, - "autoReplaceOnFailure": true, - "hostId": "{GUID}", - "hostGroup": { "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup"}, - "provisioningTime": "2019-06-27T01:02:38.3138469+00:00", - "virtualMachines": [ - { "id": "/subscriptions/subId/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/vm1" } - ], - "provisioningState": "Succeeded", - "instanceView": { - "assetId": "eb3f58b8-b4e8-4882-b69f-301a01812407", - "capacity": { - "totalCores": 30.0, - "totalVCpus": 60.0 - }, - "availableCapacity": { - "availableVCpus": 40.0, - "allocatableVMs": [ - { - "vmSize": "Standard_A1", - "count": 10 - } - ] - }, - "statuses": [ - { - "code": "ProvisioningState/succeeded", - "level": "Info", - "displayStatus": "Provisioning succeeded" - }, - { - "code": "HealthState/available", - "level": "Info", - "displayStatus": "Host available" - } - ] - } - }, + "platformFaultDomain": 1, + "autoReplaceOnFailure": true, + "hostId": "{GUID}", + "provisioningTime": "2019-06-27T01:02:38.3138469+00:00", + "virtualMachines": [ + { + "id": "/subscriptions/subId/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/vm1" + } + ], + "provisioningState": "Succeeded", + "instanceView": { + "assetId": "eb3f58b8-b4e8-4882-b69f-301a01812407", + "capacity": { + "totalCores": 30, + "totalVCpus": 60 + }, + "availableCapacity": { + "availableVCpus": 40, + "allocatableVMs": [ + { + "vmSize": "Standard_A1", + "count": 10 + } + ] + }, + "statuses": [ + { + "code": "ProvisioningState/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded" + }, + { + "code": "HealthState/available", + "level": "Info", + "displayStatus": "Host available" + } + ] + } }, - "type": "Microsoft.Compute/Host", "location": "westus", - "tags": { - "department": "HR" - }, - "sku": { - "name": "DSv3-Type1" - }, + "tags": { + "department": "HR" + }, + "sku": { + "name": "DSv3-Type1" + }, "name": "myHost" } ] diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/GetADedicatedHostGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/GetADedicatedHostGroup.json index 8e0a13d9aaeb..4850dfdcdb45 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/GetADedicatedHostGroup.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/GetADedicatedHostGroup.json @@ -3,7 +3,7 @@ "subscriptionId": "{subscriptionId}", "resourceGroupName": "myResourceGroup", "api-version": "2018-10-01", - "availabilitySetName": "myDedicatedHostGroup" + "resourceName": "myDedicatedHostGroup" }, "responses": { "200": { @@ -11,19 +11,24 @@ "value": [ { "properties": { - "platformFaultDomainCount": 3, + "platformFaultDomainCount": 3, "hosts": [ - { "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/myDedicatedHostGroup/myHostGroup/Hosts/myHost1" }, - { "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/myDedicatedHostGroup/myHostGroup/Hosts/myHost2" } + { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/myDedicatedHostGroup/myHostGroup/Hosts/myHost1" + }, + { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/myDedicatedHostGroup/myHostGroup/Hosts/myHost2" + } ] }, - "type": "Microsoft.Compute/HostGroups", "location": "westus", "tags": { "{tagName}": "{tagValue}" }, - "zones": [ "3" ], - "name": "myDedicatedHostGroup" + "name": "myDedicatedHostGroup", + "zones": [ + "3" + ] } ] } From beed92f79dacff0ce3d1a65d3ecf42449d17a47c Mon Sep 17 00:00:00 2001 From: Cigdem Celik Aydin Date: Thu, 27 Jun 2019 12:53:58 -0700 Subject: [PATCH 04/22] Removed extra comma --- .../Microsoft.Compute/stable/2019-03-01/compute.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json index a86c15d60171..4dff6e406b03 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json @@ -5655,7 +5655,7 @@ "$ref": "#/definitions/DedicatedHostInstanceView", "readOnly": true, "description": "The dedicated host instance view." - }, + } }, "description": "Properties of the dedicated host." }, From 1eecea9969fdd4719c299ae6cbd71ea3ac9373d8 Mon Sep 17 00:00:00 2001 From: Cigdem Celik Aydin Date: Thu, 27 Jun 2019 13:25:27 -0700 Subject: [PATCH 05/22] Fixed model validation errors --- .../stable/2019-03-01/compute.json | 2 +- .../examples/GetADedicatedHost.json | 92 +++++++++---------- .../examples/GetADedicatedHostGroup.json | 38 ++++---- 3 files changed, 62 insertions(+), 70 deletions(-) diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json index 4dff6e406b03..d9c3293a9362 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json @@ -5564,7 +5564,7 @@ }, "count": { "type": "number", - "format": "long", + "format": "double", "description": "Maximum number of VMs of size vmSize that can fit in the dedicated host's remaining capacity." } }, diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/GetADedicatedHost.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/GetADedicatedHost.json index c82fcd1dc1db..6e6a00575b1b 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/GetADedicatedHost.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/GetADedicatedHost.json @@ -9,58 +9,54 @@ "responses": { "200": { "body": { - "value": [ - { - "properties": { - "platformFaultDomain": 1, - "autoReplaceOnFailure": true, - "hostId": "{GUID}", - "provisioningTime": "2019-06-27T01:02:38.3138469+00:00", - "virtualMachines": [ + "properties": { + "platformFaultDomain": 1, + "autoReplaceOnFailure": true, + "hostId": "{GUID}", + "provisioningTime": "2019-06-27T01:02:38.3138469+00:00", + "virtualMachines": [ + { + "id": "/subscriptions/subId/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/vm1" + } + ], + "provisioningState": "Succeeded", + "instanceView": { + "assetId": "eb3f58b8-b4e8-4882-b69f-301a01812407", + "capacity": { + "totalCores": 30, + "totalVCpus": 60 + }, + "availableCapacity": { + "availableVCpus": 40, + "allocatableVMs": [ { - "id": "/subscriptions/subId/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/vm1" + "vmSize": "Standard_A1", + "count": 10 } - ], - "provisioningState": "Succeeded", - "instanceView": { - "assetId": "eb3f58b8-b4e8-4882-b69f-301a01812407", - "capacity": { - "totalCores": 30, - "totalVCpus": 60 - }, - "availableCapacity": { - "availableVCpus": 40, - "allocatableVMs": [ - { - "vmSize": "Standard_A1", - "count": 10 - } - ] - }, - "statuses": [ - { - "code": "ProvisioningState/succeeded", - "level": "Info", - "displayStatus": "Provisioning succeeded" - }, - { - "code": "HealthState/available", - "level": "Info", - "displayStatus": "Host available" - } - ] - } - }, - "location": "westus", - "tags": { - "department": "HR" + ] }, - "sku": { - "name": "DSv3-Type1" - }, - "name": "myHost" + "statuses": [ + { + "code": "ProvisioningState/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded" + }, + { + "code": "HealthState/available", + "level": "Info", + "displayStatus": "Host available" + } + ] } - ] + }, + "location": "westus", + "tags": { + "department": "HR" + }, + "sku": { + "name": "DSv3-Type1" + }, + "name": "myHost" } } } diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/GetADedicatedHostGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/GetADedicatedHostGroup.json index 4850dfdcdb45..21d29a047ccf 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/GetADedicatedHostGroup.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/GetADedicatedHostGroup.json @@ -8,28 +8,24 @@ "responses": { "200": { "body": { - "value": [ - { - "properties": { - "platformFaultDomainCount": 3, - "hosts": [ - { - "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/myDedicatedHostGroup/myHostGroup/Hosts/myHost1" - }, - { - "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/myDedicatedHostGroup/myHostGroup/Hosts/myHost2" - } - ] + "properties": { + "platformFaultDomainCount": 3, + "hosts": [ + { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/myDedicatedHostGroup/myHostGroup/Hosts/myHost1" }, - "location": "westus", - "tags": { - "{tagName}": "{tagValue}" - }, - "name": "myDedicatedHostGroup", - "zones": [ - "3" - ] - } + { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/myDedicatedHostGroup/myHostGroup/Hosts/myHost2" + } + ] + }, + "location": "westus", + "tags": { + "{tagName}": "{tagValue}" + }, + "name": "myDedicatedHostGroup", + "zones": [ + "3" ] } } From ec9b8a58e619e5c39a5f0b09e9eac0618b7adc11 Mon Sep 17 00:00:00 2001 From: Cigdem Celik Aydin Date: Thu, 27 Jun 2019 14:45:39 -0700 Subject: [PATCH 06/22] Added more examples --- .../stable/2019-03-01/compute.json | 6 +++ .../examples/CreateADedicatedHostGroup.json | 2 +- .../examples/UpdateADedicatedHost.json | 37 +++++++++++++++++++ .../examples/UpdateADedicatedHostGroup.json | 35 ++++++++++++++++++ 4 files changed, 79 insertions(+), 1 deletion(-) create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/UpdateADedicatedHost.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/UpdateADedicatedHostGroup.json diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json index d9c3293a9362..1f60cc204b28 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json @@ -656,6 +656,9 @@ "x-ms-examples": { "Create a dedicated host group.": { "$ref": "./examples/CreateADedicatedHostGroup.json" + }, + "Update a dedicated host group.": { + "$ref": "./examples/UpdateADedicatedHostGroup.json" } } }, @@ -910,6 +913,9 @@ "x-ms-examples": { "Create a dedicated host .": { "$ref": "./examples/CreateADedicatedHost.json" + }, + "Update a dedicated host .": { + "$ref": "./examples/UpdateADedicatedHost.json" } }, "x-ms-long-running-operation": true diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateADedicatedHostGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateADedicatedHostGroup.json index 0de25b43ddf0..270d73963c70 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateADedicatedHostGroup.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateADedicatedHostGroup.json @@ -18,7 +18,7 @@ } }, "responses": { - "200": { + "201": { "body": { "name": "myDedicatedHostGroup", "location": "westus", diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/UpdateADedicatedHost.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/UpdateADedicatedHost.json new file mode 100644 index 000000000000..840f8562abb3 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/UpdateADedicatedHost.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-10-01", + "parameters": { + "location": "westus", + "properties": { + "autoReplaceOnFailure": false, + "licenseType": "Windows_Server_Hybrid" + } + }, + "hostGroupName": "myDedicatedHostGroup", + "hostName": "myDedicatedHost" + }, + "responses": { + "200": { + "body": { + "properties": { + "platformFaultDomain": 1, + "autoReplaceOnFailure": false, + "licenseType": "Windows_Server_Hybrid", + "hostId": "{GUID}" + }, + "location": "westus", + "tags": { + "department": "HR" + }, + "name": "myDedicatedHost", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup/hosts/myDedicatedHost", + "sku": { + "name": "DSv3-Type1" + } + } + } + } +} \ No newline at end of file diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/UpdateADedicatedHostGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/UpdateADedicatedHostGroup.json new file mode 100644 index 000000000000..c48246ef47fa --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/UpdateADedicatedHostGroup.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-10-01", + "parameters": { + "location": "westus", + "tags": { + "department": "finance", + "owner": "myCompany" + } + }, + "resourceName": "myDedicatedHostGroup" + }, + "responses": { + "200": { + "body": { + "properties": { + "platformFaultDomainCount": 3, + "hosts": [] + }, + "location": "westus", + "tags": { + "department": "finance", + "owner": "myCompany" + }, + "name": "myDedicatedHostGroup", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup", + "zones": [ + "1" + ] + } + } + } +} \ No newline at end of file From 5a6113940b28526305e24b2cb70ce70670c3b188 Mon Sep 17 00:00:00 2001 From: Cigdem Celik Aydin Date: Thu, 27 Jun 2019 15:03:12 -0700 Subject: [PATCH 07/22] Modified examples --- .../stable/2019-03-01/compute.json | 14 ++----- ...json => CreateOrUpdateADedicatedHost.json} | 19 ++++++++++ ...=> CreateOrUpdateADedicatedHostGroup.json} | 18 +++++++++ .../examples/UpdateADedicatedHost.json | 37 ------------------- .../examples/UpdateADedicatedHostGroup.json | 35 ------------------ 5 files changed, 41 insertions(+), 82 deletions(-) rename specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/{CreateADedicatedHost.json => CreateOrUpdateADedicatedHost.json} (63%) rename specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/{CreateADedicatedHostGroup.json => CreateOrUpdateADedicatedHostGroup.json} (64%) delete mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/UpdateADedicatedHost.json delete mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/UpdateADedicatedHostGroup.json diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json index 1f60cc204b28..72341fb57ffa 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json @@ -654,11 +654,8 @@ } }, "x-ms-examples": { - "Create a dedicated host group.": { - "$ref": "./examples/CreateADedicatedHostGroup.json" - }, - "Update a dedicated host group.": { - "$ref": "./examples/UpdateADedicatedHostGroup.json" + "Create or update a dedicated host group.": { + "$ref": "./examples/CreateOrUpdateADedicatedHostGroup.json" } } }, @@ -911,11 +908,8 @@ } }, "x-ms-examples": { - "Create a dedicated host .": { - "$ref": "./examples/CreateADedicatedHost.json" - }, - "Update a dedicated host .": { - "$ref": "./examples/UpdateADedicatedHost.json" + "Create or update a dedicated host .": { + "$ref": "./examples/CreateOrUpdateADedicatedHost.json" } }, "x-ms-long-running-operation": true diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateADedicatedHost.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateOrUpdateADedicatedHost.json similarity index 63% rename from specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateADedicatedHost.json rename to specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateOrUpdateADedicatedHost.json index 83e1c7fb6914..4298c4bff125 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateADedicatedHost.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateOrUpdateADedicatedHost.json @@ -36,6 +36,25 @@ "hostId": "{GUID}" } } + }, + "200": { + "body": { + "properties": { + "platformFaultDomain": 1, + "autoReplaceOnFailure": false, + "licenseType": "Windows_Server_Hybrid", + "hostId": "{GUID}" + }, + "location": "westus", + "tags": { + "department": "HR" + }, + "name": "myDedicatedHost", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup/hosts/myDedicatedHost", + "sku": { + "name": "DSv3-Type1" + } + } } } } \ No newline at end of file diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateADedicatedHostGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateOrUpdateADedicatedHostGroup.json similarity index 64% rename from specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateADedicatedHostGroup.json rename to specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateOrUpdateADedicatedHostGroup.json index 270d73963c70..192053bcaa11 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateADedicatedHostGroup.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateOrUpdateADedicatedHostGroup.json @@ -34,6 +34,24 @@ "hosts": [] } } + }, + "200": { + "body": { + "properties": { + "platformFaultDomainCount": 3, + "hosts": [] + }, + "location": "westus", + "tags": { + "department": "finance", + "owner": "myCompany" + }, + "name": "myDedicatedHostGroup", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup", + "zones": [ + "1" + ] + } } } } \ No newline at end of file diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/UpdateADedicatedHost.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/UpdateADedicatedHost.json deleted file mode 100644 index 840f8562abb3..000000000000 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/UpdateADedicatedHost.json +++ /dev/null @@ -1,37 +0,0 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "api-version": "2018-10-01", - "parameters": { - "location": "westus", - "properties": { - "autoReplaceOnFailure": false, - "licenseType": "Windows_Server_Hybrid" - } - }, - "hostGroupName": "myDedicatedHostGroup", - "hostName": "myDedicatedHost" - }, - "responses": { - "200": { - "body": { - "properties": { - "platformFaultDomain": 1, - "autoReplaceOnFailure": false, - "licenseType": "Windows_Server_Hybrid", - "hostId": "{GUID}" - }, - "location": "westus", - "tags": { - "department": "HR" - }, - "name": "myDedicatedHost", - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup/hosts/myDedicatedHost", - "sku": { - "name": "DSv3-Type1" - } - } - } - } -} \ No newline at end of file diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/UpdateADedicatedHostGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/UpdateADedicatedHostGroup.json deleted file mode 100644 index c48246ef47fa..000000000000 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/UpdateADedicatedHostGroup.json +++ /dev/null @@ -1,35 +0,0 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "api-version": "2018-10-01", - "parameters": { - "location": "westus", - "tags": { - "department": "finance", - "owner": "myCompany" - } - }, - "resourceName": "myDedicatedHostGroup" - }, - "responses": { - "200": { - "body": { - "properties": { - "platformFaultDomainCount": 3, - "hosts": [] - }, - "location": "westus", - "tags": { - "department": "finance", - "owner": "myCompany" - }, - "name": "myDedicatedHostGroup", - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup", - "zones": [ - "1" - ] - } - } - } -} \ No newline at end of file From b46faa65a38347a64ee0a005ae90166197b516ae Mon Sep 17 00:00:00 2001 From: Cigdem Celik Aydin Date: Thu, 27 Jun 2019 15:31:16 -0700 Subject: [PATCH 08/22] fixed PlatformFaultDomain type --- .../2019-03-01/examples/CreateOrUpdateADedicatedHost.json | 2 +- .../2019-03-01/examples/CreateOrUpdateADedicatedHostGroup.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateOrUpdateADedicatedHost.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateOrUpdateADedicatedHost.json index 4298c4bff125..edf599b4a2f6 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateOrUpdateADedicatedHost.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateOrUpdateADedicatedHost.json @@ -9,7 +9,7 @@ "department": "HR" }, "properties": { - "platformFaultDomain": "1" + "platformFaultDomain": 1 }, "sku": { "name": "DSv3-Type1" diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateOrUpdateADedicatedHostGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateOrUpdateADedicatedHostGroup.json index 192053bcaa11..692fca3c2af9 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateOrUpdateADedicatedHostGroup.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateOrUpdateADedicatedHostGroup.json @@ -13,7 +13,7 @@ "1" ], "properties": { - "platformFaultDomainCount": "3" + "platformFaultDomainCount": 3 } } }, From 12a9eeee423e537453dab4243cc105de4f5e1141 Mon Sep 17 00:00:00 2001 From: Cigdem Celik Aydin Date: Thu, 27 Jun 2019 15:40:56 -0700 Subject: [PATCH 09/22] parameter name fixes --- .../2019-03-01/examples/CreateOrUpdateADedicatedHostGroup.json | 2 +- .../stable/2019-03-01/examples/GetADedicatedHostGroup.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateOrUpdateADedicatedHostGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateOrUpdateADedicatedHostGroup.json index 692fca3c2af9..41ab723399d6 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateOrUpdateADedicatedHostGroup.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateOrUpdateADedicatedHostGroup.json @@ -3,7 +3,7 @@ "subscriptionId": "{subscription-id}", "resourceGroupName": "myResourceGroup", "api-version": "2018-10-01", - "resourceName": "myDedicatedHostGroup", + "hostGroupName": "myDedicatedHostGroup", "parameters": { "location": "westus", "tags": { diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/GetADedicatedHostGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/GetADedicatedHostGroup.json index 21d29a047ccf..01ba5926bd63 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/GetADedicatedHostGroup.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/GetADedicatedHostGroup.json @@ -3,7 +3,7 @@ "subscriptionId": "{subscriptionId}", "resourceGroupName": "myResourceGroup", "api-version": "2018-10-01", - "resourceName": "myDedicatedHostGroup" + "hostGroupName": "myDedicatedHostGroup" }, "responses": { "200": { From 2b0c742b36400a727c41e7e0afb7b77224a56942 Mon Sep 17 00:00:00 2001 From: Cigdem Celik Aydin Date: Fri, 28 Jun 2019 15:32:04 -0700 Subject: [PATCH 10/22] Suppressed errors on DedicatedHostGroupUpdate and DedicatedHostUpdate --- specification/compute/resource-manager/readme.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/specification/compute/resource-manager/readme.md b/specification/compute/resource-manager/readme.md index f50fd8354c0e..277ac0499b62 100644 --- a/specification/compute/resource-manager/readme.md +++ b/specification/compute/resource-manager/readme.md @@ -126,7 +126,14 @@ directive: - $.definitions.ImageUpdate suppress: - RequiredPropertiesMissingInResourceModel - + - where: + - $.definitions.DedicatedHostGroupUpdate + suppress: + - RequiredPropertiesMissingInResourceModel + - where: + - $.definitions.DedicatedHostUpdate + suppress: + - RequiredPropertiesMissingInResourceModel - where: - $.definitions.VirtualMachineScaleSetVM From ce385fe611115180ccad2532c5f6a846221db2be Mon Sep 17 00:00:00 2001 From: Cigdem Celik Aydin Date: Fri, 12 Jul 2019 13:15:31 -0700 Subject: [PATCH 11/22] Update compute.json --- .../Microsoft.Compute/stable/2019-03-01/compute.json | 1 + 1 file changed, 1 insertion(+) diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json index 72341fb57ffa..8a271670fc2d 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json @@ -5623,6 +5623,7 @@ "type": "boolean", "description": "Whether the host should be replaced automatically in case of a failure. The value is defaulted to true when not provided." }, + "hostId": { "readOnly": true, "type": "string", From 08dac496757ba6f5d744d6dfbb6545568c878837 Mon Sep 17 00:00:00 2001 From: Cigdem Celik Aydin Date: Fri, 12 Jul 2019 14:05:34 -0700 Subject: [PATCH 12/22] Update compute.json --- .../Microsoft.Compute/stable/2019-03-01/compute.json | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json index 8a271670fc2d..34e33c829b59 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json @@ -5575,7 +5575,7 @@ "availableVCpus": { "type": "number", "format": "double", - "description": "The total number of CPUs." + "description": "The number of virtual CPUs available for new allocations." }, "allocatableVMs": { "type": "array", @@ -5623,7 +5623,6 @@ "type": "boolean", "description": "Whether the host should be replaced automatically in case of a failure. The value is defaulted to true when not provided." }, - "hostId": { "readOnly": true, "type": "string", @@ -5645,7 +5644,7 @@ "readOnly": true, "type": "string", "format": "date-time", - "description": "The date when the host was first created." + "description": "The date when the host was first provisioned." }, "provisioningState": { "readOnly": true, From 94b85bbf470815a49aed848d86620184091e479b Mon Sep 17 00:00:00 2001 From: Cigdem Celik Aydin Date: Fri, 12 Jul 2019 14:14:33 -0700 Subject: [PATCH 13/22] Merge from upstream/master --- .../stable/2019-03-01/compute.json.orig | 9664 +++++++++++++++++ .../CreateOrUpdateADedicatedHost.json.orig | 68 + ...reateOrUpdateADedicatedHostGroup.json.orig | 65 + .../examples/GetADedicatedHost.json.orig | 67 + .../examples/GetADedicatedHostGroup.json.orig | 37 + 5 files changed, 9901 insertions(+) create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json.orig create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateOrUpdateADedicatedHost.json.orig create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateOrUpdateADedicatedHostGroup.json.orig create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/GetADedicatedHost.json.orig create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/GetADedicatedHostGroup.json.orig diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json.orig b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json.orig new file mode 100644 index 000000000000..6277f1d93fe0 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json.orig @@ -0,0 +1,9664 @@ +{ + "swagger": "2.0", + "info": { + "title": "ComputeManagementClient", + "description": "The Compute Management Client.", + "version": "2019-03-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.Compute/operations": { + "get": { + "tags": [ + "ComputeOperations" + ], + "operationId": "Operations_List", + "description": "Gets a list of compute operations.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ComputeOperationListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}": { + "put": { + "tags": [ + "AvailabilitySets" + ], + "operationId": "AvailabilitySets_CreateOrUpdate", + "description": "Create or update an availability set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "availabilitySetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the availability set." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AvailabilitySet" + }, + "description": "Parameters supplied to the Create Availability Set operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AvailabilitySet" + } + } + }, + "x-ms-examples": { + "Create an availability set.": { + "$ref": "./examples/CreateAnAvailabilitySet.json" + } + } + }, + "patch": { + "tags": [ + "AvailabilitySets" + ], + "operationId": "AvailabilitySets_Update", + "description": "Update an availability set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "availabilitySetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the availability set." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AvailabilitySetUpdate" + }, + "description": "Parameters supplied to the Update Availability Set operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AvailabilitySet" + } + } + } + }, + "delete": { + "tags": [ + "AvailabilitySets" + ], + "operationId": "AvailabilitySets_Delete", + "description": "Delete an availability set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "availabilitySetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the availability set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + } + } + }, + "get": { + "tags": [ + "AvailabilitySets" + ], + "operationId": "AvailabilitySets_Get", + "description": "Retrieves information about an availability set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "availabilitySetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the availability set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AvailabilitySet" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/availabilitySets": { + "get": { + "tags": [ + "AvailabilitySets" + ], + "operationId": "AvailabilitySets_ListBySubscription", + "description": "Lists all availability sets in a subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AvailabilitySetListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets": { + "get": { + "tags": [ + "AvailabilitySets" + ], + "operationId": "AvailabilitySets_List", + "description": "Lists all availability sets in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AvailabilitySetListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}/vmSizes": { + "get": { + "tags": [ + "AvailabilitySets" + ], + "operationId": "AvailabilitySets_ListAvailableSizes", + "description": "Lists all available virtual machine sizes that can be used to create a new virtual machine in an existing availability set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "availabilitySetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the availability set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineSizeListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/proximityPlacementGroups/{proximityPlacementGroupName}": { + "put": { + "tags": [ + "ProximityPlacementGroups" + ], + "operationId": "ProximityPlacementGroups_CreateOrUpdate", + "description": "Create or update a proximity placement group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "proximityPlacementGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the proximity placement group." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ProximityPlacementGroup" + }, + "description": "Parameters supplied to the Create Proximity Placement Group operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProximityPlacementGroup" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ProximityPlacementGroup" + } + } + }, + "x-ms-examples": { + "Create or Update a proximity placement group.": { + "$ref": "./examples/CreateOrUpdateAProximityPlacementGroup.json" + } + } + }, + "patch": { + "tags": [ + "ProximityPlacementGroups" + ], + "operationId": "ProximityPlacementGroups_Update", + "description": "Update a proximity placement group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "proximityPlacementGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the proximity placement group." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ProximityPlacementGroupUpdate" + }, + "description": "Parameters supplied to the Update Proximity Placement Group operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProximityPlacementGroup" + } + } + }, + "x-ms-examples": { + "Create a proximity placement group.": { + "$ref": "./examples/PatchAProximityPlacementGroup.json" + } + } + }, + "delete": { + "tags": [ + "ProximityPlacementGroups" + ], + "operationId": "ProximityPlacementGroups_Delete", + "description": "Delete a proximity placement group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "proximityPlacementGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the proximity placement group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "x-ms-examples": { + "Create a proximity placement group.": { + "$ref": "./examples/DeleteAProximityPlacementGroup.json" + } + } + }, + "get": { + "tags": [ + "ProximityPlacementGroups" + ], + "operationId": "ProximityPlacementGroups_Get", + "description": "Retrieves information about a proximity placement group .", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "proximityPlacementGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the proximity placement group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProximityPlacementGroup" + } + } + }, + "x-ms-examples": { + "Create a proximity placement group.": { + "$ref": "./examples/GetAProximityPlacementGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/proximityPlacementGroups": { + "get": { + "tags": [ + "ProximityPlacementGroups" + ], + "operationId": "ProximityPlacementGroups_ListBySubscription", + "description": "Lists all proximity placement groups in a subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProximityPlacementGroupListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Create a proximity placement group.": { + "$ref": "./examples/ListProximityPlacementGroupsInASubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/proximityPlacementGroups": { + "get": { + "tags": [ + "ProximityPlacementGroups" + ], + "operationId": "ProximityPlacementGroups_ListByResourceGroup", + "description": "Lists all proximity placement groups in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProximityPlacementGroupListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Create a proximity placement group.": { + "$ref": "./examples/ListProximityPlacementGroupsInAResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}": { + "put": { + "tags": [ + "DedicatedHostGroups" + ], + "operationId": "DedicatedHostGroups_CreateOrUpdate", + "description": "Create or update a dedicated host group. For details of Dedicated Host and Dedicated Host Groups please see [Dedicated Host Documentation] (https://go.microsoft.com/fwlink/?linkid=2082596)", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host group." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DedicatedHostGroup" + }, + "description": "Parameters supplied to the Create Dedicated Host Group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHostGroup" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/DedicatedHostGroup" + } + } + }, + "x-ms-examples": { + "Create or update a dedicated host group.": { + "$ref": "./examples/CreateOrUpdateADedicatedHostGroup.json" + } + } + }, + "patch": { + "tags": [ + "DedicatedHostGroups" + ], + "operationId": "DedicatedHostGroups_Update", + "description": "Update an dedicated host group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host group." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DedicatedHostGroupUpdate" + }, + "description": "Parameters supplied to the Update Dedicated Host Group operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHostGroup" + } + } + } + }, + "delete": { + "tags": [ + "DedicatedHostGroups" + ], + "operationId": "DedicatedHostGroups_Delete", + "description": "Delete a dedicated host group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + } + } + }, + "get": { + "tags": [ + "DedicatedHostGroups" + ], + "operationId": "DedicatedHostGroups_Get", + "description": "Retrieves information about a dedicated host group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHostGroup" + } + } + }, + "x-ms-examples": { + "Create a dedicated host group.": { + "$ref": "./examples/GetADedicatedHostGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups": { + "get": { + "tags": [ + "DedicatedHostGroups" + ], + "operationId": "DedicatedHostGroups_ListByResourceGroup", + "description": "Lists all of the dedicated host groups in the specified resource group. Use the nextLink property in the response to get the next page of dedicated host groups.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHostGroupListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/hostGroups": { + "get": { + "tags": [ + "DedicatedHostGroups" + ], + "operationId": "DedicatedHostGroups_ListBySubscription", + "description": "Lists all of the dedicated host groups in the subscription. Use the nextLink property in the response to get the next page of dedicated host groups.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHostGroupListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}/hosts/{hostName}": { + "put": { + "tags": [ + "DedicatedHosts" + ], + "operationId": "DedicatedHosts_CreateOrUpdate", + "description": "Create or update a dedicated host .", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host group." + }, + { + "name": "hostName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host ." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DedicatedHost" + }, + "description": "Parameters supplied to the Create Dedicated Host ." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHost" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/DedicatedHost" + } + } + }, + "x-ms-examples": { + "Create or update a dedicated host .": { + "$ref": "./examples/CreateOrUpdateADedicatedHost.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "DedicatedHosts" + ], + "operationId": "DedicatedHosts_Update", + "description": "Update an dedicated host .", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host group." + }, + { + "name": "hostName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host ." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DedicatedHostUpdate" + }, + "description": "Parameters supplied to the Update Dedicated Host operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHost" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "DedicatedHosts" + ], + "operationId": "DedicatedHosts_Delete", + "description": "Delete a dedicated host.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host group." + }, + { + "name": "hostName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "DedicatedHosts" + ], + "operationId": "DedicatedHosts_Get", + "description": "Retrieves information about a dedicated host.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host group." + }, + { + "name": "hostName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation.", + "enum": [ + "instanceView" + ], + "x-ms-enum": { + "name": "InstanceViewTypes", + "modelAsString": false + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHost" + } + } + }, + "x-ms-examples": { + "Get a dedicated host.": { + "$ref": "./examples/GetADedicatedHost.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}/hosts": { + "get": { + "tags": [ + "DedicatedHost" + ], + "operationId": "DedicatedHosts_ListByHostGroup", + "description": "Lists all of the dedicated hosts in the specified dedicated host group. Use the nextLink property in the response to get the next page of dedicated hosts.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHostListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmextension/types/{type}/versions/{version}": { + "get": { + "tags": [ + "VirtualMachineExtensionImages" + ], + "operationId": "VirtualMachineExtensionImages_Get", + "description": "Gets a virtual machine extension image.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "type", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineExtensionImage" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmextension/types": { + "get": { + "tags": [ + "VirtualMachineExtensionImages" + ], + "operationId": "VirtualMachineExtensionImages_ListTypes", + "description": "Gets a list of virtual machine extension image types.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtensionImage" + } + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmextension/types/{type}/versions": { + "get": { + "tags": [ + "VirtualMachineExtensionImages" + ], + "operationId": "VirtualMachineExtensionImages_ListVersions", + "description": "Gets a list of virtual machine extension image versions.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "type", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtensionImage" + } + } + } + }, + "x-ms-odata": "#/definitions/VirtualMachineExtensionImage" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{vmExtensionName}": { + "put": { + "tags": [ + "VirtualMachineExtensions" + ], + "operationId": "VirtualMachineExtensions_CreateOrUpdate", + "description": "The operation to create or update the extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine where the extension should be created or updated." + }, + { + "name": "vmExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine extension." + }, + { + "name": "extensionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineExtension" + }, + "description": "Parameters supplied to the Create Virtual Machine Extension operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineExtension" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VirtualMachineExtension" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "VirtualMachineExtensions" + ], + "operationId": "VirtualMachineExtensions_Update", + "description": "The operation to update the extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine where the extension should be updated." + }, + { + "name": "vmExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine extension." + }, + { + "name": "extensionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineExtensionUpdate" + }, + "description": "Parameters supplied to the Update Virtual Machine Extension operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineExtension" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "VirtualMachineExtensions" + ], + "operationId": "VirtualMachineExtensions_Delete", + "description": "The operation to delete the extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine where the extension should be deleted." + }, + { + "name": "vmExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine extension." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "VirtualMachineExtensions" + ], + "operationId": "VirtualMachineExtensions_Get", + "description": "The operation to get the extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine containing the extension." + }, + { + "name": "vmExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine extension." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineExtension" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions": { + "get": { + "tags": [ + "VirtualMachineExtensions" + ], + "operationId": "VirtualMachineExtensions_List", + "description": "The operation to get all extensions of a Virtual Machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine containing the extension." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineExtensionsListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus/{skus}/versions/{version}": { + "get": { + "tags": [ + "VirtualMachineImages" + ], + "operationId": "VirtualMachineImages_Get", + "description": "Gets a virtual machine image.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "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" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus/{skus}/versions": { + "get": { + "tags": [ + "VirtualMachineImages" + ], + "operationId": "VirtualMachineImages_List", + "description": "Gets a list of all virtual machine image versions for the specified location, publisher, offer, and SKU.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "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": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineImageResource" + } + } + } + }, + "x-ms-odata": "#/definitions/VirtualMachineImageResource" + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers": { + "get": { + "tags": [ + "VirtualMachineImages" + ], + "operationId": "VirtualMachineImages_ListOffers", + "description": "Gets a list of virtual machine image offers for the specified location and publisher.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "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" + } + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers": { + "get": { + "tags": [ + "VirtualMachineImages" + ], + "operationId": "VirtualMachineImages_ListPublishers", + "description": "Gets a list of virtual machine image publishers for the specified Azure location.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineImageResource" + } + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus": { + "get": { + "tags": [ + "VirtualMachineImages" + ], + "operationId": "VirtualMachineImages_ListSkus", + "description": "Gets a list of virtual machine image SKUs for the specified location, publisher, and offer.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "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" + } + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/usages": { + "get": { + "tags": [ + "Usage" + ], + "operationId": "Usage_List", + "description": "Gets, for the specified location, the current compute resource usage information as well as the limits for compute resources under the subscription.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location for which resource usage is queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListUsagesResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/virtualMachines": { + "get": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_ListByLocation", + "description": "Gets all the virtual machines under the specified subscription for the specified location.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location for which virtual machines under the subscription are queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineListResult" + } + } + }, + "x-ms-examples": { + "Lists all the virtual machines under the specified subscription for the specified location.": { + "$ref": "./examples/ListVirtualMachinesInASubscriptionByLocation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/vmSizes": { + "get": { + "tags": [ + "VirtualMachineSizes" + ], + "operationId": "VirtualMachineSizes_List", + "description": "This API is deprecated. Use [Resources Skus](https://docs.microsoft.com/en-us/rest/api/compute/resourceskus/list)", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location upon which virtual-machine-sizes is queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineSizeListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/images/{imageName}": { + "put": { + "tags": [ + "Images" + ], + "operationId": "Images_CreateOrUpdate", + "description": "Create or update an image.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "imageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the image." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Image" + }, + "description": "Parameters supplied to the Create Image operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Image" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Image" + } + } + }, + "x-ms-examples": { + "Create a virtual machine image from a blob.": { + "$ref": "./examples/CreateAnImageFromABlob.json" + }, + "Create a virtual machine image from a snapshot.": { + "$ref": "./examples/CreateAnImageFromASnapshot.json" + }, + "Create a virtual machine image from a managed disk.": { + "$ref": "./examples/CreateAnImageFromAManagedDisk.json" + }, + "Create a virtual machine image from an existing virtual machine.": { + "$ref": "./examples/CreateAnImageFromAVM.json" + }, + "Create a virtual machine image that includes a data disk from a blob.": { + "$ref": "./examples/CreateAnImageThatIncludesADataDiskFromABlob.json" + }, + "Create a virtual machine image that includes a data disk from a snapshot.": { + "$ref": "./examples/CreateAnImageThatIncludesADataDiskFromASnapshot.json" + }, + "Create a virtual machine image that includes a data disk from a managed disk.": { + "$ref": "./examples/CreateAnImageThatIncludesADataDiskFromAManagedDisk.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Images" + ], + "operationId": "Images_Update", + "description": "Update an image.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "imageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the image." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ImageUpdate" + }, + "description": "Parameters supplied to the Update Image operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Image" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Image" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Images" + ], + "operationId": "Images_Delete", + "description": "Deletes an Image.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "imageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the image." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Images" + ], + "operationId": "Images_Get", + "description": "Gets an image.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "imageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the image." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Image" + } + } + }, + "x-ms-examples": { + "Get information about a virtual machine image.": { + "$ref": "./examples/GetInformationAboutAnImage.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/images": { + "get": { + "tags": [ + "Images" + ], + "operationId": "Images_ListByResourceGroup", + "description": "Gets the list of images under a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImageListResult" + } + } + }, + "x-ms-examples": { + "List all virtual machine images in a resource group.": { + "$ref": "./examples/ListImagesInAResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/images": { + "get": { + "tags": [ + "Images" + ], + "operationId": "Images_List", + "description": "Gets the list of Images in the subscription. Use nextLink property in the response to get the next page of Images. Do this till nextLink is null to fetch all the Images.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImageListResult" + } + } + }, + "x-ms-examples": { + "List all virtual machine images in a subscription.": { + "$ref": "./examples/ListImagesInASubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/capture": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Capture", + "description": "Captures the VM by copying virtual hard disks of the VM and outputs a template that can be used to create similar VMs.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineCaptureParameters" + }, + "description": "Parameters supplied to the Capture Virtual Machine operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineCaptureResult" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}": { + "put": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_CreateOrUpdate", + "description": "The operation to create or update a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachine" + }, + "description": "Parameters supplied to the Create Virtual Machine operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachine" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VirtualMachine" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create a vm with password authentication.": { + "$ref": "./examples/CreateAVmWithPasswordAuthentication.json" + }, + "Create a vm with ssh authentication.": { + "$ref": "./examples/CreateAVmWithSshAuthentication.json" + }, + "Create a vm with premium storage.": { + "$ref": "./examples/CreateAVmWithPremiumStorage.json" + }, + "Create a vm in an availability set.": { + "$ref": "./examples/CreateAVmInAnAvailabilitySet.json" + }, + "Create a vm with boot diagnostics.": { + "$ref": "./examples/CreateAVmWithBootDiagnostics.json" + }, + "Create a vm with empty data disks.": { + "$ref": "./examples/CreateAVmWithEmptyDataDisks.json" + }, + "Create a vm with a marketplace image plan.": { + "$ref": "./examples/CreateAVmWithAMarketplaceImagePlan.json" + }, + "Create a vm from a custom image.": { + "$ref": "./examples/CreateAVmFromACustomImage.json" + }, + "Create a platform-image vm with unmanaged os and data disks.": { + "$ref": "./examples/CreateAPlatformImageVmWithUnmanagedOsAndDataDisks.json" + }, + "Create a custom-image vm from an unmanaged generalized os image.": { + "$ref": "./examples/CreateACustomImageVmFromAnUnmanagedGeneralizedOsImage.json" + }, + "Create a vm with ephemeral os disk.": { + "$ref": "./examples/CreateAVmWithADiffOsDisk.json" + } + } + }, + "patch": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Update", + "description": "The operation to update a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineUpdate" + }, + "description": "Parameters supplied to the Update Virtual Machine operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachine" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VirtualMachine" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a VM by detaching data disk": { + "$ref": "./examples/UpdateVMDetachDataDiskUsingToBeDetachedProperty.json" + } + } + }, + "delete": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Delete", + "description": "The operation to delete a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Get", + "description": "Retrieves information about the model view or the instance view of a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation.", + "enum": [ + "instanceView" + ], + "x-ms-enum": { + "name": "InstanceViewTypes", + "modelAsString": false + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachine" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/instanceView": { + "get": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_InstanceView", + "description": "Retrieves information about the run-time state of a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineInstanceView" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/convertToManagedDisks": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_ConvertToManagedDisks", + "description": "Converts virtual machine disks from blob-based to managed disks. Virtual machine must be stop-deallocated before invoking this operation.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/deallocate": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Deallocate", + "description": "Shuts down the virtual machine and releases the compute resources. You are not billed for the compute resources that this virtual machine uses.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/generalize": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Generalize", + "description": "Sets the state of the virtual machine to generalized.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines": { + "get": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_List", + "description": "Lists all of the virtual machines in the specified resource group. Use the nextLink property in the response to get the next page of virtual machines.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/virtualMachines": { + "get": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_ListAll", + "description": "Lists all of the virtual machines in the specified subscription. Use the nextLink property in the response to get the next page of virtual machines.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/vmSizes": { + "get": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_ListAvailableSizes", + "description": "Lists all available virtual machine sizes to which the specified virtual machine can be resized.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineSizeListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "Lists all available virtual machine sizes to which the specified virtual machine can be resized": { + "$ref": "./examples/ListAvailableVmSizes_VirtualMachines.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/powerOff": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_PowerOff", + "description": "The operation to power off (stop) a virtual machine. The virtual machine can be restarted with the same provisioned resources. You are still charged for this virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "skipShutdown", + "in": "query", + "required": false, + "type": "boolean", + "default": false, + "description": "The parameter to request non-graceful VM shutdown. True value for this flag indicates non-graceful shutdown whereas false indicates otherwise. Default value for this flag is false if not specified" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/restart": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Restart", + "description": "The operation to restart a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/start": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Start", + "description": "The operation to start a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/redeploy": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Redeploy", + "description": "The operation to redeploy a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/reimage": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Reimage", + "description": "Reimages the virtual machine which has an ephemeral OS disk back to its initial state.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "parameters", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineReimageParameters" + }, + "description": "Parameters supplied to the Reimage Virtual Machine operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Reimage a Virtual Machine.": { + "$ref": "./examples/ReimageVirtualMachine.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/performMaintenance": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_PerformMaintenance", + "description": "The operation to perform maintenance on a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}": { + "put": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_CreateOrUpdate", + "description": "Create or update a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set to create or update." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSet" + }, + "description": "The scale set object." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSet" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSet" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create a scale set with password authentication.": { + "$ref": "./examples/CreateAScaleSetWithPasswordAuthentication.json" + }, + "Create a scale set with ssh authentication.": { + "$ref": "./examples/CreateAScaleSetWithSshAuthentication.json" + }, + "Create a scale set with premium storage.": { + "$ref": "./examples/CreateAScaleSetWithPremiumStorage.json" + }, + "Create a scale set with empty data disks on each vm.": { + "$ref": "./examples/CreateAScaleSetWithEmptyDataDisksOnEachVm.json" + }, + "Create a scale set with an azure load balancer.": { + "$ref": "./examples/CreateAScaleSetWithAnAzureLoadBalancer.json" + }, + "Create a scale set with an azure application gateway.": { + "$ref": "./examples/CreateAScaleSetWithAnAzureApplicationGateway.json" + }, + "Create a scale set with boot diagnostics.": { + "$ref": "./examples/CreateAScaleSetWithBootDiagnostics.json" + }, + "Create a scale set with a marketplace image plan.": { + "$ref": "./examples/CreateAScaleSetWithAMarketplaceImagePlan.json" + }, + "Create a scale set from a custom image.": { + "$ref": "./examples/CreateAScaleSetFromACustomImage.json" + }, + "Create a platform-image scale set with unmanaged os disks.": { + "$ref": "./examples/CreateAPlatformImageScaleSetWithUnmanagedOsDisks.json" + }, + "Create a custom-image scale set from an unmanaged generalized os image.": { + "$ref": "./examples/CreateACustomImageScaleSetFromAnUnmanagedGeneralizedOsImage.json" + }, + "Create a scale set with virtual machines in different zones.": { + "$ref": "./examples/CreateAScaleSetWithVMsInDifferentZones.json" + }, + "Create a scale set with ephemeral os disks.": { + "$ref": "./examples/CreateAScaleSetWithDiffOsDisk.json" + } + } + }, + "patch": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Update", + "description": "Update a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set to create or update." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdate" + }, + "description": "The scale set object." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSet" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Delete", + "description": "Deletes a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Get", + "description": "Display information about a virtual machine scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSet" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/deallocate": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Deallocate", + "description": "Deallocates specific virtual machines in a VM scale set. Shuts down the virtual machines and releases the compute resources. You are not billed for the compute resources that this virtual machine scale set deallocates.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/delete": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_DeleteInstances", + "description": "Deletes virtual machines in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceRequiredIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/instanceView": { + "get": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_GetInstanceView", + "description": "Gets the status of a VM scale set instance.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetInstanceView" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets": { + "get": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_List", + "description": "Gets a list of all VM scale sets under a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensions/{vmssExtensionName}": { + "put": { + "tags": [ + "VirtualMachineScaleSetExtensions" + ], + "operationId": "VirtualMachineScaleSetExtensions_CreateOrUpdate", + "description": "The operation to create or update an extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set where the extension should be create or updated." + }, + { + "name": "vmssExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set extension." + }, + { + "name": "extensionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + }, + "description": "Parameters supplied to the Create VM scale set Extension operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "VirtualMachineScaleSetExtensions" + ], + "operationId": "VirtualMachineScaleSetExtensions_Delete", + "description": "The operation to delete the extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set where the extension should be deleted." + }, + { + "name": "vmssExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set extension." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "VirtualMachineScaleSetExtensions" + ], + "operationId": "VirtualMachineScaleSetExtensions_Get", + "description": "The operation to get the extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set containing the extension." + }, + { + "name": "vmssExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set extension." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensions": { + "get": { + "tags": [ + "VirtualMachineScaleSetExtensions" + ], + "operationId": "VirtualMachineScaleSetExtensions_List", + "description": "Gets a list of all extensions in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set containing the extension." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetExtensionListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/virtualMachineScaleSets": { + "get": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_ListAll", + "description": "Gets a list of all VM Scale Sets in the subscription, regardless of the associated resource group. Use nextLink property in the response to get the next page of VM Scale Sets. Do this till nextLink is null to fetch all the VM Scale Sets.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetListWithLinkResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/skus": { + "get": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_ListSkus", + "description": "Gets a list of SKUs available for your VM scale set, including the minimum and maximum VM instances allowed for each SKU.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetListSkusResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/osUpgradeHistory": { + "get": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_GetOSUpgradeHistory", + "description": "Gets list of OS upgrades on a VM scale set instance.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetListOSUpgradeHistory" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/poweroff": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_PowerOff", + "description": "Power off (stop) one or more virtual machines in a VM scale set. Note that resources are still attached and you are getting charged for the resources. Instead, use deallocate to release resources and avoid charges.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "name": "skipShutdown", + "in": "query", + "required": false, + "type": "boolean", + "default": false, + "description": "The parameter to request non-graceful VM shutdown. True value for this flag indicates non-graceful shutdown whereas false indicates otherwise. Default value for this flag is false if not specified" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/restart": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Restart", + "description": "Restarts one or more virtual machines in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/start": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Start", + "description": "Starts one or more virtual machines in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/redeploy": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Redeploy", + "description": "Redeploy one or more virtual machines in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/performMaintenance": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_PerformMaintenance", + "description": "Perform maintenance on one or more virtual machines in a VM scale set. Operation on instances which are not eligible for perform maintenance will be failed. Please refer to best practices for more details: https://docs.microsoft.com/en-us/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-maintenance-notifications", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/manualupgrade": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_UpdateInstances", + "description": "Upgrades one or more virtual machines to the latest SKU set in the VM scale set model.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceRequiredIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/reimage": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Reimage", + "description": "Reimages (upgrade the operating system) one or more virtual machines in a VM scale set which don't have a ephemeral OS disk, for virtual machines who have a ephemeral OS disk the virtual machine is reset to initial state.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmScaleSetReimageInput", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetReimageParameters" + }, + "description": "Parameters for Reimaging VM ScaleSet." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/reimageall": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_ReimageAll", + "description": "Reimages all the disks ( including data disks ) in the virtual machines in a VM scale set. This operation is only supported for managed disks.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/rollingUpgrades/cancel": { + "post": { + "tags": [ + "VirtualMachineScaleSetRollingUpgrades" + ], + "operationId": "VirtualMachineScaleSetRollingUpgrades_Cancel", + "description": "Cancels the current virtual machine scale set rolling upgrade.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/osRollingUpgrade": { + "post": { + "tags": [ + "VirtualMachineScaleSetRollingUpgrades" + ], + "operationId": "VirtualMachineScaleSetRollingUpgrades_StartOSUpgrade", + "description": "Starts a rolling upgrade to move all virtual machine scale set instances to the latest available Platform Image OS version. Instances which are already running the latest available OS version are not affected.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensionRollingUpgrade": { + "post": { + "tags": [ + "VirtualMachineScaleSetRollingUpgrades" + ], + "operationId": "VirtualMachineScaleSetRollingUpgrades_StartExtensionUpgrade", + "description": "Starts a rolling upgrade to move all extensions for all virtual machine scale set instances to the latest available extension version. Instances which are already running the latest extension versions are not affected.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Start an extension rolling upgrade.": { + "$ref": "./examples/VMScaleSetExtensionRollingUpgrade.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/rollingUpgrades/latest": { + "get": { + "tags": [ + "VirtualMachineScaleSetRollingUpgrades" + ], + "operationId": "VirtualMachineScaleSetRollingUpgrades_GetLatest", + "description": "Gets the status of the latest virtual machine scale set rolling upgrade.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RollingUpgradeStatusInfo" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/forceRecoveryServiceFabricPlatformUpdateDomainWalk": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_ForceRecoveryServiceFabricPlatformUpdateDomainWalk", + "description": "Manual platform update domain walk to update virtual machines in a service fabric virtual machine scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "platformUpdateDomain", + "in": "query", + "required": true, + "type": "integer", + "description": "The platform update domain for which a manual recovery walk is requested" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryWalkResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/convertToSinglePlacementGroup": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_ConvertToSinglePlacementGroup", + "description": "Converts SinglePlacementGroup property to false for a existing virtual machine scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine scale set to create or update." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VMScaleSetConvertToSinglePlacementGroupInput" + }, + "description": "The input object for ConvertToSinglePlacementGroup API." + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/reimage": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Reimage", + "description": "Reimages (upgrade the operating system) a specific virtual machine in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "vmScaleSetVMReimageInput", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMReimageParameters" + }, + "description": "Parameters for the Reimaging Virtual machine in ScaleSet." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/reimageall": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_ReimageAll", + "description": "Allows you to re-image all the disks ( including data disks ) in the a VM scale set instance. This operation is only supported for managed disks.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/deallocate": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Deallocate", + "description": "Deallocates a specific virtual machine in a VM scale set. Shuts down the virtual machine and releases the compute resources it uses. You are not billed for the compute resources of this virtual machine once it is deallocated.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}": { + "put": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Update", + "description": "Updates a virtual machine of a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set where the extension should be create or updated." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVM" + }, + "description": "Parameters supplied to the Update Virtual Machine Scale Sets VM operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVM" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVM" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Delete", + "description": "Deletes a virtual machine from a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Get", + "description": "Gets a virtual machine from a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVM" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/instanceView": { + "get": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_GetInstanceView", + "description": "Gets the status of a virtual machine from a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceView" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines": { + "get": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_List", + "description": "Gets a list of all virtual machines in a VM scale sets.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualMachineScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply to the operation." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "The list parameters." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply to the operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/VirtualMachineScaleSetVM" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/poweroff": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_PowerOff", + "description": "Power off (stop) a virtual machine in a VM scale set. Note that resources are still attached and you are getting charged for the resources. Instead, use deallocate to release resources and avoid charges.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "skipShutdown", + "in": "query", + "required": false, + "type": "boolean", + "default": false, + "description": "The parameter to request non-graceful VM shutdown. True value for this flag indicates non-graceful shutdown whereas false indicates otherwise. Default value for this flag is false if not specified" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/restart": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Restart", + "description": "Restarts a virtual machine in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/start": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Start", + "description": "Starts a virtual machine in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/redeploy": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Redeploy", + "description": "Redeploys a virtual machine in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/performMaintenance": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_PerformMaintenance", + "description": "Performs maintenance on a virtual machine in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/logAnalytics/apiAccess/getRequestRateByInterval": { + "post": { + "tags": [ + "LogAnalytics" + ], + "operationId": "LogAnalytics_ExportRequestRateByInterval", + "x-ms-examples": { + "Export logs which contain all Api requests made to Compute Resource Provider within the given time period broken down by intervals.": { + "$ref": "./examples/LogAnalyticsRequestRateByInterval.json" + } + }, + "description": "Export logs that show Api requests made by this subscription in the given time window to show throttling activities.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RequestRateByIntervalInput" + }, + "description": "Parameters supplied to the LogAnalytics getRequestRateByInterval Api." + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location upon which virtual-machine-sizes is queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LogAnalyticsOperationResult" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/logAnalytics/apiAccess/getThrottledRequests": { + "post": { + "tags": [ + "LogAnalytics" + ], + "operationId": "LogAnalytics_ExportThrottledRequests", + "x-ms-examples": { + "Export logs which contain all throttled Api requests made to Compute Resource Provider within the given time period.": { + "$ref": "./examples/LogAnalyticsThrottledRequests.json" + } + }, + "description": "Export logs that show total throttled Api requests for this subscription in the given time window.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ThrottledRequestsInput" + }, + "description": "Parameters supplied to the LogAnalytics getThrottledRequests Api." + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location upon which virtual-machine-sizes is queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LogAnalyticsOperationResult" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + } + }, + "definitions": { + "ComputeOperationListResult": { + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ComputeOperationValue" + }, + "description": "The list of compute operations" + } + }, + "description": "The List Compute Operation operation response." + }, + "ComputeOperationValue": { + "properties": { + "origin": { + "type": "string", + "readOnly": true, + "description": "The origin of the compute operation." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the compute operation." + }, + "display": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ComputeOperationValueDisplay" + } + }, + "description": "Describes the properties of a Compute Operation value." + }, + "ComputeOperationValueDisplay": { + "properties": { + "operation": { + "type": "string", + "readOnly": true, + "description": "The display name of the compute operation." + }, + "resource": { + "type": "string", + "readOnly": true, + "description": "The display name of the resource the operation applies to." + }, + "description": { + "type": "string", + "readOnly": true, + "description": "The description of the operation." + }, + "provider": { + "type": "string", + "readOnly": true, + "description": "The resource provider for the operation." + } + }, + "description": "Describes the properties of a Compute Operation Value Display." + }, + "HyperVGenerationType": { + "type": "string", + "description": "Specifies the HyperVGeneration Type for the Virtual Machine created from the image", + "enum": [ + "V1", + "V2" + ], + "x-ms-enum": { + "name": "HyperVGenerationTypes", + "modelAsString": true + } + }, + "InstanceViewStatus": { + "properties": { + "code": { + "type": "string", + "description": "The status code." + }, + "level": { + "type": "string", + "description": "The level code.", + "enum": [ + "Info", + "Warning", + "Error" + ], + "x-ms-enum": { + "name": "StatusLevelTypes", + "modelAsString": false + } + }, + "displayStatus": { + "type": "string", + "description": "The short localizable label for the status." + }, + "message": { + "type": "string", + "description": "The detailed status message, including for alerts and error messages." + }, + "time": { + "type": "string", + "format": "date-time", + "description": "The time of the status." + } + }, + "description": "Instance view status." + }, + "AvailabilitySetProperties": { + "properties": { + "platformUpdateDomainCount": { + "type": "integer", + "format": "int32", + "description": "Update Domain count." + }, + "platformFaultDomainCount": { + "type": "integer", + "format": "int32", + "description": "Fault Domain count." + }, + "virtualMachines": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "description": "A list of references to all virtual machines in the availability set." + }, + "proximityPlacementGroup": { + "$ref": "#/definitions/SubResource", + "description": "Specifies information about the proximity placement group that the availability set should be assigned to.

Minimum api-version: 2018-04-01." + }, + "statuses": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "The resource status information." + } + }, + "description": "The instance view of a resource." + }, + "AvailabilitySetSkuType": { + "type": "string", + "description": "Specifies the sku of an Availability Set. Use 'Aligned' for virtual machines with managed disks and 'Classic' for virtual machines with unmanaged disks. Default value is 'Classic'.", + "enum": [ + "Classic", + "Aligned" + ], + "x-ms-enum": { + "name": "AvailabilitySetSkuTypes", + "modelAsString": true + } + }, + "AvailabilitySet": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AvailabilitySetProperties" + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "Sku of the availability set, only name is required to be set. See AvailabilitySetSkuTypes for possible set of values. Use 'Aligned' for virtual machines with managed disks and 'Classic' for virtual machines with unmanaged disks. Default value is 'Classic'." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

For more information on Azure planned maintenance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." + }, + "AvailabilitySetUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AvailabilitySetProperties" + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "Sku of the availability set" + } + }, + "allOf": [ + { + "$ref": "#/definitions/UpdateResource" + } + ], + "description": "Specifies information about the availability set that the virtual machine should be assigned to. Only tags may be updated." + }, + "AvailabilitySetListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AvailabilitySet" + }, + "description": "The list of availability sets" + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of AvailabilitySets. Call ListNext() with this URI to fetch the next page of AvailabilitySets." + } + }, + "required": [ + "value" + ], + "description": "The List Availability Set operation response." + }, + "ProximityPlacementGroupProperties": { + "properties": { + "proximityPlacementGroupType": { + "type": "string", + "description": "Specifies the type of the proximity placement group.

Possible values are:

**Standard** : Co-locate resources within an Azure region or Availability Zone.

**Ultra** : For future use.", + "enum": [ + "Standard", + "Ultra" + ], + "x-ms-enum": { + "name": "ProximityPlacementGroupType", + "modelAsString": true + } + }, + "virtualMachines": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "description": "A list of references to all virtual machines in the proximity placement group." + }, + "virtualMachineScaleSets": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "description": "A list of references to all virtual machine scale sets in the proximity placement group." + }, + "availabilitySets": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "description": "A list of references to all availability sets in the proximity placement group." + } + }, + "description": "Describes the properties of a Proximity Placement Group." + }, + "ProximityPlacementGroup": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ProximityPlacementGroupProperties", + "description": "Describes the properties of a Proximity Placement Group." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Specifies information about the proximity placement group." + }, + "ProximityPlacementGroupUpdate": { + "allOf": [ + { + "$ref": "#/definitions/UpdateResource" + } + ], + "description": "Specifies information about the proximity placement group." + }, + "ProximityPlacementGroupListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ProximityPlacementGroup" + }, + "description": "The list of proximity placement groups" + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of proximity placement groups." + } + }, + "required": [ + "value" + ], + "description": "The List Proximity Placement Group operation response." + }, + "DedicatedHostGroupProperties": { + "properties": { + "platformFaultDomainCount": { + "type": "integer", + "format": "int32", + "description": "Number of fault domains that the host group can span. Supported values 1,2,3." + }, + "hosts": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResourceReadOnly" + }, + "readOnly": true, + "description": "A list of references to all dedicated hosts in the dedicated host group." + } + }, + "description": "Dedicated Host Group Properties." + }, + "DedicatedHostGroup": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DedicatedHostGroupProperties" + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Availability Zone to use for this host group – only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforce each host in the group is in the same zone." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Specifies information about the dedicated host group that the dedicated hosts should be assigned to.

Currently, a Dedicated host can only be added to Dedicated Host Group at creation time. An existing Dedicated Host cannot be added to a dedicated host group." + }, + "DedicatedHostGroupUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DedicatedHostGroupProperties" + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Availability Zone to use for this host group – only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforce each host in the group is in the same zone." + } + }, + "allOf": [ + { + "$ref": "#/definitions/UpdateResource" + } + ], + "description": "Specifies information about the dedicated host group that the dedicated host should be assigned to. Only tags may be updated." + }, + "DedicatedHostGroupListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DedicatedHostGroup" + }, + "description": "The list of dedicated host groups" + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of Dedicated Host Groups. Call ListNext() with this URI to fetch the next page of Dedicated Host Groups." + } + }, + "required": [ + "value" + ], + "description": "The List Dedicated Host Group with resource group response." + }, + "DedicatedHostLicenseType": { + "type": "string", + "description": "Specifies the software license type that will be applied to the VMs deployed on the dedicated host.

Possible values are:

**None**

**Windows_Server_Hybrid**

**Windows_Server_Perpetual**

Default: **None**", + "enum": [ + "None", + "Windows_Server_Hybrid", + "Windows_Server_Perpetual" + ], + "x-ms-enum": { + "name": "DedicatedHostLicenseTypes", + "modelAsString": false + } + }, + "DedicatedHostCapacity": { + "properties": { + "totalCores": { + "type": "number", + "format": "double", + "description": "The total number of cores." + }, + "totalVCpus": { + "type": "number", + "format": "double", + "description": "The total number of CPUs." + } + }, + "description": "Dedicated host total capacity." + }, + "DedicatedHostAllocatableVM": { + "properties": { + "vmSize": { + "type": "string", + "description": "VM size in terms of which the unutilized capacity is represented." + }, + "count": { + "type": "number", + "format": "double", + "description": "Maximum number of VMs of size vmSize that can fit in the dedicated host's remaining capacity." + } + }, + "description": "Represents the dedicated host unutilized capacity in terms of a specific VM size." + }, + "DedicatedHostAvailableCapacity": { + "properties": { + "availableVCpus": { + "type": "number", + "format": "double", +<<<<<<< HEAD + "description": "The number of virtual CPUs available for new allocations." +======= + "description": "The total number of CPUs." +>>>>>>> upstream/master + }, + "allocatableVMs": { + "type": "array", + "items": { + "$ref": "#/definitions/DedicatedHostAllocatableVM" + }, + "description": "The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host." + } + }, + "description": "Dedicated host unutilized capacity." + }, + "DedicatedHostInstanceView": { + "properties": { + "assetId": { + "readOnly": true, + "type": "string", + "description": "Specifies the unique of the dedicated physical machine on which the dedicated host resides." + }, + "capacity": { + "$ref": "#/definitions/DedicatedHostCapacity", + "description": "The total capacity of the dedicated host." + }, + "availableCapacity": { + "$ref": "#/definitions/DedicatedHostAvailableCapacity", + "description": "Unutilized capacity of the dedicated host." + }, + "statuses": { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "The resource status information." + } + }, + "description": "The instance view of a dedicated host." + }, + "DedicatedHostProperties": { + "properties": { + "platformFaultDomain": { + "type": "integer", + "format": "int32", + "description": "Fault domain of the host within a group. Supported values 0,1,2." + }, + "autoReplaceOnFailure": { + "type": "boolean", + "description": "Whether the host should be replaced automatically in case of a failure. The value is defaulted to true when not provided." + }, + "hostId": { + "readOnly": true, + "type": "string", + "description": "A unique id generated and assigned to the dedicated host by the platform." + }, + "virtualMachines": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResourceReadOnly" + }, + "readOnly": true, + "description": "A list of references to all virtual machines in the Dedicated Host." + }, + "licenseType": { + "$ref": "#/definitions/DedicatedHostLicenseType", + "description": "Specifies the software license type that will be applied to the VMs deployed on the dedicated host.

Possible values are:

**None**

**Windows_Server_Hybrid**

**Windows_Server_Perpetual**

Default: **None**" + }, + "provisioningTime": { + "readOnly": true, + "type": "string", + "format": "date-time", +<<<<<<< HEAD + "description": "The date when the host was first provisioned." +======= + "description": "The date when the host was first created." +>>>>>>> upstream/master + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + }, + "instanceView": { + "$ref": "#/definitions/DedicatedHostInstanceView", + "readOnly": true, + "description": "The dedicated host instance view." + } + }, + "description": "Properties of the dedicated host." + }, + "DedicatedHost": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DedicatedHostProperties" + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "Sku of the dedicated host for Hardware Generation and VM family, The only name is required to be set. See DedicatedHostSkuTypes for possible set of values." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Specifies information about the Dedicated host." + }, + "DedicatedHostUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DedicatedHostProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/UpdateResource" + } + ], + "description": "Specifies information about the dedicated host. Only tags, autoReplaceOnFailure and licenseType may be updated." + }, + "DedicatedHostListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DedicatedHost" + }, + "description": "The list of dedicated hosts" + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of Dedicated hosts. Call ListNext() with this URI to fetch the next page of Dedicated hosts." + } + }, + "required": [ + "value" + ], + "description": "The List Dedicated Host operation response." + }, + "VirtualMachineSize": { + "properties": { + "name": { + "type": "string", + "description": "The name of the virtual machine size." + }, + "numberOfCores": { + "type": "integer", + "format": "int32", + "description": "The number of cores supported by the virtual machine size." + }, + "osDiskSizeInMB": { + "type": "integer", + "format": "int32", + "description": "The OS disk size, in MB, allowed by the virtual machine size." + }, + "resourceDiskSizeInMB": { + "type": "integer", + "format": "int32", + "description": "The resource disk size, in MB, allowed by the virtual machine size." + }, + "memoryInMB": { + "type": "integer", + "format": "int32", + "description": "The amount of memory, in MB, supported by the virtual machine size." + }, + "maxDataDiskCount": { + "type": "integer", + "format": "int32", + "description": "The maximum number of data disks that can be attached to the virtual machine size." + } + }, + "description": "Describes the properties of a VM size." + }, + "VirtualMachineSizeListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineSize" + }, + "description": "The list of virtual machine sizes." + } + }, + "description": "The List Virtual Machine operation response." + }, + "VirtualMachineExtensionImageProperties": { + "properties": { + "operatingSystem": { + "type": "string", + "description": "The operating system this extension supports." + }, + "computeRole": { + "type": "string", + "description": "The type of role (IaaS or PaaS) this extension supports." + }, + "handlerSchema": { + "type": "string", + "description": "The schema defined by publisher, where extension consumers should provide settings in a matching schema." + }, + "vmScaleSetEnabled": { + "type": "boolean", + "description": "Whether the extension can be used on xRP VMScaleSets. By default existing extensions are usable on scalesets, but there might be cases where a publisher wants to explicitly indicate the extension is only enabled for CRP VMs but not VMSS." + }, + "supportsMultipleExtensions": { + "type": "boolean", + "description": "Whether the handler can support multiple extensions." + } + }, + "required": [ + "operatingSystem", + "computeRole", + "handlerSchema" + ], + "description": "Describes the properties of a Virtual Machine Extension Image." + }, + "VirtualMachineExtensionImage": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineExtensionImageProperties" + } + }, + "required": [ + "name", + "location" + ], + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Describes a Virtual Machine Extension Image." + }, + "VirtualMachineImageResource": { + "properties": { + "name": { + "type": "string", + "description": "The name of the resource." + }, + "location": { + "type": "string", + "description": "The supported Azure location of the resource." + }, + "tags": { + "type": "object", + "additionalProperties": { + "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)." + } + }, + "required": [ + "name", + "location" + ], + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "Virtual machine image resource information." + }, + "VirtualMachineExtensionInstanceView": { + "properties": { + "name": { + "type": "string", + "description": "The virtual machine extension name." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + }, + "substatuses": { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "The resource status information." + }, + "statuses": { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "The resource status information." + } + }, + "description": "The instance view of a virtual machine extension." + }, + "VirtualMachineExtensionProperties": { + "properties": { + "forceUpdateTag": { + "type": "string", + "description": "How the extension handler should be forced to update even if the extension configuration has not changed." + }, + "publisher": { + "type": "string", + "description": "The name of the extension handler publisher." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + }, + "autoUpgradeMinorVersion": { + "type": "boolean", + "description": "Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true." + }, + "settings": { + "type": "object", + "description": "Json formatted public settings for the extension." + }, + "protectedSettings": { + "type": "object", + "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + }, + "instanceView": { + "$ref": "#/definitions/VirtualMachineExtensionInstanceView", + "description": "The virtual machine extension instance view." + } + }, + "description": "Describes the properties of a Virtual Machine Extension." + }, + "VirtualMachineExtensionUpdateProperties": { + "properties": { + "forceUpdateTag": { + "type": "string", + "description": "How the extension handler should be forced to update even if the extension configuration has not changed." + }, + "publisher": { + "type": "string", + "description": "The name of the extension handler publisher." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + }, + "autoUpgradeMinorVersion": { + "type": "boolean", + "description": "Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true." + }, + "settings": { + "type": "object", + "description": "Json formatted public settings for the extension." + }, + "protectedSettings": { + "type": "object", + "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." + } + }, + "description": "Describes the properties of a Virtual Machine Extension." + }, + "VirtualMachineExtension": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineExtensionProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Describes a Virtual Machine Extension." + }, + "VirtualMachineExtensionUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineExtensionUpdateProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/UpdateResource" + } + ], + "description": "Describes a Virtual Machine Extension." + }, + "VirtualMachineExtensionsListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtension" + }, + "description": "The list of extensions" + } + }, + "description": "The List Extension operation response" + }, + "PurchasePlan": { + "properties": { + "publisher": { + "type": "string", + "description": "The publisher ID." + }, + "name": { + "type": "string", + "description": "The plan ID." + }, + "product": { + "type": "string", + "description": "Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element." + } + }, + "required": [ + "publisher", + "name", + "product" + ], + "description": "Used for establishing the purchase context of any 3rd Party artifact through MarketPlace." + }, + "OSDiskImage": { + "properties": { + "operatingSystem": { + "type": "string", + "description": "The operating system of the osDiskImage.", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + } + }, + "required": [ + "operatingSystem" + ], + "description": "Contains the os disk image information." + }, + "DataDiskImage": { + "properties": { + "lun": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM." + } + }, + "description": "Contains the data disk images information." + }, + "AutomaticOSUpgradeProperties": { + "properties": { + "automaticOSUpgradeSupported": { + "type": "boolean", + "description": "Specifies whether automatic OS upgrade is supported on the image." + } + }, + "required": [ + "automaticOSUpgradeSupported" + ], + "description": "Describes automatic OS upgrade properties on the image." + }, + "VirtualMachineImageProperties": { + "properties": { + "plan": { + "$ref": "#/definitions/PurchasePlan" + }, + "osDiskImage": { + "$ref": "#/definitions/OSDiskImage" + }, + "dataDiskImages": { + "type": "array", + "items": { + "$ref": "#/definitions/DataDiskImage" + } + }, + "automaticOSUpgradeProperties": { + "$ref": "#/definitions/AutomaticOSUpgradeProperties" + } + }, + "description": "Describes the properties of a Virtual Machine Image." + }, + "VirtualMachineImage": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineImageProperties" + } + }, + "required": [ + "name", + "location" + ], + "allOf": [ + { + "$ref": "#/definitions/VirtualMachineImageResource" + } + ], + "description": "Describes a Virtual Machine Image." + }, + "UsageName": { + "properties": { + "value": { + "type": "string", + "description": "The name of the resource." + }, + "localizedValue": { + "type": "string", + "description": "The localized name of the resource." + } + }, + "description": "The Usage Names." + }, + "Usage": { + "properties": { + "unit": { + "type": "string", + "description": "An enum describing the unit of usage measurement.", + "enum": [ + "Count" + ], + "x-ms-enum": { + "name": "UsageUnit", + "modelAsString": false + } + }, + "currentValue": { + "type": "integer", + "format": "int32", + "description": "The current usage of the resource." + }, + "limit": { + "type": "integer", + "format": "int64", + "description": "The maximum permitted usage of the resource." + }, + "name": { + "$ref": "#/definitions/UsageName", + "description": "The name of the type of usage." + } + }, + "required": [ + "unit", + "currentValue", + "limit", + "name" + ], + "description": "Describes Compute Resource Usage." + }, + "ListUsagesResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Usage" + }, + "description": "The list of compute resource usages." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of compute resource usage information. Call ListNext() with this to fetch the next page of compute resource usage information." + } + }, + "required": [ + "value" + ], + "description": "The List Usages operation response." + }, + "VirtualMachineReimageParameters": { + "properties": { + "tempDisk": { + "type": "boolean", + "description": "Specifies whether to reimage temp disk. Default value: false. Note: This temp disk reimage parameter is only supported for VM/VMSS with Ephemeral OS disk." + } + }, + "description": "Parameters for Reimaging Virtual Machine. NOTE: Virtual Machine OS disk will always be reimaged" + }, + "VirtualMachineCaptureParameters": { + "properties": { + "vhdPrefix": { + "type": "string", + "description": "The captured virtual hard disk's name prefix." + }, + "destinationContainerName": { + "type": "string", + "description": "The destination container name." + }, + "overwriteVhds": { + "type": "boolean", + "description": "Specifies whether to overwrite the destination virtual hard disk, in case of conflict." + } + }, + "required": [ + "vhdPrefix", + "destinationContainerName", + "overwriteVhds" + ], + "description": "Capture Virtual Machine parameters." + }, + "VirtualMachineCaptureResult": { + "properties": { + "$schema": { + "readOnly": true, + "type": "string", + "description": "the schema of the captured virtual machine" + }, + "contentVersion": { + "readOnly": true, + "type": "string", + "description": "the version of the content" + }, + "parameters": { + "readOnly": true, + "type": "object", + "description": "parameters of the captured virtual machine" + }, + "resources": { + "readOnly": true, + "type": "array", + "items": { + "type": "object", + "description": "resource item" + }, + "description": "a list of resource items of the captured virtual machine" + } + }, + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "Output of virtual machine capture operation." + }, + "Plan": { + "properties": { + "name": { + "type": "string", + "description": "The plan ID." + }, + "publisher": { + "type": "string", + "description": "The publisher ID." + }, + "product": { + "type": "string", + "description": "Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element." + }, + "promotionCode": { + "type": "string", + "description": "The promotion code." + } + }, + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "HardwareProfile": { + "properties": { + "vmSize": { + "type": "string", + "description": "Specifies the size of the virtual machine. For more information about virtual machine sizes, see [Sizes for virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-sizes?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

The available VM sizes depend on region and availability set. For a list of available sizes use these APIs:

[List all available virtual machine sizes in an availability set](https://docs.microsoft.com/rest/api/compute/availabilitysets/listavailablesizes)

[List all available virtual machine sizes in a region](https://docs.microsoft.com/rest/api/compute/virtualmachinesizes/list)

[List all available virtual machine sizes for resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes)", + "enum": [ + "Basic_A0", + "Basic_A1", + "Basic_A2", + "Basic_A3", + "Basic_A4", + "Standard_A0", + "Standard_A1", + "Standard_A2", + "Standard_A3", + "Standard_A4", + "Standard_A5", + "Standard_A6", + "Standard_A7", + "Standard_A8", + "Standard_A9", + "Standard_A10", + "Standard_A11", + "Standard_A1_v2", + "Standard_A2_v2", + "Standard_A4_v2", + "Standard_A8_v2", + "Standard_A2m_v2", + "Standard_A4m_v2", + "Standard_A8m_v2", + "Standard_B1s", + "Standard_B1ms", + "Standard_B2s", + "Standard_B2ms", + "Standard_B4ms", + "Standard_B8ms", + "Standard_D1", + "Standard_D2", + "Standard_D3", + "Standard_D4", + "Standard_D11", + "Standard_D12", + "Standard_D13", + "Standard_D14", + "Standard_D1_v2", + "Standard_D2_v2", + "Standard_D3_v2", + "Standard_D4_v2", + "Standard_D5_v2", + "Standard_D2_v3", + "Standard_D4_v3", + "Standard_D8_v3", + "Standard_D16_v3", + "Standard_D32_v3", + "Standard_D64_v3", + "Standard_D2s_v3", + "Standard_D4s_v3", + "Standard_D8s_v3", + "Standard_D16s_v3", + "Standard_D32s_v3", + "Standard_D64s_v3", + "Standard_D11_v2", + "Standard_D12_v2", + "Standard_D13_v2", + "Standard_D14_v2", + "Standard_D15_v2", + "Standard_DS1", + "Standard_DS2", + "Standard_DS3", + "Standard_DS4", + "Standard_DS11", + "Standard_DS12", + "Standard_DS13", + "Standard_DS14", + "Standard_DS1_v2", + "Standard_DS2_v2", + "Standard_DS3_v2", + "Standard_DS4_v2", + "Standard_DS5_v2", + "Standard_DS11_v2", + "Standard_DS12_v2", + "Standard_DS13_v2", + "Standard_DS14_v2", + "Standard_DS15_v2", + "Standard_DS13-4_v2", + "Standard_DS13-2_v2", + "Standard_DS14-8_v2", + "Standard_DS14-4_v2", + "Standard_E2_v3", + "Standard_E4_v3", + "Standard_E8_v3", + "Standard_E16_v3", + "Standard_E32_v3", + "Standard_E64_v3", + "Standard_E2s_v3", + "Standard_E4s_v3", + "Standard_E8s_v3", + "Standard_E16s_v3", + "Standard_E32s_v3", + "Standard_E64s_v3", + "Standard_E32-16_v3", + "Standard_E32-8s_v3", + "Standard_E64-32s_v3", + "Standard_E64-16s_v3", + "Standard_F1", + "Standard_F2", + "Standard_F4", + "Standard_F8", + "Standard_F16", + "Standard_F1s", + "Standard_F2s", + "Standard_F4s", + "Standard_F8s", + "Standard_F16s", + "Standard_F2s_v2", + "Standard_F4s_v2", + "Standard_F8s_v2", + "Standard_F16s_v2", + "Standard_F32s_v2", + "Standard_F64s_v2", + "Standard_F72s_v2", + "Standard_G1", + "Standard_G2", + "Standard_G3", + "Standard_G4", + "Standard_G5", + "Standard_GS1", + "Standard_GS2", + "Standard_GS3", + "Standard_GS4", + "Standard_GS5", + "Standard_GS4-8", + "Standard_GS4-4", + "Standard_GS5-16", + "Standard_GS5-8", + "Standard_H8", + "Standard_H16", + "Standard_H8m", + "Standard_H16m", + "Standard_H16r", + "Standard_H16mr", + "Standard_L4s", + "Standard_L8s", + "Standard_L16s", + "Standard_L32s", + "Standard_M64s", + "Standard_M64ms", + "Standard_M128s", + "Standard_M128ms", + "Standard_M64-32ms", + "Standard_M64-16ms", + "Standard_M128-64ms", + "Standard_M128-32ms", + "Standard_NC6", + "Standard_NC12", + "Standard_NC24", + "Standard_NC24r", + "Standard_NC6s_v2", + "Standard_NC12s_v2", + "Standard_NC24s_v2", + "Standard_NC24rs_v2", + "Standard_NC6s_v3", + "Standard_NC12s_v3", + "Standard_NC24s_v3", + "Standard_NC24rs_v3", + "Standard_ND6s", + "Standard_ND12s", + "Standard_ND24s", + "Standard_ND24rs", + "Standard_NV6", + "Standard_NV12", + "Standard_NV24" + ], + "x-ms-enum": { + "name": "VirtualMachineSizeTypes", + "modelAsString": true + } + } + }, + "description": "Specifies the hardware settings for the virtual machine." + }, + "ImageReference": { + "properties": { + "publisher": { + "type": "string", + "description": "The image publisher." + }, + "offer": { + "type": "string", + "description": "Specifies the offer of the platform image or marketplace image used to create the virtual machine." + }, + "sku": { + "type": "string", + "description": "The image SKU." + }, + "version": { + "type": "string", + "description": "Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available." + } + }, + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations." + }, + "KeyVaultSecretReference": { + "properties": { + "secretUrl": { + "type": "string", + "description": "The URL referencing a secret in a Key Vault." + }, + "sourceVault": { + "$ref": "#/definitions/SubResource", + "description": "The relative URL of the Key Vault containing the secret." + } + }, + "required": [ + "secretUrl", + "sourceVault" + ], + "description": "Describes a reference to Key Vault Secret" + }, + "KeyVaultKeyReference": { + "properties": { + "keyUrl": { + "type": "string", + "description": "The URL referencing a key encryption key in Key Vault." + }, + "sourceVault": { + "$ref": "#/definitions/SubResource", + "description": "The relative URL of the Key Vault containing the key." + } + }, + "required": [ + "keyUrl", + "sourceVault" + ], + "description": "Describes a reference to Key Vault Key" + }, + "DiskEncryptionSettings": { + "properties": { + "diskEncryptionKey": { + "$ref": "#/definitions/KeyVaultSecretReference", + "description": "Specifies the location of the disk encryption key, which is a Key Vault Secret." + }, + "keyEncryptionKey": { + "$ref": "#/definitions/KeyVaultKeyReference", + "description": "Specifies the location of the key encryption key in Key Vault." + }, + "enabled": { + "type": "boolean", + "description": "Specifies whether disk encryption should be enabled on the virtual machine." + } + }, + "description": "Describes a Encryption Settings for a Disk" + }, + "VirtualHardDisk": { + "properties": { + "uri": { + "type": "string", + "description": "Specifies the virtual hard disk's uri." + } + }, + "description": "Describes the uri of a disk." + }, + "Caching": { + "type": "string", + "description": "Specifies the caching requirements.

Possible values are:

**None**

**ReadOnly**

**ReadWrite**

Default: **None for Standard storage. ReadOnly for Premium storage**", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ], + "x-ms-enum": { + "name": "CachingTypes", + "modelAsString": false + } + }, + "CreateOption": { + "type": "string", + "description": "Specifies how the virtual machine should be created.

Possible values are:

**Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.

**FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described.", + "enum": [ + "FromImage", + "Empty", + "Attach" + ], + "x-ms-enum": { + "name": "DiskCreateOptionTypes", + "modelAsString": true + } + }, + "StorageAccountType": { + "type": "string", + "description": "Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS", + "UltraSSD_LRS" + ], + "x-ms-enum": { + "name": "StorageAccountTypes", + "modelAsString": true + } + }, + "DiffDiskOption": { + "type": "string", + "description": "Specifies the ephemeral disk option for operating system disk.", + "enum": [ + "Local" + ], + "x-ms-enum": { + "name": "DiffDiskOptions", + "modelAsString": true + } + }, + "DiffDiskSettings": { + "properties": { + "option": { + "$ref": "#/definitions/DiffDiskOption", + "description": "Specifies the ephemeral disk settings for operating system disk." + } + }, + "description": "Describes the parameters of ephemeral disk settings that can be specified for operating system disk.

NOTE: The ephemeral disk settings can only be specified for managed disk." + }, + "ManagedDiskParameters": { + "properties": { + "storageAccountType": { + "$ref": "#/definitions/StorageAccountType", + "description": "Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk." + } + }, + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "The parameters of a managed disk." + }, + "OSDisk": { + "properties": { + "osType": { + "type": "string", + "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD.

Possible values are:

**Windows**

**Linux**", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + }, + "encryptionSettings": { + "$ref": "#/definitions/DiskEncryptionSettings", + "description": "Specifies the encryption settings for the OS Disk.

Minimum api-version: 2015-06-15" + }, + "name": { + "type": "string", + "description": "The disk name." + }, + "vhd": { + "$ref": "#/definitions/VirtualHardDisk", + "description": "The virtual hard disk." + }, + "image": { + "$ref": "#/definitions/VirtualHardDisk", + "description": "The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist." + }, + "caching": { + "$ref": "#/definitions/Caching", + "description": "Specifies the caching requirements.

Possible values are:

**None**

**ReadOnly**

**ReadWrite**

Default: **None for Standard storage. ReadOnly for Premium storage**" + }, + "writeAcceleratorEnabled": { + "type": "boolean", + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + }, + "diffDiskSettings": { + "$ref": "#/definitions/DiffDiskSettings", + "description": "Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine." + }, + "createOption": { + "$ref": "#/definitions/CreateOption", + "description": "Specifies how the virtual machine should be created.

Possible values are:

**Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.

**FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

This value cannot be larger than 1023 GB" + }, + "managedDisk": { + "description": "The managed disk parameters.", + "$ref": "#/definitions/ManagedDiskParameters" + } + }, + "required": [ + "createOption" + ], + "description": "Specifies information about the operating system disk used by the virtual machine.

For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + }, + "DataDisk": { + "properties": { + "lun": { + "type": "integer", + "format": "int32", + "description": "Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM." + }, + "name": { + "type": "string", + "description": "The disk name." + }, + "vhd": { + "$ref": "#/definitions/VirtualHardDisk", + "description": "The virtual hard disk." + }, + "image": { + "$ref": "#/definitions/VirtualHardDisk", + "description": "The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist." + }, + "caching": { + "$ref": "#/definitions/Caching", + "description": "Specifies the caching requirements.

Possible values are:

**None**

**ReadOnly**

**ReadWrite**

Default: **None for Standard storage. ReadOnly for Premium storage**" + }, + "writeAcceleratorEnabled": { + "type": "boolean", + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + }, + "createOption": { + "$ref": "#/definitions/CreateOption", + "description": "Specifies how the virtual machine should be created.

Possible values are:

**Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.

**FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

This value cannot be larger than 1023 GB" + }, + "managedDisk": { + "description": "The managed disk parameters.", + "$ref": "#/definitions/ManagedDiskParameters" + }, + "toBeDetached": { + "type": "boolean", + "description": "Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset" + } + }, + "required": [ + "lun", + "createOption" + ], + "description": "Describes a data disk." + }, + "StorageProfile": { + "properties": { + "imageReference": { + "$ref": "#/definitions/ImageReference", + "description": "Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations." + }, + "osDisk": { + "$ref": "#/definitions/OSDisk", + "description": "Specifies information about the operating system disk used by the virtual machine.

For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + }, + "dataDisks": { + "type": "array", + "items": { + "$ref": "#/definitions/DataDisk" + }, + "description": "Specifies the parameters that are used to add a data disk to a virtual machine.

For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + } + }, + "description": "Specifies the storage settings for the virtual machine disks." + }, + "AdditionalCapabilities": { + "properties": { + "ultraSSDEnabled": { + "type": "boolean", + "description": "The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled." + } + }, + "description": "Enables or disables a capability on the virtual machine or virtual machine scale set." + }, + "AdditionalUnattendContent": { + "properties": { + "passName": { + "type": "string", + "description": "The pass name. Currently, the only allowable value is OobeSystem.", + "enum": [ + "OobeSystem" + ], + "x-ms-enum": { + "name": "PassNames", + "modelAsString": false + } + }, + "componentName": { + "type": "string", + "description": "The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup.", + "enum": [ + "Microsoft-Windows-Shell-Setup" + ], + "x-ms-enum": { + "name": "ComponentNames", + "modelAsString": false + } + }, + "settingName": { + "type": "string", + "description": "Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.", + "enum": [ + "AutoLogon", + "FirstLogonCommands" + ], + "x-ms-enum": { + "name": "SettingNames", + "modelAsString": false + } + }, + "content": { + "type": "string", + "description": "Specifies the XML formatted content that is added to the unattend.xml file for the specified path and component. The XML must be less than 4KB and must include the root element for the setting or feature that is being inserted." + } + }, + "description": "Specifies additional XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. Contents are defined by setting name, component name, and the pass in which the content is applied." + }, + "WinRMListener": { + "properties": { + "protocol": { + "type": "string", + "description": "Specifies the protocol of listener.

Possible values are:
**http**

**https**", + "enum": [ + "Http", + "Https" + ], + "x-ms-enum": { + "name": "ProtocolTypes", + "modelAsString": false + } + }, + "certificateUrl": { + "type": "string", + "description": "This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
\"data\":\"\",
\"dataType\":\"pfx\",
\"password\":\"\"
}" + } + }, + "description": "Describes Protocol and thumbprint of Windows Remote Management listener" + }, + "WinRMConfiguration": { + "properties": { + "listeners": { + "type": "array", + "items": { + "$ref": "#/definitions/WinRMListener" + }, + "description": "The list of Windows Remote Management listeners" + } + }, + "description": "Describes Windows Remote Management configuration of the VM" + }, + "WindowsConfiguration": { + "properties": { + "provisionVMAgent": { + "type": "boolean", + "description": "Indicates whether virtual machine agent should be provisioned on the virtual machine.

When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later." + }, + "enableAutomaticUpdates": { + "type": "boolean", + "description": "Indicates whether Automatic Updates is enabled for the Windows virtual machine. Default value is true.

For virtual machine scale sets, this property can be updated and updates will take effect on OS reprovisioning." + }, + "timeZone": { + "type": "string", + "description": "Specifies the time zone of the virtual machine. e.g. \"Pacific Standard Time\"" + }, + "additionalUnattendContent": { + "type": "array", + "items": { + "$ref": "#/definitions/AdditionalUnattendContent" + }, + "description": "Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup." + }, + "winRM": { + "$ref": "#/definitions/WinRMConfiguration", + "description": "Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell." + } + }, + "description": "Specifies Windows operating system settings on the virtual machine." + }, + "SshPublicKey": { + "properties": { + "path": { + "type": "string", + "description": "Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys" + }, + "keyData": { + "type": "string", + "description": "SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format.

For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-mac-create-ssh-keys?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." + } + }, + "description": "Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed." + }, + "SshConfiguration": { + "properties": { + "publicKeys": { + "type": "array", + "items": { + "$ref": "#/definitions/SshPublicKey" + }, + "description": "The list of SSH public keys used to authenticate with linux based VMs." + } + }, + "description": "SSH configuration for Linux based VMs running on Azure" + }, + "LinuxConfiguration": { + "properties": { + "disablePasswordAuthentication": { + "type": "boolean", + "description": "Specifies whether password authentication should be disabled." + }, + "ssh": { + "$ref": "#/definitions/SshConfiguration", + "description": "Specifies the ssh key configuration for a Linux OS." + }, + "provisionVMAgent": { + "type": "boolean", + "description": "Indicates whether virtual machine agent should be provisioned on the virtual machine.

When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later." + } + }, + "description": "Specifies the Linux operating system settings on the virtual machine.

For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)

For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." + }, + "VaultCertificate": { + "properties": { + "certificateUrl": { + "type": "string", + "description": "This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
\"data\":\"\",
\"dataType\":\"pfx\",
\"password\":\"\"
}" + }, + "certificateStore": { + "type": "string", + "description": "For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for private key. Both of these files are .pem formatted." + } + }, + "description": "Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM." + }, + "VaultSecretGroup": { + "properties": { + "sourceVault": { + "$ref": "#/definitions/SubResource", + "description": "The relative URL of the Key Vault containing all of the certificates in VaultCertificates." + }, + "vaultCertificates": { + "type": "array", + "items": { + "$ref": "#/definitions/VaultCertificate" + }, + "description": "The list of key vault references in SourceVault which contain certificates." + } + }, + "description": "Describes a set of certificates which are all in the same Key Vault." + }, + "OSProfile": { + "properties": { + "computerName": { + "type": "string", + "description": "Specifies the host OS name of the virtual machine.

This name cannot be updated after the VM is created.

**Max-length (Windows):** 15 characters

**Max-length (Linux):** 64 characters.

For naming conventions and restrictions see [Azure infrastructure services implementation guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions)." + }, + "adminUsername": { + "type": "string", + "description": "Specifies the name of the administrator account.

**Windows-only restriction:** Cannot end in \".\"

**Disallowed values:** \"administrator\", \"admin\", \"user\", \"user1\", \"test\", \"user2\", \"test1\", \"user3\", \"admin1\", \"1\", \"123\", \"a\", \"actuser\", \"adm\", \"admin2\", \"aspnet\", \"backup\", \"console\", \"david\", \"guest\", \"john\", \"owner\", \"root\", \"server\", \"sql\", \"support\", \"support_388945a0\", \"sys\", \"test2\", \"test3\", \"user4\", \"user5\".

**Minimum-length (Linux):** 1 character

**Max-length (Linux):** 64 characters

**Max-length (Windows):** 20 characters

  • For root access to the Linux VM, see [Using root privileges on Linux virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
  • For a list of built-in system users on Linux that should not be used in this field, see [Selecting User Names for Linux on Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" + }, + "adminPassword": { + "type": "string", + "description": "Specifies the password of the administrator account.

    **Minimum-length (Windows):** 8 characters

    **Minimum-length (Linux):** 6 characters

    **Max-length (Windows):** 123 characters

    **Max-length (Linux):** 72 characters

    **Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
    Has lower characters
    Has upper characters
    Has a digit
    Has a special character (Regex match [\\W_])

    **Disallowed values:** \"abc@123\", \"P@$$w0rd\", \"P@ssw0rd\", \"P@ssword123\", \"Pa$$word\", \"pass@word1\", \"Password!\", \"Password1\", \"Password22\", \"iloveyou!\"

    For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password)" + }, + "customData": { + "type": "string", + "description": "Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes.

    For using cloud-init for your VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" + }, + "windowsConfiguration": { + "$ref": "#/definitions/WindowsConfiguration", + "description": "Specifies Windows operating system settings on the virtual machine." + }, + "linuxConfiguration": { + "$ref": "#/definitions/LinuxConfiguration", + "description": "Specifies the Linux operating system settings on the virtual machine.

    For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)

    For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." + }, + "secrets": { + "type": "array", + "items": { + "$ref": "#/definitions/VaultSecretGroup" + }, + "description": "Specifies set of certificates that should be installed onto the virtual machine." + }, + "allowExtensionOperations": { + "type": "boolean", + "description": "Specifies whether extension operations should be allowed on the virtual machine.

    This may only be set to False when no extensions are present on the virtual machine." + } + }, + "description": "Specifies the operating system settings for the virtual machine." + }, + "NetworkInterfaceReferenceProperties": { + "properties": { + "primary": { + "type": "boolean", + "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." + } + }, + "description": "Describes a network interface reference properties." + }, + "NetworkInterfaceReference": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkInterfaceReferenceProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "Describes a network interface reference." + }, + "NetworkProfile": { + "properties": { + "networkInterfaces": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkInterfaceReference" + }, + "description": "Specifies the list of resource Ids for the network interfaces associated with the virtual machine." + } + }, + "description": "Specifies the network interfaces of the virtual machine." + }, + "BootDiagnostics": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether boot diagnostics should be enabled on the Virtual Machine." + }, + "storageUri": { + "type": "string", + "description": "Uri of the storage account to use for placing the console output and screenshot." + } + }, + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    You can easily view the output of your console log.

    Azure also enables you to see a screenshot of the VM from the hypervisor." + }, + "DiagnosticsProfile": { + "properties": { + "bootDiagnostics": { + "$ref": "#/definitions/BootDiagnostics", + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    You can easily view the output of your console log.

    Azure also enables you to see a screenshot of the VM from the hypervisor." + } + }, + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." + }, + "VirtualMachineExtensionHandlerInstanceView": { + "properties": { + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + }, + "status": { + "$ref": "#/definitions/InstanceViewStatus", + "description": "The extension handler status." + } + }, + "description": "The instance view of a virtual machine extension handler." + }, + "VirtualMachineAgentInstanceView": { + "properties": { + "vmAgentVersion": { + "type": "string", + "description": "The VM Agent full version." + }, + "extensionHandlers": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtensionHandlerInstanceView" + }, + "description": "The virtual machine extension handler instance view." + }, + "statuses": { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "The resource status information." + } + }, + "description": "The instance view of the VM Agent running on the virtual machine." + }, + "DiskInstanceView": { + "properties": { + "name": { + "type": "string", + "description": "The disk name." + }, + "encryptionSettings": { + "type": "array", + "items": { + "$ref": "#/definitions/DiskEncryptionSettings" + }, + "description": "Specifies the encryption settings for the OS Disk.

    Minimum api-version: 2015-06-15" + }, + "statuses": { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "The resource status information." + } + }, + "description": "The instance view of the disk." + }, + "BootDiagnosticsInstanceView": { + "properties": { + "consoleScreenshotBlobUri": { + "readOnly": true, + "type": "string", + "description": "The console screenshot blob URI." + }, + "serialConsoleLogBlobUri": { + "readOnly": true, + "type": "string", + "description": "The Linux serial console log blob Uri." + }, + "status": { + "readOnly": true, + "$ref": "#/definitions/InstanceViewStatus", + "description": "The boot diagnostics status information for the VM.

    NOTE: It will be set only if there are errors encountered in enabling boot diagnostics." + } + }, + "description": "The instance view of a virtual machine boot diagnostics." + }, + "VirtualMachineIdentity": { + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of virtual machine identity. This property will only be provided for a system assigned identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity." + }, + "type": { + "type": "string", + "description": "The type of identity used for the virtual machine. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + }, + "userAssignedIdentities": { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of user assigned identity." + }, + "clientId": { + "readOnly": true, + "type": "string", + "description": "The client id of user assigned identity." + } + } + }, + "description": "The list of user identities associated with the Virtual Machine. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'." + } + }, + "description": "Identity for the virtual machine." + }, + "MaintenanceRedeployStatus": { + "properties": { + "isCustomerInitiatedMaintenanceAllowed": { + "type": "boolean", + "description": "True, if customer is allowed to perform Maintenance." + }, + "preMaintenanceWindowStartTime": { + "type": "string", + "format": "date-time", + "description": "Start Time for the Pre Maintenance Window." + }, + "preMaintenanceWindowEndTime": { + "type": "string", + "format": "date-time", + "description": "End Time for the Pre Maintenance Window." + }, + "maintenanceWindowStartTime": { + "type": "string", + "format": "date-time", + "description": "Start Time for the Maintenance Window." + }, + "maintenanceWindowEndTime": { + "type": "string", + "format": "date-time", + "description": "End Time for the Maintenance Window." + }, + "lastOperationResultCode": { + "type": "string", + "description": "The Last Maintenance Operation Result Code.", + "enum": [ + "None", + "RetryLater", + "MaintenanceAborted", + "MaintenanceCompleted" + ], + "x-ms-enum": { + "name": "MaintenanceOperationResultCodeTypes", + "modelAsString": false + } + }, + "lastOperationMessage": { + "type": "string", + "description": "Message returned for the last Maintenance Operation." + } + }, + "description": "Maintenance Operation Status." + }, + "VirtualMachineInstanceView": { + "properties": { + "platformUpdateDomain": { + "type": "integer", + "format": "int32", + "description": "Specifies the update domain of the virtual machine." + }, + "platformFaultDomain": { + "type": "integer", + "format": "int32", + "description": "Specifies the fault domain of the virtual machine." + }, + "computerName": { + "type": "string", + "description": "The computer name assigned to the virtual machine." + }, + "osName": { + "type": "string", + "description": "The Operating System running on the virtual machine." + }, + "osVersion": { + "type": "string", + "description": "The version of Operating System running on the virtual machine." + }, + "hyperVGeneration": { + "type": "string", + "description": "Specifies the HyperVGeneration Type associated with a resource", + "enum": [ + "V1", + "V2" + ], + "x-ms-enum": { + "name": "HyperVGenerationType", + "modelAsString": true + } + }, + "rdpThumbPrint": { + "type": "string", + "description": "The Remote desktop certificate thumbprint." + }, + "vmAgent": { + "$ref": "#/definitions/VirtualMachineAgentInstanceView", + "description": "The VM Agent running on the virtual machine." + }, + "maintenanceRedeployStatus": { + "$ref": "#/definitions/MaintenanceRedeployStatus", + "description": "The Maintenance Operation status on the virtual machine." + }, + "disks": { + "type": "array", + "items": { + "$ref": "#/definitions/DiskInstanceView" + }, + "description": "The virtual machine disk information." + }, + "extensions": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtensionInstanceView" + }, + "description": "The extensions information." + }, + "bootDiagnostics": { + "$ref": "#/definitions/BootDiagnosticsInstanceView", + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    You can easily view the output of your console log.

    Azure also enables you to see a screenshot of the VM from the hypervisor." + }, + "statuses": { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "The resource status information." + } + }, + "description": "The instance view of a virtual machine." + }, + "VirtualMachineProperties": { + "properties": { + "hardwareProfile": { + "$ref": "#/definitions/HardwareProfile", + "description": "Specifies the hardware settings for the virtual machine." + }, + "storageProfile": { + "$ref": "#/definitions/StorageProfile", + "description": "Specifies the storage settings for the virtual machine disks." + }, + "additionalCapabilities": { + "$ref": "#/definitions/AdditionalCapabilities", + "description": "Specifies additional capabilities enabled or disabled on the virtual machine." + }, + "osProfile": { + "$ref": "#/definitions/OSProfile", + "description": "Specifies the operating system settings for the virtual machine." + }, + "networkProfile": { + "$ref": "#/definitions/NetworkProfile", + "description": "Specifies the network interfaces of the virtual machine." + }, + "diagnosticsProfile": { + "$ref": "#/definitions/DiagnosticsProfile", + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." + }, + "availabilitySet": { + "$ref": "#/definitions/SubResource", + "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

    For more information on Azure planned maintenance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." + }, + "proximityPlacementGroup": { + "$ref": "#/definitions/SubResource", + "description": "Specifies information about the proximity placement group that the virtual machine should be assigned to.

    Minimum api-version: 2018-04-01." + }, + "host": { + "$ref": "#/definitions/SubResource", + "description": "Specifies information about the dedicated host that the virtual machine resides in.

    Minimum api-version: 2018-10-01." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + }, + "instanceView": { + "$ref": "#/definitions/VirtualMachineInstanceView", + "readOnly": true, + "description": "The virtual machine instance view." + }, + "licenseType": { + "type": "string", + "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" + }, + "vmId": { + "readOnly": true, + "type": "string", + "description": "Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands." + } + }, + "description": "Describes the properties of a Virtual Machine." + }, + "VirtualMachine": { + "properties": { + "plan": { + "$ref": "#/definitions/Plan", + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineProperties" + }, + "resources": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtension" + }, + "description": "The virtual machine child extension resources." + }, + "identity": { + "$ref": "#/definitions/VirtualMachineIdentity", + "description": "The identity of the virtual machine, if configured." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The virtual machine zones." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Describes a Virtual Machine." + }, + "VirtualMachineUpdate": { + "properties": { + "plan": { + "$ref": "#/definitions/Plan", + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineProperties" + }, + "identity": { + "$ref": "#/definitions/VirtualMachineIdentity", + "description": "The identity of the virtual machine, if configured." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The virtual machine zones." + } + }, + "allOf": [ + { + "$ref": "#/definitions/UpdateResource" + } + ], + "description": "Describes a Virtual Machine Update." + }, + "VirtualMachineListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachine" + }, + "description": "The list of virtual machines." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of VMs. Call ListNext() with this URI to fetch the next page of Virtual Machines." + } + }, + "required": [ + "value" + ], + "description": "The List Virtual Machine operation response." + }, + "Sku": { + "properties": { + "name": { + "type": "string", + "description": "The sku name." + }, + "tier": { + "type": "string", + "description": "Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic**" + }, + "capacity": { + "type": "integer", + "format": "int64", + "description": "Specifies the number of virtual machines in the scale set." + } + }, + "description": "Describes a virtual machine scale set sku." + }, + "AutomaticOSUpgradePolicy": { + "properties": { + "enableAutomaticOSUpgrade": { + "type": "boolean", + "description": "Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available. Default value is false.

    If this is set to true for Windows based scale sets, [enableAutomaticUpdates](https://docs.microsoft.com/dotnet/api/microsoft.azure.management.compute.models.windowsconfiguration.enableautomaticupdates?view=azure-dotnet) is automatically set to false and cannot be set to true." + }, + "disableAutomaticRollback": { + "type": "boolean", + "description": "Whether OS image rollback feature should be disabled. Default value is false." + } + }, + "description": "The configuration parameters used for performing automatic OS upgrade." + }, + "UpgradePolicy": { + "properties": { + "mode": { + "type": "string", + "description": "Specifies the mode of an upgrade to virtual machines in the scale set.

    Possible values are:

    **Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.

    **Automatic** - All virtual machines in the scale set are automatically updated at the same time.", + "enum": [ + "Automatic", + "Manual", + "Rolling" + ], + "x-ms-enum": { + "name": "UpgradeMode", + "modelAsString": false + } + }, + "rollingUpgradePolicy": { + "$ref": "#/definitions/RollingUpgradePolicy", + "description": "The configuration parameters used while performing a rolling upgrade." + }, + "automaticOSUpgradePolicy": { + "$ref": "#/definitions/AutomaticOSUpgradePolicy", + "description": "Configuration parameters used for performing automatic OS Upgrade." + } + }, + "description": "Describes an upgrade policy - automatic, manual, or rolling." + }, + "RollingUpgradePolicy": { + "properties": { + "maxBatchInstancePercent": { + "type": "integer", + "format": "int32", + "minimum": 5, + "maximum": 100, + "description": "The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The default value for this parameter is 20%." + }, + "maxUnhealthyInstancePercent": { + "type": "integer", + "format": "int32", + "minimum": 5, + "maximum": 100, + "description": "The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The default value for this parameter is 20%." + }, + "maxUnhealthyUpgradedInstancePercent": { + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 100, + "description": "The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The default value for this parameter is 20%." + }, + "pauseTimeBetweenBatches": { + "type": "string", + "description": "The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. The default value is 0 seconds (PT0S)." + } + }, + "description": "The configuration parameters used while performing a rolling upgrade." + }, + "ImageOSDisk": { + "properties": { + "osType": { + "type": "string", + "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image.

    Possible values are:

    **Windows**

    **Linux**", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + }, + "osState": { + "type": "string", + "description": "The OS State.", + "enum": [ + "Generalized", + "Specialized" + ], + "x-ms-enum": { + "name": "OperatingSystemStateTypes", + "modelAsString": false + } + }, + "snapshot": { + "$ref": "#/definitions/SubResource", + "description": "The snapshot." + }, + "managedDisk": { + "$ref": "#/definitions/SubResource", + "description": "The managedDisk." + }, + "blobUri": { + "type": "string", + "description": "The Virtual Hard Disk." + }, + "caching": { + "type": "string", + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ], + "x-ms-enum": { + "name": "CachingTypes", + "modelAsString": false + } + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" + }, + "storageAccountType": { + "$ref": "#/definitions/StorageAccountType", + "description": "Specifies the storage account type for the managed disk. UltraSSD_LRS cannot be used with OS Disk." + } + }, + "required": [ + "osType", + "osState" + ], + "description": "Describes an Operating System disk." + }, + "ImageDataDisk": { + "properties": { + "lun": { + "type": "integer", + "format": "int32", + "description": "Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM." + }, + "snapshot": { + "$ref": "#/definitions/SubResource", + "description": "The snapshot." + }, + "managedDisk": { + "$ref": "#/definitions/SubResource", + "description": "The managedDisk." + }, + "blobUri": { + "type": "string", + "description": "The Virtual Hard Disk." + }, + "caching": { + "type": "string", + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ], + "x-ms-enum": { + "name": "CachingTypes", + "modelAsString": false + } + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" + }, + "storageAccountType": { + "$ref": "#/definitions/StorageAccountType", + "description": "Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk." + } + }, + "required": [ + "lun" + ], + "description": "Describes a data disk." + }, + "ImageStorageProfile": { + "properties": { + "osDisk": { + "$ref": "#/definitions/ImageOSDisk", + "description": "Specifies information about the operating system disk used by the virtual machine.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + }, + "dataDisks": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageDataDisk" + }, + "description": "Specifies the parameters that are used to add a data disk to a virtual machine.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + }, + "zoneResilient": { + "type": "boolean", + "description": "Specifies whether an image is zone resilient or not. Default is false. Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS)." + } + }, + "description": "Describes a storage profile." + }, + "ImageProperties": { + "properties": { + "sourceVirtualMachine": { + "$ref": "#/definitions/SubResource", + "description": "The source virtual machine from which Image is created." + }, + "storageProfile": { + "$ref": "#/definitions/ImageStorageProfile", + "description": "Specifies the storage settings for the virtual machine disks." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state." + }, + "hyperVGeneration": { + "$ref": "#/definitions/HyperVGenerationType", + "description": "Gets the HyperVGenerationType of the VirtualMachine created from the image" + } + }, + "description": "Describes the properties of an Image." + }, + "Image": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ImageProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist." + }, + "ImageUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ImageProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/UpdateResource" + } + ], + "description": "The source user image virtual hard disk. Only tags may be updated." + }, + "ImageListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Image" + }, + "description": "The list of Images." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of Images. Call ListNext() with this to fetch the next page of Images." + } + }, + "required": [ + "value" + ], + "description": "The List Image operation response." + }, + "VirtualMachineScaleSetIdentity": { + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of virtual machine scale set identity. This property will only be provided for a system assigned identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id associated with the virtual machine scale set. This property will only be provided for a system assigned identity." + }, + "type": { + "type": "string", + "description": "The type of identity used for the virtual machine scale set. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine scale set.", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + }, + "userAssignedIdentities": { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of user assigned identity." + }, + "clientId": { + "readOnly": true, + "type": "string", + "description": "The client id of user assigned identity." + } + } + }, + "description": "The list of user identities associated with the virtual machine scale set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'." + } + }, + "description": "Identity for the virtual machine scale set." + }, + "VirtualMachineScaleSetOSProfile": { + "properties": { + "computerNamePrefix": { + "type": "string", + "description": "Specifies the computer name prefix for all of the virtual machines in the scale set. Computer name prefixes must be 1 to 15 characters long." + }, + "adminUsername": { + "type": "string", + "description": "Specifies the name of the administrator account.

    **Windows-only restriction:** Cannot end in \".\"

    **Disallowed values:** \"administrator\", \"admin\", \"user\", \"user1\", \"test\", \"user2\", \"test1\", \"user3\", \"admin1\", \"1\", \"123\", \"a\", \"actuser\", \"adm\", \"admin2\", \"aspnet\", \"backup\", \"console\", \"david\", \"guest\", \"john\", \"owner\", \"root\", \"server\", \"sql\", \"support\", \"support_388945a0\", \"sys\", \"test2\", \"test3\", \"user4\", \"user5\".

    **Minimum-length (Linux):** 1 character

    **Max-length (Linux):** 64 characters

    **Max-length (Windows):** 20 characters

  • For root access to the Linux VM, see [Using root privileges on Linux virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
  • For a list of built-in system users on Linux that should not be used in this field, see [Selecting User Names for Linux on Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" + }, + "adminPassword": { + "type": "string", + "description": "Specifies the password of the administrator account.

    **Minimum-length (Windows):** 8 characters

    **Minimum-length (Linux):** 6 characters

    **Max-length (Windows):** 123 characters

    **Max-length (Linux):** 72 characters

    **Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
    Has lower characters
    Has upper characters
    Has a digit
    Has a special character (Regex match [\\W_])

    **Disallowed values:** \"abc@123\", \"P@$$w0rd\", \"P@ssw0rd\", \"P@ssword123\", \"Pa$$word\", \"pass@word1\", \"Password!\", \"Password1\", \"Password22\", \"iloveyou!\"

    For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password)" + }, + "customData": { + "type": "string", + "description": "Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes.

    For using cloud-init for your VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" + }, + "windowsConfiguration": { + "$ref": "#/definitions/WindowsConfiguration", + "description": "Specifies Windows operating system settings on the virtual machine." + }, + "linuxConfiguration": { + "$ref": "#/definitions/LinuxConfiguration", + "description": "Specifies the Linux operating system settings on the virtual machine.

    For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)

    For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." + }, + "secrets": { + "type": "array", + "items": { + "$ref": "#/definitions/VaultSecretGroup" + }, + "description": "Specifies set of certificates that should be installed onto the virtual machines in the scale set." + } + }, + "description": "Describes a virtual machine scale set OS profile." + }, + "VirtualMachineScaleSetUpdateOSProfile": { + "properties": { + "customData": { + "type": "string", + "description": "A base-64 encoded string of custom data." + }, + "windowsConfiguration": { + "$ref": "#/definitions/WindowsConfiguration", + "description": "The Windows Configuration of the OS profile." + }, + "linuxConfiguration": { + "$ref": "#/definitions/LinuxConfiguration", + "description": "The Linux Configuration of the OS profile." + }, + "secrets": { + "type": "array", + "items": { + "$ref": "#/definitions/VaultSecretGroup" + }, + "description": "The List of certificates for addition to the VM." + } + }, + "description": "Describes a virtual machine scale set OS profile." + }, + "VirtualMachineScaleSetManagedDiskParameters": { + "properties": { + "storageAccountType": { + "$ref": "#/definitions/StorageAccountType", + "description": "Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk." + } + }, + "description": "Describes the parameters of a ScaleSet managed disk." + }, + "VirtualMachineScaleSetOSDisk": { + "properties": { + "name": { + "type": "string", + "description": "The disk name." + }, + "caching": { + "$ref": "#/definitions/Caching", + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**" + }, + "writeAcceleratorEnabled": { + "type": "boolean", + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + }, + "createOption": { + "$ref": "#/definitions/CreateOption", + "description": "Specifies how the virtual machines in the scale set should be created.

    The only allowed value is: **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." + }, + "diffDiskSettings": { + "$ref": "#/definitions/DiffDiskSettings", + "description": "Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Specifies the size of the operating system disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" + }, + "osType": { + "type": "string", + "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD.

    Possible values are:

    **Windows**

    **Linux**", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + }, + "image": { + "$ref": "#/definitions/VirtualHardDisk", + "description": "Specifies information about the unmanaged user image to base the scale set on." + }, + "vhdContainers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Specifies the container urls that are used to store operating system disks for the scale set." + }, + "managedDisk": { + "description": "The managed disk parameters.", + "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" + } + }, + "required": [ + "createOption" + ], + "description": "Describes a virtual machine scale set operating system disk." + }, + "VirtualMachineScaleSetUpdateOSDisk": { + "properties": { + "caching": { + "$ref": "#/definitions/Caching", + "description": "The caching type." + }, + "writeAcceleratorEnabled": { + "type": "boolean", + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Specifies the size of the operating system disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" + }, + "image": { + "$ref": "#/definitions/VirtualHardDisk", + "description": "The Source User Image VirtualHardDisk. This VirtualHardDisk will be copied before using it to attach to the Virtual Machine. If SourceImage is provided, the destination VirtualHardDisk should not exist." + }, + "vhdContainers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of virtual hard disk container uris." + }, + "managedDisk": { + "description": "The managed disk parameters.", + "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" + } + }, + "description": "Describes virtual machine scale set operating system disk Update Object. This should be used for Updating VMSS OS Disk." + }, + "VirtualMachineScaleSetDataDisk": { + "properties": { + "name": { + "type": "string", + "description": "The disk name." + }, + "lun": { + "type": "integer", + "format": "int32", + "description": "Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM." + }, + "caching": { + "$ref": "#/definitions/Caching", + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**" + }, + "writeAcceleratorEnabled": { + "type": "boolean", + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + }, + "createOption": { + "$ref": "#/definitions/CreateOption", + "description": "The create option." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" + }, + "managedDisk": { + "description": "The managed disk parameters.", + "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" + } + }, + "required": [ + "lun", + "createOption" + ], + "description": "Describes a virtual machine scale set data disk." + }, + "VirtualMachineScaleSetStorageProfile": { + "properties": { + "imageReference": { + "$ref": "#/definitions/ImageReference", + "description": "Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations." + }, + "osDisk": { + "$ref": "#/definitions/VirtualMachineScaleSetOSDisk", + "description": "Specifies information about the operating system disk used by the virtual machines in the scale set.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + }, + "dataDisks": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetDataDisk" + }, + "description": "Specifies the parameters that are used to add data disks to the virtual machines in the scale set.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + } + }, + "description": "Describes a virtual machine scale set storage profile." + }, + "VirtualMachineScaleSetUpdateStorageProfile": { + "properties": { + "imageReference": { + "$ref": "#/definitions/ImageReference", + "description": "The image reference." + }, + "osDisk": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdateOSDisk", + "description": "The OS disk." + }, + "dataDisks": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetDataDisk" + }, + "description": "The data disks." + } + }, + "description": "Describes a virtual machine scale set storage profile." + }, + "ApiEntityReference": { + "properties": { + "id": { + "type": "string", + "description": "The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/..." + } + }, + "description": "The API entity reference." + }, + "VirtualMachineScaleSetIPConfigurationProperties": { + "properties": { + "subnet": { + "$ref": "#/definitions/ApiEntityReference", + "description": "Specifies the identifier of the subnet." + }, + "primary": { + "type": "boolean", + "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." + }, + "publicIPAddressConfiguration": { + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfiguration", + "description": "The publicIPAddressConfiguration." + }, + "privateIPAddressVersion": { + "type": "string", + "description": "Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.", + "enum": [ + "IPv4", + "IPv6" + ], + "x-ms-enum": { + "name": "IPVersion", + "modelAsString": true + } + }, + "applicationGatewayBackendAddressPools": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "description": "Specifies an array of references to backend address pools of application gateways. A scale set can reference backend address pools of multiple application gateways. Multiple scale sets cannot use the same application gateway." + }, + "applicationSecurityGroups": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "description": "Specifies an array of references to application security group." + }, + "loadBalancerBackendAddressPools": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "description": "Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same load balancer." + }, + "loadBalancerInboundNatPools": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "description": "Specifies an array of references to inbound Nat pools of the load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same load balancer" + } + }, + "description": "Describes a virtual machine scale set network profile's IP configuration properties." + }, + "VirtualMachineScaleSetUpdateIPConfigurationProperties": { + "properties": { + "subnet": { + "$ref": "#/definitions/ApiEntityReference", + "description": "The subnet." + }, + "primary": { + "type": "boolean", + "description": "Specifies the primary IP Configuration in case the network interface has more than one IP Configuration." + }, + "publicIPAddressConfiguration": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdatePublicIPAddressConfiguration", + "description": "The publicIPAddressConfiguration." + }, + "privateIPAddressVersion": { + "type": "string", + "description": "Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.", + "enum": [ + "IPv4", + "IPv6" + ], + "x-ms-enum": { + "name": "IPVersion", + "modelAsString": true + } + }, + "applicationGatewayBackendAddressPools": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "description": "The application gateway backend address pools." + }, + "applicationSecurityGroups": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "description": "Specifies an array of references to application security group." + }, + "loadBalancerBackendAddressPools": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "description": "The load balancer backend address pools." + }, + "loadBalancerInboundNatPools": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "description": "The load balancer inbound nat pools." + } + }, + "description": "Describes a virtual machine scale set network profile's IP configuration properties." + }, + "VirtualMachineScaleSetIPConfiguration": { + "properties": { + "name": { + "type": "string", + "description": "The IP configuration name." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetIPConfigurationProperties" + } + }, + "required": [ + "name" + ], + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "Describes a virtual machine scale set network profile's IP configuration." + }, + "VirtualMachineScaleSetUpdateIPConfiguration": { + "properties": { + "name": { + "type": "string", + "description": "The IP configuration name." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetUpdateIPConfigurationProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "Describes a virtual machine scale set network profile's IP configuration." + }, + "VirtualMachineScaleSetNetworkConfigurationProperties": { + "properties": { + "primary": { + "type": "boolean", + "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." + }, + "enableAcceleratedNetworking": { + "type": "boolean", + "description": "Specifies whether the network interface is accelerated networking-enabled." + }, + "networkSecurityGroup": { + "$ref": "#/definitions/SubResource", + "description": "The network security group." + }, + "dnsSettings": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationDnsSettings", + "description": "The dns settings to be applied on the network interfaces." + }, + "ipConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetIPConfiguration" + }, + "description": "Specifies the IP configurations of the network interface." + }, + "enableIPForwarding": { + "type": "boolean", + "description": "Whether IP forwarding enabled on this NIC." + } + }, + "required": [ + "ipConfigurations" + ], + "description": "Describes a virtual machine scale set network profile's IP configuration." + }, + "VirtualMachineScaleSetUpdateNetworkConfigurationProperties": { + "properties": { + "primary": { + "type": "boolean", + "description": "Whether this is a primary NIC on a virtual machine." + }, + "enableAcceleratedNetworking": { + "type": "boolean", + "description": "Specifies whether the network interface is accelerated networking-enabled." + }, + "networkSecurityGroup": { + "$ref": "#/definitions/SubResource", + "description": "The network security group." + }, + "dnsSettings": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationDnsSettings", + "description": "The dns settings to be applied on the network interfaces." + }, + "ipConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdateIPConfiguration" + }, + "description": "The virtual machine scale set IP Configuration." + }, + "enableIPForwarding": { + "type": "boolean", + "description": "Whether IP forwarding enabled on this NIC." + } + }, + "description": "Describes a virtual machine scale set updatable network profile's IP configuration.Use this object for updating network profile's IP Configuration." + }, + "VirtualMachineScaleSetNetworkConfiguration": { + "properties": { + "name": { + "type": "string", + "description": "The network configuration name." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationProperties" + } + }, + "required": [ + "name" + ], + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "Describes a virtual machine scale set network profile's network configurations." + }, + "VirtualMachineScaleSetUpdateNetworkConfiguration": { + "properties": { + "name": { + "type": "string", + "description": "The network configuration name." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetUpdateNetworkConfigurationProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "Describes a virtual machine scale set network profile's network configurations." + }, + "VirtualMachineScaleSetNetworkConfigurationDnsSettings": { + "properties": { + "dnsServers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of DNS servers IP addresses" + } + }, + "description": "Describes a virtual machines scale sets network configuration's DNS settings." + }, + "VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings": { + "properties": { + "domainNameLabel": { + "type": "string", + "description": "The Domain name label.The concatenation of the domain name label and vm index will be the domain name labels of the PublicIPAddress resources that will be created" + } + }, + "required": [ + "domainNameLabel" + ], + "description": "Describes a virtual machines scale sets network configuration's DNS settings." + }, + "VirtualMachineScaleSetIpTag": { + "properties": { + "ipTagType": { + "type": "string", + "description": "IP tag type. Example: FirstPartyUsage." + }, + "tag": { + "type": "string", + "description": "IP tag associated with the public IP. Example: SQL, Storage etc." + } + }, + "description": "Contains the IP tag associated with the public IP address." + }, + "VirtualMachineScaleSetPublicIPAddressConfiguration": { + "properties": { + "name": { + "type": "string", + "description": "The publicIP address configuration name." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationProperties" + } + }, + "required": [ + "name" + ], + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" + }, + "VirtualMachineScaleSetUpdatePublicIPAddressConfiguration": { + "properties": { + "name": { + "type": "string", + "description": "The publicIP address configuration name." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetUpdatePublicIPAddressConfigurationProperties" + } + }, + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" + }, + "VirtualMachineScaleSetPublicIPAddressConfigurationProperties": { + "properties": { + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "description": "The idle timeout of the public IP address." + }, + "dnsSettings": { + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings", + "description": "The dns settings to be applied on the publicIP addresses ." + }, + "ipTags": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetIpTag" + }, + "description": "The list of IP tags associated with the public IP address." + }, + "publicIPPrefix": { + "$ref": "#/definitions/SubResource", + "description": "The PublicIPPrefix from which to allocate publicIP addresses." + } + }, + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" + }, + "VirtualMachineScaleSetUpdatePublicIPAddressConfigurationProperties": { + "properties": { + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "description": "The idle timeout of the public IP address." + }, + "dnsSettings": { + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings", + "description": "The dns settings to be applied on the publicIP addresses ." + } + }, + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" + }, + "VirtualMachineScaleSetNetworkProfile": { + "properties": { + "healthProbe": { + "$ref": "#/definitions/ApiEntityReference", + "description": "A reference to a load balancer probe used to determine the health of an instance in the virtual machine scale set. The reference will be in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'." + }, + "networkInterfaceConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfiguration" + }, + "description": "The list of network configurations." + } + }, + "description": "Describes a virtual machine scale set network profile." + }, + "VirtualMachineScaleSetUpdateNetworkProfile": { + "properties": { + "networkInterfaceConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdateNetworkConfiguration" + }, + "description": "The list of network configurations." + } + }, + "description": "Describes a virtual machine scale set network profile." + }, + "VirtualMachineScaleSetExtensionProperties": { + "properties": { + "forceUpdateTag": { + "type": "string", + "description": "If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed." + }, + "publisher": { + "type": "string", + "description": "The name of the extension handler publisher." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + }, + "autoUpgradeMinorVersion": { + "type": "boolean", + "description": "Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true." + }, + "settings": { + "type": "object", + "description": "Json formatted public settings for the extension." + }, + "protectedSettings": { + "type": "object", + "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + }, + "provisionAfterExtensions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Collection of extension names after which this extension needs to be provisioned." + } + }, + "description": "Describes the properties of a Virtual Machine Scale Set Extension." + }, + "VirtualMachineScaleSetExtension": { + "properties": { + "name": { + "type": "string", + "description": "The name of the extension." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/SubResourceReadOnly" + } + ], + "description": "Describes a Virtual Machine Scale Set Extension." + }, + "VirtualMachineScaleSetExtensionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + }, + "description": "The list of VM scale set extensions." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of VM scale set extensions. Call ListNext() with this to fetch the next page of VM scale set extensions." + } + }, + "required": [ + "value" + ], + "description": "The List VM scale set extension operation response." + }, + "VirtualMachineScaleSetExtensionProfile": { + "properties": { + "extensions": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + }, + "description": "The virtual machine scale set child extension resources." + } + }, + "description": "Describes a virtual machine scale set extension profile." + }, + "VirtualMachineScaleSetVMProfile": { + "properties": { + "osProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetOSProfile", + "description": "Specifies the operating system settings for the virtual machines in the scale set." + }, + "storageProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetStorageProfile", + "description": "Specifies the storage settings for the virtual machine disks." + }, + "networkProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkProfile", + "description": "Specifies properties of the network interfaces of the virtual machines in the scale set." + }, + "diagnosticsProfile": { + "$ref": "#/definitions/DiagnosticsProfile", + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." + }, + "extensionProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProfile", + "description": "Specifies a collection of settings for extensions installed on virtual machines in the scale set." + }, + "licenseType": { + "type": "string", + "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" + }, + "priority": { + "type": "string", + "description": "Specifies the priority for the virtual machines in the scale set.

    Minimum api-version: 2017-10-30-preview", + "enum": [ + "Regular", + "Low" + ], + "x-ms-enum": { + "name": "VirtualMachinePriorityTypes", + "modelAsString": true + } + }, + "evictionPolicy": { + "type": "string", + "description": "Specifies the eviction policy for virtual machines in a low priority scale set.

    Minimum api-version: 2017-10-30-preview", + "enum": [ + "Deallocate", + "Delete" + ], + "x-ms-enum": { + "name": "VirtualMachineEvictionPolicyTypes", + "modelAsString": true + } + } + }, + "description": "Describes a virtual machine scale set virtual machine profile." + }, + "VirtualMachineScaleSetUpdateVMProfile": { + "properties": { + "osProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdateOSProfile", + "description": "The virtual machine scale set OS profile." + }, + "storageProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdateStorageProfile", + "description": "The virtual machine scale set storage profile." + }, + "networkProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdateNetworkProfile", + "description": "The virtual machine scale set network profile." + }, + "diagnosticsProfile": { + "$ref": "#/definitions/DiagnosticsProfile", + "description": "The virtual machine scale set diagnostics profile." + }, + "extensionProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProfile", + "description": "The virtual machine scale set extension profile." + }, + "licenseType": { + "type": "string", + "description": "The license type, which is for bring your own license scenario." + } + }, + "description": "Describes a virtual machine scale set virtual machine profile." + }, + "VirtualMachineScaleSetProperties": { + "properties": { + "upgradePolicy": { + "$ref": "#/definitions/UpgradePolicy", + "description": "The upgrade policy." + }, + "virtualMachineProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetVMProfile", + "description": "The virtual machine profile." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + }, + "overprovision": { + "type": "boolean", + "description": "Specifies whether the Virtual Machine Scale Set should be overprovisioned." + }, + "doNotRunExtensionsOnOverprovisionedVMs": { + "type": "boolean", + "description": "When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs." + }, + "uniqueId": { + "readOnly": true, + "type": "string", + "description": "Specifies the ID which uniquely identifies a Virtual Machine Scale Set." + }, + "singlePlacementGroup": { + "type": "boolean", + "description": "When true this limits the scale set to a single placement group, of max size 100 virtual machines." + }, + "zoneBalance": { + "type": "boolean", + "description": "Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage." + }, + "platformFaultDomainCount": { + "type": "integer", + "format": "int32", + "description": "Fault Domain count for each placement group." + }, + "proximityPlacementGroup": { + "$ref": "#/definitions/SubResource", + "description": "Specifies information about the proximity placement group that the virtual machine scale set should be assigned to.

    Minimum api-version: 2018-04-01." + }, + "additionalCapabilities": { + "$ref": "#/definitions/AdditionalCapabilities", + "description": "Specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines have the capability to support attaching managed data disks with UltraSSD_LRS storage account type." + } + }, + "description": "Describes the properties of a Virtual Machine Scale Set." + }, + "VirtualMachineScaleSetUpdateProperties": { + "properties": { + "upgradePolicy": { + "$ref": "#/definitions/UpgradePolicy", + "description": "The upgrade policy." + }, + "virtualMachineProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdateVMProfile", + "description": "The virtual machine profile." + }, + "overprovision": { + "type": "boolean", + "description": "Specifies whether the Virtual Machine Scale Set should be overprovisioned." + }, + "singlePlacementGroup": { + "type": "boolean", + "description": "When true this limits the scale set to a single placement group, of max size 100 virtual machines." + }, + "additionalCapabilities": { + "$ref": "#/definitions/AdditionalCapabilities", + "description": "Specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines have the capability to support attaching managed data disks with UltraSSD_LRS storage account type." + } + }, + "description": "Describes the properties of a Virtual Machine Scale Set." + }, + "VirtualMachineScaleSet": { + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "The virtual machine scale set sku." + }, + "plan": { + "$ref": "#/definitions/Plan", + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetProperties" + }, + "identity": { + "$ref": "#/definitions/VirtualMachineScaleSetIdentity", + "description": "The identity of the virtual machine scale set, if configured." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The virtual machine scale set zones." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Describes a Virtual Machine Scale Set." + }, + "VirtualMachineScaleSetVMReimageParameters": { + "allOf": [ + { + "$ref": "#/definitions/VirtualMachineReimageParameters" + } + ], + "description": "Describes a Virtual Machine Scale Set VM Reimage Parameters." + }, + "VirtualMachineScaleSetReimageParameters": { + "properties": { + "instanceIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set." + } + }, + "allOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetVMReimageParameters" + } + ], + "description": "Describes a Virtual Machine Scale Set VM Reimage Parameters." + }, + "VirtualMachineScaleSetUpdate": { + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "The virtual machine scale set sku." + }, + "plan": { + "$ref": "#/definitions/Plan", + "description": "The purchase plan when deploying a virtual machine scale set from VM Marketplace images." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetUpdateProperties" + }, + "identity": { + "$ref": "#/definitions/VirtualMachineScaleSetIdentity", + "description": "The identity of the virtual machine scale set, if configured." + } + }, + "allOf": [ + { + "$ref": "#/definitions/UpdateResource" + } + ], + "description": "Describes a Virtual Machine Scale Set." + }, + "VirtualMachineScaleSetVMInstanceIDs": { + "properties": { + "instanceIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set." + } + }, + "description": "Specifies a list of virtual machine instance IDs from the VM scale set." + }, + "VirtualMachineScaleSetVMInstanceRequiredIDs": { + "properties": { + "instanceIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The virtual machine scale set instance ids." + } + }, + "required": [ + "instanceIds" + ], + "description": "Specifies a list of virtual machine instance IDs from the VM scale set." + }, + "VirtualMachineStatusCodeCount": { + "properties": { + "code": { + "readOnly": true, + "type": "string", + "description": "The instance view status code." + }, + "count": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of instances having a particular status code." + } + }, + "description": "The status code and count of the virtual machine scale set instance view status summary." + }, + "VirtualMachineScaleSetInstanceViewStatusesSummary": { + "properties": { + "statusesSummary": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineStatusCodeCount" + }, + "description": "The extensions information." + } + }, + "description": "Instance view statuses summary for virtual machines of a virtual machine scale set." + }, + "VirtualMachineScaleSetVMExtensionsSummary": { + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "The extension name." + }, + "statusesSummary": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineStatusCodeCount" + }, + "description": "The extensions information." + } + }, + "description": "Extensions summary for virtual machines of a virtual machine scale set." + }, + "VirtualMachineScaleSetInstanceView": { + "properties": { + "virtualMachine": { + "$ref": "#/definitions/VirtualMachineScaleSetInstanceViewStatusesSummary", + "readOnly": true, + "description": "The instance view status summary for the virtual machine scale set." + }, + "extensions": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetVMExtensionsSummary" + }, + "description": "The extensions information." + }, + "statuses": { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "The resource status information." + } + }, + "description": "The instance view of a virtual machine scale set." + }, + "VirtualMachineScaleSetListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSet" + }, + "description": "The list of virtual machine scale sets." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of Virtual Machine Scale Sets. Call ListNext() with this to fetch the next page of VMSS." + } + }, + "required": [ + "value" + ], + "description": "The List Virtual Machine operation response." + }, + "VirtualMachineScaleSetListWithLinkResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSet" + }, + "description": "The list of virtual machine scale sets." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of Virtual Machine Scale Sets. Call ListNext() with this to fetch the next page of Virtual Machine Scale Sets." + } + }, + "required": [ + "value" + ], + "description": "The List Virtual Machine operation response." + }, + "VirtualMachineScaleSetSkuCapacity": { + "properties": { + "minimum": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The minimum capacity." + }, + "maximum": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The maximum capacity that can be set." + }, + "defaultCapacity": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The default capacity." + }, + "scaleType": { + "readOnly": true, + "type": "string", + "description": "The scale type applicable to the sku.", + "enum": [ + "Automatic", + "None" + ], + "x-ms-enum": { + "name": "VirtualMachineScaleSetSkuScaleType", + "modelAsString": false + } + } + }, + "description": "Describes scaling information of a sku." + }, + "VirtualMachineScaleSetSku": { + "properties": { + "resourceType": { + "readOnly": true, + "type": "string", + "description": "The type of resource the sku applies to." + }, + "sku": { + "$ref": "#/definitions/Sku", + "readOnly": true, + "description": "The Sku." + }, + "capacity": { + "$ref": "#/definitions/VirtualMachineScaleSetSkuCapacity", + "readOnly": true, + "description": "Specifies the number of virtual machines in the scale set." + } + }, + "description": "Describes an available virtual machine scale set sku." + }, + "VirtualMachineScaleSetListSkusResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetSku" + }, + "description": "The list of skus available for the virtual machine scale set." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of Virtual Machine Scale Set Skus. Call ListNext() with this to fetch the next page of VMSS Skus." + } + }, + "required": [ + "value" + ], + "description": "The Virtual Machine Scale Set List Skus operation response." + }, + "RollbackStatusInfo": { + "properties": { + "successfullyRolledbackInstanceCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of instances which have been successfully rolled back." + }, + "failedRolledbackInstanceCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of instances which failed to rollback." + }, + "rollbackError": { + "$ref": "#/definitions/ApiError", + "readOnly": true, + "description": "Error details if OS rollback failed." + } + }, + "description": "Information about rollback on failed VM instances after a OS Upgrade operation." + }, + "UpgradeOperationHistoryStatus": { + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "Code indicating the current status of the upgrade.", + "enum": [ + "RollingForward", + "Cancelled", + "Completed", + "Faulted" + ], + "x-ms-enum": { + "name": "UpgradeState", + "modelAsString": false + } + }, + "startTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Start time of the upgrade." + }, + "endTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "End time of the upgrade." + } + }, + "description": "Information about the current running state of the overall upgrade." + }, + "UpgradeOperationHistoricalStatusInfoProperties": { + "properties": { + "runningStatus": { + "$ref": "#/definitions/UpgradeOperationHistoryStatus", + "readOnly": true, + "description": "Information about the overall status of the upgrade operation." + }, + "progress": { + "$ref": "#/definitions/RollingUpgradeProgressInfo", + "readOnly": true, + "description": "Counts of the VMs in each state." + }, + "error": { + "$ref": "#/definitions/ApiError", + "readOnly": true, + "description": "Error Details for this upgrade if there are any." + }, + "startedBy": { + "readOnly": true, + "type": "string", + "description": "Invoker of the Upgrade Operation", + "enum": [ + "Unknown", + "User", + "Platform" + ], + "x-ms-enum": { + "name": "UpgradeOperationInvoker", + "modelAsString": false + } + }, + "targetImageReference": { + "$ref": "#/definitions/ImageReference", + "readOnly": true, + "description": "Image Reference details" + }, + "rollbackInfo": { + "$ref": "#/definitions/RollbackStatusInfo", + "readOnly": true, + "description": "Information about OS rollback if performed" + } + }, + "description": "Describes each OS upgrade on the Virtual Machine Scale Set." + }, + "UpgradeOperationHistoricalStatusInfo": { + "properties": { + "properties": { + "$ref": "#/definitions/UpgradeOperationHistoricalStatusInfoProperties", + "readOnly": true, + "description": "Information about the properties of the upgrade operation." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + }, + "location": { + "readOnly": true, + "type": "string", + "description": "Resource location" + } + }, + "description": "Virtual Machine Scale Set OS Upgrade History operation response." + }, + "VirtualMachineScaleSetListOSUpgradeHistory": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/UpgradeOperationHistoricalStatusInfo" + }, + "description": "The list of OS upgrades performed on the virtual machine scale set." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of OS Upgrade History. Call ListNext() with this to fetch the next page of history of upgrades." + } + }, + "required": [ + "value" + ], + "description": "List of Virtual Machine Scale Set OS Upgrade History operation response." + }, + "VirtualMachineScaleSetVMProperties": { + "properties": { + "latestModelApplied": { + "readOnly": true, + "type": "boolean", + "description": "Specifies whether the latest model has been applied to the virtual machine." + }, + "vmId": { + "readOnly": true, + "type": "string", + "description": "Azure VM unique ID." + }, + "instanceView": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceView", + "readOnly": true, + "description": "The virtual machine instance view." + }, + "hardwareProfile": { + "$ref": "#/definitions/HardwareProfile", + "description": "Specifies the hardware settings for the virtual machine." + }, + "storageProfile": { + "$ref": "#/definitions/StorageProfile", + "description": "Specifies the storage settings for the virtual machine disks." + }, + "additionalCapabilities": { + "$ref": "#/definitions/AdditionalCapabilities", + "description": "Specifies additional capabilities enabled or disabled on the virtual machine in the scale set. For instance: whether the virtual machine has the capability to support attaching managed data disks with UltraSSD_LRS storage account type." + }, + "osProfile": { + "$ref": "#/definitions/OSProfile", + "description": "Specifies the operating system settings for the virtual machine." + }, + "networkProfile": { + "$ref": "#/definitions/NetworkProfile", + "description": "Specifies the network interfaces of the virtual machine." + }, + "networkProfileConfiguration": { + "$ref": "#/definitions/VirtualMachineScaleSetVMNetworkProfileConfiguration", + "description": "Specifies the network profile configuration of the virtual machine." + }, + "diagnosticsProfile": { + "$ref": "#/definitions/DiagnosticsProfile", + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." + }, + "availabilitySet": { + "$ref": "#/definitions/SubResource", + "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

    For more information on Azure planned maintenance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + }, + "licenseType": { + "type": "string", + "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" + }, + "modelDefinitionApplied": { + "readOnly": true, + "type": "string", + "description": "Specifies whether the model applied to the virtual machine is the model of the virtual machine scale set or the customized model for the virtual machine." + }, + "protectionPolicy": { + "$ref": "#/definitions/VirtualMachineScaleSetVMProtectionPolicy", + "description": "Specifies the protection policy of the virtual machine." + } + }, + "description": "Describes the properties of a virtual machine scale set virtual machine." + }, + "VirtualMachineScaleSetVM": { + "properties": { + "instanceId": { + "readOnly": true, + "type": "string", + "description": "The virtual machine instance ID." + }, + "sku": { + "$ref": "#/definitions/Sku", + "readOnly": true, + "description": "The virtual machine SKU." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetVMProperties" + }, + "plan": { + "$ref": "#/definitions/Plan", + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "resources": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtension" + }, + "description": "The virtual machine child extension resources." + }, + "zones": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "The virtual machine zones." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Describes a virtual machine scale set virtual machine." + }, + "VirtualMachineScaleSetVMInstanceView": { + "properties": { + "platformUpdateDomain": { + "type": "integer", + "format": "int32", + "description": "The Update Domain count." + }, + "platformFaultDomain": { + "type": "integer", + "format": "int32", + "description": "The Fault Domain count." + }, + "rdpThumbPrint": { + "type": "string", + "description": "The Remote desktop certificate thumbprint." + }, + "vmAgent": { + "$ref": "#/definitions/VirtualMachineAgentInstanceView", + "description": "The VM Agent running on the virtual machine." + }, + "maintenanceRedeployStatus": { + "$ref": "#/definitions/MaintenanceRedeployStatus", + "description": "The Maintenance Operation status on the virtual machine." + }, + "disks": { + "type": "array", + "items": { + "$ref": "#/definitions/DiskInstanceView" + }, + "description": "The disks information." + }, + "extensions": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtensionInstanceView" + }, + "description": "The extensions information." + }, + "vmHealth": { + "readOnly": true, + "$ref": "#/definitions/VirtualMachineHealthStatus", + "description": "The health status for the VM." + }, + "bootDiagnostics": { + "$ref": "#/definitions/BootDiagnosticsInstanceView", + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    You can easily view the output of your console log.

    Azure also enables you to see a screenshot of the VM from the hypervisor." + }, + "statuses": { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "The resource status information." + }, + "placementGroupId": { + "type": "string", + "description": "The placement group in which the VM is running. If the VM is deallocated it will not have a placementGroupId." + } + }, + "description": "The instance view of a virtual machine scale set VM." + }, + "VirtualMachineScaleSetVMNetworkProfileConfiguration": { + "properties": { + "networkInterfaceConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfiguration" + }, + "description": "The list of network configurations." + } + }, + "description": "Describes a virtual machine scale set VM network profile." + }, + "VirtualMachineScaleSetVMProtectionPolicy": { + "properties": { + "protectFromScaleIn": { + "type": "boolean", + "description": "Indicates that the virtual machine scale set VM shouldn't be considered for deletion during a scale-in operation." + }, + "protectFromScaleSetActions": { + "type": "boolean", + "description": "Indicates that model updates or actions (including scale-in) initiated on the virtual machine scale set should not be applied to the virtual machine scale set VM." + } + }, + "description": "The protection policy of a virtual machine scale set VM." + }, + "VirtualMachineHealthStatus": { + "properties": { + "status": { + "readOnly": true, + "$ref": "#/definitions/InstanceViewStatus", + "description": "The health status information for the VM." + } + }, + "description": "The health status of the VM." + }, + "VirtualMachineScaleSetVMListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetVM" + }, + "description": "The list of virtual machine scale sets VMs." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of Virtual Machine Scale Set VMs. Call ListNext() with this to fetch the next page of VMSS VMs" + } + }, + "required": [ + "value" + ], + "description": "The List Virtual Machine Scale Set VMs operation response." + }, + "RollingUpgradeStatusInfo": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RollingUpgradeStatusInfoProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "The status of the latest virtual machine scale set rolling upgrade." + }, + "RollingUpgradeStatusInfoProperties": { + "properties": { + "policy": { + "readOnly": true, + "$ref": "#/definitions/RollingUpgradePolicy", + "description": "The rolling upgrade policies applied for this upgrade." + }, + "runningStatus": { + "readOnly": true, + "$ref": "#/definitions/RollingUpgradeRunningStatus", + "description": "Information about the current running state of the overall upgrade." + }, + "progress": { + "readOnly": true, + "$ref": "#/definitions/RollingUpgradeProgressInfo", + "description": "Information about the number of virtual machine instances in each upgrade state." + }, + "error": { + "readOnly": true, + "$ref": "#/definitions/ApiError", + "description": "Error details for this upgrade, if there are any." + } + }, + "description": "The status of the latest virtual machine scale set rolling upgrade." + }, + "RollingUpgradeRunningStatus": { + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "Code indicating the current status of the upgrade.", + "enum": [ + "RollingForward", + "Cancelled", + "Completed", + "Faulted" + ], + "x-ms-enum": { + "name": "RollingUpgradeStatusCode", + "modelAsString": false + } + }, + "startTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Start time of the upgrade." + }, + "lastAction": { + "type": "string", + "readOnly": true, + "description": "The last action performed on the rolling upgrade.", + "enum": [ + "Start", + "Cancel" + ], + "x-ms-enum": { + "name": "RollingUpgradeActionType", + "modelAsString": false + } + }, + "lastActionTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Last action time of the upgrade." + } + }, + "description": "Information about the current running state of the overall upgrade." + }, + "RollingUpgradeProgressInfo": { + "properties": { + "successfulInstanceCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of instances that have been successfully upgraded." + }, + "failedInstanceCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of instances that have failed to be upgraded successfully." + }, + "inProgressInstanceCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of instances that are currently being upgraded." + }, + "pendingInstanceCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of instances that have not yet begun to be upgraded." + } + }, + "description": "Information about the number of virtual machine instances in each upgrade state." + }, + "ApiErrorBase": { + "properties": { + "code": { + "type": "string", + "description": "The error code." + }, + "target": { + "type": "string", + "description": "The target of the particular error." + }, + "message": { + "type": "string", + "description": "The error message." + } + }, + "description": "Api error base." + }, + "InnerError": { + "properties": { + "exceptiontype": { + "type": "string", + "description": "The exception type." + }, + "errordetail": { + "type": "string", + "description": "The internal error message or exception dump." + } + }, + "description": "Inner error details." + }, + "ApiError": { + "properties": { + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiErrorBase" + }, + "description": "The Api error details" + }, + "innererror": { + "$ref": "#/definitions/InnerError", + "description": "The Api inner error" + }, + "code": { + "type": "string", + "description": "The error code." + }, + "target": { + "type": "string", + "description": "The target of the particular error." + }, + "message": { + "type": "string", + "description": "The error message." + } + }, + "description": "Api error." + }, + "Resource": { + "description": "The Resource model definition.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "required": [ + "location" + ], + "x-ms-azure-resource": true + }, + "UpdateResource": { + "description": "The Update Resource model definition.", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "x-ms-azure-resource": true + }, + "SubResource": { + "properties": { + "id": { + "type": "string", + "description": "Resource Id" + } + }, + "x-ms-azure-resource": true + }, + "SubResourceReadOnly": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + } + }, + "x-ms-azure-resource": true + }, + "RecoveryWalkResponse": { + "properties": { + "walkPerformed": { + "type": "boolean", + "readOnly": true, + "description": "Whether the recovery walk was performed" + }, + "nextPlatformUpdateDomain": { + "type": "integer", + "readOnly": true, + "description": "The next update domain that needs to be walked. Null means walk spanning all update domains has been completed" + } + }, + "description": "Response after calling a manual recovery walk" + }, + "RequestRateByIntervalInput": { + "properties": { + "intervalLength": { + "type": "string", + "description": "Interval value in minutes used to create LogAnalytics call rate logs.", + "enum": [ + "ThreeMins", + "FiveMins", + "ThirtyMins", + "SixtyMins" + ], + "x-ms-enum": { + "name": "IntervalInMins", + "modelAsString": false + } + } + }, + "required": [ + "intervalLength" + ], + "allOf": [ + { + "$ref": "#/definitions/LogAnalyticsInputBase" + } + ], + "description": "Api request input for LogAnalytics getRequestRateByInterval Api." + }, + "ThrottledRequestsInput": { + "allOf": [ + { + "$ref": "#/definitions/LogAnalyticsInputBase" + } + ], + "description": "Api request input for LogAnalytics getThrottledRequests Api." + }, + "LogAnalyticsInputBase": { + "properties": { + "blobContainerSasUri": { + "type": "string", + "description": "SAS Uri of the logging blob container to which LogAnalytics Api writes output logs to." + }, + "fromTime": { + "type": "string", + "format": "date-time", + "description": "From time of the query" + }, + "toTime": { + "type": "string", + "format": "date-time", + "description": "To time of the query" + }, + "groupByThrottlePolicy": { + "type": "boolean", + "description": "Group query result by Throttle Policy applied." + }, + "groupByOperationName": { + "type": "boolean", + "description": "Group query result by Operation Name." + }, + "groupByResourceName": { + "type": "boolean", + "description": "Group query result by Resource Name." + } + }, + "required": [ + "blobContainerSasUri", + "fromTime", + "toTime" + ], + "description": "Api input base class for LogAnalytics Api." + }, + "LogAnalyticsOperationResult": { + "properties": { + "properties": { + "readOnly": true, + "$ref": "#/definitions/LogAnalyticsOutput", + "description": "LogAnalyticsOutput" + } + }, + "description": "LogAnalytics operation status response" + }, + "LogAnalyticsOutput": { + "properties": { + "output": { + "readOnly": true, + "type": "string", + "description": "Output file Uri path to blob container." + } + }, + "description": "LogAnalytics output properties" + }, + "VMScaleSetConvertToSinglePlacementGroupInput": { + "properties": { + "activePlacementGroupId": { + "type": "string", + "description": "Id of the placement group in which you want future virtual machine instances to be placed. To query placement group Id, please use Virtual Machine Scale Set VMs - Get API. If not provided, the platform will choose one with maximum number of virtual machine instances." + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateOrUpdateADedicatedHost.json.orig b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateOrUpdateADedicatedHost.json.orig new file mode 100644 index 000000000000..b29c630e4532 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateOrUpdateADedicatedHost.json.orig @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-10-01", + "parameters": { + "location": "westus", + "tags": { + "department": "HR" + }, + "properties": { + "platformFaultDomain": 1 + }, + "sku": { + "name": "DSv3-Type1" + } + }, + "hostGroupName": "myDedicatedHostGroup", + "hostName": "myDedicatedHost" + }, + "responses": { + "201": { + "body": { + "name": "myDedicatedHost", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup/hosts/myDedicatedHost", + "tags": { + "department": "HR" + }, + "sku": { + "name": "DSv3-Type1" + }, + "properties": { + "platformFaultDomain": 1, + "autoReplaceOnFailure": true, + "hostId": "{GUID}" + } + } + }, +<<<<<<< HEAD + "200": { +======= + "200": { +>>>>>>> upstream/master + "body": { + "properties": { + "platformFaultDomain": 1, + "autoReplaceOnFailure": false, + "licenseType": "Windows_Server_Hybrid", + "hostId": "{GUID}" + }, + "location": "westus", + "tags": { + "department": "HR" + }, + "name": "myDedicatedHost", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup/hosts/myDedicatedHost", + "sku": { + "name": "DSv3-Type1" + } + } + } + } +<<<<<<< HEAD +} +======= +} +>>>>>>> upstream/master diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateOrUpdateADedicatedHostGroup.json.orig b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateOrUpdateADedicatedHostGroup.json.orig new file mode 100644 index 000000000000..8fa966f9f5e9 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateOrUpdateADedicatedHostGroup.json.orig @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-10-01", + "hostGroupName": "myDedicatedHostGroup", + "parameters": { + "location": "westus", + "tags": { + "department": "finance" + }, + "zones": [ + "1" + ], + "properties": { + "platformFaultDomainCount": 3 + } + } + }, + "responses": { + "201": { + "body": { + "name": "myDedicatedHostGroup", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup", + "tags": { + "department": "finance" + }, + "zones": [ + "1" + ], + "properties": { + "platformFaultDomainCount": 3, + "hosts": [] + } + } + }, +<<<<<<< HEAD + "200": { +======= + "200": { +>>>>>>> upstream/master + "body": { + "properties": { + "platformFaultDomainCount": 3, + "hosts": [] + }, + "location": "westus", + "tags": { + "department": "finance", + "owner": "myCompany" + }, + "name": "myDedicatedHostGroup", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup", + "zones": [ + "1" + ] + } + } + } +<<<<<<< HEAD +} +======= +} +>>>>>>> upstream/master diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/GetADedicatedHost.json.orig b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/GetADedicatedHost.json.orig new file mode 100644 index 000000000000..5ff340ca7d69 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/GetADedicatedHost.json.orig @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-10-01", + "hostGroupName": "myDedicatedHostGroup", + "hostName": "myHost" + }, + "responses": { + "200": { + "body": { + "properties": { + "platformFaultDomain": 1, + "autoReplaceOnFailure": true, + "hostId": "{GUID}", + "provisioningTime": "2019-06-27T01:02:38.3138469+00:00", + "virtualMachines": [ + { + "id": "/subscriptions/subId/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/vm1" + } + ], + "provisioningState": "Succeeded", + "instanceView": { + "assetId": "eb3f58b8-b4e8-4882-b69f-301a01812407", + "capacity": { + "totalCores": 30, + "totalVCpus": 60 + }, + "availableCapacity": { + "availableVCpus": 40, + "allocatableVMs": [ + { + "vmSize": "Standard_A1", + "count": 10 + } + ] + }, + "statuses": [ + { + "code": "ProvisioningState/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded" + }, + { + "code": "HealthState/available", + "level": "Info", + "displayStatus": "Host available" + } + ] + } + }, + "location": "westus", + "tags": { + "department": "HR" + }, + "sku": { + "name": "DSv3-Type1" + }, + "name": "myHost" + } + } + } +<<<<<<< HEAD +} +======= +} +>>>>>>> upstream/master diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/GetADedicatedHostGroup.json.orig b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/GetADedicatedHostGroup.json.orig new file mode 100644 index 000000000000..167ed8a293c1 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/GetADedicatedHostGroup.json.orig @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-10-01", + "hostGroupName": "myDedicatedHostGroup" + }, + "responses": { + "200": { + "body": { + "properties": { + "platformFaultDomainCount": 3, + "hosts": [ + { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/myDedicatedHostGroup/myHostGroup/Hosts/myHost1" + }, + { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/myDedicatedHostGroup/myHostGroup/Hosts/myHost2" + } + ] + }, + "location": "westus", + "tags": { + "{tagName}": "{tagValue}" + }, + "name": "myDedicatedHostGroup", + "zones": [ + "3" + ] + } + } + } +<<<<<<< HEAD +} +======= +} +>>>>>>> upstream/master From 4e21b51a1eb644bbed2b7d1d7016490b8d54cdf0 Mon Sep 17 00:00:00 2001 From: Cigdem Celik Aydin Date: Fri, 12 Jul 2019 15:34:05 -0700 Subject: [PATCH 14/22] Update compute.json Documentation changes and marked required fields --- .../stable/2019-03-01/compute.json | 47 +++++++------------ 1 file changed, 17 insertions(+), 30 deletions(-) diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json index 34e33c829b59..e7c35d5cd141 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json @@ -884,7 +884,7 @@ "schema": { "$ref": "#/definitions/DedicatedHost" }, - "description": "Parameters supplied to the Create Dedicated Host ." + "description": "Parameters supplied to the Create Dedicated Host." }, { "$ref": "#/parameters/ApiVersionParameter" @@ -5465,6 +5465,9 @@ "description": "A list of references to all dedicated hosts in the dedicated host group." } }, + "required": [ + "platformFaultDomainCount" + ], "description": "Dedicated Host Group Properties." }, "DedicatedHostGroup": { @@ -5478,7 +5481,7 @@ "items": { "type": "string" }, - "description": "Availability Zone to use for this host group – only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforce each host in the group is in the same zone." + "description": "Availability Zone to use for this host group – only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforces each host in the group to be in the same zone." } }, "allOf": [ @@ -5486,7 +5489,7 @@ "$ref": "#/definitions/Resource" } ], - "description": "Specifies information about the dedicated host group that the dedicated hosts should be assigned to.

    Currently, a Dedicated host can only be added to Dedicated Host Group at creation time. An existing Dedicated Host cannot be added to a dedicated host group." + "description": "Specifies information about the dedicated host group that the dedicated hosts should be assigned to.

    Currently, a dedicated host can only be added to a dedicated host group at creation time. An existing dedicated host cannot be added to another dedicated host group." }, "DedicatedHostGroupUpdate": { "properties": { @@ -5499,7 +5502,7 @@ "items": { "type": "string" }, - "description": "Availability Zone to use for this host group – only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforce each host in the group is in the same zone." + "description": "Availability Zone to use for this host group – only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforces each host in the group to be in the same zone." } }, "allOf": [ @@ -5541,21 +5544,6 @@ "modelAsString": false } }, - "DedicatedHostCapacity": { - "properties": { - "totalCores": { - "type": "number", - "format": "double", - "description": "The total number of cores." - }, - "totalVCpus": { - "type": "number", - "format": "double", - "description": "The total number of CPUs." - } - }, - "description": "Dedicated host total capacity." - }, "DedicatedHostAllocatableVM": { "properties": { "vmSize": { @@ -5592,11 +5580,7 @@ "assetId": { "readOnly": true, "type": "string", - "description": "Specifies the unique of the dedicated physical machine on which the dedicated host resides." - }, - "capacity": { - "$ref": "#/definitions/DedicatedHostCapacity", - "description": "The total capacity of the dedicated host." + "description": "Specifies the unique id of the dedicated physical machine on which the dedicated host resides." }, "availableCapacity": { "$ref": "#/definitions/DedicatedHostAvailableCapacity", @@ -5617,16 +5601,16 @@ "platformFaultDomain": { "type": "integer", "format": "int32", - "description": "Fault domain of the host within a group. Supported values 0,1,2." + "description": "Fault domain of the dedicated host within a dedicated host group. Supported values 0,1,2." }, "autoReplaceOnFailure": { "type": "boolean", - "description": "Whether the host should be replaced automatically in case of a failure. The value is defaulted to true when not provided." + "description": "Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided." }, "hostId": { "readOnly": true, "type": "string", - "description": "A unique id generated and assigned to the dedicated host by the platform." + "description": "A unique id generated and assigned to the dedicated host by the platform.

    Does not change throughout the lifetime of the host." }, "virtualMachines": { "type": "array", @@ -5667,7 +5651,7 @@ }, "sku": { "$ref": "#/definitions/Sku", - "description": "Sku of the dedicated host for Hardware Generation and VM family, The only name is required to be set. See DedicatedHostSkuTypes for possible set of values." + "description": "SKU of the dedicated host for Hardware Generation and VM family. Only name is required to be set. List Microsoft.Compute SKUs for a list of possible values." } }, "allOf": [ @@ -5675,6 +5659,9 @@ "$ref": "#/definitions/Resource" } ], + "required": [ + "sku" + ], "description": "Specifies information about the Dedicated host." }, "DedicatedHostUpdate": { @@ -5702,13 +5689,13 @@ }, "nextLink": { "type": "string", - "description": "The URI to fetch the next page of Dedicated hosts. Call ListNext() with this URI to fetch the next page of Dedicated hosts." + "description": "The URI to fetch the next page of dedicated hosts. Call ListNext() with this URI to fetch the next page of dedicated hosts." } }, "required": [ "value" ], - "description": "The List Dedicated Host operation response." + "description": "The list dedicated host operation response." }, "VirtualMachineSize": { "properties": { From e4a48bcac773f6cb82aab3b4d8ae7988e209124c Mon Sep 17 00:00:00 2001 From: Cigdem Celik Aydin Date: Fri, 12 Jul 2019 15:52:55 -0700 Subject: [PATCH 15/22] Update GetADedicatedHost.json --- .../stable/2019-03-01/examples/GetADedicatedHost.json | 4 ---- 1 file changed, 4 deletions(-) diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/GetADedicatedHost.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/GetADedicatedHost.json index 1a4eb54fcbe3..d1ffe03c27be 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/GetADedicatedHost.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/GetADedicatedHost.json @@ -22,10 +22,6 @@ "provisioningState": "Succeeded", "instanceView": { "assetId": "eb3f58b8-b4e8-4882-b69f-301a01812407", - "capacity": { - "totalCores": 30, - "totalVCpus": 60 - }, "availableCapacity": { "availableVCpus": 40, "allocatableVMs": [ From ff70ef5090826cee69655093d672e57c40a510fa Mon Sep 17 00:00:00 2001 From: Cigdem Celik Aydin Date: Fri, 12 Jul 2019 16:08:27 -0700 Subject: [PATCH 16/22] remove .orig files --- .../CreateOrUpdateADedicatedHost.json.orig | 68 ------------------- ...reateOrUpdateADedicatedHostGroup.json.orig | 65 ------------------ .../examples/GetADedicatedHost.json.orig | 67 ------------------ .../examples/GetADedicatedHostGroup.json.orig | 37 ---------- 4 files changed, 237 deletions(-) delete mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateOrUpdateADedicatedHost.json.orig delete mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateOrUpdateADedicatedHostGroup.json.orig delete mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/GetADedicatedHost.json.orig delete mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/GetADedicatedHostGroup.json.orig diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateOrUpdateADedicatedHost.json.orig b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateOrUpdateADedicatedHost.json.orig deleted file mode 100644 index b29c630e4532..000000000000 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateOrUpdateADedicatedHost.json.orig +++ /dev/null @@ -1,68 +0,0 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "api-version": "2018-10-01", - "parameters": { - "location": "westus", - "tags": { - "department": "HR" - }, - "properties": { - "platformFaultDomain": 1 - }, - "sku": { - "name": "DSv3-Type1" - } - }, - "hostGroupName": "myDedicatedHostGroup", - "hostName": "myDedicatedHost" - }, - "responses": { - "201": { - "body": { - "name": "myDedicatedHost", - "location": "westus", - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup/hosts/myDedicatedHost", - "tags": { - "department": "HR" - }, - "sku": { - "name": "DSv3-Type1" - }, - "properties": { - "platformFaultDomain": 1, - "autoReplaceOnFailure": true, - "hostId": "{GUID}" - } - } - }, -<<<<<<< HEAD - "200": { -======= - "200": { ->>>>>>> upstream/master - "body": { - "properties": { - "platformFaultDomain": 1, - "autoReplaceOnFailure": false, - "licenseType": "Windows_Server_Hybrid", - "hostId": "{GUID}" - }, - "location": "westus", - "tags": { - "department": "HR" - }, - "name": "myDedicatedHost", - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup/hosts/myDedicatedHost", - "sku": { - "name": "DSv3-Type1" - } - } - } - } -<<<<<<< HEAD -} -======= -} ->>>>>>> upstream/master diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateOrUpdateADedicatedHostGroup.json.orig b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateOrUpdateADedicatedHostGroup.json.orig deleted file mode 100644 index 8fa966f9f5e9..000000000000 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/CreateOrUpdateADedicatedHostGroup.json.orig +++ /dev/null @@ -1,65 +0,0 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "resourceGroupName": "myResourceGroup", - "api-version": "2018-10-01", - "hostGroupName": "myDedicatedHostGroup", - "parameters": { - "location": "westus", - "tags": { - "department": "finance" - }, - "zones": [ - "1" - ], - "properties": { - "platformFaultDomainCount": 3 - } - } - }, - "responses": { - "201": { - "body": { - "name": "myDedicatedHostGroup", - "location": "westus", - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup", - "tags": { - "department": "finance" - }, - "zones": [ - "1" - ], - "properties": { - "platformFaultDomainCount": 3, - "hosts": [] - } - } - }, -<<<<<<< HEAD - "200": { -======= - "200": { ->>>>>>> upstream/master - "body": { - "properties": { - "platformFaultDomainCount": 3, - "hosts": [] - }, - "location": "westus", - "tags": { - "department": "finance", - "owner": "myCompany" - }, - "name": "myDedicatedHostGroup", - "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup", - "zones": [ - "1" - ] - } - } - } -<<<<<<< HEAD -} -======= -} ->>>>>>> upstream/master diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/GetADedicatedHost.json.orig b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/GetADedicatedHost.json.orig deleted file mode 100644 index 5ff340ca7d69..000000000000 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/GetADedicatedHost.json.orig +++ /dev/null @@ -1,67 +0,0 @@ -{ - "parameters": { - "subscriptionId": "{subscriptionId}", - "resourceGroupName": "myResourceGroup", - "api-version": "2018-10-01", - "hostGroupName": "myDedicatedHostGroup", - "hostName": "myHost" - }, - "responses": { - "200": { - "body": { - "properties": { - "platformFaultDomain": 1, - "autoReplaceOnFailure": true, - "hostId": "{GUID}", - "provisioningTime": "2019-06-27T01:02:38.3138469+00:00", - "virtualMachines": [ - { - "id": "/subscriptions/subId/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/vm1" - } - ], - "provisioningState": "Succeeded", - "instanceView": { - "assetId": "eb3f58b8-b4e8-4882-b69f-301a01812407", - "capacity": { - "totalCores": 30, - "totalVCpus": 60 - }, - "availableCapacity": { - "availableVCpus": 40, - "allocatableVMs": [ - { - "vmSize": "Standard_A1", - "count": 10 - } - ] - }, - "statuses": [ - { - "code": "ProvisioningState/succeeded", - "level": "Info", - "displayStatus": "Provisioning succeeded" - }, - { - "code": "HealthState/available", - "level": "Info", - "displayStatus": "Host available" - } - ] - } - }, - "location": "westus", - "tags": { - "department": "HR" - }, - "sku": { - "name": "DSv3-Type1" - }, - "name": "myHost" - } - } - } -<<<<<<< HEAD -} -======= -} ->>>>>>> upstream/master diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/GetADedicatedHostGroup.json.orig b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/GetADedicatedHostGroup.json.orig deleted file mode 100644 index 167ed8a293c1..000000000000 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/GetADedicatedHostGroup.json.orig +++ /dev/null @@ -1,37 +0,0 @@ -{ - "parameters": { - "subscriptionId": "{subscriptionId}", - "resourceGroupName": "myResourceGroup", - "api-version": "2018-10-01", - "hostGroupName": "myDedicatedHostGroup" - }, - "responses": { - "200": { - "body": { - "properties": { - "platformFaultDomainCount": 3, - "hosts": [ - { - "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/myDedicatedHostGroup/myHostGroup/Hosts/myHost1" - }, - { - "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/myDedicatedHostGroup/myHostGroup/Hosts/myHost2" - } - ] - }, - "location": "westus", - "tags": { - "{tagName}": "{tagValue}" - }, - "name": "myDedicatedHostGroup", - "zones": [ - "3" - ] - } - } - } -<<<<<<< HEAD -} -======= -} ->>>>>>> upstream/master From 260de18847de9bd081951719b5be5b7f184848a8 Mon Sep 17 00:00:00 2001 From: Cigdem Celik Aydin Date: Fri, 12 Jul 2019 16:13:29 -0700 Subject: [PATCH 17/22] Delete compute.json.orig --- .../stable/2019-03-01/compute.json.orig | 9664 ----------------- 1 file changed, 9664 deletions(-) delete mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json.orig diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json.orig b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json.orig deleted file mode 100644 index 6277f1d93fe0..000000000000 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json.orig +++ /dev/null @@ -1,9664 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ComputeManagementClient", - "description": "The Compute Management Client.", - "version": "2019-03-01" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/providers/Microsoft.Compute/operations": { - "get": { - "tags": [ - "ComputeOperations" - ], - "operationId": "Operations_List", - "description": "Gets a list of compute operations.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ComputeOperationListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}": { - "put": { - "tags": [ - "AvailabilitySets" - ], - "operationId": "AvailabilitySets_CreateOrUpdate", - "description": "Create or update an availability set.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "availabilitySetName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the availability set." - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/AvailabilitySet" - }, - "description": "Parameters supplied to the Create Availability Set operation." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AvailabilitySet" - } - } - }, - "x-ms-examples": { - "Create an availability set.": { - "$ref": "./examples/CreateAnAvailabilitySet.json" - } - } - }, - "patch": { - "tags": [ - "AvailabilitySets" - ], - "operationId": "AvailabilitySets_Update", - "description": "Update an availability set.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "availabilitySetName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the availability set." - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/AvailabilitySetUpdate" - }, - "description": "Parameters supplied to the Update Availability Set operation." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AvailabilitySet" - } - } - } - }, - "delete": { - "tags": [ - "AvailabilitySets" - ], - "operationId": "AvailabilitySets_Delete", - "description": "Delete an availability set.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "availabilitySetName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the availability set." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "204": { - "description": "No Content" - } - } - }, - "get": { - "tags": [ - "AvailabilitySets" - ], - "operationId": "AvailabilitySets_Get", - "description": "Retrieves information about an availability set.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "availabilitySetName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the availability set." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AvailabilitySet" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/availabilitySets": { - "get": { - "tags": [ - "AvailabilitySets" - ], - "operationId": "AvailabilitySets_ListBySubscription", - "description": "Lists all availability sets in a subscription.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AvailabilitySetListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets": { - "get": { - "tags": [ - "AvailabilitySets" - ], - "operationId": "AvailabilitySets_List", - "description": "Lists all availability sets in a resource group.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/AvailabilitySetListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}/vmSizes": { - "get": { - "tags": [ - "AvailabilitySets" - ], - "operationId": "AvailabilitySets_ListAvailableSizes", - "description": "Lists all available virtual machine sizes that can be used to create a new virtual machine in an existing availability set.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "availabilitySetName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the availability set." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VirtualMachineSizeListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/proximityPlacementGroups/{proximityPlacementGroupName}": { - "put": { - "tags": [ - "ProximityPlacementGroups" - ], - "operationId": "ProximityPlacementGroups_CreateOrUpdate", - "description": "Create or update a proximity placement group.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "proximityPlacementGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the proximity placement group." - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ProximityPlacementGroup" - }, - "description": "Parameters supplied to the Create Proximity Placement Group operation." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ProximityPlacementGroup" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/ProximityPlacementGroup" - } - } - }, - "x-ms-examples": { - "Create or Update a proximity placement group.": { - "$ref": "./examples/CreateOrUpdateAProximityPlacementGroup.json" - } - } - }, - "patch": { - "tags": [ - "ProximityPlacementGroups" - ], - "operationId": "ProximityPlacementGroups_Update", - "description": "Update a proximity placement group.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "proximityPlacementGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the proximity placement group." - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ProximityPlacementGroupUpdate" - }, - "description": "Parameters supplied to the Update Proximity Placement Group operation." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ProximityPlacementGroup" - } - } - }, - "x-ms-examples": { - "Create a proximity placement group.": { - "$ref": "./examples/PatchAProximityPlacementGroup.json" - } - } - }, - "delete": { - "tags": [ - "ProximityPlacementGroups" - ], - "operationId": "ProximityPlacementGroups_Delete", - "description": "Delete a proximity placement group.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "proximityPlacementGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the proximity placement group." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK" - } - }, - "x-ms-examples": { - "Create a proximity placement group.": { - "$ref": "./examples/DeleteAProximityPlacementGroup.json" - } - } - }, - "get": { - "tags": [ - "ProximityPlacementGroups" - ], - "operationId": "ProximityPlacementGroups_Get", - "description": "Retrieves information about a proximity placement group .", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "proximityPlacementGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the proximity placement group." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ProximityPlacementGroup" - } - } - }, - "x-ms-examples": { - "Create a proximity placement group.": { - "$ref": "./examples/GetAProximityPlacementGroup.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/proximityPlacementGroups": { - "get": { - "tags": [ - "ProximityPlacementGroups" - ], - "operationId": "ProximityPlacementGroups_ListBySubscription", - "description": "Lists all proximity placement groups in a subscription.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ProximityPlacementGroupListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Create a proximity placement group.": { - "$ref": "./examples/ListProximityPlacementGroupsInASubscription.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/proximityPlacementGroups": { - "get": { - "tags": [ - "ProximityPlacementGroups" - ], - "operationId": "ProximityPlacementGroups_ListByResourceGroup", - "description": "Lists all proximity placement groups in a resource group.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ProximityPlacementGroupListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Create a proximity placement group.": { - "$ref": "./examples/ListProximityPlacementGroupsInAResourceGroup.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}": { - "put": { - "tags": [ - "DedicatedHostGroups" - ], - "operationId": "DedicatedHostGroups_CreateOrUpdate", - "description": "Create or update a dedicated host group. For details of Dedicated Host and Dedicated Host Groups please see [Dedicated Host Documentation] (https://go.microsoft.com/fwlink/?linkid=2082596)", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "hostGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the dedicated host group." - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/DedicatedHostGroup" - }, - "description": "Parameters supplied to the Create Dedicated Host Group." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/DedicatedHostGroup" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/DedicatedHostGroup" - } - } - }, - "x-ms-examples": { - "Create or update a dedicated host group.": { - "$ref": "./examples/CreateOrUpdateADedicatedHostGroup.json" - } - } - }, - "patch": { - "tags": [ - "DedicatedHostGroups" - ], - "operationId": "DedicatedHostGroups_Update", - "description": "Update an dedicated host group.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "hostGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the dedicated host group." - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/DedicatedHostGroupUpdate" - }, - "description": "Parameters supplied to the Update Dedicated Host Group operation." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/DedicatedHostGroup" - } - } - } - }, - "delete": { - "tags": [ - "DedicatedHostGroups" - ], - "operationId": "DedicatedHostGroups_Delete", - "description": "Delete a dedicated host group.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "hostGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the dedicated host group." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "204": { - "description": "No Content" - } - } - }, - "get": { - "tags": [ - "DedicatedHostGroups" - ], - "operationId": "DedicatedHostGroups_Get", - "description": "Retrieves information about a dedicated host group.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "hostGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the dedicated host group." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/DedicatedHostGroup" - } - } - }, - "x-ms-examples": { - "Create a dedicated host group.": { - "$ref": "./examples/GetADedicatedHostGroup.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups": { - "get": { - "tags": [ - "DedicatedHostGroups" - ], - "operationId": "DedicatedHostGroups_ListByResourceGroup", - "description": "Lists all of the dedicated host groups in the specified resource group. Use the nextLink property in the response to get the next page of dedicated host groups.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/DedicatedHostGroupListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/hostGroups": { - "get": { - "tags": [ - "DedicatedHostGroups" - ], - "operationId": "DedicatedHostGroups_ListBySubscription", - "description": "Lists all of the dedicated host groups in the subscription. Use the nextLink property in the response to get the next page of dedicated host groups.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/DedicatedHostGroupListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}/hosts/{hostName}": { - "put": { - "tags": [ - "DedicatedHosts" - ], - "operationId": "DedicatedHosts_CreateOrUpdate", - "description": "Create or update a dedicated host .", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "hostGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the dedicated host group." - }, - { - "name": "hostName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the dedicated host ." - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/DedicatedHost" - }, - "description": "Parameters supplied to the Create Dedicated Host ." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/DedicatedHost" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/DedicatedHost" - } - } - }, - "x-ms-examples": { - "Create or update a dedicated host .": { - "$ref": "./examples/CreateOrUpdateADedicatedHost.json" - } - }, - "x-ms-long-running-operation": true - }, - "patch": { - "tags": [ - "DedicatedHosts" - ], - "operationId": "DedicatedHosts_Update", - "description": "Update an dedicated host .", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "hostGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the dedicated host group." - }, - { - "name": "hostName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the dedicated host ." - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/DedicatedHostUpdate" - }, - "description": "Parameters supplied to the Update Dedicated Host operation." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/DedicatedHost" - } - } - }, - "x-ms-long-running-operation": true - }, - "delete": { - "tags": [ - "DedicatedHosts" - ], - "operationId": "DedicatedHosts_Delete", - "description": "Delete a dedicated host.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "hostGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the dedicated host group." - }, - { - "name": "hostName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the dedicated host." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - }, - "204": { - "description": "No Content" - } - }, - "x-ms-long-running-operation": true - }, - "get": { - "tags": [ - "DedicatedHosts" - ], - "operationId": "DedicatedHosts_Get", - "description": "Retrieves information about a dedicated host.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "hostGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the dedicated host group." - }, - { - "name": "hostName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the dedicated host." - }, - { - "name": "$expand", - "in": "query", - "required": false, - "type": "string", - "description": "The expand expression to apply on the operation.", - "enum": [ - "instanceView" - ], - "x-ms-enum": { - "name": "InstanceViewTypes", - "modelAsString": false - } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/DedicatedHost" - } - } - }, - "x-ms-examples": { - "Get a dedicated host.": { - "$ref": "./examples/GetADedicatedHost.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}/hosts": { - "get": { - "tags": [ - "DedicatedHost" - ], - "operationId": "DedicatedHosts_ListByHostGroup", - "description": "Lists all of the dedicated hosts in the specified dedicated host group. Use the nextLink property in the response to get the next page of dedicated hosts.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "hostGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the dedicated host group." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/DedicatedHostListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmextension/types/{type}/versions/{version}": { - "get": { - "tags": [ - "VirtualMachineExtensionImages" - ], - "operationId": "VirtualMachineExtensionImages_Get", - "description": "Gets a virtual machine extension image.", - "parameters": [ - { - "name": "location", - "in": "path", - "required": true, - "type": "string", - "description": "The name of a supported Azure region." - }, - { - "name": "publisherName", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "type", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "version", - "in": "path", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VirtualMachineExtensionImage" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmextension/types": { - "get": { - "tags": [ - "VirtualMachineExtensionImages" - ], - "operationId": "VirtualMachineExtensionImages_ListTypes", - "description": "Gets a list of virtual machine extension image types.", - "parameters": [ - { - "name": "location", - "in": "path", - "required": true, - "type": "string", - "description": "The name of a supported Azure region." - }, - { - "name": "publisherName", - "in": "path", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineExtensionImage" - } - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmextension/types/{type}/versions": { - "get": { - "tags": [ - "VirtualMachineExtensionImages" - ], - "operationId": "VirtualMachineExtensionImages_ListVersions", - "description": "Gets a list of virtual machine extension image versions.", - "parameters": [ - { - "name": "location", - "in": "path", - "required": true, - "type": "string", - "description": "The name of a supported Azure region." - }, - { - "name": "publisherName", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "type", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "The filter to apply on the operation." - }, - { - "name": "$top", - "in": "query", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "$orderby", - "in": "query", - "required": false, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineExtensionImage" - } - } - } - }, - "x-ms-odata": "#/definitions/VirtualMachineExtensionImage" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{vmExtensionName}": { - "put": { - "tags": [ - "VirtualMachineExtensions" - ], - "operationId": "VirtualMachineExtensions_CreateOrUpdate", - "description": "The operation to create or update the extension.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the virtual machine where the extension should be created or updated." - }, - { - "name": "vmExtensionName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the virtual machine extension." - }, - { - "name": "extensionParameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/VirtualMachineExtension" - }, - "description": "Parameters supplied to the Create Virtual Machine Extension operation." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VirtualMachineExtension" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/VirtualMachineExtension" - } - } - }, - "x-ms-long-running-operation": true - }, - "patch": { - "tags": [ - "VirtualMachineExtensions" - ], - "operationId": "VirtualMachineExtensions_Update", - "description": "The operation to update the extension.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the virtual machine where the extension should be updated." - }, - { - "name": "vmExtensionName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the virtual machine extension." - }, - { - "name": "extensionParameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/VirtualMachineExtensionUpdate" - }, - "description": "Parameters supplied to the Update Virtual Machine Extension operation." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VirtualMachineExtension" - } - } - }, - "x-ms-long-running-operation": true - }, - "delete": { - "tags": [ - "VirtualMachineExtensions" - ], - "operationId": "VirtualMachineExtensions_Delete", - "description": "The operation to delete the extension.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the virtual machine where the extension should be deleted." - }, - { - "name": "vmExtensionName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the virtual machine extension." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - }, - "204": { - "description": "No Content" - } - }, - "x-ms-long-running-operation": true - }, - "get": { - "tags": [ - "VirtualMachineExtensions" - ], - "operationId": "VirtualMachineExtensions_Get", - "description": "The operation to get the extension.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the virtual machine containing the extension." - }, - { - "name": "vmExtensionName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the virtual machine extension." - }, - { - "name": "$expand", - "in": "query", - "required": false, - "type": "string", - "description": "The expand expression to apply on the operation." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VirtualMachineExtension" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions": { - "get": { - "tags": [ - "VirtualMachineExtensions" - ], - "operationId": "VirtualMachineExtensions_List", - "description": "The operation to get all extensions of a Virtual Machine.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the virtual machine containing the extension." - }, - { - "name": "$expand", - "in": "query", - "required": false, - "type": "string", - "description": "The expand expression to apply on the operation." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VirtualMachineExtensionsListResult" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus/{skus}/versions/{version}": { - "get": { - "tags": [ - "VirtualMachineImages" - ], - "operationId": "VirtualMachineImages_Get", - "description": "Gets a virtual machine image.", - "parameters": [ - { - "name": "location", - "in": "path", - "required": true, - "type": "string", - "description": "The name of a supported Azure region." - }, - { - "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" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus/{skus}/versions": { - "get": { - "tags": [ - "VirtualMachineImages" - ], - "operationId": "VirtualMachineImages_List", - "description": "Gets a list of all virtual machine image versions for the specified location, publisher, offer, and SKU.", - "parameters": [ - { - "name": "location", - "in": "path", - "required": true, - "type": "string", - "description": "The name of a supported Azure region." - }, - { - "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": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "The filter to apply on the operation." - }, - { - "name": "$top", - "in": "query", - "required": false, - "type": "integer", - "format": "int32" - }, - { - "name": "$orderby", - "in": "query", - "required": false, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineImageResource" - } - } - } - }, - "x-ms-odata": "#/definitions/VirtualMachineImageResource" - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers": { - "get": { - "tags": [ - "VirtualMachineImages" - ], - "operationId": "VirtualMachineImages_ListOffers", - "description": "Gets a list of virtual machine image offers for the specified location and publisher.", - "parameters": [ - { - "name": "location", - "in": "path", - "required": true, - "type": "string", - "description": "The name of a supported Azure region." - }, - { - "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" - } - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers": { - "get": { - "tags": [ - "VirtualMachineImages" - ], - "operationId": "VirtualMachineImages_ListPublishers", - "description": "Gets a list of virtual machine image publishers for the specified Azure location.", - "parameters": [ - { - "name": "location", - "in": "path", - "required": true, - "type": "string", - "description": "The name of a supported Azure region." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineImageResource" - } - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus": { - "get": { - "tags": [ - "VirtualMachineImages" - ], - "operationId": "VirtualMachineImages_ListSkus", - "description": "Gets a list of virtual machine image SKUs for the specified location, publisher, and offer.", - "parameters": [ - { - "name": "location", - "in": "path", - "required": true, - "type": "string", - "description": "The name of a supported Azure region." - }, - { - "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" - } - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/usages": { - "get": { - "tags": [ - "Usage" - ], - "operationId": "Usage_List", - "description": "Gets, for the specified location, the current compute resource usage information as well as the limits for compute resources under the subscription.", - "parameters": [ - { - "name": "location", - "in": "path", - "required": true, - "type": "string", - "description": "The location for which resource usage is queried.", - "pattern": "^[-\\w\\._]+$" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ListUsagesResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/virtualMachines": { - "get": { - "tags": [ - "VirtualMachines" - ], - "operationId": "VirtualMachines_ListByLocation", - "description": "Gets all the virtual machines under the specified subscription for the specified location.", - "parameters": [ - { - "name": "location", - "in": "path", - "required": true, - "type": "string", - "description": "The location for which virtual machines under the subscription are queried.", - "pattern": "^[-\\w\\._]+$" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VirtualMachineListResult" - } - } - }, - "x-ms-examples": { - "Lists all the virtual machines under the specified subscription for the specified location.": { - "$ref": "./examples/ListVirtualMachinesInASubscriptionByLocation.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/vmSizes": { - "get": { - "tags": [ - "VirtualMachineSizes" - ], - "operationId": "VirtualMachineSizes_List", - "description": "This API is deprecated. Use [Resources Skus](https://docs.microsoft.com/en-us/rest/api/compute/resourceskus/list)", - "parameters": [ - { - "name": "location", - "in": "path", - "required": true, - "type": "string", - "description": "The location upon which virtual-machine-sizes is queried.", - "pattern": "^[-\\w\\._]+$" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VirtualMachineSizeListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/images/{imageName}": { - "put": { - "tags": [ - "Images" - ], - "operationId": "Images_CreateOrUpdate", - "description": "Create or update an image.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "imageName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the image." - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/Image" - }, - "description": "Parameters supplied to the Create Image operation." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Image" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/Image" - } - } - }, - "x-ms-examples": { - "Create a virtual machine image from a blob.": { - "$ref": "./examples/CreateAnImageFromABlob.json" - }, - "Create a virtual machine image from a snapshot.": { - "$ref": "./examples/CreateAnImageFromASnapshot.json" - }, - "Create a virtual machine image from a managed disk.": { - "$ref": "./examples/CreateAnImageFromAManagedDisk.json" - }, - "Create a virtual machine image from an existing virtual machine.": { - "$ref": "./examples/CreateAnImageFromAVM.json" - }, - "Create a virtual machine image that includes a data disk from a blob.": { - "$ref": "./examples/CreateAnImageThatIncludesADataDiskFromABlob.json" - }, - "Create a virtual machine image that includes a data disk from a snapshot.": { - "$ref": "./examples/CreateAnImageThatIncludesADataDiskFromASnapshot.json" - }, - "Create a virtual machine image that includes a data disk from a managed disk.": { - "$ref": "./examples/CreateAnImageThatIncludesADataDiskFromAManagedDisk.json" - } - }, - "x-ms-long-running-operation": true - }, - "patch": { - "tags": [ - "Images" - ], - "operationId": "Images_Update", - "description": "Update an image.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "imageName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the image." - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ImageUpdate" - }, - "description": "Parameters supplied to the Update Image operation." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Image" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/Image" - } - } - }, - "x-ms-long-running-operation": true - }, - "delete": { - "tags": [ - "Images" - ], - "operationId": "Images_Delete", - "description": "Deletes an Image.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "imageName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the image." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - }, - "204": { - "description": "No Content" - } - }, - "x-ms-long-running-operation": true - }, - "get": { - "tags": [ - "Images" - ], - "operationId": "Images_Get", - "description": "Gets an image.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "imageName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the image." - }, - { - "name": "$expand", - "in": "query", - "required": false, - "type": "string", - "description": "The expand expression to apply on the operation." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Image" - } - } - }, - "x-ms-examples": { - "Get information about a virtual machine image.": { - "$ref": "./examples/GetInformationAboutAnImage.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/images": { - "get": { - "tags": [ - "Images" - ], - "operationId": "Images_ListByResourceGroup", - "description": "Gets the list of images under a resource group.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ImageListResult" - } - } - }, - "x-ms-examples": { - "List all virtual machine images in a resource group.": { - "$ref": "./examples/ListImagesInAResourceGroup.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/images": { - "get": { - "tags": [ - "Images" - ], - "operationId": "Images_List", - "description": "Gets the list of Images in the subscription. Use nextLink property in the response to get the next page of Images. Do this till nextLink is null to fetch all the Images.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ImageListResult" - } - } - }, - "x-ms-examples": { - "List all virtual machine images in a subscription.": { - "$ref": "./examples/ListImagesInASubscription.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/capture": { - "post": { - "tags": [ - "VirtualMachines" - ], - "operationId": "VirtualMachines_Capture", - "description": "Captures the VM by copying virtual hard disks of the VM and outputs a template that can be used to create similar VMs.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the virtual machine." - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/VirtualMachineCaptureParameters" - }, - "description": "Parameters supplied to the Capture Virtual Machine operation." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VirtualMachineCaptureResult" - } - }, - "202": { - "description": "Accepted" - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}": { - "put": { - "tags": [ - "VirtualMachines" - ], - "operationId": "VirtualMachines_CreateOrUpdate", - "description": "The operation to create or update a virtual machine.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the virtual machine." - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/VirtualMachine" - }, - "description": "Parameters supplied to the Create Virtual Machine operation." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VirtualMachine" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/VirtualMachine" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Create a vm with password authentication.": { - "$ref": "./examples/CreateAVmWithPasswordAuthentication.json" - }, - "Create a vm with ssh authentication.": { - "$ref": "./examples/CreateAVmWithSshAuthentication.json" - }, - "Create a vm with premium storage.": { - "$ref": "./examples/CreateAVmWithPremiumStorage.json" - }, - "Create a vm in an availability set.": { - "$ref": "./examples/CreateAVmInAnAvailabilitySet.json" - }, - "Create a vm with boot diagnostics.": { - "$ref": "./examples/CreateAVmWithBootDiagnostics.json" - }, - "Create a vm with empty data disks.": { - "$ref": "./examples/CreateAVmWithEmptyDataDisks.json" - }, - "Create a vm with a marketplace image plan.": { - "$ref": "./examples/CreateAVmWithAMarketplaceImagePlan.json" - }, - "Create a vm from a custom image.": { - "$ref": "./examples/CreateAVmFromACustomImage.json" - }, - "Create a platform-image vm with unmanaged os and data disks.": { - "$ref": "./examples/CreateAPlatformImageVmWithUnmanagedOsAndDataDisks.json" - }, - "Create a custom-image vm from an unmanaged generalized os image.": { - "$ref": "./examples/CreateACustomImageVmFromAnUnmanagedGeneralizedOsImage.json" - }, - "Create a vm with ephemeral os disk.": { - "$ref": "./examples/CreateAVmWithADiffOsDisk.json" - } - } - }, - "patch": { - "tags": [ - "VirtualMachines" - ], - "operationId": "VirtualMachines_Update", - "description": "The operation to update a virtual machine.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the virtual machine." - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/VirtualMachineUpdate" - }, - "description": "Parameters supplied to the Update Virtual Machine operation." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VirtualMachine" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/VirtualMachine" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Update a VM by detaching data disk": { - "$ref": "./examples/UpdateVMDetachDataDiskUsingToBeDetachedProperty.json" - } - } - }, - "delete": { - "tags": [ - "VirtualMachines" - ], - "operationId": "VirtualMachines_Delete", - "description": "The operation to delete a virtual machine.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the virtual machine." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - }, - "204": { - "description": "No Content" - } - }, - "x-ms-long-running-operation": true - }, - "get": { - "tags": [ - "VirtualMachines" - ], - "operationId": "VirtualMachines_Get", - "description": "Retrieves information about the model view or the instance view of a virtual machine.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the virtual machine." - }, - { - "name": "$expand", - "in": "query", - "required": false, - "type": "string", - "description": "The expand expression to apply on the operation.", - "enum": [ - "instanceView" - ], - "x-ms-enum": { - "name": "InstanceViewTypes", - "modelAsString": false - } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VirtualMachine" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/instanceView": { - "get": { - "tags": [ - "VirtualMachines" - ], - "operationId": "VirtualMachines_InstanceView", - "description": "Retrieves information about the run-time state of a virtual machine.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the virtual machine." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VirtualMachineInstanceView" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/convertToManagedDisks": { - "post": { - "tags": [ - "VirtualMachines" - ], - "operationId": "VirtualMachines_ConvertToManagedDisks", - "description": "Converts virtual machine disks from blob-based to managed disks. Virtual machine must be stop-deallocated before invoking this operation.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the virtual machine." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/deallocate": { - "post": { - "tags": [ - "VirtualMachines" - ], - "operationId": "VirtualMachines_Deallocate", - "description": "Shuts down the virtual machine and releases the compute resources. You are not billed for the compute resources that this virtual machine uses.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the virtual machine." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/generalize": { - "post": { - "tags": [ - "VirtualMachines" - ], - "operationId": "VirtualMachines_Generalize", - "description": "Sets the state of the virtual machine to generalized.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the virtual machine." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines": { - "get": { - "tags": [ - "VirtualMachines" - ], - "operationId": "VirtualMachines_List", - "description": "Lists all of the virtual machines in the specified resource group. Use the nextLink property in the response to get the next page of virtual machines.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VirtualMachineListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/virtualMachines": { - "get": { - "tags": [ - "VirtualMachines" - ], - "operationId": "VirtualMachines_ListAll", - "description": "Lists all of the virtual machines in the specified subscription. Use the nextLink property in the response to get the next page of virtual machines.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VirtualMachineListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/vmSizes": { - "get": { - "tags": [ - "VirtualMachines" - ], - "operationId": "VirtualMachines_ListAvailableSizes", - "description": "Lists all available virtual machine sizes to which the specified virtual machine can be resized.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the virtual machine." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VirtualMachineSizeListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - }, - "x-ms-examples": { - "Lists all available virtual machine sizes to which the specified virtual machine can be resized": { - "$ref": "./examples/ListAvailableVmSizes_VirtualMachines.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/powerOff": { - "post": { - "tags": [ - "VirtualMachines" - ], - "operationId": "VirtualMachines_PowerOff", - "description": "The operation to power off (stop) a virtual machine. The virtual machine can be restarted with the same provisioned resources. You are still charged for this virtual machine.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the virtual machine." - }, - { - "name": "skipShutdown", - "in": "query", - "required": false, - "type": "boolean", - "default": false, - "description": "The parameter to request non-graceful VM shutdown. True value for this flag indicates non-graceful shutdown whereas false indicates otherwise. Default value for this flag is false if not specified" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/restart": { - "post": { - "tags": [ - "VirtualMachines" - ], - "operationId": "VirtualMachines_Restart", - "description": "The operation to restart a virtual machine.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the virtual machine." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/start": { - "post": { - "tags": [ - "VirtualMachines" - ], - "operationId": "VirtualMachines_Start", - "description": "The operation to start a virtual machine.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the virtual machine." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/redeploy": { - "post": { - "tags": [ - "VirtualMachines" - ], - "operationId": "VirtualMachines_Redeploy", - "description": "The operation to redeploy a virtual machine.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the virtual machine." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/reimage": { - "post": { - "tags": [ - "VirtualMachines" - ], - "operationId": "VirtualMachines_Reimage", - "description": "Reimages the virtual machine which has an ephemeral OS disk back to its initial state.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the virtual machine." - }, - { - "name": "parameters", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/VirtualMachineReimageParameters" - }, - "description": "Parameters supplied to the Reimage Virtual Machine operation." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Reimage a Virtual Machine.": { - "$ref": "./examples/ReimageVirtualMachine.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/performMaintenance": { - "post": { - "tags": [ - "VirtualMachines" - ], - "operationId": "VirtualMachines_PerformMaintenance", - "description": "The operation to perform maintenance on a virtual machine.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the virtual machine." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}": { - "put": { - "tags": [ - "VirtualMachineScaleSets" - ], - "operationId": "VirtualMachineScaleSets_CreateOrUpdate", - "description": "Create or update a VM scale set.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmScaleSetName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the VM scale set to create or update." - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/VirtualMachineScaleSet" - }, - "description": "The scale set object." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VirtualMachineScaleSet" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/VirtualMachineScaleSet" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Create a scale set with password authentication.": { - "$ref": "./examples/CreateAScaleSetWithPasswordAuthentication.json" - }, - "Create a scale set with ssh authentication.": { - "$ref": "./examples/CreateAScaleSetWithSshAuthentication.json" - }, - "Create a scale set with premium storage.": { - "$ref": "./examples/CreateAScaleSetWithPremiumStorage.json" - }, - "Create a scale set with empty data disks on each vm.": { - "$ref": "./examples/CreateAScaleSetWithEmptyDataDisksOnEachVm.json" - }, - "Create a scale set with an azure load balancer.": { - "$ref": "./examples/CreateAScaleSetWithAnAzureLoadBalancer.json" - }, - "Create a scale set with an azure application gateway.": { - "$ref": "./examples/CreateAScaleSetWithAnAzureApplicationGateway.json" - }, - "Create a scale set with boot diagnostics.": { - "$ref": "./examples/CreateAScaleSetWithBootDiagnostics.json" - }, - "Create a scale set with a marketplace image plan.": { - "$ref": "./examples/CreateAScaleSetWithAMarketplaceImagePlan.json" - }, - "Create a scale set from a custom image.": { - "$ref": "./examples/CreateAScaleSetFromACustomImage.json" - }, - "Create a platform-image scale set with unmanaged os disks.": { - "$ref": "./examples/CreateAPlatformImageScaleSetWithUnmanagedOsDisks.json" - }, - "Create a custom-image scale set from an unmanaged generalized os image.": { - "$ref": "./examples/CreateACustomImageScaleSetFromAnUnmanagedGeneralizedOsImage.json" - }, - "Create a scale set with virtual machines in different zones.": { - "$ref": "./examples/CreateAScaleSetWithVMsInDifferentZones.json" - }, - "Create a scale set with ephemeral os disks.": { - "$ref": "./examples/CreateAScaleSetWithDiffOsDisk.json" - } - } - }, - "patch": { - "tags": [ - "VirtualMachineScaleSets" - ], - "operationId": "VirtualMachineScaleSets_Update", - "description": "Update a VM scale set.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmScaleSetName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the VM scale set to create or update." - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/VirtualMachineScaleSetUpdate" - }, - "description": "The scale set object." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VirtualMachineScaleSet" - } - } - }, - "x-ms-long-running-operation": true - }, - "delete": { - "tags": [ - "VirtualMachineScaleSets" - ], - "operationId": "VirtualMachineScaleSets_Delete", - "description": "Deletes a VM scale set.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmScaleSetName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the VM scale set." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - }, - "204": { - "description": "No Content" - } - }, - "x-ms-long-running-operation": true - }, - "get": { - "tags": [ - "VirtualMachineScaleSets" - ], - "operationId": "VirtualMachineScaleSets_Get", - "description": "Display information about a virtual machine scale set.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmScaleSetName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the VM scale set." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VirtualMachineScaleSet" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/deallocate": { - "post": { - "tags": [ - "VirtualMachineScaleSets" - ], - "operationId": "VirtualMachineScaleSets_Deallocate", - "description": "Deallocates specific virtual machines in a VM scale set. Shuts down the virtual machines and releases the compute resources. You are not billed for the compute resources that this virtual machine scale set deallocates.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmScaleSetName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the VM scale set." - }, - { - "name": "vmInstanceIDs", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" - }, - "description": "A list of virtual machine instance IDs from the VM scale set." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/delete": { - "post": { - "tags": [ - "VirtualMachineScaleSets" - ], - "operationId": "VirtualMachineScaleSets_DeleteInstances", - "description": "Deletes virtual machines in a VM scale set.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmScaleSetName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the VM scale set." - }, - { - "name": "vmInstanceIDs", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceRequiredIDs" - }, - "description": "A list of virtual machine instance IDs from the VM scale set." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/instanceView": { - "get": { - "tags": [ - "VirtualMachineScaleSets" - ], - "operationId": "VirtualMachineScaleSets_GetInstanceView", - "description": "Gets the status of a VM scale set instance.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmScaleSetName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the VM scale set." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VirtualMachineScaleSetInstanceView" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets": { - "get": { - "tags": [ - "VirtualMachineScaleSets" - ], - "operationId": "VirtualMachineScaleSets_List", - "description": "Gets a list of all VM scale sets under a resource group.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VirtualMachineScaleSetListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensions/{vmssExtensionName}": { - "put": { - "tags": [ - "VirtualMachineScaleSetExtensions" - ], - "operationId": "VirtualMachineScaleSetExtensions_CreateOrUpdate", - "description": "The operation to create or update an extension.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmScaleSetName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the VM scale set where the extension should be create or updated." - }, - { - "name": "vmssExtensionName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the VM scale set extension." - }, - { - "name": "extensionParameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/VirtualMachineScaleSetExtension" - }, - "description": "Parameters supplied to the Create VM scale set Extension operation." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VirtualMachineScaleSetExtension" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/VirtualMachineScaleSetExtension" - } - } - }, - "x-ms-long-running-operation": true - }, - "delete": { - "tags": [ - "VirtualMachineScaleSetExtensions" - ], - "operationId": "VirtualMachineScaleSetExtensions_Delete", - "description": "The operation to delete the extension.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmScaleSetName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the VM scale set where the extension should be deleted." - }, - { - "name": "vmssExtensionName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the VM scale set extension." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - }, - "204": { - "description": "No Content" - } - }, - "x-ms-long-running-operation": true - }, - "get": { - "tags": [ - "VirtualMachineScaleSetExtensions" - ], - "operationId": "VirtualMachineScaleSetExtensions_Get", - "description": "The operation to get the extension.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmScaleSetName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the VM scale set containing the extension." - }, - { - "name": "vmssExtensionName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the VM scale set extension." - }, - { - "name": "$expand", - "in": "query", - "required": false, - "type": "string", - "description": "The expand expression to apply on the operation." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VirtualMachineScaleSetExtension" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensions": { - "get": { - "tags": [ - "VirtualMachineScaleSetExtensions" - ], - "operationId": "VirtualMachineScaleSetExtensions_List", - "description": "Gets a list of all extensions in a VM scale set.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmScaleSetName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the VM scale set containing the extension." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VirtualMachineScaleSetExtensionListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/virtualMachineScaleSets": { - "get": { - "tags": [ - "VirtualMachineScaleSets" - ], - "operationId": "VirtualMachineScaleSets_ListAll", - "description": "Gets a list of all VM Scale Sets in the subscription, regardless of the associated resource group. Use nextLink property in the response to get the next page of VM Scale Sets. Do this till nextLink is null to fetch all the VM Scale Sets.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VirtualMachineScaleSetListWithLinkResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/skus": { - "get": { - "tags": [ - "VirtualMachineScaleSets" - ], - "operationId": "VirtualMachineScaleSets_ListSkus", - "description": "Gets a list of SKUs available for your VM scale set, including the minimum and maximum VM instances allowed for each SKU.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmScaleSetName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the VM scale set." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VirtualMachineScaleSetListSkusResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/osUpgradeHistory": { - "get": { - "tags": [ - "VirtualMachineScaleSets" - ], - "operationId": "VirtualMachineScaleSets_GetOSUpgradeHistory", - "description": "Gets list of OS upgrades on a VM scale set instance.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmScaleSetName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the VM scale set." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VirtualMachineScaleSetListOSUpgradeHistory" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/poweroff": { - "post": { - "tags": [ - "VirtualMachineScaleSets" - ], - "operationId": "VirtualMachineScaleSets_PowerOff", - "description": "Power off (stop) one or more virtual machines in a VM scale set. Note that resources are still attached and you are getting charged for the resources. Instead, use deallocate to release resources and avoid charges.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmScaleSetName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the VM scale set." - }, - { - "name": "vmInstanceIDs", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" - }, - "description": "A list of virtual machine instance IDs from the VM scale set." - }, - { - "name": "skipShutdown", - "in": "query", - "required": false, - "type": "boolean", - "default": false, - "description": "The parameter to request non-graceful VM shutdown. True value for this flag indicates non-graceful shutdown whereas false indicates otherwise. Default value for this flag is false if not specified" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/restart": { - "post": { - "tags": [ - "VirtualMachineScaleSets" - ], - "operationId": "VirtualMachineScaleSets_Restart", - "description": "Restarts one or more virtual machines in a VM scale set.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmScaleSetName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the VM scale set." - }, - { - "name": "vmInstanceIDs", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" - }, - "description": "A list of virtual machine instance IDs from the VM scale set." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/start": { - "post": { - "tags": [ - "VirtualMachineScaleSets" - ], - "operationId": "VirtualMachineScaleSets_Start", - "description": "Starts one or more virtual machines in a VM scale set.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmScaleSetName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the VM scale set." - }, - { - "name": "vmInstanceIDs", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" - }, - "description": "A list of virtual machine instance IDs from the VM scale set." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/redeploy": { - "post": { - "tags": [ - "VirtualMachineScaleSets" - ], - "operationId": "VirtualMachineScaleSets_Redeploy", - "description": "Redeploy one or more virtual machines in a VM scale set.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmScaleSetName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the VM scale set." - }, - { - "name": "vmInstanceIDs", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" - }, - "description": "A list of virtual machine instance IDs from the VM scale set." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/performMaintenance": { - "post": { - "tags": [ - "VirtualMachineScaleSets" - ], - "operationId": "VirtualMachineScaleSets_PerformMaintenance", - "description": "Perform maintenance on one or more virtual machines in a VM scale set. Operation on instances which are not eligible for perform maintenance will be failed. Please refer to best practices for more details: https://docs.microsoft.com/en-us/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-maintenance-notifications", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmScaleSetName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the VM scale set." - }, - { - "name": "vmInstanceIDs", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" - }, - "description": "A list of virtual machine instance IDs from the VM scale set." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/manualupgrade": { - "post": { - "tags": [ - "VirtualMachineScaleSets" - ], - "operationId": "VirtualMachineScaleSets_UpdateInstances", - "description": "Upgrades one or more virtual machines to the latest SKU set in the VM scale set model.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmScaleSetName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the VM scale set." - }, - { - "name": "vmInstanceIDs", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceRequiredIDs" - }, - "description": "A list of virtual machine instance IDs from the VM scale set." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/reimage": { - "post": { - "tags": [ - "VirtualMachineScaleSets" - ], - "operationId": "VirtualMachineScaleSets_Reimage", - "description": "Reimages (upgrade the operating system) one or more virtual machines in a VM scale set which don't have a ephemeral OS disk, for virtual machines who have a ephemeral OS disk the virtual machine is reset to initial state.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmScaleSetName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the VM scale set." - }, - { - "name": "vmScaleSetReimageInput", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/VirtualMachineScaleSetReimageParameters" - }, - "description": "Parameters for Reimaging VM ScaleSet." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/reimageall": { - "post": { - "tags": [ - "VirtualMachineScaleSets" - ], - "operationId": "VirtualMachineScaleSets_ReimageAll", - "description": "Reimages all the disks ( including data disks ) in the virtual machines in a VM scale set. This operation is only supported for managed disks.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmScaleSetName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the VM scale set." - }, - { - "name": "vmInstanceIDs", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" - }, - "description": "A list of virtual machine instance IDs from the VM scale set." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/rollingUpgrades/cancel": { - "post": { - "tags": [ - "VirtualMachineScaleSetRollingUpgrades" - ], - "operationId": "VirtualMachineScaleSetRollingUpgrades_Cancel", - "description": "Cancels the current virtual machine scale set rolling upgrade.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmScaleSetName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the VM scale set." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/osRollingUpgrade": { - "post": { - "tags": [ - "VirtualMachineScaleSetRollingUpgrades" - ], - "operationId": "VirtualMachineScaleSetRollingUpgrades_StartOSUpgrade", - "description": "Starts a rolling upgrade to move all virtual machine scale set instances to the latest available Platform Image OS version. Instances which are already running the latest available OS version are not affected.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmScaleSetName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the VM scale set." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensionRollingUpgrade": { - "post": { - "tags": [ - "VirtualMachineScaleSetRollingUpgrades" - ], - "operationId": "VirtualMachineScaleSetRollingUpgrades_StartExtensionUpgrade", - "description": "Starts a rolling upgrade to move all extensions for all virtual machine scale set instances to the latest available extension version. Instances which are already running the latest extension versions are not affected.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmScaleSetName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the VM scale set." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Start an extension rolling upgrade.": { - "$ref": "./examples/VMScaleSetExtensionRollingUpgrade.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/rollingUpgrades/latest": { - "get": { - "tags": [ - "VirtualMachineScaleSetRollingUpgrades" - ], - "operationId": "VirtualMachineScaleSetRollingUpgrades_GetLatest", - "description": "Gets the status of the latest virtual machine scale set rolling upgrade.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmScaleSetName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the VM scale set." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/RollingUpgradeStatusInfo" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/forceRecoveryServiceFabricPlatformUpdateDomainWalk": { - "post": { - "tags": [ - "VirtualMachineScaleSets" - ], - "operationId": "VirtualMachineScaleSets_ForceRecoveryServiceFabricPlatformUpdateDomainWalk", - "description": "Manual platform update domain walk to update virtual machines in a service fabric virtual machine scale set.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmScaleSetName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the VM scale set." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "name": "platformUpdateDomain", - "in": "query", - "required": true, - "type": "integer", - "description": "The platform update domain for which a manual recovery walk is requested" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/RecoveryWalkResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/convertToSinglePlacementGroup": { - "post": { - "tags": [ - "VirtualMachineScaleSets" - ], - "operationId": "VirtualMachineScaleSets_ConvertToSinglePlacementGroup", - "description": "Converts SinglePlacementGroup property to false for a existing virtual machine scale set.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmScaleSetName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the virtual machine scale set to create or update." - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/VMScaleSetConvertToSinglePlacementGroupInput" - }, - "description": "The input object for ConvertToSinglePlacementGroup API." - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/reimage": { - "post": { - "tags": [ - "VirtualMachineScaleSetVMs" - ], - "operationId": "VirtualMachineScaleSetVMs_Reimage", - "description": "Reimages (upgrade the operating system) a specific virtual machine in a VM scale set.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmScaleSetName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the VM scale set." - }, - { - "name": "instanceId", - "in": "path", - "required": true, - "type": "string", - "description": "The instance ID of the virtual machine." - }, - { - "name": "vmScaleSetVMReimageInput", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/VirtualMachineScaleSetVMReimageParameters" - }, - "description": "Parameters for the Reimaging Virtual machine in ScaleSet." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/reimageall": { - "post": { - "tags": [ - "VirtualMachineScaleSetVMs" - ], - "operationId": "VirtualMachineScaleSetVMs_ReimageAll", - "description": "Allows you to re-image all the disks ( including data disks ) in the a VM scale set instance. This operation is only supported for managed disks.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmScaleSetName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the VM scale set." - }, - { - "name": "instanceId", - "in": "path", - "required": true, - "type": "string", - "description": "The instance ID of the virtual machine." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/deallocate": { - "post": { - "tags": [ - "VirtualMachineScaleSetVMs" - ], - "operationId": "VirtualMachineScaleSetVMs_Deallocate", - "description": "Deallocates a specific virtual machine in a VM scale set. Shuts down the virtual machine and releases the compute resources it uses. You are not billed for the compute resources of this virtual machine once it is deallocated.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmScaleSetName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the VM scale set." - }, - { - "name": "instanceId", - "in": "path", - "required": true, - "type": "string", - "description": "The instance ID of the virtual machine." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}": { - "put": { - "tags": [ - "VirtualMachineScaleSetVMs" - ], - "operationId": "VirtualMachineScaleSetVMs_Update", - "description": "Updates a virtual machine of a VM scale set.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmScaleSetName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the VM scale set where the extension should be create or updated." - }, - { - "name": "instanceId", - "in": "path", - "required": true, - "type": "string", - "description": "The instance ID of the virtual machine." - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/VirtualMachineScaleSetVM" - }, - "description": "Parameters supplied to the Update Virtual Machine Scale Sets VM operation." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VirtualMachineScaleSetVM" - } - }, - "202": { - "description": "Accepted", - "schema": { - "$ref": "#/definitions/VirtualMachineScaleSetVM" - } - } - }, - "x-ms-long-running-operation": true - }, - "delete": { - "tags": [ - "VirtualMachineScaleSetVMs" - ], - "operationId": "VirtualMachineScaleSetVMs_Delete", - "description": "Deletes a virtual machine from a VM scale set.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmScaleSetName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the VM scale set." - }, - { - "name": "instanceId", - "in": "path", - "required": true, - "type": "string", - "description": "The instance ID of the virtual machine." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - }, - "204": { - "description": "No Content" - } - }, - "x-ms-long-running-operation": true - }, - "get": { - "tags": [ - "VirtualMachineScaleSetVMs" - ], - "operationId": "VirtualMachineScaleSetVMs_Get", - "description": "Gets a virtual machine from a VM scale set.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmScaleSetName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the VM scale set." - }, - { - "name": "instanceId", - "in": "path", - "required": true, - "type": "string", - "description": "The instance ID of the virtual machine." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VirtualMachineScaleSetVM" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/instanceView": { - "get": { - "tags": [ - "VirtualMachineScaleSetVMs" - ], - "operationId": "VirtualMachineScaleSetVMs_GetInstanceView", - "description": "Gets the status of a virtual machine from a VM scale set.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmScaleSetName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the VM scale set." - }, - { - "name": "instanceId", - "in": "path", - "required": true, - "type": "string", - "description": "The instance ID of the virtual machine." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceView" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines": { - "get": { - "tags": [ - "VirtualMachineScaleSetVMs" - ], - "operationId": "VirtualMachineScaleSetVMs_List", - "description": "Gets a list of all virtual machines in a VM scale sets.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "virtualMachineScaleSetName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the VM scale set." - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "The filter to apply to the operation." - }, - { - "name": "$select", - "in": "query", - "required": false, - "type": "string", - "description": "The list parameters." - }, - { - "name": "$expand", - "in": "query", - "required": false, - "type": "string", - "description": "The expand expression to apply to the operation." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/VirtualMachineScaleSetVMListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-odata": "#/definitions/VirtualMachineScaleSetVM" - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/poweroff": { - "post": { - "tags": [ - "VirtualMachineScaleSetVMs" - ], - "operationId": "VirtualMachineScaleSetVMs_PowerOff", - "description": "Power off (stop) a virtual machine in a VM scale set. Note that resources are still attached and you are getting charged for the resources. Instead, use deallocate to release resources and avoid charges.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmScaleSetName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the VM scale set." - }, - { - "name": "instanceId", - "in": "path", - "required": true, - "type": "string", - "description": "The instance ID of the virtual machine." - }, - { - "name": "skipShutdown", - "in": "query", - "required": false, - "type": "boolean", - "default": false, - "description": "The parameter to request non-graceful VM shutdown. True value for this flag indicates non-graceful shutdown whereas false indicates otherwise. Default value for this flag is false if not specified" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/restart": { - "post": { - "tags": [ - "VirtualMachineScaleSetVMs" - ], - "operationId": "VirtualMachineScaleSetVMs_Restart", - "description": "Restarts a virtual machine in a VM scale set.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmScaleSetName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the VM scale set." - }, - { - "name": "instanceId", - "in": "path", - "required": true, - "type": "string", - "description": "The instance ID of the virtual machine." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/start": { - "post": { - "tags": [ - "VirtualMachineScaleSetVMs" - ], - "operationId": "VirtualMachineScaleSetVMs_Start", - "description": "Starts a virtual machine in a VM scale set.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmScaleSetName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the VM scale set." - }, - { - "name": "instanceId", - "in": "path", - "required": true, - "type": "string", - "description": "The instance ID of the virtual machine." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/redeploy": { - "post": { - "tags": [ - "VirtualMachineScaleSetVMs" - ], - "operationId": "VirtualMachineScaleSetVMs_Redeploy", - "description": "Redeploys a virtual machine in a VM scale set.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmScaleSetName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the VM scale set." - }, - { - "name": "instanceId", - "in": "path", - "required": true, - "type": "string", - "description": "The instance ID of the virtual machine." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/performMaintenance": { - "post": { - "tags": [ - "VirtualMachineScaleSetVMs" - ], - "operationId": "VirtualMachineScaleSetVMs_PerformMaintenance", - "description": "Performs maintenance on a virtual machine in a VM scale set.", - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "vmScaleSetName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the VM scale set." - }, - { - "name": "instanceId", - "in": "path", - "required": true, - "type": "string", - "description": "The instance ID of the virtual machine." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/logAnalytics/apiAccess/getRequestRateByInterval": { - "post": { - "tags": [ - "LogAnalytics" - ], - "operationId": "LogAnalytics_ExportRequestRateByInterval", - "x-ms-examples": { - "Export logs which contain all Api requests made to Compute Resource Provider within the given time period broken down by intervals.": { - "$ref": "./examples/LogAnalyticsRequestRateByInterval.json" - } - }, - "description": "Export logs that show Api requests made by this subscription in the given time window to show throttling activities.", - "parameters": [ - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/RequestRateByIntervalInput" - }, - "description": "Parameters supplied to the LogAnalytics getRequestRateByInterval Api." - }, - { - "name": "location", - "in": "path", - "required": true, - "type": "string", - "description": "The location upon which virtual-machine-sizes is queried.", - "pattern": "^[-\\w\\._]+$" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/LogAnalyticsOperationResult" - } - }, - "202": { - "description": "Accepted" - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/logAnalytics/apiAccess/getThrottledRequests": { - "post": { - "tags": [ - "LogAnalytics" - ], - "operationId": "LogAnalytics_ExportThrottledRequests", - "x-ms-examples": { - "Export logs which contain all throttled Api requests made to Compute Resource Provider within the given time period.": { - "$ref": "./examples/LogAnalyticsThrottledRequests.json" - } - }, - "description": "Export logs that show total throttled Api requests for this subscription in the given time window.", - "parameters": [ - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ThrottledRequestsInput" - }, - "description": "Parameters supplied to the LogAnalytics getThrottledRequests Api." - }, - { - "name": "location", - "in": "path", - "required": true, - "type": "string", - "description": "The location upon which virtual-machine-sizes is queried.", - "pattern": "^[-\\w\\._]+$" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/LogAnalyticsOperationResult" - } - }, - "202": { - "description": "Accepted" - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - } - } - } - }, - "definitions": { - "ComputeOperationListResult": { - "properties": { - "value": { - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/ComputeOperationValue" - }, - "description": "The list of compute operations" - } - }, - "description": "The List Compute Operation operation response." - }, - "ComputeOperationValue": { - "properties": { - "origin": { - "type": "string", - "readOnly": true, - "description": "The origin of the compute operation." - }, - "name": { - "type": "string", - "readOnly": true, - "description": "The name of the compute operation." - }, - "display": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ComputeOperationValueDisplay" - } - }, - "description": "Describes the properties of a Compute Operation value." - }, - "ComputeOperationValueDisplay": { - "properties": { - "operation": { - "type": "string", - "readOnly": true, - "description": "The display name of the compute operation." - }, - "resource": { - "type": "string", - "readOnly": true, - "description": "The display name of the resource the operation applies to." - }, - "description": { - "type": "string", - "readOnly": true, - "description": "The description of the operation." - }, - "provider": { - "type": "string", - "readOnly": true, - "description": "The resource provider for the operation." - } - }, - "description": "Describes the properties of a Compute Operation Value Display." - }, - "HyperVGenerationType": { - "type": "string", - "description": "Specifies the HyperVGeneration Type for the Virtual Machine created from the image", - "enum": [ - "V1", - "V2" - ], - "x-ms-enum": { - "name": "HyperVGenerationTypes", - "modelAsString": true - } - }, - "InstanceViewStatus": { - "properties": { - "code": { - "type": "string", - "description": "The status code." - }, - "level": { - "type": "string", - "description": "The level code.", - "enum": [ - "Info", - "Warning", - "Error" - ], - "x-ms-enum": { - "name": "StatusLevelTypes", - "modelAsString": false - } - }, - "displayStatus": { - "type": "string", - "description": "The short localizable label for the status." - }, - "message": { - "type": "string", - "description": "The detailed status message, including for alerts and error messages." - }, - "time": { - "type": "string", - "format": "date-time", - "description": "The time of the status." - } - }, - "description": "Instance view status." - }, - "AvailabilitySetProperties": { - "properties": { - "platformUpdateDomainCount": { - "type": "integer", - "format": "int32", - "description": "Update Domain count." - }, - "platformFaultDomainCount": { - "type": "integer", - "format": "int32", - "description": "Fault Domain count." - }, - "virtualMachines": { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - }, - "description": "A list of references to all virtual machines in the availability set." - }, - "proximityPlacementGroup": { - "$ref": "#/definitions/SubResource", - "description": "Specifies information about the proximity placement group that the availability set should be assigned to.

    Minimum api-version: 2018-04-01." - }, - "statuses": { - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/InstanceViewStatus" - }, - "description": "The resource status information." - } - }, - "description": "The instance view of a resource." - }, - "AvailabilitySetSkuType": { - "type": "string", - "description": "Specifies the sku of an Availability Set. Use 'Aligned' for virtual machines with managed disks and 'Classic' for virtual machines with unmanaged disks. Default value is 'Classic'.", - "enum": [ - "Classic", - "Aligned" - ], - "x-ms-enum": { - "name": "AvailabilitySetSkuTypes", - "modelAsString": true - } - }, - "AvailabilitySet": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/AvailabilitySetProperties" - }, - "sku": { - "$ref": "#/definitions/Sku", - "description": "Sku of the availability set, only name is required to be set. See AvailabilitySetSkuTypes for possible set of values. Use 'Aligned' for virtual machines with managed disks and 'Classic' for virtual machines with unmanaged disks. Default value is 'Classic'." - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

    For more information on Azure planned maintenance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." - }, - "AvailabilitySetUpdate": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/AvailabilitySetProperties" - }, - "sku": { - "$ref": "#/definitions/Sku", - "description": "Sku of the availability set" - } - }, - "allOf": [ - { - "$ref": "#/definitions/UpdateResource" - } - ], - "description": "Specifies information about the availability set that the virtual machine should be assigned to. Only tags may be updated." - }, - "AvailabilitySetListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/AvailabilitySet" - }, - "description": "The list of availability sets" - }, - "nextLink": { - "type": "string", - "description": "The URI to fetch the next page of AvailabilitySets. Call ListNext() with this URI to fetch the next page of AvailabilitySets." - } - }, - "required": [ - "value" - ], - "description": "The List Availability Set operation response." - }, - "ProximityPlacementGroupProperties": { - "properties": { - "proximityPlacementGroupType": { - "type": "string", - "description": "Specifies the type of the proximity placement group.

    Possible values are:

    **Standard** : Co-locate resources within an Azure region or Availability Zone.

    **Ultra** : For future use.", - "enum": [ - "Standard", - "Ultra" - ], - "x-ms-enum": { - "name": "ProximityPlacementGroupType", - "modelAsString": true - } - }, - "virtualMachines": { - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - }, - "description": "A list of references to all virtual machines in the proximity placement group." - }, - "virtualMachineScaleSets": { - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - }, - "description": "A list of references to all virtual machine scale sets in the proximity placement group." - }, - "availabilitySets": { - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - }, - "description": "A list of references to all availability sets in the proximity placement group." - } - }, - "description": "Describes the properties of a Proximity Placement Group." - }, - "ProximityPlacementGroup": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ProximityPlacementGroupProperties", - "description": "Describes the properties of a Proximity Placement Group." - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "Specifies information about the proximity placement group." - }, - "ProximityPlacementGroupUpdate": { - "allOf": [ - { - "$ref": "#/definitions/UpdateResource" - } - ], - "description": "Specifies information about the proximity placement group." - }, - "ProximityPlacementGroupListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ProximityPlacementGroup" - }, - "description": "The list of proximity placement groups" - }, - "nextLink": { - "type": "string", - "description": "The URI to fetch the next page of proximity placement groups." - } - }, - "required": [ - "value" - ], - "description": "The List Proximity Placement Group operation response." - }, - "DedicatedHostGroupProperties": { - "properties": { - "platformFaultDomainCount": { - "type": "integer", - "format": "int32", - "description": "Number of fault domains that the host group can span. Supported values 1,2,3." - }, - "hosts": { - "type": "array", - "items": { - "$ref": "#/definitions/SubResourceReadOnly" - }, - "readOnly": true, - "description": "A list of references to all dedicated hosts in the dedicated host group." - } - }, - "description": "Dedicated Host Group Properties." - }, - "DedicatedHostGroup": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/DedicatedHostGroupProperties" - }, - "zones": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Availability Zone to use for this host group – only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforce each host in the group is in the same zone." - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "Specifies information about the dedicated host group that the dedicated hosts should be assigned to.

    Currently, a Dedicated host can only be added to Dedicated Host Group at creation time. An existing Dedicated Host cannot be added to a dedicated host group." - }, - "DedicatedHostGroupUpdate": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/DedicatedHostGroupProperties" - }, - "zones": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Availability Zone to use for this host group – only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforce each host in the group is in the same zone." - } - }, - "allOf": [ - { - "$ref": "#/definitions/UpdateResource" - } - ], - "description": "Specifies information about the dedicated host group that the dedicated host should be assigned to. Only tags may be updated." - }, - "DedicatedHostGroupListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/DedicatedHostGroup" - }, - "description": "The list of dedicated host groups" - }, - "nextLink": { - "type": "string", - "description": "The URI to fetch the next page of Dedicated Host Groups. Call ListNext() with this URI to fetch the next page of Dedicated Host Groups." - } - }, - "required": [ - "value" - ], - "description": "The List Dedicated Host Group with resource group response." - }, - "DedicatedHostLicenseType": { - "type": "string", - "description": "Specifies the software license type that will be applied to the VMs deployed on the dedicated host.

    Possible values are:

    **None**

    **Windows_Server_Hybrid**

    **Windows_Server_Perpetual**

    Default: **None**", - "enum": [ - "None", - "Windows_Server_Hybrid", - "Windows_Server_Perpetual" - ], - "x-ms-enum": { - "name": "DedicatedHostLicenseTypes", - "modelAsString": false - } - }, - "DedicatedHostCapacity": { - "properties": { - "totalCores": { - "type": "number", - "format": "double", - "description": "The total number of cores." - }, - "totalVCpus": { - "type": "number", - "format": "double", - "description": "The total number of CPUs." - } - }, - "description": "Dedicated host total capacity." - }, - "DedicatedHostAllocatableVM": { - "properties": { - "vmSize": { - "type": "string", - "description": "VM size in terms of which the unutilized capacity is represented." - }, - "count": { - "type": "number", - "format": "double", - "description": "Maximum number of VMs of size vmSize that can fit in the dedicated host's remaining capacity." - } - }, - "description": "Represents the dedicated host unutilized capacity in terms of a specific VM size." - }, - "DedicatedHostAvailableCapacity": { - "properties": { - "availableVCpus": { - "type": "number", - "format": "double", -<<<<<<< HEAD - "description": "The number of virtual CPUs available for new allocations." -======= - "description": "The total number of CPUs." ->>>>>>> upstream/master - }, - "allocatableVMs": { - "type": "array", - "items": { - "$ref": "#/definitions/DedicatedHostAllocatableVM" - }, - "description": "The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host." - } - }, - "description": "Dedicated host unutilized capacity." - }, - "DedicatedHostInstanceView": { - "properties": { - "assetId": { - "readOnly": true, - "type": "string", - "description": "Specifies the unique of the dedicated physical machine on which the dedicated host resides." - }, - "capacity": { - "$ref": "#/definitions/DedicatedHostCapacity", - "description": "The total capacity of the dedicated host." - }, - "availableCapacity": { - "$ref": "#/definitions/DedicatedHostAvailableCapacity", - "description": "Unutilized capacity of the dedicated host." - }, - "statuses": { - "type": "array", - "items": { - "$ref": "#/definitions/InstanceViewStatus" - }, - "description": "The resource status information." - } - }, - "description": "The instance view of a dedicated host." - }, - "DedicatedHostProperties": { - "properties": { - "platformFaultDomain": { - "type": "integer", - "format": "int32", - "description": "Fault domain of the host within a group. Supported values 0,1,2." - }, - "autoReplaceOnFailure": { - "type": "boolean", - "description": "Whether the host should be replaced automatically in case of a failure. The value is defaulted to true when not provided." - }, - "hostId": { - "readOnly": true, - "type": "string", - "description": "A unique id generated and assigned to the dedicated host by the platform." - }, - "virtualMachines": { - "type": "array", - "items": { - "$ref": "#/definitions/SubResourceReadOnly" - }, - "readOnly": true, - "description": "A list of references to all virtual machines in the Dedicated Host." - }, - "licenseType": { - "$ref": "#/definitions/DedicatedHostLicenseType", - "description": "Specifies the software license type that will be applied to the VMs deployed on the dedicated host.

    Possible values are:

    **None**

    **Windows_Server_Hybrid**

    **Windows_Server_Perpetual**

    Default: **None**" - }, - "provisioningTime": { - "readOnly": true, - "type": "string", - "format": "date-time", -<<<<<<< HEAD - "description": "The date when the host was first provisioned." -======= - "description": "The date when the host was first created." ->>>>>>> upstream/master - }, - "provisioningState": { - "readOnly": true, - "type": "string", - "description": "The provisioning state, which only appears in the response." - }, - "instanceView": { - "$ref": "#/definitions/DedicatedHostInstanceView", - "readOnly": true, - "description": "The dedicated host instance view." - } - }, - "description": "Properties of the dedicated host." - }, - "DedicatedHost": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/DedicatedHostProperties" - }, - "sku": { - "$ref": "#/definitions/Sku", - "description": "Sku of the dedicated host for Hardware Generation and VM family, The only name is required to be set. See DedicatedHostSkuTypes for possible set of values." - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "Specifies information about the Dedicated host." - }, - "DedicatedHostUpdate": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/DedicatedHostProperties" - } - }, - "allOf": [ - { - "$ref": "#/definitions/UpdateResource" - } - ], - "description": "Specifies information about the dedicated host. Only tags, autoReplaceOnFailure and licenseType may be updated." - }, - "DedicatedHostListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/DedicatedHost" - }, - "description": "The list of dedicated hosts" - }, - "nextLink": { - "type": "string", - "description": "The URI to fetch the next page of Dedicated hosts. Call ListNext() with this URI to fetch the next page of Dedicated hosts." - } - }, - "required": [ - "value" - ], - "description": "The List Dedicated Host operation response." - }, - "VirtualMachineSize": { - "properties": { - "name": { - "type": "string", - "description": "The name of the virtual machine size." - }, - "numberOfCores": { - "type": "integer", - "format": "int32", - "description": "The number of cores supported by the virtual machine size." - }, - "osDiskSizeInMB": { - "type": "integer", - "format": "int32", - "description": "The OS disk size, in MB, allowed by the virtual machine size." - }, - "resourceDiskSizeInMB": { - "type": "integer", - "format": "int32", - "description": "The resource disk size, in MB, allowed by the virtual machine size." - }, - "memoryInMB": { - "type": "integer", - "format": "int32", - "description": "The amount of memory, in MB, supported by the virtual machine size." - }, - "maxDataDiskCount": { - "type": "integer", - "format": "int32", - "description": "The maximum number of data disks that can be attached to the virtual machine size." - } - }, - "description": "Describes the properties of a VM size." - }, - "VirtualMachineSizeListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineSize" - }, - "description": "The list of virtual machine sizes." - } - }, - "description": "The List Virtual Machine operation response." - }, - "VirtualMachineExtensionImageProperties": { - "properties": { - "operatingSystem": { - "type": "string", - "description": "The operating system this extension supports." - }, - "computeRole": { - "type": "string", - "description": "The type of role (IaaS or PaaS) this extension supports." - }, - "handlerSchema": { - "type": "string", - "description": "The schema defined by publisher, where extension consumers should provide settings in a matching schema." - }, - "vmScaleSetEnabled": { - "type": "boolean", - "description": "Whether the extension can be used on xRP VMScaleSets. By default existing extensions are usable on scalesets, but there might be cases where a publisher wants to explicitly indicate the extension is only enabled for CRP VMs but not VMSS." - }, - "supportsMultipleExtensions": { - "type": "boolean", - "description": "Whether the handler can support multiple extensions." - } - }, - "required": [ - "operatingSystem", - "computeRole", - "handlerSchema" - ], - "description": "Describes the properties of a Virtual Machine Extension Image." - }, - "VirtualMachineExtensionImage": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/VirtualMachineExtensionImageProperties" - } - }, - "required": [ - "name", - "location" - ], - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "Describes a Virtual Machine Extension Image." - }, - "VirtualMachineImageResource": { - "properties": { - "name": { - "type": "string", - "description": "The name of the resource." - }, - "location": { - "type": "string", - "description": "The supported Azure location of the resource." - }, - "tags": { - "type": "object", - "additionalProperties": { - "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)." - } - }, - "required": [ - "name", - "location" - ], - "allOf": [ - { - "$ref": "#/definitions/SubResource" - } - ], - "description": "Virtual machine image resource information." - }, - "VirtualMachineExtensionInstanceView": { - "properties": { - "name": { - "type": "string", - "description": "The virtual machine extension name." - }, - "type": { - "type": "string", - "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." - }, - "typeHandlerVersion": { - "type": "string", - "description": "Specifies the version of the script handler." - }, - "substatuses": { - "type": "array", - "items": { - "$ref": "#/definitions/InstanceViewStatus" - }, - "description": "The resource status information." - }, - "statuses": { - "type": "array", - "items": { - "$ref": "#/definitions/InstanceViewStatus" - }, - "description": "The resource status information." - } - }, - "description": "The instance view of a virtual machine extension." - }, - "VirtualMachineExtensionProperties": { - "properties": { - "forceUpdateTag": { - "type": "string", - "description": "How the extension handler should be forced to update even if the extension configuration has not changed." - }, - "publisher": { - "type": "string", - "description": "The name of the extension handler publisher." - }, - "type": { - "type": "string", - "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." - }, - "typeHandlerVersion": { - "type": "string", - "description": "Specifies the version of the script handler." - }, - "autoUpgradeMinorVersion": { - "type": "boolean", - "description": "Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true." - }, - "settings": { - "type": "object", - "description": "Json formatted public settings for the extension." - }, - "protectedSettings": { - "type": "object", - "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." - }, - "provisioningState": { - "readOnly": true, - "type": "string", - "description": "The provisioning state, which only appears in the response." - }, - "instanceView": { - "$ref": "#/definitions/VirtualMachineExtensionInstanceView", - "description": "The virtual machine extension instance view." - } - }, - "description": "Describes the properties of a Virtual Machine Extension." - }, - "VirtualMachineExtensionUpdateProperties": { - "properties": { - "forceUpdateTag": { - "type": "string", - "description": "How the extension handler should be forced to update even if the extension configuration has not changed." - }, - "publisher": { - "type": "string", - "description": "The name of the extension handler publisher." - }, - "type": { - "type": "string", - "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." - }, - "typeHandlerVersion": { - "type": "string", - "description": "Specifies the version of the script handler." - }, - "autoUpgradeMinorVersion": { - "type": "boolean", - "description": "Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true." - }, - "settings": { - "type": "object", - "description": "Json formatted public settings for the extension." - }, - "protectedSettings": { - "type": "object", - "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." - } - }, - "description": "Describes the properties of a Virtual Machine Extension." - }, - "VirtualMachineExtension": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/VirtualMachineExtensionProperties" - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "Describes a Virtual Machine Extension." - }, - "VirtualMachineExtensionUpdate": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/VirtualMachineExtensionUpdateProperties" - } - }, - "allOf": [ - { - "$ref": "#/definitions/UpdateResource" - } - ], - "description": "Describes a Virtual Machine Extension." - }, - "VirtualMachineExtensionsListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineExtension" - }, - "description": "The list of extensions" - } - }, - "description": "The List Extension operation response" - }, - "PurchasePlan": { - "properties": { - "publisher": { - "type": "string", - "description": "The publisher ID." - }, - "name": { - "type": "string", - "description": "The plan ID." - }, - "product": { - "type": "string", - "description": "Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element." - } - }, - "required": [ - "publisher", - "name", - "product" - ], - "description": "Used for establishing the purchase context of any 3rd Party artifact through MarketPlace." - }, - "OSDiskImage": { - "properties": { - "operatingSystem": { - "type": "string", - "description": "The operating system of the osDiskImage.", - "enum": [ - "Windows", - "Linux" - ], - "x-ms-enum": { - "name": "OperatingSystemTypes", - "modelAsString": false - } - } - }, - "required": [ - "operatingSystem" - ], - "description": "Contains the os disk image information." - }, - "DataDiskImage": { - "properties": { - "lun": { - "readOnly": true, - "type": "integer", - "format": "int32", - "description": "Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM." - } - }, - "description": "Contains the data disk images information." - }, - "AutomaticOSUpgradeProperties": { - "properties": { - "automaticOSUpgradeSupported": { - "type": "boolean", - "description": "Specifies whether automatic OS upgrade is supported on the image." - } - }, - "required": [ - "automaticOSUpgradeSupported" - ], - "description": "Describes automatic OS upgrade properties on the image." - }, - "VirtualMachineImageProperties": { - "properties": { - "plan": { - "$ref": "#/definitions/PurchasePlan" - }, - "osDiskImage": { - "$ref": "#/definitions/OSDiskImage" - }, - "dataDiskImages": { - "type": "array", - "items": { - "$ref": "#/definitions/DataDiskImage" - } - }, - "automaticOSUpgradeProperties": { - "$ref": "#/definitions/AutomaticOSUpgradeProperties" - } - }, - "description": "Describes the properties of a Virtual Machine Image." - }, - "VirtualMachineImage": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/VirtualMachineImageProperties" - } - }, - "required": [ - "name", - "location" - ], - "allOf": [ - { - "$ref": "#/definitions/VirtualMachineImageResource" - } - ], - "description": "Describes a Virtual Machine Image." - }, - "UsageName": { - "properties": { - "value": { - "type": "string", - "description": "The name of the resource." - }, - "localizedValue": { - "type": "string", - "description": "The localized name of the resource." - } - }, - "description": "The Usage Names." - }, - "Usage": { - "properties": { - "unit": { - "type": "string", - "description": "An enum describing the unit of usage measurement.", - "enum": [ - "Count" - ], - "x-ms-enum": { - "name": "UsageUnit", - "modelAsString": false - } - }, - "currentValue": { - "type": "integer", - "format": "int32", - "description": "The current usage of the resource." - }, - "limit": { - "type": "integer", - "format": "int64", - "description": "The maximum permitted usage of the resource." - }, - "name": { - "$ref": "#/definitions/UsageName", - "description": "The name of the type of usage." - } - }, - "required": [ - "unit", - "currentValue", - "limit", - "name" - ], - "description": "Describes Compute Resource Usage." - }, - "ListUsagesResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Usage" - }, - "description": "The list of compute resource usages." - }, - "nextLink": { - "type": "string", - "description": "The URI to fetch the next page of compute resource usage information. Call ListNext() with this to fetch the next page of compute resource usage information." - } - }, - "required": [ - "value" - ], - "description": "The List Usages operation response." - }, - "VirtualMachineReimageParameters": { - "properties": { - "tempDisk": { - "type": "boolean", - "description": "Specifies whether to reimage temp disk. Default value: false. Note: This temp disk reimage parameter is only supported for VM/VMSS with Ephemeral OS disk." - } - }, - "description": "Parameters for Reimaging Virtual Machine. NOTE: Virtual Machine OS disk will always be reimaged" - }, - "VirtualMachineCaptureParameters": { - "properties": { - "vhdPrefix": { - "type": "string", - "description": "The captured virtual hard disk's name prefix." - }, - "destinationContainerName": { - "type": "string", - "description": "The destination container name." - }, - "overwriteVhds": { - "type": "boolean", - "description": "Specifies whether to overwrite the destination virtual hard disk, in case of conflict." - } - }, - "required": [ - "vhdPrefix", - "destinationContainerName", - "overwriteVhds" - ], - "description": "Capture Virtual Machine parameters." - }, - "VirtualMachineCaptureResult": { - "properties": { - "$schema": { - "readOnly": true, - "type": "string", - "description": "the schema of the captured virtual machine" - }, - "contentVersion": { - "readOnly": true, - "type": "string", - "description": "the version of the content" - }, - "parameters": { - "readOnly": true, - "type": "object", - "description": "parameters of the captured virtual machine" - }, - "resources": { - "readOnly": true, - "type": "array", - "items": { - "type": "object", - "description": "resource item" - }, - "description": "a list of resource items of the captured virtual machine" - } - }, - "allOf": [ - { - "$ref": "#/definitions/SubResource" - } - ], - "description": "Output of virtual machine capture operation." - }, - "Plan": { - "properties": { - "name": { - "type": "string", - "description": "The plan ID." - }, - "publisher": { - "type": "string", - "description": "The publisher ID." - }, - "product": { - "type": "string", - "description": "Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element." - }, - "promotionCode": { - "type": "string", - "description": "The promotion code." - } - }, - "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." - }, - "HardwareProfile": { - "properties": { - "vmSize": { - "type": "string", - "description": "Specifies the size of the virtual machine. For more information about virtual machine sizes, see [Sizes for virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-sizes?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

    The available VM sizes depend on region and availability set. For a list of available sizes use these APIs:

    [List all available virtual machine sizes in an availability set](https://docs.microsoft.com/rest/api/compute/availabilitysets/listavailablesizes)

    [List all available virtual machine sizes in a region](https://docs.microsoft.com/rest/api/compute/virtualmachinesizes/list)

    [List all available virtual machine sizes for resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes)", - "enum": [ - "Basic_A0", - "Basic_A1", - "Basic_A2", - "Basic_A3", - "Basic_A4", - "Standard_A0", - "Standard_A1", - "Standard_A2", - "Standard_A3", - "Standard_A4", - "Standard_A5", - "Standard_A6", - "Standard_A7", - "Standard_A8", - "Standard_A9", - "Standard_A10", - "Standard_A11", - "Standard_A1_v2", - "Standard_A2_v2", - "Standard_A4_v2", - "Standard_A8_v2", - "Standard_A2m_v2", - "Standard_A4m_v2", - "Standard_A8m_v2", - "Standard_B1s", - "Standard_B1ms", - "Standard_B2s", - "Standard_B2ms", - "Standard_B4ms", - "Standard_B8ms", - "Standard_D1", - "Standard_D2", - "Standard_D3", - "Standard_D4", - "Standard_D11", - "Standard_D12", - "Standard_D13", - "Standard_D14", - "Standard_D1_v2", - "Standard_D2_v2", - "Standard_D3_v2", - "Standard_D4_v2", - "Standard_D5_v2", - "Standard_D2_v3", - "Standard_D4_v3", - "Standard_D8_v3", - "Standard_D16_v3", - "Standard_D32_v3", - "Standard_D64_v3", - "Standard_D2s_v3", - "Standard_D4s_v3", - "Standard_D8s_v3", - "Standard_D16s_v3", - "Standard_D32s_v3", - "Standard_D64s_v3", - "Standard_D11_v2", - "Standard_D12_v2", - "Standard_D13_v2", - "Standard_D14_v2", - "Standard_D15_v2", - "Standard_DS1", - "Standard_DS2", - "Standard_DS3", - "Standard_DS4", - "Standard_DS11", - "Standard_DS12", - "Standard_DS13", - "Standard_DS14", - "Standard_DS1_v2", - "Standard_DS2_v2", - "Standard_DS3_v2", - "Standard_DS4_v2", - "Standard_DS5_v2", - "Standard_DS11_v2", - "Standard_DS12_v2", - "Standard_DS13_v2", - "Standard_DS14_v2", - "Standard_DS15_v2", - "Standard_DS13-4_v2", - "Standard_DS13-2_v2", - "Standard_DS14-8_v2", - "Standard_DS14-4_v2", - "Standard_E2_v3", - "Standard_E4_v3", - "Standard_E8_v3", - "Standard_E16_v3", - "Standard_E32_v3", - "Standard_E64_v3", - "Standard_E2s_v3", - "Standard_E4s_v3", - "Standard_E8s_v3", - "Standard_E16s_v3", - "Standard_E32s_v3", - "Standard_E64s_v3", - "Standard_E32-16_v3", - "Standard_E32-8s_v3", - "Standard_E64-32s_v3", - "Standard_E64-16s_v3", - "Standard_F1", - "Standard_F2", - "Standard_F4", - "Standard_F8", - "Standard_F16", - "Standard_F1s", - "Standard_F2s", - "Standard_F4s", - "Standard_F8s", - "Standard_F16s", - "Standard_F2s_v2", - "Standard_F4s_v2", - "Standard_F8s_v2", - "Standard_F16s_v2", - "Standard_F32s_v2", - "Standard_F64s_v2", - "Standard_F72s_v2", - "Standard_G1", - "Standard_G2", - "Standard_G3", - "Standard_G4", - "Standard_G5", - "Standard_GS1", - "Standard_GS2", - "Standard_GS3", - "Standard_GS4", - "Standard_GS5", - "Standard_GS4-8", - "Standard_GS4-4", - "Standard_GS5-16", - "Standard_GS5-8", - "Standard_H8", - "Standard_H16", - "Standard_H8m", - "Standard_H16m", - "Standard_H16r", - "Standard_H16mr", - "Standard_L4s", - "Standard_L8s", - "Standard_L16s", - "Standard_L32s", - "Standard_M64s", - "Standard_M64ms", - "Standard_M128s", - "Standard_M128ms", - "Standard_M64-32ms", - "Standard_M64-16ms", - "Standard_M128-64ms", - "Standard_M128-32ms", - "Standard_NC6", - "Standard_NC12", - "Standard_NC24", - "Standard_NC24r", - "Standard_NC6s_v2", - "Standard_NC12s_v2", - "Standard_NC24s_v2", - "Standard_NC24rs_v2", - "Standard_NC6s_v3", - "Standard_NC12s_v3", - "Standard_NC24s_v3", - "Standard_NC24rs_v3", - "Standard_ND6s", - "Standard_ND12s", - "Standard_ND24s", - "Standard_ND24rs", - "Standard_NV6", - "Standard_NV12", - "Standard_NV24" - ], - "x-ms-enum": { - "name": "VirtualMachineSizeTypes", - "modelAsString": true - } - } - }, - "description": "Specifies the hardware settings for the virtual machine." - }, - "ImageReference": { - "properties": { - "publisher": { - "type": "string", - "description": "The image publisher." - }, - "offer": { - "type": "string", - "description": "Specifies the offer of the platform image or marketplace image used to create the virtual machine." - }, - "sku": { - "type": "string", - "description": "The image SKU." - }, - "version": { - "type": "string", - "description": "Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available." - } - }, - "allOf": [ - { - "$ref": "#/definitions/SubResource" - } - ], - "description": "Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations." - }, - "KeyVaultSecretReference": { - "properties": { - "secretUrl": { - "type": "string", - "description": "The URL referencing a secret in a Key Vault." - }, - "sourceVault": { - "$ref": "#/definitions/SubResource", - "description": "The relative URL of the Key Vault containing the secret." - } - }, - "required": [ - "secretUrl", - "sourceVault" - ], - "description": "Describes a reference to Key Vault Secret" - }, - "KeyVaultKeyReference": { - "properties": { - "keyUrl": { - "type": "string", - "description": "The URL referencing a key encryption key in Key Vault." - }, - "sourceVault": { - "$ref": "#/definitions/SubResource", - "description": "The relative URL of the Key Vault containing the key." - } - }, - "required": [ - "keyUrl", - "sourceVault" - ], - "description": "Describes a reference to Key Vault Key" - }, - "DiskEncryptionSettings": { - "properties": { - "diskEncryptionKey": { - "$ref": "#/definitions/KeyVaultSecretReference", - "description": "Specifies the location of the disk encryption key, which is a Key Vault Secret." - }, - "keyEncryptionKey": { - "$ref": "#/definitions/KeyVaultKeyReference", - "description": "Specifies the location of the key encryption key in Key Vault." - }, - "enabled": { - "type": "boolean", - "description": "Specifies whether disk encryption should be enabled on the virtual machine." - } - }, - "description": "Describes a Encryption Settings for a Disk" - }, - "VirtualHardDisk": { - "properties": { - "uri": { - "type": "string", - "description": "Specifies the virtual hard disk's uri." - } - }, - "description": "Describes the uri of a disk." - }, - "Caching": { - "type": "string", - "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**", - "enum": [ - "None", - "ReadOnly", - "ReadWrite" - ], - "x-ms-enum": { - "name": "CachingTypes", - "modelAsString": false - } - }, - "CreateOption": { - "type": "string", - "description": "Specifies how the virtual machine should be created.

    Possible values are:

    **Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.

    **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described.", - "enum": [ - "FromImage", - "Empty", - "Attach" - ], - "x-ms-enum": { - "name": "DiskCreateOptionTypes", - "modelAsString": true - } - }, - "StorageAccountType": { - "type": "string", - "description": "Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk.", - "enum": [ - "Standard_LRS", - "Premium_LRS", - "StandardSSD_LRS", - "UltraSSD_LRS" - ], - "x-ms-enum": { - "name": "StorageAccountTypes", - "modelAsString": true - } - }, - "DiffDiskOption": { - "type": "string", - "description": "Specifies the ephemeral disk option for operating system disk.", - "enum": [ - "Local" - ], - "x-ms-enum": { - "name": "DiffDiskOptions", - "modelAsString": true - } - }, - "DiffDiskSettings": { - "properties": { - "option": { - "$ref": "#/definitions/DiffDiskOption", - "description": "Specifies the ephemeral disk settings for operating system disk." - } - }, - "description": "Describes the parameters of ephemeral disk settings that can be specified for operating system disk.

    NOTE: The ephemeral disk settings can only be specified for managed disk." - }, - "ManagedDiskParameters": { - "properties": { - "storageAccountType": { - "$ref": "#/definitions/StorageAccountType", - "description": "Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk." - } - }, - "allOf": [ - { - "$ref": "#/definitions/SubResource" - } - ], - "description": "The parameters of a managed disk." - }, - "OSDisk": { - "properties": { - "osType": { - "type": "string", - "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD.

    Possible values are:

    **Windows**

    **Linux**", - "enum": [ - "Windows", - "Linux" - ], - "x-ms-enum": { - "name": "OperatingSystemTypes", - "modelAsString": false - } - }, - "encryptionSettings": { - "$ref": "#/definitions/DiskEncryptionSettings", - "description": "Specifies the encryption settings for the OS Disk.

    Minimum api-version: 2015-06-15" - }, - "name": { - "type": "string", - "description": "The disk name." - }, - "vhd": { - "$ref": "#/definitions/VirtualHardDisk", - "description": "The virtual hard disk." - }, - "image": { - "$ref": "#/definitions/VirtualHardDisk", - "description": "The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist." - }, - "caching": { - "$ref": "#/definitions/Caching", - "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**" - }, - "writeAcceleratorEnabled": { - "type": "boolean", - "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." - }, - "diffDiskSettings": { - "$ref": "#/definitions/DiffDiskSettings", - "description": "Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine." - }, - "createOption": { - "$ref": "#/definitions/CreateOption", - "description": "Specifies how the virtual machine should be created.

    Possible values are:

    **Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.

    **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." - }, - "diskSizeGB": { - "type": "integer", - "format": "int32", - "description": "Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" - }, - "managedDisk": { - "description": "The managed disk parameters.", - "$ref": "#/definitions/ManagedDiskParameters" - } - }, - "required": [ - "createOption" - ], - "description": "Specifies information about the operating system disk used by the virtual machine.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." - }, - "DataDisk": { - "properties": { - "lun": { - "type": "integer", - "format": "int32", - "description": "Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM." - }, - "name": { - "type": "string", - "description": "The disk name." - }, - "vhd": { - "$ref": "#/definitions/VirtualHardDisk", - "description": "The virtual hard disk." - }, - "image": { - "$ref": "#/definitions/VirtualHardDisk", - "description": "The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist." - }, - "caching": { - "$ref": "#/definitions/Caching", - "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**" - }, - "writeAcceleratorEnabled": { - "type": "boolean", - "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." - }, - "createOption": { - "$ref": "#/definitions/CreateOption", - "description": "Specifies how the virtual machine should be created.

    Possible values are:

    **Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.

    **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." - }, - "diskSizeGB": { - "type": "integer", - "format": "int32", - "description": "Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" - }, - "managedDisk": { - "description": "The managed disk parameters.", - "$ref": "#/definitions/ManagedDiskParameters" - }, - "toBeDetached": { - "type": "boolean", - "description": "Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset" - } - }, - "required": [ - "lun", - "createOption" - ], - "description": "Describes a data disk." - }, - "StorageProfile": { - "properties": { - "imageReference": { - "$ref": "#/definitions/ImageReference", - "description": "Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations." - }, - "osDisk": { - "$ref": "#/definitions/OSDisk", - "description": "Specifies information about the operating system disk used by the virtual machine.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." - }, - "dataDisks": { - "type": "array", - "items": { - "$ref": "#/definitions/DataDisk" - }, - "description": "Specifies the parameters that are used to add a data disk to a virtual machine.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." - } - }, - "description": "Specifies the storage settings for the virtual machine disks." - }, - "AdditionalCapabilities": { - "properties": { - "ultraSSDEnabled": { - "type": "boolean", - "description": "The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled." - } - }, - "description": "Enables or disables a capability on the virtual machine or virtual machine scale set." - }, - "AdditionalUnattendContent": { - "properties": { - "passName": { - "type": "string", - "description": "The pass name. Currently, the only allowable value is OobeSystem.", - "enum": [ - "OobeSystem" - ], - "x-ms-enum": { - "name": "PassNames", - "modelAsString": false - } - }, - "componentName": { - "type": "string", - "description": "The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup.", - "enum": [ - "Microsoft-Windows-Shell-Setup" - ], - "x-ms-enum": { - "name": "ComponentNames", - "modelAsString": false - } - }, - "settingName": { - "type": "string", - "description": "Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.", - "enum": [ - "AutoLogon", - "FirstLogonCommands" - ], - "x-ms-enum": { - "name": "SettingNames", - "modelAsString": false - } - }, - "content": { - "type": "string", - "description": "Specifies the XML formatted content that is added to the unattend.xml file for the specified path and component. The XML must be less than 4KB and must include the root element for the setting or feature that is being inserted." - } - }, - "description": "Specifies additional XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. Contents are defined by setting name, component name, and the pass in which the content is applied." - }, - "WinRMListener": { - "properties": { - "protocol": { - "type": "string", - "description": "Specifies the protocol of listener.

    Possible values are:
    **http**

    **https**", - "enum": [ - "Http", - "Https" - ], - "x-ms-enum": { - "name": "ProtocolTypes", - "modelAsString": false - } - }, - "certificateUrl": { - "type": "string", - "description": "This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

    {
    \"data\":\"\",
    \"dataType\":\"pfx\",
    \"password\":\"\"
    }" - } - }, - "description": "Describes Protocol and thumbprint of Windows Remote Management listener" - }, - "WinRMConfiguration": { - "properties": { - "listeners": { - "type": "array", - "items": { - "$ref": "#/definitions/WinRMListener" - }, - "description": "The list of Windows Remote Management listeners" - } - }, - "description": "Describes Windows Remote Management configuration of the VM" - }, - "WindowsConfiguration": { - "properties": { - "provisionVMAgent": { - "type": "boolean", - "description": "Indicates whether virtual machine agent should be provisioned on the virtual machine.

    When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later." - }, - "enableAutomaticUpdates": { - "type": "boolean", - "description": "Indicates whether Automatic Updates is enabled for the Windows virtual machine. Default value is true.

    For virtual machine scale sets, this property can be updated and updates will take effect on OS reprovisioning." - }, - "timeZone": { - "type": "string", - "description": "Specifies the time zone of the virtual machine. e.g. \"Pacific Standard Time\"" - }, - "additionalUnattendContent": { - "type": "array", - "items": { - "$ref": "#/definitions/AdditionalUnattendContent" - }, - "description": "Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup." - }, - "winRM": { - "$ref": "#/definitions/WinRMConfiguration", - "description": "Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell." - } - }, - "description": "Specifies Windows operating system settings on the virtual machine." - }, - "SshPublicKey": { - "properties": { - "path": { - "type": "string", - "description": "Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys" - }, - "keyData": { - "type": "string", - "description": "SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format.

    For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-mac-create-ssh-keys?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." - } - }, - "description": "Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed." - }, - "SshConfiguration": { - "properties": { - "publicKeys": { - "type": "array", - "items": { - "$ref": "#/definitions/SshPublicKey" - }, - "description": "The list of SSH public keys used to authenticate with linux based VMs." - } - }, - "description": "SSH configuration for Linux based VMs running on Azure" - }, - "LinuxConfiguration": { - "properties": { - "disablePasswordAuthentication": { - "type": "boolean", - "description": "Specifies whether password authentication should be disabled." - }, - "ssh": { - "$ref": "#/definitions/SshConfiguration", - "description": "Specifies the ssh key configuration for a Linux OS." - }, - "provisionVMAgent": { - "type": "boolean", - "description": "Indicates whether virtual machine agent should be provisioned on the virtual machine.

    When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later." - } - }, - "description": "Specifies the Linux operating system settings on the virtual machine.

    For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)

    For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." - }, - "VaultCertificate": { - "properties": { - "certificateUrl": { - "type": "string", - "description": "This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

    {
    \"data\":\"\",
    \"dataType\":\"pfx\",
    \"password\":\"\"
    }" - }, - "certificateStore": { - "type": "string", - "description": "For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

    For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for private key. Both of these files are .pem formatted." - } - }, - "description": "Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM." - }, - "VaultSecretGroup": { - "properties": { - "sourceVault": { - "$ref": "#/definitions/SubResource", - "description": "The relative URL of the Key Vault containing all of the certificates in VaultCertificates." - }, - "vaultCertificates": { - "type": "array", - "items": { - "$ref": "#/definitions/VaultCertificate" - }, - "description": "The list of key vault references in SourceVault which contain certificates." - } - }, - "description": "Describes a set of certificates which are all in the same Key Vault." - }, - "OSProfile": { - "properties": { - "computerName": { - "type": "string", - "description": "Specifies the host OS name of the virtual machine.

    This name cannot be updated after the VM is created.

    **Max-length (Windows):** 15 characters

    **Max-length (Linux):** 64 characters.

    For naming conventions and restrictions see [Azure infrastructure services implementation guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions)." - }, - "adminUsername": { - "type": "string", - "description": "Specifies the name of the administrator account.

    **Windows-only restriction:** Cannot end in \".\"

    **Disallowed values:** \"administrator\", \"admin\", \"user\", \"user1\", \"test\", \"user2\", \"test1\", \"user3\", \"admin1\", \"1\", \"123\", \"a\", \"actuser\", \"adm\", \"admin2\", \"aspnet\", \"backup\", \"console\", \"david\", \"guest\", \"john\", \"owner\", \"root\", \"server\", \"sql\", \"support\", \"support_388945a0\", \"sys\", \"test2\", \"test3\", \"user4\", \"user5\".

    **Minimum-length (Linux):** 1 character

    **Max-length (Linux):** 64 characters

    **Max-length (Windows):** 20 characters

  • For root access to the Linux VM, see [Using root privileges on Linux virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
  • For a list of built-in system users on Linux that should not be used in this field, see [Selecting User Names for Linux on Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" - }, - "adminPassword": { - "type": "string", - "description": "Specifies the password of the administrator account.

    **Minimum-length (Windows):** 8 characters

    **Minimum-length (Linux):** 6 characters

    **Max-length (Windows):** 123 characters

    **Max-length (Linux):** 72 characters

    **Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
    Has lower characters
    Has upper characters
    Has a digit
    Has a special character (Regex match [\\W_])

    **Disallowed values:** \"abc@123\", \"P@$$w0rd\", \"P@ssw0rd\", \"P@ssword123\", \"Pa$$word\", \"pass@word1\", \"Password!\", \"Password1\", \"Password22\", \"iloveyou!\"

    For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password)" - }, - "customData": { - "type": "string", - "description": "Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes.

    For using cloud-init for your VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" - }, - "windowsConfiguration": { - "$ref": "#/definitions/WindowsConfiguration", - "description": "Specifies Windows operating system settings on the virtual machine." - }, - "linuxConfiguration": { - "$ref": "#/definitions/LinuxConfiguration", - "description": "Specifies the Linux operating system settings on the virtual machine.

    For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)

    For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." - }, - "secrets": { - "type": "array", - "items": { - "$ref": "#/definitions/VaultSecretGroup" - }, - "description": "Specifies set of certificates that should be installed onto the virtual machine." - }, - "allowExtensionOperations": { - "type": "boolean", - "description": "Specifies whether extension operations should be allowed on the virtual machine.

    This may only be set to False when no extensions are present on the virtual machine." - } - }, - "description": "Specifies the operating system settings for the virtual machine." - }, - "NetworkInterfaceReferenceProperties": { - "properties": { - "primary": { - "type": "boolean", - "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." - } - }, - "description": "Describes a network interface reference properties." - }, - "NetworkInterfaceReference": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/NetworkInterfaceReferenceProperties" - } - }, - "allOf": [ - { - "$ref": "#/definitions/SubResource" - } - ], - "description": "Describes a network interface reference." - }, - "NetworkProfile": { - "properties": { - "networkInterfaces": { - "type": "array", - "items": { - "$ref": "#/definitions/NetworkInterfaceReference" - }, - "description": "Specifies the list of resource Ids for the network interfaces associated with the virtual machine." - } - }, - "description": "Specifies the network interfaces of the virtual machine." - }, - "BootDiagnostics": { - "properties": { - "enabled": { - "type": "boolean", - "description": "Whether boot diagnostics should be enabled on the Virtual Machine." - }, - "storageUri": { - "type": "string", - "description": "Uri of the storage account to use for placing the console output and screenshot." - } - }, - "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    You can easily view the output of your console log.

    Azure also enables you to see a screenshot of the VM from the hypervisor." - }, - "DiagnosticsProfile": { - "properties": { - "bootDiagnostics": { - "$ref": "#/definitions/BootDiagnostics", - "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    You can easily view the output of your console log.

    Azure also enables you to see a screenshot of the VM from the hypervisor." - } - }, - "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." - }, - "VirtualMachineExtensionHandlerInstanceView": { - "properties": { - "type": { - "type": "string", - "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." - }, - "typeHandlerVersion": { - "type": "string", - "description": "Specifies the version of the script handler." - }, - "status": { - "$ref": "#/definitions/InstanceViewStatus", - "description": "The extension handler status." - } - }, - "description": "The instance view of a virtual machine extension handler." - }, - "VirtualMachineAgentInstanceView": { - "properties": { - "vmAgentVersion": { - "type": "string", - "description": "The VM Agent full version." - }, - "extensionHandlers": { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineExtensionHandlerInstanceView" - }, - "description": "The virtual machine extension handler instance view." - }, - "statuses": { - "type": "array", - "items": { - "$ref": "#/definitions/InstanceViewStatus" - }, - "description": "The resource status information." - } - }, - "description": "The instance view of the VM Agent running on the virtual machine." - }, - "DiskInstanceView": { - "properties": { - "name": { - "type": "string", - "description": "The disk name." - }, - "encryptionSettings": { - "type": "array", - "items": { - "$ref": "#/definitions/DiskEncryptionSettings" - }, - "description": "Specifies the encryption settings for the OS Disk.

    Minimum api-version: 2015-06-15" - }, - "statuses": { - "type": "array", - "items": { - "$ref": "#/definitions/InstanceViewStatus" - }, - "description": "The resource status information." - } - }, - "description": "The instance view of the disk." - }, - "BootDiagnosticsInstanceView": { - "properties": { - "consoleScreenshotBlobUri": { - "readOnly": true, - "type": "string", - "description": "The console screenshot blob URI." - }, - "serialConsoleLogBlobUri": { - "readOnly": true, - "type": "string", - "description": "The Linux serial console log blob Uri." - }, - "status": { - "readOnly": true, - "$ref": "#/definitions/InstanceViewStatus", - "description": "The boot diagnostics status information for the VM.

    NOTE: It will be set only if there are errors encountered in enabling boot diagnostics." - } - }, - "description": "The instance view of a virtual machine boot diagnostics." - }, - "VirtualMachineIdentity": { - "properties": { - "principalId": { - "readOnly": true, - "type": "string", - "description": "The principal id of virtual machine identity. This property will only be provided for a system assigned identity." - }, - "tenantId": { - "readOnly": true, - "type": "string", - "description": "The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity." - }, - "type": { - "type": "string", - "description": "The type of identity used for the virtual machine. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.", - "enum": [ - "SystemAssigned", - "UserAssigned", - "SystemAssigned, UserAssigned", - "None" - ], - "x-ms-enum": { - "name": "ResourceIdentityType", - "modelAsString": false - } - }, - "userAssignedIdentities": { - "type": "object", - "additionalProperties": { - "type": "object", - "properties": { - "principalId": { - "readOnly": true, - "type": "string", - "description": "The principal id of user assigned identity." - }, - "clientId": { - "readOnly": true, - "type": "string", - "description": "The client id of user assigned identity." - } - } - }, - "description": "The list of user identities associated with the Virtual Machine. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'." - } - }, - "description": "Identity for the virtual machine." - }, - "MaintenanceRedeployStatus": { - "properties": { - "isCustomerInitiatedMaintenanceAllowed": { - "type": "boolean", - "description": "True, if customer is allowed to perform Maintenance." - }, - "preMaintenanceWindowStartTime": { - "type": "string", - "format": "date-time", - "description": "Start Time for the Pre Maintenance Window." - }, - "preMaintenanceWindowEndTime": { - "type": "string", - "format": "date-time", - "description": "End Time for the Pre Maintenance Window." - }, - "maintenanceWindowStartTime": { - "type": "string", - "format": "date-time", - "description": "Start Time for the Maintenance Window." - }, - "maintenanceWindowEndTime": { - "type": "string", - "format": "date-time", - "description": "End Time for the Maintenance Window." - }, - "lastOperationResultCode": { - "type": "string", - "description": "The Last Maintenance Operation Result Code.", - "enum": [ - "None", - "RetryLater", - "MaintenanceAborted", - "MaintenanceCompleted" - ], - "x-ms-enum": { - "name": "MaintenanceOperationResultCodeTypes", - "modelAsString": false - } - }, - "lastOperationMessage": { - "type": "string", - "description": "Message returned for the last Maintenance Operation." - } - }, - "description": "Maintenance Operation Status." - }, - "VirtualMachineInstanceView": { - "properties": { - "platformUpdateDomain": { - "type": "integer", - "format": "int32", - "description": "Specifies the update domain of the virtual machine." - }, - "platformFaultDomain": { - "type": "integer", - "format": "int32", - "description": "Specifies the fault domain of the virtual machine." - }, - "computerName": { - "type": "string", - "description": "The computer name assigned to the virtual machine." - }, - "osName": { - "type": "string", - "description": "The Operating System running on the virtual machine." - }, - "osVersion": { - "type": "string", - "description": "The version of Operating System running on the virtual machine." - }, - "hyperVGeneration": { - "type": "string", - "description": "Specifies the HyperVGeneration Type associated with a resource", - "enum": [ - "V1", - "V2" - ], - "x-ms-enum": { - "name": "HyperVGenerationType", - "modelAsString": true - } - }, - "rdpThumbPrint": { - "type": "string", - "description": "The Remote desktop certificate thumbprint." - }, - "vmAgent": { - "$ref": "#/definitions/VirtualMachineAgentInstanceView", - "description": "The VM Agent running on the virtual machine." - }, - "maintenanceRedeployStatus": { - "$ref": "#/definitions/MaintenanceRedeployStatus", - "description": "The Maintenance Operation status on the virtual machine." - }, - "disks": { - "type": "array", - "items": { - "$ref": "#/definitions/DiskInstanceView" - }, - "description": "The virtual machine disk information." - }, - "extensions": { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineExtensionInstanceView" - }, - "description": "The extensions information." - }, - "bootDiagnostics": { - "$ref": "#/definitions/BootDiagnosticsInstanceView", - "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    You can easily view the output of your console log.

    Azure also enables you to see a screenshot of the VM from the hypervisor." - }, - "statuses": { - "type": "array", - "items": { - "$ref": "#/definitions/InstanceViewStatus" - }, - "description": "The resource status information." - } - }, - "description": "The instance view of a virtual machine." - }, - "VirtualMachineProperties": { - "properties": { - "hardwareProfile": { - "$ref": "#/definitions/HardwareProfile", - "description": "Specifies the hardware settings for the virtual machine." - }, - "storageProfile": { - "$ref": "#/definitions/StorageProfile", - "description": "Specifies the storage settings for the virtual machine disks." - }, - "additionalCapabilities": { - "$ref": "#/definitions/AdditionalCapabilities", - "description": "Specifies additional capabilities enabled or disabled on the virtual machine." - }, - "osProfile": { - "$ref": "#/definitions/OSProfile", - "description": "Specifies the operating system settings for the virtual machine." - }, - "networkProfile": { - "$ref": "#/definitions/NetworkProfile", - "description": "Specifies the network interfaces of the virtual machine." - }, - "diagnosticsProfile": { - "$ref": "#/definitions/DiagnosticsProfile", - "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." - }, - "availabilitySet": { - "$ref": "#/definitions/SubResource", - "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

    For more information on Azure planned maintenance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." - }, - "proximityPlacementGroup": { - "$ref": "#/definitions/SubResource", - "description": "Specifies information about the proximity placement group that the virtual machine should be assigned to.

    Minimum api-version: 2018-04-01." - }, - "host": { - "$ref": "#/definitions/SubResource", - "description": "Specifies information about the dedicated host that the virtual machine resides in.

    Minimum api-version: 2018-10-01." - }, - "provisioningState": { - "readOnly": true, - "type": "string", - "description": "The provisioning state, which only appears in the response." - }, - "instanceView": { - "$ref": "#/definitions/VirtualMachineInstanceView", - "readOnly": true, - "description": "The virtual machine instance view." - }, - "licenseType": { - "type": "string", - "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" - }, - "vmId": { - "readOnly": true, - "type": "string", - "description": "Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands." - } - }, - "description": "Describes the properties of a Virtual Machine." - }, - "VirtualMachine": { - "properties": { - "plan": { - "$ref": "#/definitions/Plan", - "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/VirtualMachineProperties" - }, - "resources": { - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineExtension" - }, - "description": "The virtual machine child extension resources." - }, - "identity": { - "$ref": "#/definitions/VirtualMachineIdentity", - "description": "The identity of the virtual machine, if configured." - }, - "zones": { - "type": "array", - "items": { - "type": "string" - }, - "description": "The virtual machine zones." - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "Describes a Virtual Machine." - }, - "VirtualMachineUpdate": { - "properties": { - "plan": { - "$ref": "#/definitions/Plan", - "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/VirtualMachineProperties" - }, - "identity": { - "$ref": "#/definitions/VirtualMachineIdentity", - "description": "The identity of the virtual machine, if configured." - }, - "zones": { - "type": "array", - "items": { - "type": "string" - }, - "description": "The virtual machine zones." - } - }, - "allOf": [ - { - "$ref": "#/definitions/UpdateResource" - } - ], - "description": "Describes a Virtual Machine Update." - }, - "VirtualMachineListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachine" - }, - "description": "The list of virtual machines." - }, - "nextLink": { - "type": "string", - "description": "The URI to fetch the next page of VMs. Call ListNext() with this URI to fetch the next page of Virtual Machines." - } - }, - "required": [ - "value" - ], - "description": "The List Virtual Machine operation response." - }, - "Sku": { - "properties": { - "name": { - "type": "string", - "description": "The sku name." - }, - "tier": { - "type": "string", - "description": "Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic**" - }, - "capacity": { - "type": "integer", - "format": "int64", - "description": "Specifies the number of virtual machines in the scale set." - } - }, - "description": "Describes a virtual machine scale set sku." - }, - "AutomaticOSUpgradePolicy": { - "properties": { - "enableAutomaticOSUpgrade": { - "type": "boolean", - "description": "Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available. Default value is false.

    If this is set to true for Windows based scale sets, [enableAutomaticUpdates](https://docs.microsoft.com/dotnet/api/microsoft.azure.management.compute.models.windowsconfiguration.enableautomaticupdates?view=azure-dotnet) is automatically set to false and cannot be set to true." - }, - "disableAutomaticRollback": { - "type": "boolean", - "description": "Whether OS image rollback feature should be disabled. Default value is false." - } - }, - "description": "The configuration parameters used for performing automatic OS upgrade." - }, - "UpgradePolicy": { - "properties": { - "mode": { - "type": "string", - "description": "Specifies the mode of an upgrade to virtual machines in the scale set.

    Possible values are:

    **Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.

    **Automatic** - All virtual machines in the scale set are automatically updated at the same time.", - "enum": [ - "Automatic", - "Manual", - "Rolling" - ], - "x-ms-enum": { - "name": "UpgradeMode", - "modelAsString": false - } - }, - "rollingUpgradePolicy": { - "$ref": "#/definitions/RollingUpgradePolicy", - "description": "The configuration parameters used while performing a rolling upgrade." - }, - "automaticOSUpgradePolicy": { - "$ref": "#/definitions/AutomaticOSUpgradePolicy", - "description": "Configuration parameters used for performing automatic OS Upgrade." - } - }, - "description": "Describes an upgrade policy - automatic, manual, or rolling." - }, - "RollingUpgradePolicy": { - "properties": { - "maxBatchInstancePercent": { - "type": "integer", - "format": "int32", - "minimum": 5, - "maximum": 100, - "description": "The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The default value for this parameter is 20%." - }, - "maxUnhealthyInstancePercent": { - "type": "integer", - "format": "int32", - "minimum": 5, - "maximum": 100, - "description": "The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The default value for this parameter is 20%." - }, - "maxUnhealthyUpgradedInstancePercent": { - "type": "integer", - "format": "int32", - "minimum": 0, - "maximum": 100, - "description": "The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The default value for this parameter is 20%." - }, - "pauseTimeBetweenBatches": { - "type": "string", - "description": "The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. The default value is 0 seconds (PT0S)." - } - }, - "description": "The configuration parameters used while performing a rolling upgrade." - }, - "ImageOSDisk": { - "properties": { - "osType": { - "type": "string", - "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image.

    Possible values are:

    **Windows**

    **Linux**", - "enum": [ - "Windows", - "Linux" - ], - "x-ms-enum": { - "name": "OperatingSystemTypes", - "modelAsString": false - } - }, - "osState": { - "type": "string", - "description": "The OS State.", - "enum": [ - "Generalized", - "Specialized" - ], - "x-ms-enum": { - "name": "OperatingSystemStateTypes", - "modelAsString": false - } - }, - "snapshot": { - "$ref": "#/definitions/SubResource", - "description": "The snapshot." - }, - "managedDisk": { - "$ref": "#/definitions/SubResource", - "description": "The managedDisk." - }, - "blobUri": { - "type": "string", - "description": "The Virtual Hard Disk." - }, - "caching": { - "type": "string", - "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**", - "enum": [ - "None", - "ReadOnly", - "ReadWrite" - ], - "x-ms-enum": { - "name": "CachingTypes", - "modelAsString": false - } - }, - "diskSizeGB": { - "type": "integer", - "format": "int32", - "description": "Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" - }, - "storageAccountType": { - "$ref": "#/definitions/StorageAccountType", - "description": "Specifies the storage account type for the managed disk. UltraSSD_LRS cannot be used with OS Disk." - } - }, - "required": [ - "osType", - "osState" - ], - "description": "Describes an Operating System disk." - }, - "ImageDataDisk": { - "properties": { - "lun": { - "type": "integer", - "format": "int32", - "description": "Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM." - }, - "snapshot": { - "$ref": "#/definitions/SubResource", - "description": "The snapshot." - }, - "managedDisk": { - "$ref": "#/definitions/SubResource", - "description": "The managedDisk." - }, - "blobUri": { - "type": "string", - "description": "The Virtual Hard Disk." - }, - "caching": { - "type": "string", - "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**", - "enum": [ - "None", - "ReadOnly", - "ReadWrite" - ], - "x-ms-enum": { - "name": "CachingTypes", - "modelAsString": false - } - }, - "diskSizeGB": { - "type": "integer", - "format": "int32", - "description": "Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" - }, - "storageAccountType": { - "$ref": "#/definitions/StorageAccountType", - "description": "Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk." - } - }, - "required": [ - "lun" - ], - "description": "Describes a data disk." - }, - "ImageStorageProfile": { - "properties": { - "osDisk": { - "$ref": "#/definitions/ImageOSDisk", - "description": "Specifies information about the operating system disk used by the virtual machine.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." - }, - "dataDisks": { - "type": "array", - "items": { - "$ref": "#/definitions/ImageDataDisk" - }, - "description": "Specifies the parameters that are used to add a data disk to a virtual machine.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." - }, - "zoneResilient": { - "type": "boolean", - "description": "Specifies whether an image is zone resilient or not. Default is false. Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS)." - } - }, - "description": "Describes a storage profile." - }, - "ImageProperties": { - "properties": { - "sourceVirtualMachine": { - "$ref": "#/definitions/SubResource", - "description": "The source virtual machine from which Image is created." - }, - "storageProfile": { - "$ref": "#/definitions/ImageStorageProfile", - "description": "Specifies the storage settings for the virtual machine disks." - }, - "provisioningState": { - "readOnly": true, - "type": "string", - "description": "The provisioning state." - }, - "hyperVGeneration": { - "$ref": "#/definitions/HyperVGenerationType", - "description": "Gets the HyperVGenerationType of the VirtualMachine created from the image" - } - }, - "description": "Describes the properties of an Image." - }, - "Image": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ImageProperties" - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist." - }, - "ImageUpdate": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ImageProperties" - } - }, - "allOf": [ - { - "$ref": "#/definitions/UpdateResource" - } - ], - "description": "The source user image virtual hard disk. Only tags may be updated." - }, - "ImageListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Image" - }, - "description": "The list of Images." - }, - "nextLink": { - "type": "string", - "description": "The uri to fetch the next page of Images. Call ListNext() with this to fetch the next page of Images." - } - }, - "required": [ - "value" - ], - "description": "The List Image operation response." - }, - "VirtualMachineScaleSetIdentity": { - "properties": { - "principalId": { - "readOnly": true, - "type": "string", - "description": "The principal id of virtual machine scale set identity. This property will only be provided for a system assigned identity." - }, - "tenantId": { - "readOnly": true, - "type": "string", - "description": "The tenant id associated with the virtual machine scale set. This property will only be provided for a system assigned identity." - }, - "type": { - "type": "string", - "description": "The type of identity used for the virtual machine scale set. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine scale set.", - "enum": [ - "SystemAssigned", - "UserAssigned", - "SystemAssigned, UserAssigned", - "None" - ], - "x-ms-enum": { - "name": "ResourceIdentityType", - "modelAsString": false - } - }, - "userAssignedIdentities": { - "type": "object", - "additionalProperties": { - "type": "object", - "properties": { - "principalId": { - "readOnly": true, - "type": "string", - "description": "The principal id of user assigned identity." - }, - "clientId": { - "readOnly": true, - "type": "string", - "description": "The client id of user assigned identity." - } - } - }, - "description": "The list of user identities associated with the virtual machine scale set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'." - } - }, - "description": "Identity for the virtual machine scale set." - }, - "VirtualMachineScaleSetOSProfile": { - "properties": { - "computerNamePrefix": { - "type": "string", - "description": "Specifies the computer name prefix for all of the virtual machines in the scale set. Computer name prefixes must be 1 to 15 characters long." - }, - "adminUsername": { - "type": "string", - "description": "Specifies the name of the administrator account.

    **Windows-only restriction:** Cannot end in \".\"

    **Disallowed values:** \"administrator\", \"admin\", \"user\", \"user1\", \"test\", \"user2\", \"test1\", \"user3\", \"admin1\", \"1\", \"123\", \"a\", \"actuser\", \"adm\", \"admin2\", \"aspnet\", \"backup\", \"console\", \"david\", \"guest\", \"john\", \"owner\", \"root\", \"server\", \"sql\", \"support\", \"support_388945a0\", \"sys\", \"test2\", \"test3\", \"user4\", \"user5\".

    **Minimum-length (Linux):** 1 character

    **Max-length (Linux):** 64 characters

    **Max-length (Windows):** 20 characters

  • For root access to the Linux VM, see [Using root privileges on Linux virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
  • For a list of built-in system users on Linux that should not be used in this field, see [Selecting User Names for Linux on Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" - }, - "adminPassword": { - "type": "string", - "description": "Specifies the password of the administrator account.

    **Minimum-length (Windows):** 8 characters

    **Minimum-length (Linux):** 6 characters

    **Max-length (Windows):** 123 characters

    **Max-length (Linux):** 72 characters

    **Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
    Has lower characters
    Has upper characters
    Has a digit
    Has a special character (Regex match [\\W_])

    **Disallowed values:** \"abc@123\", \"P@$$w0rd\", \"P@ssw0rd\", \"P@ssword123\", \"Pa$$word\", \"pass@word1\", \"Password!\", \"Password1\", \"Password22\", \"iloveyou!\"

    For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password)" - }, - "customData": { - "type": "string", - "description": "Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes.

    For using cloud-init for your VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" - }, - "windowsConfiguration": { - "$ref": "#/definitions/WindowsConfiguration", - "description": "Specifies Windows operating system settings on the virtual machine." - }, - "linuxConfiguration": { - "$ref": "#/definitions/LinuxConfiguration", - "description": "Specifies the Linux operating system settings on the virtual machine.

    For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)

    For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." - }, - "secrets": { - "type": "array", - "items": { - "$ref": "#/definitions/VaultSecretGroup" - }, - "description": "Specifies set of certificates that should be installed onto the virtual machines in the scale set." - } - }, - "description": "Describes a virtual machine scale set OS profile." - }, - "VirtualMachineScaleSetUpdateOSProfile": { - "properties": { - "customData": { - "type": "string", - "description": "A base-64 encoded string of custom data." - }, - "windowsConfiguration": { - "$ref": "#/definitions/WindowsConfiguration", - "description": "The Windows Configuration of the OS profile." - }, - "linuxConfiguration": { - "$ref": "#/definitions/LinuxConfiguration", - "description": "The Linux Configuration of the OS profile." - }, - "secrets": { - "type": "array", - "items": { - "$ref": "#/definitions/VaultSecretGroup" - }, - "description": "The List of certificates for addition to the VM." - } - }, - "description": "Describes a virtual machine scale set OS profile." - }, - "VirtualMachineScaleSetManagedDiskParameters": { - "properties": { - "storageAccountType": { - "$ref": "#/definitions/StorageAccountType", - "description": "Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk." - } - }, - "description": "Describes the parameters of a ScaleSet managed disk." - }, - "VirtualMachineScaleSetOSDisk": { - "properties": { - "name": { - "type": "string", - "description": "The disk name." - }, - "caching": { - "$ref": "#/definitions/Caching", - "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**" - }, - "writeAcceleratorEnabled": { - "type": "boolean", - "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." - }, - "createOption": { - "$ref": "#/definitions/CreateOption", - "description": "Specifies how the virtual machines in the scale set should be created.

    The only allowed value is: **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." - }, - "diffDiskSettings": { - "$ref": "#/definitions/DiffDiskSettings", - "description": "Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set." - }, - "diskSizeGB": { - "type": "integer", - "format": "int32", - "description": "Specifies the size of the operating system disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" - }, - "osType": { - "type": "string", - "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD.

    Possible values are:

    **Windows**

    **Linux**", - "enum": [ - "Windows", - "Linux" - ], - "x-ms-enum": { - "name": "OperatingSystemTypes", - "modelAsString": false - } - }, - "image": { - "$ref": "#/definitions/VirtualHardDisk", - "description": "Specifies information about the unmanaged user image to base the scale set on." - }, - "vhdContainers": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Specifies the container urls that are used to store operating system disks for the scale set." - }, - "managedDisk": { - "description": "The managed disk parameters.", - "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" - } - }, - "required": [ - "createOption" - ], - "description": "Describes a virtual machine scale set operating system disk." - }, - "VirtualMachineScaleSetUpdateOSDisk": { - "properties": { - "caching": { - "$ref": "#/definitions/Caching", - "description": "The caching type." - }, - "writeAcceleratorEnabled": { - "type": "boolean", - "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." - }, - "diskSizeGB": { - "type": "integer", - "format": "int32", - "description": "Specifies the size of the operating system disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" - }, - "image": { - "$ref": "#/definitions/VirtualHardDisk", - "description": "The Source User Image VirtualHardDisk. This VirtualHardDisk will be copied before using it to attach to the Virtual Machine. If SourceImage is provided, the destination VirtualHardDisk should not exist." - }, - "vhdContainers": { - "type": "array", - "items": { - "type": "string" - }, - "description": "The list of virtual hard disk container uris." - }, - "managedDisk": { - "description": "The managed disk parameters.", - "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" - } - }, - "description": "Describes virtual machine scale set operating system disk Update Object. This should be used for Updating VMSS OS Disk." - }, - "VirtualMachineScaleSetDataDisk": { - "properties": { - "name": { - "type": "string", - "description": "The disk name." - }, - "lun": { - "type": "integer", - "format": "int32", - "description": "Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM." - }, - "caching": { - "$ref": "#/definitions/Caching", - "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**" - }, - "writeAcceleratorEnabled": { - "type": "boolean", - "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." - }, - "createOption": { - "$ref": "#/definitions/CreateOption", - "description": "The create option." - }, - "diskSizeGB": { - "type": "integer", - "format": "int32", - "description": "Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" - }, - "managedDisk": { - "description": "The managed disk parameters.", - "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" - } - }, - "required": [ - "lun", - "createOption" - ], - "description": "Describes a virtual machine scale set data disk." - }, - "VirtualMachineScaleSetStorageProfile": { - "properties": { - "imageReference": { - "$ref": "#/definitions/ImageReference", - "description": "Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations." - }, - "osDisk": { - "$ref": "#/definitions/VirtualMachineScaleSetOSDisk", - "description": "Specifies information about the operating system disk used by the virtual machines in the scale set.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." - }, - "dataDisks": { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineScaleSetDataDisk" - }, - "description": "Specifies the parameters that are used to add data disks to the virtual machines in the scale set.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." - } - }, - "description": "Describes a virtual machine scale set storage profile." - }, - "VirtualMachineScaleSetUpdateStorageProfile": { - "properties": { - "imageReference": { - "$ref": "#/definitions/ImageReference", - "description": "The image reference." - }, - "osDisk": { - "$ref": "#/definitions/VirtualMachineScaleSetUpdateOSDisk", - "description": "The OS disk." - }, - "dataDisks": { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineScaleSetDataDisk" - }, - "description": "The data disks." - } - }, - "description": "Describes a virtual machine scale set storage profile." - }, - "ApiEntityReference": { - "properties": { - "id": { - "type": "string", - "description": "The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/..." - } - }, - "description": "The API entity reference." - }, - "VirtualMachineScaleSetIPConfigurationProperties": { - "properties": { - "subnet": { - "$ref": "#/definitions/ApiEntityReference", - "description": "Specifies the identifier of the subnet." - }, - "primary": { - "type": "boolean", - "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." - }, - "publicIPAddressConfiguration": { - "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfiguration", - "description": "The publicIPAddressConfiguration." - }, - "privateIPAddressVersion": { - "type": "string", - "description": "Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.", - "enum": [ - "IPv4", - "IPv6" - ], - "x-ms-enum": { - "name": "IPVersion", - "modelAsString": true - } - }, - "applicationGatewayBackendAddressPools": { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - }, - "description": "Specifies an array of references to backend address pools of application gateways. A scale set can reference backend address pools of multiple application gateways. Multiple scale sets cannot use the same application gateway." - }, - "applicationSecurityGroups": { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - }, - "description": "Specifies an array of references to application security group." - }, - "loadBalancerBackendAddressPools": { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - }, - "description": "Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same load balancer." - }, - "loadBalancerInboundNatPools": { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - }, - "description": "Specifies an array of references to inbound Nat pools of the load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same load balancer" - } - }, - "description": "Describes a virtual machine scale set network profile's IP configuration properties." - }, - "VirtualMachineScaleSetUpdateIPConfigurationProperties": { - "properties": { - "subnet": { - "$ref": "#/definitions/ApiEntityReference", - "description": "The subnet." - }, - "primary": { - "type": "boolean", - "description": "Specifies the primary IP Configuration in case the network interface has more than one IP Configuration." - }, - "publicIPAddressConfiguration": { - "$ref": "#/definitions/VirtualMachineScaleSetUpdatePublicIPAddressConfiguration", - "description": "The publicIPAddressConfiguration." - }, - "privateIPAddressVersion": { - "type": "string", - "description": "Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.", - "enum": [ - "IPv4", - "IPv6" - ], - "x-ms-enum": { - "name": "IPVersion", - "modelAsString": true - } - }, - "applicationGatewayBackendAddressPools": { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - }, - "description": "The application gateway backend address pools." - }, - "applicationSecurityGroups": { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - }, - "description": "Specifies an array of references to application security group." - }, - "loadBalancerBackendAddressPools": { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - }, - "description": "The load balancer backend address pools." - }, - "loadBalancerInboundNatPools": { - "type": "array", - "items": { - "$ref": "#/definitions/SubResource" - }, - "description": "The load balancer inbound nat pools." - } - }, - "description": "Describes a virtual machine scale set network profile's IP configuration properties." - }, - "VirtualMachineScaleSetIPConfiguration": { - "properties": { - "name": { - "type": "string", - "description": "The IP configuration name." - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/VirtualMachineScaleSetIPConfigurationProperties" - } - }, - "required": [ - "name" - ], - "allOf": [ - { - "$ref": "#/definitions/SubResource" - } - ], - "description": "Describes a virtual machine scale set network profile's IP configuration." - }, - "VirtualMachineScaleSetUpdateIPConfiguration": { - "properties": { - "name": { - "type": "string", - "description": "The IP configuration name." - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/VirtualMachineScaleSetUpdateIPConfigurationProperties" - } - }, - "allOf": [ - { - "$ref": "#/definitions/SubResource" - } - ], - "description": "Describes a virtual machine scale set network profile's IP configuration." - }, - "VirtualMachineScaleSetNetworkConfigurationProperties": { - "properties": { - "primary": { - "type": "boolean", - "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." - }, - "enableAcceleratedNetworking": { - "type": "boolean", - "description": "Specifies whether the network interface is accelerated networking-enabled." - }, - "networkSecurityGroup": { - "$ref": "#/definitions/SubResource", - "description": "The network security group." - }, - "dnsSettings": { - "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationDnsSettings", - "description": "The dns settings to be applied on the network interfaces." - }, - "ipConfigurations": { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineScaleSetIPConfiguration" - }, - "description": "Specifies the IP configurations of the network interface." - }, - "enableIPForwarding": { - "type": "boolean", - "description": "Whether IP forwarding enabled on this NIC." - } - }, - "required": [ - "ipConfigurations" - ], - "description": "Describes a virtual machine scale set network profile's IP configuration." - }, - "VirtualMachineScaleSetUpdateNetworkConfigurationProperties": { - "properties": { - "primary": { - "type": "boolean", - "description": "Whether this is a primary NIC on a virtual machine." - }, - "enableAcceleratedNetworking": { - "type": "boolean", - "description": "Specifies whether the network interface is accelerated networking-enabled." - }, - "networkSecurityGroup": { - "$ref": "#/definitions/SubResource", - "description": "The network security group." - }, - "dnsSettings": { - "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationDnsSettings", - "description": "The dns settings to be applied on the network interfaces." - }, - "ipConfigurations": { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineScaleSetUpdateIPConfiguration" - }, - "description": "The virtual machine scale set IP Configuration." - }, - "enableIPForwarding": { - "type": "boolean", - "description": "Whether IP forwarding enabled on this NIC." - } - }, - "description": "Describes a virtual machine scale set updatable network profile's IP configuration.Use this object for updating network profile's IP Configuration." - }, - "VirtualMachineScaleSetNetworkConfiguration": { - "properties": { - "name": { - "type": "string", - "description": "The network configuration name." - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationProperties" - } - }, - "required": [ - "name" - ], - "allOf": [ - { - "$ref": "#/definitions/SubResource" - } - ], - "description": "Describes a virtual machine scale set network profile's network configurations." - }, - "VirtualMachineScaleSetUpdateNetworkConfiguration": { - "properties": { - "name": { - "type": "string", - "description": "The network configuration name." - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/VirtualMachineScaleSetUpdateNetworkConfigurationProperties" - } - }, - "allOf": [ - { - "$ref": "#/definitions/SubResource" - } - ], - "description": "Describes a virtual machine scale set network profile's network configurations." - }, - "VirtualMachineScaleSetNetworkConfigurationDnsSettings": { - "properties": { - "dnsServers": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of DNS servers IP addresses" - } - }, - "description": "Describes a virtual machines scale sets network configuration's DNS settings." - }, - "VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings": { - "properties": { - "domainNameLabel": { - "type": "string", - "description": "The Domain name label.The concatenation of the domain name label and vm index will be the domain name labels of the PublicIPAddress resources that will be created" - } - }, - "required": [ - "domainNameLabel" - ], - "description": "Describes a virtual machines scale sets network configuration's DNS settings." - }, - "VirtualMachineScaleSetIpTag": { - "properties": { - "ipTagType": { - "type": "string", - "description": "IP tag type. Example: FirstPartyUsage." - }, - "tag": { - "type": "string", - "description": "IP tag associated with the public IP. Example: SQL, Storage etc." - } - }, - "description": "Contains the IP tag associated with the public IP address." - }, - "VirtualMachineScaleSetPublicIPAddressConfiguration": { - "properties": { - "name": { - "type": "string", - "description": "The publicIP address configuration name." - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationProperties" - } - }, - "required": [ - "name" - ], - "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" - }, - "VirtualMachineScaleSetUpdatePublicIPAddressConfiguration": { - "properties": { - "name": { - "type": "string", - "description": "The publicIP address configuration name." - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/VirtualMachineScaleSetUpdatePublicIPAddressConfigurationProperties" - } - }, - "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" - }, - "VirtualMachineScaleSetPublicIPAddressConfigurationProperties": { - "properties": { - "idleTimeoutInMinutes": { - "type": "integer", - "format": "int32", - "description": "The idle timeout of the public IP address." - }, - "dnsSettings": { - "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings", - "description": "The dns settings to be applied on the publicIP addresses ." - }, - "ipTags": { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineScaleSetIpTag" - }, - "description": "The list of IP tags associated with the public IP address." - }, - "publicIPPrefix": { - "$ref": "#/definitions/SubResource", - "description": "The PublicIPPrefix from which to allocate publicIP addresses." - } - }, - "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" - }, - "VirtualMachineScaleSetUpdatePublicIPAddressConfigurationProperties": { - "properties": { - "idleTimeoutInMinutes": { - "type": "integer", - "format": "int32", - "description": "The idle timeout of the public IP address." - }, - "dnsSettings": { - "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings", - "description": "The dns settings to be applied on the publicIP addresses ." - } - }, - "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" - }, - "VirtualMachineScaleSetNetworkProfile": { - "properties": { - "healthProbe": { - "$ref": "#/definitions/ApiEntityReference", - "description": "A reference to a load balancer probe used to determine the health of an instance in the virtual machine scale set. The reference will be in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'." - }, - "networkInterfaceConfigurations": { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfiguration" - }, - "description": "The list of network configurations." - } - }, - "description": "Describes a virtual machine scale set network profile." - }, - "VirtualMachineScaleSetUpdateNetworkProfile": { - "properties": { - "networkInterfaceConfigurations": { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineScaleSetUpdateNetworkConfiguration" - }, - "description": "The list of network configurations." - } - }, - "description": "Describes a virtual machine scale set network profile." - }, - "VirtualMachineScaleSetExtensionProperties": { - "properties": { - "forceUpdateTag": { - "type": "string", - "description": "If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed." - }, - "publisher": { - "type": "string", - "description": "The name of the extension handler publisher." - }, - "type": { - "type": "string", - "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." - }, - "typeHandlerVersion": { - "type": "string", - "description": "Specifies the version of the script handler." - }, - "autoUpgradeMinorVersion": { - "type": "boolean", - "description": "Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true." - }, - "settings": { - "type": "object", - "description": "Json formatted public settings for the extension." - }, - "protectedSettings": { - "type": "object", - "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." - }, - "provisioningState": { - "readOnly": true, - "type": "string", - "description": "The provisioning state, which only appears in the response." - }, - "provisionAfterExtensions": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Collection of extension names after which this extension needs to be provisioned." - } - }, - "description": "Describes the properties of a Virtual Machine Scale Set Extension." - }, - "VirtualMachineScaleSetExtension": { - "properties": { - "name": { - "type": "string", - "description": "The name of the extension." - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/VirtualMachineScaleSetExtensionProperties" - } - }, - "allOf": [ - { - "$ref": "#/definitions/SubResourceReadOnly" - } - ], - "description": "Describes a Virtual Machine Scale Set Extension." - }, - "VirtualMachineScaleSetExtensionListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineScaleSetExtension" - }, - "description": "The list of VM scale set extensions." - }, - "nextLink": { - "type": "string", - "description": "The uri to fetch the next page of VM scale set extensions. Call ListNext() with this to fetch the next page of VM scale set extensions." - } - }, - "required": [ - "value" - ], - "description": "The List VM scale set extension operation response." - }, - "VirtualMachineScaleSetExtensionProfile": { - "properties": { - "extensions": { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineScaleSetExtension" - }, - "description": "The virtual machine scale set child extension resources." - } - }, - "description": "Describes a virtual machine scale set extension profile." - }, - "VirtualMachineScaleSetVMProfile": { - "properties": { - "osProfile": { - "$ref": "#/definitions/VirtualMachineScaleSetOSProfile", - "description": "Specifies the operating system settings for the virtual machines in the scale set." - }, - "storageProfile": { - "$ref": "#/definitions/VirtualMachineScaleSetStorageProfile", - "description": "Specifies the storage settings for the virtual machine disks." - }, - "networkProfile": { - "$ref": "#/definitions/VirtualMachineScaleSetNetworkProfile", - "description": "Specifies properties of the network interfaces of the virtual machines in the scale set." - }, - "diagnosticsProfile": { - "$ref": "#/definitions/DiagnosticsProfile", - "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." - }, - "extensionProfile": { - "$ref": "#/definitions/VirtualMachineScaleSetExtensionProfile", - "description": "Specifies a collection of settings for extensions installed on virtual machines in the scale set." - }, - "licenseType": { - "type": "string", - "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" - }, - "priority": { - "type": "string", - "description": "Specifies the priority for the virtual machines in the scale set.

    Minimum api-version: 2017-10-30-preview", - "enum": [ - "Regular", - "Low" - ], - "x-ms-enum": { - "name": "VirtualMachinePriorityTypes", - "modelAsString": true - } - }, - "evictionPolicy": { - "type": "string", - "description": "Specifies the eviction policy for virtual machines in a low priority scale set.

    Minimum api-version: 2017-10-30-preview", - "enum": [ - "Deallocate", - "Delete" - ], - "x-ms-enum": { - "name": "VirtualMachineEvictionPolicyTypes", - "modelAsString": true - } - } - }, - "description": "Describes a virtual machine scale set virtual machine profile." - }, - "VirtualMachineScaleSetUpdateVMProfile": { - "properties": { - "osProfile": { - "$ref": "#/definitions/VirtualMachineScaleSetUpdateOSProfile", - "description": "The virtual machine scale set OS profile." - }, - "storageProfile": { - "$ref": "#/definitions/VirtualMachineScaleSetUpdateStorageProfile", - "description": "The virtual machine scale set storage profile." - }, - "networkProfile": { - "$ref": "#/definitions/VirtualMachineScaleSetUpdateNetworkProfile", - "description": "The virtual machine scale set network profile." - }, - "diagnosticsProfile": { - "$ref": "#/definitions/DiagnosticsProfile", - "description": "The virtual machine scale set diagnostics profile." - }, - "extensionProfile": { - "$ref": "#/definitions/VirtualMachineScaleSetExtensionProfile", - "description": "The virtual machine scale set extension profile." - }, - "licenseType": { - "type": "string", - "description": "The license type, which is for bring your own license scenario." - } - }, - "description": "Describes a virtual machine scale set virtual machine profile." - }, - "VirtualMachineScaleSetProperties": { - "properties": { - "upgradePolicy": { - "$ref": "#/definitions/UpgradePolicy", - "description": "The upgrade policy." - }, - "virtualMachineProfile": { - "$ref": "#/definitions/VirtualMachineScaleSetVMProfile", - "description": "The virtual machine profile." - }, - "provisioningState": { - "readOnly": true, - "type": "string", - "description": "The provisioning state, which only appears in the response." - }, - "overprovision": { - "type": "boolean", - "description": "Specifies whether the Virtual Machine Scale Set should be overprovisioned." - }, - "doNotRunExtensionsOnOverprovisionedVMs": { - "type": "boolean", - "description": "When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs." - }, - "uniqueId": { - "readOnly": true, - "type": "string", - "description": "Specifies the ID which uniquely identifies a Virtual Machine Scale Set." - }, - "singlePlacementGroup": { - "type": "boolean", - "description": "When true this limits the scale set to a single placement group, of max size 100 virtual machines." - }, - "zoneBalance": { - "type": "boolean", - "description": "Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage." - }, - "platformFaultDomainCount": { - "type": "integer", - "format": "int32", - "description": "Fault Domain count for each placement group." - }, - "proximityPlacementGroup": { - "$ref": "#/definitions/SubResource", - "description": "Specifies information about the proximity placement group that the virtual machine scale set should be assigned to.

    Minimum api-version: 2018-04-01." - }, - "additionalCapabilities": { - "$ref": "#/definitions/AdditionalCapabilities", - "description": "Specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines have the capability to support attaching managed data disks with UltraSSD_LRS storage account type." - } - }, - "description": "Describes the properties of a Virtual Machine Scale Set." - }, - "VirtualMachineScaleSetUpdateProperties": { - "properties": { - "upgradePolicy": { - "$ref": "#/definitions/UpgradePolicy", - "description": "The upgrade policy." - }, - "virtualMachineProfile": { - "$ref": "#/definitions/VirtualMachineScaleSetUpdateVMProfile", - "description": "The virtual machine profile." - }, - "overprovision": { - "type": "boolean", - "description": "Specifies whether the Virtual Machine Scale Set should be overprovisioned." - }, - "singlePlacementGroup": { - "type": "boolean", - "description": "When true this limits the scale set to a single placement group, of max size 100 virtual machines." - }, - "additionalCapabilities": { - "$ref": "#/definitions/AdditionalCapabilities", - "description": "Specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines have the capability to support attaching managed data disks with UltraSSD_LRS storage account type." - } - }, - "description": "Describes the properties of a Virtual Machine Scale Set." - }, - "VirtualMachineScaleSet": { - "properties": { - "sku": { - "$ref": "#/definitions/Sku", - "description": "The virtual machine scale set sku." - }, - "plan": { - "$ref": "#/definitions/Plan", - "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/VirtualMachineScaleSetProperties" - }, - "identity": { - "$ref": "#/definitions/VirtualMachineScaleSetIdentity", - "description": "The identity of the virtual machine scale set, if configured." - }, - "zones": { - "type": "array", - "items": { - "type": "string" - }, - "description": "The virtual machine scale set zones." - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "Describes a Virtual Machine Scale Set." - }, - "VirtualMachineScaleSetVMReimageParameters": { - "allOf": [ - { - "$ref": "#/definitions/VirtualMachineReimageParameters" - } - ], - "description": "Describes a Virtual Machine Scale Set VM Reimage Parameters." - }, - "VirtualMachineScaleSetReimageParameters": { - "properties": { - "instanceIds": { - "type": "array", - "items": { - "type": "string" - }, - "description": "The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set." - } - }, - "allOf": [ - { - "$ref": "#/definitions/VirtualMachineScaleSetVMReimageParameters" - } - ], - "description": "Describes a Virtual Machine Scale Set VM Reimage Parameters." - }, - "VirtualMachineScaleSetUpdate": { - "properties": { - "sku": { - "$ref": "#/definitions/Sku", - "description": "The virtual machine scale set sku." - }, - "plan": { - "$ref": "#/definitions/Plan", - "description": "The purchase plan when deploying a virtual machine scale set from VM Marketplace images." - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/VirtualMachineScaleSetUpdateProperties" - }, - "identity": { - "$ref": "#/definitions/VirtualMachineScaleSetIdentity", - "description": "The identity of the virtual machine scale set, if configured." - } - }, - "allOf": [ - { - "$ref": "#/definitions/UpdateResource" - } - ], - "description": "Describes a Virtual Machine Scale Set." - }, - "VirtualMachineScaleSetVMInstanceIDs": { - "properties": { - "instanceIds": { - "type": "array", - "items": { - "type": "string" - }, - "description": "The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set." - } - }, - "description": "Specifies a list of virtual machine instance IDs from the VM scale set." - }, - "VirtualMachineScaleSetVMInstanceRequiredIDs": { - "properties": { - "instanceIds": { - "type": "array", - "items": { - "type": "string" - }, - "description": "The virtual machine scale set instance ids." - } - }, - "required": [ - "instanceIds" - ], - "description": "Specifies a list of virtual machine instance IDs from the VM scale set." - }, - "VirtualMachineStatusCodeCount": { - "properties": { - "code": { - "readOnly": true, - "type": "string", - "description": "The instance view status code." - }, - "count": { - "readOnly": true, - "type": "integer", - "format": "int32", - "description": "The number of instances having a particular status code." - } - }, - "description": "The status code and count of the virtual machine scale set instance view status summary." - }, - "VirtualMachineScaleSetInstanceViewStatusesSummary": { - "properties": { - "statusesSummary": { - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineStatusCodeCount" - }, - "description": "The extensions information." - } - }, - "description": "Instance view statuses summary for virtual machines of a virtual machine scale set." - }, - "VirtualMachineScaleSetVMExtensionsSummary": { - "properties": { - "name": { - "readOnly": true, - "type": "string", - "description": "The extension name." - }, - "statusesSummary": { - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineStatusCodeCount" - }, - "description": "The extensions information." - } - }, - "description": "Extensions summary for virtual machines of a virtual machine scale set." - }, - "VirtualMachineScaleSetInstanceView": { - "properties": { - "virtualMachine": { - "$ref": "#/definitions/VirtualMachineScaleSetInstanceViewStatusesSummary", - "readOnly": true, - "description": "The instance view status summary for the virtual machine scale set." - }, - "extensions": { - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineScaleSetVMExtensionsSummary" - }, - "description": "The extensions information." - }, - "statuses": { - "type": "array", - "items": { - "$ref": "#/definitions/InstanceViewStatus" - }, - "description": "The resource status information." - } - }, - "description": "The instance view of a virtual machine scale set." - }, - "VirtualMachineScaleSetListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineScaleSet" - }, - "description": "The list of virtual machine scale sets." - }, - "nextLink": { - "type": "string", - "description": "The uri to fetch the next page of Virtual Machine Scale Sets. Call ListNext() with this to fetch the next page of VMSS." - } - }, - "required": [ - "value" - ], - "description": "The List Virtual Machine operation response." - }, - "VirtualMachineScaleSetListWithLinkResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineScaleSet" - }, - "description": "The list of virtual machine scale sets." - }, - "nextLink": { - "type": "string", - "description": "The uri to fetch the next page of Virtual Machine Scale Sets. Call ListNext() with this to fetch the next page of Virtual Machine Scale Sets." - } - }, - "required": [ - "value" - ], - "description": "The List Virtual Machine operation response." - }, - "VirtualMachineScaleSetSkuCapacity": { - "properties": { - "minimum": { - "readOnly": true, - "type": "integer", - "format": "int64", - "description": "The minimum capacity." - }, - "maximum": { - "readOnly": true, - "type": "integer", - "format": "int64", - "description": "The maximum capacity that can be set." - }, - "defaultCapacity": { - "readOnly": true, - "type": "integer", - "format": "int64", - "description": "The default capacity." - }, - "scaleType": { - "readOnly": true, - "type": "string", - "description": "The scale type applicable to the sku.", - "enum": [ - "Automatic", - "None" - ], - "x-ms-enum": { - "name": "VirtualMachineScaleSetSkuScaleType", - "modelAsString": false - } - } - }, - "description": "Describes scaling information of a sku." - }, - "VirtualMachineScaleSetSku": { - "properties": { - "resourceType": { - "readOnly": true, - "type": "string", - "description": "The type of resource the sku applies to." - }, - "sku": { - "$ref": "#/definitions/Sku", - "readOnly": true, - "description": "The Sku." - }, - "capacity": { - "$ref": "#/definitions/VirtualMachineScaleSetSkuCapacity", - "readOnly": true, - "description": "Specifies the number of virtual machines in the scale set." - } - }, - "description": "Describes an available virtual machine scale set sku." - }, - "VirtualMachineScaleSetListSkusResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineScaleSetSku" - }, - "description": "The list of skus available for the virtual machine scale set." - }, - "nextLink": { - "type": "string", - "description": "The uri to fetch the next page of Virtual Machine Scale Set Skus. Call ListNext() with this to fetch the next page of VMSS Skus." - } - }, - "required": [ - "value" - ], - "description": "The Virtual Machine Scale Set List Skus operation response." - }, - "RollbackStatusInfo": { - "properties": { - "successfullyRolledbackInstanceCount": { - "readOnly": true, - "type": "integer", - "format": "int32", - "description": "The number of instances which have been successfully rolled back." - }, - "failedRolledbackInstanceCount": { - "readOnly": true, - "type": "integer", - "format": "int32", - "description": "The number of instances which failed to rollback." - }, - "rollbackError": { - "$ref": "#/definitions/ApiError", - "readOnly": true, - "description": "Error details if OS rollback failed." - } - }, - "description": "Information about rollback on failed VM instances after a OS Upgrade operation." - }, - "UpgradeOperationHistoryStatus": { - "properties": { - "code": { - "type": "string", - "readOnly": true, - "description": "Code indicating the current status of the upgrade.", - "enum": [ - "RollingForward", - "Cancelled", - "Completed", - "Faulted" - ], - "x-ms-enum": { - "name": "UpgradeState", - "modelAsString": false - } - }, - "startTime": { - "readOnly": true, - "type": "string", - "format": "date-time", - "description": "Start time of the upgrade." - }, - "endTime": { - "readOnly": true, - "type": "string", - "format": "date-time", - "description": "End time of the upgrade." - } - }, - "description": "Information about the current running state of the overall upgrade." - }, - "UpgradeOperationHistoricalStatusInfoProperties": { - "properties": { - "runningStatus": { - "$ref": "#/definitions/UpgradeOperationHistoryStatus", - "readOnly": true, - "description": "Information about the overall status of the upgrade operation." - }, - "progress": { - "$ref": "#/definitions/RollingUpgradeProgressInfo", - "readOnly": true, - "description": "Counts of the VMs in each state." - }, - "error": { - "$ref": "#/definitions/ApiError", - "readOnly": true, - "description": "Error Details for this upgrade if there are any." - }, - "startedBy": { - "readOnly": true, - "type": "string", - "description": "Invoker of the Upgrade Operation", - "enum": [ - "Unknown", - "User", - "Platform" - ], - "x-ms-enum": { - "name": "UpgradeOperationInvoker", - "modelAsString": false - } - }, - "targetImageReference": { - "$ref": "#/definitions/ImageReference", - "readOnly": true, - "description": "Image Reference details" - }, - "rollbackInfo": { - "$ref": "#/definitions/RollbackStatusInfo", - "readOnly": true, - "description": "Information about OS rollback if performed" - } - }, - "description": "Describes each OS upgrade on the Virtual Machine Scale Set." - }, - "UpgradeOperationHistoricalStatusInfo": { - "properties": { - "properties": { - "$ref": "#/definitions/UpgradeOperationHistoricalStatusInfoProperties", - "readOnly": true, - "description": "Information about the properties of the upgrade operation." - }, - "type": { - "readOnly": true, - "type": "string", - "description": "Resource type" - }, - "location": { - "readOnly": true, - "type": "string", - "description": "Resource location" - } - }, - "description": "Virtual Machine Scale Set OS Upgrade History operation response." - }, - "VirtualMachineScaleSetListOSUpgradeHistory": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/UpgradeOperationHistoricalStatusInfo" - }, - "description": "The list of OS upgrades performed on the virtual machine scale set." - }, - "nextLink": { - "type": "string", - "description": "The uri to fetch the next page of OS Upgrade History. Call ListNext() with this to fetch the next page of history of upgrades." - } - }, - "required": [ - "value" - ], - "description": "List of Virtual Machine Scale Set OS Upgrade History operation response." - }, - "VirtualMachineScaleSetVMProperties": { - "properties": { - "latestModelApplied": { - "readOnly": true, - "type": "boolean", - "description": "Specifies whether the latest model has been applied to the virtual machine." - }, - "vmId": { - "readOnly": true, - "type": "string", - "description": "Azure VM unique ID." - }, - "instanceView": { - "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceView", - "readOnly": true, - "description": "The virtual machine instance view." - }, - "hardwareProfile": { - "$ref": "#/definitions/HardwareProfile", - "description": "Specifies the hardware settings for the virtual machine." - }, - "storageProfile": { - "$ref": "#/definitions/StorageProfile", - "description": "Specifies the storage settings for the virtual machine disks." - }, - "additionalCapabilities": { - "$ref": "#/definitions/AdditionalCapabilities", - "description": "Specifies additional capabilities enabled or disabled on the virtual machine in the scale set. For instance: whether the virtual machine has the capability to support attaching managed data disks with UltraSSD_LRS storage account type." - }, - "osProfile": { - "$ref": "#/definitions/OSProfile", - "description": "Specifies the operating system settings for the virtual machine." - }, - "networkProfile": { - "$ref": "#/definitions/NetworkProfile", - "description": "Specifies the network interfaces of the virtual machine." - }, - "networkProfileConfiguration": { - "$ref": "#/definitions/VirtualMachineScaleSetVMNetworkProfileConfiguration", - "description": "Specifies the network profile configuration of the virtual machine." - }, - "diagnosticsProfile": { - "$ref": "#/definitions/DiagnosticsProfile", - "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." - }, - "availabilitySet": { - "$ref": "#/definitions/SubResource", - "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

    For more information on Azure planned maintenance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." - }, - "provisioningState": { - "readOnly": true, - "type": "string", - "description": "The provisioning state, which only appears in the response." - }, - "licenseType": { - "type": "string", - "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" - }, - "modelDefinitionApplied": { - "readOnly": true, - "type": "string", - "description": "Specifies whether the model applied to the virtual machine is the model of the virtual machine scale set or the customized model for the virtual machine." - }, - "protectionPolicy": { - "$ref": "#/definitions/VirtualMachineScaleSetVMProtectionPolicy", - "description": "Specifies the protection policy of the virtual machine." - } - }, - "description": "Describes the properties of a virtual machine scale set virtual machine." - }, - "VirtualMachineScaleSetVM": { - "properties": { - "instanceId": { - "readOnly": true, - "type": "string", - "description": "The virtual machine instance ID." - }, - "sku": { - "$ref": "#/definitions/Sku", - "readOnly": true, - "description": "The virtual machine SKU." - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/VirtualMachineScaleSetVMProperties" - }, - "plan": { - "$ref": "#/definitions/Plan", - "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." - }, - "resources": { - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineExtension" - }, - "description": "The virtual machine child extension resources." - }, - "zones": { - "readOnly": true, - "type": "array", - "items": { - "type": "string" - }, - "description": "The virtual machine zones." - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "Describes a virtual machine scale set virtual machine." - }, - "VirtualMachineScaleSetVMInstanceView": { - "properties": { - "platformUpdateDomain": { - "type": "integer", - "format": "int32", - "description": "The Update Domain count." - }, - "platformFaultDomain": { - "type": "integer", - "format": "int32", - "description": "The Fault Domain count." - }, - "rdpThumbPrint": { - "type": "string", - "description": "The Remote desktop certificate thumbprint." - }, - "vmAgent": { - "$ref": "#/definitions/VirtualMachineAgentInstanceView", - "description": "The VM Agent running on the virtual machine." - }, - "maintenanceRedeployStatus": { - "$ref": "#/definitions/MaintenanceRedeployStatus", - "description": "The Maintenance Operation status on the virtual machine." - }, - "disks": { - "type": "array", - "items": { - "$ref": "#/definitions/DiskInstanceView" - }, - "description": "The disks information." - }, - "extensions": { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineExtensionInstanceView" - }, - "description": "The extensions information." - }, - "vmHealth": { - "readOnly": true, - "$ref": "#/definitions/VirtualMachineHealthStatus", - "description": "The health status for the VM." - }, - "bootDiagnostics": { - "$ref": "#/definitions/BootDiagnosticsInstanceView", - "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    You can easily view the output of your console log.

    Azure also enables you to see a screenshot of the VM from the hypervisor." - }, - "statuses": { - "type": "array", - "items": { - "$ref": "#/definitions/InstanceViewStatus" - }, - "description": "The resource status information." - }, - "placementGroupId": { - "type": "string", - "description": "The placement group in which the VM is running. If the VM is deallocated it will not have a placementGroupId." - } - }, - "description": "The instance view of a virtual machine scale set VM." - }, - "VirtualMachineScaleSetVMNetworkProfileConfiguration": { - "properties": { - "networkInterfaceConfigurations": { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfiguration" - }, - "description": "The list of network configurations." - } - }, - "description": "Describes a virtual machine scale set VM network profile." - }, - "VirtualMachineScaleSetVMProtectionPolicy": { - "properties": { - "protectFromScaleIn": { - "type": "boolean", - "description": "Indicates that the virtual machine scale set VM shouldn't be considered for deletion during a scale-in operation." - }, - "protectFromScaleSetActions": { - "type": "boolean", - "description": "Indicates that model updates or actions (including scale-in) initiated on the virtual machine scale set should not be applied to the virtual machine scale set VM." - } - }, - "description": "The protection policy of a virtual machine scale set VM." - }, - "VirtualMachineHealthStatus": { - "properties": { - "status": { - "readOnly": true, - "$ref": "#/definitions/InstanceViewStatus", - "description": "The health status information for the VM." - } - }, - "description": "The health status of the VM." - }, - "VirtualMachineScaleSetVMListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualMachineScaleSetVM" - }, - "description": "The list of virtual machine scale sets VMs." - }, - "nextLink": { - "type": "string", - "description": "The uri to fetch the next page of Virtual Machine Scale Set VMs. Call ListNext() with this to fetch the next page of VMSS VMs" - } - }, - "required": [ - "value" - ], - "description": "The List Virtual Machine Scale Set VMs operation response." - }, - "RollingUpgradeStatusInfo": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/RollingUpgradeStatusInfoProperties" - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "The status of the latest virtual machine scale set rolling upgrade." - }, - "RollingUpgradeStatusInfoProperties": { - "properties": { - "policy": { - "readOnly": true, - "$ref": "#/definitions/RollingUpgradePolicy", - "description": "The rolling upgrade policies applied for this upgrade." - }, - "runningStatus": { - "readOnly": true, - "$ref": "#/definitions/RollingUpgradeRunningStatus", - "description": "Information about the current running state of the overall upgrade." - }, - "progress": { - "readOnly": true, - "$ref": "#/definitions/RollingUpgradeProgressInfo", - "description": "Information about the number of virtual machine instances in each upgrade state." - }, - "error": { - "readOnly": true, - "$ref": "#/definitions/ApiError", - "description": "Error details for this upgrade, if there are any." - } - }, - "description": "The status of the latest virtual machine scale set rolling upgrade." - }, - "RollingUpgradeRunningStatus": { - "properties": { - "code": { - "type": "string", - "readOnly": true, - "description": "Code indicating the current status of the upgrade.", - "enum": [ - "RollingForward", - "Cancelled", - "Completed", - "Faulted" - ], - "x-ms-enum": { - "name": "RollingUpgradeStatusCode", - "modelAsString": false - } - }, - "startTime": { - "readOnly": true, - "type": "string", - "format": "date-time", - "description": "Start time of the upgrade." - }, - "lastAction": { - "type": "string", - "readOnly": true, - "description": "The last action performed on the rolling upgrade.", - "enum": [ - "Start", - "Cancel" - ], - "x-ms-enum": { - "name": "RollingUpgradeActionType", - "modelAsString": false - } - }, - "lastActionTime": { - "readOnly": true, - "type": "string", - "format": "date-time", - "description": "Last action time of the upgrade." - } - }, - "description": "Information about the current running state of the overall upgrade." - }, - "RollingUpgradeProgressInfo": { - "properties": { - "successfulInstanceCount": { - "readOnly": true, - "type": "integer", - "format": "int32", - "description": "The number of instances that have been successfully upgraded." - }, - "failedInstanceCount": { - "readOnly": true, - "type": "integer", - "format": "int32", - "description": "The number of instances that have failed to be upgraded successfully." - }, - "inProgressInstanceCount": { - "readOnly": true, - "type": "integer", - "format": "int32", - "description": "The number of instances that are currently being upgraded." - }, - "pendingInstanceCount": { - "readOnly": true, - "type": "integer", - "format": "int32", - "description": "The number of instances that have not yet begun to be upgraded." - } - }, - "description": "Information about the number of virtual machine instances in each upgrade state." - }, - "ApiErrorBase": { - "properties": { - "code": { - "type": "string", - "description": "The error code." - }, - "target": { - "type": "string", - "description": "The target of the particular error." - }, - "message": { - "type": "string", - "description": "The error message." - } - }, - "description": "Api error base." - }, - "InnerError": { - "properties": { - "exceptiontype": { - "type": "string", - "description": "The exception type." - }, - "errordetail": { - "type": "string", - "description": "The internal error message or exception dump." - } - }, - "description": "Inner error details." - }, - "ApiError": { - "properties": { - "details": { - "type": "array", - "items": { - "$ref": "#/definitions/ApiErrorBase" - }, - "description": "The Api error details" - }, - "innererror": { - "$ref": "#/definitions/InnerError", - "description": "The Api inner error" - }, - "code": { - "type": "string", - "description": "The error code." - }, - "target": { - "type": "string", - "description": "The target of the particular error." - }, - "message": { - "type": "string", - "description": "The error message." - } - }, - "description": "Api error." - }, - "Resource": { - "description": "The Resource model definition.", - "properties": { - "id": { - "readOnly": true, - "type": "string", - "description": "Resource Id" - }, - "name": { - "readOnly": true, - "type": "string", - "description": "Resource name" - }, - "type": { - "readOnly": true, - "type": "string", - "description": "Resource type" - }, - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Resource tags" - } - }, - "required": [ - "location" - ], - "x-ms-azure-resource": true - }, - "UpdateResource": { - "description": "The Update Resource model definition.", - "properties": { - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Resource tags" - } - }, - "x-ms-azure-resource": true - }, - "SubResource": { - "properties": { - "id": { - "type": "string", - "description": "Resource Id" - } - }, - "x-ms-azure-resource": true - }, - "SubResourceReadOnly": { - "properties": { - "id": { - "readOnly": true, - "type": "string", - "description": "Resource Id" - } - }, - "x-ms-azure-resource": true - }, - "RecoveryWalkResponse": { - "properties": { - "walkPerformed": { - "type": "boolean", - "readOnly": true, - "description": "Whether the recovery walk was performed" - }, - "nextPlatformUpdateDomain": { - "type": "integer", - "readOnly": true, - "description": "The next update domain that needs to be walked. Null means walk spanning all update domains has been completed" - } - }, - "description": "Response after calling a manual recovery walk" - }, - "RequestRateByIntervalInput": { - "properties": { - "intervalLength": { - "type": "string", - "description": "Interval value in minutes used to create LogAnalytics call rate logs.", - "enum": [ - "ThreeMins", - "FiveMins", - "ThirtyMins", - "SixtyMins" - ], - "x-ms-enum": { - "name": "IntervalInMins", - "modelAsString": false - } - } - }, - "required": [ - "intervalLength" - ], - "allOf": [ - { - "$ref": "#/definitions/LogAnalyticsInputBase" - } - ], - "description": "Api request input for LogAnalytics getRequestRateByInterval Api." - }, - "ThrottledRequestsInput": { - "allOf": [ - { - "$ref": "#/definitions/LogAnalyticsInputBase" - } - ], - "description": "Api request input for LogAnalytics getThrottledRequests Api." - }, - "LogAnalyticsInputBase": { - "properties": { - "blobContainerSasUri": { - "type": "string", - "description": "SAS Uri of the logging blob container to which LogAnalytics Api writes output logs to." - }, - "fromTime": { - "type": "string", - "format": "date-time", - "description": "From time of the query" - }, - "toTime": { - "type": "string", - "format": "date-time", - "description": "To time of the query" - }, - "groupByThrottlePolicy": { - "type": "boolean", - "description": "Group query result by Throttle Policy applied." - }, - "groupByOperationName": { - "type": "boolean", - "description": "Group query result by Operation Name." - }, - "groupByResourceName": { - "type": "boolean", - "description": "Group query result by Resource Name." - } - }, - "required": [ - "blobContainerSasUri", - "fromTime", - "toTime" - ], - "description": "Api input base class for LogAnalytics Api." - }, - "LogAnalyticsOperationResult": { - "properties": { - "properties": { - "readOnly": true, - "$ref": "#/definitions/LogAnalyticsOutput", - "description": "LogAnalyticsOutput" - } - }, - "description": "LogAnalytics operation status response" - }, - "LogAnalyticsOutput": { - "properties": { - "output": { - "readOnly": true, - "type": "string", - "description": "Output file Uri path to blob container." - } - }, - "description": "LogAnalytics output properties" - }, - "VMScaleSetConvertToSinglePlacementGroupInput": { - "properties": { - "activePlacementGroupId": { - "type": "string", - "description": "Id of the placement group in which you want future virtual machine instances to be placed. To query placement group Id, please use Virtual Machine Scale Set VMs - Get API. If not provided, the platform will choose one with maximum number of virtual machine instances." - } - } - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "Client Api Version." - } - } -} From 007443c407844b7e8d76bdb617fa2b1b21a26a04 Mon Sep 17 00:00:00 2001 From: Cigdem Celik Aydin Date: Fri, 12 Jul 2019 17:25:26 -0700 Subject: [PATCH 18/22] Use min max --- .../Microsoft.Compute/stable/2019-03-01/compute.json | 8 ++++++-- .../examples/LogAnalyticsRequestRateByInterval.json | 3 ++- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json index e7c35d5cd141..a1e02816aa16 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json @@ -5454,7 +5454,9 @@ "platformFaultDomainCount": { "type": "integer", "format": "int32", - "description": "Number of fault domains that the host group can span. Supported values 1,2,3." + "minimum": 1, + "maximum": 3, + "description": "Number of fault domains that the host group can span." }, "hosts": { "type": "array", @@ -5601,7 +5603,9 @@ "platformFaultDomain": { "type": "integer", "format": "int32", - "description": "Fault domain of the dedicated host within a dedicated host group. Supported values 0,1,2." + "minimum": 0, + "maximum": 2, + "description": "Fault domain of the dedicated host within a dedicated host group." }, "autoReplaceOnFailure": { "type": "boolean", diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/LogAnalyticsRequestRateByInterval.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/LogAnalyticsRequestRateByInterval.json index cabcb6fb61de..e5d80b5bf0bf 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/LogAnalyticsRequestRateByInterval.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/LogAnalyticsRequestRateByInterval.json @@ -20,7 +20,8 @@ } }, "202": { - "body": "" + "body": { + } } } } From eb0d1478578ba11640dfa578778ca5edcd90cb03 Mon Sep 17 00:00:00 2001 From: Cigdem Celik Aydin Date: Fri, 12 Jul 2019 17:31:46 -0700 Subject: [PATCH 19/22] attempt to fix model validation --- .../2019-03-01/examples/LogAnalyticsRequestRateByInterval.json | 2 -- 1 file changed, 2 deletions(-) diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/LogAnalyticsRequestRateByInterval.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/LogAnalyticsRequestRateByInterval.json index e5d80b5bf0bf..62ff8545dcf4 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/LogAnalyticsRequestRateByInterval.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/LogAnalyticsRequestRateByInterval.json @@ -20,8 +20,6 @@ } }, "202": { - "body": { - } } } } From 72a60ae11ed8c32e8daaed3b7b9dffd4d03c29d0 Mon Sep 17 00:00:00 2001 From: Cigdem Celik Aydin Date: Fri, 12 Jul 2019 17:36:25 -0700 Subject: [PATCH 20/22] fix model validation --- .../2019-03-01/examples/LogAnalyticsThrottledRequests.json | 1 - 1 file changed, 1 deletion(-) diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/LogAnalyticsThrottledRequests.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/LogAnalyticsThrottledRequests.json index 774bacfdb1c7..cfcb82a6ab93 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/LogAnalyticsThrottledRequests.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/LogAnalyticsThrottledRequests.json @@ -20,7 +20,6 @@ } }, "202": { - "body": "" } } } From 124f9aa0504f60c88ea83ae34cd2404627c240b1 Mon Sep 17 00:00:00 2001 From: Cigdem Celik Aydin Date: Sat, 13 Jul 2019 15:00:40 -0700 Subject: [PATCH 21/22] Removed availableVCpus --- .../Microsoft.Compute/stable/2019-03-01/compute.json | 5 ----- 1 file changed, 5 deletions(-) diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json index a1e02816aa16..0ac9e89c1fc0 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json @@ -5562,11 +5562,6 @@ }, "DedicatedHostAvailableCapacity": { "properties": { - "availableVCpus": { - "type": "number", - "format": "double", - "description": "The number of virtual CPUs available for new allocations." - }, "allocatableVMs": { "type": "array", "items": { From f6387a464505efdd6ee716d4bdf1edf2b9787476 Mon Sep 17 00:00:00 2001 From: Cigdem Celik Aydin Date: Mon, 15 Jul 2019 11:14:00 -0700 Subject: [PATCH 22/22] Update GetADedicatedHost.json --- .../stable/2019-03-01/examples/GetADedicatedHost.json | 1 - 1 file changed, 1 deletion(-) diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/GetADedicatedHost.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/GetADedicatedHost.json index d1ffe03c27be..0da47da294d4 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/GetADedicatedHost.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/GetADedicatedHost.json @@ -23,7 +23,6 @@ "instanceView": { "assetId": "eb3f58b8-b4e8-4882-b69f-301a01812407", "availableCapacity": { - "availableVCpus": 40, "allocatableVMs": [ { "vmSize": "Standard_A1",