Availability Sets - Update

Service:

Azure Arc enabled SCVMM

API Version:

2024-06-01

Implements the AvailabilitySets PATCH method.
Updates the AvailabilitySets resource.

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

URI Parameters

Name	In	Required	Type	Description
availabilitySetResourceName	path	True	string minLength: 1 maxLength: 54 pattern: [a-zA-Z0-9-_\.]	Name of the AvailabilitySet.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	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 minLength: 1	The API version to use for this operation.

Request Body

Name	Type	Description
tags	object	Resource tags.

Responses

Name	Type	Description
200 OK	AvailabilitySet	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

AvailabilitySets_Update_MaximumSet

AvailabilitySets_Update_MinimumSet

AvailabilitySets_Update_MaximumSet

Sample request

HTTP

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

{
  "tags": {
    "key1460": "vcbwibkvr"
  }
}

Sample response

Status code:

200

{
  "properties": {
    "availabilitySetName": "njrpftunzo",
    "vmmServerId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName",
    "provisioningState": "Succeeded"
  },
  "extendedLocation": {
    "type": "customLocation",
    "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName"
  },
  "tags": {
    "key5701": "cldtxloqh"
  },
  "location": "jelevilan",
  "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/availabilitySets/availabilitySetResourceName",
  "name": "dibfuxyuidzxcfik",
  "type": "xwzjruksexpuqgtreexm",
  "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

AvailabilitySets_Update_MinimumSet

Sample request

HTTP

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

{}

Sample response

Status code:

200

{
  "extendedLocation": {},
  "location": "jelevilan"
}

Status code:

202

location: https://contoso.com/operationstatus

Definitions

Name	Description
AvailabilitySet	The AvailabilitySets resource definition.
AvailabilitySetTagsUpdate	The type used for updating tags in AvailabilitySet 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.
systemData	Metadata pertaining to creation and last modification of the resource.

AvailabilitySet

Object

The AvailabilitySets resource definition.

Name	Type	Description
extendedLocation	ExtendedLocation	The extended location.
id	string (arm-id)	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.availabilitySetName	string minLength: 1	Name of the availability set.
properties.provisioningState	ProvisioningState	Provisioning state of the resource.
properties.vmmServerId	string (arm-id)	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"

AvailabilitySetTagsUpdate

Object

The type used for updating tags in AvailabilitySet resources.

Name	Type	Description
tags	object	Resource tags.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

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

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ExtendedLocation

Object

The extended location.

Name	Type	Description
name	string (arm-id)	The extended location name.
type	string	The extended location type.

ProvisioningState

Enumeration

The provisioning state of the resource.

Value	Description
Accepted	The resource has been accepted.
Canceled	Resource creation was canceled.
Created	The resource was created.
Deleting	The resource is being deleted.
Failed	Resource creation failed.
Provisioning	The resource is provisioning.
Succeeded	Resource has been created.
Updating	The resource is updating.

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	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 (date-time)	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.