diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2022-04-04/CloudServiceRP/cloudService.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2022-04-04/CloudServiceRP/cloudService.json index ffeb575880a6..fc061ae2e305 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2022-04-04/CloudServiceRP/cloudService.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2022-04-04/CloudServiceRP/cloudService.json @@ -52,12 +52,14 @@ { "in": "path", "name": "resourceGroupName", + "description": "Name of the resource group.", "required": true, "type": "string" }, { "in": "path", "name": "cloudServiceName", + "description": "Name of the cloud service.", "required": true, "type": "string" }, @@ -69,6 +71,12 @@ } ], "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../common.json#/definitions/CloudError" + } + }, "200": { "description": "OK" }, @@ -77,12 +85,6 @@ }, "204": { "description": "No Content" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../common.json#/definitions/CloudError" - } } }, "x-ms-long-running-operation": true, @@ -109,12 +111,14 @@ { "in": "path", "name": "resourceGroupName", + "description": "Name of the resource group.", "required": true, "type": "string" }, { "in": "path", "name": "cloudServiceName", + "description": "Name of the cloud service.", "required": true, "type": "string" }, @@ -140,17 +144,17 @@ } ], "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/RoleInstance" - } - }, "default": { "description": "Error", "schema": { "$ref": "../common.json#/definitions/CloudError" } + }, + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RoleInstance" + } } }, "x-ms-examples": { @@ -178,12 +182,14 @@ { "in": "path", "name": "resourceGroupName", + "description": "Name of the resource group.", "required": true, "type": "string" }, { "in": "path", "name": "cloudServiceName", + "description": "Name of the cloud service.", "required": true, "type": "string" }, @@ -195,17 +201,17 @@ } ], "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/RoleInstanceInstanceView" - } - }, "default": { "description": "Error", "schema": { "$ref": "../common.json#/definitions/CloudError" } + }, + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RoleInstanceInstanceView" + } } }, "x-ms-examples": { @@ -226,12 +232,14 @@ { "in": "path", "name": "resourceGroupName", + "description": "Name of the resource group.", "required": true, "type": "string" }, { "in": "path", "name": "cloudServiceName", + "description": "Name of the cloud service.", "required": true, "type": "string" }, @@ -257,17 +265,17 @@ } ], "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/RoleInstanceListResult" - } - }, "default": { "description": "Error", "schema": { "$ref": "../common.json#/definitions/CloudError" } + }, + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RoleInstanceListResult" + } } }, "x-ms-examples": { @@ -298,12 +306,14 @@ { "in": "path", "name": "resourceGroupName", + "description": "Name of the resource group.", "required": true, "type": "string" }, { "in": "path", "name": "cloudServiceName", + "description": "Name of the cloud service.", "required": true, "type": "string" }, @@ -315,17 +325,17 @@ } ], "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - }, "default": { "description": "Error", "schema": { "$ref": "../common.json#/definitions/CloudError" } + }, + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" } }, "x-ms-long-running-operation": true, @@ -354,12 +364,14 @@ { "in": "path", "name": "resourceGroupName", + "description": "Name of the resource group.", "required": true, "type": "string" }, { "in": "path", "name": "cloudServiceName", + "description": "Name of the cloud service.", "required": true, "type": "string" }, @@ -371,17 +383,17 @@ } ], "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - }, "default": { "description": "Error", "schema": { "$ref": "../common.json#/definitions/CloudError" } + }, + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" } }, "x-ms-long-running-operation": true, @@ -410,12 +422,14 @@ { "in": "path", "name": "resourceGroupName", + "description": "Name of the resource group.", "required": true, "type": "string" }, { "in": "path", "name": "cloudServiceName", + "description": "Name of the cloud service.", "required": true, "type": "string" }, @@ -427,17 +441,17 @@ } ], "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - }, "default": { "description": "Error", "schema": { "$ref": "../common.json#/definitions/CloudError" } + }, + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" } }, "x-ms-long-running-operation": true, @@ -469,12 +483,14 @@ { "in": "path", "name": "resourceGroupName", + "description": "Name of the resource group.", "required": true, "type": "string" }, { "in": "path", "name": "cloudServiceName", + "description": "Name of the cloud service.", "required": true, "type": "string" }, @@ -486,18 +502,23 @@ } ], "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../common.json#/definitions/CloudError" + } + }, "200": { "description": "OK", "schema": { "format": "binary", "type": "file" } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../common.json#/definitions/CloudError" - } + } + }, + "x-ms-examples": { + "Get Cloud Service Role": { + "$ref": "./examples/CloudServiceRoleInstance_Get_RemoteDesktopFile.json" } } } @@ -520,12 +541,14 @@ { "in": "path", "name": "resourceGroupName", + "description": "Name of the resource group.", "required": true, "type": "string" }, { "in": "path", "name": "cloudServiceName", + "description": "Name of the cloud service.", "required": true, "type": "string" }, @@ -537,17 +560,17 @@ } ], "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/CloudServiceRole" - } - }, "default": { "description": "Error", "schema": { "$ref": "../common.json#/definitions/CloudError" } + }, + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CloudServiceRole" + } } }, "x-ms-examples": { @@ -568,12 +591,14 @@ { "in": "path", "name": "resourceGroupName", + "description": "Name of the resource group.", "required": true, "type": "string" }, { "in": "path", "name": "cloudServiceName", + "description": "Name of the cloud service.", "required": true, "type": "string" }, @@ -585,17 +610,17 @@ } ], "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/CloudServiceRoleListResult" - } - }, "default": { "description": "Error", "schema": { "$ref": "../common.json#/definitions/CloudError" } + }, + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CloudServiceRoleListResult" + } } }, "x-ms-examples": { @@ -646,6 +671,12 @@ } ], "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../common.json#/definitions/CloudError" + } + }, "200": { "description": "OK", "schema": { @@ -657,12 +688,6 @@ "schema": { "$ref": "#/definitions/CloudService" } - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../common.json#/definitions/CloudError" - } } }, "x-ms-long-running-operation": true, @@ -718,17 +743,17 @@ } ], "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/CloudService" - } - }, "default": { "description": "Error", "schema": { "$ref": "../common.json#/definitions/CloudError" } + }, + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CloudService" + } } }, "x-ms-long-running-operation": true, @@ -767,6 +792,12 @@ } ], "responses": { + "default": { + "description": "Error", + "schema": { + "$ref": "../common.json#/definitions/CloudError" + } + }, "200": { "description": "OK" }, @@ -775,12 +806,6 @@ }, "204": { "description": "No Content" - }, - "default": { - "description": "Error", - "schema": { - "$ref": "../common.json#/definitions/CloudError" - } } }, "x-ms-long-running-operation": true, @@ -819,17 +844,17 @@ } ], "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/CloudService" - } - }, "default": { "description": "Error", "schema": { "$ref": "../common.json#/definitions/CloudError" } + }, + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CloudService" + } } }, "x-ms-examples": { @@ -869,17 +894,17 @@ } ], "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/CloudServiceInstanceView" - } - }, "default": { "description": "Error", "schema": { "$ref": "../common.json#/definitions/CloudError" } + }, + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CloudServiceInstanceView" + } } }, "x-ms-examples": { @@ -905,17 +930,17 @@ } ], "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/CloudServiceListResult" - } - }, "default": { "description": "Error", "schema": { "$ref": "../common.json#/definitions/CloudError" } + }, + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CloudServiceListResult" + } } }, "x-ms-examples": { @@ -951,17 +976,17 @@ } ], "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/CloudServiceListResult" - } - }, "default": { "description": "Error", "schema": { "$ref": "../common.json#/definitions/CloudError" } + }, + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CloudServiceListResult" + } } }, "x-ms-examples": { @@ -1004,17 +1029,17 @@ } ], "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - }, "default": { "description": "Error", "schema": { "$ref": "../common.json#/definitions/CloudError" } + }, + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" } }, "x-ms-long-running-operation": true, @@ -1055,17 +1080,17 @@ } ], "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - }, "default": { "description": "Error", "schema": { "$ref": "../common.json#/definitions/CloudError" } + }, + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" } }, "x-ms-long-running-operation": true, @@ -1114,17 +1139,17 @@ } ], "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - }, "default": { "description": "Error", "schema": { "$ref": "../common.json#/definitions/CloudError" } + }, + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" } }, "x-ms-long-running-operation": true, @@ -1173,17 +1198,17 @@ } ], "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - }, "default": { "description": "Error", "schema": { "$ref": "../common.json#/definitions/CloudError" } + }, + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" } }, "x-ms-long-running-operation": true, @@ -1232,17 +1257,17 @@ } ], "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - }, "default": { "description": "Error", "schema": { "$ref": "../common.json#/definitions/CloudError" } + }, + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" } }, "x-ms-long-running-operation": true, @@ -1291,17 +1316,17 @@ } ], "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - }, "default": { "description": "Error", "schema": { "$ref": "../common.json#/definitions/CloudError" } + }, + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" } }, "x-ms-long-running-operation": true, @@ -1358,17 +1383,17 @@ } ], "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - }, "default": { "description": "Error", "schema": { "$ref": "../common.json#/definitions/CloudError" } + }, + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" } }, "x-ms-long-running-operation": true, @@ -1415,17 +1440,17 @@ } ], "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/UpdateDomain" - } - }, "default": { "description": "Error", "schema": { "$ref": "../common.json#/definitions/CloudError" } + }, + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UpdateDomain" + } } }, "x-ms-examples": { @@ -1465,17 +1490,17 @@ } ], "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/UpdateDomainListResult" - } - }, "default": { "description": "Error", "schema": { "$ref": "../common.json#/definitions/CloudError" } + }, + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UpdateDomainListResult" + } } }, "x-ms-examples": { @@ -1518,17 +1543,17 @@ } ], "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/OSVersion" - } - }, "default": { "description": "Error", "schema": { "$ref": "../common.json#/definitions/CloudError" } + }, + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OSVersion" + } } }, "x-ms-examples": { @@ -1561,17 +1586,17 @@ } ], "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/OSVersionListResult" - } - }, "default": { "description": "Error", "schema": { "$ref": "../common.json#/definitions/CloudError" } + }, + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OSVersionListResult" + } } }, "x-ms-examples": { @@ -1614,17 +1639,17 @@ } ], "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/OSFamily" - } - }, "default": { "description": "Error", "schema": { "$ref": "../common.json#/definitions/CloudError" } + }, + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OSFamily" + } } }, "x-ms-examples": { @@ -1657,17 +1682,17 @@ } ], "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/OSFamilyListResult" - } - }, "default": { "description": "Error", "schema": { "$ref": "../common.json#/definitions/CloudError" } + }, + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OSFamilyListResult" + } } }, "x-ms-examples": { @@ -1683,6 +1708,7 @@ }, "definitions": { "InstanceSku": { + "description": "The role instance SKU.", "type": "object", "properties": { "name": { @@ -1783,6 +1809,7 @@ } }, "RoleInstanceProperties": { + "description": "Role instance properties.", "type": "object", "properties": { "networkProfile": { @@ -1794,6 +1821,7 @@ } }, "RoleInstance": { + "description": "Describes the cloud service role instance.", "type": "object", "properties": { "id": { @@ -1833,15 +1861,18 @@ } }, "RoleInstanceListResult": { + "description": "The list operation result.", "type": "object", "properties": { "value": { + "description": "The list of resources.", "type": "array", "items": { "$ref": "#/definitions/RoleInstance" } }, "nextLink": { + "description": "The URI to fetch the next page of resources. Use this to get the next page of resources. Do this till nextLink is null to fetch all the resources.", "type": "string" } }, @@ -1869,7 +1900,7 @@ } }, "CloudServiceRoleProperties": { - "description": "", + "description": "The cloud service role properties.", "type": "object", "properties": { "uniqueId": { @@ -1912,15 +1943,18 @@ } }, "CloudServiceRoleListResult": { + "description": "The list operation result.", "type": "object", "properties": { "value": { + "description": "The list of resources.", "type": "array", "items": { "$ref": "#/definitions/CloudServiceRole" } }, "nextLink": { + "description": "The URI to fetch the next page of resources. Use this to get the next page of resources. Do this till nextLink is null to fetch all the resources.", "type": "string" } }, @@ -2035,6 +2069,7 @@ } }, "LoadBalancerFrontendIPConfiguration": { + "description": "Specifies the frontend IP to be used for the load balancer. Only IPv4 frontend IP address is supported. Each load balancer configuration must have exactly one frontend IP configuration.", "type": "object", "properties": { "name": { @@ -2052,6 +2087,7 @@ ] }, "LoadBalancerConfigurationProperties": { + "description": "Describes the properties of the load balancer configuration.", "type": "object", "properties": { "frontendIPConfigurations": { @@ -2091,6 +2127,18 @@ "properties" ] }, + "CloudServiceSlotType": { + "description": "Slot type for the cloud service.\r\nPossible values are

**Production**

**Staging**

\r\nIf not specified, the default value is Production.", + "enum": [ + "Production", + "Staging" + ], + "type": "string", + "x-ms-enum": { + "name": "CloudServiceSlotType", + "modelAsString": true + } + }, "CloudServiceNetworkProfile": { "description": "Network Profile for the cloud service.", "type": "object", @@ -2102,6 +2150,9 @@ "$ref": "#/definitions/LoadBalancerConfiguration" } }, + "slotType": { + "$ref": "#/definitions/CloudServiceSlotType" + }, "swappableCloudService": { "$ref": "../common.json#/definitions/SubResource", "description": "The id reference of the cloud service containing the target IP with which the subject cloud service can perform a swap. This property cannot be updated once it is set. The swappable cloud service referred by this id must be present otherwise an error will be thrown." @@ -2112,12 +2163,15 @@ "type": "object", "properties": { "sourceVault": { - "$ref": "../common.json#/definitions/SubResource" + "$ref": "../common.json#/definitions/SubResource", + "description": "The ARM Resource ID of the Key Vault" }, "secretUrl": { - "type": "string" + "type": "string", + "description": "Secret URL which contains the protected settings of the extension" } - } + }, + "description": "Protected settings for the extension, referenced using KeyVault which are encrypted before sent to the role instance." }, "CloudServiceExtensionProperties": { "description": "Extension Properties.", @@ -2141,11 +2195,11 @@ }, "settings": { "description": "Public settings for the extension. For JSON extensions, this is the JSON settings for the extension. For XML Extension (like RDP), this is the XML setting for the extension.", - "type": "string" + "type": "object" }, "protectedSettings": { "description": "Protected settings for the extension which are encrypted before sent to the role instance.", - "type": "string" + "type": "object" }, "protectedSettingsFromKeyVault": { "$ref": "#/definitions/CloudServiceVaultAndSecretReference" @@ -2280,6 +2334,9 @@ }, "properties": { "$ref": "#/definitions/CloudServiceProperties" + }, + "systemData": { + "$ref": "../common.json#/definitions/SystemData" } }, "x-ms-azure-resource": true, @@ -2300,6 +2357,7 @@ } }, "StatusCodeCount": { + "description": "The status code and count of the cloud service instance view statuses", "type": "object", "properties": { "code": { @@ -2320,6 +2378,7 @@ "type": "object", "properties": { "statusesSummary": { + "description": "The summary.", "type": "array", "items": { "$ref": "#/definitions/StatusCodeCount" @@ -2360,15 +2419,18 @@ } }, "CloudServiceListResult": { + "description": "The list operation result.", "type": "object", "properties": { "value": { + "description": "The list of resources.", "type": "array", "items": { "$ref": "#/definitions/CloudService" } }, "nextLink": { + "description": "The URI to fetch the next page of resources. Use this to get the next page of resources. Do this till nextLink is null to fetch all the resources.", "type": "string" } }, @@ -2409,15 +2471,18 @@ } }, "UpdateDomainListResult": { + "description": "The list operation result.", "type": "object", "properties": { "value": { + "description": "The list of resources.", "type": "array", "items": { "$ref": "#/definitions/UpdateDomain" } }, "nextLink": { + "description": "The URI to fetch the next page of resources. Use this to get the next page of resources. Do this till nextLink is null to fetch all the resources.", "type": "string" } }, @@ -2491,15 +2556,18 @@ } }, "OSVersionListResult": { + "description": "The list operation result.", "type": "object", "properties": { "value": { + "description": "The list of resources.", "type": "array", "items": { "$ref": "#/definitions/OSVersion" } }, "nextLink": { + "description": "The URI to fetch the next page of resources. Use this to get the next page of resources. Do this till nextLink is null to fetch all the resources.", "type": "string" } }, @@ -2590,15 +2658,18 @@ } }, "OSFamilyListResult": { + "description": "The list operation result.", "type": "object", "properties": { "value": { + "description": "The list of resources.", "type": "array", "items": { "$ref": "#/definitions/OSFamily" } }, "nextLink": { + "description": "The URI to fetch the next page of resources. Use this to get the next page of resources. Do this till nextLink is null to fetch all the resources.", "type": "string" } }, diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2022-04-04/CloudServiceRP/examples/CloudServiceRoleInstance_Get_RemoteDesktopFile.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2022-04-04/CloudServiceRP/examples/CloudServiceRoleInstance_Get_RemoteDesktopFile.json new file mode 100644 index 000000000000..0229672f9e0c --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2022-04-04/CloudServiceRP/examples/CloudServiceRoleInstance_Get_RemoteDesktopFile.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "roleInstanceName": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "resourceGroupName": "rgcloudService", + "cloudServiceName": "aaaa", + "subscriptionId": "{subscription-id}", + "api-version": "2022-04-04" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2022-04-04/common.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2022-04-04/common.json index beada9ed44df..0c47b567fac8 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2022-04-04/common.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2022-04-04/common.json @@ -236,6 +236,24 @@ } }, "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}'." + }, + "SystemData": { + "description": "The system meta data relating to this resource.", + "type": "object", + "properties": { + "createdAt": { + "format": "date-time", + "description": "Specifies the time in UTC at which the Cloud Service (extended support) resource was created.
Minimum api-version: 2022-04-04.", + "type": "string", + "readOnly": true + }, + "lastModifiedAt": { + "format": "date-time", + "description": "Specifies the time in UTC at which the Cloud Service (extended support) resource was last modified.
Minimum api-version: 2022-04-04.", + "type": "string", + "readOnly": true + } + }, } }, "parameters": {