Vmm Servers - Update

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

Implements VmmServers PATCH method.
Updates the VmmServers resource.

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

URI Parameters

Name In Required Type Description
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.
vmmServerName
 path True

string

Name of the VmmServer.

Regex pattern: [a-zA-Z0-9-_\.]
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

VmmServer

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

VmmServers_Update_MaximumSet
VmmServers_Update_MinimumSet

VmmServers_Update_MaximumSet

Sample request

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

{
  "tags": {
    "key7187": "oktnfvklfchnquelzzdagtpwfskzc"
  }
}

Sample response

Status code:
200 
{
  "properties": {
    "credentials": {
      "username": "jbuoltypmrgqfi"
    },
    "fqdn": "pvzcjaqrswbvptgx",
    "port": 4,
    "connectionStatus": "vlmrrigzmutgbzrgjtolnamfxm",
    "errorMessage": "ndkzeiipz",
    "uuid": "vmwbukuqbuz",
    "version": "tawfjzbqrlkqzqyomxiahnfqg",
    "provisioningState": "Succeeded"
  },
  "extendedLocation": {
    "type": "customLocation",
    "name": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ExtendedLocation/customLocations/customLocationName"
  },
  "tags": {
    "key4834": "vycgfkzjcyyuotwwq"
  },
  "location": "hslxkyzktvwpqbypvs",
  "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName",
  "name": "gyoxmcbnbbfajvzygtffpaufxxjzs",
  "type": "nwiimbcjryiggdcbpvrqdnlrklcwbr",
  "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

VmmServers_Update_MinimumSet

Sample request

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

{}

Sample response

Status code:
200 
{
  "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/vmmServers/vmmServerName",
  "extendedLocation": {},
  "location": "hslxkyzktvwpqbypvs"
}
Status code:
202 
location: https://contoso.com/operationstatus

Definitions

Name Description
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.
VmmCredential

Credentials to connect to VmmServer.
VmmServer

The VmmServers resource definition.
VmmServerTagsUpdate

The type used for updating tags in VmmServer resources.

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.

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.

VmmCredential

Credentials to connect to VmmServer.

Name Type Description
password

string

Password to use to connect to VmmServer.
username

string

Username to use to connect to VmmServer.

VmmServer

The VmmServers 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.connectionStatus

string

Gets the connection status to the vmmServer.
properties.credentials

VmmCredential

Credentials to connect to VmmServer.
properties.errorMessage

string

Gets any error message if connection to vmmServer is having any issue.
properties.fqdn

string

Fqdn is the hostname/ip of the vmmServer.
properties.port

integer

Port is the port on which the vmmServer is listening.
properties.provisioningState

ProvisioningState

Provisioning state of the resource.
properties.uuid

string

Unique ID of vmmServer.
properties.version

string

Version is the version of the vmmSever.
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"

VmmServerTagsUpdate

The type used for updating tags in VmmServer resources.

Name Type Description
tags

object

Resource tags.