Share via

Clouds - Update

  • Reference
Service:
Azure Arc enabled SCVMM
API Version:
2024-06-01

Implements the Clouds PATCH method.
Updates the Clouds resource.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/clouds/{cloudResourceName}?api-version=2024-06-01

URI Parameters

Name In Required Type Description
cloudResourceName
 path True

string

Name of the Cloud.

Regex pattern: [a-zA-Z0-9-_\.]
resourceGroupName
 path True

string

The name of the resource group. The name is case insensitive.
subscriptionId
 path True

string

uuid

The ID of the target subscription. The value must be an UUID.
api-version
 query True

string

The API version to use for this operation.

Request Body

Name Type Description
tags

object

Resource tags.

Responses

Name Type Description
200 OK

Cloud

Azure operation completed successfully.
202 Accepted

Resource update request accepted.

Headers

  • Location: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Clouds_Update_MaximumSet
Clouds_Update_MinimumSet

Clouds_Update_MaximumSet

Sample request

PATCH https://management.azure.com/subscriptions/79332E5A-630B-480F-A266-A941C015AB19/resourceGroups/rgscvmm/providers/Microsoft.ScVmm/clouds/P?api-version=2024-06-01

{
  "tags": {
    "key5266": "hjpcnwmpnixsolrxnbl"
  }
}

Sample response

Status code:
200 
{
  "properties": {
    "inventoryItemId": "qjd",
    "uuid": "12345678-1234-1234-1234-12345678abcd",
    "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName",
    "cloudName": "menarjsplhcqvnkjdwieroir",
    "cloudCapacity": {
      "cpuCount": 4,
      "memoryMB": 19,
      "vmCount": 28
    },
    "storageQoSPolicies": [
      {
        "name": "hvqcentnbwcunxhzfavyewhwlo",
        "id": "oclhgkydaw",
        "iopsMaximum": 6,
        "iopsMinimum": 25,
        "bandwidthLimit": 26,
        "policyId": "lvcylbmxrqjgarvhfny"
      }
    ],
    "provisioningState": "Succeeded"
  },
  "extendedLocation": {
    "type": "customLocation",
    "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName"
  },
  "tags": {
    "key4295": "wngosgcbdifaxdobufuuqxtho"
  },
  "location": "khwsdmaxfhmbu",
  "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/clouds/cloudResourceName",
  "name": "wwcwalpiufsfbnydxpr",
  "type": "qnaaimszbuokldohwrdfuiitpy",
  "systemData": {
    "createdBy": "p",
    "createdByType": "User",
    "createdAt": "2024-01-29T22:28:00.094Z",
    "lastModifiedBy": "goxcwpyyqlxndquly",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-01-29T22:28:00.095Z"
  }
}
Status code:
202 
location: https://contoso.com/operationstatus

Clouds_Update_MinimumSet

Sample request

PATCH https://management.azure.com/subscriptions/79332E5A-630B-480F-A266-A941C015AB19/resourceGroups/rgscvmm/providers/Microsoft.ScVmm/clouds/_?api-version=2024-06-01

{}

Sample response

Status code:
200 
{
  "extendedLocation": {},
  "location": "khwsdmaxfhmbu"
}
Status code:
202 
location: https://contoso.com/operationstatus

Definitions

Name Description
Cloud

The Clouds resource definition.
CloudCapacity

Cloud Capacity model
CloudTagsUpdate

The type used for updating tags in Cloud resources.
createdByType

The type of identity that created the resource.
ErrorAdditionalInfo

The resource management error additional info.
ErrorDetail

The error detail.
ErrorResponse

Error response
ExtendedLocation

The extended location.
ProvisioningState

The provisioning state of the resource.
StorageQosPolicy

The StorageQoSPolicy definition.
systemData

Metadata pertaining to creation and last modification of the resource.

Cloud

The Clouds resource definition.

Name Type Description
extendedLocation

ExtendedLocation

The extended location.
id

string

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location

string

The geo-location where the resource lives
name

string

The name of the resource
properties.cloudCapacity

CloudCapacity

Capacity of the cloud.
properties.cloudName

string

Name of the cloud in VmmServer.
properties.inventoryItemId

string

Gets or sets the inventory Item ID for the resource.
properties.provisioningState

ProvisioningState

Provisioning state of the resource.
properties.storageQoSPolicies

StorageQosPolicy[]

List of QoS policies available for the cloud.
properties.uuid

string

Unique ID of the cloud.
properties.vmmServerId

string

ARM Id of the vmmServer resource in which this resource resides.
systemData

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags

object

Resource tags.
type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

CloudCapacity

Cloud Capacity model

Name Type Description
cpuCount

integer

CPUCount specifies the maximum number of CPUs that can be allocated in the cloud.
memoryMB

integer

MemoryMB specifies a memory usage limit in megabytes.
vmCount

integer

VMCount gives the max number of VMs that can be deployed in the cloud.

CloudTagsUpdate

The type used for updating tags in Cloud resources.

Name Type Description
tags

object

Resource tags.

createdByType

The type of identity that created the resource.

Name Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.
type

string

The additional info type.

ErrorDetail

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.
code

string

The error code.
details

ErrorDetail[]

The error details.
message

string

The error message.
target

string

The error target.

ErrorResponse

Error response

Name Type Description
error

ErrorDetail

The error object.

ExtendedLocation

The extended location.

Name Type Description
name

string

The extended location name.
type

string

The extended location type.

ProvisioningState

The provisioning state of the resource.

Name Type Description
Accepted

string

The resource has been accepted.
Canceled

string

Resource creation was canceled.
Created

string

The resource was created.
Deleting

string

The resource is being deleted.
Failed

string

Resource creation failed.
Provisioning

string

The resource is provisioning.
Succeeded

string

Resource has been created.
Updating

string

The resource is updating.

StorageQosPolicy

The StorageQoSPolicy definition.

Name Type Description
bandwidthLimit

integer

The Bandwidth Limit for internet traffic.
id

string

The ID of the QoS policy.
iopsMaximum

integer

The maximum IO operations per second.
iopsMinimum

integer

The minimum IO operations per second.
name

string

The name of the policy.
policyId

string

The underlying policy.

systemData

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt

string

The timestamp of resource creation (UTC).
createdBy

string

The identity that created the resource.
createdByType

createdByType

The type of identity that created the resource.
lastModifiedAt

string

The timestamp of resource last modification (UTC)
lastModifiedBy

string

The identity that last modified the resource.
lastModifiedByType

createdByType

The type of identity that last modified the resource.