Microsoft.AzureStackHCI (preview:2025-12-01)

2025/12/18 • 68 new, 8 updated, 68 deleted methods

EdgeDevices_List (new)
Description :  List EdgeDevice resources by parent
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.AzureStackHCI/edgeDevices
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The EdgeDevice items on this page ,
Required: True ,
}
[
{
kind:
{
Description: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value. ,
Enum:
{
HCI: Arc-enabled edge device with HCI OS. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EdgeDevices_Get (new)
Description :  Get a EdgeDevice
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.AzureStackHCI/edgeDevices/{edgeDeviceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
edgeDeviceName:
{
Description: Name of Device ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value. ,
Enum:
{
HCI: Arc-enabled edge device with HCI OS. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EdgeDevices_CreateOrUpdate (new)
Description :  Create a EdgeDevice
Reference :  Link ¶

⚼ Request

PUT:  /{resourceUri}/providers/Microsoft.AzureStackHCI/edgeDevices/{edgeDeviceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
edgeDeviceName:
{
Description: Name of Device ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
kind:
{
Description: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value. ,
Enum:
{
HCI: Arc-enabled edge device with HCI OS. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
kind:
{
Description: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value. ,
Enum:
{
HCI: Arc-enabled edge device with HCI OS. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Edge device resource. ,
}
{
kind:
{
Description: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value. ,
Enum:
{
HCI: Arc-enabled edge device with HCI OS. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EdgeDevices_Delete (new)
Description :  Delete a EdgeDevice
Reference :  Link ¶

⚼ Request

DELETE:  /{resourceUri}/providers/Microsoft.AzureStackHCI/edgeDevices/{edgeDeviceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
edgeDeviceName:
{
Description: Name of Device ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EdgeDeviceJobs_ListByEdgeDevice (new)
Description :  List EdgeDeviceJob resources by EdgeDevice
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.AzureStackHCI/edgeDevices/{edgeDeviceName}/jobs
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
edgeDeviceName:
{
Description: Name of Device ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The EdgeDeviceJob items on this page ,
Required: True ,
}
[
{
kind:
{
Description: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value. ,
Enum:
{
HCI: Arc-enabled edge device with HCI OS. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EdgeDeviceJobs_Get (new)
Description :  Get a EdgeDeviceJob
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.AzureStackHCI/edgeDevices/{edgeDeviceName}/jobs/{jobsName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
edgeDeviceName:
{
Description: Name of Device ,
Required: True ,
}
string ,
jobsName:
{
Description: Name of EdgeDevice Job ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value. ,
Enum:
{
HCI: Arc-enabled edge device with HCI OS. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EdgeDeviceJobs_CreateOrUpdate (new)
Description :  Create a EdgeDeviceJob
Reference :  Link ¶

⚼ Request

PUT:  /{resourceUri}/providers/Microsoft.AzureStackHCI/edgeDevices/{edgeDeviceName}/jobs/{jobsName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
edgeDeviceName:
{
Description: Name of Device ,
Required: True ,
}
string ,
jobsName:
{
Description: Name of EdgeDevice Job ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
kind:
{
Description: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value. ,
Enum:
{
HCI: Arc-enabled edge device with HCI OS. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
kind:
{
Description: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value. ,
Enum:
{
HCI: Arc-enabled edge device with HCI OS. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: EdgeDevice Jobs resource ,
}
{
kind:
{
Description: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value. ,
Enum:
{
HCI: Arc-enabled edge device with HCI OS. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EdgeDeviceJobs_Delete (new)
Description :  Delete a EdgeDeviceJob
Reference :  Link ¶

⚼ Request

DELETE:  /{resourceUri}/providers/Microsoft.AzureStackHCI/edgeDevices/{edgeDeviceName}/jobs/{jobsName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
edgeDeviceName:
{
Description: Name of Device ,
Required: True ,
}
string ,
jobsName:
{
Description: Name of EdgeDevice Job ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EdgeDevices_Validate (new)
Description :  A long-running resource action.
Reference :  Link ¶

⚼ Request

POST:  /{resourceUri}/providers/Microsoft.AzureStackHCI/edgeDevices/{edgeDeviceName}/validate
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
edgeDeviceName:
{
Description: Name of Device ,
Required: True ,
}
string ,
ValidateRequest:
{
Description: The content of the action request ,
Required: True ,
}
{
edgeDeviceIds:
{
Description: Node Ids against which, current node has to be validated. ,
Required: True ,
}
[
string ,
]
,
additionalInfo:
{
Description: Additional info required for validation. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
status:
{
Description: edge device validation status ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_ListBySubscription (new)
Description :  List all HCI clusters in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AzureStackHCI/clusters
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Cluster items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Cluster properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state. Indicates the current lifecycle status of the resource, including creation, update, deletion, connectivity, and error states. ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Status of the cluster agent. Indicates the current connectivity, validation, and deployment state of the agent within the cluster. ,
Enum:
{
NotYetRegistered: The cluster agent has not yet registered with Azure. ,
ConnectedRecently: The cluster agent has connected to Azure recently. ,
NotConnectedRecently: The cluster agent has not connected to Azure recently. ,
Disconnected: The cluster agent is currently disconnected from Azure. ,
Error: An error occurred in the cluster agent's operation. ,
NotSpecified: The status of the cluster agent is not specified. ,
ValidationInProgress: Validation of the cluster agent is currently in progress. ,
ValidationSuccess: Validation of the cluster agent completed successfully. ,
ValidationFailed: Validation of the cluster agent failed. ,
DeploymentInProgress: Deployment of the cluster agent is currently in progress. ,
DeploymentFailed: Deployment of the cluster agent failed. ,
DeploymentSuccess: Deployment of the cluster agent completed successfully. ,
}
,
Required: False ,
}
enum ,
connectivityStatus:
{
Description: Overall connectivity status for the cluster resource. Indicates whether the cluster is connected to Azure, partially connected, or has not recently communicated. ,
Enum:
{
NotYetRegistered: The cluster has not yet registered with Azure. ,
Connected: The cluster is fully connected to Azure. ,
NotConnectedRecently: The cluster has not connected to Azure recently. ,
PartiallyConnected: Some components of the cluster are connected, while others are not. ,
Disconnected: The cluster is not connected to Azure. ,
NotSpecified: The connectivity status is not specified. ,
}
,
Required: False ,
}
enum ,
supportStatus:
{
Description: Indicates whether the cluster is under support. ,
Enum:
{
InSupport: The cluster is under support. ,
OutOfSupport: The cluster is out of support. ,
NotSpecified: The support status is not specified. ,
}
,
Required: False ,
}
enum ,
cloudId:
{
Description: Unique, immutable resource id. ,
Required: False ,
}
string ,
ring:
{
Description: The ring to which this cluster belongs to. ,
Required: False ,
}
string ,
cloudManagementEndpoint:
{
Description: Endpoint configured for management from the Azure portal. ,
Required: False ,
}
string ,
aadClientId:
{
Description: App id of cluster AAD identity. ,
Required: False ,
}
string ,
aadTenantId:
{
Description: Tenant id of cluster AAD identity. ,
Required: False ,
}
string ,
aadApplicationObjectId:
{
Description: Object id of cluster AAD identity. ,
Required: False ,
}
string ,
aadServicePrincipalObjectId:
{
Description: Id of cluster identity service principal. ,
Required: False ,
}
string ,
softwareAssuranceProperties:
{
Description: Software Assurance properties of the cluster. ,
Required: False ,
}
{
softwareAssuranceStatus:
{
Description: Status of the Software Assurance for the cluster. ,
Enum:
{
Enabled: Software Assurance is enabled for the cluster. ,
Disabled: Software Assurance is disabled for the cluster. ,
}
,
Required: False ,
}
enum ,
softwareAssuranceIntent:
{
Description: Customer Intent for Software Assurance Benefit. ,
Enum:
{
Enable: Customer intends to enable the Software Assurance benefit. ,
Disable: Customer intends to disable the Software Assurance benefit. ,
}
,
Required: False ,
}
enum ,
lastUpdated:
{
Description: TimeStamp denoting the latest SA benefit applicability is validated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
isManagementCluster:
{
Description: Is Management Cluster, when true indicates that the cluster is used for managing other clusters ,
Required: False ,
}
boolean ,
logCollectionProperties:
{
Description: Log Collection properties of the cluster. ,
Required: False ,
}
{
fromDate:
{
Description: From DateTimeStamp from when logs need to be connected ,
Format: date-time ,
Required: False ,
}
string ,
toDate:
{
Description: To DateTimeStamp till when logs need to be connected ,
Format: date-time ,
Required: False ,
}
string ,
lastLogGenerated:
{
Description: Recent DateTimeStamp where logs are successfully generated ,
Format: date-time ,
Required: False ,
}
string ,
logCollectionSessionDetails:
{
Required: False ,
}
[
{
logStartTime:
{
Description: Start Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
logEndTime:
{
Description: End Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
timeCollected:
{
Description: Duration of logs collected ,
Format: date-time ,
Required: False ,
}
string ,
logSize:
{
Description: Size of the logs collected ,
Format: int64 ,
Required: False ,
}
integer ,
logCollectionStatus:
{
Description: LogCollection status ,
Enum:
{
None: No log collection has been initiated. ,
InProgress: Log collection is currently in progress. ,
Failed: Log collection has failed. ,
Succeeded: Log collection completed successfully. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: CorrelationId of the log collection ,
Required: False ,
}
string ,
logCollectionJobType:
{
Description: Specifies the type of log collection job. Determines whether the logs are collected immediately on demand or as part of a scheduled operation. ,
Enum:
{
OnDemand: Log collection is triggered manually and executed immediately. ,
Scheduled: Log collection is scheduled to run at a predefined time or interval. ,
}
,
Required: False ,
}
enum ,
endTimeCollected:
{
Description: End Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
logCollectionError:
{
Description: Log Collection Error details of the cluster. ,
Required: False ,
}
{
errorCode:
{
Description: Error Code of the log collection ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error Message of the log collection ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
remoteSupportProperties:
{
Description: RemoteSupport properties of the cluster. ,
Required: False ,
}
{
accessLevel:
{
Description: Remote Support Access Level ,
Enum:
{
Diagnostics: Allows remote diagnostics operations only. ,
DiagnosticsAndRepair: Allows both remote diagnostics and repair operations. ,
}
,
Required: False ,
}
enum ,
expirationTimeStamp:
{
Description: Expiration DateTimeStamp when Remote Support Access will be expired ,
Format: date-time ,
Required: False ,
}
string ,
remoteSupportType:
{
Description: Remote Support Type for cluster ,
Enum:
{
Enable: Enable remote support for the cluster. ,
Revoke: Revoke previously enabled remote support for the cluster. ,
}
,
Required: False ,
}
enum ,
remoteSupportNodeSettings:
{
Required: False ,
}
[
{
arcResourceId:
{
Description: Arc ResourceId of the Node ,
Required: False ,
}
string ,
state:
{
Description: Remote Support Access Connection State on the Node ,
Required: False ,
}
string ,
createdAt:
{
Description: Remote Support Enablement Request Created TimeStamp on the Node ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: Remote Support Enablement Request Updated TimeStamp on the Node ,
Format: date-time ,
Required: False ,
}
string ,
connectionStatus:
{
Description: Remote Support Access Connection Status on the Node ,
Required: False ,
}
string ,
connectionErrorMessage:
{
Description: Remote Support Access Connection Error Message on the Node ,
Required: False ,
}
string ,
transcriptLocation:
{
Description: Remote Support Transcript location on the node ,
Required: False ,
}
string ,
}
,
]
,
remoteSupportSessionDetails:
{
Required: False ,
}
[
{
sessionStartTime:
{
Description: Remote Support Session StartTime on the Node ,
Format: date-time ,
Required: False ,
}
string ,
sessionEndTime:
{
Description: Remote Support Session EndTime on the Node ,
Format: date-time ,
Required: False ,
}
string ,
nodeName:
{
Description: Name of the node ,
Required: False ,
}
string ,
duration:
{
Description: Duration of Remote Support Enablement ,
Format: int64 ,
Required: False ,
}
integer ,
accessLevel:
{
Description: Remote Support Access Level ,
Enum:
{
Diagnostics: Allows remote diagnostics operations only. ,
DiagnosticsAndRepair: Allows both remote diagnostics and repair operations. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
desiredProperties:
{
Description: Desired properties of the cluster. ,
Required: False ,
}
{
windowsServerSubscription:
{
Description: Desired state of Windows Server Subscription. ,
Enum:
{
Disabled: Windows Server Subscription is disabled. ,
Enabled: Windows Server Subscription is enabled. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Desired level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No diagnostic data will be emitted. ,
Basic: Basic diagnostic data will be emitted, including essential health metrics. ,
Enhanced: Enhanced diagnostic data will be emitted, including detailed performance and usage metrics. ,
}
,
Required: False ,
}
enum ,
}
,
reportedProperties:
{
Description: Properties reported by cluster agent. ,
Required: False ,
}
{
clusterName:
{
Description: Name of the on-prem cluster connected to this resource. ,
Required: False ,
}
string ,
clusterId:
{
Description: Unique id generated by the on-prem cluster. ,
Required: False ,
}
string ,
clusterVersion:
{
Description: Version of the cluster software. ,
Required: False ,
}
string ,
nodes:
{
Description: List of nodes reported by the cluster. ,
Required: False ,
}
[
{
name:
{
Description: Name of the cluster node. ,
Required: False ,
}
string ,
id:
{
Description: Id of the node in the cluster. ,
Format: float ,
Required: False ,
}
number ,
windowsServerSubscription:
{
Description: State of Windows Server Subscription. ,
Enum:
{
Disabled: Windows Server Subscription is disabled. ,
Enabled: Windows Server Subscription is enabled. ,
}
,
Required: False ,
}
enum ,
nodeType:
{
Description: Type of the cluster node hardware. ,
Enum:
{
FirstParty: All nodes in the cluster are provided and managed by Microsoft. ,
ThirdParty: All nodes in the cluster are provided and managed by a third-party vendor. ,
}
,
Required: False ,
}
enum ,
ehcResourceId:
{
Description: Edge Hardware Center Resource Id ,
Required: False ,
}
string ,
manufacturer:
{
Description: Manufacturer of the cluster node hardware. ,
Required: False ,
}
string ,
model:
{
Description: Model name of the cluster node hardware. ,
Required: False ,
}
string ,
osName:
{
Description: Operating system running on the cluster node. ,
Required: False ,
}
string ,
osVersion:
{
Description: Version of the operating system running on the cluster node. ,
Required: False ,
}
string ,
osDisplayVersion:
{
Description: Display version of the operating system running on the cluster node. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Immutable id of the cluster node. ,
Required: False ,
}
string ,
coreCount:
{
Description: Number of physical cores on the cluster node. ,
Format: float ,
Required: False ,
}
number ,
memoryInGiB:
{
Description: Total available memory on the cluster node (in GiB). ,
Format: float ,
Required: False ,
}
number ,
lastLicensingTimestamp:
{
Description: Most recent licensing timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
oemActivation:
{
Description: OEM activation status of the node. ,
Enum:
{
Disabled: OEM activation is disabled for the cluster. ,
Enabled: OEM activation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
lastUpdated:
{
Description: Last time the cluster reported the data. ,
Format: date-time ,
Required: False ,
}
string ,
msiExpirationTimeStamp:
{
Description: Specifies the expiration timestamp of the cluster's Managed Service Identity (MSI). The value is expressed in Coordinated Universal Time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
imdsAttestation:
{
Description: IMDS attestation status of the cluster. ,
Enum:
{
Disabled: IMDS attestation is disabled for the cluster. ,
Enabled: IMDS attestation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No diagnostic data will be emitted. ,
Basic: Basic diagnostic data will be emitted, including essential health metrics. ,
Enhanced: Enhanced diagnostic data will be emitted, including detailed performance and usage metrics. ,
}
,
Required: False ,
}
enum ,
supportedCapabilities:
{
Description: Capabilities supported by the cluster. ,
Required: False ,
}
[
string ,
]
,
clusterType:
{
Description: Specifies the type of hardware vendor for all nodes in the cluster. Indicates whether the nodes are provided by Microsoft or a third-party vendor. ,
Enum:
{
FirstParty: All nodes in the cluster are provided and managed by Microsoft. ,
ThirdParty: All nodes in the cluster are provided and managed by a third-party vendor. ,
}
,
Required: False ,
}
enum ,
manufacturer:
{
Description: The manufacturer of all the nodes of the cluster. ,
Required: False ,
}
string ,
oemActivation:
{
Description: OEM activation status of the cluster. ,
Enum:
{
Disabled: OEM activation is disabled for the cluster. ,
Enabled: OEM activation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
hardwareClass:
{
Description: Hardware class of the cluster. ,
Enum:
{
Small: The hardware class is small. ,
Medium: The hardware class is medium. This corresponds to the default ,
Large: The hardware class is large. ,
}
,
Required: False ,
}
enum ,
}
,
isolatedVmAttestationConfiguration:
{
Description: Attestation configurations for isolated VM (e.g. TVM, CVM) of the cluster. ,
Required: False ,
}
{
attestationResourceId:
{
Description: Fully qualified Azure resource id of the Microsoft Azure attestation resource associated with this cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
relyingPartyServiceEndpoint:
{
Description: Region specific endpoint for relying party service. ,
Required: False ,
}
string ,
attestationServiceEndpoint:
{
Description: Region specific endpoint for Microsoft Azure Attestation service for the cluster ,
Required: False ,
}
string ,
}
,
trialDaysRemaining:
{
Description: Number of days remaining in the trial period. ,
Format: float ,
Required: False ,
}
number ,
billingModel:
{
Description: Type of billing applied to the resource. ,
Required: False ,
}
string ,
registrationTimestamp:
{
Description: First cluster sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncTimestamp:
{
Description: Most recent cluster sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastBillingTimestamp:
{
Description: Most recent billing meter timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
serviceEndpoint:
{
Description: Region specific DataPath Endpoint of the cluster. ,
Required: False ,
}
string ,
resourceProviderObjectId:
{
Description: Object id of RP Service Principal ,
Required: False ,
}
string ,
secretsLocations:
{
Description: List of secret locations. ,
Required: False ,
}
[
{
secretsType:
{
Description: Type of secrets to store ,
Enum:
{
BackupSecrets: Backup secrets type ,
}
,
Required: True ,
}
enum ,
secretsLocation:
{
Description: secrets location ,
Required: True ,
}
string ,
}
,
]
,
clusterPattern:
{
Description: Supported Storage Type for HCI Cluster ,
Enum:
{
Standard: Standard cluster. ,
RackAware: RackAware cluster. ,
}
,
Required: False ,
}
enum ,
confidentialVmProperties:
{
Description: Represents the Confidential Virtual Machine (CVM) support intent and current status for the cluster resource. ,
Required: False ,
}
{
confidentialVmIntent:
{
Description: Captures the customer's intent to enable or disable CVM support on the cluster, either during initial deployment (Day-0) or at a later stage (Day-N). ,
Enum:
{
Enable: Indicates that the customer intends to enable CVM support on the cluster. ,
Disable: Indicates that the customer intends to disable CVM support on the cluster. ,
}
,
Required: False ,
}
enum ,
confidentialVmStatus:
{
Description: Captures the current status of CVM support on the cluster. ,
Enum:
{
Enabled: CVM support is fully enabled on the cluster. All nodes are CVM capable. ,
PartiallyEnabled: CVM support is partially enabled. At least one node in the cluster is CVM capable. ,
Disabled: CVM support is disabled. None of the nodes in the cluster are CVM capable. ,
}
,
Required: False ,
}
enum ,
confidentialVmStatusSummary:
{
Description: Additional context about CVM support on the cluster, such as reasons for partial enablement or hardware constraints. ,
Required: False ,
}
string ,
}
,
sdnProperties:
{
Description: Software Defined Networking Properties of the cluster ,
Required: False ,
}
{
sdnIntegrationIntent:
{
Description: Indicates whether Software Defined Networking (SDN) integration should be enabled or disabled for this deployment. ,
Enum:
{
Enable: Enable SDN integration for the deployment. ,
Disable: Disable SDN integration for the deployment. ,
}
,
Required: False ,
}
enum ,
}
,
localAvailabilityZones:
{
Description: Local Availability Zone information for HCI cluster ,
Required: False ,
}
[
{
localAvailabilityZoneName:
{
Description: Local Availability Zone name for HCI cluster ,
Required: False ,
}
string ,
nodes:
{
Description: Nodes belonging to a particular zone ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
identityProvider:
{
Description: Identity Provider for the cluster ,
Enum:
{
ActiveDirectory: Uses Active Directory as the identity provider, enabling domain-based authentication and centralized identity management. This is the default option. ,
LocalIdentity: Uses a local identity system integrated with Azure Key Vault for authentication. Suitable for AD-less environments where Active Directory is not available or required. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
kind:
{
Description: This property identifies the purpose of the Cluster deployment. For example, a valid value is AzureLocal ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ValidatedSolutionRecipes_ListBySubscriptionLocationResource (new)
Description :  List all validated solution recipes.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AzureStackHCI/locations/{location}/validatedSolutionRecipes
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ValidatedSolutionRecipe items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
recipeContent:
{
Description: Represents contents of a validated solution recipe. ,
Required: True ,
}
{
info:
{
Description: Represents information about a validated solution recipe. ,
Required: True ,
}
{
solutionType:
{
Description: Represents the solution type for which this validated solution recipe is applicable. ,
Required: True ,
}
string ,
version:
{
Description: Represents the version for which this validated solution recipe is applicable. ,
Required: True ,
}
string ,
}
,
capabilities:
{
Description: Represents capabilities available in a validated solution recipe. ,
Required: False ,
}
{
clusterCapabilities:
{
Description: Represents the cluster capabilities. ,
Required: True ,
}
[
{
capabilityName:
{
Description: Represents the capability name. ,
Required: True ,
}
string ,
}
,
]
,
nodeCapabilities:
{
Description: Represents the node capabilities. ,
Required: True ,
}
[
{
capabilityName:
{
Description: Represents the capability name. ,
Required: True ,
}
string ,
}
,
]
,
}
,
components:
{
Description: Represents components available in a validated solution recipe. ,
Required: True ,
}
[
{
name:
{
Description: Represents the component's name. ,
Required: True ,
}
string ,
type:
{
Description: Represents the component's type. ,
Required: True ,
}
string ,
requiredVersion:
{
Description: Represents the component's required version. ,
Required: False ,
}
string ,
installOrder:
{
Description: Represents the component's install order. ,
Format: int64 ,
Required: False ,
}
integer ,
tags:
{
Description: Represents the component's tags. ,
Required: True ,
}
[
string ,
]
,
payloads:
{
Description: Represents the component's payloads. ,
Required: False ,
}
[
{
identifier:
{
Description: Represents the unique identifier of the payload used to query the URL. ,
Required: True ,
}
string ,
hash:
{
Description: Represents the cryptographic hash of the payload, ensuring data integrity. ,
Required: True ,
}
string ,
fileName:
{
Description: Represents the name of the file associated with the payload. ,
Required: True ,
}
string ,
url:
{
Description: Represents the URL from which the payload can be downloaded. ,
Required: True ,
}
string ,
}
,
]
,
metadata:
{
Description: Represents the component's metadata. ,
Required: False ,
}
{
extensionType:
{
Description: Represents the type of extension. ,
Required: False ,
}
string ,
publisher:
{
Description: Represents the publisher of the extension. ,
Required: False ,
}
string ,
enableAutomaticUpgrade:
{
Description: Indicates whether automatic upgrades of the extension are enabled. ,
Required: False ,
}
boolean ,
lcmUpdate:
{
Description: Indicates whether the LCM (Lifecycle Management) update of the extension is enabled. ,
Required: False ,
}
boolean ,
catalog:
{
Description: Specifies the catalog to which the extension belongs. ,
Required: False ,
}
string ,
ring:
{
Description: Specifies the ring to which the extension belongs, internally used by component. ,
Required: False ,
}
string ,
releaseTrain:
{
Description: Specifies the release train to which given component belongs. ,
Required: False ,
}
string ,
link:
{
Description: Specifies the link associated with the extension. ,
Required: False ,
}
string ,
name:
{
Description: Specifies the name of the extension. ,
Required: False ,
}
string ,
expectedHash:
{
Description: Specifies the expected hash of the extension. ,
Required: False ,
}
string ,
previewSource:
{
Description: Specifies the preview source of the extension. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
signature:
{
Description: Represents the signature of the recipe, to be used for ensuring its integrity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ValidatedSolutionRecipes_Get (new)
Description :  Get a validated solution recipe.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AzureStackHCI/locations/{location}/validatedSolutionRecipes/{validatedSolutionRecipeName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
validatedSolutionRecipeName:
{
Description: The name of the ValidatedSolutionRecipe ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
recipeContent:
{
Description: Represents contents of a validated solution recipe. ,
Required: True ,
}
{
info:
{
Description: Represents information about a validated solution recipe. ,
Required: True ,
}
{
solutionType:
{
Description: Represents the solution type for which this validated solution recipe is applicable. ,
Required: True ,
}
string ,
version:
{
Description: Represents the version for which this validated solution recipe is applicable. ,
Required: True ,
}
string ,
}
,
capabilities:
{
Description: Represents capabilities available in a validated solution recipe. ,
Required: False ,
}
{
clusterCapabilities:
{
Description: Represents the cluster capabilities. ,
Required: True ,
}
[
{
capabilityName:
{
Description: Represents the capability name. ,
Required: True ,
}
string ,
}
,
]
,
nodeCapabilities:
{
Description: Represents the node capabilities. ,
Required: True ,
}
[
{
capabilityName:
{
Description: Represents the capability name. ,
Required: True ,
}
string ,
}
,
]
,
}
,
components:
{
Description: Represents components available in a validated solution recipe. ,
Required: True ,
}
[
{
name:
{
Description: Represents the component's name. ,
Required: True ,
}
string ,
type:
{
Description: Represents the component's type. ,
Required: True ,
}
string ,
requiredVersion:
{
Description: Represents the component's required version. ,
Required: False ,
}
string ,
installOrder:
{
Description: Represents the component's install order. ,
Format: int64 ,
Required: False ,
}
integer ,
tags:
{
Description: Represents the component's tags. ,
Required: True ,
}
[
string ,
]
,
payloads:
{
Description: Represents the component's payloads. ,
Required: False ,
}
[
{
identifier:
{
Description: Represents the unique identifier of the payload used to query the URL. ,
Required: True ,
}
string ,
hash:
{
Description: Represents the cryptographic hash of the payload, ensuring data integrity. ,
Required: True ,
}
string ,
fileName:
{
Description: Represents the name of the file associated with the payload. ,
Required: True ,
}
string ,
url:
{
Description: Represents the URL from which the payload can be downloaded. ,
Required: True ,
}
string ,
}
,
]
,
metadata:
{
Description: Represents the component's metadata. ,
Required: False ,
}
{
extensionType:
{
Description: Represents the type of extension. ,
Required: False ,
}
string ,
publisher:
{
Description: Represents the publisher of the extension. ,
Required: False ,
}
string ,
enableAutomaticUpgrade:
{
Description: Indicates whether automatic upgrades of the extension are enabled. ,
Required: False ,
}
boolean ,
lcmUpdate:
{
Description: Indicates whether the LCM (Lifecycle Management) update of the extension is enabled. ,
Required: False ,
}
boolean ,
catalog:
{
Description: Specifies the catalog to which the extension belongs. ,
Required: False ,
}
string ,
ring:
{
Description: Specifies the ring to which the extension belongs, internally used by component. ,
Required: False ,
}
string ,
releaseTrain:
{
Description: Specifies the release train to which given component belongs. ,
Required: False ,
}
string ,
link:
{
Description: Specifies the link associated with the extension. ,
Required: False ,
}
string ,
name:
{
Description: Specifies the name of the extension. ,
Required: False ,
}
string ,
expectedHash:
{
Description: Specifies the expected hash of the extension. ,
Required: False ,
}
string ,
previewSource:
{
Description: Specifies the preview source of the extension. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
signature:
{
Description: Represents the signature of the recipe, to be used for ensuring its integrity. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_ListByResourceGroup (new)
Description :  List all HCI clusters in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Cluster items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Cluster properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state. Indicates the current lifecycle status of the resource, including creation, update, deletion, connectivity, and error states. ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Status of the cluster agent. Indicates the current connectivity, validation, and deployment state of the agent within the cluster. ,
Enum:
{
NotYetRegistered: The cluster agent has not yet registered with Azure. ,
ConnectedRecently: The cluster agent has connected to Azure recently. ,
NotConnectedRecently: The cluster agent has not connected to Azure recently. ,
Disconnected: The cluster agent is currently disconnected from Azure. ,
Error: An error occurred in the cluster agent's operation. ,
NotSpecified: The status of the cluster agent is not specified. ,
ValidationInProgress: Validation of the cluster agent is currently in progress. ,
ValidationSuccess: Validation of the cluster agent completed successfully. ,
ValidationFailed: Validation of the cluster agent failed. ,
DeploymentInProgress: Deployment of the cluster agent is currently in progress. ,
DeploymentFailed: Deployment of the cluster agent failed. ,
DeploymentSuccess: Deployment of the cluster agent completed successfully. ,
}
,
Required: False ,
}
enum ,
connectivityStatus:
{
Description: Overall connectivity status for the cluster resource. Indicates whether the cluster is connected to Azure, partially connected, or has not recently communicated. ,
Enum:
{
NotYetRegistered: The cluster has not yet registered with Azure. ,
Connected: The cluster is fully connected to Azure. ,
NotConnectedRecently: The cluster has not connected to Azure recently. ,
PartiallyConnected: Some components of the cluster are connected, while others are not. ,
Disconnected: The cluster is not connected to Azure. ,
NotSpecified: The connectivity status is not specified. ,
}
,
Required: False ,
}
enum ,
supportStatus:
{
Description: Indicates whether the cluster is under support. ,
Enum:
{
InSupport: The cluster is under support. ,
OutOfSupport: The cluster is out of support. ,
NotSpecified: The support status is not specified. ,
}
,
Required: False ,
}
enum ,
cloudId:
{
Description: Unique, immutable resource id. ,
Required: False ,
}
string ,
ring:
{
Description: The ring to which this cluster belongs to. ,
Required: False ,
}
string ,
cloudManagementEndpoint:
{
Description: Endpoint configured for management from the Azure portal. ,
Required: False ,
}
string ,
aadClientId:
{
Description: App id of cluster AAD identity. ,
Required: False ,
}
string ,
aadTenantId:
{
Description: Tenant id of cluster AAD identity. ,
Required: False ,
}
string ,
aadApplicationObjectId:
{
Description: Object id of cluster AAD identity. ,
Required: False ,
}
string ,
aadServicePrincipalObjectId:
{
Description: Id of cluster identity service principal. ,
Required: False ,
}
string ,
softwareAssuranceProperties:
{
Description: Software Assurance properties of the cluster. ,
Required: False ,
}
{
softwareAssuranceStatus:
{
Description: Status of the Software Assurance for the cluster. ,
Enum:
{
Enabled: Software Assurance is enabled for the cluster. ,
Disabled: Software Assurance is disabled for the cluster. ,
}
,
Required: False ,
}
enum ,
softwareAssuranceIntent:
{
Description: Customer Intent for Software Assurance Benefit. ,
Enum:
{
Enable: Customer intends to enable the Software Assurance benefit. ,
Disable: Customer intends to disable the Software Assurance benefit. ,
}
,
Required: False ,
}
enum ,
lastUpdated:
{
Description: TimeStamp denoting the latest SA benefit applicability is validated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
isManagementCluster:
{
Description: Is Management Cluster, when true indicates that the cluster is used for managing other clusters ,
Required: False ,
}
boolean ,
logCollectionProperties:
{
Description: Log Collection properties of the cluster. ,
Required: False ,
}
{
fromDate:
{
Description: From DateTimeStamp from when logs need to be connected ,
Format: date-time ,
Required: False ,
}
string ,
toDate:
{
Description: To DateTimeStamp till when logs need to be connected ,
Format: date-time ,
Required: False ,
}
string ,
lastLogGenerated:
{
Description: Recent DateTimeStamp where logs are successfully generated ,
Format: date-time ,
Required: False ,
}
string ,
logCollectionSessionDetails:
{
Required: False ,
}
[
{
logStartTime:
{
Description: Start Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
logEndTime:
{
Description: End Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
timeCollected:
{
Description: Duration of logs collected ,
Format: date-time ,
Required: False ,
}
string ,
logSize:
{
Description: Size of the logs collected ,
Format: int64 ,
Required: False ,
}
integer ,
logCollectionStatus:
{
Description: LogCollection status ,
Enum:
{
None: No log collection has been initiated. ,
InProgress: Log collection is currently in progress. ,
Failed: Log collection has failed. ,
Succeeded: Log collection completed successfully. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: CorrelationId of the log collection ,
Required: False ,
}
string ,
logCollectionJobType:
{
Description: Specifies the type of log collection job. Determines whether the logs are collected immediately on demand or as part of a scheduled operation. ,
Enum:
{
OnDemand: Log collection is triggered manually and executed immediately. ,
Scheduled: Log collection is scheduled to run at a predefined time or interval. ,
}
,
Required: False ,
}
enum ,
endTimeCollected:
{
Description: End Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
logCollectionError:
{
Description: Log Collection Error details of the cluster. ,
Required: False ,
}
{
errorCode:
{
Description: Error Code of the log collection ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error Message of the log collection ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
remoteSupportProperties:
{
Description: RemoteSupport properties of the cluster. ,
Required: False ,
}
{
accessLevel:
{
Description: Remote Support Access Level ,
Enum:
{
Diagnostics: Allows remote diagnostics operations only. ,
DiagnosticsAndRepair: Allows both remote diagnostics and repair operations. ,
}
,
Required: False ,
}
enum ,
expirationTimeStamp:
{
Description: Expiration DateTimeStamp when Remote Support Access will be expired ,
Format: date-time ,
Required: False ,
}
string ,
remoteSupportType:
{
Description: Remote Support Type for cluster ,
Enum:
{
Enable: Enable remote support for the cluster. ,
Revoke: Revoke previously enabled remote support for the cluster. ,
}
,
Required: False ,
}
enum ,
remoteSupportNodeSettings:
{
Required: False ,
}
[
{
arcResourceId:
{
Description: Arc ResourceId of the Node ,
Required: False ,
}
string ,
state:
{
Description: Remote Support Access Connection State on the Node ,
Required: False ,
}
string ,
createdAt:
{
Description: Remote Support Enablement Request Created TimeStamp on the Node ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: Remote Support Enablement Request Updated TimeStamp on the Node ,
Format: date-time ,
Required: False ,
}
string ,
connectionStatus:
{
Description: Remote Support Access Connection Status on the Node ,
Required: False ,
}
string ,
connectionErrorMessage:
{
Description: Remote Support Access Connection Error Message on the Node ,
Required: False ,
}
string ,
transcriptLocation:
{
Description: Remote Support Transcript location on the node ,
Required: False ,
}
string ,
}
,
]
,
remoteSupportSessionDetails:
{
Required: False ,
}
[
{
sessionStartTime:
{
Description: Remote Support Session StartTime on the Node ,
Format: date-time ,
Required: False ,
}
string ,
sessionEndTime:
{
Description: Remote Support Session EndTime on the Node ,
Format: date-time ,
Required: False ,
}
string ,
nodeName:
{
Description: Name of the node ,
Required: False ,
}
string ,
duration:
{
Description: Duration of Remote Support Enablement ,
Format: int64 ,
Required: False ,
}
integer ,
accessLevel:
{
Description: Remote Support Access Level ,
Enum:
{
Diagnostics: Allows remote diagnostics operations only. ,
DiagnosticsAndRepair: Allows both remote diagnostics and repair operations. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
desiredProperties:
{
Description: Desired properties of the cluster. ,
Required: False ,
}
{
windowsServerSubscription:
{
Description: Desired state of Windows Server Subscription. ,
Enum:
{
Disabled: Windows Server Subscription is disabled. ,
Enabled: Windows Server Subscription is enabled. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Desired level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No diagnostic data will be emitted. ,
Basic: Basic diagnostic data will be emitted, including essential health metrics. ,
Enhanced: Enhanced diagnostic data will be emitted, including detailed performance and usage metrics. ,
}
,
Required: False ,
}
enum ,
}
,
reportedProperties:
{
Description: Properties reported by cluster agent. ,
Required: False ,
}
{
clusterName:
{
Description: Name of the on-prem cluster connected to this resource. ,
Required: False ,
}
string ,
clusterId:
{
Description: Unique id generated by the on-prem cluster. ,
Required: False ,
}
string ,
clusterVersion:
{
Description: Version of the cluster software. ,
Required: False ,
}
string ,
nodes:
{
Description: List of nodes reported by the cluster. ,
Required: False ,
}
[
{
name:
{
Description: Name of the cluster node. ,
Required: False ,
}
string ,
id:
{
Description: Id of the node in the cluster. ,
Format: float ,
Required: False ,
}
number ,
windowsServerSubscription:
{
Description: State of Windows Server Subscription. ,
Enum:
{
Disabled: Windows Server Subscription is disabled. ,
Enabled: Windows Server Subscription is enabled. ,
}
,
Required: False ,
}
enum ,
nodeType:
{
Description: Type of the cluster node hardware. ,
Enum:
{
FirstParty: All nodes in the cluster are provided and managed by Microsoft. ,
ThirdParty: All nodes in the cluster are provided and managed by a third-party vendor. ,
}
,
Required: False ,
}
enum ,
ehcResourceId:
{
Description: Edge Hardware Center Resource Id ,
Required: False ,
}
string ,
manufacturer:
{
Description: Manufacturer of the cluster node hardware. ,
Required: False ,
}
string ,
model:
{
Description: Model name of the cluster node hardware. ,
Required: False ,
}
string ,
osName:
{
Description: Operating system running on the cluster node. ,
Required: False ,
}
string ,
osVersion:
{
Description: Version of the operating system running on the cluster node. ,
Required: False ,
}
string ,
osDisplayVersion:
{
Description: Display version of the operating system running on the cluster node. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Immutable id of the cluster node. ,
Required: False ,
}
string ,
coreCount:
{
Description: Number of physical cores on the cluster node. ,
Format: float ,
Required: False ,
}
number ,
memoryInGiB:
{
Description: Total available memory on the cluster node (in GiB). ,
Format: float ,
Required: False ,
}
number ,
lastLicensingTimestamp:
{
Description: Most recent licensing timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
oemActivation:
{
Description: OEM activation status of the node. ,
Enum:
{
Disabled: OEM activation is disabled for the cluster. ,
Enabled: OEM activation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
lastUpdated:
{
Description: Last time the cluster reported the data. ,
Format: date-time ,
Required: False ,
}
string ,
msiExpirationTimeStamp:
{
Description: Specifies the expiration timestamp of the cluster's Managed Service Identity (MSI). The value is expressed in Coordinated Universal Time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
imdsAttestation:
{
Description: IMDS attestation status of the cluster. ,
Enum:
{
Disabled: IMDS attestation is disabled for the cluster. ,
Enabled: IMDS attestation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No diagnostic data will be emitted. ,
Basic: Basic diagnostic data will be emitted, including essential health metrics. ,
Enhanced: Enhanced diagnostic data will be emitted, including detailed performance and usage metrics. ,
}
,
Required: False ,
}
enum ,
supportedCapabilities:
{
Description: Capabilities supported by the cluster. ,
Required: False ,
}
[
string ,
]
,
clusterType:
{
Description: Specifies the type of hardware vendor for all nodes in the cluster. Indicates whether the nodes are provided by Microsoft or a third-party vendor. ,
Enum:
{
FirstParty: All nodes in the cluster are provided and managed by Microsoft. ,
ThirdParty: All nodes in the cluster are provided and managed by a third-party vendor. ,
}
,
Required: False ,
}
enum ,
manufacturer:
{
Description: The manufacturer of all the nodes of the cluster. ,
Required: False ,
}
string ,
oemActivation:
{
Description: OEM activation status of the cluster. ,
Enum:
{
Disabled: OEM activation is disabled for the cluster. ,
Enabled: OEM activation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
hardwareClass:
{
Description: Hardware class of the cluster. ,
Enum:
{
Small: The hardware class is small. ,
Medium: The hardware class is medium. This corresponds to the default ,
Large: The hardware class is large. ,
}
,
Required: False ,
}
enum ,
}
,
isolatedVmAttestationConfiguration:
{
Description: Attestation configurations for isolated VM (e.g. TVM, CVM) of the cluster. ,
Required: False ,
}
{
attestationResourceId:
{
Description: Fully qualified Azure resource id of the Microsoft Azure attestation resource associated with this cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
relyingPartyServiceEndpoint:
{
Description: Region specific endpoint for relying party service. ,
Required: False ,
}
string ,
attestationServiceEndpoint:
{
Description: Region specific endpoint for Microsoft Azure Attestation service for the cluster ,
Required: False ,
}
string ,
}
,
trialDaysRemaining:
{
Description: Number of days remaining in the trial period. ,
Format: float ,
Required: False ,
}
number ,
billingModel:
{
Description: Type of billing applied to the resource. ,
Required: False ,
}
string ,
registrationTimestamp:
{
Description: First cluster sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncTimestamp:
{
Description: Most recent cluster sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastBillingTimestamp:
{
Description: Most recent billing meter timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
serviceEndpoint:
{
Description: Region specific DataPath Endpoint of the cluster. ,
Required: False ,
}
string ,
resourceProviderObjectId:
{
Description: Object id of RP Service Principal ,
Required: False ,
}
string ,
secretsLocations:
{
Description: List of secret locations. ,
Required: False ,
}
[
{
secretsType:
{
Description: Type of secrets to store ,
Enum:
{
BackupSecrets: Backup secrets type ,
}
,
Required: True ,
}
enum ,
secretsLocation:
{
Description: secrets location ,
Required: True ,
}
string ,
}
,
]
,
clusterPattern:
{
Description: Supported Storage Type for HCI Cluster ,
Enum:
{
Standard: Standard cluster. ,
RackAware: RackAware cluster. ,
}
,
Required: False ,
}
enum ,
confidentialVmProperties:
{
Description: Represents the Confidential Virtual Machine (CVM) support intent and current status for the cluster resource. ,
Required: False ,
}
{
confidentialVmIntent:
{
Description: Captures the customer's intent to enable or disable CVM support on the cluster, either during initial deployment (Day-0) or at a later stage (Day-N). ,
Enum:
{
Enable: Indicates that the customer intends to enable CVM support on the cluster. ,
Disable: Indicates that the customer intends to disable CVM support on the cluster. ,
}
,
Required: False ,
}
enum ,
confidentialVmStatus:
{
Description: Captures the current status of CVM support on the cluster. ,
Enum:
{
Enabled: CVM support is fully enabled on the cluster. All nodes are CVM capable. ,
PartiallyEnabled: CVM support is partially enabled. At least one node in the cluster is CVM capable. ,
Disabled: CVM support is disabled. None of the nodes in the cluster are CVM capable. ,
}
,
Required: False ,
}
enum ,
confidentialVmStatusSummary:
{
Description: Additional context about CVM support on the cluster, such as reasons for partial enablement or hardware constraints. ,
Required: False ,
}
string ,
}
,
sdnProperties:
{
Description: Software Defined Networking Properties of the cluster ,
Required: False ,
}
{
sdnIntegrationIntent:
{
Description: Indicates whether Software Defined Networking (SDN) integration should be enabled or disabled for this deployment. ,
Enum:
{
Enable: Enable SDN integration for the deployment. ,
Disable: Disable SDN integration for the deployment. ,
}
,
Required: False ,
}
enum ,
}
,
localAvailabilityZones:
{
Description: Local Availability Zone information for HCI cluster ,
Required: False ,
}
[
{
localAvailabilityZoneName:
{
Description: Local Availability Zone name for HCI cluster ,
Required: False ,
}
string ,
nodes:
{
Description: Nodes belonging to a particular zone ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
identityProvider:
{
Description: Identity Provider for the cluster ,
Enum:
{
ActiveDirectory: Uses Active Directory as the identity provider, enabling domain-based authentication and centralized identity management. This is the default option. ,
LocalIdentity: Uses a local identity system integrated with Azure Key Vault for authentication. Suitable for AD-less environments where Active Directory is not available or required. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
kind:
{
Description: This property identifies the purpose of the Cluster deployment. For example, a valid value is AzureLocal ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_Get (new)
Description :  Get HCI cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Cluster properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state. Indicates the current lifecycle status of the resource, including creation, update, deletion, connectivity, and error states. ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Status of the cluster agent. Indicates the current connectivity, validation, and deployment state of the agent within the cluster. ,
Enum:
{
NotYetRegistered: The cluster agent has not yet registered with Azure. ,
ConnectedRecently: The cluster agent has connected to Azure recently. ,
NotConnectedRecently: The cluster agent has not connected to Azure recently. ,
Disconnected: The cluster agent is currently disconnected from Azure. ,
Error: An error occurred in the cluster agent's operation. ,
NotSpecified: The status of the cluster agent is not specified. ,
ValidationInProgress: Validation of the cluster agent is currently in progress. ,
ValidationSuccess: Validation of the cluster agent completed successfully. ,
ValidationFailed: Validation of the cluster agent failed. ,
DeploymentInProgress: Deployment of the cluster agent is currently in progress. ,
DeploymentFailed: Deployment of the cluster agent failed. ,
DeploymentSuccess: Deployment of the cluster agent completed successfully. ,
}
,
Required: False ,
}
enum ,
connectivityStatus:
{
Description: Overall connectivity status for the cluster resource. Indicates whether the cluster is connected to Azure, partially connected, or has not recently communicated. ,
Enum:
{
NotYetRegistered: The cluster has not yet registered with Azure. ,
Connected: The cluster is fully connected to Azure. ,
NotConnectedRecently: The cluster has not connected to Azure recently. ,
PartiallyConnected: Some components of the cluster are connected, while others are not. ,
Disconnected: The cluster is not connected to Azure. ,
NotSpecified: The connectivity status is not specified. ,
}
,
Required: False ,
}
enum ,
supportStatus:
{
Description: Indicates whether the cluster is under support. ,
Enum:
{
InSupport: The cluster is under support. ,
OutOfSupport: The cluster is out of support. ,
NotSpecified: The support status is not specified. ,
}
,
Required: False ,
}
enum ,
cloudId:
{
Description: Unique, immutable resource id. ,
Required: False ,
}
string ,
ring:
{
Description: The ring to which this cluster belongs to. ,
Required: False ,
}
string ,
cloudManagementEndpoint:
{
Description: Endpoint configured for management from the Azure portal. ,
Required: False ,
}
string ,
aadClientId:
{
Description: App id of cluster AAD identity. ,
Required: False ,
}
string ,
aadTenantId:
{
Description: Tenant id of cluster AAD identity. ,
Required: False ,
}
string ,
aadApplicationObjectId:
{
Description: Object id of cluster AAD identity. ,
Required: False ,
}
string ,
aadServicePrincipalObjectId:
{
Description: Id of cluster identity service principal. ,
Required: False ,
}
string ,
softwareAssuranceProperties:
{
Description: Software Assurance properties of the cluster. ,
Required: False ,
}
{
softwareAssuranceStatus:
{
Description: Status of the Software Assurance for the cluster. ,
Enum:
{
Enabled: Software Assurance is enabled for the cluster. ,
Disabled: Software Assurance is disabled for the cluster. ,
}
,
Required: False ,
}
enum ,
softwareAssuranceIntent:
{
Description: Customer Intent for Software Assurance Benefit. ,
Enum:
{
Enable: Customer intends to enable the Software Assurance benefit. ,
Disable: Customer intends to disable the Software Assurance benefit. ,
}
,
Required: False ,
}
enum ,
lastUpdated:
{
Description: TimeStamp denoting the latest SA benefit applicability is validated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
isManagementCluster:
{
Description: Is Management Cluster, when true indicates that the cluster is used for managing other clusters ,
Required: False ,
}
boolean ,
logCollectionProperties:
{
Description: Log Collection properties of the cluster. ,
Required: False ,
}
{
fromDate:
{
Description: From DateTimeStamp from when logs need to be connected ,
Format: date-time ,
Required: False ,
}
string ,
toDate:
{
Description: To DateTimeStamp till when logs need to be connected ,
Format: date-time ,
Required: False ,
}
string ,
lastLogGenerated:
{
Description: Recent DateTimeStamp where logs are successfully generated ,
Format: date-time ,
Required: False ,
}
string ,
logCollectionSessionDetails:
{
Required: False ,
}
[
{
logStartTime:
{
Description: Start Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
logEndTime:
{
Description: End Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
timeCollected:
{
Description: Duration of logs collected ,
Format: date-time ,
Required: False ,
}
string ,
logSize:
{
Description: Size of the logs collected ,
Format: int64 ,
Required: False ,
}
integer ,
logCollectionStatus:
{
Description: LogCollection status ,
Enum:
{
None: No log collection has been initiated. ,
InProgress: Log collection is currently in progress. ,
Failed: Log collection has failed. ,
Succeeded: Log collection completed successfully. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: CorrelationId of the log collection ,
Required: False ,
}
string ,
logCollectionJobType:
{
Description: Specifies the type of log collection job. Determines whether the logs are collected immediately on demand or as part of a scheduled operation. ,
Enum:
{
OnDemand: Log collection is triggered manually and executed immediately. ,
Scheduled: Log collection is scheduled to run at a predefined time or interval. ,
}
,
Required: False ,
}
enum ,
endTimeCollected:
{
Description: End Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
logCollectionError:
{
Description: Log Collection Error details of the cluster. ,
Required: False ,
}
{
errorCode:
{
Description: Error Code of the log collection ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error Message of the log collection ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
remoteSupportProperties:
{
Description: RemoteSupport properties of the cluster. ,
Required: False ,
}
{
accessLevel:
{
Description: Remote Support Access Level ,
Enum:
{
Diagnostics: Allows remote diagnostics operations only. ,
DiagnosticsAndRepair: Allows both remote diagnostics and repair operations. ,
}
,
Required: False ,
}
enum ,
expirationTimeStamp:
{
Description: Expiration DateTimeStamp when Remote Support Access will be expired ,
Format: date-time ,
Required: False ,
}
string ,
remoteSupportType:
{
Description: Remote Support Type for cluster ,
Enum:
{
Enable: Enable remote support for the cluster. ,
Revoke: Revoke previously enabled remote support for the cluster. ,
}
,
Required: False ,
}
enum ,
remoteSupportNodeSettings:
{
Required: False ,
}
[
{
arcResourceId:
{
Description: Arc ResourceId of the Node ,
Required: False ,
}
string ,
state:
{
Description: Remote Support Access Connection State on the Node ,
Required: False ,
}
string ,
createdAt:
{
Description: Remote Support Enablement Request Created TimeStamp on the Node ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: Remote Support Enablement Request Updated TimeStamp on the Node ,
Format: date-time ,
Required: False ,
}
string ,
connectionStatus:
{
Description: Remote Support Access Connection Status on the Node ,
Required: False ,
}
string ,
connectionErrorMessage:
{
Description: Remote Support Access Connection Error Message on the Node ,
Required: False ,
}
string ,
transcriptLocation:
{
Description: Remote Support Transcript location on the node ,
Required: False ,
}
string ,
}
,
]
,
remoteSupportSessionDetails:
{
Required: False ,
}
[
{
sessionStartTime:
{
Description: Remote Support Session StartTime on the Node ,
Format: date-time ,
Required: False ,
}
string ,
sessionEndTime:
{
Description: Remote Support Session EndTime on the Node ,
Format: date-time ,
Required: False ,
}
string ,
nodeName:
{
Description: Name of the node ,
Required: False ,
}
string ,
duration:
{
Description: Duration of Remote Support Enablement ,
Format: int64 ,
Required: False ,
}
integer ,
accessLevel:
{
Description: Remote Support Access Level ,
Enum:
{
Diagnostics: Allows remote diagnostics operations only. ,
DiagnosticsAndRepair: Allows both remote diagnostics and repair operations. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
desiredProperties:
{
Description: Desired properties of the cluster. ,
Required: False ,
}
{
windowsServerSubscription:
{
Description: Desired state of Windows Server Subscription. ,
Enum:
{
Disabled: Windows Server Subscription is disabled. ,
Enabled: Windows Server Subscription is enabled. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Desired level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No diagnostic data will be emitted. ,
Basic: Basic diagnostic data will be emitted, including essential health metrics. ,
Enhanced: Enhanced diagnostic data will be emitted, including detailed performance and usage metrics. ,
}
,
Required: False ,
}
enum ,
}
,
reportedProperties:
{
Description: Properties reported by cluster agent. ,
Required: False ,
}
{
clusterName:
{
Description: Name of the on-prem cluster connected to this resource. ,
Required: False ,
}
string ,
clusterId:
{
Description: Unique id generated by the on-prem cluster. ,
Required: False ,
}
string ,
clusterVersion:
{
Description: Version of the cluster software. ,
Required: False ,
}
string ,
nodes:
{
Description: List of nodes reported by the cluster. ,
Required: False ,
}
[
{
name:
{
Description: Name of the cluster node. ,
Required: False ,
}
string ,
id:
{
Description: Id of the node in the cluster. ,
Format: float ,
Required: False ,
}
number ,
windowsServerSubscription:
{
Description: State of Windows Server Subscription. ,
Enum:
{
Disabled: Windows Server Subscription is disabled. ,
Enabled: Windows Server Subscription is enabled. ,
}
,
Required: False ,
}
enum ,
nodeType:
{
Description: Type of the cluster node hardware. ,
Enum:
{
FirstParty: All nodes in the cluster are provided and managed by Microsoft. ,
ThirdParty: All nodes in the cluster are provided and managed by a third-party vendor. ,
}
,
Required: False ,
}
enum ,
ehcResourceId:
{
Description: Edge Hardware Center Resource Id ,
Required: False ,
}
string ,
manufacturer:
{
Description: Manufacturer of the cluster node hardware. ,
Required: False ,
}
string ,
model:
{
Description: Model name of the cluster node hardware. ,
Required: False ,
}
string ,
osName:
{
Description: Operating system running on the cluster node. ,
Required: False ,
}
string ,
osVersion:
{
Description: Version of the operating system running on the cluster node. ,
Required: False ,
}
string ,
osDisplayVersion:
{
Description: Display version of the operating system running on the cluster node. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Immutable id of the cluster node. ,
Required: False ,
}
string ,
coreCount:
{
Description: Number of physical cores on the cluster node. ,
Format: float ,
Required: False ,
}
number ,
memoryInGiB:
{
Description: Total available memory on the cluster node (in GiB). ,
Format: float ,
Required: False ,
}
number ,
lastLicensingTimestamp:
{
Description: Most recent licensing timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
oemActivation:
{
Description: OEM activation status of the node. ,
Enum:
{
Disabled: OEM activation is disabled for the cluster. ,
Enabled: OEM activation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
lastUpdated:
{
Description: Last time the cluster reported the data. ,
Format: date-time ,
Required: False ,
}
string ,
msiExpirationTimeStamp:
{
Description: Specifies the expiration timestamp of the cluster's Managed Service Identity (MSI). The value is expressed in Coordinated Universal Time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
imdsAttestation:
{
Description: IMDS attestation status of the cluster. ,
Enum:
{
Disabled: IMDS attestation is disabled for the cluster. ,
Enabled: IMDS attestation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No diagnostic data will be emitted. ,
Basic: Basic diagnostic data will be emitted, including essential health metrics. ,
Enhanced: Enhanced diagnostic data will be emitted, including detailed performance and usage metrics. ,
}
,
Required: False ,
}
enum ,
supportedCapabilities:
{
Description: Capabilities supported by the cluster. ,
Required: False ,
}
[
string ,
]
,
clusterType:
{
Description: Specifies the type of hardware vendor for all nodes in the cluster. Indicates whether the nodes are provided by Microsoft or a third-party vendor. ,
Enum:
{
FirstParty: All nodes in the cluster are provided and managed by Microsoft. ,
ThirdParty: All nodes in the cluster are provided and managed by a third-party vendor. ,
}
,
Required: False ,
}
enum ,
manufacturer:
{
Description: The manufacturer of all the nodes of the cluster. ,
Required: False ,
}
string ,
oemActivation:
{
Description: OEM activation status of the cluster. ,
Enum:
{
Disabled: OEM activation is disabled for the cluster. ,
Enabled: OEM activation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
hardwareClass:
{
Description: Hardware class of the cluster. ,
Enum:
{
Small: The hardware class is small. ,
Medium: The hardware class is medium. This corresponds to the default ,
Large: The hardware class is large. ,
}
,
Required: False ,
}
enum ,
}
,
isolatedVmAttestationConfiguration:
{
Description: Attestation configurations for isolated VM (e.g. TVM, CVM) of the cluster. ,
Required: False ,
}
{
attestationResourceId:
{
Description: Fully qualified Azure resource id of the Microsoft Azure attestation resource associated with this cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
relyingPartyServiceEndpoint:
{
Description: Region specific endpoint for relying party service. ,
Required: False ,
}
string ,
attestationServiceEndpoint:
{
Description: Region specific endpoint for Microsoft Azure Attestation service for the cluster ,
Required: False ,
}
string ,
}
,
trialDaysRemaining:
{
Description: Number of days remaining in the trial period. ,
Format: float ,
Required: False ,
}
number ,
billingModel:
{
Description: Type of billing applied to the resource. ,
Required: False ,
}
string ,
registrationTimestamp:
{
Description: First cluster sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncTimestamp:
{
Description: Most recent cluster sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastBillingTimestamp:
{
Description: Most recent billing meter timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
serviceEndpoint:
{
Description: Region specific DataPath Endpoint of the cluster. ,
Required: False ,
}
string ,
resourceProviderObjectId:
{
Description: Object id of RP Service Principal ,
Required: False ,
}
string ,
secretsLocations:
{
Description: List of secret locations. ,
Required: False ,
}
[
{
secretsType:
{
Description: Type of secrets to store ,
Enum:
{
BackupSecrets: Backup secrets type ,
}
,
Required: True ,
}
enum ,
secretsLocation:
{
Description: secrets location ,
Required: True ,
}
string ,
}
,
]
,
clusterPattern:
{
Description: Supported Storage Type for HCI Cluster ,
Enum:
{
Standard: Standard cluster. ,
RackAware: RackAware cluster. ,
}
,
Required: False ,
}
enum ,
confidentialVmProperties:
{
Description: Represents the Confidential Virtual Machine (CVM) support intent and current status for the cluster resource. ,
Required: False ,
}
{
confidentialVmIntent:
{
Description: Captures the customer's intent to enable or disable CVM support on the cluster, either during initial deployment (Day-0) or at a later stage (Day-N). ,
Enum:
{
Enable: Indicates that the customer intends to enable CVM support on the cluster. ,
Disable: Indicates that the customer intends to disable CVM support on the cluster. ,
}
,
Required: False ,
}
enum ,
confidentialVmStatus:
{
Description: Captures the current status of CVM support on the cluster. ,
Enum:
{
Enabled: CVM support is fully enabled on the cluster. All nodes are CVM capable. ,
PartiallyEnabled: CVM support is partially enabled. At least one node in the cluster is CVM capable. ,
Disabled: CVM support is disabled. None of the nodes in the cluster are CVM capable. ,
}
,
Required: False ,
}
enum ,
confidentialVmStatusSummary:
{
Description: Additional context about CVM support on the cluster, such as reasons for partial enablement or hardware constraints. ,
Required: False ,
}
string ,
}
,
sdnProperties:
{
Description: Software Defined Networking Properties of the cluster ,
Required: False ,
}
{
sdnIntegrationIntent:
{
Description: Indicates whether Software Defined Networking (SDN) integration should be enabled or disabled for this deployment. ,
Enum:
{
Enable: Enable SDN integration for the deployment. ,
Disable: Disable SDN integration for the deployment. ,
}
,
Required: False ,
}
enum ,
}
,
localAvailabilityZones:
{
Description: Local Availability Zone information for HCI cluster ,
Required: False ,
}
[
{
localAvailabilityZoneName:
{
Description: Local Availability Zone name for HCI cluster ,
Required: False ,
}
string ,
nodes:
{
Description: Nodes belonging to a particular zone ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
identityProvider:
{
Description: Identity Provider for the cluster ,
Enum:
{
ActiveDirectory: Uses Active Directory as the identity provider, enabling domain-based authentication and centralized identity management. This is the default option. ,
LocalIdentity: Uses a local identity system integrated with Azure Key Vault for authentication. Suitable for AD-less environments where Active Directory is not available or required. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
kind:
{
Description: This property identifies the purpose of the Cluster deployment. For example, a valid value is AzureLocal ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_Create (new)
Description :  Create an HCI cluster.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
cluster:
{
Description: Details of the HCI cluster. ,
Required: True ,
}
{
properties:
{
Description: Cluster properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state. Indicates the current lifecycle status of the resource, including creation, update, deletion, connectivity, and error states. ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Status of the cluster agent. Indicates the current connectivity, validation, and deployment state of the agent within the cluster. ,
Enum:
{
NotYetRegistered: The cluster agent has not yet registered with Azure. ,
ConnectedRecently: The cluster agent has connected to Azure recently. ,
NotConnectedRecently: The cluster agent has not connected to Azure recently. ,
Disconnected: The cluster agent is currently disconnected from Azure. ,
Error: An error occurred in the cluster agent's operation. ,
NotSpecified: The status of the cluster agent is not specified. ,
ValidationInProgress: Validation of the cluster agent is currently in progress. ,
ValidationSuccess: Validation of the cluster agent completed successfully. ,
ValidationFailed: Validation of the cluster agent failed. ,
DeploymentInProgress: Deployment of the cluster agent is currently in progress. ,
DeploymentFailed: Deployment of the cluster agent failed. ,
DeploymentSuccess: Deployment of the cluster agent completed successfully. ,
}
,
Required: False ,
}
enum ,
connectivityStatus:
{
Description: Overall connectivity status for the cluster resource. Indicates whether the cluster is connected to Azure, partially connected, or has not recently communicated. ,
Enum:
{
NotYetRegistered: The cluster has not yet registered with Azure. ,
Connected: The cluster is fully connected to Azure. ,
NotConnectedRecently: The cluster has not connected to Azure recently. ,
PartiallyConnected: Some components of the cluster are connected, while others are not. ,
Disconnected: The cluster is not connected to Azure. ,
NotSpecified: The connectivity status is not specified. ,
}
,
Required: False ,
}
enum ,
supportStatus:
{
Description: Indicates whether the cluster is under support. ,
Enum:
{
InSupport: The cluster is under support. ,
OutOfSupport: The cluster is out of support. ,
NotSpecified: The support status is not specified. ,
}
,
Required: False ,
}
enum ,
cloudId:
{
Description: Unique, immutable resource id. ,
Required: False ,
}
string ,
ring:
{
Description: The ring to which this cluster belongs to. ,
Required: False ,
}
string ,
cloudManagementEndpoint:
{
Description: Endpoint configured for management from the Azure portal. ,
Required: False ,
}
string ,
aadClientId:
{
Description: App id of cluster AAD identity. ,
Required: False ,
}
string ,
aadTenantId:
{
Description: Tenant id of cluster AAD identity. ,
Required: False ,
}
string ,
aadApplicationObjectId:
{
Description: Object id of cluster AAD identity. ,
Required: False ,
}
string ,
aadServicePrincipalObjectId:
{
Description: Id of cluster identity service principal. ,
Required: False ,
}
string ,
softwareAssuranceProperties:
{
Description: Software Assurance properties of the cluster. ,
Required: False ,
}
{
softwareAssuranceStatus:
{
Description: Status of the Software Assurance for the cluster. ,
Enum:
{
Enabled: Software Assurance is enabled for the cluster. ,
Disabled: Software Assurance is disabled for the cluster. ,
}
,
Required: False ,
}
enum ,
softwareAssuranceIntent:
{
Description: Customer Intent for Software Assurance Benefit. ,
Enum:
{
Enable: Customer intends to enable the Software Assurance benefit. ,
Disable: Customer intends to disable the Software Assurance benefit. ,
}
,
Required: False ,
}
enum ,
lastUpdated:
{
Description: TimeStamp denoting the latest SA benefit applicability is validated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
isManagementCluster:
{
Description: Is Management Cluster, when true indicates that the cluster is used for managing other clusters ,
Required: False ,
}
boolean ,
logCollectionProperties:
{
Description: Log Collection properties of the cluster. ,
Required: False ,
}
{
fromDate:
{
Description: From DateTimeStamp from when logs need to be connected ,
Format: date-time ,
Required: False ,
}
string ,
toDate:
{
Description: To DateTimeStamp till when logs need to be connected ,
Format: date-time ,
Required: False ,
}
string ,
lastLogGenerated:
{
Description: Recent DateTimeStamp where logs are successfully generated ,
Format: date-time ,
Required: False ,
}
string ,
logCollectionSessionDetails:
{
Required: False ,
}
[
{
logStartTime:
{
Description: Start Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
logEndTime:
{
Description: End Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
timeCollected:
{
Description: Duration of logs collected ,
Format: date-time ,
Required: False ,
}
string ,
logSize:
{
Description: Size of the logs collected ,
Format: int64 ,
Required: False ,
}
integer ,
logCollectionStatus:
{
Description: LogCollection status ,
Enum:
{
None: No log collection has been initiated. ,
InProgress: Log collection is currently in progress. ,
Failed: Log collection has failed. ,
Succeeded: Log collection completed successfully. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: CorrelationId of the log collection ,
Required: False ,
}
string ,
logCollectionJobType:
{
Description: Specifies the type of log collection job. Determines whether the logs are collected immediately on demand or as part of a scheduled operation. ,
Enum:
{
OnDemand: Log collection is triggered manually and executed immediately. ,
Scheduled: Log collection is scheduled to run at a predefined time or interval. ,
}
,
Required: False ,
}
enum ,
endTimeCollected:
{
Description: End Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
logCollectionError:
{
Description: Log Collection Error details of the cluster. ,
Required: False ,
}
{
errorCode:
{
Description: Error Code of the log collection ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error Message of the log collection ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
remoteSupportProperties:
{
Description: RemoteSupport properties of the cluster. ,
Required: False ,
}
{
accessLevel:
{
Description: Remote Support Access Level ,
Enum:
{
Diagnostics: Allows remote diagnostics operations only. ,
DiagnosticsAndRepair: Allows both remote diagnostics and repair operations. ,
}
,
Required: False ,
}
enum ,
expirationTimeStamp:
{
Description: Expiration DateTimeStamp when Remote Support Access will be expired ,
Format: date-time ,
Required: False ,
}
string ,
remoteSupportType:
{
Description: Remote Support Type for cluster ,
Enum:
{
Enable: Enable remote support for the cluster. ,
Revoke: Revoke previously enabled remote support for the cluster. ,
}
,
Required: False ,
}
enum ,
remoteSupportNodeSettings:
{
Required: False ,
}
[
{
arcResourceId:
{
Description: Arc ResourceId of the Node ,
Required: False ,
}
string ,
state:
{
Description: Remote Support Access Connection State on the Node ,
Required: False ,
}
string ,
createdAt:
{
Description: Remote Support Enablement Request Created TimeStamp on the Node ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: Remote Support Enablement Request Updated TimeStamp on the Node ,
Format: date-time ,
Required: False ,
}
string ,
connectionStatus:
{
Description: Remote Support Access Connection Status on the Node ,
Required: False ,
}
string ,
connectionErrorMessage:
{
Description: Remote Support Access Connection Error Message on the Node ,
Required: False ,
}
string ,
transcriptLocation:
{
Description: Remote Support Transcript location on the node ,
Required: False ,
}
string ,
}
,
]
,
remoteSupportSessionDetails:
{
Required: False ,
}
[
{
sessionStartTime:
{
Description: Remote Support Session StartTime on the Node ,
Format: date-time ,
Required: False ,
}
string ,
sessionEndTime:
{
Description: Remote Support Session EndTime on the Node ,
Format: date-time ,
Required: False ,
}
string ,
nodeName:
{
Description: Name of the node ,
Required: False ,
}
string ,
duration:
{
Description: Duration of Remote Support Enablement ,
Format: int64 ,
Required: False ,
}
integer ,
accessLevel:
{
Description: Remote Support Access Level ,
Enum:
{
Diagnostics: Allows remote diagnostics operations only. ,
DiagnosticsAndRepair: Allows both remote diagnostics and repair operations. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
desiredProperties:
{
Description: Desired properties of the cluster. ,
Required: False ,
}
{
windowsServerSubscription:
{
Description: Desired state of Windows Server Subscription. ,
Enum:
{
Disabled: Windows Server Subscription is disabled. ,
Enabled: Windows Server Subscription is enabled. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Desired level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No diagnostic data will be emitted. ,
Basic: Basic diagnostic data will be emitted, including essential health metrics. ,
Enhanced: Enhanced diagnostic data will be emitted, including detailed performance and usage metrics. ,
}
,
Required: False ,
}
enum ,
}
,
reportedProperties:
{
Description: Properties reported by cluster agent. ,
Required: False ,
}
{
clusterName:
{
Description: Name of the on-prem cluster connected to this resource. ,
Required: False ,
}
string ,
clusterId:
{
Description: Unique id generated by the on-prem cluster. ,
Required: False ,
}
string ,
clusterVersion:
{
Description: Version of the cluster software. ,
Required: False ,
}
string ,
nodes:
{
Description: List of nodes reported by the cluster. ,
Required: False ,
}
[
{
name:
{
Description: Name of the cluster node. ,
Required: False ,
}
string ,
id:
{
Description: Id of the node in the cluster. ,
Format: float ,
Required: False ,
}
number ,
windowsServerSubscription:
{
Description: State of Windows Server Subscription. ,
Enum:
{
Disabled: Windows Server Subscription is disabled. ,
Enabled: Windows Server Subscription is enabled. ,
}
,
Required: False ,
}
enum ,
nodeType:
{
Description: Type of the cluster node hardware. ,
Enum:
{
FirstParty: All nodes in the cluster are provided and managed by Microsoft. ,
ThirdParty: All nodes in the cluster are provided and managed by a third-party vendor. ,
}
,
Required: False ,
}
enum ,
ehcResourceId:
{
Description: Edge Hardware Center Resource Id ,
Required: False ,
}
string ,
manufacturer:
{
Description: Manufacturer of the cluster node hardware. ,
Required: False ,
}
string ,
model:
{
Description: Model name of the cluster node hardware. ,
Required: False ,
}
string ,
osName:
{
Description: Operating system running on the cluster node. ,
Required: False ,
}
string ,
osVersion:
{
Description: Version of the operating system running on the cluster node. ,
Required: False ,
}
string ,
osDisplayVersion:
{
Description: Display version of the operating system running on the cluster node. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Immutable id of the cluster node. ,
Required: False ,
}
string ,
coreCount:
{
Description: Number of physical cores on the cluster node. ,
Format: float ,
Required: False ,
}
number ,
memoryInGiB:
{
Description: Total available memory on the cluster node (in GiB). ,
Format: float ,
Required: False ,
}
number ,
lastLicensingTimestamp:
{
Description: Most recent licensing timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
oemActivation:
{
Description: OEM activation status of the node. ,
Enum:
{
Disabled: OEM activation is disabled for the cluster. ,
Enabled: OEM activation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
lastUpdated:
{
Description: Last time the cluster reported the data. ,
Format: date-time ,
Required: False ,
}
string ,
msiExpirationTimeStamp:
{
Description: Specifies the expiration timestamp of the cluster's Managed Service Identity (MSI). The value is expressed in Coordinated Universal Time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
imdsAttestation:
{
Description: IMDS attestation status of the cluster. ,
Enum:
{
Disabled: IMDS attestation is disabled for the cluster. ,
Enabled: IMDS attestation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No diagnostic data will be emitted. ,
Basic: Basic diagnostic data will be emitted, including essential health metrics. ,
Enhanced: Enhanced diagnostic data will be emitted, including detailed performance and usage metrics. ,
}
,
Required: False ,
}
enum ,
supportedCapabilities:
{
Description: Capabilities supported by the cluster. ,
Required: False ,
}
[
string ,
]
,
clusterType:
{
Description: Specifies the type of hardware vendor for all nodes in the cluster. Indicates whether the nodes are provided by Microsoft or a third-party vendor. ,
Enum:
{
FirstParty: All nodes in the cluster are provided and managed by Microsoft. ,
ThirdParty: All nodes in the cluster are provided and managed by a third-party vendor. ,
}
,
Required: False ,
}
enum ,
manufacturer:
{
Description: The manufacturer of all the nodes of the cluster. ,
Required: False ,
}
string ,
oemActivation:
{
Description: OEM activation status of the cluster. ,
Enum:
{
Disabled: OEM activation is disabled for the cluster. ,
Enabled: OEM activation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
hardwareClass:
{
Description: Hardware class of the cluster. ,
Enum:
{
Small: The hardware class is small. ,
Medium: The hardware class is medium. This corresponds to the default ,
Large: The hardware class is large. ,
}
,
Required: False ,
}
enum ,
}
,
isolatedVmAttestationConfiguration:
{
Description: Attestation configurations for isolated VM (e.g. TVM, CVM) of the cluster. ,
Required: False ,
}
{
attestationResourceId:
{
Description: Fully qualified Azure resource id of the Microsoft Azure attestation resource associated with this cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
relyingPartyServiceEndpoint:
{
Description: Region specific endpoint for relying party service. ,
Required: False ,
}
string ,
attestationServiceEndpoint:
{
Description: Region specific endpoint for Microsoft Azure Attestation service for the cluster ,
Required: False ,
}
string ,
}
,
trialDaysRemaining:
{
Description: Number of days remaining in the trial period. ,
Format: float ,
Required: False ,
}
number ,
billingModel:
{
Description: Type of billing applied to the resource. ,
Required: False ,
}
string ,
registrationTimestamp:
{
Description: First cluster sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncTimestamp:
{
Description: Most recent cluster sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastBillingTimestamp:
{
Description: Most recent billing meter timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
serviceEndpoint:
{
Description: Region specific DataPath Endpoint of the cluster. ,
Required: False ,
}
string ,
resourceProviderObjectId:
{
Description: Object id of RP Service Principal ,
Required: False ,
}
string ,
secretsLocations:
{
Description: List of secret locations. ,
Required: False ,
}
[
{
secretsType:
{
Description: Type of secrets to store ,
Enum:
{
BackupSecrets: Backup secrets type ,
}
,
Required: True ,
}
enum ,
secretsLocation:
{
Description: secrets location ,
Required: True ,
}
string ,
}
,
]
,
clusterPattern:
{
Description: Supported Storage Type for HCI Cluster ,
Enum:
{
Standard: Standard cluster. ,
RackAware: RackAware cluster. ,
}
,
Required: False ,
}
enum ,
confidentialVmProperties:
{
Description: Represents the Confidential Virtual Machine (CVM) support intent and current status for the cluster resource. ,
Required: False ,
}
{
confidentialVmIntent:
{
Description: Captures the customer's intent to enable or disable CVM support on the cluster, either during initial deployment (Day-0) or at a later stage (Day-N). ,
Enum:
{
Enable: Indicates that the customer intends to enable CVM support on the cluster. ,
Disable: Indicates that the customer intends to disable CVM support on the cluster. ,
}
,
Required: False ,
}
enum ,
confidentialVmStatus:
{
Description: Captures the current status of CVM support on the cluster. ,
Enum:
{
Enabled: CVM support is fully enabled on the cluster. All nodes are CVM capable. ,
PartiallyEnabled: CVM support is partially enabled. At least one node in the cluster is CVM capable. ,
Disabled: CVM support is disabled. None of the nodes in the cluster are CVM capable. ,
}
,
Required: False ,
}
enum ,
confidentialVmStatusSummary:
{
Description: Additional context about CVM support on the cluster, such as reasons for partial enablement or hardware constraints. ,
Required: False ,
}
string ,
}
,
sdnProperties:
{
Description: Software Defined Networking Properties of the cluster ,
Required: False ,
}
{
sdnIntegrationIntent:
{
Description: Indicates whether Software Defined Networking (SDN) integration should be enabled or disabled for this deployment. ,
Enum:
{
Enable: Enable SDN integration for the deployment. ,
Disable: Disable SDN integration for the deployment. ,
}
,
Required: False ,
}
enum ,
}
,
localAvailabilityZones:
{
Description: Local Availability Zone information for HCI cluster ,
Required: False ,
}
[
{
localAvailabilityZoneName:
{
Description: Local Availability Zone name for HCI cluster ,
Required: False ,
}
string ,
nodes:
{
Description: Nodes belonging to a particular zone ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
identityProvider:
{
Description: Identity Provider for the cluster ,
Enum:
{
ActiveDirectory: Uses Active Directory as the identity provider, enabling domain-based authentication and centralized identity management. This is the default option. ,
LocalIdentity: Uses a local identity system integrated with Azure Key Vault for authentication. Suitable for AD-less environments where Active Directory is not available or required. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
kind:
{
Description: This property identifies the purpose of the Cluster deployment. For example, a valid value is AzureLocal ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Cluster properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state. Indicates the current lifecycle status of the resource, including creation, update, deletion, connectivity, and error states. ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Status of the cluster agent. Indicates the current connectivity, validation, and deployment state of the agent within the cluster. ,
Enum:
{
NotYetRegistered: The cluster agent has not yet registered with Azure. ,
ConnectedRecently: The cluster agent has connected to Azure recently. ,
NotConnectedRecently: The cluster agent has not connected to Azure recently. ,
Disconnected: The cluster agent is currently disconnected from Azure. ,
Error: An error occurred in the cluster agent's operation. ,
NotSpecified: The status of the cluster agent is not specified. ,
ValidationInProgress: Validation of the cluster agent is currently in progress. ,
ValidationSuccess: Validation of the cluster agent completed successfully. ,
ValidationFailed: Validation of the cluster agent failed. ,
DeploymentInProgress: Deployment of the cluster agent is currently in progress. ,
DeploymentFailed: Deployment of the cluster agent failed. ,
DeploymentSuccess: Deployment of the cluster agent completed successfully. ,
}
,
Required: False ,
}
enum ,
connectivityStatus:
{
Description: Overall connectivity status for the cluster resource. Indicates whether the cluster is connected to Azure, partially connected, or has not recently communicated. ,
Enum:
{
NotYetRegistered: The cluster has not yet registered with Azure. ,
Connected: The cluster is fully connected to Azure. ,
NotConnectedRecently: The cluster has not connected to Azure recently. ,
PartiallyConnected: Some components of the cluster are connected, while others are not. ,
Disconnected: The cluster is not connected to Azure. ,
NotSpecified: The connectivity status is not specified. ,
}
,
Required: False ,
}
enum ,
supportStatus:
{
Description: Indicates whether the cluster is under support. ,
Enum:
{
InSupport: The cluster is under support. ,
OutOfSupport: The cluster is out of support. ,
NotSpecified: The support status is not specified. ,
}
,
Required: False ,
}
enum ,
cloudId:
{
Description: Unique, immutable resource id. ,
Required: False ,
}
string ,
ring:
{
Description: The ring to which this cluster belongs to. ,
Required: False ,
}
string ,
cloudManagementEndpoint:
{
Description: Endpoint configured for management from the Azure portal. ,
Required: False ,
}
string ,
aadClientId:
{
Description: App id of cluster AAD identity. ,
Required: False ,
}
string ,
aadTenantId:
{
Description: Tenant id of cluster AAD identity. ,
Required: False ,
}
string ,
aadApplicationObjectId:
{
Description: Object id of cluster AAD identity. ,
Required: False ,
}
string ,
aadServicePrincipalObjectId:
{
Description: Id of cluster identity service principal. ,
Required: False ,
}
string ,
softwareAssuranceProperties:
{
Description: Software Assurance properties of the cluster. ,
Required: False ,
}
{
softwareAssuranceStatus:
{
Description: Status of the Software Assurance for the cluster. ,
Enum:
{
Enabled: Software Assurance is enabled for the cluster. ,
Disabled: Software Assurance is disabled for the cluster. ,
}
,
Required: False ,
}
enum ,
softwareAssuranceIntent:
{
Description: Customer Intent for Software Assurance Benefit. ,
Enum:
{
Enable: Customer intends to enable the Software Assurance benefit. ,
Disable: Customer intends to disable the Software Assurance benefit. ,
}
,
Required: False ,
}
enum ,
lastUpdated:
{
Description: TimeStamp denoting the latest SA benefit applicability is validated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
isManagementCluster:
{
Description: Is Management Cluster, when true indicates that the cluster is used for managing other clusters ,
Required: False ,
}
boolean ,
logCollectionProperties:
{
Description: Log Collection properties of the cluster. ,
Required: False ,
}
{
fromDate:
{
Description: From DateTimeStamp from when logs need to be connected ,
Format: date-time ,
Required: False ,
}
string ,
toDate:
{
Description: To DateTimeStamp till when logs need to be connected ,
Format: date-time ,
Required: False ,
}
string ,
lastLogGenerated:
{
Description: Recent DateTimeStamp where logs are successfully generated ,
Format: date-time ,
Required: False ,
}
string ,
logCollectionSessionDetails:
{
Required: False ,
}
[
{
logStartTime:
{
Description: Start Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
logEndTime:
{
Description: End Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
timeCollected:
{
Description: Duration of logs collected ,
Format: date-time ,
Required: False ,
}
string ,
logSize:
{
Description: Size of the logs collected ,
Format: int64 ,
Required: False ,
}
integer ,
logCollectionStatus:
{
Description: LogCollection status ,
Enum:
{
None: No log collection has been initiated. ,
InProgress: Log collection is currently in progress. ,
Failed: Log collection has failed. ,
Succeeded: Log collection completed successfully. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: CorrelationId of the log collection ,
Required: False ,
}
string ,
logCollectionJobType:
{
Description: Specifies the type of log collection job. Determines whether the logs are collected immediately on demand or as part of a scheduled operation. ,
Enum:
{
OnDemand: Log collection is triggered manually and executed immediately. ,
Scheduled: Log collection is scheduled to run at a predefined time or interval. ,
}
,
Required: False ,
}
enum ,
endTimeCollected:
{
Description: End Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
logCollectionError:
{
Description: Log Collection Error details of the cluster. ,
Required: False ,
}
{
errorCode:
{
Description: Error Code of the log collection ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error Message of the log collection ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
remoteSupportProperties:
{
Description: RemoteSupport properties of the cluster. ,
Required: False ,
}
{
accessLevel:
{
Description: Remote Support Access Level ,
Enum:
{
Diagnostics: Allows remote diagnostics operations only. ,
DiagnosticsAndRepair: Allows both remote diagnostics and repair operations. ,
}
,
Required: False ,
}
enum ,
expirationTimeStamp:
{
Description: Expiration DateTimeStamp when Remote Support Access will be expired ,
Format: date-time ,
Required: False ,
}
string ,
remoteSupportType:
{
Description: Remote Support Type for cluster ,
Enum:
{
Enable: Enable remote support for the cluster. ,
Revoke: Revoke previously enabled remote support for the cluster. ,
}
,
Required: False ,
}
enum ,
remoteSupportNodeSettings:
{
Required: False ,
}
[
{
arcResourceId:
{
Description: Arc ResourceId of the Node ,
Required: False ,
}
string ,
state:
{
Description: Remote Support Access Connection State on the Node ,
Required: False ,
}
string ,
createdAt:
{
Description: Remote Support Enablement Request Created TimeStamp on the Node ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: Remote Support Enablement Request Updated TimeStamp on the Node ,
Format: date-time ,
Required: False ,
}
string ,
connectionStatus:
{
Description: Remote Support Access Connection Status on the Node ,
Required: False ,
}
string ,
connectionErrorMessage:
{
Description: Remote Support Access Connection Error Message on the Node ,
Required: False ,
}
string ,
transcriptLocation:
{
Description: Remote Support Transcript location on the node ,
Required: False ,
}
string ,
}
,
]
,
remoteSupportSessionDetails:
{
Required: False ,
}
[
{
sessionStartTime:
{
Description: Remote Support Session StartTime on the Node ,
Format: date-time ,
Required: False ,
}
string ,
sessionEndTime:
{
Description: Remote Support Session EndTime on the Node ,
Format: date-time ,
Required: False ,
}
string ,
nodeName:
{
Description: Name of the node ,
Required: False ,
}
string ,
duration:
{
Description: Duration of Remote Support Enablement ,
Format: int64 ,
Required: False ,
}
integer ,
accessLevel:
{
Description: Remote Support Access Level ,
Enum:
{
Diagnostics: Allows remote diagnostics operations only. ,
DiagnosticsAndRepair: Allows both remote diagnostics and repair operations. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
desiredProperties:
{
Description: Desired properties of the cluster. ,
Required: False ,
}
{
windowsServerSubscription:
{
Description: Desired state of Windows Server Subscription. ,
Enum:
{
Disabled: Windows Server Subscription is disabled. ,
Enabled: Windows Server Subscription is enabled. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Desired level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No diagnostic data will be emitted. ,
Basic: Basic diagnostic data will be emitted, including essential health metrics. ,
Enhanced: Enhanced diagnostic data will be emitted, including detailed performance and usage metrics. ,
}
,
Required: False ,
}
enum ,
}
,
reportedProperties:
{
Description: Properties reported by cluster agent. ,
Required: False ,
}
{
clusterName:
{
Description: Name of the on-prem cluster connected to this resource. ,
Required: False ,
}
string ,
clusterId:
{
Description: Unique id generated by the on-prem cluster. ,
Required: False ,
}
string ,
clusterVersion:
{
Description: Version of the cluster software. ,
Required: False ,
}
string ,
nodes:
{
Description: List of nodes reported by the cluster. ,
Required: False ,
}
[
{
name:
{
Description: Name of the cluster node. ,
Required: False ,
}
string ,
id:
{
Description: Id of the node in the cluster. ,
Format: float ,
Required: False ,
}
number ,
windowsServerSubscription:
{
Description: State of Windows Server Subscription. ,
Enum:
{
Disabled: Windows Server Subscription is disabled. ,
Enabled: Windows Server Subscription is enabled. ,
}
,
Required: False ,
}
enum ,
nodeType:
{
Description: Type of the cluster node hardware. ,
Enum:
{
FirstParty: All nodes in the cluster are provided and managed by Microsoft. ,
ThirdParty: All nodes in the cluster are provided and managed by a third-party vendor. ,
}
,
Required: False ,
}
enum ,
ehcResourceId:
{
Description: Edge Hardware Center Resource Id ,
Required: False ,
}
string ,
manufacturer:
{
Description: Manufacturer of the cluster node hardware. ,
Required: False ,
}
string ,
model:
{
Description: Model name of the cluster node hardware. ,
Required: False ,
}
string ,
osName:
{
Description: Operating system running on the cluster node. ,
Required: False ,
}
string ,
osVersion:
{
Description: Version of the operating system running on the cluster node. ,
Required: False ,
}
string ,
osDisplayVersion:
{
Description: Display version of the operating system running on the cluster node. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Immutable id of the cluster node. ,
Required: False ,
}
string ,
coreCount:
{
Description: Number of physical cores on the cluster node. ,
Format: float ,
Required: False ,
}
number ,
memoryInGiB:
{
Description: Total available memory on the cluster node (in GiB). ,
Format: float ,
Required: False ,
}
number ,
lastLicensingTimestamp:
{
Description: Most recent licensing timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
oemActivation:
{
Description: OEM activation status of the node. ,
Enum:
{
Disabled: OEM activation is disabled for the cluster. ,
Enabled: OEM activation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
lastUpdated:
{
Description: Last time the cluster reported the data. ,
Format: date-time ,
Required: False ,
}
string ,
msiExpirationTimeStamp:
{
Description: Specifies the expiration timestamp of the cluster's Managed Service Identity (MSI). The value is expressed in Coordinated Universal Time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
imdsAttestation:
{
Description: IMDS attestation status of the cluster. ,
Enum:
{
Disabled: IMDS attestation is disabled for the cluster. ,
Enabled: IMDS attestation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No diagnostic data will be emitted. ,
Basic: Basic diagnostic data will be emitted, including essential health metrics. ,
Enhanced: Enhanced diagnostic data will be emitted, including detailed performance and usage metrics. ,
}
,
Required: False ,
}
enum ,
supportedCapabilities:
{
Description: Capabilities supported by the cluster. ,
Required: False ,
}
[
string ,
]
,
clusterType:
{
Description: Specifies the type of hardware vendor for all nodes in the cluster. Indicates whether the nodes are provided by Microsoft or a third-party vendor. ,
Enum:
{
FirstParty: All nodes in the cluster are provided and managed by Microsoft. ,
ThirdParty: All nodes in the cluster are provided and managed by a third-party vendor. ,
}
,
Required: False ,
}
enum ,
manufacturer:
{
Description: The manufacturer of all the nodes of the cluster. ,
Required: False ,
}
string ,
oemActivation:
{
Description: OEM activation status of the cluster. ,
Enum:
{
Disabled: OEM activation is disabled for the cluster. ,
Enabled: OEM activation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
hardwareClass:
{
Description: Hardware class of the cluster. ,
Enum:
{
Small: The hardware class is small. ,
Medium: The hardware class is medium. This corresponds to the default ,
Large: The hardware class is large. ,
}
,
Required: False ,
}
enum ,
}
,
isolatedVmAttestationConfiguration:
{
Description: Attestation configurations for isolated VM (e.g. TVM, CVM) of the cluster. ,
Required: False ,
}
{
attestationResourceId:
{
Description: Fully qualified Azure resource id of the Microsoft Azure attestation resource associated with this cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
relyingPartyServiceEndpoint:
{
Description: Region specific endpoint for relying party service. ,
Required: False ,
}
string ,
attestationServiceEndpoint:
{
Description: Region specific endpoint for Microsoft Azure Attestation service for the cluster ,
Required: False ,
}
string ,
}
,
trialDaysRemaining:
{
Description: Number of days remaining in the trial period. ,
Format: float ,
Required: False ,
}
number ,
billingModel:
{
Description: Type of billing applied to the resource. ,
Required: False ,
}
string ,
registrationTimestamp:
{
Description: First cluster sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncTimestamp:
{
Description: Most recent cluster sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastBillingTimestamp:
{
Description: Most recent billing meter timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
serviceEndpoint:
{
Description: Region specific DataPath Endpoint of the cluster. ,
Required: False ,
}
string ,
resourceProviderObjectId:
{
Description: Object id of RP Service Principal ,
Required: False ,
}
string ,
secretsLocations:
{
Description: List of secret locations. ,
Required: False ,
}
[
{
secretsType:
{
Description: Type of secrets to store ,
Enum:
{
BackupSecrets: Backup secrets type ,
}
,
Required: True ,
}
enum ,
secretsLocation:
{
Description: secrets location ,
Required: True ,
}
string ,
}
,
]
,
clusterPattern:
{
Description: Supported Storage Type for HCI Cluster ,
Enum:
{
Standard: Standard cluster. ,
RackAware: RackAware cluster. ,
}
,
Required: False ,
}
enum ,
confidentialVmProperties:
{
Description: Represents the Confidential Virtual Machine (CVM) support intent and current status for the cluster resource. ,
Required: False ,
}
{
confidentialVmIntent:
{
Description: Captures the customer's intent to enable or disable CVM support on the cluster, either during initial deployment (Day-0) or at a later stage (Day-N). ,
Enum:
{
Enable: Indicates that the customer intends to enable CVM support on the cluster. ,
Disable: Indicates that the customer intends to disable CVM support on the cluster. ,
}
,
Required: False ,
}
enum ,
confidentialVmStatus:
{
Description: Captures the current status of CVM support on the cluster. ,
Enum:
{
Enabled: CVM support is fully enabled on the cluster. All nodes are CVM capable. ,
PartiallyEnabled: CVM support is partially enabled. At least one node in the cluster is CVM capable. ,
Disabled: CVM support is disabled. None of the nodes in the cluster are CVM capable. ,
}
,
Required: False ,
}
enum ,
confidentialVmStatusSummary:
{
Description: Additional context about CVM support on the cluster, such as reasons for partial enablement or hardware constraints. ,
Required: False ,
}
string ,
}
,
sdnProperties:
{
Description: Software Defined Networking Properties of the cluster ,
Required: False ,
}
{
sdnIntegrationIntent:
{
Description: Indicates whether Software Defined Networking (SDN) integration should be enabled or disabled for this deployment. ,
Enum:
{
Enable: Enable SDN integration for the deployment. ,
Disable: Disable SDN integration for the deployment. ,
}
,
Required: False ,
}
enum ,
}
,
localAvailabilityZones:
{
Description: Local Availability Zone information for HCI cluster ,
Required: False ,
}
[
{
localAvailabilityZoneName:
{
Description: Local Availability Zone name for HCI cluster ,
Required: False ,
}
string ,
nodes:
{
Description: Nodes belonging to a particular zone ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
identityProvider:
{
Description: Identity Provider for the cluster ,
Enum:
{
ActiveDirectory: Uses Active Directory as the identity provider, enabling domain-based authentication and centralized identity management. This is the default option. ,
LocalIdentity: Uses a local identity system integrated with Azure Key Vault for authentication. Suitable for AD-less environments where Active Directory is not available or required. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
kind:
{
Description: This property identifies the purpose of the Cluster deployment. For example, a valid value is AzureLocal ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_Update (new)
Description :  Update an HCI cluster.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
cluster:
{
Description: Details of the HCI cluster. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
identity:
{
Description: Identity of Cluster resource ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Cluster properties. ,
Required: False ,
}
{
cloudManagementEndpoint:
{
Description: Endpoint configured for management from the Azure portal ,
Required: False ,
}
string ,
aadClientId:
{
Description: App id of cluster AAD identity. ,
Required: False ,
}
string ,
aadTenantId:
{
Description: Tenant id of cluster AAD identity. ,
Required: False ,
}
string ,
desiredProperties:
{
Description: Desired properties of the cluster. ,
Required: False ,
}
{
windowsServerSubscription:
{
Description: Desired state of Windows Server Subscription. ,
Enum:
{
Disabled: Windows Server Subscription is disabled. ,
Enabled: Windows Server Subscription is enabled. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Desired level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No diagnostic data will be emitted. ,
Basic: Basic diagnostic data will be emitted, including essential health metrics. ,
Enhanced: Enhanced diagnostic data will be emitted, including detailed performance and usage metrics. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Cluster properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state. Indicates the current lifecycle status of the resource, including creation, update, deletion, connectivity, and error states. ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Status of the cluster agent. Indicates the current connectivity, validation, and deployment state of the agent within the cluster. ,
Enum:
{
NotYetRegistered: The cluster agent has not yet registered with Azure. ,
ConnectedRecently: The cluster agent has connected to Azure recently. ,
NotConnectedRecently: The cluster agent has not connected to Azure recently. ,
Disconnected: The cluster agent is currently disconnected from Azure. ,
Error: An error occurred in the cluster agent's operation. ,
NotSpecified: The status of the cluster agent is not specified. ,
ValidationInProgress: Validation of the cluster agent is currently in progress. ,
ValidationSuccess: Validation of the cluster agent completed successfully. ,
ValidationFailed: Validation of the cluster agent failed. ,
DeploymentInProgress: Deployment of the cluster agent is currently in progress. ,
DeploymentFailed: Deployment of the cluster agent failed. ,
DeploymentSuccess: Deployment of the cluster agent completed successfully. ,
}
,
Required: False ,
}
enum ,
connectivityStatus:
{
Description: Overall connectivity status for the cluster resource. Indicates whether the cluster is connected to Azure, partially connected, or has not recently communicated. ,
Enum:
{
NotYetRegistered: The cluster has not yet registered with Azure. ,
Connected: The cluster is fully connected to Azure. ,
NotConnectedRecently: The cluster has not connected to Azure recently. ,
PartiallyConnected: Some components of the cluster are connected, while others are not. ,
Disconnected: The cluster is not connected to Azure. ,
NotSpecified: The connectivity status is not specified. ,
}
,
Required: False ,
}
enum ,
supportStatus:
{
Description: Indicates whether the cluster is under support. ,
Enum:
{
InSupport: The cluster is under support. ,
OutOfSupport: The cluster is out of support. ,
NotSpecified: The support status is not specified. ,
}
,
Required: False ,
}
enum ,
cloudId:
{
Description: Unique, immutable resource id. ,
Required: False ,
}
string ,
ring:
{
Description: The ring to which this cluster belongs to. ,
Required: False ,
}
string ,
cloudManagementEndpoint:
{
Description: Endpoint configured for management from the Azure portal. ,
Required: False ,
}
string ,
aadClientId:
{
Description: App id of cluster AAD identity. ,
Required: False ,
}
string ,
aadTenantId:
{
Description: Tenant id of cluster AAD identity. ,
Required: False ,
}
string ,
aadApplicationObjectId:
{
Description: Object id of cluster AAD identity. ,
Required: False ,
}
string ,
aadServicePrincipalObjectId:
{
Description: Id of cluster identity service principal. ,
Required: False ,
}
string ,
softwareAssuranceProperties:
{
Description: Software Assurance properties of the cluster. ,
Required: False ,
}
{
softwareAssuranceStatus:
{
Description: Status of the Software Assurance for the cluster. ,
Enum:
{
Enabled: Software Assurance is enabled for the cluster. ,
Disabled: Software Assurance is disabled for the cluster. ,
}
,
Required: False ,
}
enum ,
softwareAssuranceIntent:
{
Description: Customer Intent for Software Assurance Benefit. ,
Enum:
{
Enable: Customer intends to enable the Software Assurance benefit. ,
Disable: Customer intends to disable the Software Assurance benefit. ,
}
,
Required: False ,
}
enum ,
lastUpdated:
{
Description: TimeStamp denoting the latest SA benefit applicability is validated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
isManagementCluster:
{
Description: Is Management Cluster, when true indicates that the cluster is used for managing other clusters ,
Required: False ,
}
boolean ,
logCollectionProperties:
{
Description: Log Collection properties of the cluster. ,
Required: False ,
}
{
fromDate:
{
Description: From DateTimeStamp from when logs need to be connected ,
Format: date-time ,
Required: False ,
}
string ,
toDate:
{
Description: To DateTimeStamp till when logs need to be connected ,
Format: date-time ,
Required: False ,
}
string ,
lastLogGenerated:
{
Description: Recent DateTimeStamp where logs are successfully generated ,
Format: date-time ,
Required: False ,
}
string ,
logCollectionSessionDetails:
{
Required: False ,
}
[
{
logStartTime:
{
Description: Start Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
logEndTime:
{
Description: End Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
timeCollected:
{
Description: Duration of logs collected ,
Format: date-time ,
Required: False ,
}
string ,
logSize:
{
Description: Size of the logs collected ,
Format: int64 ,
Required: False ,
}
integer ,
logCollectionStatus:
{
Description: LogCollection status ,
Enum:
{
None: No log collection has been initiated. ,
InProgress: Log collection is currently in progress. ,
Failed: Log collection has failed. ,
Succeeded: Log collection completed successfully. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: CorrelationId of the log collection ,
Required: False ,
}
string ,
logCollectionJobType:
{
Description: Specifies the type of log collection job. Determines whether the logs are collected immediately on demand or as part of a scheduled operation. ,
Enum:
{
OnDemand: Log collection is triggered manually and executed immediately. ,
Scheduled: Log collection is scheduled to run at a predefined time or interval. ,
}
,
Required: False ,
}
enum ,
endTimeCollected:
{
Description: End Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
logCollectionError:
{
Description: Log Collection Error details of the cluster. ,
Required: False ,
}
{
errorCode:
{
Description: Error Code of the log collection ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error Message of the log collection ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
remoteSupportProperties:
{
Description: RemoteSupport properties of the cluster. ,
Required: False ,
}
{
accessLevel:
{
Description: Remote Support Access Level ,
Enum:
{
Diagnostics: Allows remote diagnostics operations only. ,
DiagnosticsAndRepair: Allows both remote diagnostics and repair operations. ,
}
,
Required: False ,
}
enum ,
expirationTimeStamp:
{
Description: Expiration DateTimeStamp when Remote Support Access will be expired ,
Format: date-time ,
Required: False ,
}
string ,
remoteSupportType:
{
Description: Remote Support Type for cluster ,
Enum:
{
Enable: Enable remote support for the cluster. ,
Revoke: Revoke previously enabled remote support for the cluster. ,
}
,
Required: False ,
}
enum ,
remoteSupportNodeSettings:
{
Required: False ,
}
[
{
arcResourceId:
{
Description: Arc ResourceId of the Node ,
Required: False ,
}
string ,
state:
{
Description: Remote Support Access Connection State on the Node ,
Required: False ,
}
string ,
createdAt:
{
Description: Remote Support Enablement Request Created TimeStamp on the Node ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: Remote Support Enablement Request Updated TimeStamp on the Node ,
Format: date-time ,
Required: False ,
}
string ,
connectionStatus:
{
Description: Remote Support Access Connection Status on the Node ,
Required: False ,
}
string ,
connectionErrorMessage:
{
Description: Remote Support Access Connection Error Message on the Node ,
Required: False ,
}
string ,
transcriptLocation:
{
Description: Remote Support Transcript location on the node ,
Required: False ,
}
string ,
}
,
]
,
remoteSupportSessionDetails:
{
Required: False ,
}
[
{
sessionStartTime:
{
Description: Remote Support Session StartTime on the Node ,
Format: date-time ,
Required: False ,
}
string ,
sessionEndTime:
{
Description: Remote Support Session EndTime on the Node ,
Format: date-time ,
Required: False ,
}
string ,
nodeName:
{
Description: Name of the node ,
Required: False ,
}
string ,
duration:
{
Description: Duration of Remote Support Enablement ,
Format: int64 ,
Required: False ,
}
integer ,
accessLevel:
{
Description: Remote Support Access Level ,
Enum:
{
Diagnostics: Allows remote diagnostics operations only. ,
DiagnosticsAndRepair: Allows both remote diagnostics and repair operations. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
desiredProperties:
{
Description: Desired properties of the cluster. ,
Required: False ,
}
{
windowsServerSubscription:
{
Description: Desired state of Windows Server Subscription. ,
Enum:
{
Disabled: Windows Server Subscription is disabled. ,
Enabled: Windows Server Subscription is enabled. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Desired level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No diagnostic data will be emitted. ,
Basic: Basic diagnostic data will be emitted, including essential health metrics. ,
Enhanced: Enhanced diagnostic data will be emitted, including detailed performance and usage metrics. ,
}
,
Required: False ,
}
enum ,
}
,
reportedProperties:
{
Description: Properties reported by cluster agent. ,
Required: False ,
}
{
clusterName:
{
Description: Name of the on-prem cluster connected to this resource. ,
Required: False ,
}
string ,
clusterId:
{
Description: Unique id generated by the on-prem cluster. ,
Required: False ,
}
string ,
clusterVersion:
{
Description: Version of the cluster software. ,
Required: False ,
}
string ,
nodes:
{
Description: List of nodes reported by the cluster. ,
Required: False ,
}
[
{
name:
{
Description: Name of the cluster node. ,
Required: False ,
}
string ,
id:
{
Description: Id of the node in the cluster. ,
Format: float ,
Required: False ,
}
number ,
windowsServerSubscription:
{
Description: State of Windows Server Subscription. ,
Enum:
{
Disabled: Windows Server Subscription is disabled. ,
Enabled: Windows Server Subscription is enabled. ,
}
,
Required: False ,
}
enum ,
nodeType:
{
Description: Type of the cluster node hardware. ,
Enum:
{
FirstParty: All nodes in the cluster are provided and managed by Microsoft. ,
ThirdParty: All nodes in the cluster are provided and managed by a third-party vendor. ,
}
,
Required: False ,
}
enum ,
ehcResourceId:
{
Description: Edge Hardware Center Resource Id ,
Required: False ,
}
string ,
manufacturer:
{
Description: Manufacturer of the cluster node hardware. ,
Required: False ,
}
string ,
model:
{
Description: Model name of the cluster node hardware. ,
Required: False ,
}
string ,
osName:
{
Description: Operating system running on the cluster node. ,
Required: False ,
}
string ,
osVersion:
{
Description: Version of the operating system running on the cluster node. ,
Required: False ,
}
string ,
osDisplayVersion:
{
Description: Display version of the operating system running on the cluster node. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Immutable id of the cluster node. ,
Required: False ,
}
string ,
coreCount:
{
Description: Number of physical cores on the cluster node. ,
Format: float ,
Required: False ,
}
number ,
memoryInGiB:
{
Description: Total available memory on the cluster node (in GiB). ,
Format: float ,
Required: False ,
}
number ,
lastLicensingTimestamp:
{
Description: Most recent licensing timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
oemActivation:
{
Description: OEM activation status of the node. ,
Enum:
{
Disabled: OEM activation is disabled for the cluster. ,
Enabled: OEM activation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
lastUpdated:
{
Description: Last time the cluster reported the data. ,
Format: date-time ,
Required: False ,
}
string ,
msiExpirationTimeStamp:
{
Description: Specifies the expiration timestamp of the cluster's Managed Service Identity (MSI). The value is expressed in Coordinated Universal Time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
imdsAttestation:
{
Description: IMDS attestation status of the cluster. ,
Enum:
{
Disabled: IMDS attestation is disabled for the cluster. ,
Enabled: IMDS attestation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No diagnostic data will be emitted. ,
Basic: Basic diagnostic data will be emitted, including essential health metrics. ,
Enhanced: Enhanced diagnostic data will be emitted, including detailed performance and usage metrics. ,
}
,
Required: False ,
}
enum ,
supportedCapabilities:
{
Description: Capabilities supported by the cluster. ,
Required: False ,
}
[
string ,
]
,
clusterType:
{
Description: Specifies the type of hardware vendor for all nodes in the cluster. Indicates whether the nodes are provided by Microsoft or a third-party vendor. ,
Enum:
{
FirstParty: All nodes in the cluster are provided and managed by Microsoft. ,
ThirdParty: All nodes in the cluster are provided and managed by a third-party vendor. ,
}
,
Required: False ,
}
enum ,
manufacturer:
{
Description: The manufacturer of all the nodes of the cluster. ,
Required: False ,
}
string ,
oemActivation:
{
Description: OEM activation status of the cluster. ,
Enum:
{
Disabled: OEM activation is disabled for the cluster. ,
Enabled: OEM activation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
hardwareClass:
{
Description: Hardware class of the cluster. ,
Enum:
{
Small: The hardware class is small. ,
Medium: The hardware class is medium. This corresponds to the default ,
Large: The hardware class is large. ,
}
,
Required: False ,
}
enum ,
}
,
isolatedVmAttestationConfiguration:
{
Description: Attestation configurations for isolated VM (e.g. TVM, CVM) of the cluster. ,
Required: False ,
}
{
attestationResourceId:
{
Description: Fully qualified Azure resource id of the Microsoft Azure attestation resource associated with this cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
relyingPartyServiceEndpoint:
{
Description: Region specific endpoint for relying party service. ,
Required: False ,
}
string ,
attestationServiceEndpoint:
{
Description: Region specific endpoint for Microsoft Azure Attestation service for the cluster ,
Required: False ,
}
string ,
}
,
trialDaysRemaining:
{
Description: Number of days remaining in the trial period. ,
Format: float ,
Required: False ,
}
number ,
billingModel:
{
Description: Type of billing applied to the resource. ,
Required: False ,
}
string ,
registrationTimestamp:
{
Description: First cluster sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncTimestamp:
{
Description: Most recent cluster sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastBillingTimestamp:
{
Description: Most recent billing meter timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
serviceEndpoint:
{
Description: Region specific DataPath Endpoint of the cluster. ,
Required: False ,
}
string ,
resourceProviderObjectId:
{
Description: Object id of RP Service Principal ,
Required: False ,
}
string ,
secretsLocations:
{
Description: List of secret locations. ,
Required: False ,
}
[
{
secretsType:
{
Description: Type of secrets to store ,
Enum:
{
BackupSecrets: Backup secrets type ,
}
,
Required: True ,
}
enum ,
secretsLocation:
{
Description: secrets location ,
Required: True ,
}
string ,
}
,
]
,
clusterPattern:
{
Description: Supported Storage Type for HCI Cluster ,
Enum:
{
Standard: Standard cluster. ,
RackAware: RackAware cluster. ,
}
,
Required: False ,
}
enum ,
confidentialVmProperties:
{
Description: Represents the Confidential Virtual Machine (CVM) support intent and current status for the cluster resource. ,
Required: False ,
}
{
confidentialVmIntent:
{
Description: Captures the customer's intent to enable or disable CVM support on the cluster, either during initial deployment (Day-0) or at a later stage (Day-N). ,
Enum:
{
Enable: Indicates that the customer intends to enable CVM support on the cluster. ,
Disable: Indicates that the customer intends to disable CVM support on the cluster. ,
}
,
Required: False ,
}
enum ,
confidentialVmStatus:
{
Description: Captures the current status of CVM support on the cluster. ,
Enum:
{
Enabled: CVM support is fully enabled on the cluster. All nodes are CVM capable. ,
PartiallyEnabled: CVM support is partially enabled. At least one node in the cluster is CVM capable. ,
Disabled: CVM support is disabled. None of the nodes in the cluster are CVM capable. ,
}
,
Required: False ,
}
enum ,
confidentialVmStatusSummary:
{
Description: Additional context about CVM support on the cluster, such as reasons for partial enablement or hardware constraints. ,
Required: False ,
}
string ,
}
,
sdnProperties:
{
Description: Software Defined Networking Properties of the cluster ,
Required: False ,
}
{
sdnIntegrationIntent:
{
Description: Indicates whether Software Defined Networking (SDN) integration should be enabled or disabled for this deployment. ,
Enum:
{
Enable: Enable SDN integration for the deployment. ,
Disable: Disable SDN integration for the deployment. ,
}
,
Required: False ,
}
enum ,
}
,
localAvailabilityZones:
{
Description: Local Availability Zone information for HCI cluster ,
Required: False ,
}
[
{
localAvailabilityZoneName:
{
Description: Local Availability Zone name for HCI cluster ,
Required: False ,
}
string ,
nodes:
{
Description: Nodes belonging to a particular zone ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
identityProvider:
{
Description: Identity Provider for the cluster ,
Enum:
{
ActiveDirectory: Uses Active Directory as the identity provider, enabling domain-based authentication and centralized identity management. This is the default option. ,
LocalIdentity: Uses a local identity system integrated with Azure Key Vault for authentication. Suitable for AD-less environments where Active Directory is not available or required. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
kind:
{
Description: This property identifies the purpose of the Cluster deployment. For example, a valid value is AzureLocal ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_Delete (new)
Description :  Delete an HCI cluster.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ArcSettings_ListByCluster (new)
Description :  Get ArcSetting resources of HCI Cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ArcSetting items on this page ,
Required: True ,
}
[
{
properties:
{
Description: ArcSetting properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the ArcSetting proxy resource. ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
arcInstanceResourceGroup:
{
Description: The resource group that hosts the Arc agents, ie. Hybrid Compute Machine resources. ,
Required: False ,
}
string ,
arcApplicationClientId:
{
Description: App id of arc AAD identity. ,
Required: False ,
}
string ,
arcApplicationTenantId:
{
Description: Tenant id of arc AAD identity. ,
Required: False ,
}
string ,
arcServicePrincipalObjectId:
{
Description: Object id of arc AAD service principal. ,
Required: False ,
}
string ,
arcApplicationObjectId:
{
Description: Object id of arc AAD identity. ,
Required: False ,
}
string ,
aggregateState:
{
Description: Aggregate state of Arc agent across the nodes in this HCI cluster. ,
Enum:
{
NotSpecified: The aggregate state is not specified. ,
Error: An error occurred in the aggregate state. ,
Succeeded: The operation successfully completed across all nodes. ,
Canceled: The operation was canceled across the nodes. ,
Failed: The operation failed on all or most nodes. ,
Connected: All nodes are connected. ,
Disconnected: All nodes are disconnected. ,
Deleted: The Arc agent has been deleted from all nodes. ,
Creating: The Arc agent is being created across the nodes. ,
Updating: The Arc agent is being updated across the nodes. ,
Deleting: The Arc agent is being deleted across the nodes. ,
Moving: The Arc agent is being moved across the nodes. ,
PartiallySucceeded: The operation succeeded on some nodes. ,
PartiallyConnected: Some nodes are connected, others are not. ,
InProgress: The operation is currently in progress across the nodes. ,
Accepted: The operation has been accepted and is pending execution. ,
Provisioning: The Arc agent is being provisioned across the nodes. ,
DisableInProgress: The Arc agent is being disabled across the nodes. ,
}
,
Required: False ,
}
enum ,
perNodeDetails:
{
Description: State of Arc agent in each of the nodes. ,
Required: False ,
}
[
{
name:
{
Description: Name of the Node in HCI Cluster ,
Required: False ,
}
string ,
arcInstance:
{
Description: Fully qualified resource ID for the Arc agent of this node. ,
Required: False ,
}
string ,
arcNodeServicePrincipalObjectId:
{
Description: The service principal id of the arc for server node ,
Required: False ,
}
string ,
state:
{
Description: State of the Arc agent in this node. Indicates the current lifecycle status of the agent, such as whether it's being provisioned, connected, updated, or has encountered an error. ,
Enum:
{
NotSpecified: The state is not specified. ,
Error: An error occurred during the agent's lifecycle. ,
Succeeded: The operation completed successfully. ,
Canceled: The operation was canceled before completion. ,
Failed: The operation failed. ,
Connected: The Arc agent is connected on this node. ,
Disconnected: The Arc agent is disconnected on this node. ,
Deleted: The Arc agent has been deleted from this node. ,
Creating: The Arc agent is being created on this node. ,
Updating: The Arc agent is being updated on this node. ,
Deleting: The Arc agent is being deleted from this node. ,
Moving: The Arc agent is being moved on this node. ,
PartiallySucceeded: The operation partially succeeded. ,
PartiallyConnected: The Arc agent is partially connected on this node. ,
InProgress: The operation is currently in progress. ,
Accepted: The operation has been accepted and is pending execution. ,
Provisioning: The Arc agent is currently being provisioned on this node. ,
DisableInProgress: The Arc agent is in the process of being disabled on this node. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
connectivityProperties:
{
Description: contains connectivity related configuration for ARC resources ,
Required: False ,
}
{
enabled:
{
Description: True indicates ARC connectivity is enabled ,
Required: False ,
}
boolean ,
serviceConfigurations:
{
Description: Service configurations associated with the connectivity resource. They are only processed by the server if 'enabled' property is set to 'true'. ,
Required: False ,
}
[
{
serviceName:
{
Description: Specifies the name of the service associated with the update or operation. This helps identify which system component or tool is involved. ,
Enum:
{
WAC: Windows Admin Center (WAC) is the service associated with this operation. ,
}
,
Required: True ,
}
enum ,
port:
{
Description: The port on which service is enabled. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
defaultExtensions:
{
Description: Properties for each of the default extensions category ,
Required: False ,
}
[
{
category:
{
Description: Default extension category ,
Required: False ,
}
string ,
consentTime:
{
Description: Consent time for extension category ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ArcSettings_Get (new)
Description :  Get ArcSetting resource details of HCI Cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
arcSettingName:
{
Description: The name of the proxy resource holding details of HCI ArcSetting information. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: ArcSetting properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the ArcSetting proxy resource. ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
arcInstanceResourceGroup:
{
Description: The resource group that hosts the Arc agents, ie. Hybrid Compute Machine resources. ,
Required: False ,
}
string ,
arcApplicationClientId:
{
Description: App id of arc AAD identity. ,
Required: False ,
}
string ,
arcApplicationTenantId:
{
Description: Tenant id of arc AAD identity. ,
Required: False ,
}
string ,
arcServicePrincipalObjectId:
{
Description: Object id of arc AAD service principal. ,
Required: False ,
}
string ,
arcApplicationObjectId:
{
Description: Object id of arc AAD identity. ,
Required: False ,
}
string ,
aggregateState:
{
Description: Aggregate state of Arc agent across the nodes in this HCI cluster. ,
Enum:
{
NotSpecified: The aggregate state is not specified. ,
Error: An error occurred in the aggregate state. ,
Succeeded: The operation successfully completed across all nodes. ,
Canceled: The operation was canceled across the nodes. ,
Failed: The operation failed on all or most nodes. ,
Connected: All nodes are connected. ,
Disconnected: All nodes are disconnected. ,
Deleted: The Arc agent has been deleted from all nodes. ,
Creating: The Arc agent is being created across the nodes. ,
Updating: The Arc agent is being updated across the nodes. ,
Deleting: The Arc agent is being deleted across the nodes. ,
Moving: The Arc agent is being moved across the nodes. ,
PartiallySucceeded: The operation succeeded on some nodes. ,
PartiallyConnected: Some nodes are connected, others are not. ,
InProgress: The operation is currently in progress across the nodes. ,
Accepted: The operation has been accepted and is pending execution. ,
Provisioning: The Arc agent is being provisioned across the nodes. ,
DisableInProgress: The Arc agent is being disabled across the nodes. ,
}
,
Required: False ,
}
enum ,
perNodeDetails:
{
Description: State of Arc agent in each of the nodes. ,
Required: False ,
}
[
{
name:
{
Description: Name of the Node in HCI Cluster ,
Required: False ,
}
string ,
arcInstance:
{
Description: Fully qualified resource ID for the Arc agent of this node. ,
Required: False ,
}
string ,
arcNodeServicePrincipalObjectId:
{
Description: The service principal id of the arc for server node ,
Required: False ,
}
string ,
state:
{
Description: State of the Arc agent in this node. Indicates the current lifecycle status of the agent, such as whether it's being provisioned, connected, updated, or has encountered an error. ,
Enum:
{
NotSpecified: The state is not specified. ,
Error: An error occurred during the agent's lifecycle. ,
Succeeded: The operation completed successfully. ,
Canceled: The operation was canceled before completion. ,
Failed: The operation failed. ,
Connected: The Arc agent is connected on this node. ,
Disconnected: The Arc agent is disconnected on this node. ,
Deleted: The Arc agent has been deleted from this node. ,
Creating: The Arc agent is being created on this node. ,
Updating: The Arc agent is being updated on this node. ,
Deleting: The Arc agent is being deleted from this node. ,
Moving: The Arc agent is being moved on this node. ,
PartiallySucceeded: The operation partially succeeded. ,
PartiallyConnected: The Arc agent is partially connected on this node. ,
InProgress: The operation is currently in progress. ,
Accepted: The operation has been accepted and is pending execution. ,
Provisioning: The Arc agent is currently being provisioned on this node. ,
DisableInProgress: The Arc agent is in the process of being disabled on this node. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
connectivityProperties:
{
Description: contains connectivity related configuration for ARC resources ,
Required: False ,
}
{
enabled:
{
Description: True indicates ARC connectivity is enabled ,
Required: False ,
}
boolean ,
serviceConfigurations:
{
Description: Service configurations associated with the connectivity resource. They are only processed by the server if 'enabled' property is set to 'true'. ,
Required: False ,
}
[
{
serviceName:
{
Description: Specifies the name of the service associated with the update or operation. This helps identify which system component or tool is involved. ,
Enum:
{
WAC: Windows Admin Center (WAC) is the service associated with this operation. ,
}
,
Required: True ,
}
enum ,
port:
{
Description: The port on which service is enabled. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
defaultExtensions:
{
Description: Properties for each of the default extensions category ,
Required: False ,
}
[
{
category:
{
Description: Default extension category ,
Required: False ,
}
string ,
consentTime:
{
Description: Consent time for extension category ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ArcSettings_Create (new)
Description :  Create ArcSetting for HCI cluster.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
arcSettingName:
{
Description: The name of the proxy resource holding details of HCI ArcSetting information. ,
Required: True ,
}
string ,
arcSetting:
{
Description: Parameters supplied to the Create ArcSetting resource for this HCI cluster. ,
Required: True ,
}
{
properties:
{
Description: ArcSetting properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the ArcSetting proxy resource. ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
arcInstanceResourceGroup:
{
Description: The resource group that hosts the Arc agents, ie. Hybrid Compute Machine resources. ,
Required: False ,
}
string ,
arcApplicationClientId:
{
Description: App id of arc AAD identity. ,
Required: False ,
}
string ,
arcApplicationTenantId:
{
Description: Tenant id of arc AAD identity. ,
Required: False ,
}
string ,
arcServicePrincipalObjectId:
{
Description: Object id of arc AAD service principal. ,
Required: False ,
}
string ,
arcApplicationObjectId:
{
Description: Object id of arc AAD identity. ,
Required: False ,
}
string ,
aggregateState:
{
Description: Aggregate state of Arc agent across the nodes in this HCI cluster. ,
Enum:
{
NotSpecified: The aggregate state is not specified. ,
Error: An error occurred in the aggregate state. ,
Succeeded: The operation successfully completed across all nodes. ,
Canceled: The operation was canceled across the nodes. ,
Failed: The operation failed on all or most nodes. ,
Connected: All nodes are connected. ,
Disconnected: All nodes are disconnected. ,
Deleted: The Arc agent has been deleted from all nodes. ,
Creating: The Arc agent is being created across the nodes. ,
Updating: The Arc agent is being updated across the nodes. ,
Deleting: The Arc agent is being deleted across the nodes. ,
Moving: The Arc agent is being moved across the nodes. ,
PartiallySucceeded: The operation succeeded on some nodes. ,
PartiallyConnected: Some nodes are connected, others are not. ,
InProgress: The operation is currently in progress across the nodes. ,
Accepted: The operation has been accepted and is pending execution. ,
Provisioning: The Arc agent is being provisioned across the nodes. ,
DisableInProgress: The Arc agent is being disabled across the nodes. ,
}
,
Required: False ,
}
enum ,
perNodeDetails:
{
Description: State of Arc agent in each of the nodes. ,
Required: False ,
}
[
{
name:
{
Description: Name of the Node in HCI Cluster ,
Required: False ,
}
string ,
arcInstance:
{
Description: Fully qualified resource ID for the Arc agent of this node. ,
Required: False ,
}
string ,
arcNodeServicePrincipalObjectId:
{
Description: The service principal id of the arc for server node ,
Required: False ,
}
string ,
state:
{
Description: State of the Arc agent in this node. Indicates the current lifecycle status of the agent, such as whether it's being provisioned, connected, updated, or has encountered an error. ,
Enum:
{
NotSpecified: The state is not specified. ,
Error: An error occurred during the agent's lifecycle. ,
Succeeded: The operation completed successfully. ,
Canceled: The operation was canceled before completion. ,
Failed: The operation failed. ,
Connected: The Arc agent is connected on this node. ,
Disconnected: The Arc agent is disconnected on this node. ,
Deleted: The Arc agent has been deleted from this node. ,
Creating: The Arc agent is being created on this node. ,
Updating: The Arc agent is being updated on this node. ,
Deleting: The Arc agent is being deleted from this node. ,
Moving: The Arc agent is being moved on this node. ,
PartiallySucceeded: The operation partially succeeded. ,
PartiallyConnected: The Arc agent is partially connected on this node. ,
InProgress: The operation is currently in progress. ,
Accepted: The operation has been accepted and is pending execution. ,
Provisioning: The Arc agent is currently being provisioned on this node. ,
DisableInProgress: The Arc agent is in the process of being disabled on this node. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
connectivityProperties:
{
Description: contains connectivity related configuration for ARC resources ,
Required: False ,
}
{
enabled:
{
Description: True indicates ARC connectivity is enabled ,
Required: False ,
}
boolean ,
serviceConfigurations:
{
Description: Service configurations associated with the connectivity resource. They are only processed by the server if 'enabled' property is set to 'true'. ,
Required: False ,
}
[
{
serviceName:
{
Description: Specifies the name of the service associated with the update or operation. This helps identify which system component or tool is involved. ,
Enum:
{
WAC: Windows Admin Center (WAC) is the service associated with this operation. ,
}
,
Required: True ,
}
enum ,
port:
{
Description: The port on which service is enabled. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
defaultExtensions:
{
Description: Properties for each of the default extensions category ,
Required: False ,
}
[
{
category:
{
Description: Default extension category ,
Required: False ,
}
string ,
consentTime:
{
Description: Consent time for extension category ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: ArcSetting properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the ArcSetting proxy resource. ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
arcInstanceResourceGroup:
{
Description: The resource group that hosts the Arc agents, ie. Hybrid Compute Machine resources. ,
Required: False ,
}
string ,
arcApplicationClientId:
{
Description: App id of arc AAD identity. ,
Required: False ,
}
string ,
arcApplicationTenantId:
{
Description: Tenant id of arc AAD identity. ,
Required: False ,
}
string ,
arcServicePrincipalObjectId:
{
Description: Object id of arc AAD service principal. ,
Required: False ,
}
string ,
arcApplicationObjectId:
{
Description: Object id of arc AAD identity. ,
Required: False ,
}
string ,
aggregateState:
{
Description: Aggregate state of Arc agent across the nodes in this HCI cluster. ,
Enum:
{
NotSpecified: The aggregate state is not specified. ,
Error: An error occurred in the aggregate state. ,
Succeeded: The operation successfully completed across all nodes. ,
Canceled: The operation was canceled across the nodes. ,
Failed: The operation failed on all or most nodes. ,
Connected: All nodes are connected. ,
Disconnected: All nodes are disconnected. ,
Deleted: The Arc agent has been deleted from all nodes. ,
Creating: The Arc agent is being created across the nodes. ,
Updating: The Arc agent is being updated across the nodes. ,
Deleting: The Arc agent is being deleted across the nodes. ,
Moving: The Arc agent is being moved across the nodes. ,
PartiallySucceeded: The operation succeeded on some nodes. ,
PartiallyConnected: Some nodes are connected, others are not. ,
InProgress: The operation is currently in progress across the nodes. ,
Accepted: The operation has been accepted and is pending execution. ,
Provisioning: The Arc agent is being provisioned across the nodes. ,
DisableInProgress: The Arc agent is being disabled across the nodes. ,
}
,
Required: False ,
}
enum ,
perNodeDetails:
{
Description: State of Arc agent in each of the nodes. ,
Required: False ,
}
[
{
name:
{
Description: Name of the Node in HCI Cluster ,
Required: False ,
}
string ,
arcInstance:
{
Description: Fully qualified resource ID for the Arc agent of this node. ,
Required: False ,
}
string ,
arcNodeServicePrincipalObjectId:
{
Description: The service principal id of the arc for server node ,
Required: False ,
}
string ,
state:
{
Description: State of the Arc agent in this node. Indicates the current lifecycle status of the agent, such as whether it's being provisioned, connected, updated, or has encountered an error. ,
Enum:
{
NotSpecified: The state is not specified. ,
Error: An error occurred during the agent's lifecycle. ,
Succeeded: The operation completed successfully. ,
Canceled: The operation was canceled before completion. ,
Failed: The operation failed. ,
Connected: The Arc agent is connected on this node. ,
Disconnected: The Arc agent is disconnected on this node. ,
Deleted: The Arc agent has been deleted from this node. ,
Creating: The Arc agent is being created on this node. ,
Updating: The Arc agent is being updated on this node. ,
Deleting: The Arc agent is being deleted from this node. ,
Moving: The Arc agent is being moved on this node. ,
PartiallySucceeded: The operation partially succeeded. ,
PartiallyConnected: The Arc agent is partially connected on this node. ,
InProgress: The operation is currently in progress. ,
Accepted: The operation has been accepted and is pending execution. ,
Provisioning: The Arc agent is currently being provisioned on this node. ,
DisableInProgress: The Arc agent is in the process of being disabled on this node. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
connectivityProperties:
{
Description: contains connectivity related configuration for ARC resources ,
Required: False ,
}
{
enabled:
{
Description: True indicates ARC connectivity is enabled ,
Required: False ,
}
boolean ,
serviceConfigurations:
{
Description: Service configurations associated with the connectivity resource. They are only processed by the server if 'enabled' property is set to 'true'. ,
Required: False ,
}
[
{
serviceName:
{
Description: Specifies the name of the service associated with the update or operation. This helps identify which system component or tool is involved. ,
Enum:
{
WAC: Windows Admin Center (WAC) is the service associated with this operation. ,
}
,
Required: True ,
}
enum ,
port:
{
Description: The port on which service is enabled. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
defaultExtensions:
{
Description: Properties for each of the default extensions category ,
Required: False ,
}
[
{
category:
{
Description: Default extension category ,
Required: False ,
}
string ,
consentTime:
{
Description: Consent time for extension category ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ArcSettings_Update (new)
Description :  Update ArcSettings for HCI cluster.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
arcSettingName:
{
Description: The name of the proxy resource holding details of HCI ArcSetting information. ,
Required: True ,
}
string ,
arcSetting:
{
Description: ArcSettings parameters that needs to be updated ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: ArcSettings properties. ,
Required: False ,
}
{
connectivityProperties:
{
Description: contains connectivity related configuration for ARC resources ,
Required: False ,
}
{
enabled:
{
Description: True indicates ARC connectivity is enabled ,
Required: False ,
}
boolean ,
serviceConfigurations:
{
Description: Service configurations associated with the connectivity resource. They are only processed by the server if 'enabled' property is set to 'true'. ,
Required: False ,
}
[
{
serviceName:
{
Description: Specifies the name of the service associated with the update or operation. This helps identify which system component or tool is involved. ,
Enum:
{
WAC: Windows Admin Center (WAC) is the service associated with this operation. ,
}
,
Required: True ,
}
enum ,
port:
{
Description: The port on which service is enabled. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: ArcSetting properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the ArcSetting proxy resource. ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
arcInstanceResourceGroup:
{
Description: The resource group that hosts the Arc agents, ie. Hybrid Compute Machine resources. ,
Required: False ,
}
string ,
arcApplicationClientId:
{
Description: App id of arc AAD identity. ,
Required: False ,
}
string ,
arcApplicationTenantId:
{
Description: Tenant id of arc AAD identity. ,
Required: False ,
}
string ,
arcServicePrincipalObjectId:
{
Description: Object id of arc AAD service principal. ,
Required: False ,
}
string ,
arcApplicationObjectId:
{
Description: Object id of arc AAD identity. ,
Required: False ,
}
string ,
aggregateState:
{
Description: Aggregate state of Arc agent across the nodes in this HCI cluster. ,
Enum:
{
NotSpecified: The aggregate state is not specified. ,
Error: An error occurred in the aggregate state. ,
Succeeded: The operation successfully completed across all nodes. ,
Canceled: The operation was canceled across the nodes. ,
Failed: The operation failed on all or most nodes. ,
Connected: All nodes are connected. ,
Disconnected: All nodes are disconnected. ,
Deleted: The Arc agent has been deleted from all nodes. ,
Creating: The Arc agent is being created across the nodes. ,
Updating: The Arc agent is being updated across the nodes. ,
Deleting: The Arc agent is being deleted across the nodes. ,
Moving: The Arc agent is being moved across the nodes. ,
PartiallySucceeded: The operation succeeded on some nodes. ,
PartiallyConnected: Some nodes are connected, others are not. ,
InProgress: The operation is currently in progress across the nodes. ,
Accepted: The operation has been accepted and is pending execution. ,
Provisioning: The Arc agent is being provisioned across the nodes. ,
DisableInProgress: The Arc agent is being disabled across the nodes. ,
}
,
Required: False ,
}
enum ,
perNodeDetails:
{
Description: State of Arc agent in each of the nodes. ,
Required: False ,
}
[
{
name:
{
Description: Name of the Node in HCI Cluster ,
Required: False ,
}
string ,
arcInstance:
{
Description: Fully qualified resource ID for the Arc agent of this node. ,
Required: False ,
}
string ,
arcNodeServicePrincipalObjectId:
{
Description: The service principal id of the arc for server node ,
Required: False ,
}
string ,
state:
{
Description: State of the Arc agent in this node. Indicates the current lifecycle status of the agent, such as whether it's being provisioned, connected, updated, or has encountered an error. ,
Enum:
{
NotSpecified: The state is not specified. ,
Error: An error occurred during the agent's lifecycle. ,
Succeeded: The operation completed successfully. ,
Canceled: The operation was canceled before completion. ,
Failed: The operation failed. ,
Connected: The Arc agent is connected on this node. ,
Disconnected: The Arc agent is disconnected on this node. ,
Deleted: The Arc agent has been deleted from this node. ,
Creating: The Arc agent is being created on this node. ,
Updating: The Arc agent is being updated on this node. ,
Deleting: The Arc agent is being deleted from this node. ,
Moving: The Arc agent is being moved on this node. ,
PartiallySucceeded: The operation partially succeeded. ,
PartiallyConnected: The Arc agent is partially connected on this node. ,
InProgress: The operation is currently in progress. ,
Accepted: The operation has been accepted and is pending execution. ,
Provisioning: The Arc agent is currently being provisioned on this node. ,
DisableInProgress: The Arc agent is in the process of being disabled on this node. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
connectivityProperties:
{
Description: contains connectivity related configuration for ARC resources ,
Required: False ,
}
{
enabled:
{
Description: True indicates ARC connectivity is enabled ,
Required: False ,
}
boolean ,
serviceConfigurations:
{
Description: Service configurations associated with the connectivity resource. They are only processed by the server if 'enabled' property is set to 'true'. ,
Required: False ,
}
[
{
serviceName:
{
Description: Specifies the name of the service associated with the update or operation. This helps identify which system component or tool is involved. ,
Enum:
{
WAC: Windows Admin Center (WAC) is the service associated with this operation. ,
}
,
Required: True ,
}
enum ,
port:
{
Description: The port on which service is enabled. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
defaultExtensions:
{
Description: Properties for each of the default extensions category ,
Required: False ,
}
[
{
category:
{
Description: Default extension category ,
Required: False ,
}
string ,
consentTime:
{
Description: Consent time for extension category ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ArcSettings_Delete (new)
Description :  Delete ArcSetting resource details of HCI Cluster.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
arcSettingName:
{
Description: The name of the proxy resource holding details of HCI ArcSetting information. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ArcSettings_ConsentAndInstallDefaultExtensions (new)
Description :  Add consent time for default extensions and initiate extensions installation
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}/consentAndInstallDefaultExtensions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
arcSettingName:
{
Description: The name of the proxy resource holding details of HCI ArcSetting information. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: ArcSetting properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the ArcSetting proxy resource. ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
arcInstanceResourceGroup:
{
Description: The resource group that hosts the Arc agents, ie. Hybrid Compute Machine resources. ,
Required: False ,
}
string ,
arcApplicationClientId:
{
Description: App id of arc AAD identity. ,
Required: False ,
}
string ,
arcApplicationTenantId:
{
Description: Tenant id of arc AAD identity. ,
Required: False ,
}
string ,
arcServicePrincipalObjectId:
{
Description: Object id of arc AAD service principal. ,
Required: False ,
}
string ,
arcApplicationObjectId:
{
Description: Object id of arc AAD identity. ,
Required: False ,
}
string ,
aggregateState:
{
Description: Aggregate state of Arc agent across the nodes in this HCI cluster. ,
Enum:
{
NotSpecified: The aggregate state is not specified. ,
Error: An error occurred in the aggregate state. ,
Succeeded: The operation successfully completed across all nodes. ,
Canceled: The operation was canceled across the nodes. ,
Failed: The operation failed on all or most nodes. ,
Connected: All nodes are connected. ,
Disconnected: All nodes are disconnected. ,
Deleted: The Arc agent has been deleted from all nodes. ,
Creating: The Arc agent is being created across the nodes. ,
Updating: The Arc agent is being updated across the nodes. ,
Deleting: The Arc agent is being deleted across the nodes. ,
Moving: The Arc agent is being moved across the nodes. ,
PartiallySucceeded: The operation succeeded on some nodes. ,
PartiallyConnected: Some nodes are connected, others are not. ,
InProgress: The operation is currently in progress across the nodes. ,
Accepted: The operation has been accepted and is pending execution. ,
Provisioning: The Arc agent is being provisioned across the nodes. ,
DisableInProgress: The Arc agent is being disabled across the nodes. ,
}
,
Required: False ,
}
enum ,
perNodeDetails:
{
Description: State of Arc agent in each of the nodes. ,
Required: False ,
}
[
{
name:
{
Description: Name of the Node in HCI Cluster ,
Required: False ,
}
string ,
arcInstance:
{
Description: Fully qualified resource ID for the Arc agent of this node. ,
Required: False ,
}
string ,
arcNodeServicePrincipalObjectId:
{
Description: The service principal id of the arc for server node ,
Required: False ,
}
string ,
state:
{
Description: State of the Arc agent in this node. Indicates the current lifecycle status of the agent, such as whether it's being provisioned, connected, updated, or has encountered an error. ,
Enum:
{
NotSpecified: The state is not specified. ,
Error: An error occurred during the agent's lifecycle. ,
Succeeded: The operation completed successfully. ,
Canceled: The operation was canceled before completion. ,
Failed: The operation failed. ,
Connected: The Arc agent is connected on this node. ,
Disconnected: The Arc agent is disconnected on this node. ,
Deleted: The Arc agent has been deleted from this node. ,
Creating: The Arc agent is being created on this node. ,
Updating: The Arc agent is being updated on this node. ,
Deleting: The Arc agent is being deleted from this node. ,
Moving: The Arc agent is being moved on this node. ,
PartiallySucceeded: The operation partially succeeded. ,
PartiallyConnected: The Arc agent is partially connected on this node. ,
InProgress: The operation is currently in progress. ,
Accepted: The operation has been accepted and is pending execution. ,
Provisioning: The Arc agent is currently being provisioned on this node. ,
DisableInProgress: The Arc agent is in the process of being disabled on this node. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
connectivityProperties:
{
Description: contains connectivity related configuration for ARC resources ,
Required: False ,
}
{
enabled:
{
Description: True indicates ARC connectivity is enabled ,
Required: False ,
}
boolean ,
serviceConfigurations:
{
Description: Service configurations associated with the connectivity resource. They are only processed by the server if 'enabled' property is set to 'true'. ,
Required: False ,
}
[
{
serviceName:
{
Description: Specifies the name of the service associated with the update or operation. This helps identify which system component or tool is involved. ,
Enum:
{
WAC: Windows Admin Center (WAC) is the service associated with this operation. ,
}
,
Required: True ,
}
enum ,
port:
{
Description: The port on which service is enabled. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
defaultExtensions:
{
Description: Properties for each of the default extensions category ,
Required: False ,
}
[
{
category:
{
Description: Default extension category ,
Required: False ,
}
string ,
consentTime:
{
Description: Consent time for extension category ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ArcSettings_CreateIdentity (new)
Description :  Create Aad identity for arc settings.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}/createArcIdentity
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
arcSettingName:
{
Description: The name of the proxy resource holding details of HCI ArcSetting information. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: ArcIdentity properties. ,
Required: False ,
}
{
arcApplicationClientId:
{
Required: False ,
}
string ,
arcApplicationTenantId:
{
Required: False ,
}
string ,
arcServicePrincipalObjectId:
{
Required: False ,
}
string ,
arcApplicationObjectId:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Extensions_ListByArcSetting (new)
Description :  List all Extensions under ArcSetting resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}/extensions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
arcSettingName:
{
Description: The name of the proxy resource holding details of HCI ArcSetting information. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Extension items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Describes Machine Extension Properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Extension proxy resource. Indicates the current lifecycle status of the resource, such as whether it's being created, updated, deleted, or has encountered an error. ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
extensionParameters:
{
Description: Parameters specific to this extension type. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. Latest version would be used if not specified. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
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. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
string ,
protectedSettings:
{
Description: Protected settings (may contain secrets). ,
Format: password ,
Required: False ,
}
string ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. ,
Required: False ,
}
boolean ,
}
,
aggregateState:
{
Description: Aggregate state of Arc Extensions across the nodes in this HCI cluster. This reflects the overall status of the extension deployment and operation across all nodes. ,
Enum:
{
NotSpecified: The aggregate state is not specified. ,
Error: An error occurred in the aggregate state. ,
Succeeded: The operation succeeded across all nodes. ,
Canceled: The operation was canceled across the nodes. ,
Failed: The operation failed on all or most nodes. ,
Connected: All nodes are connected. ,
Disconnected: All nodes are disconnected. ,
Deleted: The extension has been deleted from all nodes. ,
Creating: The extension is being created across the nodes. ,
Updating: The extension is being updated across the nodes. ,
Deleting: The extension is being deleted across the nodes. ,
Moving: The extension is being moved across the nodes. ,
PartiallySucceeded: The operation succeeded on some nodes. ,
PartiallyConnected: Some nodes are connected, others are not. ,
InProgress: The operation is currently in progress across the nodes. ,
Accepted: The operation has been accepted and is pending execution. ,
Provisioning: The extension is currently being provisioned across the nodes. ,
UpgradeFailedRollbackSucceeded: Extension upgrade failed, but rollback succeeded across the nodes. ,
}
,
Required: False ,
}
enum ,
perNodeExtensionDetails:
{
Description: State of Arc Extension in each of the nodes. ,
Required: False ,
}
[
{
name:
{
Description: Name of the node in HCI Cluster. ,
Required: False ,
}
string ,
extension:
{
Description: Fully qualified resource ID for the particular Arc Extension on this node. ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
state:
{
Description: State of Arc Extension in this node. Reflects the current lifecycle status of the extension on the individual node, such as whether it's being created, updated, deleted, or has encountered an error. ,
Enum:
{
NotSpecified: The state is not specified. ,
Error: An error occurred during the extension lifecycle. ,
Succeeded: The extension operation completed successfully. ,
Canceled: The extension operation was canceled. ,
Failed: The extension operation failed. ,
Connected: The extension is connected on the node. ,
Disconnected: The extension is disconnected on the node. ,
Deleted: The extension has been deleted from the node. ,
Creating: The extension is being created on the node. ,
Updating: The extension is being updated on the node. ,
Deleting: The extension is being deleted from the node. ,
Moving: The extension is being moved on the node. ,
PartiallySucceeded: The extension operation partially succeeded. ,
PartiallyConnected: The extension is partially connected on the node. ,
InProgress: The extension operation is currently in progress. ,
Accepted: The extension operation has been accepted and is pending execution. ,
Provisioning: The extension is currently being provisioned on the node. ,
}
,
Required: False ,
}
enum ,
instanceView:
{
Description: The extension instance view. ,
Required: False ,
}
{
name:
{
Description: The extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "MicrosoftMonitoringAgent". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: Instance view status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. Indicates the severity or importance of the status message. ,
Enum:
{
Info: Informational message indicating normal operation. ,
Warning: Warning message indicating a potential issue or non-critical problem. ,
Error: Error message indicating a failure or critical issue. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
managedBy:
{
Description: Indicates if the extension is managed by Azure or the user. This determines who controls the deployment and lifecycle of the extension. ,
Enum:
{
User: The extension is managed by the user. ,
Azure: The extension is managed by Azure. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Extensions_Get (new)
Description :  Get particular Arc Extension of HCI Cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}/extensions/{extensionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
arcSettingName:
{
Description: The name of the proxy resource holding details of HCI ArcSetting information. ,
Required: True ,
}
string ,
extensionName:
{
Description: The name of the machine extension. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes Machine Extension Properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Extension proxy resource. Indicates the current lifecycle status of the resource, such as whether it's being created, updated, deleted, or has encountered an error. ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
extensionParameters:
{
Description: Parameters specific to this extension type. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. Latest version would be used if not specified. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
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. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
string ,
protectedSettings:
{
Description: Protected settings (may contain secrets). ,
Format: password ,
Required: False ,
}
string ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. ,
Required: False ,
}
boolean ,
}
,
aggregateState:
{
Description: Aggregate state of Arc Extensions across the nodes in this HCI cluster. This reflects the overall status of the extension deployment and operation across all nodes. ,
Enum:
{
NotSpecified: The aggregate state is not specified. ,
Error: An error occurred in the aggregate state. ,
Succeeded: The operation succeeded across all nodes. ,
Canceled: The operation was canceled across the nodes. ,
Failed: The operation failed on all or most nodes. ,
Connected: All nodes are connected. ,
Disconnected: All nodes are disconnected. ,
Deleted: The extension has been deleted from all nodes. ,
Creating: The extension is being created across the nodes. ,
Updating: The extension is being updated across the nodes. ,
Deleting: The extension is being deleted across the nodes. ,
Moving: The extension is being moved across the nodes. ,
PartiallySucceeded: The operation succeeded on some nodes. ,
PartiallyConnected: Some nodes are connected, others are not. ,
InProgress: The operation is currently in progress across the nodes. ,
Accepted: The operation has been accepted and is pending execution. ,
Provisioning: The extension is currently being provisioned across the nodes. ,
UpgradeFailedRollbackSucceeded: Extension upgrade failed, but rollback succeeded across the nodes. ,
}
,
Required: False ,
}
enum ,
perNodeExtensionDetails:
{
Description: State of Arc Extension in each of the nodes. ,
Required: False ,
}
[
{
name:
{
Description: Name of the node in HCI Cluster. ,
Required: False ,
}
string ,
extension:
{
Description: Fully qualified resource ID for the particular Arc Extension on this node. ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
state:
{
Description: State of Arc Extension in this node. Reflects the current lifecycle status of the extension on the individual node, such as whether it's being created, updated, deleted, or has encountered an error. ,
Enum:
{
NotSpecified: The state is not specified. ,
Error: An error occurred during the extension lifecycle. ,
Succeeded: The extension operation completed successfully. ,
Canceled: The extension operation was canceled. ,
Failed: The extension operation failed. ,
Connected: The extension is connected on the node. ,
Disconnected: The extension is disconnected on the node. ,
Deleted: The extension has been deleted from the node. ,
Creating: The extension is being created on the node. ,
Updating: The extension is being updated on the node. ,
Deleting: The extension is being deleted from the node. ,
Moving: The extension is being moved on the node. ,
PartiallySucceeded: The extension operation partially succeeded. ,
PartiallyConnected: The extension is partially connected on the node. ,
InProgress: The extension operation is currently in progress. ,
Accepted: The extension operation has been accepted and is pending execution. ,
Provisioning: The extension is currently being provisioned on the node. ,
}
,
Required: False ,
}
enum ,
instanceView:
{
Description: The extension instance view. ,
Required: False ,
}
{
name:
{
Description: The extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "MicrosoftMonitoringAgent". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: Instance view status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. Indicates the severity or importance of the status message. ,
Enum:
{
Info: Informational message indicating normal operation. ,
Warning: Warning message indicating a potential issue or non-critical problem. ,
Error: Error message indicating a failure or critical issue. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
managedBy:
{
Description: Indicates if the extension is managed by Azure or the user. This determines who controls the deployment and lifecycle of the extension. ,
Enum:
{
User: The extension is managed by the user. ,
Azure: The extension is managed by Azure. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Extensions_Create (new)
Description :  Create Extension for HCI cluster.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}/extensions/{extensionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
arcSettingName:
{
Description: The name of the proxy resource holding details of HCI ArcSetting information. ,
Required: True ,
}
string ,
extensionName:
{
Description: The name of the machine extension. ,
Required: True ,
}
string ,
extension:
{
Description: Details of the Machine Extension to be created. ,
Required: True ,
}
{
properties:
{
Description: Describes Machine Extension Properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Extension proxy resource. Indicates the current lifecycle status of the resource, such as whether it's being created, updated, deleted, or has encountered an error. ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
extensionParameters:
{
Description: Parameters specific to this extension type. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. Latest version would be used if not specified. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
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. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
string ,
protectedSettings:
{
Description: Protected settings (may contain secrets). ,
Format: password ,
Required: False ,
}
string ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. ,
Required: False ,
}
boolean ,
}
,
aggregateState:
{
Description: Aggregate state of Arc Extensions across the nodes in this HCI cluster. This reflects the overall status of the extension deployment and operation across all nodes. ,
Enum:
{
NotSpecified: The aggregate state is not specified. ,
Error: An error occurred in the aggregate state. ,
Succeeded: The operation succeeded across all nodes. ,
Canceled: The operation was canceled across the nodes. ,
Failed: The operation failed on all or most nodes. ,
Connected: All nodes are connected. ,
Disconnected: All nodes are disconnected. ,
Deleted: The extension has been deleted from all nodes. ,
Creating: The extension is being created across the nodes. ,
Updating: The extension is being updated across the nodes. ,
Deleting: The extension is being deleted across the nodes. ,
Moving: The extension is being moved across the nodes. ,
PartiallySucceeded: The operation succeeded on some nodes. ,
PartiallyConnected: Some nodes are connected, others are not. ,
InProgress: The operation is currently in progress across the nodes. ,
Accepted: The operation has been accepted and is pending execution. ,
Provisioning: The extension is currently being provisioned across the nodes. ,
UpgradeFailedRollbackSucceeded: Extension upgrade failed, but rollback succeeded across the nodes. ,
}
,
Required: False ,
}
enum ,
perNodeExtensionDetails:
{
Description: State of Arc Extension in each of the nodes. ,
Required: False ,
}
[
{
name:
{
Description: Name of the node in HCI Cluster. ,
Required: False ,
}
string ,
extension:
{
Description: Fully qualified resource ID for the particular Arc Extension on this node. ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
state:
{
Description: State of Arc Extension in this node. Reflects the current lifecycle status of the extension on the individual node, such as whether it's being created, updated, deleted, or has encountered an error. ,
Enum:
{
NotSpecified: The state is not specified. ,
Error: An error occurred during the extension lifecycle. ,
Succeeded: The extension operation completed successfully. ,
Canceled: The extension operation was canceled. ,
Failed: The extension operation failed. ,
Connected: The extension is connected on the node. ,
Disconnected: The extension is disconnected on the node. ,
Deleted: The extension has been deleted from the node. ,
Creating: The extension is being created on the node. ,
Updating: The extension is being updated on the node. ,
Deleting: The extension is being deleted from the node. ,
Moving: The extension is being moved on the node. ,
PartiallySucceeded: The extension operation partially succeeded. ,
PartiallyConnected: The extension is partially connected on the node. ,
InProgress: The extension operation is currently in progress. ,
Accepted: The extension operation has been accepted and is pending execution. ,
Provisioning: The extension is currently being provisioned on the node. ,
}
,
Required: False ,
}
enum ,
instanceView:
{
Description: The extension instance view. ,
Required: False ,
}
{
name:
{
Description: The extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "MicrosoftMonitoringAgent". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: Instance view status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. Indicates the severity or importance of the status message. ,
Enum:
{
Info: Informational message indicating normal operation. ,
Warning: Warning message indicating a potential issue or non-critical problem. ,
Error: Error message indicating a failure or critical issue. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
managedBy:
{
Description: Indicates if the extension is managed by Azure or the user. This determines who controls the deployment and lifecycle of the extension. ,
Enum:
{
User: The extension is managed by the user. ,
Azure: The extension is managed by Azure. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Describes Machine Extension Properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Extension proxy resource. Indicates the current lifecycle status of the resource, such as whether it's being created, updated, deleted, or has encountered an error. ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
extensionParameters:
{
Description: Parameters specific to this extension type. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. Latest version would be used if not specified. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
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. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
string ,
protectedSettings:
{
Description: Protected settings (may contain secrets). ,
Format: password ,
Required: False ,
}
string ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. ,
Required: False ,
}
boolean ,
}
,
aggregateState:
{
Description: Aggregate state of Arc Extensions across the nodes in this HCI cluster. This reflects the overall status of the extension deployment and operation across all nodes. ,
Enum:
{
NotSpecified: The aggregate state is not specified. ,
Error: An error occurred in the aggregate state. ,
Succeeded: The operation succeeded across all nodes. ,
Canceled: The operation was canceled across the nodes. ,
Failed: The operation failed on all or most nodes. ,
Connected: All nodes are connected. ,
Disconnected: All nodes are disconnected. ,
Deleted: The extension has been deleted from all nodes. ,
Creating: The extension is being created across the nodes. ,
Updating: The extension is being updated across the nodes. ,
Deleting: The extension is being deleted across the nodes. ,
Moving: The extension is being moved across the nodes. ,
PartiallySucceeded: The operation succeeded on some nodes. ,
PartiallyConnected: Some nodes are connected, others are not. ,
InProgress: The operation is currently in progress across the nodes. ,
Accepted: The operation has been accepted and is pending execution. ,
Provisioning: The extension is currently being provisioned across the nodes. ,
UpgradeFailedRollbackSucceeded: Extension upgrade failed, but rollback succeeded across the nodes. ,
}
,
Required: False ,
}
enum ,
perNodeExtensionDetails:
{
Description: State of Arc Extension in each of the nodes. ,
Required: False ,
}
[
{
name:
{
Description: Name of the node in HCI Cluster. ,
Required: False ,
}
string ,
extension:
{
Description: Fully qualified resource ID for the particular Arc Extension on this node. ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
state:
{
Description: State of Arc Extension in this node. Reflects the current lifecycle status of the extension on the individual node, such as whether it's being created, updated, deleted, or has encountered an error. ,
Enum:
{
NotSpecified: The state is not specified. ,
Error: An error occurred during the extension lifecycle. ,
Succeeded: The extension operation completed successfully. ,
Canceled: The extension operation was canceled. ,
Failed: The extension operation failed. ,
Connected: The extension is connected on the node. ,
Disconnected: The extension is disconnected on the node. ,
Deleted: The extension has been deleted from the node. ,
Creating: The extension is being created on the node. ,
Updating: The extension is being updated on the node. ,
Deleting: The extension is being deleted from the node. ,
Moving: The extension is being moved on the node. ,
PartiallySucceeded: The extension operation partially succeeded. ,
PartiallyConnected: The extension is partially connected on the node. ,
InProgress: The extension operation is currently in progress. ,
Accepted: The extension operation has been accepted and is pending execution. ,
Provisioning: The extension is currently being provisioned on the node. ,
}
,
Required: False ,
}
enum ,
instanceView:
{
Description: The extension instance view. ,
Required: False ,
}
{
name:
{
Description: The extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "MicrosoftMonitoringAgent". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: Instance view status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. Indicates the severity or importance of the status message. ,
Enum:
{
Info: Informational message indicating normal operation. ,
Warning: Warning message indicating a potential issue or non-critical problem. ,
Error: Error message indicating a failure or critical issue. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
managedBy:
{
Description: Indicates if the extension is managed by Azure or the user. This determines who controls the deployment and lifecycle of the extension. ,
Enum:
{
User: The extension is managed by the user. ,
Azure: The extension is managed by Azure. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Details of a particular extension in HCI Cluster. ,
}
{
properties:
{
Description: Describes Machine Extension Properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Extension proxy resource. Indicates the current lifecycle status of the resource, such as whether it's being created, updated, deleted, or has encountered an error. ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
extensionParameters:
{
Description: Parameters specific to this extension type. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. Latest version would be used if not specified. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
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. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
string ,
protectedSettings:
{
Description: Protected settings (may contain secrets). ,
Format: password ,
Required: False ,
}
string ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. ,
Required: False ,
}
boolean ,
}
,
aggregateState:
{
Description: Aggregate state of Arc Extensions across the nodes in this HCI cluster. This reflects the overall status of the extension deployment and operation across all nodes. ,
Enum:
{
NotSpecified: The aggregate state is not specified. ,
Error: An error occurred in the aggregate state. ,
Succeeded: The operation succeeded across all nodes. ,
Canceled: The operation was canceled across the nodes. ,
Failed: The operation failed on all or most nodes. ,
Connected: All nodes are connected. ,
Disconnected: All nodes are disconnected. ,
Deleted: The extension has been deleted from all nodes. ,
Creating: The extension is being created across the nodes. ,
Updating: The extension is being updated across the nodes. ,
Deleting: The extension is being deleted across the nodes. ,
Moving: The extension is being moved across the nodes. ,
PartiallySucceeded: The operation succeeded on some nodes. ,
PartiallyConnected: Some nodes are connected, others are not. ,
InProgress: The operation is currently in progress across the nodes. ,
Accepted: The operation has been accepted and is pending execution. ,
Provisioning: The extension is currently being provisioned across the nodes. ,
UpgradeFailedRollbackSucceeded: Extension upgrade failed, but rollback succeeded across the nodes. ,
}
,
Required: False ,
}
enum ,
perNodeExtensionDetails:
{
Description: State of Arc Extension in each of the nodes. ,
Required: False ,
}
[
{
name:
{
Description: Name of the node in HCI Cluster. ,
Required: False ,
}
string ,
extension:
{
Description: Fully qualified resource ID for the particular Arc Extension on this node. ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
state:
{
Description: State of Arc Extension in this node. Reflects the current lifecycle status of the extension on the individual node, such as whether it's being created, updated, deleted, or has encountered an error. ,
Enum:
{
NotSpecified: The state is not specified. ,
Error: An error occurred during the extension lifecycle. ,
Succeeded: The extension operation completed successfully. ,
Canceled: The extension operation was canceled. ,
Failed: The extension operation failed. ,
Connected: The extension is connected on the node. ,
Disconnected: The extension is disconnected on the node. ,
Deleted: The extension has been deleted from the node. ,
Creating: The extension is being created on the node. ,
Updating: The extension is being updated on the node. ,
Deleting: The extension is being deleted from the node. ,
Moving: The extension is being moved on the node. ,
PartiallySucceeded: The extension operation partially succeeded. ,
PartiallyConnected: The extension is partially connected on the node. ,
InProgress: The extension operation is currently in progress. ,
Accepted: The extension operation has been accepted and is pending execution. ,
Provisioning: The extension is currently being provisioned on the node. ,
}
,
Required: False ,
}
enum ,
instanceView:
{
Description: The extension instance view. ,
Required: False ,
}
{
name:
{
Description: The extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "MicrosoftMonitoringAgent". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: Instance view status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. Indicates the severity or importance of the status message. ,
Enum:
{
Info: Informational message indicating normal operation. ,
Warning: Warning message indicating a potential issue or non-critical problem. ,
Error: Error message indicating a failure or critical issue. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
managedBy:
{
Description: Indicates if the extension is managed by Azure or the user. This determines who controls the deployment and lifecycle of the extension. ,
Enum:
{
User: The extension is managed by the user. ,
Azure: The extension is managed by Azure. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Extensions_Update (new)
Description :  Update Extension for HCI cluster.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}/extensions/{extensionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
arcSettingName:
{
Description: The name of the proxy resource holding details of HCI ArcSetting information. ,
Required: True ,
}
string ,
extensionName:
{
Description: The name of the machine extension. ,
Required: True ,
}
string ,
extension:
{
Description: Details of the Machine Extension to be created. ,
Required: True ,
}
{
properties:
{
Description: Describes Machine Extension Properties that can be updated. ,
Required: False ,
}
{
extensionParameters:
{
Description: Describes the properties of a Machine Extension that can be updated. ,
Required: False ,
}
{
typeHandlerVersion:
{
Description: Specifies the version of the script handler. Latest version would be used if not specified. ,
Required: False ,
}
string ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
string ,
protectedSettings:
{
Description: Protected settings (may contain secrets). ,
Format: password ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Describes Machine Extension Properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Extension proxy resource. Indicates the current lifecycle status of the resource, such as whether it's being created, updated, deleted, or has encountered an error. ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
extensionParameters:
{
Description: Parameters specific to this extension type. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. Latest version would be used if not specified. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
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. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
string ,
protectedSettings:
{
Description: Protected settings (may contain secrets). ,
Format: password ,
Required: False ,
}
string ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. ,
Required: False ,
}
boolean ,
}
,
aggregateState:
{
Description: Aggregate state of Arc Extensions across the nodes in this HCI cluster. This reflects the overall status of the extension deployment and operation across all nodes. ,
Enum:
{
NotSpecified: The aggregate state is not specified. ,
Error: An error occurred in the aggregate state. ,
Succeeded: The operation succeeded across all nodes. ,
Canceled: The operation was canceled across the nodes. ,
Failed: The operation failed on all or most nodes. ,
Connected: All nodes are connected. ,
Disconnected: All nodes are disconnected. ,
Deleted: The extension has been deleted from all nodes. ,
Creating: The extension is being created across the nodes. ,
Updating: The extension is being updated across the nodes. ,
Deleting: The extension is being deleted across the nodes. ,
Moving: The extension is being moved across the nodes. ,
PartiallySucceeded: The operation succeeded on some nodes. ,
PartiallyConnected: Some nodes are connected, others are not. ,
InProgress: The operation is currently in progress across the nodes. ,
Accepted: The operation has been accepted and is pending execution. ,
Provisioning: The extension is currently being provisioned across the nodes. ,
UpgradeFailedRollbackSucceeded: Extension upgrade failed, but rollback succeeded across the nodes. ,
}
,
Required: False ,
}
enum ,
perNodeExtensionDetails:
{
Description: State of Arc Extension in each of the nodes. ,
Required: False ,
}
[
{
name:
{
Description: Name of the node in HCI Cluster. ,
Required: False ,
}
string ,
extension:
{
Description: Fully qualified resource ID for the particular Arc Extension on this node. ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
state:
{
Description: State of Arc Extension in this node. Reflects the current lifecycle status of the extension on the individual node, such as whether it's being created, updated, deleted, or has encountered an error. ,
Enum:
{
NotSpecified: The state is not specified. ,
Error: An error occurred during the extension lifecycle. ,
Succeeded: The extension operation completed successfully. ,
Canceled: The extension operation was canceled. ,
Failed: The extension operation failed. ,
Connected: The extension is connected on the node. ,
Disconnected: The extension is disconnected on the node. ,
Deleted: The extension has been deleted from the node. ,
Creating: The extension is being created on the node. ,
Updating: The extension is being updated on the node. ,
Deleting: The extension is being deleted from the node. ,
Moving: The extension is being moved on the node. ,
PartiallySucceeded: The extension operation partially succeeded. ,
PartiallyConnected: The extension is partially connected on the node. ,
InProgress: The extension operation is currently in progress. ,
Accepted: The extension operation has been accepted and is pending execution. ,
Provisioning: The extension is currently being provisioned on the node. ,
}
,
Required: False ,
}
enum ,
instanceView:
{
Description: The extension instance view. ,
Required: False ,
}
{
name:
{
Description: The extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "MicrosoftMonitoringAgent". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: Instance view status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. Indicates the severity or importance of the status message. ,
Enum:
{
Info: Informational message indicating normal operation. ,
Warning: Warning message indicating a potential issue or non-critical problem. ,
Error: Error message indicating a failure or critical issue. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
managedBy:
{
Description: Indicates if the extension is managed by Azure or the user. This determines who controls the deployment and lifecycle of the extension. ,
Enum:
{
User: The extension is managed by the user. ,
Azure: The extension is managed by Azure. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Extensions_Delete (new)
Description :  Delete particular Arc Extension of HCI Cluster.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}/extensions/{extensionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
arcSettingName:
{
Description: The name of the proxy resource holding details of HCI ArcSetting information. ,
Required: True ,
}
string ,
extensionName:
{
Description: The name of the machine extension. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Extensions_Upgrade (new)
Description :  Upgrade a particular Arc Extension of HCI Cluster.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}/extensions/{extensionName}/upgrade
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
arcSettingName:
{
Description: The name of the proxy resource holding details of HCI ArcSetting information. ,
Required: True ,
}
string ,
extensionName:
{
Description: The name of the machine extension. ,
Required: True ,
}
string ,
extensionUpgradeParameters:
{
Description: Parameters supplied to the Upgrade Extensions operation. ,
Required: True ,
}
{
targetVersion:
{
Description: Extension Upgrade Target Version. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ArcSettings_GeneratePassword (new)
Description :  Generate password for arc settings.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}/generatePassword
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
arcSettingName:
{
Description: The name of the proxy resource holding details of HCI ArcSetting information. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
secretText:
{
Required: False ,
}
string ,
keyId:
{
Required: False ,
}
string ,
startDateTime:
{
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ArcSettings_InitializeDisableProcess (new)
Description :  Initializes ARC Disable process on the cluster
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}/initializeDisableProcess
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
arcSettingName:
{
Description: The name of the proxy resource holding details of HCI ArcSetting information. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ArcSettings_Reconcile (new)
Description :  Reconcile Arc Settings with information related to all nodes.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}/reconcile
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
arcSettingName:
{
Description: The name of the proxy resource holding details of HCI ArcSetting information. ,
Required: True ,
}
string ,
reconcileArcSettingsRequest:
{
Description: Request for reconciling Arc Settings. ,
Required: True ,
}
{
properties:
{
Description: List of Arc Nodes in the cluster ,
Required: False ,
}
{
clusterNodes:
{
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: ArcSetting properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the ArcSetting proxy resource. ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
arcInstanceResourceGroup:
{
Description: The resource group that hosts the Arc agents, ie. Hybrid Compute Machine resources. ,
Required: False ,
}
string ,
arcApplicationClientId:
{
Description: App id of arc AAD identity. ,
Required: False ,
}
string ,
arcApplicationTenantId:
{
Description: Tenant id of arc AAD identity. ,
Required: False ,
}
string ,
arcServicePrincipalObjectId:
{
Description: Object id of arc AAD service principal. ,
Required: False ,
}
string ,
arcApplicationObjectId:
{
Description: Object id of arc AAD identity. ,
Required: False ,
}
string ,
aggregateState:
{
Description: Aggregate state of Arc agent across the nodes in this HCI cluster. ,
Enum:
{
NotSpecified: The aggregate state is not specified. ,
Error: An error occurred in the aggregate state. ,
Succeeded: The operation successfully completed across all nodes. ,
Canceled: The operation was canceled across the nodes. ,
Failed: The operation failed on all or most nodes. ,
Connected: All nodes are connected. ,
Disconnected: All nodes are disconnected. ,
Deleted: The Arc agent has been deleted from all nodes. ,
Creating: The Arc agent is being created across the nodes. ,
Updating: The Arc agent is being updated across the nodes. ,
Deleting: The Arc agent is being deleted across the nodes. ,
Moving: The Arc agent is being moved across the nodes. ,
PartiallySucceeded: The operation succeeded on some nodes. ,
PartiallyConnected: Some nodes are connected, others are not. ,
InProgress: The operation is currently in progress across the nodes. ,
Accepted: The operation has been accepted and is pending execution. ,
Provisioning: The Arc agent is being provisioned across the nodes. ,
DisableInProgress: The Arc agent is being disabled across the nodes. ,
}
,
Required: False ,
}
enum ,
perNodeDetails:
{
Description: State of Arc agent in each of the nodes. ,
Required: False ,
}
[
{
name:
{
Description: Name of the Node in HCI Cluster ,
Required: False ,
}
string ,
arcInstance:
{
Description: Fully qualified resource ID for the Arc agent of this node. ,
Required: False ,
}
string ,
arcNodeServicePrincipalObjectId:
{
Description: The service principal id of the arc for server node ,
Required: False ,
}
string ,
state:
{
Description: State of the Arc agent in this node. Indicates the current lifecycle status of the agent, such as whether it's being provisioned, connected, updated, or has encountered an error. ,
Enum:
{
NotSpecified: The state is not specified. ,
Error: An error occurred during the agent's lifecycle. ,
Succeeded: The operation completed successfully. ,
Canceled: The operation was canceled before completion. ,
Failed: The operation failed. ,
Connected: The Arc agent is connected on this node. ,
Disconnected: The Arc agent is disconnected on this node. ,
Deleted: The Arc agent has been deleted from this node. ,
Creating: The Arc agent is being created on this node. ,
Updating: The Arc agent is being updated on this node. ,
Deleting: The Arc agent is being deleted from this node. ,
Moving: The Arc agent is being moved on this node. ,
PartiallySucceeded: The operation partially succeeded. ,
PartiallyConnected: The Arc agent is partially connected on this node. ,
InProgress: The operation is currently in progress. ,
Accepted: The operation has been accepted and is pending execution. ,
Provisioning: The Arc agent is currently being provisioned on this node. ,
DisableInProgress: The Arc agent is in the process of being disabled on this node. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
connectivityProperties:
{
Description: contains connectivity related configuration for ARC resources ,
Required: False ,
}
{
enabled:
{
Description: True indicates ARC connectivity is enabled ,
Required: False ,
}
boolean ,
serviceConfigurations:
{
Description: Service configurations associated with the connectivity resource. They are only processed by the server if 'enabled' property is set to 'true'. ,
Required: False ,
}
[
{
serviceName:
{
Description: Specifies the name of the service associated with the update or operation. This helps identify which system component or tool is involved. ,
Enum:
{
WAC: Windows Admin Center (WAC) is the service associated with this operation. ,
}
,
Required: True ,
}
enum ,
port:
{
Description: The port on which service is enabled. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
defaultExtensions:
{
Description: Properties for each of the default extensions category ,
Required: False ,
}
[
{
category:
{
Description: Default extension category ,
Required: False ,
}
string ,
consentTime:
{
Description: Consent time for extension category ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_ChangeRing (new)
Description :  Changes ring of a cluster
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/changeRing
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
changeRingRequest:
{
Description: Change ring request payload ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
targetRing:
{
Description: The target ring for the cluster. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Cluster properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state. Indicates the current lifecycle status of the resource, including creation, update, deletion, connectivity, and error states. ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Status of the cluster agent. Indicates the current connectivity, validation, and deployment state of the agent within the cluster. ,
Enum:
{
NotYetRegistered: The cluster agent has not yet registered with Azure. ,
ConnectedRecently: The cluster agent has connected to Azure recently. ,
NotConnectedRecently: The cluster agent has not connected to Azure recently. ,
Disconnected: The cluster agent is currently disconnected from Azure. ,
Error: An error occurred in the cluster agent's operation. ,
NotSpecified: The status of the cluster agent is not specified. ,
ValidationInProgress: Validation of the cluster agent is currently in progress. ,
ValidationSuccess: Validation of the cluster agent completed successfully. ,
ValidationFailed: Validation of the cluster agent failed. ,
DeploymentInProgress: Deployment of the cluster agent is currently in progress. ,
DeploymentFailed: Deployment of the cluster agent failed. ,
DeploymentSuccess: Deployment of the cluster agent completed successfully. ,
}
,
Required: False ,
}
enum ,
connectivityStatus:
{
Description: Overall connectivity status for the cluster resource. Indicates whether the cluster is connected to Azure, partially connected, or has not recently communicated. ,
Enum:
{
NotYetRegistered: The cluster has not yet registered with Azure. ,
Connected: The cluster is fully connected to Azure. ,
NotConnectedRecently: The cluster has not connected to Azure recently. ,
PartiallyConnected: Some components of the cluster are connected, while others are not. ,
Disconnected: The cluster is not connected to Azure. ,
NotSpecified: The connectivity status is not specified. ,
}
,
Required: False ,
}
enum ,
supportStatus:
{
Description: Indicates whether the cluster is under support. ,
Enum:
{
InSupport: The cluster is under support. ,
OutOfSupport: The cluster is out of support. ,
NotSpecified: The support status is not specified. ,
}
,
Required: False ,
}
enum ,
cloudId:
{
Description: Unique, immutable resource id. ,
Required: False ,
}
string ,
ring:
{
Description: The ring to which this cluster belongs to. ,
Required: False ,
}
string ,
cloudManagementEndpoint:
{
Description: Endpoint configured for management from the Azure portal. ,
Required: False ,
}
string ,
aadClientId:
{
Description: App id of cluster AAD identity. ,
Required: False ,
}
string ,
aadTenantId:
{
Description: Tenant id of cluster AAD identity. ,
Required: False ,
}
string ,
aadApplicationObjectId:
{
Description: Object id of cluster AAD identity. ,
Required: False ,
}
string ,
aadServicePrincipalObjectId:
{
Description: Id of cluster identity service principal. ,
Required: False ,
}
string ,
softwareAssuranceProperties:
{
Description: Software Assurance properties of the cluster. ,
Required: False ,
}
{
softwareAssuranceStatus:
{
Description: Status of the Software Assurance for the cluster. ,
Enum:
{
Enabled: Software Assurance is enabled for the cluster. ,
Disabled: Software Assurance is disabled for the cluster. ,
}
,
Required: False ,
}
enum ,
softwareAssuranceIntent:
{
Description: Customer Intent for Software Assurance Benefit. ,
Enum:
{
Enable: Customer intends to enable the Software Assurance benefit. ,
Disable: Customer intends to disable the Software Assurance benefit. ,
}
,
Required: False ,
}
enum ,
lastUpdated:
{
Description: TimeStamp denoting the latest SA benefit applicability is validated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
isManagementCluster:
{
Description: Is Management Cluster, when true indicates that the cluster is used for managing other clusters ,
Required: False ,
}
boolean ,
logCollectionProperties:
{
Description: Log Collection properties of the cluster. ,
Required: False ,
}
{
fromDate:
{
Description: From DateTimeStamp from when logs need to be connected ,
Format: date-time ,
Required: False ,
}
string ,
toDate:
{
Description: To DateTimeStamp till when logs need to be connected ,
Format: date-time ,
Required: False ,
}
string ,
lastLogGenerated:
{
Description: Recent DateTimeStamp where logs are successfully generated ,
Format: date-time ,
Required: False ,
}
string ,
logCollectionSessionDetails:
{
Required: False ,
}
[
{
logStartTime:
{
Description: Start Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
logEndTime:
{
Description: End Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
timeCollected:
{
Description: Duration of logs collected ,
Format: date-time ,
Required: False ,
}
string ,
logSize:
{
Description: Size of the logs collected ,
Format: int64 ,
Required: False ,
}
integer ,
logCollectionStatus:
{
Description: LogCollection status ,
Enum:
{
None: No log collection has been initiated. ,
InProgress: Log collection is currently in progress. ,
Failed: Log collection has failed. ,
Succeeded: Log collection completed successfully. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: CorrelationId of the log collection ,
Required: False ,
}
string ,
logCollectionJobType:
{
Description: Specifies the type of log collection job. Determines whether the logs are collected immediately on demand or as part of a scheduled operation. ,
Enum:
{
OnDemand: Log collection is triggered manually and executed immediately. ,
Scheduled: Log collection is scheduled to run at a predefined time or interval. ,
}
,
Required: False ,
}
enum ,
endTimeCollected:
{
Description: End Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
logCollectionError:
{
Description: Log Collection Error details of the cluster. ,
Required: False ,
}
{
errorCode:
{
Description: Error Code of the log collection ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error Message of the log collection ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
remoteSupportProperties:
{
Description: RemoteSupport properties of the cluster. ,
Required: False ,
}
{
accessLevel:
{
Description: Remote Support Access Level ,
Enum:
{
Diagnostics: Allows remote diagnostics operations only. ,
DiagnosticsAndRepair: Allows both remote diagnostics and repair operations. ,
}
,
Required: False ,
}
enum ,
expirationTimeStamp:
{
Description: Expiration DateTimeStamp when Remote Support Access will be expired ,
Format: date-time ,
Required: False ,
}
string ,
remoteSupportType:
{
Description: Remote Support Type for cluster ,
Enum:
{
Enable: Enable remote support for the cluster. ,
Revoke: Revoke previously enabled remote support for the cluster. ,
}
,
Required: False ,
}
enum ,
remoteSupportNodeSettings:
{
Required: False ,
}
[
{
arcResourceId:
{
Description: Arc ResourceId of the Node ,
Required: False ,
}
string ,
state:
{
Description: Remote Support Access Connection State on the Node ,
Required: False ,
}
string ,
createdAt:
{
Description: Remote Support Enablement Request Created TimeStamp on the Node ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: Remote Support Enablement Request Updated TimeStamp on the Node ,
Format: date-time ,
Required: False ,
}
string ,
connectionStatus:
{
Description: Remote Support Access Connection Status on the Node ,
Required: False ,
}
string ,
connectionErrorMessage:
{
Description: Remote Support Access Connection Error Message on the Node ,
Required: False ,
}
string ,
transcriptLocation:
{
Description: Remote Support Transcript location on the node ,
Required: False ,
}
string ,
}
,
]
,
remoteSupportSessionDetails:
{
Required: False ,
}
[
{
sessionStartTime:
{
Description: Remote Support Session StartTime on the Node ,
Format: date-time ,
Required: False ,
}
string ,
sessionEndTime:
{
Description: Remote Support Session EndTime on the Node ,
Format: date-time ,
Required: False ,
}
string ,
nodeName:
{
Description: Name of the node ,
Required: False ,
}
string ,
duration:
{
Description: Duration of Remote Support Enablement ,
Format: int64 ,
Required: False ,
}
integer ,
accessLevel:
{
Description: Remote Support Access Level ,
Enum:
{
Diagnostics: Allows remote diagnostics operations only. ,
DiagnosticsAndRepair: Allows both remote diagnostics and repair operations. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
desiredProperties:
{
Description: Desired properties of the cluster. ,
Required: False ,
}
{
windowsServerSubscription:
{
Description: Desired state of Windows Server Subscription. ,
Enum:
{
Disabled: Windows Server Subscription is disabled. ,
Enabled: Windows Server Subscription is enabled. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Desired level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No diagnostic data will be emitted. ,
Basic: Basic diagnostic data will be emitted, including essential health metrics. ,
Enhanced: Enhanced diagnostic data will be emitted, including detailed performance and usage metrics. ,
}
,
Required: False ,
}
enum ,
}
,
reportedProperties:
{
Description: Properties reported by cluster agent. ,
Required: False ,
}
{
clusterName:
{
Description: Name of the on-prem cluster connected to this resource. ,
Required: False ,
}
string ,
clusterId:
{
Description: Unique id generated by the on-prem cluster. ,
Required: False ,
}
string ,
clusterVersion:
{
Description: Version of the cluster software. ,
Required: False ,
}
string ,
nodes:
{
Description: List of nodes reported by the cluster. ,
Required: False ,
}
[
{
name:
{
Description: Name of the cluster node. ,
Required: False ,
}
string ,
id:
{
Description: Id of the node in the cluster. ,
Format: float ,
Required: False ,
}
number ,
windowsServerSubscription:
{
Description: State of Windows Server Subscription. ,
Enum:
{
Disabled: Windows Server Subscription is disabled. ,
Enabled: Windows Server Subscription is enabled. ,
}
,
Required: False ,
}
enum ,
nodeType:
{
Description: Type of the cluster node hardware. ,
Enum:
{
FirstParty: All nodes in the cluster are provided and managed by Microsoft. ,
ThirdParty: All nodes in the cluster are provided and managed by a third-party vendor. ,
}
,
Required: False ,
}
enum ,
ehcResourceId:
{
Description: Edge Hardware Center Resource Id ,
Required: False ,
}
string ,
manufacturer:
{
Description: Manufacturer of the cluster node hardware. ,
Required: False ,
}
string ,
model:
{
Description: Model name of the cluster node hardware. ,
Required: False ,
}
string ,
osName:
{
Description: Operating system running on the cluster node. ,
Required: False ,
}
string ,
osVersion:
{
Description: Version of the operating system running on the cluster node. ,
Required: False ,
}
string ,
osDisplayVersion:
{
Description: Display version of the operating system running on the cluster node. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Immutable id of the cluster node. ,
Required: False ,
}
string ,
coreCount:
{
Description: Number of physical cores on the cluster node. ,
Format: float ,
Required: False ,
}
number ,
memoryInGiB:
{
Description: Total available memory on the cluster node (in GiB). ,
Format: float ,
Required: False ,
}
number ,
lastLicensingTimestamp:
{
Description: Most recent licensing timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
oemActivation:
{
Description: OEM activation status of the node. ,
Enum:
{
Disabled: OEM activation is disabled for the cluster. ,
Enabled: OEM activation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
lastUpdated:
{
Description: Last time the cluster reported the data. ,
Format: date-time ,
Required: False ,
}
string ,
msiExpirationTimeStamp:
{
Description: Specifies the expiration timestamp of the cluster's Managed Service Identity (MSI). The value is expressed in Coordinated Universal Time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
imdsAttestation:
{
Description: IMDS attestation status of the cluster. ,
Enum:
{
Disabled: IMDS attestation is disabled for the cluster. ,
Enabled: IMDS attestation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No diagnostic data will be emitted. ,
Basic: Basic diagnostic data will be emitted, including essential health metrics. ,
Enhanced: Enhanced diagnostic data will be emitted, including detailed performance and usage metrics. ,
}
,
Required: False ,
}
enum ,
supportedCapabilities:
{
Description: Capabilities supported by the cluster. ,
Required: False ,
}
[
string ,
]
,
clusterType:
{
Description: Specifies the type of hardware vendor for all nodes in the cluster. Indicates whether the nodes are provided by Microsoft or a third-party vendor. ,
Enum:
{
FirstParty: All nodes in the cluster are provided and managed by Microsoft. ,
ThirdParty: All nodes in the cluster are provided and managed by a third-party vendor. ,
}
,
Required: False ,
}
enum ,
manufacturer:
{
Description: The manufacturer of all the nodes of the cluster. ,
Required: False ,
}
string ,
oemActivation:
{
Description: OEM activation status of the cluster. ,
Enum:
{
Disabled: OEM activation is disabled for the cluster. ,
Enabled: OEM activation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
hardwareClass:
{
Description: Hardware class of the cluster. ,
Enum:
{
Small: The hardware class is small. ,
Medium: The hardware class is medium. This corresponds to the default ,
Large: The hardware class is large. ,
}
,
Required: False ,
}
enum ,
}
,
isolatedVmAttestationConfiguration:
{
Description: Attestation configurations for isolated VM (e.g. TVM, CVM) of the cluster. ,
Required: False ,
}
{
attestationResourceId:
{
Description: Fully qualified Azure resource id of the Microsoft Azure attestation resource associated with this cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
relyingPartyServiceEndpoint:
{
Description: Region specific endpoint for relying party service. ,
Required: False ,
}
string ,
attestationServiceEndpoint:
{
Description: Region specific endpoint for Microsoft Azure Attestation service for the cluster ,
Required: False ,
}
string ,
}
,
trialDaysRemaining:
{
Description: Number of days remaining in the trial period. ,
Format: float ,
Required: False ,
}
number ,
billingModel:
{
Description: Type of billing applied to the resource. ,
Required: False ,
}
string ,
registrationTimestamp:
{
Description: First cluster sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncTimestamp:
{
Description: Most recent cluster sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastBillingTimestamp:
{
Description: Most recent billing meter timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
serviceEndpoint:
{
Description: Region specific DataPath Endpoint of the cluster. ,
Required: False ,
}
string ,
resourceProviderObjectId:
{
Description: Object id of RP Service Principal ,
Required: False ,
}
string ,
secretsLocations:
{
Description: List of secret locations. ,
Required: False ,
}
[
{
secretsType:
{
Description: Type of secrets to store ,
Enum:
{
BackupSecrets: Backup secrets type ,
}
,
Required: True ,
}
enum ,
secretsLocation:
{
Description: secrets location ,
Required: True ,
}
string ,
}
,
]
,
clusterPattern:
{
Description: Supported Storage Type for HCI Cluster ,
Enum:
{
Standard: Standard cluster. ,
RackAware: RackAware cluster. ,
}
,
Required: False ,
}
enum ,
confidentialVmProperties:
{
Description: Represents the Confidential Virtual Machine (CVM) support intent and current status for the cluster resource. ,
Required: False ,
}
{
confidentialVmIntent:
{
Description: Captures the customer's intent to enable or disable CVM support on the cluster, either during initial deployment (Day-0) or at a later stage (Day-N). ,
Enum:
{
Enable: Indicates that the customer intends to enable CVM support on the cluster. ,
Disable: Indicates that the customer intends to disable CVM support on the cluster. ,
}
,
Required: False ,
}
enum ,
confidentialVmStatus:
{
Description: Captures the current status of CVM support on the cluster. ,
Enum:
{
Enabled: CVM support is fully enabled on the cluster. All nodes are CVM capable. ,
PartiallyEnabled: CVM support is partially enabled. At least one node in the cluster is CVM capable. ,
Disabled: CVM support is disabled. None of the nodes in the cluster are CVM capable. ,
}
,
Required: False ,
}
enum ,
confidentialVmStatusSummary:
{
Description: Additional context about CVM support on the cluster, such as reasons for partial enablement or hardware constraints. ,
Required: False ,
}
string ,
}
,
sdnProperties:
{
Description: Software Defined Networking Properties of the cluster ,
Required: False ,
}
{
sdnIntegrationIntent:
{
Description: Indicates whether Software Defined Networking (SDN) integration should be enabled or disabled for this deployment. ,
Enum:
{
Enable: Enable SDN integration for the deployment. ,
Disable: Disable SDN integration for the deployment. ,
}
,
Required: False ,
}
enum ,
}
,
localAvailabilityZones:
{
Description: Local Availability Zone information for HCI cluster ,
Required: False ,
}
[
{
localAvailabilityZoneName:
{
Description: Local Availability Zone name for HCI cluster ,
Required: False ,
}
string ,
nodes:
{
Description: Nodes belonging to a particular zone ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
identityProvider:
{
Description: Identity Provider for the cluster ,
Enum:
{
ActiveDirectory: Uses Active Directory as the identity provider, enabling domain-based authentication and centralized identity management. This is the default option. ,
LocalIdentity: Uses a local identity system integrated with Azure Key Vault for authentication. Suitable for AD-less environments where Active Directory is not available or required. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
kind:
{
Description: This property identifies the purpose of the Cluster deployment. For example, a valid value is AzureLocal ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_ConfigureRemoteSupport (new)
Description :  Configure RemoteSupport on a cluster
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/configureRemoteSupport
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
remoteSupportRequest:
{
Description: Configure Remote Support Request Payload ,
Required: True ,
}
{
properties:
{
Description: Properties for Remote Support Request ,
Required: False ,
}
{
accessLevel:
{
Description: Remote Support Access Level ,
Enum:
{
Diagnostics: Allows remote diagnostics operations only. ,
DiagnosticsAndRepair: Allows both remote diagnostics and repair operations. ,
}
,
Required: False ,
}
enum ,
expirationTimeStamp:
{
Description: Expiration DateTimeStamp when Remote Support Access will be expired ,
Format: date-time ,
Required: False ,
}
string ,
remoteSupportType:
{
Description: Remote Support Type for cluster ,
Enum:
{
Enable: Enable remote support for the cluster. ,
Revoke: Revoke previously enabled remote support for the cluster. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Cluster properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state. Indicates the current lifecycle status of the resource, including creation, update, deletion, connectivity, and error states. ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Status of the cluster agent. Indicates the current connectivity, validation, and deployment state of the agent within the cluster. ,
Enum:
{
NotYetRegistered: The cluster agent has not yet registered with Azure. ,
ConnectedRecently: The cluster agent has connected to Azure recently. ,
NotConnectedRecently: The cluster agent has not connected to Azure recently. ,
Disconnected: The cluster agent is currently disconnected from Azure. ,
Error: An error occurred in the cluster agent's operation. ,
NotSpecified: The status of the cluster agent is not specified. ,
ValidationInProgress: Validation of the cluster agent is currently in progress. ,
ValidationSuccess: Validation of the cluster agent completed successfully. ,
ValidationFailed: Validation of the cluster agent failed. ,
DeploymentInProgress: Deployment of the cluster agent is currently in progress. ,
DeploymentFailed: Deployment of the cluster agent failed. ,
DeploymentSuccess: Deployment of the cluster agent completed successfully. ,
}
,
Required: False ,
}
enum ,
connectivityStatus:
{
Description: Overall connectivity status for the cluster resource. Indicates whether the cluster is connected to Azure, partially connected, or has not recently communicated. ,
Enum:
{
NotYetRegistered: The cluster has not yet registered with Azure. ,
Connected: The cluster is fully connected to Azure. ,
NotConnectedRecently: The cluster has not connected to Azure recently. ,
PartiallyConnected: Some components of the cluster are connected, while others are not. ,
Disconnected: The cluster is not connected to Azure. ,
NotSpecified: The connectivity status is not specified. ,
}
,
Required: False ,
}
enum ,
supportStatus:
{
Description: Indicates whether the cluster is under support. ,
Enum:
{
InSupport: The cluster is under support. ,
OutOfSupport: The cluster is out of support. ,
NotSpecified: The support status is not specified. ,
}
,
Required: False ,
}
enum ,
cloudId:
{
Description: Unique, immutable resource id. ,
Required: False ,
}
string ,
ring:
{
Description: The ring to which this cluster belongs to. ,
Required: False ,
}
string ,
cloudManagementEndpoint:
{
Description: Endpoint configured for management from the Azure portal. ,
Required: False ,
}
string ,
aadClientId:
{
Description: App id of cluster AAD identity. ,
Required: False ,
}
string ,
aadTenantId:
{
Description: Tenant id of cluster AAD identity. ,
Required: False ,
}
string ,
aadApplicationObjectId:
{
Description: Object id of cluster AAD identity. ,
Required: False ,
}
string ,
aadServicePrincipalObjectId:
{
Description: Id of cluster identity service principal. ,
Required: False ,
}
string ,
softwareAssuranceProperties:
{
Description: Software Assurance properties of the cluster. ,
Required: False ,
}
{
softwareAssuranceStatus:
{
Description: Status of the Software Assurance for the cluster. ,
Enum:
{
Enabled: Software Assurance is enabled for the cluster. ,
Disabled: Software Assurance is disabled for the cluster. ,
}
,
Required: False ,
}
enum ,
softwareAssuranceIntent:
{
Description: Customer Intent for Software Assurance Benefit. ,
Enum:
{
Enable: Customer intends to enable the Software Assurance benefit. ,
Disable: Customer intends to disable the Software Assurance benefit. ,
}
,
Required: False ,
}
enum ,
lastUpdated:
{
Description: TimeStamp denoting the latest SA benefit applicability is validated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
isManagementCluster:
{
Description: Is Management Cluster, when true indicates that the cluster is used for managing other clusters ,
Required: False ,
}
boolean ,
logCollectionProperties:
{
Description: Log Collection properties of the cluster. ,
Required: False ,
}
{
fromDate:
{
Description: From DateTimeStamp from when logs need to be connected ,
Format: date-time ,
Required: False ,
}
string ,
toDate:
{
Description: To DateTimeStamp till when logs need to be connected ,
Format: date-time ,
Required: False ,
}
string ,
lastLogGenerated:
{
Description: Recent DateTimeStamp where logs are successfully generated ,
Format: date-time ,
Required: False ,
}
string ,
logCollectionSessionDetails:
{
Required: False ,
}
[
{
logStartTime:
{
Description: Start Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
logEndTime:
{
Description: End Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
timeCollected:
{
Description: Duration of logs collected ,
Format: date-time ,
Required: False ,
}
string ,
logSize:
{
Description: Size of the logs collected ,
Format: int64 ,
Required: False ,
}
integer ,
logCollectionStatus:
{
Description: LogCollection status ,
Enum:
{
None: No log collection has been initiated. ,
InProgress: Log collection is currently in progress. ,
Failed: Log collection has failed. ,
Succeeded: Log collection completed successfully. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: CorrelationId of the log collection ,
Required: False ,
}
string ,
logCollectionJobType:
{
Description: Specifies the type of log collection job. Determines whether the logs are collected immediately on demand or as part of a scheduled operation. ,
Enum:
{
OnDemand: Log collection is triggered manually and executed immediately. ,
Scheduled: Log collection is scheduled to run at a predefined time or interval. ,
}
,
Required: False ,
}
enum ,
endTimeCollected:
{
Description: End Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
logCollectionError:
{
Description: Log Collection Error details of the cluster. ,
Required: False ,
}
{
errorCode:
{
Description: Error Code of the log collection ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error Message of the log collection ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
remoteSupportProperties:
{
Description: RemoteSupport properties of the cluster. ,
Required: False ,
}
{
accessLevel:
{
Description: Remote Support Access Level ,
Enum:
{
Diagnostics: Allows remote diagnostics operations only. ,
DiagnosticsAndRepair: Allows both remote diagnostics and repair operations. ,
}
,
Required: False ,
}
enum ,
expirationTimeStamp:
{
Description: Expiration DateTimeStamp when Remote Support Access will be expired ,
Format: date-time ,
Required: False ,
}
string ,
remoteSupportType:
{
Description: Remote Support Type for cluster ,
Enum:
{
Enable: Enable remote support for the cluster. ,
Revoke: Revoke previously enabled remote support for the cluster. ,
}
,
Required: False ,
}
enum ,
remoteSupportNodeSettings:
{
Required: False ,
}
[
{
arcResourceId:
{
Description: Arc ResourceId of the Node ,
Required: False ,
}
string ,
state:
{
Description: Remote Support Access Connection State on the Node ,
Required: False ,
}
string ,
createdAt:
{
Description: Remote Support Enablement Request Created TimeStamp on the Node ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: Remote Support Enablement Request Updated TimeStamp on the Node ,
Format: date-time ,
Required: False ,
}
string ,
connectionStatus:
{
Description: Remote Support Access Connection Status on the Node ,
Required: False ,
}
string ,
connectionErrorMessage:
{
Description: Remote Support Access Connection Error Message on the Node ,
Required: False ,
}
string ,
transcriptLocation:
{
Description: Remote Support Transcript location on the node ,
Required: False ,
}
string ,
}
,
]
,
remoteSupportSessionDetails:
{
Required: False ,
}
[
{
sessionStartTime:
{
Description: Remote Support Session StartTime on the Node ,
Format: date-time ,
Required: False ,
}
string ,
sessionEndTime:
{
Description: Remote Support Session EndTime on the Node ,
Format: date-time ,
Required: False ,
}
string ,
nodeName:
{
Description: Name of the node ,
Required: False ,
}
string ,
duration:
{
Description: Duration of Remote Support Enablement ,
Format: int64 ,
Required: False ,
}
integer ,
accessLevel:
{
Description: Remote Support Access Level ,
Enum:
{
Diagnostics: Allows remote diagnostics operations only. ,
DiagnosticsAndRepair: Allows both remote diagnostics and repair operations. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
desiredProperties:
{
Description: Desired properties of the cluster. ,
Required: False ,
}
{
windowsServerSubscription:
{
Description: Desired state of Windows Server Subscription. ,
Enum:
{
Disabled: Windows Server Subscription is disabled. ,
Enabled: Windows Server Subscription is enabled. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Desired level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No diagnostic data will be emitted. ,
Basic: Basic diagnostic data will be emitted, including essential health metrics. ,
Enhanced: Enhanced diagnostic data will be emitted, including detailed performance and usage metrics. ,
}
,
Required: False ,
}
enum ,
}
,
reportedProperties:
{
Description: Properties reported by cluster agent. ,
Required: False ,
}
{
clusterName:
{
Description: Name of the on-prem cluster connected to this resource. ,
Required: False ,
}
string ,
clusterId:
{
Description: Unique id generated by the on-prem cluster. ,
Required: False ,
}
string ,
clusterVersion:
{
Description: Version of the cluster software. ,
Required: False ,
}
string ,
nodes:
{
Description: List of nodes reported by the cluster. ,
Required: False ,
}
[
{
name:
{
Description: Name of the cluster node. ,
Required: False ,
}
string ,
id:
{
Description: Id of the node in the cluster. ,
Format: float ,
Required: False ,
}
number ,
windowsServerSubscription:
{
Description: State of Windows Server Subscription. ,
Enum:
{
Disabled: Windows Server Subscription is disabled. ,
Enabled: Windows Server Subscription is enabled. ,
}
,
Required: False ,
}
enum ,
nodeType:
{
Description: Type of the cluster node hardware. ,
Enum:
{
FirstParty: All nodes in the cluster are provided and managed by Microsoft. ,
ThirdParty: All nodes in the cluster are provided and managed by a third-party vendor. ,
}
,
Required: False ,
}
enum ,
ehcResourceId:
{
Description: Edge Hardware Center Resource Id ,
Required: False ,
}
string ,
manufacturer:
{
Description: Manufacturer of the cluster node hardware. ,
Required: False ,
}
string ,
model:
{
Description: Model name of the cluster node hardware. ,
Required: False ,
}
string ,
osName:
{
Description: Operating system running on the cluster node. ,
Required: False ,
}
string ,
osVersion:
{
Description: Version of the operating system running on the cluster node. ,
Required: False ,
}
string ,
osDisplayVersion:
{
Description: Display version of the operating system running on the cluster node. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Immutable id of the cluster node. ,
Required: False ,
}
string ,
coreCount:
{
Description: Number of physical cores on the cluster node. ,
Format: float ,
Required: False ,
}
number ,
memoryInGiB:
{
Description: Total available memory on the cluster node (in GiB). ,
Format: float ,
Required: False ,
}
number ,
lastLicensingTimestamp:
{
Description: Most recent licensing timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
oemActivation:
{
Description: OEM activation status of the node. ,
Enum:
{
Disabled: OEM activation is disabled for the cluster. ,
Enabled: OEM activation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
lastUpdated:
{
Description: Last time the cluster reported the data. ,
Format: date-time ,
Required: False ,
}
string ,
msiExpirationTimeStamp:
{
Description: Specifies the expiration timestamp of the cluster's Managed Service Identity (MSI). The value is expressed in Coordinated Universal Time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
imdsAttestation:
{
Description: IMDS attestation status of the cluster. ,
Enum:
{
Disabled: IMDS attestation is disabled for the cluster. ,
Enabled: IMDS attestation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No diagnostic data will be emitted. ,
Basic: Basic diagnostic data will be emitted, including essential health metrics. ,
Enhanced: Enhanced diagnostic data will be emitted, including detailed performance and usage metrics. ,
}
,
Required: False ,
}
enum ,
supportedCapabilities:
{
Description: Capabilities supported by the cluster. ,
Required: False ,
}
[
string ,
]
,
clusterType:
{
Description: Specifies the type of hardware vendor for all nodes in the cluster. Indicates whether the nodes are provided by Microsoft or a third-party vendor. ,
Enum:
{
FirstParty: All nodes in the cluster are provided and managed by Microsoft. ,
ThirdParty: All nodes in the cluster are provided and managed by a third-party vendor. ,
}
,
Required: False ,
}
enum ,
manufacturer:
{
Description: The manufacturer of all the nodes of the cluster. ,
Required: False ,
}
string ,
oemActivation:
{
Description: OEM activation status of the cluster. ,
Enum:
{
Disabled: OEM activation is disabled for the cluster. ,
Enabled: OEM activation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
hardwareClass:
{
Description: Hardware class of the cluster. ,
Enum:
{
Small: The hardware class is small. ,
Medium: The hardware class is medium. This corresponds to the default ,
Large: The hardware class is large. ,
}
,
Required: False ,
}
enum ,
}
,
isolatedVmAttestationConfiguration:
{
Description: Attestation configurations for isolated VM (e.g. TVM, CVM) of the cluster. ,
Required: False ,
}
{
attestationResourceId:
{
Description: Fully qualified Azure resource id of the Microsoft Azure attestation resource associated with this cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
relyingPartyServiceEndpoint:
{
Description: Region specific endpoint for relying party service. ,
Required: False ,
}
string ,
attestationServiceEndpoint:
{
Description: Region specific endpoint for Microsoft Azure Attestation service for the cluster ,
Required: False ,
}
string ,
}
,
trialDaysRemaining:
{
Description: Number of days remaining in the trial period. ,
Format: float ,
Required: False ,
}
number ,
billingModel:
{
Description: Type of billing applied to the resource. ,
Required: False ,
}
string ,
registrationTimestamp:
{
Description: First cluster sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncTimestamp:
{
Description: Most recent cluster sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastBillingTimestamp:
{
Description: Most recent billing meter timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
serviceEndpoint:
{
Description: Region specific DataPath Endpoint of the cluster. ,
Required: False ,
}
string ,
resourceProviderObjectId:
{
Description: Object id of RP Service Principal ,
Required: False ,
}
string ,
secretsLocations:
{
Description: List of secret locations. ,
Required: False ,
}
[
{
secretsType:
{
Description: Type of secrets to store ,
Enum:
{
BackupSecrets: Backup secrets type ,
}
,
Required: True ,
}
enum ,
secretsLocation:
{
Description: secrets location ,
Required: True ,
}
string ,
}
,
]
,
clusterPattern:
{
Description: Supported Storage Type for HCI Cluster ,
Enum:
{
Standard: Standard cluster. ,
RackAware: RackAware cluster. ,
}
,
Required: False ,
}
enum ,
confidentialVmProperties:
{
Description: Represents the Confidential Virtual Machine (CVM) support intent and current status for the cluster resource. ,
Required: False ,
}
{
confidentialVmIntent:
{
Description: Captures the customer's intent to enable or disable CVM support on the cluster, either during initial deployment (Day-0) or at a later stage (Day-N). ,
Enum:
{
Enable: Indicates that the customer intends to enable CVM support on the cluster. ,
Disable: Indicates that the customer intends to disable CVM support on the cluster. ,
}
,
Required: False ,
}
enum ,
confidentialVmStatus:
{
Description: Captures the current status of CVM support on the cluster. ,
Enum:
{
Enabled: CVM support is fully enabled on the cluster. All nodes are CVM capable. ,
PartiallyEnabled: CVM support is partially enabled. At least one node in the cluster is CVM capable. ,
Disabled: CVM support is disabled. None of the nodes in the cluster are CVM capable. ,
}
,
Required: False ,
}
enum ,
confidentialVmStatusSummary:
{
Description: Additional context about CVM support on the cluster, such as reasons for partial enablement or hardware constraints. ,
Required: False ,
}
string ,
}
,
sdnProperties:
{
Description: Software Defined Networking Properties of the cluster ,
Required: False ,
}
{
sdnIntegrationIntent:
{
Description: Indicates whether Software Defined Networking (SDN) integration should be enabled or disabled for this deployment. ,
Enum:
{
Enable: Enable SDN integration for the deployment. ,
Disable: Disable SDN integration for the deployment. ,
}
,
Required: False ,
}
enum ,
}
,
localAvailabilityZones:
{
Description: Local Availability Zone information for HCI cluster ,
Required: False ,
}
[
{
localAvailabilityZoneName:
{
Description: Local Availability Zone name for HCI cluster ,
Required: False ,
}
string ,
nodes:
{
Description: Nodes belonging to a particular zone ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
identityProvider:
{
Description: Identity Provider for the cluster ,
Enum:
{
ActiveDirectory: Uses Active Directory as the identity provider, enabling domain-based authentication and centralized identity management. This is the default option. ,
LocalIdentity: Uses a local identity system integrated with Azure Key Vault for authentication. Suitable for AD-less environments where Active Directory is not available or required. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
kind:
{
Description: This property identifies the purpose of the Cluster deployment. For example, a valid value is AzureLocal ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_CreateIdentity (new)
Description :  Create cluster identity.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/createClusterIdentity
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Cluster identity properties. ,
Required: False ,
}
{
aadClientId:
{
Required: False ,
}
string ,
aadTenantId:
{
Required: False ,
}
string ,
aadServicePrincipalObjectId:
{
Required: False ,
}
string ,
aadApplicationObjectId:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeploymentSettings_ListByClusters (new)
Description :  List DeploymentSetting resources by Clusters
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/deploymentSettings
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The DeploymentSetting items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: DeploymentSetting provisioning state ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
arcNodeResourceIds:
{
Description: Azure resource ids of Arc machines to be part of cluster. ,
Required: True ,
}
[
string ,
]
,
deploymentMode:
{
Description: The deployment mode for cluster deployment. ,
Enum:
{
Validate: Validate ECE action deployment for a cluster. ,
Deploy: Deploy ECE action deployment for a cluster. ,
}
,
Required: True ,
}
enum ,
operationType:
{
Description: The intended operation for a cluster. ,
Enum:
{
ClusterProvisioning: Cluster provisioning operation. ,
ClusterUpgrade: Cluster upgrade operation. ,
}
,
Required: False ,
}
enum ,
deploymentConfiguration:
{
Description: Scale units will contains list of deployment data ,
Required: True ,
}
{
version:
{
Description: deployment template version ,
Required: False ,
}
string ,
scaleUnits:
{
Description: Scale units will contains list of deployment data ,
Required: True ,
}
[
{
deploymentData:
{
Description: Deployment Data to deploy AzureStackHCI Cluster. ,
Required: True ,
}
{
securitySettings:
{
Description: SecuritySettings to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
hvciProtection:
{
Description: By default, Hypervisor-protected Code Integrity is enabled on your Azure HCI cluster. ,
Required: False ,
}
boolean ,
drtmProtection:
{
Description: By default, Secure Boot is enabled on your Azure HCI cluster. This setting is hardware dependent. ,
Required: False ,
}
boolean ,
driftControlEnforced:
{
Description: When set to true, the security baseline is re-applied regularly. ,
Required: False ,
}
boolean ,
credentialGuardEnforced:
{
Description: When set to true, Credential Guard is enabled. ,
Required: False ,
}
boolean ,
smbSigningEnforced:
{
Description: When set to true, the SMB default instance requires sign in for the client and server services. ,
Required: False ,
}
boolean ,
smbClusterEncryption:
{
Description: When set to true, cluster east-west traffic is encrypted. ,
Required: False ,
}
boolean ,
sideChannelMitigationEnforced:
{
Description: When set to true, all the side channel mitigations are enabled ,
Required: False ,
}
boolean ,
bitlockerBootVolume:
{
Description: When set to true, BitLocker XTS_AES 256-bit encryption is enabled for all data-at-rest on the OS volume of your Azure Stack HCI cluster. This setting is TPM-hardware dependent. ,
Required: False ,
}
boolean ,
bitlockerDataVolumes:
{
Description: When set to true, BitLocker XTS-AES 256-bit encryption is enabled for all data-at-rest on your Azure Stack HCI cluster shared volumes. ,
Required: False ,
}
boolean ,
wdacEnforced:
{
Description: WDAC is enabled by default and limits the applications and the code that you can run on your Azure Stack HCI cluster. ,
Required: False ,
}
boolean ,
}
,
observability:
{
Description: Observability config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
streamingDataClient:
{
Description: Enables telemetry data to be sent to Microsoft ,
Required: False ,
}
boolean ,
euLocation:
{
Description: Location of your cluster. The log and diagnostic data is sent to the appropriate diagnostics servers depending upon where your cluster resides. Setting this to false results in all data sent to Microsoft to be stored outside of the EU. ,
Required: False ,
}
boolean ,
episodicDataUpload:
{
Description: When set to true, collects log data to facilitate quicker issue resolution. ,
Required: False ,
}
boolean ,
}
,
cluster:
{
Description: Observability config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
name:
{
Description: The cluster name provided when preparing Active Directory. ,
Required: False ,
}
string ,
witnessType:
{
Description: Use a cloud witness if you have internet access and if you use an Azure Storage account to provide a vote on cluster quorum. A cloud witness uses Azure Blob Storage to read or write a blob file and then uses it to arbitrate in split-brain resolution. Only allowed values are 'Cloud', 'FileShare'. ,
Required: False ,
}
string ,
witnessPath:
{
Description: Specify the fileshare path for the local witness for your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
cloudAccountName:
{
Description: Specify the Azure Storage account name for cloud witness for your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
azureServiceEndpoint:
{
Description: For Azure blob service endpoint type, select either Default or Custom domain. If you selected **Custom domain, enter the domain for the blob service in this format core.windows.net. ,
Required: False ,
}
string ,
hardwareClass:
{
Description: Hardware class of the cluster. ,
Enum:
{
Small: The hardware class is small. ,
Medium: The hardware class is medium. This corresponds to the default ,
Large: The hardware class is large. ,
}
,
Required: False ,
}
enum ,
clusterPattern:
{
Description: Cluster Pattern supported. ,
Enum:
{
Standard: Standard cluster. ,
RackAware: RackAware cluster. ,
}
,
Required: False ,
}
enum ,
}
,
identityProvider:
{
Description: Identity Provider for the cluster ,
Enum:
{
ActiveDirectory: Uses Active Directory as the identity provider, enabling domain-based authentication and centralized identity management. This is the default option. ,
LocalIdentity: Uses a local identity system integrated with Azure Key Vault for authentication. Suitable for AD-less environments where Active Directory is not available or required. ,
}
,
Required: False ,
}
enum ,
storage:
{
Description: Storage config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
configurationMode:
{
Description: By default, this mode is set to Express and your storage is configured as per best practices based on the number of nodes in the cluster. Allowed values are 'Express','InfraOnly', 'KeepStorage' ,
Required: False ,
}
string ,
}
,
namingPrefix:
{
Description: naming prefix to deploy cluster. ,
Required: False ,
}
string ,
domainFqdn:
{
Description: FQDN to deploy cluster ,
Required: False ,
}
string ,
infrastructureNetwork:
{
Description: InfrastructureNetwork config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
[
{
subnetMask:
{
Description: Subnet mask that matches the provided IP address space. ,
Required: False ,
}
string ,
gateway:
{
Description: Default gateway that should be used for the provided IP address space. ,
Required: False ,
}
string ,
ipPools:
{
Description: Range of IP addresses from which addresses are allocated for nodes within a subnet. ,
Required: False ,
}
[
{
startingAddress:
{
Description: Starting IP address for the management network. A minimum of six free, contiguous IPv4 addresses (excluding your host IPs) are needed for infrastructure services such as clustering. ,
Required: False ,
}
string ,
endingAddress:
{
Description: Ending IP address for the management network. A minimum of six free, contiguous IPv4 addresses (excluding your host IPs) are needed for infrastructure services such as clustering. ,
Required: False ,
}
string ,
}
,
]
,
dnsServerConfig:
{
Description: Specifies how DNS servers are configured for the infrastructure network. Allowed values are 'UseDnsServer' to use the provided DNS servers, and 'UseForwarder' to use DNS forwarders. ,
Enum:
{
UseDnsServer: Use the provided DNS servers for the infrastructure network. ,
UseForwarder: Use DNS forwarders for the infrastructure network. ,
}
,
Required: False ,
}
enum ,
dnsZones:
{
Description: Details of the DNS Zones to be configured. ,
Required: False ,
}
[
{
dnsZoneName:
{
Description: Name of the DNS Zone to be configured. ,
Required: False ,
}
string ,
dnsForwarder:
{
Description: Forwarder details of the DNS Zone to be configured. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
dnsServers:
{
Description: IPv4 address of the DNS servers in your environment. ,
Required: False ,
}
[
string ,
]
,
useDhcp:
{
Description: Allows customers to use DHCP for Hosts and Cluster IPs. If not declared, the deployment will default to static IPs. When true, GW and DNS servers are not required ,
Required: False ,
}
boolean ,
}
,
]
,
physicalNodes:
{
Description: list of physical nodes config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
[
{
name:
{
Description: NETBIOS name of each physical server on your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
ipv4Address:
{
Description: The IPv4 address assigned to each physical server on your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
}
,
]
,
hostNetwork:
{
Description: HostNetwork config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
intents:
{
Description: The network intents assigned to the network reference pattern used for the deployment. Each intent will define its own name, traffic type, adapter names, and overrides as recommended by your OEM. ,
Required: False ,
}
[
{
name:
{
Description: Name of the network intent you wish to create. ,
Required: False ,
}
string ,
trafficType:
{
Description: List of network traffic types. Only allowed values are 'Compute', 'Storage', 'Management'. ,
Required: False ,
}
[
string ,
]
,
adapter:
{
Description: Array of network interfaces used for the network intent. ,
Required: False ,
}
[
string ,
]
,
overrideVirtualSwitchConfiguration:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
boolean ,
virtualSwitchConfigurationOverrides:
{
Description: Set virtualSwitch ConfigurationOverrides for cluster. ,
Required: False ,
}
{
enableIov:
{
Description: Enable IoV for Virtual Switch ,
Required: False ,
}
string ,
loadBalancingAlgorithm:
{
Description: Load Balancing Algorithm for Virtual Switch ,
Required: False ,
}
string ,
}
,
overrideQosPolicy:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
boolean ,
qosPolicyOverrides:
{
Description: Set QoS PolicyOverrides for cluster. ,
Required: False ,
}
{
priorityValue8021Action_Cluster:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
string ,
priorityValue8021Action_SMB:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
string ,
bandwidthPercentage_SMB:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
string ,
}
,
overrideAdapterProperty:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
boolean ,
adapterPropertyOverrides:
{
Description: Set Adapter PropertyOverrides for cluster. ,
Required: False ,
}
{
jumboPacket:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
string ,
networkDirect:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
string ,
networkDirectTechnology:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. Expected values are 'iWARP', 'RoCEv2', 'RoCE' ,
Required: False ,
}
string ,
}
,
}
,
]
,
storageNetworks:
{
Description: List of StorageNetworks config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
[
{
name:
{
Description: Name of the storage network. ,
Required: False ,
}
string ,
networkAdapterName:
{
Description: Name of the storage network adapter. ,
Required: False ,
}
string ,
vlanId:
{
Description: ID specified for the VLAN storage network. This setting is applied to the network interfaces that route the storage and VM migration traffic. ,
Required: False ,
}
string ,
storageAdapterIPInfo:
{
Description: List of Storage adapter physical nodes config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
[
{
physicalNode:
{
Description: storage adapter physical node name. ,
Required: False ,
}
string ,
ipv4Address:
{
Description: The IPv4 address assigned to each storage adapter physical node on your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
subnetMask:
{
Description: The SubnetMask address assigned to each storage adapter physical node on your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
storageConnectivitySwitchless:
{
Description: Defines how the storage adapters between nodes are connected either switch or switch less.. ,
Required: False ,
}
boolean ,
enableStorageAutoIp:
{
Description: Optional parameter required only for 3 Nodes Switchless deployments. This allows users to specify IPs and Mask for Storage NICs when Network ATC is not assigning the IPs for storage automatically. ,
Required: False ,
}
boolean ,
}
,
sdnIntegration:
{
Description: SDN Integration config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
networkController:
{
Description: network controller config for SDN Integration to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
macAddressPoolStart:
{
Description: macAddressPoolStart of network controller used for SDN Integration. ,
Required: False ,
}
string ,
macAddressPoolStop:
{
Description: macAddressPoolStop of network controller used for SDN Integration. ,
Required: False ,
}
string ,
networkVirtualizationEnabled:
{
Description: NetworkVirtualizationEnabled of network controller used for SDN Integration. ,
Required: False ,
}
boolean ,
}
,
}
,
isManagementCluster:
{
Description: Is Management Cluster, when true indicates that the cluster is used for managing other clusters ,
Required: False ,
}
boolean ,
adouPath:
{
Description: The path to the Active Directory Organizational Unit container object prepared for the deployment. ,
Required: False ,
}
string ,
secretsLocation:
{
Description: Azure key vault endpoint. This property is deprecated from 2023-12-01-preview. Please use secrets property instead. ,
Required: False ,
}
string ,
secrets:
{
Description: secrets used for cloud deployment. ,
Required: False ,
}
[
{
secretName:
{
Description: Secret name stored in keyvault. ,
Required: False ,
}
string ,
eceSecretName:
{
Description: Secret name expected for Enterprise Cloud Engine (ECE) deployment. ,
Enum:
{
AzureStackLCMUserCredential: AzureStackLCMUserCredential used for LCM operations for AzureStackHCI cluster. ,
DefaultARBApplication: DefaultARBApplication used to manage Azure Arc resource bridge (ARB) for AzureStackHCI cluster. ,
LocalAdminCredential: LocalAdminCredential used for admin operations for AzureStackHCI cluster. ,
WitnessStorageKey: WitnessStorageKey used for setting up a cloud witness for AzureStackHCI cluster. ,
}
,
Required: False ,
}
enum ,
secretLocation:
{
Description: Secret URI stored in keyvault. ,
Format: uri ,
Required: False ,
}
string ,
}
,
]
,
optionalServices:
{
Description: OptionalServices config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
customLocation:
{
Description: The name of custom location. ,
Required: False ,
}
string ,
}
,
localAvailabilityZones:
{
Description: Local Availability Zone information for HCI cluster ,
Required: False ,
}
[
{
localAvailabilityZoneName:
{
Description: Local Availability Zone name for HCI cluster ,
Required: False ,
}
string ,
nodes:
{
Description: Nodes belonging to a particular zone ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
assemblyInfo:
{
Description: Assembly Package details for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
{
packageVersion:
{
Description: Assembly Package version for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
string ,
payload:
{
Description: Payload properties for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
[
{
identifier:
{
Description: assembly identifier for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
string ,
hash:
{
Description: Hash of assembly package for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
string ,
fileName:
{
Description: File name of assembly package for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
string ,
url:
{
Description: Url of assembly package for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
sbePartnerInfo:
{
Description: Solution builder extension (SBE) partner properties ,
Required: False ,
}
{
sbeDeploymentInfo:
{
Description: SBE package and manifest information for the solution Builder Extension staged for AzureStackHCI cluster deployment. ,
Required: False ,
}
{
version:
{
Description: SBE package version. ,
Required: False ,
}
string ,
family:
{
Description: SBE family name. ,
Required: False ,
}
string ,
publisher:
{
Description: SBE manifest publisher. ,
Required: False ,
}
string ,
sbeManifestSource:
{
Description: SBE Manifest Source. ,
Required: False ,
}
string ,
sbeManifestCreationDate:
{
Description: SBE Manifest Creation Date. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
partnerProperties:
{
Description: List of SBE partner properties for AzureStackHCI cluster deployment. ,
Required: False ,
}
[
{
name:
{
Description: SBE partner property name. ,
Required: False ,
}
string ,
value:
{
Description: SBE partner property value. ,
Required: False ,
}
string ,
}
,
]
,
credentialList:
{
Description: SBE credentials list for AzureStackHCI cluster deployment. ,
Required: False ,
}
[
{
secretName:
{
Description: secret name stored in keyvault. ,
Required: False ,
}
string ,
eceSecretName:
{
Description: secret name expected for Enterprise Cloud Engine (ECE). ,
Required: False ,
}
string ,
secretLocation:
{
Description: secret URI stored in keyvault. ,
Format: uri ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
}
,
reportedProperties:
{
Description: Deployment Status reported from cluster. ,
Required: False ,
}
{
validationStatus:
{
Description: validation status of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
{
status:
{
Description: Status of ECE action AzureStackHCI Cluster Deployment. ,
Required: False ,
}
string ,
steps:
{
Description: List of steps of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
{
name:
{
Description: Name of step. ,
Required: False ,
}
string ,
description:
{
Description: Description of step. ,
Required: False ,
}
string ,
fullStepIndex:
{
Description: FullStepIndex of step. ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: Start time of step. ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: End time of step. ,
Required: False ,
}
string ,
status:
{
Description: Status of step. Allowed values are 'Error', 'Success', 'InProgress' ,
Required: False ,
}
string ,
steps:
{
Description: List of nested steps of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
string ,
]
,
exception:
{
Description: List of exceptions in AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
deploymentStatus:
{
Description: Deployment status of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
{
status:
{
Description: Status of ECE action AzureStackHCI Cluster Deployment. ,
Required: False ,
}
string ,
steps:
{
Description: List of steps of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
{
name:
{
Description: Name of step. ,
Required: False ,
}
string ,
description:
{
Description: Description of step. ,
Required: False ,
}
string ,
fullStepIndex:
{
Description: FullStepIndex of step. ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: Start time of step. ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: End time of step. ,
Required: False ,
}
string ,
status:
{
Description: Status of step. Allowed values are 'Error', 'Success', 'InProgress' ,
Required: False ,
}
string ,
steps:
{
Description: List of nested steps of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
string ,
]
,
exception:
{
Description: List of exceptions in AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeploymentSettings_Get (new)
Description :  Get a DeploymentSetting
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/deploymentSettings/{deploymentSettingsName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
deploymentSettingsName:
{
Description: Name of Deployment Setting ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: DeploymentSetting provisioning state ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
arcNodeResourceIds:
{
Description: Azure resource ids of Arc machines to be part of cluster. ,
Required: True ,
}
[
string ,
]
,
deploymentMode:
{
Description: The deployment mode for cluster deployment. ,
Enum:
{
Validate: Validate ECE action deployment for a cluster. ,
Deploy: Deploy ECE action deployment for a cluster. ,
}
,
Required: True ,
}
enum ,
operationType:
{
Description: The intended operation for a cluster. ,
Enum:
{
ClusterProvisioning: Cluster provisioning operation. ,
ClusterUpgrade: Cluster upgrade operation. ,
}
,
Required: False ,
}
enum ,
deploymentConfiguration:
{
Description: Scale units will contains list of deployment data ,
Required: True ,
}
{
version:
{
Description: deployment template version ,
Required: False ,
}
string ,
scaleUnits:
{
Description: Scale units will contains list of deployment data ,
Required: True ,
}
[
{
deploymentData:
{
Description: Deployment Data to deploy AzureStackHCI Cluster. ,
Required: True ,
}
{
securitySettings:
{
Description: SecuritySettings to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
hvciProtection:
{
Description: By default, Hypervisor-protected Code Integrity is enabled on your Azure HCI cluster. ,
Required: False ,
}
boolean ,
drtmProtection:
{
Description: By default, Secure Boot is enabled on your Azure HCI cluster. This setting is hardware dependent. ,
Required: False ,
}
boolean ,
driftControlEnforced:
{
Description: When set to true, the security baseline is re-applied regularly. ,
Required: False ,
}
boolean ,
credentialGuardEnforced:
{
Description: When set to true, Credential Guard is enabled. ,
Required: False ,
}
boolean ,
smbSigningEnforced:
{
Description: When set to true, the SMB default instance requires sign in for the client and server services. ,
Required: False ,
}
boolean ,
smbClusterEncryption:
{
Description: When set to true, cluster east-west traffic is encrypted. ,
Required: False ,
}
boolean ,
sideChannelMitigationEnforced:
{
Description: When set to true, all the side channel mitigations are enabled ,
Required: False ,
}
boolean ,
bitlockerBootVolume:
{
Description: When set to true, BitLocker XTS_AES 256-bit encryption is enabled for all data-at-rest on the OS volume of your Azure Stack HCI cluster. This setting is TPM-hardware dependent. ,
Required: False ,
}
boolean ,
bitlockerDataVolumes:
{
Description: When set to true, BitLocker XTS-AES 256-bit encryption is enabled for all data-at-rest on your Azure Stack HCI cluster shared volumes. ,
Required: False ,
}
boolean ,
wdacEnforced:
{
Description: WDAC is enabled by default and limits the applications and the code that you can run on your Azure Stack HCI cluster. ,
Required: False ,
}
boolean ,
}
,
observability:
{
Description: Observability config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
streamingDataClient:
{
Description: Enables telemetry data to be sent to Microsoft ,
Required: False ,
}
boolean ,
euLocation:
{
Description: Location of your cluster. The log and diagnostic data is sent to the appropriate diagnostics servers depending upon where your cluster resides. Setting this to false results in all data sent to Microsoft to be stored outside of the EU. ,
Required: False ,
}
boolean ,
episodicDataUpload:
{
Description: When set to true, collects log data to facilitate quicker issue resolution. ,
Required: False ,
}
boolean ,
}
,
cluster:
{
Description: Observability config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
name:
{
Description: The cluster name provided when preparing Active Directory. ,
Required: False ,
}
string ,
witnessType:
{
Description: Use a cloud witness if you have internet access and if you use an Azure Storage account to provide a vote on cluster quorum. A cloud witness uses Azure Blob Storage to read or write a blob file and then uses it to arbitrate in split-brain resolution. Only allowed values are 'Cloud', 'FileShare'. ,
Required: False ,
}
string ,
witnessPath:
{
Description: Specify the fileshare path for the local witness for your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
cloudAccountName:
{
Description: Specify the Azure Storage account name for cloud witness for your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
azureServiceEndpoint:
{
Description: For Azure blob service endpoint type, select either Default or Custom domain. If you selected **Custom domain, enter the domain for the blob service in this format core.windows.net. ,
Required: False ,
}
string ,
hardwareClass:
{
Description: Hardware class of the cluster. ,
Enum:
{
Small: The hardware class is small. ,
Medium: The hardware class is medium. This corresponds to the default ,
Large: The hardware class is large. ,
}
,
Required: False ,
}
enum ,
clusterPattern:
{
Description: Cluster Pattern supported. ,
Enum:
{
Standard: Standard cluster. ,
RackAware: RackAware cluster. ,
}
,
Required: False ,
}
enum ,
}
,
identityProvider:
{
Description: Identity Provider for the cluster ,
Enum:
{
ActiveDirectory: Uses Active Directory as the identity provider, enabling domain-based authentication and centralized identity management. This is the default option. ,
LocalIdentity: Uses a local identity system integrated with Azure Key Vault for authentication. Suitable for AD-less environments where Active Directory is not available or required. ,
}
,
Required: False ,
}
enum ,
storage:
{
Description: Storage config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
configurationMode:
{
Description: By default, this mode is set to Express and your storage is configured as per best practices based on the number of nodes in the cluster. Allowed values are 'Express','InfraOnly', 'KeepStorage' ,
Required: False ,
}
string ,
}
,
namingPrefix:
{
Description: naming prefix to deploy cluster. ,
Required: False ,
}
string ,
domainFqdn:
{
Description: FQDN to deploy cluster ,
Required: False ,
}
string ,
infrastructureNetwork:
{
Description: InfrastructureNetwork config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
[
{
subnetMask:
{
Description: Subnet mask that matches the provided IP address space. ,
Required: False ,
}
string ,
gateway:
{
Description: Default gateway that should be used for the provided IP address space. ,
Required: False ,
}
string ,
ipPools:
{
Description: Range of IP addresses from which addresses are allocated for nodes within a subnet. ,
Required: False ,
}
[
{
startingAddress:
{
Description: Starting IP address for the management network. A minimum of six free, contiguous IPv4 addresses (excluding your host IPs) are needed for infrastructure services such as clustering. ,
Required: False ,
}
string ,
endingAddress:
{
Description: Ending IP address for the management network. A minimum of six free, contiguous IPv4 addresses (excluding your host IPs) are needed for infrastructure services such as clustering. ,
Required: False ,
}
string ,
}
,
]
,
dnsServerConfig:
{
Description: Specifies how DNS servers are configured for the infrastructure network. Allowed values are 'UseDnsServer' to use the provided DNS servers, and 'UseForwarder' to use DNS forwarders. ,
Enum:
{
UseDnsServer: Use the provided DNS servers for the infrastructure network. ,
UseForwarder: Use DNS forwarders for the infrastructure network. ,
}
,
Required: False ,
}
enum ,
dnsZones:
{
Description: Details of the DNS Zones to be configured. ,
Required: False ,
}
[
{
dnsZoneName:
{
Description: Name of the DNS Zone to be configured. ,
Required: False ,
}
string ,
dnsForwarder:
{
Description: Forwarder details of the DNS Zone to be configured. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
dnsServers:
{
Description: IPv4 address of the DNS servers in your environment. ,
Required: False ,
}
[
string ,
]
,
useDhcp:
{
Description: Allows customers to use DHCP for Hosts and Cluster IPs. If not declared, the deployment will default to static IPs. When true, GW and DNS servers are not required ,
Required: False ,
}
boolean ,
}
,
]
,
physicalNodes:
{
Description: list of physical nodes config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
[
{
name:
{
Description: NETBIOS name of each physical server on your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
ipv4Address:
{
Description: The IPv4 address assigned to each physical server on your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
}
,
]
,
hostNetwork:
{
Description: HostNetwork config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
intents:
{
Description: The network intents assigned to the network reference pattern used for the deployment. Each intent will define its own name, traffic type, adapter names, and overrides as recommended by your OEM. ,
Required: False ,
}
[
{
name:
{
Description: Name of the network intent you wish to create. ,
Required: False ,
}
string ,
trafficType:
{
Description: List of network traffic types. Only allowed values are 'Compute', 'Storage', 'Management'. ,
Required: False ,
}
[
string ,
]
,
adapter:
{
Description: Array of network interfaces used for the network intent. ,
Required: False ,
}
[
string ,
]
,
overrideVirtualSwitchConfiguration:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
boolean ,
virtualSwitchConfigurationOverrides:
{
Description: Set virtualSwitch ConfigurationOverrides for cluster. ,
Required: False ,
}
{
enableIov:
{
Description: Enable IoV for Virtual Switch ,
Required: False ,
}
string ,
loadBalancingAlgorithm:
{
Description: Load Balancing Algorithm for Virtual Switch ,
Required: False ,
}
string ,
}
,
overrideQosPolicy:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
boolean ,
qosPolicyOverrides:
{
Description: Set QoS PolicyOverrides for cluster. ,
Required: False ,
}
{
priorityValue8021Action_Cluster:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
string ,
priorityValue8021Action_SMB:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
string ,
bandwidthPercentage_SMB:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
string ,
}
,
overrideAdapterProperty:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
boolean ,
adapterPropertyOverrides:
{
Description: Set Adapter PropertyOverrides for cluster. ,
Required: False ,
}
{
jumboPacket:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
string ,
networkDirect:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
string ,
networkDirectTechnology:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. Expected values are 'iWARP', 'RoCEv2', 'RoCE' ,
Required: False ,
}
string ,
}
,
}
,
]
,
storageNetworks:
{
Description: List of StorageNetworks config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
[
{
name:
{
Description: Name of the storage network. ,
Required: False ,
}
string ,
networkAdapterName:
{
Description: Name of the storage network adapter. ,
Required: False ,
}
string ,
vlanId:
{
Description: ID specified for the VLAN storage network. This setting is applied to the network interfaces that route the storage and VM migration traffic. ,
Required: False ,
}
string ,
storageAdapterIPInfo:
{
Description: List of Storage adapter physical nodes config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
[
{
physicalNode:
{
Description: storage adapter physical node name. ,
Required: False ,
}
string ,
ipv4Address:
{
Description: The IPv4 address assigned to each storage adapter physical node on your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
subnetMask:
{
Description: The SubnetMask address assigned to each storage adapter physical node on your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
storageConnectivitySwitchless:
{
Description: Defines how the storage adapters between nodes are connected either switch or switch less.. ,
Required: False ,
}
boolean ,
enableStorageAutoIp:
{
Description: Optional parameter required only for 3 Nodes Switchless deployments. This allows users to specify IPs and Mask for Storage NICs when Network ATC is not assigning the IPs for storage automatically. ,
Required: False ,
}
boolean ,
}
,
sdnIntegration:
{
Description: SDN Integration config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
networkController:
{
Description: network controller config for SDN Integration to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
macAddressPoolStart:
{
Description: macAddressPoolStart of network controller used for SDN Integration. ,
Required: False ,
}
string ,
macAddressPoolStop:
{
Description: macAddressPoolStop of network controller used for SDN Integration. ,
Required: False ,
}
string ,
networkVirtualizationEnabled:
{
Description: NetworkVirtualizationEnabled of network controller used for SDN Integration. ,
Required: False ,
}
boolean ,
}
,
}
,
isManagementCluster:
{
Description: Is Management Cluster, when true indicates that the cluster is used for managing other clusters ,
Required: False ,
}
boolean ,
adouPath:
{
Description: The path to the Active Directory Organizational Unit container object prepared for the deployment. ,
Required: False ,
}
string ,
secretsLocation:
{
Description: Azure key vault endpoint. This property is deprecated from 2023-12-01-preview. Please use secrets property instead. ,
Required: False ,
}
string ,
secrets:
{
Description: secrets used for cloud deployment. ,
Required: False ,
}
[
{
secretName:
{
Description: Secret name stored in keyvault. ,
Required: False ,
}
string ,
eceSecretName:
{
Description: Secret name expected for Enterprise Cloud Engine (ECE) deployment. ,
Enum:
{
AzureStackLCMUserCredential: AzureStackLCMUserCredential used for LCM operations for AzureStackHCI cluster. ,
DefaultARBApplication: DefaultARBApplication used to manage Azure Arc resource bridge (ARB) for AzureStackHCI cluster. ,
LocalAdminCredential: LocalAdminCredential used for admin operations for AzureStackHCI cluster. ,
WitnessStorageKey: WitnessStorageKey used for setting up a cloud witness for AzureStackHCI cluster. ,
}
,
Required: False ,
}
enum ,
secretLocation:
{
Description: Secret URI stored in keyvault. ,
Format: uri ,
Required: False ,
}
string ,
}
,
]
,
optionalServices:
{
Description: OptionalServices config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
customLocation:
{
Description: The name of custom location. ,
Required: False ,
}
string ,
}
,
localAvailabilityZones:
{
Description: Local Availability Zone information for HCI cluster ,
Required: False ,
}
[
{
localAvailabilityZoneName:
{
Description: Local Availability Zone name for HCI cluster ,
Required: False ,
}
string ,
nodes:
{
Description: Nodes belonging to a particular zone ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
assemblyInfo:
{
Description: Assembly Package details for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
{
packageVersion:
{
Description: Assembly Package version for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
string ,
payload:
{
Description: Payload properties for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
[
{
identifier:
{
Description: assembly identifier for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
string ,
hash:
{
Description: Hash of assembly package for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
string ,
fileName:
{
Description: File name of assembly package for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
string ,
url:
{
Description: Url of assembly package for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
sbePartnerInfo:
{
Description: Solution builder extension (SBE) partner properties ,
Required: False ,
}
{
sbeDeploymentInfo:
{
Description: SBE package and manifest information for the solution Builder Extension staged for AzureStackHCI cluster deployment. ,
Required: False ,
}
{
version:
{
Description: SBE package version. ,
Required: False ,
}
string ,
family:
{
Description: SBE family name. ,
Required: False ,
}
string ,
publisher:
{
Description: SBE manifest publisher. ,
Required: False ,
}
string ,
sbeManifestSource:
{
Description: SBE Manifest Source. ,
Required: False ,
}
string ,
sbeManifestCreationDate:
{
Description: SBE Manifest Creation Date. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
partnerProperties:
{
Description: List of SBE partner properties for AzureStackHCI cluster deployment. ,
Required: False ,
}
[
{
name:
{
Description: SBE partner property name. ,
Required: False ,
}
string ,
value:
{
Description: SBE partner property value. ,
Required: False ,
}
string ,
}
,
]
,
credentialList:
{
Description: SBE credentials list for AzureStackHCI cluster deployment. ,
Required: False ,
}
[
{
secretName:
{
Description: secret name stored in keyvault. ,
Required: False ,
}
string ,
eceSecretName:
{
Description: secret name expected for Enterprise Cloud Engine (ECE). ,
Required: False ,
}
string ,
secretLocation:
{
Description: secret URI stored in keyvault. ,
Format: uri ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
}
,
reportedProperties:
{
Description: Deployment Status reported from cluster. ,
Required: False ,
}
{
validationStatus:
{
Description: validation status of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
{
status:
{
Description: Status of ECE action AzureStackHCI Cluster Deployment. ,
Required: False ,
}
string ,
steps:
{
Description: List of steps of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
{
name:
{
Description: Name of step. ,
Required: False ,
}
string ,
description:
{
Description: Description of step. ,
Required: False ,
}
string ,
fullStepIndex:
{
Description: FullStepIndex of step. ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: Start time of step. ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: End time of step. ,
Required: False ,
}
string ,
status:
{
Description: Status of step. Allowed values are 'Error', 'Success', 'InProgress' ,
Required: False ,
}
string ,
steps:
{
Description: List of nested steps of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
string ,
]
,
exception:
{
Description: List of exceptions in AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
deploymentStatus:
{
Description: Deployment status of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
{
status:
{
Description: Status of ECE action AzureStackHCI Cluster Deployment. ,
Required: False ,
}
string ,
steps:
{
Description: List of steps of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
{
name:
{
Description: Name of step. ,
Required: False ,
}
string ,
description:
{
Description: Description of step. ,
Required: False ,
}
string ,
fullStepIndex:
{
Description: FullStepIndex of step. ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: Start time of step. ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: End time of step. ,
Required: False ,
}
string ,
status:
{
Description: Status of step. Allowed values are 'Error', 'Success', 'InProgress' ,
Required: False ,
}
string ,
steps:
{
Description: List of nested steps of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
string ,
]
,
exception:
{
Description: List of exceptions in AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeploymentSettings_CreateOrUpdate (new)
Description :  Create a DeploymentSetting
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/deploymentSettings/{deploymentSettingsName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
deploymentSettingsName:
{
Description: Name of Deployment Setting ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: DeploymentSetting provisioning state ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
arcNodeResourceIds:
{
Description: Azure resource ids of Arc machines to be part of cluster. ,
Required: True ,
}
[
string ,
]
,
deploymentMode:
{
Description: The deployment mode for cluster deployment. ,
Enum:
{
Validate: Validate ECE action deployment for a cluster. ,
Deploy: Deploy ECE action deployment for a cluster. ,
}
,
Required: True ,
}
enum ,
operationType:
{
Description: The intended operation for a cluster. ,
Enum:
{
ClusterProvisioning: Cluster provisioning operation. ,
ClusterUpgrade: Cluster upgrade operation. ,
}
,
Required: False ,
}
enum ,
deploymentConfiguration:
{
Description: Scale units will contains list of deployment data ,
Required: True ,
}
{
version:
{
Description: deployment template version ,
Required: False ,
}
string ,
scaleUnits:
{
Description: Scale units will contains list of deployment data ,
Required: True ,
}
[
{
deploymentData:
{
Description: Deployment Data to deploy AzureStackHCI Cluster. ,
Required: True ,
}
{
securitySettings:
{
Description: SecuritySettings to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
hvciProtection:
{
Description: By default, Hypervisor-protected Code Integrity is enabled on your Azure HCI cluster. ,
Required: False ,
}
boolean ,
drtmProtection:
{
Description: By default, Secure Boot is enabled on your Azure HCI cluster. This setting is hardware dependent. ,
Required: False ,
}
boolean ,
driftControlEnforced:
{
Description: When set to true, the security baseline is re-applied regularly. ,
Required: False ,
}
boolean ,
credentialGuardEnforced:
{
Description: When set to true, Credential Guard is enabled. ,
Required: False ,
}
boolean ,
smbSigningEnforced:
{
Description: When set to true, the SMB default instance requires sign in for the client and server services. ,
Required: False ,
}
boolean ,
smbClusterEncryption:
{
Description: When set to true, cluster east-west traffic is encrypted. ,
Required: False ,
}
boolean ,
sideChannelMitigationEnforced:
{
Description: When set to true, all the side channel mitigations are enabled ,
Required: False ,
}
boolean ,
bitlockerBootVolume:
{
Description: When set to true, BitLocker XTS_AES 256-bit encryption is enabled for all data-at-rest on the OS volume of your Azure Stack HCI cluster. This setting is TPM-hardware dependent. ,
Required: False ,
}
boolean ,
bitlockerDataVolumes:
{
Description: When set to true, BitLocker XTS-AES 256-bit encryption is enabled for all data-at-rest on your Azure Stack HCI cluster shared volumes. ,
Required: False ,
}
boolean ,
wdacEnforced:
{
Description: WDAC is enabled by default and limits the applications and the code that you can run on your Azure Stack HCI cluster. ,
Required: False ,
}
boolean ,
}
,
observability:
{
Description: Observability config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
streamingDataClient:
{
Description: Enables telemetry data to be sent to Microsoft ,
Required: False ,
}
boolean ,
euLocation:
{
Description: Location of your cluster. The log and diagnostic data is sent to the appropriate diagnostics servers depending upon where your cluster resides. Setting this to false results in all data sent to Microsoft to be stored outside of the EU. ,
Required: False ,
}
boolean ,
episodicDataUpload:
{
Description: When set to true, collects log data to facilitate quicker issue resolution. ,
Required: False ,
}
boolean ,
}
,
cluster:
{
Description: Observability config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
name:
{
Description: The cluster name provided when preparing Active Directory. ,
Required: False ,
}
string ,
witnessType:
{
Description: Use a cloud witness if you have internet access and if you use an Azure Storage account to provide a vote on cluster quorum. A cloud witness uses Azure Blob Storage to read or write a blob file and then uses it to arbitrate in split-brain resolution. Only allowed values are 'Cloud', 'FileShare'. ,
Required: False ,
}
string ,
witnessPath:
{
Description: Specify the fileshare path for the local witness for your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
cloudAccountName:
{
Description: Specify the Azure Storage account name for cloud witness for your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
azureServiceEndpoint:
{
Description: For Azure blob service endpoint type, select either Default or Custom domain. If you selected **Custom domain, enter the domain for the blob service in this format core.windows.net. ,
Required: False ,
}
string ,
hardwareClass:
{
Description: Hardware class of the cluster. ,
Enum:
{
Small: The hardware class is small. ,
Medium: The hardware class is medium. This corresponds to the default ,
Large: The hardware class is large. ,
}
,
Required: False ,
}
enum ,
clusterPattern:
{
Description: Cluster Pattern supported. ,
Enum:
{
Standard: Standard cluster. ,
RackAware: RackAware cluster. ,
}
,
Required: False ,
}
enum ,
}
,
identityProvider:
{
Description: Identity Provider for the cluster ,
Enum:
{
ActiveDirectory: Uses Active Directory as the identity provider, enabling domain-based authentication and centralized identity management. This is the default option. ,
LocalIdentity: Uses a local identity system integrated with Azure Key Vault for authentication. Suitable for AD-less environments where Active Directory is not available or required. ,
}
,
Required: False ,
}
enum ,
storage:
{
Description: Storage config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
configurationMode:
{
Description: By default, this mode is set to Express and your storage is configured as per best practices based on the number of nodes in the cluster. Allowed values are 'Express','InfraOnly', 'KeepStorage' ,
Required: False ,
}
string ,
}
,
namingPrefix:
{
Description: naming prefix to deploy cluster. ,
Required: False ,
}
string ,
domainFqdn:
{
Description: FQDN to deploy cluster ,
Required: False ,
}
string ,
infrastructureNetwork:
{
Description: InfrastructureNetwork config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
[
{
subnetMask:
{
Description: Subnet mask that matches the provided IP address space. ,
Required: False ,
}
string ,
gateway:
{
Description: Default gateway that should be used for the provided IP address space. ,
Required: False ,
}
string ,
ipPools:
{
Description: Range of IP addresses from which addresses are allocated for nodes within a subnet. ,
Required: False ,
}
[
{
startingAddress:
{
Description: Starting IP address for the management network. A minimum of six free, contiguous IPv4 addresses (excluding your host IPs) are needed for infrastructure services such as clustering. ,
Required: False ,
}
string ,
endingAddress:
{
Description: Ending IP address for the management network. A minimum of six free, contiguous IPv4 addresses (excluding your host IPs) are needed for infrastructure services such as clustering. ,
Required: False ,
}
string ,
}
,
]
,
dnsServerConfig:
{
Description: Specifies how DNS servers are configured for the infrastructure network. Allowed values are 'UseDnsServer' to use the provided DNS servers, and 'UseForwarder' to use DNS forwarders. ,
Enum:
{
UseDnsServer: Use the provided DNS servers for the infrastructure network. ,
UseForwarder: Use DNS forwarders for the infrastructure network. ,
}
,
Required: False ,
}
enum ,
dnsZones:
{
Description: Details of the DNS Zones to be configured. ,
Required: False ,
}
[
{
dnsZoneName:
{
Description: Name of the DNS Zone to be configured. ,
Required: False ,
}
string ,
dnsForwarder:
{
Description: Forwarder details of the DNS Zone to be configured. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
dnsServers:
{
Description: IPv4 address of the DNS servers in your environment. ,
Required: False ,
}
[
string ,
]
,
useDhcp:
{
Description: Allows customers to use DHCP for Hosts and Cluster IPs. If not declared, the deployment will default to static IPs. When true, GW and DNS servers are not required ,
Required: False ,
}
boolean ,
}
,
]
,
physicalNodes:
{
Description: list of physical nodes config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
[
{
name:
{
Description: NETBIOS name of each physical server on your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
ipv4Address:
{
Description: The IPv4 address assigned to each physical server on your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
}
,
]
,
hostNetwork:
{
Description: HostNetwork config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
intents:
{
Description: The network intents assigned to the network reference pattern used for the deployment. Each intent will define its own name, traffic type, adapter names, and overrides as recommended by your OEM. ,
Required: False ,
}
[
{
name:
{
Description: Name of the network intent you wish to create. ,
Required: False ,
}
string ,
trafficType:
{
Description: List of network traffic types. Only allowed values are 'Compute', 'Storage', 'Management'. ,
Required: False ,
}
[
string ,
]
,
adapter:
{
Description: Array of network interfaces used for the network intent. ,
Required: False ,
}
[
string ,
]
,
overrideVirtualSwitchConfiguration:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
boolean ,
virtualSwitchConfigurationOverrides:
{
Description: Set virtualSwitch ConfigurationOverrides for cluster. ,
Required: False ,
}
{
enableIov:
{
Description: Enable IoV for Virtual Switch ,
Required: False ,
}
string ,
loadBalancingAlgorithm:
{
Description: Load Balancing Algorithm for Virtual Switch ,
Required: False ,
}
string ,
}
,
overrideQosPolicy:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
boolean ,
qosPolicyOverrides:
{
Description: Set QoS PolicyOverrides for cluster. ,
Required: False ,
}
{
priorityValue8021Action_Cluster:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
string ,
priorityValue8021Action_SMB:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
string ,
bandwidthPercentage_SMB:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
string ,
}
,
overrideAdapterProperty:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
boolean ,
adapterPropertyOverrides:
{
Description: Set Adapter PropertyOverrides for cluster. ,
Required: False ,
}
{
jumboPacket:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
string ,
networkDirect:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
string ,
networkDirectTechnology:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. Expected values are 'iWARP', 'RoCEv2', 'RoCE' ,
Required: False ,
}
string ,
}
,
}
,
]
,
storageNetworks:
{
Description: List of StorageNetworks config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
[
{
name:
{
Description: Name of the storage network. ,
Required: False ,
}
string ,
networkAdapterName:
{
Description: Name of the storage network adapter. ,
Required: False ,
}
string ,
vlanId:
{
Description: ID specified for the VLAN storage network. This setting is applied to the network interfaces that route the storage and VM migration traffic. ,
Required: False ,
}
string ,
storageAdapterIPInfo:
{
Description: List of Storage adapter physical nodes config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
[
{
physicalNode:
{
Description: storage adapter physical node name. ,
Required: False ,
}
string ,
ipv4Address:
{
Description: The IPv4 address assigned to each storage adapter physical node on your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
subnetMask:
{
Description: The SubnetMask address assigned to each storage adapter physical node on your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
storageConnectivitySwitchless:
{
Description: Defines how the storage adapters between nodes are connected either switch or switch less.. ,
Required: False ,
}
boolean ,
enableStorageAutoIp:
{
Description: Optional parameter required only for 3 Nodes Switchless deployments. This allows users to specify IPs and Mask for Storage NICs when Network ATC is not assigning the IPs for storage automatically. ,
Required: False ,
}
boolean ,
}
,
sdnIntegration:
{
Description: SDN Integration config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
networkController:
{
Description: network controller config for SDN Integration to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
macAddressPoolStart:
{
Description: macAddressPoolStart of network controller used for SDN Integration. ,
Required: False ,
}
string ,
macAddressPoolStop:
{
Description: macAddressPoolStop of network controller used for SDN Integration. ,
Required: False ,
}
string ,
networkVirtualizationEnabled:
{
Description: NetworkVirtualizationEnabled of network controller used for SDN Integration. ,
Required: False ,
}
boolean ,
}
,
}
,
isManagementCluster:
{
Description: Is Management Cluster, when true indicates that the cluster is used for managing other clusters ,
Required: False ,
}
boolean ,
adouPath:
{
Description: The path to the Active Directory Organizational Unit container object prepared for the deployment. ,
Required: False ,
}
string ,
secretsLocation:
{
Description: Azure key vault endpoint. This property is deprecated from 2023-12-01-preview. Please use secrets property instead. ,
Required: False ,
}
string ,
secrets:
{
Description: secrets used for cloud deployment. ,
Required: False ,
}
[
{
secretName:
{
Description: Secret name stored in keyvault. ,
Required: False ,
}
string ,
eceSecretName:
{
Description: Secret name expected for Enterprise Cloud Engine (ECE) deployment. ,
Enum:
{
AzureStackLCMUserCredential: AzureStackLCMUserCredential used for LCM operations for AzureStackHCI cluster. ,
DefaultARBApplication: DefaultARBApplication used to manage Azure Arc resource bridge (ARB) for AzureStackHCI cluster. ,
LocalAdminCredential: LocalAdminCredential used for admin operations for AzureStackHCI cluster. ,
WitnessStorageKey: WitnessStorageKey used for setting up a cloud witness for AzureStackHCI cluster. ,
}
,
Required: False ,
}
enum ,
secretLocation:
{
Description: Secret URI stored in keyvault. ,
Format: uri ,
Required: False ,
}
string ,
}
,
]
,
optionalServices:
{
Description: OptionalServices config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
customLocation:
{
Description: The name of custom location. ,
Required: False ,
}
string ,
}
,
localAvailabilityZones:
{
Description: Local Availability Zone information for HCI cluster ,
Required: False ,
}
[
{
localAvailabilityZoneName:
{
Description: Local Availability Zone name for HCI cluster ,
Required: False ,
}
string ,
nodes:
{
Description: Nodes belonging to a particular zone ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
assemblyInfo:
{
Description: Assembly Package details for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
{
packageVersion:
{
Description: Assembly Package version for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
string ,
payload:
{
Description: Payload properties for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
[
{
identifier:
{
Description: assembly identifier for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
string ,
hash:
{
Description: Hash of assembly package for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
string ,
fileName:
{
Description: File name of assembly package for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
string ,
url:
{
Description: Url of assembly package for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
sbePartnerInfo:
{
Description: Solution builder extension (SBE) partner properties ,
Required: False ,
}
{
sbeDeploymentInfo:
{
Description: SBE package and manifest information for the solution Builder Extension staged for AzureStackHCI cluster deployment. ,
Required: False ,
}
{
version:
{
Description: SBE package version. ,
Required: False ,
}
string ,
family:
{
Description: SBE family name. ,
Required: False ,
}
string ,
publisher:
{
Description: SBE manifest publisher. ,
Required: False ,
}
string ,
sbeManifestSource:
{
Description: SBE Manifest Source. ,
Required: False ,
}
string ,
sbeManifestCreationDate:
{
Description: SBE Manifest Creation Date. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
partnerProperties:
{
Description: List of SBE partner properties for AzureStackHCI cluster deployment. ,
Required: False ,
}
[
{
name:
{
Description: SBE partner property name. ,
Required: False ,
}
string ,
value:
{
Description: SBE partner property value. ,
Required: False ,
}
string ,
}
,
]
,
credentialList:
{
Description: SBE credentials list for AzureStackHCI cluster deployment. ,
Required: False ,
}
[
{
secretName:
{
Description: secret name stored in keyvault. ,
Required: False ,
}
string ,
eceSecretName:
{
Description: secret name expected for Enterprise Cloud Engine (ECE). ,
Required: False ,
}
string ,
secretLocation:
{
Description: secret URI stored in keyvault. ,
Format: uri ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
}
,
reportedProperties:
{
Description: Deployment Status reported from cluster. ,
Required: False ,
}
{
validationStatus:
{
Description: validation status of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
{
status:
{
Description: Status of ECE action AzureStackHCI Cluster Deployment. ,
Required: False ,
}
string ,
steps:
{
Description: List of steps of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
{
name:
{
Description: Name of step. ,
Required: False ,
}
string ,
description:
{
Description: Description of step. ,
Required: False ,
}
string ,
fullStepIndex:
{
Description: FullStepIndex of step. ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: Start time of step. ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: End time of step. ,
Required: False ,
}
string ,
status:
{
Description: Status of step. Allowed values are 'Error', 'Success', 'InProgress' ,
Required: False ,
}
string ,
steps:
{
Description: List of nested steps of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
string ,
]
,
exception:
{
Description: List of exceptions in AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
deploymentStatus:
{
Description: Deployment status of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
{
status:
{
Description: Status of ECE action AzureStackHCI Cluster Deployment. ,
Required: False ,
}
string ,
steps:
{
Description: List of steps of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
{
name:
{
Description: Name of step. ,
Required: False ,
}
string ,
description:
{
Description: Description of step. ,
Required: False ,
}
string ,
fullStepIndex:
{
Description: FullStepIndex of step. ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: Start time of step. ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: End time of step. ,
Required: False ,
}
string ,
status:
{
Description: Status of step. Allowed values are 'Error', 'Success', 'InProgress' ,
Required: False ,
}
string ,
steps:
{
Description: List of nested steps of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
string ,
]
,
exception:
{
Description: List of exceptions in AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: DeploymentSetting provisioning state ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
arcNodeResourceIds:
{
Description: Azure resource ids of Arc machines to be part of cluster. ,
Required: True ,
}
[
string ,
]
,
deploymentMode:
{
Description: The deployment mode for cluster deployment. ,
Enum:
{
Validate: Validate ECE action deployment for a cluster. ,
Deploy: Deploy ECE action deployment for a cluster. ,
}
,
Required: True ,
}
enum ,
operationType:
{
Description: The intended operation for a cluster. ,
Enum:
{
ClusterProvisioning: Cluster provisioning operation. ,
ClusterUpgrade: Cluster upgrade operation. ,
}
,
Required: False ,
}
enum ,
deploymentConfiguration:
{
Description: Scale units will contains list of deployment data ,
Required: True ,
}
{
version:
{
Description: deployment template version ,
Required: False ,
}
string ,
scaleUnits:
{
Description: Scale units will contains list of deployment data ,
Required: True ,
}
[
{
deploymentData:
{
Description: Deployment Data to deploy AzureStackHCI Cluster. ,
Required: True ,
}
{
securitySettings:
{
Description: SecuritySettings to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
hvciProtection:
{
Description: By default, Hypervisor-protected Code Integrity is enabled on your Azure HCI cluster. ,
Required: False ,
}
boolean ,
drtmProtection:
{
Description: By default, Secure Boot is enabled on your Azure HCI cluster. This setting is hardware dependent. ,
Required: False ,
}
boolean ,
driftControlEnforced:
{
Description: When set to true, the security baseline is re-applied regularly. ,
Required: False ,
}
boolean ,
credentialGuardEnforced:
{
Description: When set to true, Credential Guard is enabled. ,
Required: False ,
}
boolean ,
smbSigningEnforced:
{
Description: When set to true, the SMB default instance requires sign in for the client and server services. ,
Required: False ,
}
boolean ,
smbClusterEncryption:
{
Description: When set to true, cluster east-west traffic is encrypted. ,
Required: False ,
}
boolean ,
sideChannelMitigationEnforced:
{
Description: When set to true, all the side channel mitigations are enabled ,
Required: False ,
}
boolean ,
bitlockerBootVolume:
{
Description: When set to true, BitLocker XTS_AES 256-bit encryption is enabled for all data-at-rest on the OS volume of your Azure Stack HCI cluster. This setting is TPM-hardware dependent. ,
Required: False ,
}
boolean ,
bitlockerDataVolumes:
{
Description: When set to true, BitLocker XTS-AES 256-bit encryption is enabled for all data-at-rest on your Azure Stack HCI cluster shared volumes. ,
Required: False ,
}
boolean ,
wdacEnforced:
{
Description: WDAC is enabled by default and limits the applications and the code that you can run on your Azure Stack HCI cluster. ,
Required: False ,
}
boolean ,
}
,
observability:
{
Description: Observability config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
streamingDataClient:
{
Description: Enables telemetry data to be sent to Microsoft ,
Required: False ,
}
boolean ,
euLocation:
{
Description: Location of your cluster. The log and diagnostic data is sent to the appropriate diagnostics servers depending upon where your cluster resides. Setting this to false results in all data sent to Microsoft to be stored outside of the EU. ,
Required: False ,
}
boolean ,
episodicDataUpload:
{
Description: When set to true, collects log data to facilitate quicker issue resolution. ,
Required: False ,
}
boolean ,
}
,
cluster:
{
Description: Observability config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
name:
{
Description: The cluster name provided when preparing Active Directory. ,
Required: False ,
}
string ,
witnessType:
{
Description: Use a cloud witness if you have internet access and if you use an Azure Storage account to provide a vote on cluster quorum. A cloud witness uses Azure Blob Storage to read or write a blob file and then uses it to arbitrate in split-brain resolution. Only allowed values are 'Cloud', 'FileShare'. ,
Required: False ,
}
string ,
witnessPath:
{
Description: Specify the fileshare path for the local witness for your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
cloudAccountName:
{
Description: Specify the Azure Storage account name for cloud witness for your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
azureServiceEndpoint:
{
Description: For Azure blob service endpoint type, select either Default or Custom domain. If you selected **Custom domain, enter the domain for the blob service in this format core.windows.net. ,
Required: False ,
}
string ,
hardwareClass:
{
Description: Hardware class of the cluster. ,
Enum:
{
Small: The hardware class is small. ,
Medium: The hardware class is medium. This corresponds to the default ,
Large: The hardware class is large. ,
}
,
Required: False ,
}
enum ,
clusterPattern:
{
Description: Cluster Pattern supported. ,
Enum:
{
Standard: Standard cluster. ,
RackAware: RackAware cluster. ,
}
,
Required: False ,
}
enum ,
}
,
identityProvider:
{
Description: Identity Provider for the cluster ,
Enum:
{
ActiveDirectory: Uses Active Directory as the identity provider, enabling domain-based authentication and centralized identity management. This is the default option. ,
LocalIdentity: Uses a local identity system integrated with Azure Key Vault for authentication. Suitable for AD-less environments where Active Directory is not available or required. ,
}
,
Required: False ,
}
enum ,
storage:
{
Description: Storage config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
configurationMode:
{
Description: By default, this mode is set to Express and your storage is configured as per best practices based on the number of nodes in the cluster. Allowed values are 'Express','InfraOnly', 'KeepStorage' ,
Required: False ,
}
string ,
}
,
namingPrefix:
{
Description: naming prefix to deploy cluster. ,
Required: False ,
}
string ,
domainFqdn:
{
Description: FQDN to deploy cluster ,
Required: False ,
}
string ,
infrastructureNetwork:
{
Description: InfrastructureNetwork config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
[
{
subnetMask:
{
Description: Subnet mask that matches the provided IP address space. ,
Required: False ,
}
string ,
gateway:
{
Description: Default gateway that should be used for the provided IP address space. ,
Required: False ,
}
string ,
ipPools:
{
Description: Range of IP addresses from which addresses are allocated for nodes within a subnet. ,
Required: False ,
}
[
{
startingAddress:
{
Description: Starting IP address for the management network. A minimum of six free, contiguous IPv4 addresses (excluding your host IPs) are needed for infrastructure services such as clustering. ,
Required: False ,
}
string ,
endingAddress:
{
Description: Ending IP address for the management network. A minimum of six free, contiguous IPv4 addresses (excluding your host IPs) are needed for infrastructure services such as clustering. ,
Required: False ,
}
string ,
}
,
]
,
dnsServerConfig:
{
Description: Specifies how DNS servers are configured for the infrastructure network. Allowed values are 'UseDnsServer' to use the provided DNS servers, and 'UseForwarder' to use DNS forwarders. ,
Enum:
{
UseDnsServer: Use the provided DNS servers for the infrastructure network. ,
UseForwarder: Use DNS forwarders for the infrastructure network. ,
}
,
Required: False ,
}
enum ,
dnsZones:
{
Description: Details of the DNS Zones to be configured. ,
Required: False ,
}
[
{
dnsZoneName:
{
Description: Name of the DNS Zone to be configured. ,
Required: False ,
}
string ,
dnsForwarder:
{
Description: Forwarder details of the DNS Zone to be configured. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
dnsServers:
{
Description: IPv4 address of the DNS servers in your environment. ,
Required: False ,
}
[
string ,
]
,
useDhcp:
{
Description: Allows customers to use DHCP for Hosts and Cluster IPs. If not declared, the deployment will default to static IPs. When true, GW and DNS servers are not required ,
Required: False ,
}
boolean ,
}
,
]
,
physicalNodes:
{
Description: list of physical nodes config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
[
{
name:
{
Description: NETBIOS name of each physical server on your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
ipv4Address:
{
Description: The IPv4 address assigned to each physical server on your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
}
,
]
,
hostNetwork:
{
Description: HostNetwork config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
intents:
{
Description: The network intents assigned to the network reference pattern used for the deployment. Each intent will define its own name, traffic type, adapter names, and overrides as recommended by your OEM. ,
Required: False ,
}
[
{
name:
{
Description: Name of the network intent you wish to create. ,
Required: False ,
}
string ,
trafficType:
{
Description: List of network traffic types. Only allowed values are 'Compute', 'Storage', 'Management'. ,
Required: False ,
}
[
string ,
]
,
adapter:
{
Description: Array of network interfaces used for the network intent. ,
Required: False ,
}
[
string ,
]
,
overrideVirtualSwitchConfiguration:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
boolean ,
virtualSwitchConfigurationOverrides:
{
Description: Set virtualSwitch ConfigurationOverrides for cluster. ,
Required: False ,
}
{
enableIov:
{
Description: Enable IoV for Virtual Switch ,
Required: False ,
}
string ,
loadBalancingAlgorithm:
{
Description: Load Balancing Algorithm for Virtual Switch ,
Required: False ,
}
string ,
}
,
overrideQosPolicy:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
boolean ,
qosPolicyOverrides:
{
Description: Set QoS PolicyOverrides for cluster. ,
Required: False ,
}
{
priorityValue8021Action_Cluster:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
string ,
priorityValue8021Action_SMB:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
string ,
bandwidthPercentage_SMB:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
string ,
}
,
overrideAdapterProperty:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
boolean ,
adapterPropertyOverrides:
{
Description: Set Adapter PropertyOverrides for cluster. ,
Required: False ,
}
{
jumboPacket:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
string ,
networkDirect:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
string ,
networkDirectTechnology:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. Expected values are 'iWARP', 'RoCEv2', 'RoCE' ,
Required: False ,
}
string ,
}
,
}
,
]
,
storageNetworks:
{
Description: List of StorageNetworks config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
[
{
name:
{
Description: Name of the storage network. ,
Required: False ,
}
string ,
networkAdapterName:
{
Description: Name of the storage network adapter. ,
Required: False ,
}
string ,
vlanId:
{
Description: ID specified for the VLAN storage network. This setting is applied to the network interfaces that route the storage and VM migration traffic. ,
Required: False ,
}
string ,
storageAdapterIPInfo:
{
Description: List of Storage adapter physical nodes config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
[
{
physicalNode:
{
Description: storage adapter physical node name. ,
Required: False ,
}
string ,
ipv4Address:
{
Description: The IPv4 address assigned to each storage adapter physical node on your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
subnetMask:
{
Description: The SubnetMask address assigned to each storage adapter physical node on your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
storageConnectivitySwitchless:
{
Description: Defines how the storage adapters between nodes are connected either switch or switch less.. ,
Required: False ,
}
boolean ,
enableStorageAutoIp:
{
Description: Optional parameter required only for 3 Nodes Switchless deployments. This allows users to specify IPs and Mask for Storage NICs when Network ATC is not assigning the IPs for storage automatically. ,
Required: False ,
}
boolean ,
}
,
sdnIntegration:
{
Description: SDN Integration config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
networkController:
{
Description: network controller config for SDN Integration to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
macAddressPoolStart:
{
Description: macAddressPoolStart of network controller used for SDN Integration. ,
Required: False ,
}
string ,
macAddressPoolStop:
{
Description: macAddressPoolStop of network controller used for SDN Integration. ,
Required: False ,
}
string ,
networkVirtualizationEnabled:
{
Description: NetworkVirtualizationEnabled of network controller used for SDN Integration. ,
Required: False ,
}
boolean ,
}
,
}
,
isManagementCluster:
{
Description: Is Management Cluster, when true indicates that the cluster is used for managing other clusters ,
Required: False ,
}
boolean ,
adouPath:
{
Description: The path to the Active Directory Organizational Unit container object prepared for the deployment. ,
Required: False ,
}
string ,
secretsLocation:
{
Description: Azure key vault endpoint. This property is deprecated from 2023-12-01-preview. Please use secrets property instead. ,
Required: False ,
}
string ,
secrets:
{
Description: secrets used for cloud deployment. ,
Required: False ,
}
[
{
secretName:
{
Description: Secret name stored in keyvault. ,
Required: False ,
}
string ,
eceSecretName:
{
Description: Secret name expected for Enterprise Cloud Engine (ECE) deployment. ,
Enum:
{
AzureStackLCMUserCredential: AzureStackLCMUserCredential used for LCM operations for AzureStackHCI cluster. ,
DefaultARBApplication: DefaultARBApplication used to manage Azure Arc resource bridge (ARB) for AzureStackHCI cluster. ,
LocalAdminCredential: LocalAdminCredential used for admin operations for AzureStackHCI cluster. ,
WitnessStorageKey: WitnessStorageKey used for setting up a cloud witness for AzureStackHCI cluster. ,
}
,
Required: False ,
}
enum ,
secretLocation:
{
Description: Secret URI stored in keyvault. ,
Format: uri ,
Required: False ,
}
string ,
}
,
]
,
optionalServices:
{
Description: OptionalServices config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
customLocation:
{
Description: The name of custom location. ,
Required: False ,
}
string ,
}
,
localAvailabilityZones:
{
Description: Local Availability Zone information for HCI cluster ,
Required: False ,
}
[
{
localAvailabilityZoneName:
{
Description: Local Availability Zone name for HCI cluster ,
Required: False ,
}
string ,
nodes:
{
Description: Nodes belonging to a particular zone ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
assemblyInfo:
{
Description: Assembly Package details for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
{
packageVersion:
{
Description: Assembly Package version for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
string ,
payload:
{
Description: Payload properties for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
[
{
identifier:
{
Description: assembly identifier for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
string ,
hash:
{
Description: Hash of assembly package for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
string ,
fileName:
{
Description: File name of assembly package for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
string ,
url:
{
Description: Url of assembly package for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
sbePartnerInfo:
{
Description: Solution builder extension (SBE) partner properties ,
Required: False ,
}
{
sbeDeploymentInfo:
{
Description: SBE package and manifest information for the solution Builder Extension staged for AzureStackHCI cluster deployment. ,
Required: False ,
}
{
version:
{
Description: SBE package version. ,
Required: False ,
}
string ,
family:
{
Description: SBE family name. ,
Required: False ,
}
string ,
publisher:
{
Description: SBE manifest publisher. ,
Required: False ,
}
string ,
sbeManifestSource:
{
Description: SBE Manifest Source. ,
Required: False ,
}
string ,
sbeManifestCreationDate:
{
Description: SBE Manifest Creation Date. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
partnerProperties:
{
Description: List of SBE partner properties for AzureStackHCI cluster deployment. ,
Required: False ,
}
[
{
name:
{
Description: SBE partner property name. ,
Required: False ,
}
string ,
value:
{
Description: SBE partner property value. ,
Required: False ,
}
string ,
}
,
]
,
credentialList:
{
Description: SBE credentials list for AzureStackHCI cluster deployment. ,
Required: False ,
}
[
{
secretName:
{
Description: secret name stored in keyvault. ,
Required: False ,
}
string ,
eceSecretName:
{
Description: secret name expected for Enterprise Cloud Engine (ECE). ,
Required: False ,
}
string ,
secretLocation:
{
Description: secret URI stored in keyvault. ,
Format: uri ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
}
,
reportedProperties:
{
Description: Deployment Status reported from cluster. ,
Required: False ,
}
{
validationStatus:
{
Description: validation status of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
{
status:
{
Description: Status of ECE action AzureStackHCI Cluster Deployment. ,
Required: False ,
}
string ,
steps:
{
Description: List of steps of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
{
name:
{
Description: Name of step. ,
Required: False ,
}
string ,
description:
{
Description: Description of step. ,
Required: False ,
}
string ,
fullStepIndex:
{
Description: FullStepIndex of step. ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: Start time of step. ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: End time of step. ,
Required: False ,
}
string ,
status:
{
Description: Status of step. Allowed values are 'Error', 'Success', 'InProgress' ,
Required: False ,
}
string ,
steps:
{
Description: List of nested steps of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
string ,
]
,
exception:
{
Description: List of exceptions in AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
deploymentStatus:
{
Description: Deployment status of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
{
status:
{
Description: Status of ECE action AzureStackHCI Cluster Deployment. ,
Required: False ,
}
string ,
steps:
{
Description: List of steps of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
{
name:
{
Description: Name of step. ,
Required: False ,
}
string ,
description:
{
Description: Description of step. ,
Required: False ,
}
string ,
fullStepIndex:
{
Description: FullStepIndex of step. ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: Start time of step. ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: End time of step. ,
Required: False ,
}
string ,
status:
{
Description: Status of step. Allowed values are 'Error', 'Success', 'InProgress' ,
Required: False ,
}
string ,
steps:
{
Description: List of nested steps of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
string ,
]
,
exception:
{
Description: List of exceptions in AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Edge device resource ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: DeploymentSetting provisioning state ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
arcNodeResourceIds:
{
Description: Azure resource ids of Arc machines to be part of cluster. ,
Required: True ,
}
[
string ,
]
,
deploymentMode:
{
Description: The deployment mode for cluster deployment. ,
Enum:
{
Validate: Validate ECE action deployment for a cluster. ,
Deploy: Deploy ECE action deployment for a cluster. ,
}
,
Required: True ,
}
enum ,
operationType:
{
Description: The intended operation for a cluster. ,
Enum:
{
ClusterProvisioning: Cluster provisioning operation. ,
ClusterUpgrade: Cluster upgrade operation. ,
}
,
Required: False ,
}
enum ,
deploymentConfiguration:
{
Description: Scale units will contains list of deployment data ,
Required: True ,
}
{
version:
{
Description: deployment template version ,
Required: False ,
}
string ,
scaleUnits:
{
Description: Scale units will contains list of deployment data ,
Required: True ,
}
[
{
deploymentData:
{
Description: Deployment Data to deploy AzureStackHCI Cluster. ,
Required: True ,
}
{
securitySettings:
{
Description: SecuritySettings to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
hvciProtection:
{
Description: By default, Hypervisor-protected Code Integrity is enabled on your Azure HCI cluster. ,
Required: False ,
}
boolean ,
drtmProtection:
{
Description: By default, Secure Boot is enabled on your Azure HCI cluster. This setting is hardware dependent. ,
Required: False ,
}
boolean ,
driftControlEnforced:
{
Description: When set to true, the security baseline is re-applied regularly. ,
Required: False ,
}
boolean ,
credentialGuardEnforced:
{
Description: When set to true, Credential Guard is enabled. ,
Required: False ,
}
boolean ,
smbSigningEnforced:
{
Description: When set to true, the SMB default instance requires sign in for the client and server services. ,
Required: False ,
}
boolean ,
smbClusterEncryption:
{
Description: When set to true, cluster east-west traffic is encrypted. ,
Required: False ,
}
boolean ,
sideChannelMitigationEnforced:
{
Description: When set to true, all the side channel mitigations are enabled ,
Required: False ,
}
boolean ,
bitlockerBootVolume:
{
Description: When set to true, BitLocker XTS_AES 256-bit encryption is enabled for all data-at-rest on the OS volume of your Azure Stack HCI cluster. This setting is TPM-hardware dependent. ,
Required: False ,
}
boolean ,
bitlockerDataVolumes:
{
Description: When set to true, BitLocker XTS-AES 256-bit encryption is enabled for all data-at-rest on your Azure Stack HCI cluster shared volumes. ,
Required: False ,
}
boolean ,
wdacEnforced:
{
Description: WDAC is enabled by default and limits the applications and the code that you can run on your Azure Stack HCI cluster. ,
Required: False ,
}
boolean ,
}
,
observability:
{
Description: Observability config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
streamingDataClient:
{
Description: Enables telemetry data to be sent to Microsoft ,
Required: False ,
}
boolean ,
euLocation:
{
Description: Location of your cluster. The log and diagnostic data is sent to the appropriate diagnostics servers depending upon where your cluster resides. Setting this to false results in all data sent to Microsoft to be stored outside of the EU. ,
Required: False ,
}
boolean ,
episodicDataUpload:
{
Description: When set to true, collects log data to facilitate quicker issue resolution. ,
Required: False ,
}
boolean ,
}
,
cluster:
{
Description: Observability config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
name:
{
Description: The cluster name provided when preparing Active Directory. ,
Required: False ,
}
string ,
witnessType:
{
Description: Use a cloud witness if you have internet access and if you use an Azure Storage account to provide a vote on cluster quorum. A cloud witness uses Azure Blob Storage to read or write a blob file and then uses it to arbitrate in split-brain resolution. Only allowed values are 'Cloud', 'FileShare'. ,
Required: False ,
}
string ,
witnessPath:
{
Description: Specify the fileshare path for the local witness for your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
cloudAccountName:
{
Description: Specify the Azure Storage account name for cloud witness for your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
azureServiceEndpoint:
{
Description: For Azure blob service endpoint type, select either Default or Custom domain. If you selected **Custom domain, enter the domain for the blob service in this format core.windows.net. ,
Required: False ,
}
string ,
hardwareClass:
{
Description: Hardware class of the cluster. ,
Enum:
{
Small: The hardware class is small. ,
Medium: The hardware class is medium. This corresponds to the default ,
Large: The hardware class is large. ,
}
,
Required: False ,
}
enum ,
clusterPattern:
{
Description: Cluster Pattern supported. ,
Enum:
{
Standard: Standard cluster. ,
RackAware: RackAware cluster. ,
}
,
Required: False ,
}
enum ,
}
,
identityProvider:
{
Description: Identity Provider for the cluster ,
Enum:
{
ActiveDirectory: Uses Active Directory as the identity provider, enabling domain-based authentication and centralized identity management. This is the default option. ,
LocalIdentity: Uses a local identity system integrated with Azure Key Vault for authentication. Suitable for AD-less environments where Active Directory is not available or required. ,
}
,
Required: False ,
}
enum ,
storage:
{
Description: Storage config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
configurationMode:
{
Description: By default, this mode is set to Express and your storage is configured as per best practices based on the number of nodes in the cluster. Allowed values are 'Express','InfraOnly', 'KeepStorage' ,
Required: False ,
}
string ,
}
,
namingPrefix:
{
Description: naming prefix to deploy cluster. ,
Required: False ,
}
string ,
domainFqdn:
{
Description: FQDN to deploy cluster ,
Required: False ,
}
string ,
infrastructureNetwork:
{
Description: InfrastructureNetwork config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
[
{
subnetMask:
{
Description: Subnet mask that matches the provided IP address space. ,
Required: False ,
}
string ,
gateway:
{
Description: Default gateway that should be used for the provided IP address space. ,
Required: False ,
}
string ,
ipPools:
{
Description: Range of IP addresses from which addresses are allocated for nodes within a subnet. ,
Required: False ,
}
[
{
startingAddress:
{
Description: Starting IP address for the management network. A minimum of six free, contiguous IPv4 addresses (excluding your host IPs) are needed for infrastructure services such as clustering. ,
Required: False ,
}
string ,
endingAddress:
{
Description: Ending IP address for the management network. A minimum of six free, contiguous IPv4 addresses (excluding your host IPs) are needed for infrastructure services such as clustering. ,
Required: False ,
}
string ,
}
,
]
,
dnsServerConfig:
{
Description: Specifies how DNS servers are configured for the infrastructure network. Allowed values are 'UseDnsServer' to use the provided DNS servers, and 'UseForwarder' to use DNS forwarders. ,
Enum:
{
UseDnsServer: Use the provided DNS servers for the infrastructure network. ,
UseForwarder: Use DNS forwarders for the infrastructure network. ,
}
,
Required: False ,
}
enum ,
dnsZones:
{
Description: Details of the DNS Zones to be configured. ,
Required: False ,
}
[
{
dnsZoneName:
{
Description: Name of the DNS Zone to be configured. ,
Required: False ,
}
string ,
dnsForwarder:
{
Description: Forwarder details of the DNS Zone to be configured. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
dnsServers:
{
Description: IPv4 address of the DNS servers in your environment. ,
Required: False ,
}
[
string ,
]
,
useDhcp:
{
Description: Allows customers to use DHCP for Hosts and Cluster IPs. If not declared, the deployment will default to static IPs. When true, GW and DNS servers are not required ,
Required: False ,
}
boolean ,
}
,
]
,
physicalNodes:
{
Description: list of physical nodes config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
[
{
name:
{
Description: NETBIOS name of each physical server on your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
ipv4Address:
{
Description: The IPv4 address assigned to each physical server on your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
}
,
]
,
hostNetwork:
{
Description: HostNetwork config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
intents:
{
Description: The network intents assigned to the network reference pattern used for the deployment. Each intent will define its own name, traffic type, adapter names, and overrides as recommended by your OEM. ,
Required: False ,
}
[
{
name:
{
Description: Name of the network intent you wish to create. ,
Required: False ,
}
string ,
trafficType:
{
Description: List of network traffic types. Only allowed values are 'Compute', 'Storage', 'Management'. ,
Required: False ,
}
[
string ,
]
,
adapter:
{
Description: Array of network interfaces used for the network intent. ,
Required: False ,
}
[
string ,
]
,
overrideVirtualSwitchConfiguration:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
boolean ,
virtualSwitchConfigurationOverrides:
{
Description: Set virtualSwitch ConfigurationOverrides for cluster. ,
Required: False ,
}
{
enableIov:
{
Description: Enable IoV for Virtual Switch ,
Required: False ,
}
string ,
loadBalancingAlgorithm:
{
Description: Load Balancing Algorithm for Virtual Switch ,
Required: False ,
}
string ,
}
,
overrideQosPolicy:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
boolean ,
qosPolicyOverrides:
{
Description: Set QoS PolicyOverrides for cluster. ,
Required: False ,
}
{
priorityValue8021Action_Cluster:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
string ,
priorityValue8021Action_SMB:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
string ,
bandwidthPercentage_SMB:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
string ,
}
,
overrideAdapterProperty:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
boolean ,
adapterPropertyOverrides:
{
Description: Set Adapter PropertyOverrides for cluster. ,
Required: False ,
}
{
jumboPacket:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
string ,
networkDirect:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
string ,
networkDirectTechnology:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. Expected values are 'iWARP', 'RoCEv2', 'RoCE' ,
Required: False ,
}
string ,
}
,
}
,
]
,
storageNetworks:
{
Description: List of StorageNetworks config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
[
{
name:
{
Description: Name of the storage network. ,
Required: False ,
}
string ,
networkAdapterName:
{
Description: Name of the storage network adapter. ,
Required: False ,
}
string ,
vlanId:
{
Description: ID specified for the VLAN storage network. This setting is applied to the network interfaces that route the storage and VM migration traffic. ,
Required: False ,
}
string ,
storageAdapterIPInfo:
{
Description: List of Storage adapter physical nodes config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
[
{
physicalNode:
{
Description: storage adapter physical node name. ,
Required: False ,
}
string ,
ipv4Address:
{
Description: The IPv4 address assigned to each storage adapter physical node on your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
subnetMask:
{
Description: The SubnetMask address assigned to each storage adapter physical node on your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
storageConnectivitySwitchless:
{
Description: Defines how the storage adapters between nodes are connected either switch or switch less.. ,
Required: False ,
}
boolean ,
enableStorageAutoIp:
{
Description: Optional parameter required only for 3 Nodes Switchless deployments. This allows users to specify IPs and Mask for Storage NICs when Network ATC is not assigning the IPs for storage automatically. ,
Required: False ,
}
boolean ,
}
,
sdnIntegration:
{
Description: SDN Integration config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
networkController:
{
Description: network controller config for SDN Integration to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
macAddressPoolStart:
{
Description: macAddressPoolStart of network controller used for SDN Integration. ,
Required: False ,
}
string ,
macAddressPoolStop:
{
Description: macAddressPoolStop of network controller used for SDN Integration. ,
Required: False ,
}
string ,
networkVirtualizationEnabled:
{
Description: NetworkVirtualizationEnabled of network controller used for SDN Integration. ,
Required: False ,
}
boolean ,
}
,
}
,
isManagementCluster:
{
Description: Is Management Cluster, when true indicates that the cluster is used for managing other clusters ,
Required: False ,
}
boolean ,
adouPath:
{
Description: The path to the Active Directory Organizational Unit container object prepared for the deployment. ,
Required: False ,
}
string ,
secretsLocation:
{
Description: Azure key vault endpoint. This property is deprecated from 2023-12-01-preview. Please use secrets property instead. ,
Required: False ,
}
string ,
secrets:
{
Description: secrets used for cloud deployment. ,
Required: False ,
}
[
{
secretName:
{
Description: Secret name stored in keyvault. ,
Required: False ,
}
string ,
eceSecretName:
{
Description: Secret name expected for Enterprise Cloud Engine (ECE) deployment. ,
Enum:
{
AzureStackLCMUserCredential: AzureStackLCMUserCredential used for LCM operations for AzureStackHCI cluster. ,
DefaultARBApplication: DefaultARBApplication used to manage Azure Arc resource bridge (ARB) for AzureStackHCI cluster. ,
LocalAdminCredential: LocalAdminCredential used for admin operations for AzureStackHCI cluster. ,
WitnessStorageKey: WitnessStorageKey used for setting up a cloud witness for AzureStackHCI cluster. ,
}
,
Required: False ,
}
enum ,
secretLocation:
{
Description: Secret URI stored in keyvault. ,
Format: uri ,
Required: False ,
}
string ,
}
,
]
,
optionalServices:
{
Description: OptionalServices config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
customLocation:
{
Description: The name of custom location. ,
Required: False ,
}
string ,
}
,
localAvailabilityZones:
{
Description: Local Availability Zone information for HCI cluster ,
Required: False ,
}
[
{
localAvailabilityZoneName:
{
Description: Local Availability Zone name for HCI cluster ,
Required: False ,
}
string ,
nodes:
{
Description: Nodes belonging to a particular zone ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
assemblyInfo:
{
Description: Assembly Package details for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
{
packageVersion:
{
Description: Assembly Package version for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
string ,
payload:
{
Description: Payload properties for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
[
{
identifier:
{
Description: assembly identifier for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
string ,
hash:
{
Description: Hash of assembly package for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
string ,
fileName:
{
Description: File name of assembly package for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
string ,
url:
{
Description: Url of assembly package for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
sbePartnerInfo:
{
Description: Solution builder extension (SBE) partner properties ,
Required: False ,
}
{
sbeDeploymentInfo:
{
Description: SBE package and manifest information for the solution Builder Extension staged for AzureStackHCI cluster deployment. ,
Required: False ,
}
{
version:
{
Description: SBE package version. ,
Required: False ,
}
string ,
family:
{
Description: SBE family name. ,
Required: False ,
}
string ,
publisher:
{
Description: SBE manifest publisher. ,
Required: False ,
}
string ,
sbeManifestSource:
{
Description: SBE Manifest Source. ,
Required: False ,
}
string ,
sbeManifestCreationDate:
{
Description: SBE Manifest Creation Date. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
partnerProperties:
{
Description: List of SBE partner properties for AzureStackHCI cluster deployment. ,
Required: False ,
}
[
{
name:
{
Description: SBE partner property name. ,
Required: False ,
}
string ,
value:
{
Description: SBE partner property value. ,
Required: False ,
}
string ,
}
,
]
,
credentialList:
{
Description: SBE credentials list for AzureStackHCI cluster deployment. ,
Required: False ,
}
[
{
secretName:
{
Description: secret name stored in keyvault. ,
Required: False ,
}
string ,
eceSecretName:
{
Description: secret name expected for Enterprise Cloud Engine (ECE). ,
Required: False ,
}
string ,
secretLocation:
{
Description: secret URI stored in keyvault. ,
Format: uri ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
}
,
reportedProperties:
{
Description: Deployment Status reported from cluster. ,
Required: False ,
}
{
validationStatus:
{
Description: validation status of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
{
status:
{
Description: Status of ECE action AzureStackHCI Cluster Deployment. ,
Required: False ,
}
string ,
steps:
{
Description: List of steps of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
{
name:
{
Description: Name of step. ,
Required: False ,
}
string ,
description:
{
Description: Description of step. ,
Required: False ,
}
string ,
fullStepIndex:
{
Description: FullStepIndex of step. ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: Start time of step. ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: End time of step. ,
Required: False ,
}
string ,
status:
{
Description: Status of step. Allowed values are 'Error', 'Success', 'InProgress' ,
Required: False ,
}
string ,
steps:
{
Description: List of nested steps of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
string ,
]
,
exception:
{
Description: List of exceptions in AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
deploymentStatus:
{
Description: Deployment status of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
{
status:
{
Description: Status of ECE action AzureStackHCI Cluster Deployment. ,
Required: False ,
}
string ,
steps:
{
Description: List of steps of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
{
name:
{
Description: Name of step. ,
Required: False ,
}
string ,
description:
{
Description: Description of step. ,
Required: False ,
}
string ,
fullStepIndex:
{
Description: FullStepIndex of step. ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: Start time of step. ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: End time of step. ,
Required: False ,
}
string ,
status:
{
Description: Status of step. Allowed values are 'Error', 'Success', 'InProgress' ,
Required: False ,
}
string ,
steps:
{
Description: List of nested steps of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
string ,
]
,
exception:
{
Description: List of exceptions in AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeploymentSettings_Delete (new)
Description :  Delete a DeploymentSetting
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/deploymentSettings/{deploymentSettingsName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
deploymentSettingsName:
{
Description: Name of Deployment Setting ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_ExtendSoftwareAssuranceBenefit (new)
Description :  Extends Software Assurance Benefit to a cluster
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/extendSoftwareAssuranceBenefit
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
softwareAssuranceChangeRequest:
{
Description: Software Assurance Change Request Payload ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
softwareAssuranceIntent:
{
Description: Customer Intent for Software Assurance Benefit. This indicates whether the customer wishes to opt in or out of the Software Assurance program, which provides licensing and support benefits. ,
Enum:
{
Enable: Customer intends to enable the Software Assurance benefit. ,
Disable: Customer intends to disable the Software Assurance benefit. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Cluster properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state. Indicates the current lifecycle status of the resource, including creation, update, deletion, connectivity, and error states. ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Status of the cluster agent. Indicates the current connectivity, validation, and deployment state of the agent within the cluster. ,
Enum:
{
NotYetRegistered: The cluster agent has not yet registered with Azure. ,
ConnectedRecently: The cluster agent has connected to Azure recently. ,
NotConnectedRecently: The cluster agent has not connected to Azure recently. ,
Disconnected: The cluster agent is currently disconnected from Azure. ,
Error: An error occurred in the cluster agent's operation. ,
NotSpecified: The status of the cluster agent is not specified. ,
ValidationInProgress: Validation of the cluster agent is currently in progress. ,
ValidationSuccess: Validation of the cluster agent completed successfully. ,
ValidationFailed: Validation of the cluster agent failed. ,
DeploymentInProgress: Deployment of the cluster agent is currently in progress. ,
DeploymentFailed: Deployment of the cluster agent failed. ,
DeploymentSuccess: Deployment of the cluster agent completed successfully. ,
}
,
Required: False ,
}
enum ,
connectivityStatus:
{
Description: Overall connectivity status for the cluster resource. Indicates whether the cluster is connected to Azure, partially connected, or has not recently communicated. ,
Enum:
{
NotYetRegistered: The cluster has not yet registered with Azure. ,
Connected: The cluster is fully connected to Azure. ,
NotConnectedRecently: The cluster has not connected to Azure recently. ,
PartiallyConnected: Some components of the cluster are connected, while others are not. ,
Disconnected: The cluster is not connected to Azure. ,
NotSpecified: The connectivity status is not specified. ,
}
,
Required: False ,
}
enum ,
supportStatus:
{
Description: Indicates whether the cluster is under support. ,
Enum:
{
InSupport: The cluster is under support. ,
OutOfSupport: The cluster is out of support. ,
NotSpecified: The support status is not specified. ,
}
,
Required: False ,
}
enum ,
cloudId:
{
Description: Unique, immutable resource id. ,
Required: False ,
}
string ,
ring:
{
Description: The ring to which this cluster belongs to. ,
Required: False ,
}
string ,
cloudManagementEndpoint:
{
Description: Endpoint configured for management from the Azure portal. ,
Required: False ,
}
string ,
aadClientId:
{
Description: App id of cluster AAD identity. ,
Required: False ,
}
string ,
aadTenantId:
{
Description: Tenant id of cluster AAD identity. ,
Required: False ,
}
string ,
aadApplicationObjectId:
{
Description: Object id of cluster AAD identity. ,
Required: False ,
}
string ,
aadServicePrincipalObjectId:
{
Description: Id of cluster identity service principal. ,
Required: False ,
}
string ,
softwareAssuranceProperties:
{
Description: Software Assurance properties of the cluster. ,
Required: False ,
}
{
softwareAssuranceStatus:
{
Description: Status of the Software Assurance for the cluster. ,
Enum:
{
Enabled: Software Assurance is enabled for the cluster. ,
Disabled: Software Assurance is disabled for the cluster. ,
}
,
Required: False ,
}
enum ,
softwareAssuranceIntent:
{
Description: Customer Intent for Software Assurance Benefit. ,
Enum:
{
Enable: Customer intends to enable the Software Assurance benefit. ,
Disable: Customer intends to disable the Software Assurance benefit. ,
}
,
Required: False ,
}
enum ,
lastUpdated:
{
Description: TimeStamp denoting the latest SA benefit applicability is validated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
isManagementCluster:
{
Description: Is Management Cluster, when true indicates that the cluster is used for managing other clusters ,
Required: False ,
}
boolean ,
logCollectionProperties:
{
Description: Log Collection properties of the cluster. ,
Required: False ,
}
{
fromDate:
{
Description: From DateTimeStamp from when logs need to be connected ,
Format: date-time ,
Required: False ,
}
string ,
toDate:
{
Description: To DateTimeStamp till when logs need to be connected ,
Format: date-time ,
Required: False ,
}
string ,
lastLogGenerated:
{
Description: Recent DateTimeStamp where logs are successfully generated ,
Format: date-time ,
Required: False ,
}
string ,
logCollectionSessionDetails:
{
Required: False ,
}
[
{
logStartTime:
{
Description: Start Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
logEndTime:
{
Description: End Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
timeCollected:
{
Description: Duration of logs collected ,
Format: date-time ,
Required: False ,
}
string ,
logSize:
{
Description: Size of the logs collected ,
Format: int64 ,
Required: False ,
}
integer ,
logCollectionStatus:
{
Description: LogCollection status ,
Enum:
{
None: No log collection has been initiated. ,
InProgress: Log collection is currently in progress. ,
Failed: Log collection has failed. ,
Succeeded: Log collection completed successfully. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: CorrelationId of the log collection ,
Required: False ,
}
string ,
logCollectionJobType:
{
Description: Specifies the type of log collection job. Determines whether the logs are collected immediately on demand or as part of a scheduled operation. ,
Enum:
{
OnDemand: Log collection is triggered manually and executed immediately. ,
Scheduled: Log collection is scheduled to run at a predefined time or interval. ,
}
,
Required: False ,
}
enum ,
endTimeCollected:
{
Description: End Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
logCollectionError:
{
Description: Log Collection Error details of the cluster. ,
Required: False ,
}
{
errorCode:
{
Description: Error Code of the log collection ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error Message of the log collection ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
remoteSupportProperties:
{
Description: RemoteSupport properties of the cluster. ,
Required: False ,
}
{
accessLevel:
{
Description: Remote Support Access Level ,
Enum:
{
Diagnostics: Allows remote diagnostics operations only. ,
DiagnosticsAndRepair: Allows both remote diagnostics and repair operations. ,
}
,
Required: False ,
}
enum ,
expirationTimeStamp:
{
Description: Expiration DateTimeStamp when Remote Support Access will be expired ,
Format: date-time ,
Required: False ,
}
string ,
remoteSupportType:
{
Description: Remote Support Type for cluster ,
Enum:
{
Enable: Enable remote support for the cluster. ,
Revoke: Revoke previously enabled remote support for the cluster. ,
}
,
Required: False ,
}
enum ,
remoteSupportNodeSettings:
{
Required: False ,
}
[
{
arcResourceId:
{
Description: Arc ResourceId of the Node ,
Required: False ,
}
string ,
state:
{
Description: Remote Support Access Connection State on the Node ,
Required: False ,
}
string ,
createdAt:
{
Description: Remote Support Enablement Request Created TimeStamp on the Node ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: Remote Support Enablement Request Updated TimeStamp on the Node ,
Format: date-time ,
Required: False ,
}
string ,
connectionStatus:
{
Description: Remote Support Access Connection Status on the Node ,
Required: False ,
}
string ,
connectionErrorMessage:
{
Description: Remote Support Access Connection Error Message on the Node ,
Required: False ,
}
string ,
transcriptLocation:
{
Description: Remote Support Transcript location on the node ,
Required: False ,
}
string ,
}
,
]
,
remoteSupportSessionDetails:
{
Required: False ,
}
[
{
sessionStartTime:
{
Description: Remote Support Session StartTime on the Node ,
Format: date-time ,
Required: False ,
}
string ,
sessionEndTime:
{
Description: Remote Support Session EndTime on the Node ,
Format: date-time ,
Required: False ,
}
string ,
nodeName:
{
Description: Name of the node ,
Required: False ,
}
string ,
duration:
{
Description: Duration of Remote Support Enablement ,
Format: int64 ,
Required: False ,
}
integer ,
accessLevel:
{
Description: Remote Support Access Level ,
Enum:
{
Diagnostics: Allows remote diagnostics operations only. ,
DiagnosticsAndRepair: Allows both remote diagnostics and repair operations. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
desiredProperties:
{
Description: Desired properties of the cluster. ,
Required: False ,
}
{
windowsServerSubscription:
{
Description: Desired state of Windows Server Subscription. ,
Enum:
{
Disabled: Windows Server Subscription is disabled. ,
Enabled: Windows Server Subscription is enabled. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Desired level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No diagnostic data will be emitted. ,
Basic: Basic diagnostic data will be emitted, including essential health metrics. ,
Enhanced: Enhanced diagnostic data will be emitted, including detailed performance and usage metrics. ,
}
,
Required: False ,
}
enum ,
}
,
reportedProperties:
{
Description: Properties reported by cluster agent. ,
Required: False ,
}
{
clusterName:
{
Description: Name of the on-prem cluster connected to this resource. ,
Required: False ,
}
string ,
clusterId:
{
Description: Unique id generated by the on-prem cluster. ,
Required: False ,
}
string ,
clusterVersion:
{
Description: Version of the cluster software. ,
Required: False ,
}
string ,
nodes:
{
Description: List of nodes reported by the cluster. ,
Required: False ,
}
[
{
name:
{
Description: Name of the cluster node. ,
Required: False ,
}
string ,
id:
{
Description: Id of the node in the cluster. ,
Format: float ,
Required: False ,
}
number ,
windowsServerSubscription:
{
Description: State of Windows Server Subscription. ,
Enum:
{
Disabled: Windows Server Subscription is disabled. ,
Enabled: Windows Server Subscription is enabled. ,
}
,
Required: False ,
}
enum ,
nodeType:
{
Description: Type of the cluster node hardware. ,
Enum:
{
FirstParty: All nodes in the cluster are provided and managed by Microsoft. ,
ThirdParty: All nodes in the cluster are provided and managed by a third-party vendor. ,
}
,
Required: False ,
}
enum ,
ehcResourceId:
{
Description: Edge Hardware Center Resource Id ,
Required: False ,
}
string ,
manufacturer:
{
Description: Manufacturer of the cluster node hardware. ,
Required: False ,
}
string ,
model:
{
Description: Model name of the cluster node hardware. ,
Required: False ,
}
string ,
osName:
{
Description: Operating system running on the cluster node. ,
Required: False ,
}
string ,
osVersion:
{
Description: Version of the operating system running on the cluster node. ,
Required: False ,
}
string ,
osDisplayVersion:
{
Description: Display version of the operating system running on the cluster node. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Immutable id of the cluster node. ,
Required: False ,
}
string ,
coreCount:
{
Description: Number of physical cores on the cluster node. ,
Format: float ,
Required: False ,
}
number ,
memoryInGiB:
{
Description: Total available memory on the cluster node (in GiB). ,
Format: float ,
Required: False ,
}
number ,
lastLicensingTimestamp:
{
Description: Most recent licensing timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
oemActivation:
{
Description: OEM activation status of the node. ,
Enum:
{
Disabled: OEM activation is disabled for the cluster. ,
Enabled: OEM activation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
lastUpdated:
{
Description: Last time the cluster reported the data. ,
Format: date-time ,
Required: False ,
}
string ,
msiExpirationTimeStamp:
{
Description: Specifies the expiration timestamp of the cluster's Managed Service Identity (MSI). The value is expressed in Coordinated Universal Time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
imdsAttestation:
{
Description: IMDS attestation status of the cluster. ,
Enum:
{
Disabled: IMDS attestation is disabled for the cluster. ,
Enabled: IMDS attestation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No diagnostic data will be emitted. ,
Basic: Basic diagnostic data will be emitted, including essential health metrics. ,
Enhanced: Enhanced diagnostic data will be emitted, including detailed performance and usage metrics. ,
}
,
Required: False ,
}
enum ,
supportedCapabilities:
{
Description: Capabilities supported by the cluster. ,
Required: False ,
}
[
string ,
]
,
clusterType:
{
Description: Specifies the type of hardware vendor for all nodes in the cluster. Indicates whether the nodes are provided by Microsoft or a third-party vendor. ,
Enum:
{
FirstParty: All nodes in the cluster are provided and managed by Microsoft. ,
ThirdParty: All nodes in the cluster are provided and managed by a third-party vendor. ,
}
,
Required: False ,
}
enum ,
manufacturer:
{
Description: The manufacturer of all the nodes of the cluster. ,
Required: False ,
}
string ,
oemActivation:
{
Description: OEM activation status of the cluster. ,
Enum:
{
Disabled: OEM activation is disabled for the cluster. ,
Enabled: OEM activation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
hardwareClass:
{
Description: Hardware class of the cluster. ,
Enum:
{
Small: The hardware class is small. ,
Medium: The hardware class is medium. This corresponds to the default ,
Large: The hardware class is large. ,
}
,
Required: False ,
}
enum ,
}
,
isolatedVmAttestationConfiguration:
{
Description: Attestation configurations for isolated VM (e.g. TVM, CVM) of the cluster. ,
Required: False ,
}
{
attestationResourceId:
{
Description: Fully qualified Azure resource id of the Microsoft Azure attestation resource associated with this cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
relyingPartyServiceEndpoint:
{
Description: Region specific endpoint for relying party service. ,
Required: False ,
}
string ,
attestationServiceEndpoint:
{
Description: Region specific endpoint for Microsoft Azure Attestation service for the cluster ,
Required: False ,
}
string ,
}
,
trialDaysRemaining:
{
Description: Number of days remaining in the trial period. ,
Format: float ,
Required: False ,
}
number ,
billingModel:
{
Description: Type of billing applied to the resource. ,
Required: False ,
}
string ,
registrationTimestamp:
{
Description: First cluster sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncTimestamp:
{
Description: Most recent cluster sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastBillingTimestamp:
{
Description: Most recent billing meter timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
serviceEndpoint:
{
Description: Region specific DataPath Endpoint of the cluster. ,
Required: False ,
}
string ,
resourceProviderObjectId:
{
Description: Object id of RP Service Principal ,
Required: False ,
}
string ,
secretsLocations:
{
Description: List of secret locations. ,
Required: False ,
}
[
{
secretsType:
{
Description: Type of secrets to store ,
Enum:
{
BackupSecrets: Backup secrets type ,
}
,
Required: True ,
}
enum ,
secretsLocation:
{
Description: secrets location ,
Required: True ,
}
string ,
}
,
]
,
clusterPattern:
{
Description: Supported Storage Type for HCI Cluster ,
Enum:
{
Standard: Standard cluster. ,
RackAware: RackAware cluster. ,
}
,
Required: False ,
}
enum ,
confidentialVmProperties:
{
Description: Represents the Confidential Virtual Machine (CVM) support intent and current status for the cluster resource. ,
Required: False ,
}
{
confidentialVmIntent:
{
Description: Captures the customer's intent to enable or disable CVM support on the cluster, either during initial deployment (Day-0) or at a later stage (Day-N). ,
Enum:
{
Enable: Indicates that the customer intends to enable CVM support on the cluster. ,
Disable: Indicates that the customer intends to disable CVM support on the cluster. ,
}
,
Required: False ,
}
enum ,
confidentialVmStatus:
{
Description: Captures the current status of CVM support on the cluster. ,
Enum:
{
Enabled: CVM support is fully enabled on the cluster. All nodes are CVM capable. ,
PartiallyEnabled: CVM support is partially enabled. At least one node in the cluster is CVM capable. ,
Disabled: CVM support is disabled. None of the nodes in the cluster are CVM capable. ,
}
,
Required: False ,
}
enum ,
confidentialVmStatusSummary:
{
Description: Additional context about CVM support on the cluster, such as reasons for partial enablement or hardware constraints. ,
Required: False ,
}
string ,
}
,
sdnProperties:
{
Description: Software Defined Networking Properties of the cluster ,
Required: False ,
}
{
sdnIntegrationIntent:
{
Description: Indicates whether Software Defined Networking (SDN) integration should be enabled or disabled for this deployment. ,
Enum:
{
Enable: Enable SDN integration for the deployment. ,
Disable: Disable SDN integration for the deployment. ,
}
,
Required: False ,
}
enum ,
}
,
localAvailabilityZones:
{
Description: Local Availability Zone information for HCI cluster ,
Required: False ,
}
[
{
localAvailabilityZoneName:
{
Description: Local Availability Zone name for HCI cluster ,
Required: False ,
}
string ,
nodes:
{
Description: Nodes belonging to a particular zone ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
identityProvider:
{
Description: Identity Provider for the cluster ,
Enum:
{
ActiveDirectory: Uses Active Directory as the identity provider, enabling domain-based authentication and centralized identity management. This is the default option. ,
LocalIdentity: Uses a local identity system integrated with Azure Key Vault for authentication. Suitable for AD-less environments where Active Directory is not available or required. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
kind:
{
Description: This property identifies the purpose of the Cluster deployment. For example, a valid value is AzureLocal ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Offers_ListByCluster (new)
Description :  List Offers available across publishers for the HCI Cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/offers
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify $expand=content,contentVersion to populate additional fields related to the marketplace offer. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Offer proxy resources. ,
Required: False ,
}
[
{
properties:
{
Description: Offer properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning State ,
Required: False ,
}
string ,
publisherId:
{
Description: Identifier of the Publisher for the offer ,
Required: False ,
}
string ,
content:
{
Description: JSON serialized catalog content of the offer ,
Required: False ,
}
string ,
contentVersion:
{
Description: The API version of the catalog service used to serve the catalog content ,
Required: False ,
}
string ,
skuMappings:
{
Description: Array of SKU mappings ,
Required: False ,
}
[
{
catalogPlanId:
{
Description: Identifier of the CatalogPlan for the sku ,
Required: False ,
}
string ,
marketplaceSkuId:
{
Description: Identifier for the sku ,
Required: False ,
}
string ,
marketplaceSkuVersions:
{
Description: Array of SKU versions available ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Publishers_ListByCluster (new)
Description :  List Publishers available for the HCI Cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/publishers
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Publisher proxy resources. ,
Required: False ,
}
[
{
properties:
{
Description: Publisher properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning State ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Publishers_Get (new)
Description :  Get Publisher resource details of HCI Cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/publishers/{publisherName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
publisherName:
{
Description: The name of the publisher available within HCI cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Publisher properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning State ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Offers_ListByPublisher (new)
Description :  List Offers available for a publisher within the HCI Cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/publishers/{publisherName}/offers
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
publisherName:
{
Description: The name of the publisher available within HCI cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify $expand=content,contentVersion to populate additional fields related to the marketplace offer. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Offer proxy resources. ,
Required: False ,
}
[
{
properties:
{
Description: Offer properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning State ,
Required: False ,
}
string ,
publisherId:
{
Description: Identifier of the Publisher for the offer ,
Required: False ,
}
string ,
content:
{
Description: JSON serialized catalog content of the offer ,
Required: False ,
}
string ,
contentVersion:
{
Description: The API version of the catalog service used to serve the catalog content ,
Required: False ,
}
string ,
skuMappings:
{
Description: Array of SKU mappings ,
Required: False ,
}
[
{
catalogPlanId:
{
Description: Identifier of the CatalogPlan for the sku ,
Required: False ,
}
string ,
marketplaceSkuId:
{
Description: Identifier for the sku ,
Required: False ,
}
string ,
marketplaceSkuVersions:
{
Description: Array of SKU versions available ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Offers_Get (new)
Description :  Get Offer resource details within a publisher of HCI Cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/publishers/{publisherName}/offers/{offerName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
publisherName:
{
Description: The name of the publisher available within HCI cluster. ,
Required: True ,
}
string ,
offerName:
{
Description: The name of the offer available within HCI cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify $expand=content,contentVersion to populate additional fields related to the marketplace offer. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Offer properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning State ,
Required: False ,
}
string ,
publisherId:
{
Description: Identifier of the Publisher for the offer ,
Required: False ,
}
string ,
content:
{
Description: JSON serialized catalog content of the offer ,
Required: False ,
}
string ,
contentVersion:
{
Description: The API version of the catalog service used to serve the catalog content ,
Required: False ,
}
string ,
skuMappings:
{
Description: Array of SKU mappings ,
Required: False ,
}
[
{
catalogPlanId:
{
Description: Identifier of the CatalogPlan for the sku ,
Required: False ,
}
string ,
marketplaceSkuId:
{
Description: Identifier for the sku ,
Required: False ,
}
string ,
marketplaceSkuVersions:
{
Description: Array of SKU versions available ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Skus_ListByOffer (new)
Description :  List Skus available for a offer within the HCI Cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/publishers/{publisherName}/offers/{offerName}/skus
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
publisherName:
{
Description: The name of the publisher available within HCI cluster. ,
Required: True ,
}
string ,
offerName:
{
Description: The name of the offer available within HCI cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify $expand=content,contentVersion to populate additional fields related to the marketplace offer. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of SKU proxy resources. ,
Required: False ,
}
[
{
properties:
{
Description: SKU properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning State ,
Required: False ,
}
string ,
publisherId:
{
Description: Identifier of the Publisher for the offer ,
Required: False ,
}
string ,
offerId:
{
Description: Identifier of the Offer for the sku ,
Required: False ,
}
string ,
content:
{
Description: JSON serialized catalog content of the sku offer ,
Required: False ,
}
string ,
contentVersion:
{
Description: The API version of the catalog service used to serve the catalog content ,
Required: False ,
}
string ,
skuMappings:
{
Description: Array of SKU mappings ,
Required: False ,
}
[
{
catalogPlanId:
{
Description: Identifier of the CatalogPlan for the sku ,
Required: False ,
}
string ,
marketplaceSkuId:
{
Description: Identifier for the sku ,
Required: False ,
}
string ,
marketplaceSkuVersions:
{
Description: Array of SKU versions available ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Skus_Get (new)
Description :  Get SKU resource details within a offer of HCI Cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/publishers/{publisherName}/offers/{offerName}/skus/{skuName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
publisherName:
{
Description: The name of the publisher available within HCI cluster. ,
Required: True ,
}
string ,
offerName:
{
Description: The name of the offer available within HCI cluster. ,
Required: True ,
}
string ,
skuName:
{
Description: The name of the SKU available within HCI cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify $expand=content,contentVersion to populate additional fields related to the marketplace offer. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: SKU properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning State ,
Required: False ,
}
string ,
publisherId:
{
Description: Identifier of the Publisher for the offer ,
Required: False ,
}
string ,
offerId:
{
Description: Identifier of the Offer for the sku ,
Required: False ,
}
string ,
content:
{
Description: JSON serialized catalog content of the sku offer ,
Required: False ,
}
string ,
contentVersion:
{
Description: The API version of the catalog service used to serve the catalog content ,
Required: False ,
}
string ,
skuMappings:
{
Description: Array of SKU mappings ,
Required: False ,
}
[
{
catalogPlanId:
{
Description: Identifier of the CatalogPlan for the sku ,
Required: False ,
}
string ,
marketplaceSkuId:
{
Description: Identifier for the sku ,
Required: False ,
}
string ,
marketplaceSkuVersions:
{
Description: Array of SKU versions available ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SecuritySettings_ListByClusters (new)
Description :  List SecuritySetting resources by Clusters
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/securitySettings
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The SecuritySetting items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
securedCoreComplianceAssignment:
{
Description: Secured Core Compliance Assignment ,
Enum:
{
Audit: Report on the state of the machine, but don't make changes. ,
ApplyAndAutoCorrect: Applied to the machine. If it drifts, the local service inside the machine makes a correction at the next evaluation. ,
}
,
Required: False ,
}
enum ,
wdacComplianceAssignment:
{
Description: WDAC Compliance Assignment ,
Enum:
{
Audit: Report on the state of the machine, but don't make changes. ,
ApplyAndAutoCorrect: Applied to the machine. If it drifts, the local service inside the machine makes a correction at the next evaluation. ,
}
,
Required: False ,
}
enum ,
smbEncryptionForIntraClusterTrafficComplianceAssignment:
{
Description: SMB encryption for intra-cluster traffic Compliance Assignment ,
Enum:
{
Audit: Report on the state of the machine, but don't make changes. ,
ApplyAndAutoCorrect: Applied to the machine. If it drifts, the local service inside the machine makes a correction at the next evaluation. ,
}
,
Required: False ,
}
enum ,
securityComplianceStatus:
{
Description: Security Compliance Status ,
Required: False ,
}
{
securedCoreCompliance:
{
Description: Indicates whether HCI hosts meets secured-core server requirements. ,
Enum:
{
Compliant: The resource is compliant ,
NonCompliant: The resource is non-compliant ,
Pending: The resource compliance status is pending ,
}
,
Required: False ,
}
enum ,
wdacCompliance:
{
Description: Indicates whether HCI hosts have enforced consistent Windows Defender Application Control. ,
Enum:
{
Compliant: The resource is compliant ,
NonCompliant: The resource is non-compliant ,
Pending: The resource compliance status is pending ,
}
,
Required: False ,
}
enum ,
dataAtRestEncrypted:
{
Description: Indicates whether data at-rest encryption is enabled on Azure Stack HCI clustered volumes. ,
Enum:
{
Compliant: The resource is compliant ,
NonCompliant: The resource is non-compliant ,
Pending: The resource compliance status is pending ,
}
,
Required: False ,
}
enum ,
dataInTransitProtected:
{
Description: Indicates whether HCI cluster has data in-transit protection. ,
Enum:
{
Compliant: The resource is compliant ,
NonCompliant: The resource is non-compliant ,
Pending: The resource compliance status is pending ,
}
,
Required: False ,
}
enum ,
lastUpdated:
{
Description: Time in UTC when compliance status was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SecuritySettings_Get (new)
Description :  Get a SecuritySetting
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/securitySettings/{securitySettingsName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
securitySettingsName:
{
Description: Name of security setting ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
securedCoreComplianceAssignment:
{
Description: Secured Core Compliance Assignment ,
Enum:
{
Audit: Report on the state of the machine, but don't make changes. ,
ApplyAndAutoCorrect: Applied to the machine. If it drifts, the local service inside the machine makes a correction at the next evaluation. ,
}
,
Required: False ,
}
enum ,
wdacComplianceAssignment:
{
Description: WDAC Compliance Assignment ,
Enum:
{
Audit: Report on the state of the machine, but don't make changes. ,
ApplyAndAutoCorrect: Applied to the machine. If it drifts, the local service inside the machine makes a correction at the next evaluation. ,
}
,
Required: False ,
}
enum ,
smbEncryptionForIntraClusterTrafficComplianceAssignment:
{
Description: SMB encryption for intra-cluster traffic Compliance Assignment ,
Enum:
{
Audit: Report on the state of the machine, but don't make changes. ,
ApplyAndAutoCorrect: Applied to the machine. If it drifts, the local service inside the machine makes a correction at the next evaluation. ,
}
,
Required: False ,
}
enum ,
securityComplianceStatus:
{
Description: Security Compliance Status ,
Required: False ,
}
{
securedCoreCompliance:
{
Description: Indicates whether HCI hosts meets secured-core server requirements. ,
Enum:
{
Compliant: The resource is compliant ,
NonCompliant: The resource is non-compliant ,
Pending: The resource compliance status is pending ,
}
,
Required: False ,
}
enum ,
wdacCompliance:
{
Description: Indicates whether HCI hosts have enforced consistent Windows Defender Application Control. ,
Enum:
{
Compliant: The resource is compliant ,
NonCompliant: The resource is non-compliant ,
Pending: The resource compliance status is pending ,
}
,
Required: False ,
}
enum ,
dataAtRestEncrypted:
{
Description: Indicates whether data at-rest encryption is enabled on Azure Stack HCI clustered volumes. ,
Enum:
{
Compliant: The resource is compliant ,
NonCompliant: The resource is non-compliant ,
Pending: The resource compliance status is pending ,
}
,
Required: False ,
}
enum ,
dataInTransitProtected:
{
Description: Indicates whether HCI cluster has data in-transit protection. ,
Enum:
{
Compliant: The resource is compliant ,
NonCompliant: The resource is non-compliant ,
Pending: The resource compliance status is pending ,
}
,
Required: False ,
}
enum ,
lastUpdated:
{
Description: Time in UTC when compliance status was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SecuritySettings_CreateOrUpdate (new)
Description :  Create a security setting
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/securitySettings/{securitySettingsName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
securitySettingsName:
{
Description: Name of security setting ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
securedCoreComplianceAssignment:
{
Description: Secured Core Compliance Assignment ,
Enum:
{
Audit: Report on the state of the machine, but don't make changes. ,
ApplyAndAutoCorrect: Applied to the machine. If it drifts, the local service inside the machine makes a correction at the next evaluation. ,
}
,
Required: False ,
}
enum ,
wdacComplianceAssignment:
{
Description: WDAC Compliance Assignment ,
Enum:
{
Audit: Report on the state of the machine, but don't make changes. ,
ApplyAndAutoCorrect: Applied to the machine. If it drifts, the local service inside the machine makes a correction at the next evaluation. ,
}
,
Required: False ,
}
enum ,
smbEncryptionForIntraClusterTrafficComplianceAssignment:
{
Description: SMB encryption for intra-cluster traffic Compliance Assignment ,
Enum:
{
Audit: Report on the state of the machine, but don't make changes. ,
ApplyAndAutoCorrect: Applied to the machine. If it drifts, the local service inside the machine makes a correction at the next evaluation. ,
}
,
Required: False ,
}
enum ,
securityComplianceStatus:
{
Description: Security Compliance Status ,
Required: False ,
}
{
securedCoreCompliance:
{
Description: Indicates whether HCI hosts meets secured-core server requirements. ,
Enum:
{
Compliant: The resource is compliant ,
NonCompliant: The resource is non-compliant ,
Pending: The resource compliance status is pending ,
}
,
Required: False ,
}
enum ,
wdacCompliance:
{
Description: Indicates whether HCI hosts have enforced consistent Windows Defender Application Control. ,
Enum:
{
Compliant: The resource is compliant ,
NonCompliant: The resource is non-compliant ,
Pending: The resource compliance status is pending ,
}
,
Required: False ,
}
enum ,
dataAtRestEncrypted:
{
Description: Indicates whether data at-rest encryption is enabled on Azure Stack HCI clustered volumes. ,
Enum:
{
Compliant: The resource is compliant ,
NonCompliant: The resource is non-compliant ,
Pending: The resource compliance status is pending ,
}
,
Required: False ,
}
enum ,
dataInTransitProtected:
{
Description: Indicates whether HCI cluster has data in-transit protection. ,
Enum:
{
Compliant: The resource is compliant ,
NonCompliant: The resource is non-compliant ,
Pending: The resource compliance status is pending ,
}
,
Required: False ,
}
enum ,
lastUpdated:
{
Description: Time in UTC when compliance status was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
securedCoreComplianceAssignment:
{
Description: Secured Core Compliance Assignment ,
Enum:
{
Audit: Report on the state of the machine, but don't make changes. ,
ApplyAndAutoCorrect: Applied to the machine. If it drifts, the local service inside the machine makes a correction at the next evaluation. ,
}
,
Required: False ,
}
enum ,
wdacComplianceAssignment:
{
Description: WDAC Compliance Assignment ,
Enum:
{
Audit: Report on the state of the machine, but don't make changes. ,
ApplyAndAutoCorrect: Applied to the machine. If it drifts, the local service inside the machine makes a correction at the next evaluation. ,
}
,
Required: False ,
}
enum ,
smbEncryptionForIntraClusterTrafficComplianceAssignment:
{
Description: SMB encryption for intra-cluster traffic Compliance Assignment ,
Enum:
{
Audit: Report on the state of the machine, but don't make changes. ,
ApplyAndAutoCorrect: Applied to the machine. If it drifts, the local service inside the machine makes a correction at the next evaluation. ,
}
,
Required: False ,
}
enum ,
securityComplianceStatus:
{
Description: Security Compliance Status ,
Required: False ,
}
{
securedCoreCompliance:
{
Description: Indicates whether HCI hosts meets secured-core server requirements. ,
Enum:
{
Compliant: The resource is compliant ,
NonCompliant: The resource is non-compliant ,
Pending: The resource compliance status is pending ,
}
,
Required: False ,
}
enum ,
wdacCompliance:
{
Description: Indicates whether HCI hosts have enforced consistent Windows Defender Application Control. ,
Enum:
{
Compliant: The resource is compliant ,
NonCompliant: The resource is non-compliant ,
Pending: The resource compliance status is pending ,
}
,
Required: False ,
}
enum ,
dataAtRestEncrypted:
{
Description: Indicates whether data at-rest encryption is enabled on Azure Stack HCI clustered volumes. ,
Enum:
{
Compliant: The resource is compliant ,
NonCompliant: The resource is non-compliant ,
Pending: The resource compliance status is pending ,
}
,
Required: False ,
}
enum ,
dataInTransitProtected:
{
Description: Indicates whether HCI cluster has data in-transit protection. ,
Enum:
{
Compliant: The resource is compliant ,
NonCompliant: The resource is non-compliant ,
Pending: The resource compliance status is pending ,
}
,
Required: False ,
}
enum ,
lastUpdated:
{
Description: Time in UTC when compliance status was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Security settings proxy resource ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
securedCoreComplianceAssignment:
{
Description: Secured Core Compliance Assignment ,
Enum:
{
Audit: Report on the state of the machine, but don't make changes. ,
ApplyAndAutoCorrect: Applied to the machine. If it drifts, the local service inside the machine makes a correction at the next evaluation. ,
}
,
Required: False ,
}
enum ,
wdacComplianceAssignment:
{
Description: WDAC Compliance Assignment ,
Enum:
{
Audit: Report on the state of the machine, but don't make changes. ,
ApplyAndAutoCorrect: Applied to the machine. If it drifts, the local service inside the machine makes a correction at the next evaluation. ,
}
,
Required: False ,
}
enum ,
smbEncryptionForIntraClusterTrafficComplianceAssignment:
{
Description: SMB encryption for intra-cluster traffic Compliance Assignment ,
Enum:
{
Audit: Report on the state of the machine, but don't make changes. ,
ApplyAndAutoCorrect: Applied to the machine. If it drifts, the local service inside the machine makes a correction at the next evaluation. ,
}
,
Required: False ,
}
enum ,
securityComplianceStatus:
{
Description: Security Compliance Status ,
Required: False ,
}
{
securedCoreCompliance:
{
Description: Indicates whether HCI hosts meets secured-core server requirements. ,
Enum:
{
Compliant: The resource is compliant ,
NonCompliant: The resource is non-compliant ,
Pending: The resource compliance status is pending ,
}
,
Required: False ,
}
enum ,
wdacCompliance:
{
Description: Indicates whether HCI hosts have enforced consistent Windows Defender Application Control. ,
Enum:
{
Compliant: The resource is compliant ,
NonCompliant: The resource is non-compliant ,
Pending: The resource compliance status is pending ,
}
,
Required: False ,
}
enum ,
dataAtRestEncrypted:
{
Description: Indicates whether data at-rest encryption is enabled on Azure Stack HCI clustered volumes. ,
Enum:
{
Compliant: The resource is compliant ,
NonCompliant: The resource is non-compliant ,
Pending: The resource compliance status is pending ,
}
,
Required: False ,
}
enum ,
dataInTransitProtected:
{
Description: Indicates whether HCI cluster has data in-transit protection. ,
Enum:
{
Compliant: The resource is compliant ,
NonCompliant: The resource is non-compliant ,
Pending: The resource compliance status is pending ,
}
,
Required: False ,
}
enum ,
lastUpdated:
{
Description: Time in UTC when compliance status was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SecuritySettings_Delete (new)
Description :  Delete a SecuritySetting
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/securitySettings/{securitySettingsName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
securitySettingsName:
{
Description: Name of security setting ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_TriggerLogCollection (new)
Description :  Trigger Log Collection on a cluster
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/triggerLogCollection
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
logCollectionRequest:
{
Description: Trigger Log Collection Request Payload ,
Required: True ,
}
{
properties:
{
Description: Properties for Log Collection Request ,
Required: False ,
}
{
fromDate:
{
Description: From DateTimeStamp from when logs need to be connected ,
Format: date-time ,
Required: True ,
}
string ,
toDate:
{
Description: To DateTimeStamp till when logs need to be connected ,
Format: date-time ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Cluster properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state. Indicates the current lifecycle status of the resource, including creation, update, deletion, connectivity, and error states. ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Status of the cluster agent. Indicates the current connectivity, validation, and deployment state of the agent within the cluster. ,
Enum:
{
NotYetRegistered: The cluster agent has not yet registered with Azure. ,
ConnectedRecently: The cluster agent has connected to Azure recently. ,
NotConnectedRecently: The cluster agent has not connected to Azure recently. ,
Disconnected: The cluster agent is currently disconnected from Azure. ,
Error: An error occurred in the cluster agent's operation. ,
NotSpecified: The status of the cluster agent is not specified. ,
ValidationInProgress: Validation of the cluster agent is currently in progress. ,
ValidationSuccess: Validation of the cluster agent completed successfully. ,
ValidationFailed: Validation of the cluster agent failed. ,
DeploymentInProgress: Deployment of the cluster agent is currently in progress. ,
DeploymentFailed: Deployment of the cluster agent failed. ,
DeploymentSuccess: Deployment of the cluster agent completed successfully. ,
}
,
Required: False ,
}
enum ,
connectivityStatus:
{
Description: Overall connectivity status for the cluster resource. Indicates whether the cluster is connected to Azure, partially connected, or has not recently communicated. ,
Enum:
{
NotYetRegistered: The cluster has not yet registered with Azure. ,
Connected: The cluster is fully connected to Azure. ,
NotConnectedRecently: The cluster has not connected to Azure recently. ,
PartiallyConnected: Some components of the cluster are connected, while others are not. ,
Disconnected: The cluster is not connected to Azure. ,
NotSpecified: The connectivity status is not specified. ,
}
,
Required: False ,
}
enum ,
supportStatus:
{
Description: Indicates whether the cluster is under support. ,
Enum:
{
InSupport: The cluster is under support. ,
OutOfSupport: The cluster is out of support. ,
NotSpecified: The support status is not specified. ,
}
,
Required: False ,
}
enum ,
cloudId:
{
Description: Unique, immutable resource id. ,
Required: False ,
}
string ,
ring:
{
Description: The ring to which this cluster belongs to. ,
Required: False ,
}
string ,
cloudManagementEndpoint:
{
Description: Endpoint configured for management from the Azure portal. ,
Required: False ,
}
string ,
aadClientId:
{
Description: App id of cluster AAD identity. ,
Required: False ,
}
string ,
aadTenantId:
{
Description: Tenant id of cluster AAD identity. ,
Required: False ,
}
string ,
aadApplicationObjectId:
{
Description: Object id of cluster AAD identity. ,
Required: False ,
}
string ,
aadServicePrincipalObjectId:
{
Description: Id of cluster identity service principal. ,
Required: False ,
}
string ,
softwareAssuranceProperties:
{
Description: Software Assurance properties of the cluster. ,
Required: False ,
}
{
softwareAssuranceStatus:
{
Description: Status of the Software Assurance for the cluster. ,
Enum:
{
Enabled: Software Assurance is enabled for the cluster. ,
Disabled: Software Assurance is disabled for the cluster. ,
}
,
Required: False ,
}
enum ,
softwareAssuranceIntent:
{
Description: Customer Intent for Software Assurance Benefit. ,
Enum:
{
Enable: Customer intends to enable the Software Assurance benefit. ,
Disable: Customer intends to disable the Software Assurance benefit. ,
}
,
Required: False ,
}
enum ,
lastUpdated:
{
Description: TimeStamp denoting the latest SA benefit applicability is validated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
isManagementCluster:
{
Description: Is Management Cluster, when true indicates that the cluster is used for managing other clusters ,
Required: False ,
}
boolean ,
logCollectionProperties:
{
Description: Log Collection properties of the cluster. ,
Required: False ,
}
{
fromDate:
{
Description: From DateTimeStamp from when logs need to be connected ,
Format: date-time ,
Required: False ,
}
string ,
toDate:
{
Description: To DateTimeStamp till when logs need to be connected ,
Format: date-time ,
Required: False ,
}
string ,
lastLogGenerated:
{
Description: Recent DateTimeStamp where logs are successfully generated ,
Format: date-time ,
Required: False ,
}
string ,
logCollectionSessionDetails:
{
Required: False ,
}
[
{
logStartTime:
{
Description: Start Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
logEndTime:
{
Description: End Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
timeCollected:
{
Description: Duration of logs collected ,
Format: date-time ,
Required: False ,
}
string ,
logSize:
{
Description: Size of the logs collected ,
Format: int64 ,
Required: False ,
}
integer ,
logCollectionStatus:
{
Description: LogCollection status ,
Enum:
{
None: No log collection has been initiated. ,
InProgress: Log collection is currently in progress. ,
Failed: Log collection has failed. ,
Succeeded: Log collection completed successfully. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: CorrelationId of the log collection ,
Required: False ,
}
string ,
logCollectionJobType:
{
Description: Specifies the type of log collection job. Determines whether the logs are collected immediately on demand or as part of a scheduled operation. ,
Enum:
{
OnDemand: Log collection is triggered manually and executed immediately. ,
Scheduled: Log collection is scheduled to run at a predefined time or interval. ,
}
,
Required: False ,
}
enum ,
endTimeCollected:
{
Description: End Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
logCollectionError:
{
Description: Log Collection Error details of the cluster. ,
Required: False ,
}
{
errorCode:
{
Description: Error Code of the log collection ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error Message of the log collection ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
remoteSupportProperties:
{
Description: RemoteSupport properties of the cluster. ,
Required: False ,
}
{
accessLevel:
{
Description: Remote Support Access Level ,
Enum:
{
Diagnostics: Allows remote diagnostics operations only. ,
DiagnosticsAndRepair: Allows both remote diagnostics and repair operations. ,
}
,
Required: False ,
}
enum ,
expirationTimeStamp:
{
Description: Expiration DateTimeStamp when Remote Support Access will be expired ,
Format: date-time ,
Required: False ,
}
string ,
remoteSupportType:
{
Description: Remote Support Type for cluster ,
Enum:
{
Enable: Enable remote support for the cluster. ,
Revoke: Revoke previously enabled remote support for the cluster. ,
}
,
Required: False ,
}
enum ,
remoteSupportNodeSettings:
{
Required: False ,
}
[
{
arcResourceId:
{
Description: Arc ResourceId of the Node ,
Required: False ,
}
string ,
state:
{
Description: Remote Support Access Connection State on the Node ,
Required: False ,
}
string ,
createdAt:
{
Description: Remote Support Enablement Request Created TimeStamp on the Node ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: Remote Support Enablement Request Updated TimeStamp on the Node ,
Format: date-time ,
Required: False ,
}
string ,
connectionStatus:
{
Description: Remote Support Access Connection Status on the Node ,
Required: False ,
}
string ,
connectionErrorMessage:
{
Description: Remote Support Access Connection Error Message on the Node ,
Required: False ,
}
string ,
transcriptLocation:
{
Description: Remote Support Transcript location on the node ,
Required: False ,
}
string ,
}
,
]
,
remoteSupportSessionDetails:
{
Required: False ,
}
[
{
sessionStartTime:
{
Description: Remote Support Session StartTime on the Node ,
Format: date-time ,
Required: False ,
}
string ,
sessionEndTime:
{
Description: Remote Support Session EndTime on the Node ,
Format: date-time ,
Required: False ,
}
string ,
nodeName:
{
Description: Name of the node ,
Required: False ,
}
string ,
duration:
{
Description: Duration of Remote Support Enablement ,
Format: int64 ,
Required: False ,
}
integer ,
accessLevel:
{
Description: Remote Support Access Level ,
Enum:
{
Diagnostics: Allows remote diagnostics operations only. ,
DiagnosticsAndRepair: Allows both remote diagnostics and repair operations. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
desiredProperties:
{
Description: Desired properties of the cluster. ,
Required: False ,
}
{
windowsServerSubscription:
{
Description: Desired state of Windows Server Subscription. ,
Enum:
{
Disabled: Windows Server Subscription is disabled. ,
Enabled: Windows Server Subscription is enabled. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Desired level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No diagnostic data will be emitted. ,
Basic: Basic diagnostic data will be emitted, including essential health metrics. ,
Enhanced: Enhanced diagnostic data will be emitted, including detailed performance and usage metrics. ,
}
,
Required: False ,
}
enum ,
}
,
reportedProperties:
{
Description: Properties reported by cluster agent. ,
Required: False ,
}
{
clusterName:
{
Description: Name of the on-prem cluster connected to this resource. ,
Required: False ,
}
string ,
clusterId:
{
Description: Unique id generated by the on-prem cluster. ,
Required: False ,
}
string ,
clusterVersion:
{
Description: Version of the cluster software. ,
Required: False ,
}
string ,
nodes:
{
Description: List of nodes reported by the cluster. ,
Required: False ,
}
[
{
name:
{
Description: Name of the cluster node. ,
Required: False ,
}
string ,
id:
{
Description: Id of the node in the cluster. ,
Format: float ,
Required: False ,
}
number ,
windowsServerSubscription:
{
Description: State of Windows Server Subscription. ,
Enum:
{
Disabled: Windows Server Subscription is disabled. ,
Enabled: Windows Server Subscription is enabled. ,
}
,
Required: False ,
}
enum ,
nodeType:
{
Description: Type of the cluster node hardware. ,
Enum:
{
FirstParty: All nodes in the cluster are provided and managed by Microsoft. ,
ThirdParty: All nodes in the cluster are provided and managed by a third-party vendor. ,
}
,
Required: False ,
}
enum ,
ehcResourceId:
{
Description: Edge Hardware Center Resource Id ,
Required: False ,
}
string ,
manufacturer:
{
Description: Manufacturer of the cluster node hardware. ,
Required: False ,
}
string ,
model:
{
Description: Model name of the cluster node hardware. ,
Required: False ,
}
string ,
osName:
{
Description: Operating system running on the cluster node. ,
Required: False ,
}
string ,
osVersion:
{
Description: Version of the operating system running on the cluster node. ,
Required: False ,
}
string ,
osDisplayVersion:
{
Description: Display version of the operating system running on the cluster node. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Immutable id of the cluster node. ,
Required: False ,
}
string ,
coreCount:
{
Description: Number of physical cores on the cluster node. ,
Format: float ,
Required: False ,
}
number ,
memoryInGiB:
{
Description: Total available memory on the cluster node (in GiB). ,
Format: float ,
Required: False ,
}
number ,
lastLicensingTimestamp:
{
Description: Most recent licensing timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
oemActivation:
{
Description: OEM activation status of the node. ,
Enum:
{
Disabled: OEM activation is disabled for the cluster. ,
Enabled: OEM activation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
lastUpdated:
{
Description: Last time the cluster reported the data. ,
Format: date-time ,
Required: False ,
}
string ,
msiExpirationTimeStamp:
{
Description: Specifies the expiration timestamp of the cluster's Managed Service Identity (MSI). The value is expressed in Coordinated Universal Time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
imdsAttestation:
{
Description: IMDS attestation status of the cluster. ,
Enum:
{
Disabled: IMDS attestation is disabled for the cluster. ,
Enabled: IMDS attestation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No diagnostic data will be emitted. ,
Basic: Basic diagnostic data will be emitted, including essential health metrics. ,
Enhanced: Enhanced diagnostic data will be emitted, including detailed performance and usage metrics. ,
}
,
Required: False ,
}
enum ,
supportedCapabilities:
{
Description: Capabilities supported by the cluster. ,
Required: False ,
}
[
string ,
]
,
clusterType:
{
Description: Specifies the type of hardware vendor for all nodes in the cluster. Indicates whether the nodes are provided by Microsoft or a third-party vendor. ,
Enum:
{
FirstParty: All nodes in the cluster are provided and managed by Microsoft. ,
ThirdParty: All nodes in the cluster are provided and managed by a third-party vendor. ,
}
,
Required: False ,
}
enum ,
manufacturer:
{
Description: The manufacturer of all the nodes of the cluster. ,
Required: False ,
}
string ,
oemActivation:
{
Description: OEM activation status of the cluster. ,
Enum:
{
Disabled: OEM activation is disabled for the cluster. ,
Enabled: OEM activation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
hardwareClass:
{
Description: Hardware class of the cluster. ,
Enum:
{
Small: The hardware class is small. ,
Medium: The hardware class is medium. This corresponds to the default ,
Large: The hardware class is large. ,
}
,
Required: False ,
}
enum ,
}
,
isolatedVmAttestationConfiguration:
{
Description: Attestation configurations for isolated VM (e.g. TVM, CVM) of the cluster. ,
Required: False ,
}
{
attestationResourceId:
{
Description: Fully qualified Azure resource id of the Microsoft Azure attestation resource associated with this cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
relyingPartyServiceEndpoint:
{
Description: Region specific endpoint for relying party service. ,
Required: False ,
}
string ,
attestationServiceEndpoint:
{
Description: Region specific endpoint for Microsoft Azure Attestation service for the cluster ,
Required: False ,
}
string ,
}
,
trialDaysRemaining:
{
Description: Number of days remaining in the trial period. ,
Format: float ,
Required: False ,
}
number ,
billingModel:
{
Description: Type of billing applied to the resource. ,
Required: False ,
}
string ,
registrationTimestamp:
{
Description: First cluster sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncTimestamp:
{
Description: Most recent cluster sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastBillingTimestamp:
{
Description: Most recent billing meter timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
serviceEndpoint:
{
Description: Region specific DataPath Endpoint of the cluster. ,
Required: False ,
}
string ,
resourceProviderObjectId:
{
Description: Object id of RP Service Principal ,
Required: False ,
}
string ,
secretsLocations:
{
Description: List of secret locations. ,
Required: False ,
}
[
{
secretsType:
{
Description: Type of secrets to store ,
Enum:
{
BackupSecrets: Backup secrets type ,
}
,
Required: True ,
}
enum ,
secretsLocation:
{
Description: secrets location ,
Required: True ,
}
string ,
}
,
]
,
clusterPattern:
{
Description: Supported Storage Type for HCI Cluster ,
Enum:
{
Standard: Standard cluster. ,
RackAware: RackAware cluster. ,
}
,
Required: False ,
}
enum ,
confidentialVmProperties:
{
Description: Represents the Confidential Virtual Machine (CVM) support intent and current status for the cluster resource. ,
Required: False ,
}
{
confidentialVmIntent:
{
Description: Captures the customer's intent to enable or disable CVM support on the cluster, either during initial deployment (Day-0) or at a later stage (Day-N). ,
Enum:
{
Enable: Indicates that the customer intends to enable CVM support on the cluster. ,
Disable: Indicates that the customer intends to disable CVM support on the cluster. ,
}
,
Required: False ,
}
enum ,
confidentialVmStatus:
{
Description: Captures the current status of CVM support on the cluster. ,
Enum:
{
Enabled: CVM support is fully enabled on the cluster. All nodes are CVM capable. ,
PartiallyEnabled: CVM support is partially enabled. At least one node in the cluster is CVM capable. ,
Disabled: CVM support is disabled. None of the nodes in the cluster are CVM capable. ,
}
,
Required: False ,
}
enum ,
confidentialVmStatusSummary:
{
Description: Additional context about CVM support on the cluster, such as reasons for partial enablement or hardware constraints. ,
Required: False ,
}
string ,
}
,
sdnProperties:
{
Description: Software Defined Networking Properties of the cluster ,
Required: False ,
}
{
sdnIntegrationIntent:
{
Description: Indicates whether Software Defined Networking (SDN) integration should be enabled or disabled for this deployment. ,
Enum:
{
Enable: Enable SDN integration for the deployment. ,
Disable: Disable SDN integration for the deployment. ,
}
,
Required: False ,
}
enum ,
}
,
localAvailabilityZones:
{
Description: Local Availability Zone information for HCI cluster ,
Required: False ,
}
[
{
localAvailabilityZoneName:
{
Description: Local Availability Zone name for HCI cluster ,
Required: False ,
}
string ,
nodes:
{
Description: Nodes belonging to a particular zone ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
identityProvider:
{
Description: Identity Provider for the cluster ,
Enum:
{
ActiveDirectory: Uses Active Directory as the identity provider, enabling domain-based authentication and centralized identity management. This is the default option. ,
LocalIdentity: Uses a local identity system integrated with Azure Key Vault for authentication. Suitable for AD-less environments where Active Directory is not available or required. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
kind:
{
Description: This property identifies the purpose of the Cluster deployment. For example, a valid value is AzureLocal ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_UpdateSecretsLocations (new)
Description :  Update cluster secrets locations.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/updateSecretsLocations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
properties:
{
Description: List of secret locations ,
Required: False ,
}
[
{
secretsType:
{
Description: Type of secrets to store ,
Enum:
{
BackupSecrets: Backup secrets type ,
}
,
Required: True ,
}
enum ,
secretsLocation:
{
Description: secrets location ,
Required: True ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Cluster properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state. Indicates the current lifecycle status of the resource, including creation, update, deletion, connectivity, and error states. ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Status of the cluster agent. Indicates the current connectivity, validation, and deployment state of the agent within the cluster. ,
Enum:
{
NotYetRegistered: The cluster agent has not yet registered with Azure. ,
ConnectedRecently: The cluster agent has connected to Azure recently. ,
NotConnectedRecently: The cluster agent has not connected to Azure recently. ,
Disconnected: The cluster agent is currently disconnected from Azure. ,
Error: An error occurred in the cluster agent's operation. ,
NotSpecified: The status of the cluster agent is not specified. ,
ValidationInProgress: Validation of the cluster agent is currently in progress. ,
ValidationSuccess: Validation of the cluster agent completed successfully. ,
ValidationFailed: Validation of the cluster agent failed. ,
DeploymentInProgress: Deployment of the cluster agent is currently in progress. ,
DeploymentFailed: Deployment of the cluster agent failed. ,
DeploymentSuccess: Deployment of the cluster agent completed successfully. ,
}
,
Required: False ,
}
enum ,
connectivityStatus:
{
Description: Overall connectivity status for the cluster resource. Indicates whether the cluster is connected to Azure, partially connected, or has not recently communicated. ,
Enum:
{
NotYetRegistered: The cluster has not yet registered with Azure. ,
Connected: The cluster is fully connected to Azure. ,
NotConnectedRecently: The cluster has not connected to Azure recently. ,
PartiallyConnected: Some components of the cluster are connected, while others are not. ,
Disconnected: The cluster is not connected to Azure. ,
NotSpecified: The connectivity status is not specified. ,
}
,
Required: False ,
}
enum ,
supportStatus:
{
Description: Indicates whether the cluster is under support. ,
Enum:
{
InSupport: The cluster is under support. ,
OutOfSupport: The cluster is out of support. ,
NotSpecified: The support status is not specified. ,
}
,
Required: False ,
}
enum ,
cloudId:
{
Description: Unique, immutable resource id. ,
Required: False ,
}
string ,
ring:
{
Description: The ring to which this cluster belongs to. ,
Required: False ,
}
string ,
cloudManagementEndpoint:
{
Description: Endpoint configured for management from the Azure portal. ,
Required: False ,
}
string ,
aadClientId:
{
Description: App id of cluster AAD identity. ,
Required: False ,
}
string ,
aadTenantId:
{
Description: Tenant id of cluster AAD identity. ,
Required: False ,
}
string ,
aadApplicationObjectId:
{
Description: Object id of cluster AAD identity. ,
Required: False ,
}
string ,
aadServicePrincipalObjectId:
{
Description: Id of cluster identity service principal. ,
Required: False ,
}
string ,
softwareAssuranceProperties:
{
Description: Software Assurance properties of the cluster. ,
Required: False ,
}
{
softwareAssuranceStatus:
{
Description: Status of the Software Assurance for the cluster. ,
Enum:
{
Enabled: Software Assurance is enabled for the cluster. ,
Disabled: Software Assurance is disabled for the cluster. ,
}
,
Required: False ,
}
enum ,
softwareAssuranceIntent:
{
Description: Customer Intent for Software Assurance Benefit. ,
Enum:
{
Enable: Customer intends to enable the Software Assurance benefit. ,
Disable: Customer intends to disable the Software Assurance benefit. ,
}
,
Required: False ,
}
enum ,
lastUpdated:
{
Description: TimeStamp denoting the latest SA benefit applicability is validated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
isManagementCluster:
{
Description: Is Management Cluster, when true indicates that the cluster is used for managing other clusters ,
Required: False ,
}
boolean ,
logCollectionProperties:
{
Description: Log Collection properties of the cluster. ,
Required: False ,
}
{
fromDate:
{
Description: From DateTimeStamp from when logs need to be connected ,
Format: date-time ,
Required: False ,
}
string ,
toDate:
{
Description: To DateTimeStamp till when logs need to be connected ,
Format: date-time ,
Required: False ,
}
string ,
lastLogGenerated:
{
Description: Recent DateTimeStamp where logs are successfully generated ,
Format: date-time ,
Required: False ,
}
string ,
logCollectionSessionDetails:
{
Required: False ,
}
[
{
logStartTime:
{
Description: Start Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
logEndTime:
{
Description: End Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
timeCollected:
{
Description: Duration of logs collected ,
Format: date-time ,
Required: False ,
}
string ,
logSize:
{
Description: Size of the logs collected ,
Format: int64 ,
Required: False ,
}
integer ,
logCollectionStatus:
{
Description: LogCollection status ,
Enum:
{
None: No log collection has been initiated. ,
InProgress: Log collection is currently in progress. ,
Failed: Log collection has failed. ,
Succeeded: Log collection completed successfully. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: CorrelationId of the log collection ,
Required: False ,
}
string ,
logCollectionJobType:
{
Description: Specifies the type of log collection job. Determines whether the logs are collected immediately on demand or as part of a scheduled operation. ,
Enum:
{
OnDemand: Log collection is triggered manually and executed immediately. ,
Scheduled: Log collection is scheduled to run at a predefined time or interval. ,
}
,
Required: False ,
}
enum ,
endTimeCollected:
{
Description: End Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
logCollectionError:
{
Description: Log Collection Error details of the cluster. ,
Required: False ,
}
{
errorCode:
{
Description: Error Code of the log collection ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error Message of the log collection ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
remoteSupportProperties:
{
Description: RemoteSupport properties of the cluster. ,
Required: False ,
}
{
accessLevel:
{
Description: Remote Support Access Level ,
Enum:
{
Diagnostics: Allows remote diagnostics operations only. ,
DiagnosticsAndRepair: Allows both remote diagnostics and repair operations. ,
}
,
Required: False ,
}
enum ,
expirationTimeStamp:
{
Description: Expiration DateTimeStamp when Remote Support Access will be expired ,
Format: date-time ,
Required: False ,
}
string ,
remoteSupportType:
{
Description: Remote Support Type for cluster ,
Enum:
{
Enable: Enable remote support for the cluster. ,
Revoke: Revoke previously enabled remote support for the cluster. ,
}
,
Required: False ,
}
enum ,
remoteSupportNodeSettings:
{
Required: False ,
}
[
{
arcResourceId:
{
Description: Arc ResourceId of the Node ,
Required: False ,
}
string ,
state:
{
Description: Remote Support Access Connection State on the Node ,
Required: False ,
}
string ,
createdAt:
{
Description: Remote Support Enablement Request Created TimeStamp on the Node ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: Remote Support Enablement Request Updated TimeStamp on the Node ,
Format: date-time ,
Required: False ,
}
string ,
connectionStatus:
{
Description: Remote Support Access Connection Status on the Node ,
Required: False ,
}
string ,
connectionErrorMessage:
{
Description: Remote Support Access Connection Error Message on the Node ,
Required: False ,
}
string ,
transcriptLocation:
{
Description: Remote Support Transcript location on the node ,
Required: False ,
}
string ,
}
,
]
,
remoteSupportSessionDetails:
{
Required: False ,
}
[
{
sessionStartTime:
{
Description: Remote Support Session StartTime on the Node ,
Format: date-time ,
Required: False ,
}
string ,
sessionEndTime:
{
Description: Remote Support Session EndTime on the Node ,
Format: date-time ,
Required: False ,
}
string ,
nodeName:
{
Description: Name of the node ,
Required: False ,
}
string ,
duration:
{
Description: Duration of Remote Support Enablement ,
Format: int64 ,
Required: False ,
}
integer ,
accessLevel:
{
Description: Remote Support Access Level ,
Enum:
{
Diagnostics: Allows remote diagnostics operations only. ,
DiagnosticsAndRepair: Allows both remote diagnostics and repair operations. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
desiredProperties:
{
Description: Desired properties of the cluster. ,
Required: False ,
}
{
windowsServerSubscription:
{
Description: Desired state of Windows Server Subscription. ,
Enum:
{
Disabled: Windows Server Subscription is disabled. ,
Enabled: Windows Server Subscription is enabled. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Desired level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No diagnostic data will be emitted. ,
Basic: Basic diagnostic data will be emitted, including essential health metrics. ,
Enhanced: Enhanced diagnostic data will be emitted, including detailed performance and usage metrics. ,
}
,
Required: False ,
}
enum ,
}
,
reportedProperties:
{
Description: Properties reported by cluster agent. ,
Required: False ,
}
{
clusterName:
{
Description: Name of the on-prem cluster connected to this resource. ,
Required: False ,
}
string ,
clusterId:
{
Description: Unique id generated by the on-prem cluster. ,
Required: False ,
}
string ,
clusterVersion:
{
Description: Version of the cluster software. ,
Required: False ,
}
string ,
nodes:
{
Description: List of nodes reported by the cluster. ,
Required: False ,
}
[
{
name:
{
Description: Name of the cluster node. ,
Required: False ,
}
string ,
id:
{
Description: Id of the node in the cluster. ,
Format: float ,
Required: False ,
}
number ,
windowsServerSubscription:
{
Description: State of Windows Server Subscription. ,
Enum:
{
Disabled: Windows Server Subscription is disabled. ,
Enabled: Windows Server Subscription is enabled. ,
}
,
Required: False ,
}
enum ,
nodeType:
{
Description: Type of the cluster node hardware. ,
Enum:
{
FirstParty: All nodes in the cluster are provided and managed by Microsoft. ,
ThirdParty: All nodes in the cluster are provided and managed by a third-party vendor. ,
}
,
Required: False ,
}
enum ,
ehcResourceId:
{
Description: Edge Hardware Center Resource Id ,
Required: False ,
}
string ,
manufacturer:
{
Description: Manufacturer of the cluster node hardware. ,
Required: False ,
}
string ,
model:
{
Description: Model name of the cluster node hardware. ,
Required: False ,
}
string ,
osName:
{
Description: Operating system running on the cluster node. ,
Required: False ,
}
string ,
osVersion:
{
Description: Version of the operating system running on the cluster node. ,
Required: False ,
}
string ,
osDisplayVersion:
{
Description: Display version of the operating system running on the cluster node. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Immutable id of the cluster node. ,
Required: False ,
}
string ,
coreCount:
{
Description: Number of physical cores on the cluster node. ,
Format: float ,
Required: False ,
}
number ,
memoryInGiB:
{
Description: Total available memory on the cluster node (in GiB). ,
Format: float ,
Required: False ,
}
number ,
lastLicensingTimestamp:
{
Description: Most recent licensing timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
oemActivation:
{
Description: OEM activation status of the node. ,
Enum:
{
Disabled: OEM activation is disabled for the cluster. ,
Enabled: OEM activation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
lastUpdated:
{
Description: Last time the cluster reported the data. ,
Format: date-time ,
Required: False ,
}
string ,
msiExpirationTimeStamp:
{
Description: Specifies the expiration timestamp of the cluster's Managed Service Identity (MSI). The value is expressed in Coordinated Universal Time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
imdsAttestation:
{
Description: IMDS attestation status of the cluster. ,
Enum:
{
Disabled: IMDS attestation is disabled for the cluster. ,
Enabled: IMDS attestation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No diagnostic data will be emitted. ,
Basic: Basic diagnostic data will be emitted, including essential health metrics. ,
Enhanced: Enhanced diagnostic data will be emitted, including detailed performance and usage metrics. ,
}
,
Required: False ,
}
enum ,
supportedCapabilities:
{
Description: Capabilities supported by the cluster. ,
Required: False ,
}
[
string ,
]
,
clusterType:
{
Description: Specifies the type of hardware vendor for all nodes in the cluster. Indicates whether the nodes are provided by Microsoft or a third-party vendor. ,
Enum:
{
FirstParty: All nodes in the cluster are provided and managed by Microsoft. ,
ThirdParty: All nodes in the cluster are provided and managed by a third-party vendor. ,
}
,
Required: False ,
}
enum ,
manufacturer:
{
Description: The manufacturer of all the nodes of the cluster. ,
Required: False ,
}
string ,
oemActivation:
{
Description: OEM activation status of the cluster. ,
Enum:
{
Disabled: OEM activation is disabled for the cluster. ,
Enabled: OEM activation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
hardwareClass:
{
Description: Hardware class of the cluster. ,
Enum:
{
Small: The hardware class is small. ,
Medium: The hardware class is medium. This corresponds to the default ,
Large: The hardware class is large. ,
}
,
Required: False ,
}
enum ,
}
,
isolatedVmAttestationConfiguration:
{
Description: Attestation configurations for isolated VM (e.g. TVM, CVM) of the cluster. ,
Required: False ,
}
{
attestationResourceId:
{
Description: Fully qualified Azure resource id of the Microsoft Azure attestation resource associated with this cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
relyingPartyServiceEndpoint:
{
Description: Region specific endpoint for relying party service. ,
Required: False ,
}
string ,
attestationServiceEndpoint:
{
Description: Region specific endpoint for Microsoft Azure Attestation service for the cluster ,
Required: False ,
}
string ,
}
,
trialDaysRemaining:
{
Description: Number of days remaining in the trial period. ,
Format: float ,
Required: False ,
}
number ,
billingModel:
{
Description: Type of billing applied to the resource. ,
Required: False ,
}
string ,
registrationTimestamp:
{
Description: First cluster sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncTimestamp:
{
Description: Most recent cluster sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastBillingTimestamp:
{
Description: Most recent billing meter timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
serviceEndpoint:
{
Description: Region specific DataPath Endpoint of the cluster. ,
Required: False ,
}
string ,
resourceProviderObjectId:
{
Description: Object id of RP Service Principal ,
Required: False ,
}
string ,
secretsLocations:
{
Description: List of secret locations. ,
Required: False ,
}
[
{
secretsType:
{
Description: Type of secrets to store ,
Enum:
{
BackupSecrets: Backup secrets type ,
}
,
Required: True ,
}
enum ,
secretsLocation:
{
Description: secrets location ,
Required: True ,
}
string ,
}
,
]
,
clusterPattern:
{
Description: Supported Storage Type for HCI Cluster ,
Enum:
{
Standard: Standard cluster. ,
RackAware: RackAware cluster. ,
}
,
Required: False ,
}
enum ,
confidentialVmProperties:
{
Description: Represents the Confidential Virtual Machine (CVM) support intent and current status for the cluster resource. ,
Required: False ,
}
{
confidentialVmIntent:
{
Description: Captures the customer's intent to enable or disable CVM support on the cluster, either during initial deployment (Day-0) or at a later stage (Day-N). ,
Enum:
{
Enable: Indicates that the customer intends to enable CVM support on the cluster. ,
Disable: Indicates that the customer intends to disable CVM support on the cluster. ,
}
,
Required: False ,
}
enum ,
confidentialVmStatus:
{
Description: Captures the current status of CVM support on the cluster. ,
Enum:
{
Enabled: CVM support is fully enabled on the cluster. All nodes are CVM capable. ,
PartiallyEnabled: CVM support is partially enabled. At least one node in the cluster is CVM capable. ,
Disabled: CVM support is disabled. None of the nodes in the cluster are CVM capable. ,
}
,
Required: False ,
}
enum ,
confidentialVmStatusSummary:
{
Description: Additional context about CVM support on the cluster, such as reasons for partial enablement or hardware constraints. ,
Required: False ,
}
string ,
}
,
sdnProperties:
{
Description: Software Defined Networking Properties of the cluster ,
Required: False ,
}
{
sdnIntegrationIntent:
{
Description: Indicates whether Software Defined Networking (SDN) integration should be enabled or disabled for this deployment. ,
Enum:
{
Enable: Enable SDN integration for the deployment. ,
Disable: Disable SDN integration for the deployment. ,
}
,
Required: False ,
}
enum ,
}
,
localAvailabilityZones:
{
Description: Local Availability Zone information for HCI cluster ,
Required: False ,
}
[
{
localAvailabilityZoneName:
{
Description: Local Availability Zone name for HCI cluster ,
Required: False ,
}
string ,
nodes:
{
Description: Nodes belonging to a particular zone ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
identityProvider:
{
Description: Identity Provider for the cluster ,
Enum:
{
ActiveDirectory: Uses Active Directory as the identity provider, enabling domain-based authentication and centralized identity management. This is the default option. ,
LocalIdentity: Uses a local identity system integrated with Azure Key Vault for authentication. Suitable for AD-less environments where Active Directory is not available or required. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
kind:
{
Description: This property identifies the purpose of the Cluster deployment. For example, a valid value is AzureLocal ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
UpdateSummaries_List (new)
Description :  List all Update summaries under the HCI cluster
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/updateSummaries
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Update Summaries ,
Required: False ,
}
[
{
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
properties:
{
Description: Update summaries properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the UpdateSummaries proxy resource. Indicates the current lifecycle status of the update summary operation, such as whether it has been accepted, is in progress, or has completed. ,
Enum:
{
Succeeded: The update summary operation completed successfully. ,
Failed: The update summary operation failed. ,
Canceled: The update summary operation was canceled before completion. ,
Accepted: The update summary operation has been accepted and is pending execution. ,
Provisioning: The update summary operation is currently being provisioned. ,
}
,
Required: False ,
}
enum ,
oemFamily:
{
Description: OEM family name. ,
Required: False ,
}
string ,
currentOemVersion:
{
Description: Current OEM Version. ,
Required: False ,
}
string ,
hardwareModel:
{
Description: Name of the hardware model. ,
Required: False ,
}
string ,
packageVersions:
{
Description: Current version of each updatable component. ,
Required: False ,
}
[
{
packageType:
{
Description: Package type ,
Required: False ,
}
string ,
version:
{
Description: Package version ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Last time this component was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
currentVersion:
{
Description: Current Solution Bundle version of the stamp. ,
Required: False ,
}
string ,
currentSbeVersion:
{
Description: Current Sbe version of the stamp. ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Last time an update installation completed successfully. ,
Format: date-time ,
Required: False ,
}
string ,
lastChecked:
{
Description: Last time the update service successfully checked for updates ,
Format: date-time ,
Required: False ,
}
string ,
healthState:
{
Description: Overall health state for update-specific health checks. ,
Required: False ,
}
object ,
healthCheckResult:
{
Description: An array of pre-check result objects. ,
Required: False ,
}
[
{
name:
{
Description: Name of the individual test/rule/alert that was executed. Unique, not exposed to the customer. ,
Required: False ,
}
string ,
displayName:
{
Description: The health check DisplayName localized of the individual test executed. ,
Required: False ,
}
string ,
tags:
{
Description: Key-value pairs that allow grouping/filtering individual tests. ,
Required: False ,
}
{
key:
{
Description: Key that allow grouping/filtering individual tests. ,
Required: False ,
}
string ,
value:
{
Description: Value of the key that allow grouping/filtering individual tests. ,
Required: False ,
}
string ,
}
,
healthCheckTags:
{
Description: Key-value pairs that allow grouping/filtering individual tests. ,
Required: False ,
}
object ,
title:
{
Description: User-facing name; one or more sentences indicating the direct issue. ,
Required: False ,
}
string ,
status:
{
Description: Represents the current status of the check being performed. Indicates whether the check has completed successfully, failed, or is still in progress. ,
Enum:
{
Succeeded: The check completed successfully. ,
Failed: The check completed but failed. ,
InProgress: The check is currently in progress. ,
}
,
Required: False ,
}
enum ,
severity:
{
Description: Indicates the importance or impact level of the result. Determines whether the result is informational, a warning, or a critical issue that may block updates. ,
Enum:
{
Critical: A critical issue that blocks updates and requires immediate attention. ,
Warning: A warning that may indicate a potential issue but does not block updates. ,
Informational: General information that does not indicate any issue. ,
Hidden: The result is hidden and not shown in the output. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Detailed overview of the issue and what impact the issue has on the stamp. ,
Required: False ,
}
string ,
remediation:
{
Description: Set of steps that can be taken to resolve the issue found. ,
Required: False ,
}
string ,
targetResourceID:
{
Description: The unique identifier for the affected resource (such as a node or drive). ,
Required: False ,
}
string ,
targetResourceName:
{
Description: The name of the affected resource. ,
Required: False ,
}
string ,
targetResourceType:
{
Description: The type of resource being referred to (well-known set of nouns in infrastructure, aligning with Monitoring). ,
Required: False ,
}
string ,
timestamp:
{
Description: The time in which the HealthCheck was called. ,
Format: date-time ,
Required: False ,
}
string ,
additionalData:
{
Description: Property bag of key value pairs for additional information. ,
Required: False ,
}
string ,
healthCheckSource:
{
Description: The name of the services called for the HealthCheck (I.E. Test-AzureStack, Test-Cluster). ,
Required: False ,
}
string ,
}
,
]
,
healthCheckDate:
{
Description: Last time the package-specific checks were run. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: Overall update state of the stamp. Indicates the current status of update deployment across the stamp, including preparation, application, and any issues encountered. ,
Enum:
{
Unknown: The update state is not known. ,
AppliedSuccessfully: Updates have been successfully applied to the stamp. ,
UpdateAvailable: Updates are available but have not yet been applied. ,
UpdateInProgress: Updates are currently being applied to the stamp. ,
UpdateFailed: The update process failed. ,
NeedsAttention: The update process requires user intervention or has encountered issues needing attention. ,
PreparationInProgress: Preparation for the update is currently in progress. ,
PreparationFailed: Preparation for the update failed. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
UpdateSummaries_Get (new)
Description :  Get all Update summaries under the HCI cluster
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/updateSummaries/default
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
properties:
{
Description: Update summaries properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the UpdateSummaries proxy resource. Indicates the current lifecycle status of the update summary operation, such as whether it has been accepted, is in progress, or has completed. ,
Enum:
{
Succeeded: The update summary operation completed successfully. ,
Failed: The update summary operation failed. ,
Canceled: The update summary operation was canceled before completion. ,
Accepted: The update summary operation has been accepted and is pending execution. ,
Provisioning: The update summary operation is currently being provisioned. ,
}
,
Required: False ,
}
enum ,
oemFamily:
{
Description: OEM family name. ,
Required: False ,
}
string ,
currentOemVersion:
{
Description: Current OEM Version. ,
Required: False ,
}
string ,
hardwareModel:
{
Description: Name of the hardware model. ,
Required: False ,
}
string ,
packageVersions:
{
Description: Current version of each updatable component. ,
Required: False ,
}
[
{
packageType:
{
Description: Package type ,
Required: False ,
}
string ,
version:
{
Description: Package version ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Last time this component was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
currentVersion:
{
Description: Current Solution Bundle version of the stamp. ,
Required: False ,
}
string ,
currentSbeVersion:
{
Description: Current Sbe version of the stamp. ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Last time an update installation completed successfully. ,
Format: date-time ,
Required: False ,
}
string ,
lastChecked:
{
Description: Last time the update service successfully checked for updates ,
Format: date-time ,
Required: False ,
}
string ,
healthState:
{
Description: Overall health state for update-specific health checks. ,
Required: False ,
}
object ,
healthCheckResult:
{
Description: An array of pre-check result objects. ,
Required: False ,
}
[
{
name:
{
Description: Name of the individual test/rule/alert that was executed. Unique, not exposed to the customer. ,
Required: False ,
}
string ,
displayName:
{
Description: The health check DisplayName localized of the individual test executed. ,
Required: False ,
}
string ,
tags:
{
Description: Key-value pairs that allow grouping/filtering individual tests. ,
Required: False ,
}
{
key:
{
Description: Key that allow grouping/filtering individual tests. ,
Required: False ,
}
string ,
value:
{
Description: Value of the key that allow grouping/filtering individual tests. ,
Required: False ,
}
string ,
}
,
healthCheckTags:
{
Description: Key-value pairs that allow grouping/filtering individual tests. ,
Required: False ,
}
object ,
title:
{
Description: User-facing name; one or more sentences indicating the direct issue. ,
Required: False ,
}
string ,
status:
{
Description: Represents the current status of the check being performed. Indicates whether the check has completed successfully, failed, or is still in progress. ,
Enum:
{
Succeeded: The check completed successfully. ,
Failed: The check completed but failed. ,
InProgress: The check is currently in progress. ,
}
,
Required: False ,
}
enum ,
severity:
{
Description: Indicates the importance or impact level of the result. Determines whether the result is informational, a warning, or a critical issue that may block updates. ,
Enum:
{
Critical: A critical issue that blocks updates and requires immediate attention. ,
Warning: A warning that may indicate a potential issue but does not block updates. ,
Informational: General information that does not indicate any issue. ,
Hidden: The result is hidden and not shown in the output. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Detailed overview of the issue and what impact the issue has on the stamp. ,
Required: False ,
}
string ,
remediation:
{
Description: Set of steps that can be taken to resolve the issue found. ,
Required: False ,
}
string ,
targetResourceID:
{
Description: The unique identifier for the affected resource (such as a node or drive). ,
Required: False ,
}
string ,
targetResourceName:
{
Description: The name of the affected resource. ,
Required: False ,
}
string ,
targetResourceType:
{
Description: The type of resource being referred to (well-known set of nouns in infrastructure, aligning with Monitoring). ,
Required: False ,
}
string ,
timestamp:
{
Description: The time in which the HealthCheck was called. ,
Format: date-time ,
Required: False ,
}
string ,
additionalData:
{
Description: Property bag of key value pairs for additional information. ,
Required: False ,
}
string ,
healthCheckSource:
{
Description: The name of the services called for the HealthCheck (I.E. Test-AzureStack, Test-Cluster). ,
Required: False ,
}
string ,
}
,
]
,
healthCheckDate:
{
Description: Last time the package-specific checks were run. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: Overall update state of the stamp. Indicates the current status of update deployment across the stamp, including preparation, application, and any issues encountered. ,
Enum:
{
Unknown: The update state is not known. ,
AppliedSuccessfully: Updates have been successfully applied to the stamp. ,
UpdateAvailable: Updates are available but have not yet been applied. ,
UpdateInProgress: Updates are currently being applied to the stamp. ,
UpdateFailed: The update process failed. ,
NeedsAttention: The update process requires user intervention or has encountered issues needing attention. ,
PreparationInProgress: Preparation for the update is currently in progress. ,
PreparationFailed: Preparation for the update failed. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
UpdateSummaries_Put (new)
Description :  Put Update summaries under the HCI cluster
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/updateSummaries/default
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
updateLocationProperties:
{
Description: Properties of the UpdateSummaries resource ,
Required: True ,
}
{
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
properties:
{
Description: Update summaries properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the UpdateSummaries proxy resource. Indicates the current lifecycle status of the update summary operation, such as whether it has been accepted, is in progress, or has completed. ,
Enum:
{
Succeeded: The update summary operation completed successfully. ,
Failed: The update summary operation failed. ,
Canceled: The update summary operation was canceled before completion. ,
Accepted: The update summary operation has been accepted and is pending execution. ,
Provisioning: The update summary operation is currently being provisioned. ,
}
,
Required: False ,
}
enum ,
oemFamily:
{
Description: OEM family name. ,
Required: False ,
}
string ,
currentOemVersion:
{
Description: Current OEM Version. ,
Required: False ,
}
string ,
hardwareModel:
{
Description: Name of the hardware model. ,
Required: False ,
}
string ,
packageVersions:
{
Description: Current version of each updatable component. ,
Required: False ,
}
[
{
packageType:
{
Description: Package type ,
Required: False ,
}
string ,
version:
{
Description: Package version ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Last time this component was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
currentVersion:
{
Description: Current Solution Bundle version of the stamp. ,
Required: False ,
}
string ,
currentSbeVersion:
{
Description: Current Sbe version of the stamp. ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Last time an update installation completed successfully. ,
Format: date-time ,
Required: False ,
}
string ,
lastChecked:
{
Description: Last time the update service successfully checked for updates ,
Format: date-time ,
Required: False ,
}
string ,
healthState:
{
Description: Overall health state for update-specific health checks. ,
Required: False ,
}
object ,
healthCheckResult:
{
Description: An array of pre-check result objects. ,
Required: False ,
}
[
{
name:
{
Description: Name of the individual test/rule/alert that was executed. Unique, not exposed to the customer. ,
Required: False ,
}
string ,
displayName:
{
Description: The health check DisplayName localized of the individual test executed. ,
Required: False ,
}
string ,
tags:
{
Description: Key-value pairs that allow grouping/filtering individual tests. ,
Required: False ,
}
{
key:
{
Description: Key that allow grouping/filtering individual tests. ,
Required: False ,
}
string ,
value:
{
Description: Value of the key that allow grouping/filtering individual tests. ,
Required: False ,
}
string ,
}
,
healthCheckTags:
{
Description: Key-value pairs that allow grouping/filtering individual tests. ,
Required: False ,
}
object ,
title:
{
Description: User-facing name; one or more sentences indicating the direct issue. ,
Required: False ,
}
string ,
status:
{
Description: Represents the current status of the check being performed. Indicates whether the check has completed successfully, failed, or is still in progress. ,
Enum:
{
Succeeded: The check completed successfully. ,
Failed: The check completed but failed. ,
InProgress: The check is currently in progress. ,
}
,
Required: False ,
}
enum ,
severity:
{
Description: Indicates the importance or impact level of the result. Determines whether the result is informational, a warning, or a critical issue that may block updates. ,
Enum:
{
Critical: A critical issue that blocks updates and requires immediate attention. ,
Warning: A warning that may indicate a potential issue but does not block updates. ,
Informational: General information that does not indicate any issue. ,
Hidden: The result is hidden and not shown in the output. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Detailed overview of the issue and what impact the issue has on the stamp. ,
Required: False ,
}
string ,
remediation:
{
Description: Set of steps that can be taken to resolve the issue found. ,
Required: False ,
}
string ,
targetResourceID:
{
Description: The unique identifier for the affected resource (such as a node or drive). ,
Required: False ,
}
string ,
targetResourceName:
{
Description: The name of the affected resource. ,
Required: False ,
}
string ,
targetResourceType:
{
Description: The type of resource being referred to (well-known set of nouns in infrastructure, aligning with Monitoring). ,
Required: False ,
}
string ,
timestamp:
{
Description: The time in which the HealthCheck was called. ,
Format: date-time ,
Required: False ,
}
string ,
additionalData:
{
Description: Property bag of key value pairs for additional information. ,
Required: False ,
}
string ,
healthCheckSource:
{
Description: The name of the services called for the HealthCheck (I.E. Test-AzureStack, Test-Cluster). ,
Required: False ,
}
string ,
}
,
]
,
healthCheckDate:
{
Description: Last time the package-specific checks were run. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: Overall update state of the stamp. Indicates the current status of update deployment across the stamp, including preparation, application, and any issues encountered. ,
Enum:
{
Unknown: The update state is not known. ,
AppliedSuccessfully: Updates have been successfully applied to the stamp. ,
UpdateAvailable: Updates are available but have not yet been applied. ,
UpdateInProgress: Updates are currently being applied to the stamp. ,
UpdateFailed: The update process failed. ,
NeedsAttention: The update process requires user intervention or has encountered issues needing attention. ,
PreparationInProgress: Preparation for the update is currently in progress. ,
PreparationFailed: Preparation for the update failed. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
properties:
{
Description: Update summaries properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the UpdateSummaries proxy resource. Indicates the current lifecycle status of the update summary operation, such as whether it has been accepted, is in progress, or has completed. ,
Enum:
{
Succeeded: The update summary operation completed successfully. ,
Failed: The update summary operation failed. ,
Canceled: The update summary operation was canceled before completion. ,
Accepted: The update summary operation has been accepted and is pending execution. ,
Provisioning: The update summary operation is currently being provisioned. ,
}
,
Required: False ,
}
enum ,
oemFamily:
{
Description: OEM family name. ,
Required: False ,
}
string ,
currentOemVersion:
{
Description: Current OEM Version. ,
Required: False ,
}
string ,
hardwareModel:
{
Description: Name of the hardware model. ,
Required: False ,
}
string ,
packageVersions:
{
Description: Current version of each updatable component. ,
Required: False ,
}
[
{
packageType:
{
Description: Package type ,
Required: False ,
}
string ,
version:
{
Description: Package version ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Last time this component was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
currentVersion:
{
Description: Current Solution Bundle version of the stamp. ,
Required: False ,
}
string ,
currentSbeVersion:
{
Description: Current Sbe version of the stamp. ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Last time an update installation completed successfully. ,
Format: date-time ,
Required: False ,
}
string ,
lastChecked:
{
Description: Last time the update service successfully checked for updates ,
Format: date-time ,
Required: False ,
}
string ,
healthState:
{
Description: Overall health state for update-specific health checks. ,
Required: False ,
}
object ,
healthCheckResult:
{
Description: An array of pre-check result objects. ,
Required: False ,
}
[
{
name:
{
Description: Name of the individual test/rule/alert that was executed. Unique, not exposed to the customer. ,
Required: False ,
}
string ,
displayName:
{
Description: The health check DisplayName localized of the individual test executed. ,
Required: False ,
}
string ,
tags:
{
Description: Key-value pairs that allow grouping/filtering individual tests. ,
Required: False ,
}
{
key:
{
Description: Key that allow grouping/filtering individual tests. ,
Required: False ,
}
string ,
value:
{
Description: Value of the key that allow grouping/filtering individual tests. ,
Required: False ,
}
string ,
}
,
healthCheckTags:
{
Description: Key-value pairs that allow grouping/filtering individual tests. ,
Required: False ,
}
object ,
title:
{
Description: User-facing name; one or more sentences indicating the direct issue. ,
Required: False ,
}
string ,
status:
{
Description: Represents the current status of the check being performed. Indicates whether the check has completed successfully, failed, or is still in progress. ,
Enum:
{
Succeeded: The check completed successfully. ,
Failed: The check completed but failed. ,
InProgress: The check is currently in progress. ,
}
,
Required: False ,
}
enum ,
severity:
{
Description: Indicates the importance or impact level of the result. Determines whether the result is informational, a warning, or a critical issue that may block updates. ,
Enum:
{
Critical: A critical issue that blocks updates and requires immediate attention. ,
Warning: A warning that may indicate a potential issue but does not block updates. ,
Informational: General information that does not indicate any issue. ,
Hidden: The result is hidden and not shown in the output. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Detailed overview of the issue and what impact the issue has on the stamp. ,
Required: False ,
}
string ,
remediation:
{
Description: Set of steps that can be taken to resolve the issue found. ,
Required: False ,
}
string ,
targetResourceID:
{
Description: The unique identifier for the affected resource (such as a node or drive). ,
Required: False ,
}
string ,
targetResourceName:
{
Description: The name of the affected resource. ,
Required: False ,
}
string ,
targetResourceType:
{
Description: The type of resource being referred to (well-known set of nouns in infrastructure, aligning with Monitoring). ,
Required: False ,
}
string ,
timestamp:
{
Description: The time in which the HealthCheck was called. ,
Format: date-time ,
Required: False ,
}
string ,
additionalData:
{
Description: Property bag of key value pairs for additional information. ,
Required: False ,
}
string ,
healthCheckSource:
{
Description: The name of the services called for the HealthCheck (I.E. Test-AzureStack, Test-Cluster). ,
Required: False ,
}
string ,
}
,
]
,
healthCheckDate:
{
Description: Last time the package-specific checks were run. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: Overall update state of the stamp. Indicates the current status of update deployment across the stamp, including preparation, application, and any issues encountered. ,
Enum:
{
Unknown: The update state is not known. ,
AppliedSuccessfully: Updates have been successfully applied to the stamp. ,
UpdateAvailable: Updates are available but have not yet been applied. ,
UpdateInProgress: Updates are currently being applied to the stamp. ,
UpdateFailed: The update process failed. ,
NeedsAttention: The update process requires user intervention or has encountered issues needing attention. ,
PreparationInProgress: Preparation for the update is currently in progress. ,
PreparationFailed: Preparation for the update failed. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
UpdateSummaries_Delete (new)
Description :  Delete Update Summaries
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/updateSummaries/default
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URL to query for status of the operation. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Updates_List (new)
Description :  List all Updates
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/updates
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Updates ,
Required: False ,
}
[
{
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
properties:
{
Description: Update properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Updates proxy resource. Indicates the current lifecycle status of the update operation, such as whether it has been accepted, is in progress, or has completed. ,
Enum:
{
Succeeded: The update operation completed successfully. ,
Failed: The update operation failed. ,
Canceled: The update operation was canceled before completion. ,
Accepted: The update operation has been accepted and is pending execution. ,
Provisioning: The update operation is currently being provisioned. ,
}
,
Required: False ,
}
enum ,
installedDate:
{
Description: Date that the update was installed. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Description of the update. ,
Required: False ,
}
string ,
minSbeVersionRequired:
{
Description: Minimum Sbe Version of the update. ,
Required: False ,
}
string ,
state:
{
Description: Represents the current state of the update as it relates to this stamp. This includes phases such as preparation, installation, scanning, and error handling, providing insight into the update's progress and any issues encountered. ,
Enum:
{
HasPrerequisite: The update has prerequisites that must be fulfilled before it can proceed. ,
Obsolete: The update is obsolete and no longer applicable. ,
Ready: The update is ready to be installed. ,
NotApplicableBecauseAnotherUpdateIsInProgress: The update cannot be applied because another update is currently in progress. ,
Preparing: The update is currently in the preparation phase. ,
Installing: The update is currently being installed. ,
Installed: The update has been successfully installed. ,
PreparationFailed: The update preparation phase failed. ,
InstallationFailed: The update installation failed. ,
Invalid: The update is invalid and cannot be applied. ,
Recalled: The update has been recalled and should not be applied. ,
Downloading: The update is currently being downloaded. ,
DownloadFailed: The update download failed. ,
HealthChecking: A health check is being performed before applying the update. ,
HealthCheckFailed: The health check failed, preventing the update from proceeding. ,
ReadyToInstall: The update is ready to be installed after successful preparation and checks. ,
ScanInProgress: The system is scanning for updates. ,
ScanFailed: The scan for updates failed. ,
AdditionalContentRequired: Additional content is required to proceed with the update. ,
}
,
Required: False ,
}
enum ,
prerequisites:
{
Description: If update State is HasPrerequisite, this property contains an array of objects describing prerequisite updates before installing this update. Otherwise, it is empty. ,
Required: False ,
}
[
{
updateType:
{
Description: Updatable component type. ,
Required: False ,
}
string ,
version:
{
Description: Version of the prerequisite. ,
Required: False ,
}
string ,
packageName:
{
Description: Friendly name of the prerequisite. ,
Required: False ,
}
string ,
}
,
]
,
componentVersions:
{
Description: An array of component versions for a Solution Bundle update, and an empty array otherwise. ,
Required: False ,
}
[
{
packageType:
{
Description: Package type ,
Required: False ,
}
string ,
version:
{
Description: Package version ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Last time this component was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
rebootRequired:
{
Description: Indicates whether a reboot is required after the update or operation. Helps determine if a system restart is necessary to complete the process. ,
Required: False ,
}
object ,
healthState:
{
Description: Overall health state for update-specific health checks. ,
Required: False ,
}
object ,
healthCheckResult:
{
Description: An array of PrecheckResult objects. ,
Required: False ,
}
[
{
name:
{
Description: Name of the individual test/rule/alert that was executed. Unique, not exposed to the customer. ,
Required: False ,
}
string ,
displayName:
{
Description: The health check DisplayName localized of the individual test executed. ,
Required: False ,
}
string ,
tags:
{
Description: Key-value pairs that allow grouping/filtering individual tests. ,
Required: False ,
}
{
key:
{
Description: Key that allow grouping/filtering individual tests. ,
Required: False ,
}
string ,
value:
{
Description: Value of the key that allow grouping/filtering individual tests. ,
Required: False ,
}
string ,
}
,
healthCheckTags:
{
Description: Key-value pairs that allow grouping/filtering individual tests. ,
Required: False ,
}
object ,
title:
{
Description: User-facing name; one or more sentences indicating the direct issue. ,
Required: False ,
}
string ,
status:
{
Description: Represents the current status of the check being performed. Indicates whether the check has completed successfully, failed, or is still in progress. ,
Enum:
{
Succeeded: The check completed successfully. ,
Failed: The check completed but failed. ,
InProgress: The check is currently in progress. ,
}
,
Required: False ,
}
enum ,
severity:
{
Description: Indicates the importance or impact level of the result. Determines whether the result is informational, a warning, or a critical issue that may block updates. ,
Enum:
{
Critical: A critical issue that blocks updates and requires immediate attention. ,
Warning: A warning that may indicate a potential issue but does not block updates. ,
Informational: General information that does not indicate any issue. ,
Hidden: The result is hidden and not shown in the output. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Detailed overview of the issue and what impact the issue has on the stamp. ,
Required: False ,
}
string ,
remediation:
{
Description: Set of steps that can be taken to resolve the issue found. ,
Required: False ,
}
string ,
targetResourceID:
{
Description: The unique identifier for the affected resource (such as a node or drive). ,
Required: False ,
}
string ,
targetResourceName:
{
Description: The name of the affected resource. ,
Required: False ,
}
string ,
targetResourceType:
{
Description: The type of resource being referred to (well-known set of nouns in infrastructure, aligning with Monitoring). ,
Required: False ,
}
string ,
timestamp:
{
Description: The time in which the HealthCheck was called. ,
Format: date-time ,
Required: False ,
}
string ,
additionalData:
{
Description: Property bag of key value pairs for additional information. ,
Required: False ,
}
string ,
healthCheckSource:
{
Description: The name of the services called for the HealthCheck (I.E. Test-AzureStack, Test-Cluster). ,
Required: False ,
}
string ,
}
,
]
,
healthCheckDate:
{
Description: Last time the package-specific checks were run. ,
Format: date-time ,
Required: False ,
}
string ,
packagePath:
{
Description: Path where the update package is available. ,
Required: False ,
}
string ,
packageSizeInMb:
{
Description: Size of the package. This value is a combination of the size from update metadata and size of the payload that results from the live scan operation for OS update content. ,
Required: False ,
}
number ,
displayName:
{
Description: Display name of the Update ,
Required: False ,
}
string ,
version:
{
Description: Version of the update. ,
Required: False ,
}
string ,
publisher:
{
Description: Publisher of the update package. ,
Required: False ,
}
string ,
releaseLink:
{
Description: Link to release notes for the update. ,
Required: False ,
}
string ,
availabilityType:
{
Description: Indicates how the update content is made available for download. This determines whether the update is sourced locally, from an online repository, or requires user notification. ,
Enum:
{
Local: The update content is available locally within the environment. ,
Online: The update content is available from an online source. ,
Notify: The system will notify the user when update content becomes available. ,
}
,
Required: False ,
}
enum ,
packageType:
{
Description: Customer-visible type of the update. ,
Required: False ,
}
string ,
additionalProperties:
{
Description: Extensible KV pairs serialized as a string. This is currently used to report the stamp OEM family and hardware model information when an update is flagged as Invalid for the stamp based on OEM type. ,
Required: False ,
}
string ,
updateStateProperties:
{
Description: Additional information regarding the state of the update. See definition of UpdateStateProperties type below for more details on this property. ,
Required: False ,
}
{
progressPercentage:
{
Description: Progress percentage of ongoing operation. Currently this property is only valid when the update is in the Downloading state, where it maps to how much of the update content has been downloaded. ,
Required: False ,
}
number ,
notifyMessage:
{
Description: Brief message with instructions for updates of AvailabilityType Notify. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Updates_Get (new)
Description :  Get specified Update
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/updates/{updateName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
updateName:
{
Description: The name of the Update ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
properties:
{
Description: Update properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Updates proxy resource. Indicates the current lifecycle status of the update operation, such as whether it has been accepted, is in progress, or has completed. ,
Enum:
{
Succeeded: The update operation completed successfully. ,
Failed: The update operation failed. ,
Canceled: The update operation was canceled before completion. ,
Accepted: The update operation has been accepted and is pending execution. ,
Provisioning: The update operation is currently being provisioned. ,
}
,
Required: False ,
}
enum ,
installedDate:
{
Description: Date that the update was installed. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Description of the update. ,
Required: False ,
}
string ,
minSbeVersionRequired:
{
Description: Minimum Sbe Version of the update. ,
Required: False ,
}
string ,
state:
{
Description: Represents the current state of the update as it relates to this stamp. This includes phases such as preparation, installation, scanning, and error handling, providing insight into the update's progress and any issues encountered. ,
Enum:
{
HasPrerequisite: The update has prerequisites that must be fulfilled before it can proceed. ,
Obsolete: The update is obsolete and no longer applicable. ,
Ready: The update is ready to be installed. ,
NotApplicableBecauseAnotherUpdateIsInProgress: The update cannot be applied because another update is currently in progress. ,
Preparing: The update is currently in the preparation phase. ,
Installing: The update is currently being installed. ,
Installed: The update has been successfully installed. ,
PreparationFailed: The update preparation phase failed. ,
InstallationFailed: The update installation failed. ,
Invalid: The update is invalid and cannot be applied. ,
Recalled: The update has been recalled and should not be applied. ,
Downloading: The update is currently being downloaded. ,
DownloadFailed: The update download failed. ,
HealthChecking: A health check is being performed before applying the update. ,
HealthCheckFailed: The health check failed, preventing the update from proceeding. ,
ReadyToInstall: The update is ready to be installed after successful preparation and checks. ,
ScanInProgress: The system is scanning for updates. ,
ScanFailed: The scan for updates failed. ,
AdditionalContentRequired: Additional content is required to proceed with the update. ,
}
,
Required: False ,
}
enum ,
prerequisites:
{
Description: If update State is HasPrerequisite, this property contains an array of objects describing prerequisite updates before installing this update. Otherwise, it is empty. ,
Required: False ,
}
[
{
updateType:
{
Description: Updatable component type. ,
Required: False ,
}
string ,
version:
{
Description: Version of the prerequisite. ,
Required: False ,
}
string ,
packageName:
{
Description: Friendly name of the prerequisite. ,
Required: False ,
}
string ,
}
,
]
,
componentVersions:
{
Description: An array of component versions for a Solution Bundle update, and an empty array otherwise. ,
Required: False ,
}
[
{
packageType:
{
Description: Package type ,
Required: False ,
}
string ,
version:
{
Description: Package version ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Last time this component was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
rebootRequired:
{
Description: Indicates whether a reboot is required after the update or operation. Helps determine if a system restart is necessary to complete the process. ,
Required: False ,
}
object ,
healthState:
{
Description: Overall health state for update-specific health checks. ,
Required: False ,
}
object ,
healthCheckResult:
{
Description: An array of PrecheckResult objects. ,
Required: False ,
}
[
{
name:
{
Description: Name of the individual test/rule/alert that was executed. Unique, not exposed to the customer. ,
Required: False ,
}
string ,
displayName:
{
Description: The health check DisplayName localized of the individual test executed. ,
Required: False ,
}
string ,
tags:
{
Description: Key-value pairs that allow grouping/filtering individual tests. ,
Required: False ,
}
{
key:
{
Description: Key that allow grouping/filtering individual tests. ,
Required: False ,
}
string ,
value:
{
Description: Value of the key that allow grouping/filtering individual tests. ,
Required: False ,
}
string ,
}
,
healthCheckTags:
{
Description: Key-value pairs that allow grouping/filtering individual tests. ,
Required: False ,
}
object ,
title:
{
Description: User-facing name; one or more sentences indicating the direct issue. ,
Required: False ,
}
string ,
status:
{
Description: Represents the current status of the check being performed. Indicates whether the check has completed successfully, failed, or is still in progress. ,
Enum:
{
Succeeded: The check completed successfully. ,
Failed: The check completed but failed. ,
InProgress: The check is currently in progress. ,
}
,
Required: False ,
}
enum ,
severity:
{
Description: Indicates the importance or impact level of the result. Determines whether the result is informational, a warning, or a critical issue that may block updates. ,
Enum:
{
Critical: A critical issue that blocks updates and requires immediate attention. ,
Warning: A warning that may indicate a potential issue but does not block updates. ,
Informational: General information that does not indicate any issue. ,
Hidden: The result is hidden and not shown in the output. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Detailed overview of the issue and what impact the issue has on the stamp. ,
Required: False ,
}
string ,
remediation:
{
Description: Set of steps that can be taken to resolve the issue found. ,
Required: False ,
}
string ,
targetResourceID:
{
Description: The unique identifier for the affected resource (such as a node or drive). ,
Required: False ,
}
string ,
targetResourceName:
{
Description: The name of the affected resource. ,
Required: False ,
}
string ,
targetResourceType:
{
Description: The type of resource being referred to (well-known set of nouns in infrastructure, aligning with Monitoring). ,
Required: False ,
}
string ,
timestamp:
{
Description: The time in which the HealthCheck was called. ,
Format: date-time ,
Required: False ,
}
string ,
additionalData:
{
Description: Property bag of key value pairs for additional information. ,
Required: False ,
}
string ,
healthCheckSource:
{
Description: The name of the services called for the HealthCheck (I.E. Test-AzureStack, Test-Cluster). ,
Required: False ,
}
string ,
}
,
]
,
healthCheckDate:
{
Description: Last time the package-specific checks were run. ,
Format: date-time ,
Required: False ,
}
string ,
packagePath:
{
Description: Path where the update package is available. ,
Required: False ,
}
string ,
packageSizeInMb:
{
Description: Size of the package. This value is a combination of the size from update metadata and size of the payload that results from the live scan operation for OS update content. ,
Required: False ,
}
number ,
displayName:
{
Description: Display name of the Update ,
Required: False ,
}
string ,
version:
{
Description: Version of the update. ,
Required: False ,
}
string ,
publisher:
{
Description: Publisher of the update package. ,
Required: False ,
}
string ,
releaseLink:
{
Description: Link to release notes for the update. ,
Required: False ,
}
string ,
availabilityType:
{
Description: Indicates how the update content is made available for download. This determines whether the update is sourced locally, from an online repository, or requires user notification. ,
Enum:
{
Local: The update content is available locally within the environment. ,
Online: The update content is available from an online source. ,
Notify: The system will notify the user when update content becomes available. ,
}
,
Required: False ,
}
enum ,
packageType:
{
Description: Customer-visible type of the update. ,
Required: False ,
}
string ,
additionalProperties:
{
Description: Extensible KV pairs serialized as a string. This is currently used to report the stamp OEM family and hardware model information when an update is flagged as Invalid for the stamp based on OEM type. ,
Required: False ,
}
string ,
updateStateProperties:
{
Description: Additional information regarding the state of the update. See definition of UpdateStateProperties type below for more details on this property. ,
Required: False ,
}
{
progressPercentage:
{
Description: Progress percentage of ongoing operation. Currently this property is only valid when the update is in the Downloading state, where it maps to how much of the update content has been downloaded. ,
Required: False ,
}
number ,
notifyMessage:
{
Description: Brief message with instructions for updates of AvailabilityType Notify. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Updates_Put (new)
Description :  Put specified Update
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/updates/{updateName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
updateName:
{
Description: The name of the Update ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
updateProperties:
{
Description: Properties of the Updates object ,
Required: True ,
}
{
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
properties:
{
Description: Update properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Updates proxy resource. Indicates the current lifecycle status of the update operation, such as whether it has been accepted, is in progress, or has completed. ,
Enum:
{
Succeeded: The update operation completed successfully. ,
Failed: The update operation failed. ,
Canceled: The update operation was canceled before completion. ,
Accepted: The update operation has been accepted and is pending execution. ,
Provisioning: The update operation is currently being provisioned. ,
}
,
Required: False ,
}
enum ,
installedDate:
{
Description: Date that the update was installed. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Description of the update. ,
Required: False ,
}
string ,
minSbeVersionRequired:
{
Description: Minimum Sbe Version of the update. ,
Required: False ,
}
string ,
state:
{
Description: Represents the current state of the update as it relates to this stamp. This includes phases such as preparation, installation, scanning, and error handling, providing insight into the update's progress and any issues encountered. ,
Enum:
{
HasPrerequisite: The update has prerequisites that must be fulfilled before it can proceed. ,
Obsolete: The update is obsolete and no longer applicable. ,
Ready: The update is ready to be installed. ,
NotApplicableBecauseAnotherUpdateIsInProgress: The update cannot be applied because another update is currently in progress. ,
Preparing: The update is currently in the preparation phase. ,
Installing: The update is currently being installed. ,
Installed: The update has been successfully installed. ,
PreparationFailed: The update preparation phase failed. ,
InstallationFailed: The update installation failed. ,
Invalid: The update is invalid and cannot be applied. ,
Recalled: The update has been recalled and should not be applied. ,
Downloading: The update is currently being downloaded. ,
DownloadFailed: The update download failed. ,
HealthChecking: A health check is being performed before applying the update. ,
HealthCheckFailed: The health check failed, preventing the update from proceeding. ,
ReadyToInstall: The update is ready to be installed after successful preparation and checks. ,
ScanInProgress: The system is scanning for updates. ,
ScanFailed: The scan for updates failed. ,
AdditionalContentRequired: Additional content is required to proceed with the update. ,
}
,
Required: False ,
}
enum ,
prerequisites:
{
Description: If update State is HasPrerequisite, this property contains an array of objects describing prerequisite updates before installing this update. Otherwise, it is empty. ,
Required: False ,
}
[
{
updateType:
{
Description: Updatable component type. ,
Required: False ,
}
string ,
version:
{
Description: Version of the prerequisite. ,
Required: False ,
}
string ,
packageName:
{
Description: Friendly name of the prerequisite. ,
Required: False ,
}
string ,
}
,
]
,
componentVersions:
{
Description: An array of component versions for a Solution Bundle update, and an empty array otherwise. ,
Required: False ,
}
[
{
packageType:
{
Description: Package type ,
Required: False ,
}
string ,
version:
{
Description: Package version ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Last time this component was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
rebootRequired:
{
Description: Indicates whether a reboot is required after the update or operation. Helps determine if a system restart is necessary to complete the process. ,
Required: False ,
}
object ,
healthState:
{
Description: Overall health state for update-specific health checks. ,
Required: False ,
}
object ,
healthCheckResult:
{
Description: An array of PrecheckResult objects. ,
Required: False ,
}
[
{
name:
{
Description: Name of the individual test/rule/alert that was executed. Unique, not exposed to the customer. ,
Required: False ,
}
string ,
displayName:
{
Description: The health check DisplayName localized of the individual test executed. ,
Required: False ,
}
string ,
tags:
{
Description: Key-value pairs that allow grouping/filtering individual tests. ,
Required: False ,
}
{
key:
{
Description: Key that allow grouping/filtering individual tests. ,
Required: False ,
}
string ,
value:
{
Description: Value of the key that allow grouping/filtering individual tests. ,
Required: False ,
}
string ,
}
,
healthCheckTags:
{
Description: Key-value pairs that allow grouping/filtering individual tests. ,
Required: False ,
}
object ,
title:
{
Description: User-facing name; one or more sentences indicating the direct issue. ,
Required: False ,
}
string ,
status:
{
Description: Represents the current status of the check being performed. Indicates whether the check has completed successfully, failed, or is still in progress. ,
Enum:
{
Succeeded: The check completed successfully. ,
Failed: The check completed but failed. ,
InProgress: The check is currently in progress. ,
}
,
Required: False ,
}
enum ,
severity:
{
Description: Indicates the importance or impact level of the result. Determines whether the result is informational, a warning, or a critical issue that may block updates. ,
Enum:
{
Critical: A critical issue that blocks updates and requires immediate attention. ,
Warning: A warning that may indicate a potential issue but does not block updates. ,
Informational: General information that does not indicate any issue. ,
Hidden: The result is hidden and not shown in the output. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Detailed overview of the issue and what impact the issue has on the stamp. ,
Required: False ,
}
string ,
remediation:
{
Description: Set of steps that can be taken to resolve the issue found. ,
Required: False ,
}
string ,
targetResourceID:
{
Description: The unique identifier for the affected resource (such as a node or drive). ,
Required: False ,
}
string ,
targetResourceName:
{
Description: The name of the affected resource. ,
Required: False ,
}
string ,
targetResourceType:
{
Description: The type of resource being referred to (well-known set of nouns in infrastructure, aligning with Monitoring). ,
Required: False ,
}
string ,
timestamp:
{
Description: The time in which the HealthCheck was called. ,
Format: date-time ,
Required: False ,
}
string ,
additionalData:
{
Description: Property bag of key value pairs for additional information. ,
Required: False ,
}
string ,
healthCheckSource:
{
Description: The name of the services called for the HealthCheck (I.E. Test-AzureStack, Test-Cluster). ,
Required: False ,
}
string ,
}
,
]
,
healthCheckDate:
{
Description: Last time the package-specific checks were run. ,
Format: date-time ,
Required: False ,
}
string ,
packagePath:
{
Description: Path where the update package is available. ,
Required: False ,
}
string ,
packageSizeInMb:
{
Description: Size of the package. This value is a combination of the size from update metadata and size of the payload that results from the live scan operation for OS update content. ,
Required: False ,
}
number ,
displayName:
{
Description: Display name of the Update ,
Required: False ,
}
string ,
version:
{
Description: Version of the update. ,
Required: False ,
}
string ,
publisher:
{
Description: Publisher of the update package. ,
Required: False ,
}
string ,
releaseLink:
{
Description: Link to release notes for the update. ,
Required: False ,
}
string ,
availabilityType:
{
Description: Indicates how the update content is made available for download. This determines whether the update is sourced locally, from an online repository, or requires user notification. ,
Enum:
{
Local: The update content is available locally within the environment. ,
Online: The update content is available from an online source. ,
Notify: The system will notify the user when update content becomes available. ,
}
,
Required: False ,
}
enum ,
packageType:
{
Description: Customer-visible type of the update. ,
Required: False ,
}
string ,
additionalProperties:
{
Description: Extensible KV pairs serialized as a string. This is currently used to report the stamp OEM family and hardware model information when an update is flagged as Invalid for the stamp based on OEM type. ,
Required: False ,
}
string ,
updateStateProperties:
{
Description: Additional information regarding the state of the update. See definition of UpdateStateProperties type below for more details on this property. ,
Required: False ,
}
{
progressPercentage:
{
Description: Progress percentage of ongoing operation. Currently this property is only valid when the update is in the Downloading state, where it maps to how much of the update content has been downloaded. ,
Required: False ,
}
number ,
notifyMessage:
{
Description: Brief message with instructions for updates of AvailabilityType Notify. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
properties:
{
Description: Update properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Updates proxy resource. Indicates the current lifecycle status of the update operation, such as whether it has been accepted, is in progress, or has completed. ,
Enum:
{
Succeeded: The update operation completed successfully. ,
Failed: The update operation failed. ,
Canceled: The update operation was canceled before completion. ,
Accepted: The update operation has been accepted and is pending execution. ,
Provisioning: The update operation is currently being provisioned. ,
}
,
Required: False ,
}
enum ,
installedDate:
{
Description: Date that the update was installed. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Description of the update. ,
Required: False ,
}
string ,
minSbeVersionRequired:
{
Description: Minimum Sbe Version of the update. ,
Required: False ,
}
string ,
state:
{
Description: Represents the current state of the update as it relates to this stamp. This includes phases such as preparation, installation, scanning, and error handling, providing insight into the update's progress and any issues encountered. ,
Enum:
{
HasPrerequisite: The update has prerequisites that must be fulfilled before it can proceed. ,
Obsolete: The update is obsolete and no longer applicable. ,
Ready: The update is ready to be installed. ,
NotApplicableBecauseAnotherUpdateIsInProgress: The update cannot be applied because another update is currently in progress. ,
Preparing: The update is currently in the preparation phase. ,
Installing: The update is currently being installed. ,
Installed: The update has been successfully installed. ,
PreparationFailed: The update preparation phase failed. ,
InstallationFailed: The update installation failed. ,
Invalid: The update is invalid and cannot be applied. ,
Recalled: The update has been recalled and should not be applied. ,
Downloading: The update is currently being downloaded. ,
DownloadFailed: The update download failed. ,
HealthChecking: A health check is being performed before applying the update. ,
HealthCheckFailed: The health check failed, preventing the update from proceeding. ,
ReadyToInstall: The update is ready to be installed after successful preparation and checks. ,
ScanInProgress: The system is scanning for updates. ,
ScanFailed: The scan for updates failed. ,
AdditionalContentRequired: Additional content is required to proceed with the update. ,
}
,
Required: False ,
}
enum ,
prerequisites:
{
Description: If update State is HasPrerequisite, this property contains an array of objects describing prerequisite updates before installing this update. Otherwise, it is empty. ,
Required: False ,
}
[
{
updateType:
{
Description: Updatable component type. ,
Required: False ,
}
string ,
version:
{
Description: Version of the prerequisite. ,
Required: False ,
}
string ,
packageName:
{
Description: Friendly name of the prerequisite. ,
Required: False ,
}
string ,
}
,
]
,
componentVersions:
{
Description: An array of component versions for a Solution Bundle update, and an empty array otherwise. ,
Required: False ,
}
[
{
packageType:
{
Description: Package type ,
Required: False ,
}
string ,
version:
{
Description: Package version ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Last time this component was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
rebootRequired:
{
Description: Indicates whether a reboot is required after the update or operation. Helps determine if a system restart is necessary to complete the process. ,
Required: False ,
}
object ,
healthState:
{
Description: Overall health state for update-specific health checks. ,
Required: False ,
}
object ,
healthCheckResult:
{
Description: An array of PrecheckResult objects. ,
Required: False ,
}
[
{
name:
{
Description: Name of the individual test/rule/alert that was executed. Unique, not exposed to the customer. ,
Required: False ,
}
string ,
displayName:
{
Description: The health check DisplayName localized of the individual test executed. ,
Required: False ,
}
string ,
tags:
{
Description: Key-value pairs that allow grouping/filtering individual tests. ,
Required: False ,
}
{
key:
{
Description: Key that allow grouping/filtering individual tests. ,
Required: False ,
}
string ,
value:
{
Description: Value of the key that allow grouping/filtering individual tests. ,
Required: False ,
}
string ,
}
,
healthCheckTags:
{
Description: Key-value pairs that allow grouping/filtering individual tests. ,
Required: False ,
}
object ,
title:
{
Description: User-facing name; one or more sentences indicating the direct issue. ,
Required: False ,
}
string ,
status:
{
Description: Represents the current status of the check being performed. Indicates whether the check has completed successfully, failed, or is still in progress. ,
Enum:
{
Succeeded: The check completed successfully. ,
Failed: The check completed but failed. ,
InProgress: The check is currently in progress. ,
}
,
Required: False ,
}
enum ,
severity:
{
Description: Indicates the importance or impact level of the result. Determines whether the result is informational, a warning, or a critical issue that may block updates. ,
Enum:
{
Critical: A critical issue that blocks updates and requires immediate attention. ,
Warning: A warning that may indicate a potential issue but does not block updates. ,
Informational: General information that does not indicate any issue. ,
Hidden: The result is hidden and not shown in the output. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Detailed overview of the issue and what impact the issue has on the stamp. ,
Required: False ,
}
string ,
remediation:
{
Description: Set of steps that can be taken to resolve the issue found. ,
Required: False ,
}
string ,
targetResourceID:
{
Description: The unique identifier for the affected resource (such as a node or drive). ,
Required: False ,
}
string ,
targetResourceName:
{
Description: The name of the affected resource. ,
Required: False ,
}
string ,
targetResourceType:
{
Description: The type of resource being referred to (well-known set of nouns in infrastructure, aligning with Monitoring). ,
Required: False ,
}
string ,
timestamp:
{
Description: The time in which the HealthCheck was called. ,
Format: date-time ,
Required: False ,
}
string ,
additionalData:
{
Description: Property bag of key value pairs for additional information. ,
Required: False ,
}
string ,
healthCheckSource:
{
Description: The name of the services called for the HealthCheck (I.E. Test-AzureStack, Test-Cluster). ,
Required: False ,
}
string ,
}
,
]
,
healthCheckDate:
{
Description: Last time the package-specific checks were run. ,
Format: date-time ,
Required: False ,
}
string ,
packagePath:
{
Description: Path where the update package is available. ,
Required: False ,
}
string ,
packageSizeInMb:
{
Description: Size of the package. This value is a combination of the size from update metadata and size of the payload that results from the live scan operation for OS update content. ,
Required: False ,
}
number ,
displayName:
{
Description: Display name of the Update ,
Required: False ,
}
string ,
version:
{
Description: Version of the update. ,
Required: False ,
}
string ,
publisher:
{
Description: Publisher of the update package. ,
Required: False ,
}
string ,
releaseLink:
{
Description: Link to release notes for the update. ,
Required: False ,
}
string ,
availabilityType:
{
Description: Indicates how the update content is made available for download. This determines whether the update is sourced locally, from an online repository, or requires user notification. ,
Enum:
{
Local: The update content is available locally within the environment. ,
Online: The update content is available from an online source. ,
Notify: The system will notify the user when update content becomes available. ,
}
,
Required: False ,
}
enum ,
packageType:
{
Description: Customer-visible type of the update. ,
Required: False ,
}
string ,
additionalProperties:
{
Description: Extensible KV pairs serialized as a string. This is currently used to report the stamp OEM family and hardware model information when an update is flagged as Invalid for the stamp based on OEM type. ,
Required: False ,
}
string ,
updateStateProperties:
{
Description: Additional information regarding the state of the update. See definition of UpdateStateProperties type below for more details on this property. ,
Required: False ,
}
{
progressPercentage:
{
Description: Progress percentage of ongoing operation. Currently this property is only valid when the update is in the Downloading state, where it maps to how much of the update content has been downloaded. ,
Required: False ,
}
number ,
notifyMessage:
{
Description: Brief message with instructions for updates of AvailabilityType Notify. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Updates_Delete (new)
Description :  Delete specified Update
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/updates/{updateName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
updateName:
{
Description: The name of the Update ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URL to query for status of the operation. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Updates_Post (new)
Description :  Apply Update
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/updates/{updateName}/apply
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
updateName:
{
Description: The name of the Update ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URL to query for status of the operation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
UpdateRuns_List (new)
Description :  List all Update runs for a specified update
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/updates/{updateName}/updateRuns
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
updateName:
{
Description: The name of the Update ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Update runs ,
Required: False ,
}
[
{
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
properties:
{
Description: Describes Update Run Properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the UpdateRuns proxy resource. Indicates the current lifecycle status of the update operation, such as whether it has been accepted, is in progress, or has completed. ,
Enum:
{
Succeeded: The update operation completed successfully. ,
Failed: The update operation failed. ,
Canceled: The update operation was canceled before completion. ,
Accepted: The update operation has been accepted and is pending execution. ,
Provisioning: The update operation is currently being provisioned. ,
}
,
Required: False ,
}
enum ,
timeStarted:
{
Description: Timestamp of the update run was started. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTime:
{
Description: Timestamp of the most recently completed step in the update run. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: Duration of the update run. ,
Required: False ,
}
string ,
state:
{
Description: Represents the current state of the update run. Indicates whether the update is in progress, has completed successfully, failed, or is in an unknown state. ,
Enum:
{
Unknown: The state of the update run is not known. ,
Succeeded: The update run completed successfully. ,
InProgress: The update run is currently in progress. ,
Failed: The update run failed to complete successfully. ,
}
,
Required: False ,
}
enum ,
progress:
{
Description: Progress representation of the update run steps. ,
Required: False ,
}
{
name:
{
Description: Name of the step. ,
Required: False ,
}
string ,
description:
{
Description: More detailed description of the step. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message, specified if the step is in a failed state. ,
Required: False ,
}
string ,
status:
{
Description: Status of the step, bubbled up from the ECE action plan for installation attempts. Values are: 'Success', 'Error', 'InProgress', and 'Unknown status'. ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: When the step started, or empty if it has not started executing. ,
Format: date-time ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: When the step reached a terminal state. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTimeUtc:
{
Description: Completion time of this step or the last completed sub-step. ,
Format: date-time ,
Required: False ,
}
string ,
expectedExecutionTime:
{
Description: Expected execution time of a given step. This is optionally authored in the update action plan and can be empty. ,
Required: False ,
}
string ,
steps:
{
Description: Recursive model for child steps of this step. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
UpdateRuns_Get (new)
Description :  Get the Update run for a specified update
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/updates/{updateName}/updateRuns/{updateRunName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
updateName:
{
Description: The name of the Update ,
Required: True ,
}
string ,
updateRunName:
{
Description: The name of the Update Run ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
properties:
{
Description: Describes Update Run Properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the UpdateRuns proxy resource. Indicates the current lifecycle status of the update operation, such as whether it has been accepted, is in progress, or has completed. ,
Enum:
{
Succeeded: The update operation completed successfully. ,
Failed: The update operation failed. ,
Canceled: The update operation was canceled before completion. ,
Accepted: The update operation has been accepted and is pending execution. ,
Provisioning: The update operation is currently being provisioned. ,
}
,
Required: False ,
}
enum ,
timeStarted:
{
Description: Timestamp of the update run was started. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTime:
{
Description: Timestamp of the most recently completed step in the update run. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: Duration of the update run. ,
Required: False ,
}
string ,
state:
{
Description: Represents the current state of the update run. Indicates whether the update is in progress, has completed successfully, failed, or is in an unknown state. ,
Enum:
{
Unknown: The state of the update run is not known. ,
Succeeded: The update run completed successfully. ,
InProgress: The update run is currently in progress. ,
Failed: The update run failed to complete successfully. ,
}
,
Required: False ,
}
enum ,
progress:
{
Description: Progress representation of the update run steps. ,
Required: False ,
}
{
name:
{
Description: Name of the step. ,
Required: False ,
}
string ,
description:
{
Description: More detailed description of the step. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message, specified if the step is in a failed state. ,
Required: False ,
}
string ,
status:
{
Description: Status of the step, bubbled up from the ECE action plan for installation attempts. Values are: 'Success', 'Error', 'InProgress', and 'Unknown status'. ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: When the step started, or empty if it has not started executing. ,
Format: date-time ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: When the step reached a terminal state. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTimeUtc:
{
Description: Completion time of this step or the last completed sub-step. ,
Format: date-time ,
Required: False ,
}
string ,
expectedExecutionTime:
{
Description: Expected execution time of a given step. This is optionally authored in the update action plan and can be empty. ,
Required: False ,
}
string ,
steps:
{
Description: Recursive model for child steps of this step. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
UpdateRuns_Put (new)
Description :  Put Update runs for a specified update
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/updates/{updateName}/updateRuns/{updateRunName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
updateName:
{
Description: The name of the Update ,
Required: True ,
}
string ,
updateRunName:
{
Description: The name of the Update Run ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
updateRunsProperties:
{
Description: Properties of the updateRuns object ,
Required: True ,
}
{
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
properties:
{
Description: Describes Update Run Properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the UpdateRuns proxy resource. Indicates the current lifecycle status of the update operation, such as whether it has been accepted, is in progress, or has completed. ,
Enum:
{
Succeeded: The update operation completed successfully. ,
Failed: The update operation failed. ,
Canceled: The update operation was canceled before completion. ,
Accepted: The update operation has been accepted and is pending execution. ,
Provisioning: The update operation is currently being provisioned. ,
}
,
Required: False ,
}
enum ,
timeStarted:
{
Description: Timestamp of the update run was started. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTime:
{
Description: Timestamp of the most recently completed step in the update run. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: Duration of the update run. ,
Required: False ,
}
string ,
state:
{
Description: Represents the current state of the update run. Indicates whether the update is in progress, has completed successfully, failed, or is in an unknown state. ,
Enum:
{
Unknown: The state of the update run is not known. ,
Succeeded: The update run completed successfully. ,
InProgress: The update run is currently in progress. ,
Failed: The update run failed to complete successfully. ,
}
,
Required: False ,
}
enum ,
progress:
{
Description: Progress representation of the update run steps. ,
Required: False ,
}
{
name:
{
Description: Name of the step. ,
Required: False ,
}
string ,
description:
{
Description: More detailed description of the step. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message, specified if the step is in a failed state. ,
Required: False ,
}
string ,
status:
{
Description: Status of the step, bubbled up from the ECE action plan for installation attempts. Values are: 'Success', 'Error', 'InProgress', and 'Unknown status'. ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: When the step started, or empty if it has not started executing. ,
Format: date-time ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: When the step reached a terminal state. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTimeUtc:
{
Description: Completion time of this step or the last completed sub-step. ,
Format: date-time ,
Required: False ,
}
string ,
expectedExecutionTime:
{
Description: Expected execution time of a given step. This is optionally authored in the update action plan and can be empty. ,
Required: False ,
}
string ,
steps:
{
Description: Recursive model for child steps of this step. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
properties:
{
Description: Describes Update Run Properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the UpdateRuns proxy resource. Indicates the current lifecycle status of the update operation, such as whether it has been accepted, is in progress, or has completed. ,
Enum:
{
Succeeded: The update operation completed successfully. ,
Failed: The update operation failed. ,
Canceled: The update operation was canceled before completion. ,
Accepted: The update operation has been accepted and is pending execution. ,
Provisioning: The update operation is currently being provisioned. ,
}
,
Required: False ,
}
enum ,
timeStarted:
{
Description: Timestamp of the update run was started. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTime:
{
Description: Timestamp of the most recently completed step in the update run. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: Duration of the update run. ,
Required: False ,
}
string ,
state:
{
Description: Represents the current state of the update run. Indicates whether the update is in progress, has completed successfully, failed, or is in an unknown state. ,
Enum:
{
Unknown: The state of the update run is not known. ,
Succeeded: The update run completed successfully. ,
InProgress: The update run is currently in progress. ,
Failed: The update run failed to complete successfully. ,
}
,
Required: False ,
}
enum ,
progress:
{
Description: Progress representation of the update run steps. ,
Required: False ,
}
{
name:
{
Description: Name of the step. ,
Required: False ,
}
string ,
description:
{
Description: More detailed description of the step. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message, specified if the step is in a failed state. ,
Required: False ,
}
string ,
status:
{
Description: Status of the step, bubbled up from the ECE action plan for installation attempts. Values are: 'Success', 'Error', 'InProgress', and 'Unknown status'. ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: When the step started, or empty if it has not started executing. ,
Format: date-time ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: When the step reached a terminal state. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTimeUtc:
{
Description: Completion time of this step or the last completed sub-step. ,
Format: date-time ,
Required: False ,
}
string ,
expectedExecutionTime:
{
Description: Expected execution time of a given step. This is optionally authored in the update action plan and can be empty. ,
Required: False ,
}
string ,
steps:
{
Description: Recursive model for child steps of this step. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
UpdateRuns_Delete (new)
Description :  Delete specified Update Run
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/updates/{updateName}/updateRuns/{updateRunName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
updateName:
{
Description: The name of the Update ,
Required: True ,
}
string ,
updateRunName:
{
Description: The name of the Update Run ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URL to query for status of the operation. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_UploadCertificate (new)
Description :  Upload certificate.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/uploadCertificate
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
uploadCertificateRequest:
{
Description: Upload certificate request. ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
certificates:
{
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EdgeMachines_ListBySubscription (updated)
Description :  List all edge machines in a subscription.
Reference :  Link ¶

⚶ Changes

{
  "#id": "EdgeMachines_ListBySubscription",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "#name": "provisioningState",
                "Enum": {
                  "new": [
                    [
                      "NotSpecified",
                      "The provisioning state is not specified."
                    ],
                    [
                      "Error",
                      "An error occurred during provisioning."
                    ],
                    [
                      "Succeeded",
                      "Provisioning completed successfully."
                    ],
                    [
                      "Failed",
                      "Provisioning failed."
                    ],
                    [
                      "Canceled",
                      "Provisioning was canceled."
                    ],
                    [
                      "Connected",
                      "The resource is connected."
                    ],
                    [
                      "Disconnected",
                      "The resource is disconnected."
                    ],
                    [
                      "Deleted",
                      "The resource has been deleted."
                    ],
                    [
                      "Creating",
                      "The resource is being created."
                    ],
                    [
                      "Updating",
                      "The resource is being updated."
                    ],
                    [
                      "Deleting",
                      "The resource is being deleted."
                    ],
                    [
                      "Moving",
                      "The resource is being moved."
                    ],
                    [
                      "PartiallySucceeded",
                      "Provisioning partially succeeded."
                    ],
                    [
                      "PartiallyConnected",
                      "The resource is partially connected."
                    ],
                    [
                      "InProgress",
                      "Provisioning is in progress."
                    ],
                    [
                      "Accepted",
                      "Provisioning request has been accepted."
                    ],
                    [
                      "Provisioning",
                      "The resource is currently provisioning."
                    ],
                    [
                      "DisableInProgress",
                      "The resource is being disabled."
                    ]
                  ],
                  "old": [
                    [
                      "NotSpecified",
                      "The resource provision state is not specified"
                    ],
                    [
                      "Succeeded",
                      "Resource has been created."
                    ],
                    [
                      "Failed",
                      "Resource creation failed."
                    ],
                    [
                      "Canceled",
                      "Resource creation was canceled."
                    ],
                    [
                      "InProgress",
                      "Resource creation is in progress."
                    ],
                    [
                      "Provisioning",
                      "The resource is being provisioned"
                    ],
                    [
                      "Updating",
                      "The resource is updating"
                    ],
                    [
                      "Deleting",
                      "The resource is being deleted"
                    ],
                    [
                      "Accepted",
                      "The resource create request has been accepted"
                    ]
                  ]
                }
              },
              {
                "siteDetails": [
                  {
                    "deviceConfiguration": [
                      {
                        "@added_8f30dd907f1d460ea7d77a28ea007eff": {
                          "#name": "nicDetails",
                          "Description": "NIC Details of device",
                          "Required": false,
                          "Type": "array",
                          "$items": {
                            "Description": "The NIC Detail of a device.",
                            "Type": "object",
                            "$properties": [
                              {
                                "#name": "adapterName",
                                "Description": "Adapter Name of NIC",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "interfaceDescription",
                                "Description": "Interface Description of NIC",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "componentId",
                                "Description": "Component Id of NIC",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "driverVersion",
                                "Description": "Driver Version of NIC",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "ip4Address",
                                "Description": "Subnet Mask of NIC",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "subnetMask",
                                "Description": "Subnet Mask of NIC",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "defaultGateway",
                                "Description": "Default Gateway of NIC",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "dnsServers",
                                "Description": "DNS Servers for NIC",
                                "Required": false,
                                "Type": "array",
                                "$items": {
                                  "Type": "string"
                                }
                              },
                              {
                                "#name": "defaultIsolationId",
                                "Description": "Default Isolation of Management NIC",
                                "Required": false,
                                "Type": "string"
                              }
                            ]
                          }
                        }
                      },
                      {
                        "@added_039056c0c16246e0acc15439ec13ccc2": {
                          "#name": "deviceMetadata",
                          "Description": "Device metadata details.",
                          "Required": false,
                          "Type": "string"
                        }
                      },
                      {
                        "@removed_8c673dd14dae4fe58dd0092a3af0bcde": {
                          "#name": "network",
                          "Description": "Network configuration.",
                          "Required": false,
                          "Type": "object",
                          "$properties": [
                            {
                              "#name": "networkAdapters",
                              "Description": "List of network adapters.",
                              "Required": false,
                              "Type": "array",
                              "$items": {
                                "Description": "Network adapter configuration.",
                                "Type": "object",
                                "$properties": [
                                  {
                                    "#name": "ipAssignmentType",
                                    "Description": "Type of IP assignment.",
                                    "Enum": [
                                      [
                                        "Automatic",
                                        "Automatic IP assignment"
                                      ],
                                      [
                                        "Manual",
                                        "Manual IP assignment"
                                      ]
                                    ],
                                    "Required": true,
                                    "Type": "string"
                                  },
                                  {
                                    "#name": "ipAddress",
                                    "Description": "IP address.",
                                    "Required": false,
                                    "Type": "string"
                                  },
                                  {
                                    "#name": "adapterName",
                                    "Description": "Adapter Name.",
                                    "Required": false,
                                    "Type": "string"
                                  },
                                  {
                                    "#name": "macAddress",
                                    "Description": "MAC address.",
                                    "Required": false,
                                    "Type": "string"
                                  },
                                  {
                                    "#name": "ipAddressRange",
                                    "Description": "IP address range.",
                                    "Required": false,
                                    "Type": "object",
                                    "$properties": [
                                      {
                                        "#name": "startIp",
                                        "Description": "Start IP address.",
                                        "Required": true,
                                        "Type": "string"
                                      },
                                      {
                                        "#name": "endIp",
                                        "Description": "End IP address.",
                                        "Required": true,
                                        "Type": "string"
                                      }
                                    ]
                                  },
                                  {
                                    "#name": "gateway",
                                    "Description": "Gateway id.",
                                    "Required": false,
                                    "Type": "string"
                                  },
                                  {
                                    "#name": "subnetMask",
                                    "Description": "Subnet mask.",
                                    "Required": false,
                                    "Type": "string"
                                  },
                                  {
                                    "#name": "dnsAddressArray",
                                    "Description": "Array of DNS addresses.",
                                    "Required": false,
                                    "Type": "array",
                                    "$items": {
                                      "Type": "string"
                                    }
                                  },
                                  {
                                    "#name": "vlanId",
                                    "Description": "VLAN ID for the network setup.",
                                    "Required": false,
                                    "Type": "string"
                                  }
                                ]
                              }
                            }
                          ]
                        }
                      },
                      {
                        "@removed_6ed890083c6b4eb5bcc3b6ff3ec64518": {
                          "#name": "hostName",
                          "Description": "Hostname of the device.",
                          "Required": false,
                          "Type": "string"
                        }
                      },
                      {
                        "@removed_c85aae285b454649b92d446a5d2b519d": {
                          "#name": "webProxy",
                          "Description": "Web proxy configuration.",
                          "Required": false,
                          "Type": "object",
                          "$properties": [
                            {
                              "#name": "connectionUri",
                              "Description": "Connection URI of the web proxy.",
                              "Format": "uri",
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "port",
                              "Description": "Port of the web proxy.",
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "bypassList",
                              "Description": "Bypass list for the web proxy.",
                              "Required": false,
                              "Type": "array",
                              "$items": {
                                "Format": "uri",
                                "Type": "string"
                              }
                            }
                          ]
                        }
                      },
                      {
                        "@removed_e26f1d8819ba4b9ebb37b71365150e63": {
                          "#name": "time",
                          "Description": "Time configuration.",
                          "Required": false,
                          "Type": "object",
                          "$properties": [
                            {
                              "#name": "primaryTimeServer",
                              "Description": "Primary NTP server.",
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "secondaryTimeServer",
                              "Description": "Secondary NTP server.",
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "timeZone",
                              "Description": "Time zone.",
                              "Required": false,
                              "Type": "string"
                            }
                          ]
                        }
                      },
                      {
                        "@removed_7b3d09522205484c95ef60df4750c15c": {
                          "#name": "storage",
                          "Description": "Storage configuration.",
                          "Required": false,
                          "Type": "object",
                          "$properties": [
                            {
                              "#name": "partitionSize",
                              "Description": "Partition size.",
                              "Required": false,
                              "Type": "string"
                            }
                          ]
                        }
                      }
                    ]
                  }
                ]
              },
              {
                "reportedProperties": [
                  {
                    "networkProfile": [
                      {
                        "nicDetails": {
                          "$properties": [
                            {
                              "#name": "rdmaCapability",
                              "Enum": {
                                "new": [
                                  [
                                    "Enabled",
                                    "Network Adapter on the device is RDMA Capable"
                                  ],
                                  [
                                    "Disabled",
                                    "Network Adapter on the device is RDMA Capable"
                                  ]
                                ],
                                "old": [
                                  [
                                    "Enabled",
                                    "Network Adapter on the device is RDMA Capable"
                                  ],
                                  [
                                    "Disabled",
                                    "Network Adapter on the device isn't RDMA Capable"
                                  ]
                                ]
                              }
                            }
                          ]
                        }
                      },
                      {
                        "switchDetails": {
                          "Description": {
                            "new": "List of switch details for edge device.",
                            "old": "Switch Details of edge machine."
                          }
                        }
                      }
                    ]
                  },
                  {
                    "extensionProfile": [
                      {
                        "extensions": {
                          "$properties": [
                            {
                              "#name": "state",
                              "Enum": {
                                "new": [
                                  [
                                    "NotSpecified",
                                    "Arc extension state is not specified."
                                  ],
                                  [
                                    "Succeeded",
                                    "Arc extension state is Succeeded."
                                  ],
                                  [
                                    "Failed",
                                    "Arc extension state is Failed."
                                  ],
                                  [
                                    "Canceled",
                                    "Arc extension state is Canceled."
                                  ],
                                  [
                                    "Accepted",
                                    "Arc extension state is Accepted when extension installation triggered."
                                  ],
                                  [
                                    "Creating",
                                    "Arc extension is in Creating State."
                                  ],
                                  [
                                    "Updating",
                                    "Arc extension is in Updating State."
                                  ],
                                  [
                                    "Moving",
                                    "Arc extension is in Moving State."
                                  ],
                                  [
                                    "Deleting",
                                    "Arc extension is in Deleting State."
                                  ],
                                  [
                                    "Deleted",
                                    "Arc extension is in Deleted State."
                                  ]
                                ],
                                "old": [
                                  [
                                    "NotSpecified",
                                    "Arc extension state is not specified."
                                  ],
                                  [
                                    "Accepted",
                                    "Arc extension state is Accepted when extension installation triggered."
                                  ],
                                  [
                                    "Canceled",
                                    "Arc extension state is Canceled."
                                  ],
                                  [
                                    "Creating",
                                    "Arc extension is in Creating State."
                                  ],
                                  [
                                    "Deleted",
                                    "Arc extension is in Deleted State."
                                  ],
                                  [
                                    "Deleting",
                                    "Arc extension is in Deleting State."
                                  ],
                                  [
                                    "Failed",
                                    "Arc extension state is Failed."
                                  ],
                                  [
                                    "Moving",
                                    "Arc extension is in Moving State."
                                  ],
                                  [
                                    "Succeeded",
                                    "Arc extension state is Succeeded."
                                  ],
                                  [
                                    "Updating",
                                    "Arc extension is in Updating State."
                                  ]
                                ]
                              }
                            },
                            {
                              "#name": "managedBy",
                              "Description": {
                                "new": "Indicates whether the extension is managed by the user or by Azure.",
                                "old": "Extension managed by user or Azure."
                              },
                              "Enum": {
                                "new": [
                                  [
                                    "User",
                                    "The extension is managed by the user."
                                  ],
                                  [
                                    "Azure",
                                    "The extension is managed by Azure."
                                  ]
                                ],
                                "old": [
                                  [
                                    "User",
                                    "Extension managed by user."
                                  ],
                                  [
                                    "Azure",
                                    "Extension managed by Azure."
                                  ]
                                ]
                              }
                            },
                            {
                              "@removed_9ef04d415ca64721a3595663019ff0ea": {
                                "#name": "exception",
                                "Description": "Exception details while installing Arc extension.",
                                "Required": false,
                                "Type": "string"
                              }
                            }
                          ]
                        }
                      }
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AzureStackHCI/edgeMachines
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The EdgeMachine items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
edgeMachineKind:
{
Description: Edge Machine type. ,
Enum:
{
Standard: EdgeMachine resource created using Zero-touch provisioning. ,
Dedicated: EdgeMachine resource created for brownfield HCI customers without zero touch provisioning. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of a resource. ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
cloudId:
{
Description: Unique, immutable resource id. ,
Required: False ,
}
string ,
arcMachineResourceGroupId:
{
Description: Optional property to create arc machine in custom resource group. ,
Format: arm-id ,
Required: False ,
}
string ,
arcMachineResourceId:
{
Description: Arc machine instance resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
arcGatewayResourceId:
{
Description: Link to Arc Gateway ARM resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
siteDetails:
{
Description: Service fetches common configuration from site. ,
Required: False ,
}
{
siteResourceId:
{
Description: Site resource Id to be set during Edge Machine resource creation. ,
Format: arm-id ,
Required: True ,
}
string ,
deviceConfiguration:
{
Description: Edge Device configuration received from site common configuration. ,
Required: False ,
}
{
nicDetails:
{
Description: NIC Details of device ,
Required: False ,
}
[
{
adapterName:
{
Description: Adapter Name of NIC ,
Required: False ,
}
string ,
interfaceDescription:
{
Description: Interface Description of NIC ,
Required: False ,
}
string ,
componentId:
{
Description: Component Id of NIC ,
Required: False ,
}
string ,
driverVersion:
{
Description: Driver Version of NIC ,
Required: False ,
}
string ,
ip4Address:
{
Description: Subnet Mask of NIC ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet Mask of NIC ,
Required: False ,
}
string ,
defaultGateway:
{
Description: Default Gateway of NIC ,
Required: False ,
}
string ,
dnsServers:
{
Description: DNS Servers for NIC ,
Required: False ,
}
[
string ,
]
,
defaultIsolationId:
{
Description: Default Isolation of Management NIC ,
Required: False ,
}
string ,
}
,
]
,
deviceMetadata:
{
Description: Device metadata details. ,
Required: False ,
}
string ,
}
,
}
,
ownershipVoucherDetails:
{
Description: Ownership voucher details for provisioned machine. ,
Required: False ,
}
{
ownershipVoucher:
{
Description: Ownership voucher in base64 encoded format ,
Format: password ,
Required: True ,
}
string ,
ownerKeyType:
{
Description: Owner key type ,
Enum:
{
MicrosoftManaged: Owner is Microsoft managed key ,
}
,
Required: True ,
}
enum ,
}
,
provisioningDetails:
{
Description: Details for device provisioning. ,
Required: False ,
}
{
osProfile:
{
Description: Operating system profile. ,
Required: True ,
}
{
osName:
{
Description: Name of the operating system. ,
Required: False ,
}
string ,
osType:
{
Description: Type of the operating system. ,
Required: False ,
}
string ,
osVersion:
{
Description: Version of the operating system. ,
Required: False ,
}
string ,
osImageLocation:
{
Description: Location of the operating system image. ,
Required: False ,
}
string ,
vsrVersion:
{
Description: Validated Solution Recipe version to be used for the job ,
Required: False ,
}
string ,
imageHash:
{
Description: Hash of the OS package downloaded ,
Required: False ,
}
string ,
gpgPubKey:
{
Description: GPG Public Key used for package verification ,
Required: False ,
}
string ,
operationType:
{
Description: Operation sub type of OS Provisioning ,
Enum:
{
Provision: OS Provisioning operation ,
Update: OS Update operation ,
ReImage: OS ReImage operation ,
}
,
Required: False ,
}
enum ,
}
,
userDetails:
{
Description: User configuration. ,
Required: False ,
}
[
{
userName:
{
Description: Name of the user. ,
Required: True ,
}
string ,
secretType:
{
Description: Type of the secret used for authentication. ,
Enum:
{
KeyVault: Key Vault based authentication ,
SshPubKey: SSH Public Key based authentication ,
}
,
Required: True ,
}
enum ,
secretLocation:
{
Description: Location of the secret used for authentication. ,
Required: False ,
}
string ,
sshPubKey:
{
Description: SSH Public Key for the user. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
devicePoolResourceId:
{
Description: A machine can only be assigned to single device pool ,
Required: False ,
}
string ,
machineState:
{
Description: OS configuration status details ,
Enum:
{
Created: Created when EdgeMachine resource created ,
Registering: EdgeMachine state during device discovery and registration ,
Unpurposed: EdgeMachine state when machine configured with restricted OS and not provisioned to deploy workloads ,
Transitioning: EdgeMachine state when transitioning from initial OS to target OS ,
Purposed: EdgeMachine state when machine configured with target OS to deploy workloads ,
Updating: EdgeMachine state when OS updates are in-progress ,
Resetting: EdgeMachine state when transitioning from target OS to restricted OS ,
Failed: EdgeMachine failed state and only option to recover is to re-provisioning machine ,
Preparing: Preparing EdgeMachine ,
}
,
Required: False ,
}
enum ,
connectivityStatus:
{
Description: machine connectivity status ,
Enum:
{
NotSpecified: The connectivity status of the machine resource is not specified. ,
Disconnected: The machine resource is disconnected. ,
Connected: The machine resource is connected. ,
}
,
Required: False ,
}
enum ,
claimedBy:
{
Description: Tracks the ID of the consuming resource, setting the machine as in-use. ,
Required: False ,
}
string ,
reportedProperties:
{
Description: Reported properties for edge machine. ,
Required: False ,
}
{
lastUpdated:
{
Description: Last time data reported. ,
Format: date-time ,
Required: False ,
}
string ,
networkProfile:
{
Description: Network details for edge machine. ,
Required: False ,
}
{
nicDetails:
{
Description: List of Network Interface Card (NIC) Details of edge machine. ,
Required: False ,
}
[
{
adapterName:
{
Description: Adapter Name of NIC ,
Required: False ,
}
string ,
interfaceDescription:
{
Description: Interface Description of NIC ,
Required: False ,
}
string ,
componentId:
{
Description: Component Id of NIC ,
Required: False ,
}
string ,
driverVersion:
{
Description: Driver Version of NIC ,
Required: False ,
}
string ,
ip4Address:
{
Description: Subnet Mask of NIC ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet Mask of NIC ,
Required: False ,
}
string ,
defaultGateway:
{
Description: Default Gateway of NIC ,
Required: False ,
}
string ,
dnsServers:
{
Description: DNS Servers for NIC ,
Required: False ,
}
[
string ,
]
,
defaultIsolationId:
{
Description: Default Isolation of Management NIC ,
Required: False ,
}
string ,
macAddress:
{
Description: MAC address information of NIC. ,
Required: False ,
}
string ,
slot:
{
Description: The slot attached to the NIC. ,
Required: False ,
}
string ,
switchName:
{
Description: The switch attached to the NIC, if any. ,
Required: False ,
}
string ,
nicType:
{
Description: The type of NIC, physical, virtual, management. ,
Required: False ,
}
string ,
vlanId:
{
Description: The VLAN ID of the physical NIC. ,
Required: False ,
}
string ,
nicStatus:
{
Description: The status of NIC, up, disconnected. ,
Required: False ,
}
string ,
rdmaCapability:
{
Description: Describes the RDMA capability of the network adapter. ,
Enum:
{
Enabled: Network Adapter on the device is RDMA Capable ,
Disabled: Network Adapter on the device is RDMA Capable ,
}
,
Required: False ,
}
enum ,
}
,
]
,
switchDetails:
{
Description: List of switch Details of edge machine. ,
Required: False ,
}
[
{
switchName:
{
Description: The name of the switch. ,
Required: False ,
}
string ,
switchType:
{
Description: The type of the switch. e.g. external, internal. ,
Required: False ,
}
string ,
extensions:
{
Description: This represents extensions installed on virtualSwitch. ,
Required: False ,
}
[
{
switchId:
{
Description: Unique identifier for virtualSwitch. ,
Required: False ,
}
string ,
extensionName:
{
Description: This will show extension name for virtualSwitch. ,
Required: False ,
}
string ,
extensionEnabled:
{
Description: This represents whether extension is enabled on virtualSwitch. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
}
,
osProfile:
{
Description: OS Properties for edge machine. ,
Required: False ,
}
{
bootType:
{
Description: The boot type of the device. e.g. UEFI, Legacy etc ,
Required: False ,
}
string ,
assemblyVersion:
{
Description: Version of assembly present on device ,
Required: False ,
}
string ,
osType:
{
Description: OS type (“windows", “linux”) ,
Required: False ,
}
string ,
osSku:
{
Description: OS SKU (e.g., “ Microsoft Azure Linux ROE“, “Azure Stack HCI", "Microsoft Azure Linux 3.0") ,
Required: False ,
}
string ,
osVersion:
{
Description: OS Version ,
Required: False ,
}
string ,
buildNumber:
{
Description: OS Build Number ,
Required: False ,
}
string ,
baseImageVersion:
{
Description: OS Base Image Version ,
Required: False ,
}
string ,
imageVersion:
{
Description: OS Image Version ,
Required: False ,
}
string ,
}
,
hardwareProfile:
{
Description: Hardware related information for edge machine. ,
Required: False ,
}
{
cpuCores:
{
Description: Number of cpu cores in the machine ,
Format: int64 ,
Required: False ,
}
integer ,
cpuSockets:
{
Description: Number of cpu sockets in the machine ,
Format: int64 ,
Required: False ,
}
integer ,
memoryCapacityInGb:
{
Description: Memory capacity of the machine ,
Format: int64 ,
Required: False ,
}
integer ,
model:
{
Description: Model info of the machine ,
Required: False ,
}
string ,
manufacturer:
{
Description: manufacturer info of the machine ,
Required: False ,
}
string ,
serialNumber:
{
Description: Serial number of the machine ,
Required: False ,
}
string ,
processorType:
{
Description: Process type of the machine ,
Required: False ,
}
string ,
}
,
storageProfile:
{
Description: Storage related information for edge machine. ,
Required: False ,
}
{
poolableDisksCount:
{
Description: Number of storage disks in the device with $CanPool as true. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
sbeDeploymentPackageInfo:
{
Description: Solution builder extension (SBE) deployment package information. ,
Required: False ,
}
{
code:
{
Description: SBE deployment validation code. ,
Required: False ,
}
string ,
message:
{
Description: A detailed message that explains the SBE package validation result. ,
Required: False ,
}
string ,
sbeManifest:
{
Description: This represents discovered update results for matching updates and store it as SBE manifest. ,
Required: False ,
}
string ,
}
,
extensionProfile:
{
Description: Extension details for edge machine. ,
Required: False ,
}
{
extensions:
{
Description: List of Arc extensions installed on edge device. ,
Required: False ,
}
[
{
extensionName:
{
Description: Arc extension name installed on edge device. ,
Required: False ,
}
string ,
state:
{
Description: Arc extension state from arc machine extension. ,
Enum:
{
NotSpecified: Arc extension state is not specified. ,
Succeeded: Arc extension state is Succeeded. ,
Failed: Arc extension state is Failed. ,
Canceled: Arc extension state is Canceled. ,
Accepted: Arc extension state is Accepted when extension installation triggered. ,
Creating: Arc extension is in Creating State. ,
Updating: Arc extension is in Updating State. ,
Moving: Arc extension is in Moving State. ,
Deleting: Arc extension is in Deleting State. ,
Deleted: Arc extension is in Deleted State. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details while installing Arc extension. ,
Required: False ,
}
[
{
exception:
{
Description: Exception details while installing extension. ,
Required: False ,
}
string ,
}
,
]
,
extensionResourceId:
{
Description: Arc Extension Azure resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Extension version installed. ,
Required: False ,
}
string ,
managedBy:
{
Description: Indicates whether the extension is managed by the user or by Azure. ,
Enum:
{
User: The extension is managed by the user. ,
Azure: The extension is managed by Azure. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
operationDetails:
{
Description: operation status details for edge machine. ,
Required: False ,
}
[
{
name:
{
Description: operation name. ,
Required: False ,
}
string ,
id:
{
Description: operation id. ,
Required: False ,
}
string ,
type:
{
Description: operation type. ,
Required: False ,
}
string ,
resourceId:
{
Description: operation resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
description:
{
Description: operation description. ,
Required: False ,
}
string ,
status:
{
Description: operation status. ,
Required: False ,
}
string ,
error:
{
Description: error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
]
,
lastSyncTimestamp:
{
Description: Last time data updated to service. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EdgeMachines_ListByResourceGroup (updated)
Description :  List all edge machines in a resource group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "EdgeMachines_ListByResourceGroup",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "#name": "provisioningState",
                "Enum": {
                  "new": [
                    [
                      "NotSpecified",
                      "The provisioning state is not specified."
                    ],
                    [
                      "Error",
                      "An error occurred during provisioning."
                    ],
                    [
                      "Succeeded",
                      "Provisioning completed successfully."
                    ],
                    [
                      "Failed",
                      "Provisioning failed."
                    ],
                    [
                      "Canceled",
                      "Provisioning was canceled."
                    ],
                    [
                      "Connected",
                      "The resource is connected."
                    ],
                    [
                      "Disconnected",
                      "The resource is disconnected."
                    ],
                    [
                      "Deleted",
                      "The resource has been deleted."
                    ],
                    [
                      "Creating",
                      "The resource is being created."
                    ],
                    [
                      "Updating",
                      "The resource is being updated."
                    ],
                    [
                      "Deleting",
                      "The resource is being deleted."
                    ],
                    [
                      "Moving",
                      "The resource is being moved."
                    ],
                    [
                      "PartiallySucceeded",
                      "Provisioning partially succeeded."
                    ],
                    [
                      "PartiallyConnected",
                      "The resource is partially connected."
                    ],
                    [
                      "InProgress",
                      "Provisioning is in progress."
                    ],
                    [
                      "Accepted",
                      "Provisioning request has been accepted."
                    ],
                    [
                      "Provisioning",
                      "The resource is currently provisioning."
                    ],
                    [
                      "DisableInProgress",
                      "The resource is being disabled."
                    ]
                  ],
                  "old": [
                    [
                      "NotSpecified",
                      "The resource provision state is not specified"
                    ],
                    [
                      "Succeeded",
                      "Resource has been created."
                    ],
                    [
                      "Failed",
                      "Resource creation failed."
                    ],
                    [
                      "Canceled",
                      "Resource creation was canceled."
                    ],
                    [
                      "InProgress",
                      "Resource creation is in progress."
                    ],
                    [
                      "Provisioning",
                      "The resource is being provisioned"
                    ],
                    [
                      "Updating",
                      "The resource is updating"
                    ],
                    [
                      "Deleting",
                      "The resource is being deleted"
                    ],
                    [
                      "Accepted",
                      "The resource create request has been accepted"
                    ]
                  ]
                }
              },
              {
                "siteDetails": [
                  {
                    "deviceConfiguration": [
                      {
                        "@added_b0fbcc2d16b8420a8a461669b0ea879b": {
                          "#name": "nicDetails",
                          "Description": "NIC Details of device",
                          "Required": false,
                          "Type": "array",
                          "$items": {
                            "Description": "The NIC Detail of a device.",
                            "Type": "object",
                            "$properties": [
                              {
                                "#name": "adapterName",
                                "Description": "Adapter Name of NIC",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "interfaceDescription",
                                "Description": "Interface Description of NIC",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "componentId",
                                "Description": "Component Id of NIC",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "driverVersion",
                                "Description": "Driver Version of NIC",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "ip4Address",
                                "Description": "Subnet Mask of NIC",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "subnetMask",
                                "Description": "Subnet Mask of NIC",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "defaultGateway",
                                "Description": "Default Gateway of NIC",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "dnsServers",
                                "Description": "DNS Servers for NIC",
                                "Required": false,
                                "Type": "array",
                                "$items": {
                                  "Type": "string"
                                }
                              },
                              {
                                "#name": "defaultIsolationId",
                                "Description": "Default Isolation of Management NIC",
                                "Required": false,
                                "Type": "string"
                              }
                            ]
                          }
                        }
                      },
                      {
                        "@added_435756c385b94d338eb590a1ce42a613": {
                          "#name": "deviceMetadata",
                          "Description": "Device metadata details.",
                          "Required": false,
                          "Type": "string"
                        }
                      },
                      {
                        "@removed_f261bf3c824b40c5831f4a39ed53ba42": {
                          "#name": "network",
                          "Description": "Network configuration.",
                          "Required": false,
                          "Type": "object",
                          "$properties": [
                            {
                              "#name": "networkAdapters",
                              "Description": "List of network adapters.",
                              "Required": false,
                              "Type": "array",
                              "$items": {
                                "Description": "Network adapter configuration.",
                                "Type": "object",
                                "$properties": [
                                  {
                                    "#name": "ipAssignmentType",
                                    "Description": "Type of IP assignment.",
                                    "Enum": [
                                      [
                                        "Automatic",
                                        "Automatic IP assignment"
                                      ],
                                      [
                                        "Manual",
                                        "Manual IP assignment"
                                      ]
                                    ],
                                    "Required": true,
                                    "Type": "string"
                                  },
                                  {
                                    "#name": "ipAddress",
                                    "Description": "IP address.",
                                    "Required": false,
                                    "Type": "string"
                                  },
                                  {
                                    "#name": "adapterName",
                                    "Description": "Adapter Name.",
                                    "Required": false,
                                    "Type": "string"
                                  },
                                  {
                                    "#name": "macAddress",
                                    "Description": "MAC address.",
                                    "Required": false,
                                    "Type": "string"
                                  },
                                  {
                                    "#name": "ipAddressRange",
                                    "Description": "IP address range.",
                                    "Required": false,
                                    "Type": "object",
                                    "$properties": [
                                      {
                                        "#name": "startIp",
                                        "Description": "Start IP address.",
                                        "Required": true,
                                        "Type": "string"
                                      },
                                      {
                                        "#name": "endIp",
                                        "Description": "End IP address.",
                                        "Required": true,
                                        "Type": "string"
                                      }
                                    ]
                                  },
                                  {
                                    "#name": "gateway",
                                    "Description": "Gateway id.",
                                    "Required": false,
                                    "Type": "string"
                                  },
                                  {
                                    "#name": "subnetMask",
                                    "Description": "Subnet mask.",
                                    "Required": false,
                                    "Type": "string"
                                  },
                                  {
                                    "#name": "dnsAddressArray",
                                    "Description": "Array of DNS addresses.",
                                    "Required": false,
                                    "Type": "array",
                                    "$items": {
                                      "Type": "string"
                                    }
                                  },
                                  {
                                    "#name": "vlanId",
                                    "Description": "VLAN ID for the network setup.",
                                    "Required": false,
                                    "Type": "string"
                                  }
                                ]
                              }
                            }
                          ]
                        }
                      },
                      {
                        "@removed_3f654c87ba6c4b4dac90de08d7ed2064": {
                          "#name": "hostName",
                          "Description": "Hostname of the device.",
                          "Required": false,
                          "Type": "string"
                        }
                      },
                      {
                        "@removed_de9d983e9e09447b8b445ea455d43e1d": {
                          "#name": "webProxy",
                          "Description": "Web proxy configuration.",
                          "Required": false,
                          "Type": "object",
                          "$properties": [
                            {
                              "#name": "connectionUri",
                              "Description": "Connection URI of the web proxy.",
                              "Format": "uri",
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "port",
                              "Description": "Port of the web proxy.",
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "bypassList",
                              "Description": "Bypass list for the web proxy.",
                              "Required": false,
                              "Type": "array",
                              "$items": {
                                "Format": "uri",
                                "Type": "string"
                              }
                            }
                          ]
                        }
                      },
                      {
                        "@removed_bcfdfd3e3c3642c4ba6d92b9fc712608": {
                          "#name": "time",
                          "Description": "Time configuration.",
                          "Required": false,
                          "Type": "object",
                          "$properties": [
                            {
                              "#name": "primaryTimeServer",
                              "Description": "Primary NTP server.",
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "secondaryTimeServer",
                              "Description": "Secondary NTP server.",
                              "Required": false,
                              "Type": "string"
                            },
                            {
                              "#name": "timeZone",
                              "Description": "Time zone.",
                              "Required": false,
                              "Type": "string"
                            }
                          ]
                        }
                      },
                      {
                        "@removed_a36ae1f45f154ba09c163f2e0f92f964": {
                          "#name": "storage",
                          "Description": "Storage configuration.",
                          "Required": false,
                          "Type": "object",
                          "$properties": [
                            {
                              "#name": "partitionSize",
                              "Description": "Partition size.",
                              "Required": false,
                              "Type": "string"
                            }
                          ]
                        }
                      }
                    ]
                  }
                ]
              },
              {
                "reportedProperties": [
                  {
                    "networkProfile": [
                      {
                        "nicDetails": {
                          "$properties": [
                            {
                              "#name": "rdmaCapability",
                              "Enum": {
                                "new": [
                                  [
                                    "Enabled",
                                    "Network Adapter on the device is RDMA Capable"
                                  ],
                                  [
                                    "Disabled",
                                    "Network Adapter on the device is RDMA Capable"
                                  ]
                                ],
                                "old": [
                                  [
                                    "Enabled",
                                    "Network Adapter on the device is RDMA Capable"
                                  ],
                                  [
                                    "Disabled",
                                    "Network Adapter on the device isn't RDMA Capable"
                                  ]
                                ]
                              }
                            }
                          ]
                        }
                      },
                      {
                        "switchDetails": {
                          "Description": {
                            "new": "List of switch details for edge device.",
                            "old": "Switch Details of edge machine."
                          }
                        }
                      }
                    ]
                  },
                  {
                    "extensionProfile": [
                      {
                        "extensions": {
                          "$properties": [
                            {
                              "#name": "state",
                              "Enum": {
                                "new": [
                                  [
                                    "NotSpecified",
                                    "Arc extension state is not specified."
                                  ],
                                  [
                                    "Succeeded",
                                    "Arc extension state is Succeeded."
                                  ],
                                  [
                                    "Failed",
                                    "Arc extension state is Failed."
                                  ],
                                  [
                                    "Canceled",
                                    "Arc extension state is Canceled."
                                  ],
                                  [
                                    "Accepted",
                                    "Arc extension state is Accepted when extension installation triggered."
                                  ],
                                  [
                                    "Creating",
                                    "Arc extension is in Creating State."
                                  ],
                                  [
                                    "Updating",
                                    "Arc extension is in Updating State."
                                  ],
                                  [
                                    "Moving",
                                    "Arc extension is in Moving State."
                                  ],
                                  [
                                    "Deleting",
                                    "Arc extension is in Deleting State."
                                  ],
                                  [
                                    "Deleted",
                                    "Arc extension is in Deleted State."
                                  ]
                                ],
                                "old": [
                                  [
                                    "NotSpecified",
                                    "Arc extension state is not specified."
                                  ],
                                  [
                                    "Accepted",
                                    "Arc extension state is Accepted when extension installation triggered."
                                  ],
                                  [
                                    "Canceled",
                                    "Arc extension state is Canceled."
                                  ],
                                  [
                                    "Creating",
                                    "Arc extension is in Creating State."
                                  ],
                                  [
                                    "Deleted",
                                    "Arc extension is in Deleted State."
                                  ],
                                  [
                                    "Deleting",
                                    "Arc extension is in Deleting State."
                                  ],
                                  [
                                    "Failed",
                                    "Arc extension state is Failed."
                                  ],
                                  [
                                    "Moving",
                                    "Arc extension is in Moving State."
                                  ],
                                  [
                                    "Succeeded",
                                    "Arc extension state is Succeeded."
                                  ],
                                  [
                                    "Updating",
                                    "Arc extension is in Updating State."
                                  ]
                                ]
                              }
                            },
                            {
                              "#name": "managedBy",
                              "Description": {
                                "new": "Indicates whether the extension is managed by the user or by Azure.",
                                "old": "Extension managed by user or Azure."
                              },
                              "Enum": {
                                "new": [
                                  [
                                    "User",
                                    "The extension is managed by the user."
                                  ],
                                  [
                                    "Azure",
                                    "The extension is managed by Azure."
                                  ]
                                ],
                                "old": [
                                  [
                                    "User",
                                    "Extension managed by user."
                                  ],
                                  [
                                    "Azure",
                                    "Extension managed by Azure."
                                  ]
                                ]
                              }
                            },
                            {
                              "@removed_df1a90cd2cda440b91a1e28dd83e34de": {
                                "#name": "exception",
                                "Description": "Exception details while installing Arc extension.",
                                "Required": false,
                                "Type": "string"
                              }
                            }
                          ]
                        }
                      }
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/edgeMachines
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The EdgeMachine items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
edgeMachineKind:
{
Description: Edge Machine type. ,
Enum:
{
Standard: EdgeMachine resource created using Zero-touch provisioning. ,
Dedicated: EdgeMachine resource created for brownfield HCI customers without zero touch provisioning. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of a resource. ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
cloudId:
{
Description: Unique, immutable resource id. ,
Required: False ,
}
string ,
arcMachineResourceGroupId:
{
Description: Optional property to create arc machine in custom resource group. ,
Format: arm-id ,
Required: False ,
}
string ,
arcMachineResourceId:
{
Description: Arc machine instance resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
arcGatewayResourceId:
{
Description: Link to Arc Gateway ARM resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
siteDetails:
{
Description: Service fetches common configuration from site. ,
Required: False ,
}
{
siteResourceId:
{
Description: Site resource Id to be set during Edge Machine resource creation. ,
Format: arm-id ,
Required: True ,
}
string ,
deviceConfiguration:
{
Description: Edge Device configuration received from site common configuration. ,
Required: False ,
}
{
nicDetails:
{
Description: NIC Details of device ,
Required: False ,
}
[
{
adapterName:
{
Description: Adapter Name of NIC ,
Required: False ,
}
string ,
interfaceDescription:
{
Description: Interface Description of NIC ,
Required: False ,
}
string ,
componentId:
{
Description: Component Id of NIC ,
Required: False ,
}
string ,
driverVersion:
{
Description: Driver Version of NIC ,
Required: False ,
}
string ,
ip4Address:
{
Description: Subnet Mask of NIC ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet Mask of NIC ,
Required: False ,
}
string ,
defaultGateway:
{
Description: Default Gateway of NIC ,
Required: False ,
}
string ,
dnsServers:
{
Description: DNS Servers for NIC ,
Required: False ,
}
[
string ,
]
,
defaultIsolationId:
{
Description: Default Isolation of Management NIC ,
Required: False ,
}
string ,
}
,
]
,
deviceMetadata:
{
Description: Device metadata details. ,
Required: False ,
}
string ,
}
,
}
,
ownershipVoucherDetails:
{
Description: Ownership voucher details for provisioned machine. ,
Required: False ,
}
{
ownershipVoucher:
{
Description: Ownership voucher in base64 encoded format ,
Format: password ,
Required: True ,
}
string ,
ownerKeyType:
{
Description: Owner key type ,
Enum:
{
MicrosoftManaged: Owner is Microsoft managed key ,
}
,
Required: True ,
}
enum ,
}
,
provisioningDetails:
{
Description: Details for device provisioning. ,
Required: False ,
}
{
osProfile:
{
Description: Operating system profile. ,
Required: True ,
}
{
osName:
{
Description: Name of the operating system. ,
Required: False ,
}
string ,
osType:
{
Description: Type of the operating system. ,
Required: False ,
}
string ,
osVersion:
{
Description: Version of the operating system. ,
Required: False ,
}
string ,
osImageLocation:
{
Description: Location of the operating system image. ,
Required: False ,
}
string ,
vsrVersion:
{
Description: Validated Solution Recipe version to be used for the job ,
Required: False ,
}
string ,
imageHash:
{
Description: Hash of the OS package downloaded ,
Required: False ,
}
string ,
gpgPubKey:
{
Description: GPG Public Key used for package verification ,
Required: False ,
}
string ,
operationType:
{
Description: Operation sub type of OS Provisioning ,
Enum:
{
Provision: OS Provisioning operation ,
Update: OS Update operation ,
ReImage: OS ReImage operation ,
}
,
Required: False ,
}
enum ,
}
,
userDetails:
{
Description: User configuration. ,
Required: False ,
}
[
{
userName:
{
Description: Name of the user. ,
Required: True ,
}
string ,
secretType:
{
Description: Type of the secret used for authentication. ,
Enum:
{
KeyVault: Key Vault based authentication ,
SshPubKey: SSH Public Key based authentication ,
}
,
Required: True ,
}
enum ,
secretLocation:
{
Description: Location of the secret used for authentication. ,
Required: False ,
}
string ,
sshPubKey:
{
Description: SSH Public Key for the user. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
devicePoolResourceId:
{
Description: A machine can only be assigned to single device pool ,
Required: False ,
}
string ,
machineState:
{
Description: OS configuration status details ,
Enum:
{
Created: Created when EdgeMachine resource created ,
Registering: EdgeMachine state during device discovery and registration ,
Unpurposed: EdgeMachine state when machine configured with restricted OS and not provisioned to deploy workloads ,
Transitioning: EdgeMachine state when transitioning from initial OS to target OS ,
Purposed: EdgeMachine state when machine configured with target OS to deploy workloads ,
Updating: EdgeMachine state when OS updates are in-progress ,
Resetting: EdgeMachine state when transitioning from target OS to restricted OS ,
Failed: EdgeMachine failed state and only option to recover is to re-provisioning machine ,
Preparing: Preparing EdgeMachine ,
}
,
Required: False ,
}
enum ,
connectivityStatus:
{
Description: machine connectivity status ,
Enum:
{
NotSpecified: The connectivity status of the machine resource is not specified. ,
Disconnected: The machine resource is disconnected. ,
Connected: The machine resource is connected. ,
}
,
Required: False ,
}
enum ,
claimedBy:
{
Description: Tracks the ID of the consuming resource, setting the machine as in-use. ,
Required: False ,
}
string ,
reportedProperties:
{
Description: Reported properties for edge machine. ,
Required: False ,
}
{
lastUpdated:
{
Description: Last time data reported. ,
Format: date-time ,
Required: False ,
}
string ,
networkProfile:
{
Description: Network details for edge machine. ,
Required: False ,
}
{
nicDetails:
{
Description: List of Network Interface Card (NIC) Details of edge machine. ,
Required: False ,
}
[
{
adapterName:
{
Description: Adapter Name of NIC ,
Required: False ,
}
string ,
interfaceDescription:
{
Description: Interface Description of NIC ,
Required: False ,
}
string ,
componentId:
{
Description: Component Id of NIC ,
Required: False ,
}
string ,
driverVersion:
{
Description: Driver Version of NIC ,
Required: False ,
}
string ,
ip4Address:
{
Description: Subnet Mask of NIC ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet Mask of NIC ,
Required: False ,
}
string ,
defaultGateway:
{
Description: Default Gateway of NIC ,
Required: False ,
}
string ,
dnsServers:
{
Description: DNS Servers for NIC ,
Required: False ,
}
[
string ,
]
,
defaultIsolationId:
{
Description: Default Isolation of Management NIC ,
Required: False ,
}
string ,
macAddress:
{
Description: MAC address information of NIC. ,
Required: False ,
}
string ,
slot:
{
Description: The slot attached to the NIC. ,
Required: False ,
}
string ,
switchName:
{
Description: The switch attached to the NIC, if any. ,
Required: False ,
}
string ,
nicType:
{
Description: The type of NIC, physical, virtual, management. ,
Required: False ,
}
string ,
vlanId:
{
Description: The VLAN ID of the physical NIC. ,
Required: False ,
}
string ,
nicStatus:
{
Description: The status of NIC, up, disconnected. ,
Required: False ,
}
string ,
rdmaCapability:
{
Description: Describes the RDMA capability of the network adapter. ,
Enum:
{
Enabled: Network Adapter on the device is RDMA Capable ,
Disabled: Network Adapter on the device is RDMA Capable ,
}
,
Required: False ,
}
enum ,
}
,
]
,
switchDetails:
{
Description: List of switch Details of edge machine. ,
Required: False ,
}
[
{
switchName:
{
Description: The name of the switch. ,
Required: False ,
}
string ,
switchType:
{
Description: The type of the switch. e.g. external, internal. ,
Required: False ,
}
string ,
extensions:
{
Description: This represents extensions installed on virtualSwitch. ,
Required: False ,
}
[
{
switchId:
{
Description: Unique identifier for virtualSwitch. ,
Required: False ,
}
string ,
extensionName:
{
Description: This will show extension name for virtualSwitch. ,
Required: False ,
}
string ,
extensionEnabled:
{
Description: This represents whether extension is enabled on virtualSwitch. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
}
,
osProfile:
{
Description: OS Properties for edge machine. ,
Required: False ,
}
{
bootType:
{
Description: The boot type of the device. e.g. UEFI, Legacy etc ,
Required: False ,
}
string ,
assemblyVersion:
{
Description: Version of assembly present on device ,
Required: False ,
}
string ,
osType:
{
Description: OS type (“windows", “linux”) ,
Required: False ,
}
string ,
osSku:
{
Description: OS SKU (e.g., “ Microsoft Azure Linux ROE“, “Azure Stack HCI", "Microsoft Azure Linux 3.0") ,
Required: False ,
}
string ,
osVersion:
{
Description: OS Version ,
Required: False ,
}
string ,
buildNumber:
{
Description: OS Build Number ,
Required: False ,
}
string ,
baseImageVersion:
{
Description: OS Base Image Version ,
Required: False ,
}
string ,
imageVersion:
{
Description: OS Image Version ,
Required: False ,
}
string ,
}
,
hardwareProfile:
{
Description: Hardware related information for edge machine. ,
Required: False ,
}
{
cpuCores:
{
Description: Number of cpu cores in the machine ,
Format: int64 ,
Required: False ,
}
integer ,
cpuSockets:
{
Description: Number of cpu sockets in the machine ,
Format: int64 ,
Required: False ,
}
integer ,
memoryCapacityInGb:
{
Description: Memory capacity of the machine ,
Format: int64 ,
Required: False ,
}
integer ,
model:
{
Description: Model info of the machine ,
Required: False ,
}
string ,
manufacturer:
{
Description: manufacturer info of the machine ,
Required: False ,
}
string ,
serialNumber:
{
Description: Serial number of the machine ,
Required: False ,
}
string ,
processorType:
{
Description: Process type of the machine ,
Required: False ,
}
string ,
}
,
storageProfile:
{
Description: Storage related information for edge machine. ,
Required: False ,
}
{
poolableDisksCount:
{
Description: Number of storage disks in the device with $CanPool as true. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
sbeDeploymentPackageInfo:
{
Description: Solution builder extension (SBE) deployment package information. ,
Required: False ,
}
{
code:
{
Description: SBE deployment validation code. ,
Required: False ,
}
string ,
message:
{
Description: A detailed message that explains the SBE package validation result. ,
Required: False ,
}
string ,
sbeManifest:
{
Description: This represents discovered update results for matching updates and store it as SBE manifest. ,
Required: False ,
}
string ,
}
,
extensionProfile:
{
Description: Extension details for edge machine. ,
Required: False ,
}
{
extensions:
{
Description: List of Arc extensions installed on edge device. ,
Required: False ,
}
[
{
extensionName:
{
Description: Arc extension name installed on edge device. ,
Required: False ,
}
string ,
state:
{
Description: Arc extension state from arc machine extension. ,
Enum:
{
NotSpecified: Arc extension state is not specified. ,
Succeeded: Arc extension state is Succeeded. ,
Failed: Arc extension state is Failed. ,
Canceled: Arc extension state is Canceled. ,
Accepted: Arc extension state is Accepted when extension installation triggered. ,
Creating: Arc extension is in Creating State. ,
Updating: Arc extension is in Updating State. ,
Moving: Arc extension is in Moving State. ,
Deleting: Arc extension is in Deleting State. ,
Deleted: Arc extension is in Deleted State. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details while installing Arc extension. ,
Required: False ,
}
[
{
exception:
{
Description: Exception details while installing extension. ,
Required: False ,
}
string ,
}
,
]
,
extensionResourceId:
{
Description: Arc Extension Azure resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Extension version installed. ,
Required: False ,
}
string ,
managedBy:
{
Description: Indicates whether the extension is managed by the user or by Azure. ,
Enum:
{
User: The extension is managed by the user. ,
Azure: The extension is managed by Azure. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
operationDetails:
{
Description: operation status details for edge machine. ,
Required: False ,
}
[
{
name:
{
Description: operation name. ,
Required: False ,
}
string ,
id:
{
Description: operation id. ,
Required: False ,
}
string ,
type:
{
Description: operation type. ,
Required: False ,
}
string ,
resourceId:
{
Description: operation resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
description:
{
Description: operation description. ,
Required: False ,
}
string ,
status:
{
Description: operation status. ,
Required: False ,
}
string ,
error:
{
Description: error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
]
,
lastSyncTimestamp:
{
Description: Last time data updated to service. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EdgeMachines_Get (updated)
Description :  Get an edge machine.
Reference :  Link ¶

⚶ Changes

{
  "#id": "EdgeMachines_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "NotSpecified",
                  "The provisioning state is not specified."
                ],
                [
                  "Error",
                  "An error occurred during provisioning."
                ],
                [
                  "Succeeded",
                  "Provisioning completed successfully."
                ],
                [
                  "Failed",
                  "Provisioning failed."
                ],
                [
                  "Canceled",
                  "Provisioning was canceled."
                ],
                [
                  "Connected",
                  "The resource is connected."
                ],
                [
                  "Disconnected",
                  "The resource is disconnected."
                ],
                [
                  "Deleted",
                  "The resource has been deleted."
                ],
                [
                  "Creating",
                  "The resource is being created."
                ],
                [
                  "Updating",
                  "The resource is being updated."
                ],
                [
                  "Deleting",
                  "The resource is being deleted."
                ],
                [
                  "Moving",
                  "The resource is being moved."
                ],
                [
                  "PartiallySucceeded",
                  "Provisioning partially succeeded."
                ],
                [
                  "PartiallyConnected",
                  "The resource is partially connected."
                ],
                [
                  "InProgress",
                  "Provisioning is in progress."
                ],
                [
                  "Accepted",
                  "Provisioning request has been accepted."
                ],
                [
                  "Provisioning",
                  "The resource is currently provisioning."
                ],
                [
                  "DisableInProgress",
                  "The resource is being disabled."
                ]
              ],
              "old": [
                [
                  "NotSpecified",
                  "The resource provision state is not specified"
                ],
                [
                  "Succeeded",
                  "Resource has been created."
                ],
                [
                  "Failed",
                  "Resource creation failed."
                ],
                [
                  "Canceled",
                  "Resource creation was canceled."
                ],
                [
                  "InProgress",
                  "Resource creation is in progress."
                ],
                [
                  "Provisioning",
                  "The resource is being provisioned"
                ],
                [
                  "Updating",
                  "The resource is updating"
                ],
                [
                  "Deleting",
                  "The resource is being deleted"
                ],
                [
                  "Accepted",
                  "The resource create request has been accepted"
                ]
              ]
            }
          },
          {
            "siteDetails": [
              {
                "deviceConfiguration": [
                  {
                    "@added_d8d91e9666664a3fba4140b0ee915e35": {
                      "#name": "nicDetails",
                      "Description": "NIC Details of device",
                      "Required": false,
                      "Type": "array",
                      "$items": {
                        "Description": "The NIC Detail of a device.",
                        "Type": "object",
                        "$properties": [
                          {
                            "#name": "adapterName",
                            "Description": "Adapter Name of NIC",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "interfaceDescription",
                            "Description": "Interface Description of NIC",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "componentId",
                            "Description": "Component Id of NIC",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "driverVersion",
                            "Description": "Driver Version of NIC",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "ip4Address",
                            "Description": "Subnet Mask of NIC",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "subnetMask",
                            "Description": "Subnet Mask of NIC",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "defaultGateway",
                            "Description": "Default Gateway of NIC",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "dnsServers",
                            "Description": "DNS Servers for NIC",
                            "Required": false,
                            "Type": "array",
                            "$items": {
                              "Type": "string"
                            }
                          },
                          {
                            "#name": "defaultIsolationId",
                            "Description": "Default Isolation of Management NIC",
                            "Required": false,
                            "Type": "string"
                          }
                        ]
                      }
                    }
                  },
                  {
                    "@added_5732dc2171ed453a865cbc0155550f5d": {
                      "#name": "deviceMetadata",
                      "Description": "Device metadata details.",
                      "Required": false,
                      "Type": "string"
                    }
                  },
                  {
                    "@removed_060dde7fb54448d9a42689ee68a4dbf1": {
                      "#name": "network",
                      "Description": "Network configuration.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "networkAdapters",
                          "Description": "List of network adapters.",
                          "Required": false,
                          "Type": "array",
                          "$items": {
                            "Description": "Network adapter configuration.",
                            "Type": "object",
                            "$properties": [
                              {
                                "#name": "ipAssignmentType",
                                "Description": "Type of IP assignment.",
                                "Enum": [
                                  [
                                    "Automatic",
                                    "Automatic IP assignment"
                                  ],
                                  [
                                    "Manual",
                                    "Manual IP assignment"
                                  ]
                                ],
                                "Required": true,
                                "Type": "string"
                              },
                              {
                                "#name": "ipAddress",
                                "Description": "IP address.",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "adapterName",
                                "Description": "Adapter Name.",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "macAddress",
                                "Description": "MAC address.",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "ipAddressRange",
                                "Description": "IP address range.",
                                "Required": false,
                                "Type": "object",
                                "$properties": [
                                  {
                                    "#name": "startIp",
                                    "Description": "Start IP address.",
                                    "Required": true,
                                    "Type": "string"
                                  },
                                  {
                                    "#name": "endIp",
                                    "Description": "End IP address.",
                                    "Required": true,
                                    "Type": "string"
                                  }
                                ]
                              },
                              {
                                "#name": "gateway",
                                "Description": "Gateway id.",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "subnetMask",
                                "Description": "Subnet mask.",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "dnsAddressArray",
                                "Description": "Array of DNS addresses.",
                                "Required": false,
                                "Type": "array",
                                "$items": {
                                  "Type": "string"
                                }
                              },
                              {
                                "#name": "vlanId",
                                "Description": "VLAN ID for the network setup.",
                                "Required": false,
                                "Type": "string"
                              }
                            ]
                          }
                        }
                      ]
                    }
                  },
                  {
                    "@removed_ecf601d961fe41479060685939a3c1af": {
                      "#name": "hostName",
                      "Description": "Hostname of the device.",
                      "Required": false,
                      "Type": "string"
                    }
                  },
                  {
                    "@removed_917035a054e246389d694d80cdb77448": {
                      "#name": "webProxy",
                      "Description": "Web proxy configuration.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "connectionUri",
                          "Description": "Connection URI of the web proxy.",
                          "Format": "uri",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "port",
                          "Description": "Port of the web proxy.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "bypassList",
                          "Description": "Bypass list for the web proxy.",
                          "Required": false,
                          "Type": "array",
                          "$items": {
                            "Format": "uri",
                            "Type": "string"
                          }
                        }
                      ]
                    }
                  },
                  {
                    "@removed_4f7ed7070a6d4b4aa45d0a92f477f154": {
                      "#name": "time",
                      "Description": "Time configuration.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "primaryTimeServer",
                          "Description": "Primary NTP server.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "secondaryTimeServer",
                          "Description": "Secondary NTP server.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "timeZone",
                          "Description": "Time zone.",
                          "Required": false,
                          "Type": "string"
                        }
                      ]
                    }
                  },
                  {
                    "@removed_301bb8c244ec4687add43b43104da8e5": {
                      "#name": "storage",
                      "Description": "Storage configuration.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "partitionSize",
                          "Description": "Partition size.",
                          "Required": false,
                          "Type": "string"
                        }
                      ]
                    }
                  }
                ]
              }
            ]
          },
          {
            "reportedProperties": [
              {
                "networkProfile": [
                  {
                    "nicDetails": {
                      "$properties": [
                        {
                          "#name": "rdmaCapability",
                          "Enum": {
                            "new": [
                              [
                                "Enabled",
                                "Network Adapter on the device is RDMA Capable"
                              ],
                              [
                                "Disabled",
                                "Network Adapter on the device is RDMA Capable"
                              ]
                            ],
                            "old": [
                              [
                                "Enabled",
                                "Network Adapter on the device is RDMA Capable"
                              ],
                              [
                                "Disabled",
                                "Network Adapter on the device isn't RDMA Capable"
                              ]
                            ]
                          }
                        }
                      ]
                    }
                  },
                  {
                    "switchDetails": {
                      "Description": {
                        "new": "List of switch details for edge device.",
                        "old": "Switch Details of edge machine."
                      }
                    }
                  }
                ]
              },
              {
                "extensionProfile": [
                  {
                    "extensions": {
                      "$properties": [
                        {
                          "#name": "state",
                          "Enum": {
                            "new": [
                              [
                                "NotSpecified",
                                "Arc extension state is not specified."
                              ],
                              [
                                "Succeeded",
                                "Arc extension state is Succeeded."
                              ],
                              [
                                "Failed",
                                "Arc extension state is Failed."
                              ],
                              [
                                "Canceled",
                                "Arc extension state is Canceled."
                              ],
                              [
                                "Accepted",
                                "Arc extension state is Accepted when extension installation triggered."
                              ],
                              [
                                "Creating",
                                "Arc extension is in Creating State."
                              ],
                              [
                                "Updating",
                                "Arc extension is in Updating State."
                              ],
                              [
                                "Moving",
                                "Arc extension is in Moving State."
                              ],
                              [
                                "Deleting",
                                "Arc extension is in Deleting State."
                              ],
                              [
                                "Deleted",
                                "Arc extension is in Deleted State."
                              ]
                            ],
                            "old": [
                              [
                                "NotSpecified",
                                "Arc extension state is not specified."
                              ],
                              [
                                "Accepted",
                                "Arc extension state is Accepted when extension installation triggered."
                              ],
                              [
                                "Canceled",
                                "Arc extension state is Canceled."
                              ],
                              [
                                "Creating",
                                "Arc extension is in Creating State."
                              ],
                              [
                                "Deleted",
                                "Arc extension is in Deleted State."
                              ],
                              [
                                "Deleting",
                                "Arc extension is in Deleting State."
                              ],
                              [
                                "Failed",
                                "Arc extension state is Failed."
                              ],
                              [
                                "Moving",
                                "Arc extension is in Moving State."
                              ],
                              [
                                "Succeeded",
                                "Arc extension state is Succeeded."
                              ],
                              [
                                "Updating",
                                "Arc extension is in Updating State."
                              ]
                            ]
                          }
                        },
                        {
                          "#name": "managedBy",
                          "Description": {
                            "new": "Indicates whether the extension is managed by the user or by Azure.",
                            "old": "Extension managed by user or Azure."
                          },
                          "Enum": {
                            "new": [
                              [
                                "User",
                                "The extension is managed by the user."
                              ],
                              [
                                "Azure",
                                "The extension is managed by Azure."
                              ]
                            ],
                            "old": [
                              [
                                "User",
                                "Extension managed by user."
                              ],
                              [
                                "Azure",
                                "Extension managed by Azure."
                              ]
                            ]
                          }
                        },
                        {
                          "@removed_f18f798a2c9f4e4dacca03cf6c4e8ce1": {
                            "#name": "exception",
                            "Description": "Exception details while installing Arc extension.",
                            "Required": false,
                            "Type": "string"
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/edgeMachines/{edgeMachineName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
edgeMachineName:
{
Description: Name of Device ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
edgeMachineKind:
{
Description: Edge Machine type. ,
Enum:
{
Standard: EdgeMachine resource created using Zero-touch provisioning. ,
Dedicated: EdgeMachine resource created for brownfield HCI customers without zero touch provisioning. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of a resource. ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
cloudId:
{
Description: Unique, immutable resource id. ,
Required: False ,
}
string ,
arcMachineResourceGroupId:
{
Description: Optional property to create arc machine in custom resource group. ,
Format: arm-id ,
Required: False ,
}
string ,
arcMachineResourceId:
{
Description: Arc machine instance resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
arcGatewayResourceId:
{
Description: Link to Arc Gateway ARM resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
siteDetails:
{
Description: Service fetches common configuration from site. ,
Required: False ,
}
{
siteResourceId:
{
Description: Site resource Id to be set during Edge Machine resource creation. ,
Format: arm-id ,
Required: True ,
}
string ,
deviceConfiguration:
{
Description: Edge Device configuration received from site common configuration. ,
Required: False ,
}
{
nicDetails:
{
Description: NIC Details of device ,
Required: False ,
}
[
{
adapterName:
{
Description: Adapter Name of NIC ,
Required: False ,
}
string ,
interfaceDescription:
{
Description: Interface Description of NIC ,
Required: False ,
}
string ,
componentId:
{
Description: Component Id of NIC ,
Required: False ,
}
string ,
driverVersion:
{
Description: Driver Version of NIC ,
Required: False ,
}
string ,
ip4Address:
{
Description: Subnet Mask of NIC ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet Mask of NIC ,
Required: False ,
}
string ,
defaultGateway:
{
Description: Default Gateway of NIC ,
Required: False ,
}
string ,
dnsServers:
{
Description: DNS Servers for NIC ,
Required: False ,
}
[
string ,
]
,
defaultIsolationId:
{
Description: Default Isolation of Management NIC ,
Required: False ,
}
string ,
}
,
]
,
deviceMetadata:
{
Description: Device metadata details. ,
Required: False ,
}
string ,
}
,
}
,
ownershipVoucherDetails:
{
Description: Ownership voucher details for provisioned machine. ,
Required: False ,
}
{
ownershipVoucher:
{
Description: Ownership voucher in base64 encoded format ,
Format: password ,
Required: True ,
}
string ,
ownerKeyType:
{
Description: Owner key type ,
Enum:
{
MicrosoftManaged: Owner is Microsoft managed key ,
}
,
Required: True ,
}
enum ,
}
,
provisioningDetails:
{
Description: Details for device provisioning. ,
Required: False ,
}
{
osProfile:
{
Description: Operating system profile. ,
Required: True ,
}
{
osName:
{
Description: Name of the operating system. ,
Required: False ,
}
string ,
osType:
{
Description: Type of the operating system. ,
Required: False ,
}
string ,
osVersion:
{
Description: Version of the operating system. ,
Required: False ,
}
string ,
osImageLocation:
{
Description: Location of the operating system image. ,
Required: False ,
}
string ,
vsrVersion:
{
Description: Validated Solution Recipe version to be used for the job ,
Required: False ,
}
string ,
imageHash:
{
Description: Hash of the OS package downloaded ,
Required: False ,
}
string ,
gpgPubKey:
{
Description: GPG Public Key used for package verification ,
Required: False ,
}
string ,
operationType:
{
Description: Operation sub type of OS Provisioning ,
Enum:
{
Provision: OS Provisioning operation ,
Update: OS Update operation ,
ReImage: OS ReImage operation ,
}
,
Required: False ,
}
enum ,
}
,
userDetails:
{
Description: User configuration. ,
Required: False ,
}
[
{
userName:
{
Description: Name of the user. ,
Required: True ,
}
string ,
secretType:
{
Description: Type of the secret used for authentication. ,
Enum:
{
KeyVault: Key Vault based authentication ,
SshPubKey: SSH Public Key based authentication ,
}
,
Required: True ,
}
enum ,
secretLocation:
{
Description: Location of the secret used for authentication. ,
Required: False ,
}
string ,
sshPubKey:
{
Description: SSH Public Key for the user. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
devicePoolResourceId:
{
Description: A machine can only be assigned to single device pool ,
Required: False ,
}
string ,
machineState:
{
Description: OS configuration status details ,
Enum:
{
Created: Created when EdgeMachine resource created ,
Registering: EdgeMachine state during device discovery and registration ,
Unpurposed: EdgeMachine state when machine configured with restricted OS and not provisioned to deploy workloads ,
Transitioning: EdgeMachine state when transitioning from initial OS to target OS ,
Purposed: EdgeMachine state when machine configured with target OS to deploy workloads ,
Updating: EdgeMachine state when OS updates are in-progress ,
Resetting: EdgeMachine state when transitioning from target OS to restricted OS ,
Failed: EdgeMachine failed state and only option to recover is to re-provisioning machine ,
Preparing: Preparing EdgeMachine ,
}
,
Required: False ,
}
enum ,
connectivityStatus:
{
Description: machine connectivity status ,
Enum:
{
NotSpecified: The connectivity status of the machine resource is not specified. ,
Disconnected: The machine resource is disconnected. ,
Connected: The machine resource is connected. ,
}
,
Required: False ,
}
enum ,
claimedBy:
{
Description: Tracks the ID of the consuming resource, setting the machine as in-use. ,
Required: False ,
}
string ,
reportedProperties:
{
Description: Reported properties for edge machine. ,
Required: False ,
}
{
lastUpdated:
{
Description: Last time data reported. ,
Format: date-time ,
Required: False ,
}
string ,
networkProfile:
{
Description: Network details for edge machine. ,
Required: False ,
}
{
nicDetails:
{
Description: List of Network Interface Card (NIC) Details of edge machine. ,
Required: False ,
}
[
{
adapterName:
{
Description: Adapter Name of NIC ,
Required: False ,
}
string ,
interfaceDescription:
{
Description: Interface Description of NIC ,
Required: False ,
}
string ,
componentId:
{
Description: Component Id of NIC ,
Required: False ,
}
string ,
driverVersion:
{
Description: Driver Version of NIC ,
Required: False ,
}
string ,
ip4Address:
{
Description: Subnet Mask of NIC ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet Mask of NIC ,
Required: False ,
}
string ,
defaultGateway:
{
Description: Default Gateway of NIC ,
Required: False ,
}
string ,
dnsServers:
{
Description: DNS Servers for NIC ,
Required: False ,
}
[
string ,
]
,
defaultIsolationId:
{
Description: Default Isolation of Management NIC ,
Required: False ,
}
string ,
macAddress:
{
Description: MAC address information of NIC. ,
Required: False ,
}
string ,
slot:
{
Description: The slot attached to the NIC. ,
Required: False ,
}
string ,
switchName:
{
Description: The switch attached to the NIC, if any. ,
Required: False ,
}
string ,
nicType:
{
Description: The type of NIC, physical, virtual, management. ,
Required: False ,
}
string ,
vlanId:
{
Description: The VLAN ID of the physical NIC. ,
Required: False ,
}
string ,
nicStatus:
{
Description: The status of NIC, up, disconnected. ,
Required: False ,
}
string ,
rdmaCapability:
{
Description: Describes the RDMA capability of the network adapter. ,
Enum:
{
Enabled: Network Adapter on the device is RDMA Capable ,
Disabled: Network Adapter on the device is RDMA Capable ,
}
,
Required: False ,
}
enum ,
}
,
]
,
switchDetails:
{
Description: List of switch Details of edge machine. ,
Required: False ,
}
[
{
switchName:
{
Description: The name of the switch. ,
Required: False ,
}
string ,
switchType:
{
Description: The type of the switch. e.g. external, internal. ,
Required: False ,
}
string ,
extensions:
{
Description: This represents extensions installed on virtualSwitch. ,
Required: False ,
}
[
{
switchId:
{
Description: Unique identifier for virtualSwitch. ,
Required: False ,
}
string ,
extensionName:
{
Description: This will show extension name for virtualSwitch. ,
Required: False ,
}
string ,
extensionEnabled:
{
Description: This represents whether extension is enabled on virtualSwitch. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
}
,
osProfile:
{
Description: OS Properties for edge machine. ,
Required: False ,
}
{
bootType:
{
Description: The boot type of the device. e.g. UEFI, Legacy etc ,
Required: False ,
}
string ,
assemblyVersion:
{
Description: Version of assembly present on device ,
Required: False ,
}
string ,
osType:
{
Description: OS type (“windows", “linux”) ,
Required: False ,
}
string ,
osSku:
{
Description: OS SKU (e.g., “ Microsoft Azure Linux ROE“, “Azure Stack HCI", "Microsoft Azure Linux 3.0") ,
Required: False ,
}
string ,
osVersion:
{
Description: OS Version ,
Required: False ,
}
string ,
buildNumber:
{
Description: OS Build Number ,
Required: False ,
}
string ,
baseImageVersion:
{
Description: OS Base Image Version ,
Required: False ,
}
string ,
imageVersion:
{
Description: OS Image Version ,
Required: False ,
}
string ,
}
,
hardwareProfile:
{
Description: Hardware related information for edge machine. ,
Required: False ,
}
{
cpuCores:
{
Description: Number of cpu cores in the machine ,
Format: int64 ,
Required: False ,
}
integer ,
cpuSockets:
{
Description: Number of cpu sockets in the machine ,
Format: int64 ,
Required: False ,
}
integer ,
memoryCapacityInGb:
{
Description: Memory capacity of the machine ,
Format: int64 ,
Required: False ,
}
integer ,
model:
{
Description: Model info of the machine ,
Required: False ,
}
string ,
manufacturer:
{
Description: manufacturer info of the machine ,
Required: False ,
}
string ,
serialNumber:
{
Description: Serial number of the machine ,
Required: False ,
}
string ,
processorType:
{
Description: Process type of the machine ,
Required: False ,
}
string ,
}
,
storageProfile:
{
Description: Storage related information for edge machine. ,
Required: False ,
}
{
poolableDisksCount:
{
Description: Number of storage disks in the device with $CanPool as true. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
sbeDeploymentPackageInfo:
{
Description: Solution builder extension (SBE) deployment package information. ,
Required: False ,
}
{
code:
{
Description: SBE deployment validation code. ,
Required: False ,
}
string ,
message:
{
Description: A detailed message that explains the SBE package validation result. ,
Required: False ,
}
string ,
sbeManifest:
{
Description: This represents discovered update results for matching updates and store it as SBE manifest. ,
Required: False ,
}
string ,
}
,
extensionProfile:
{
Description: Extension details for edge machine. ,
Required: False ,
}
{
extensions:
{
Description: List of Arc extensions installed on edge device. ,
Required: False ,
}
[
{
extensionName:
{
Description: Arc extension name installed on edge device. ,
Required: False ,
}
string ,
state:
{
Description: Arc extension state from arc machine extension. ,
Enum:
{
NotSpecified: Arc extension state is not specified. ,
Succeeded: Arc extension state is Succeeded. ,
Failed: Arc extension state is Failed. ,
Canceled: Arc extension state is Canceled. ,
Accepted: Arc extension state is Accepted when extension installation triggered. ,
Creating: Arc extension is in Creating State. ,
Updating: Arc extension is in Updating State. ,
Moving: Arc extension is in Moving State. ,
Deleting: Arc extension is in Deleting State. ,
Deleted: Arc extension is in Deleted State. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details while installing Arc extension. ,
Required: False ,
}
[
{
exception:
{
Description: Exception details while installing extension. ,
Required: False ,
}
string ,
}
,
]
,
extensionResourceId:
{
Description: Arc Extension Azure resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Extension version installed. ,
Required: False ,
}
string ,
managedBy:
{
Description: Indicates whether the extension is managed by the user or by Azure. ,
Enum:
{
User: The extension is managed by the user. ,
Azure: The extension is managed by Azure. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
operationDetails:
{
Description: operation status details for edge machine. ,
Required: False ,
}
[
{
name:
{
Description: operation name. ,
Required: False ,
}
string ,
id:
{
Description: operation id. ,
Required: False ,
}
string ,
type:
{
Description: operation type. ,
Required: False ,
}
string ,
resourceId:
{
Description: operation resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
description:
{
Description: operation description. ,
Required: False ,
}
string ,
status:
{
Description: operation status. ,
Required: False ,
}
string ,
error:
{
Description: error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
]
,
lastSyncTimestamp:
{
Description: Last time data updated to service. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EdgeMachines_CreateOrUpdate (updated)
Description :  Create or update an edge machine.
Reference :  Link ¶

⚶ Changes

{
  "#id": "EdgeMachines_CreateOrUpdate",
  "$parameters": {
    "resource": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "NotSpecified",
                  "The provisioning state is not specified."
                ],
                [
                  "Error",
                  "An error occurred during provisioning."
                ],
                [
                  "Succeeded",
                  "Provisioning completed successfully."
                ],
                [
                  "Failed",
                  "Provisioning failed."
                ],
                [
                  "Canceled",
                  "Provisioning was canceled."
                ],
                [
                  "Connected",
                  "The resource is connected."
                ],
                [
                  "Disconnected",
                  "The resource is disconnected."
                ],
                [
                  "Deleted",
                  "The resource has been deleted."
                ],
                [
                  "Creating",
                  "The resource is being created."
                ],
                [
                  "Updating",
                  "The resource is being updated."
                ],
                [
                  "Deleting",
                  "The resource is being deleted."
                ],
                [
                  "Moving",
                  "The resource is being moved."
                ],
                [
                  "PartiallySucceeded",
                  "Provisioning partially succeeded."
                ],
                [
                  "PartiallyConnected",
                  "The resource is partially connected."
                ],
                [
                  "InProgress",
                  "Provisioning is in progress."
                ],
                [
                  "Accepted",
                  "Provisioning request has been accepted."
                ],
                [
                  "Provisioning",
                  "The resource is currently provisioning."
                ],
                [
                  "DisableInProgress",
                  "The resource is being disabled."
                ]
              ],
              "old": [
                [
                  "NotSpecified",
                  "The resource provision state is not specified"
                ],
                [
                  "Succeeded",
                  "Resource has been created."
                ],
                [
                  "Failed",
                  "Resource creation failed."
                ],
                [
                  "Canceled",
                  "Resource creation was canceled."
                ],
                [
                  "InProgress",
                  "Resource creation is in progress."
                ],
                [
                  "Provisioning",
                  "The resource is being provisioned"
                ],
                [
                  "Updating",
                  "The resource is updating"
                ],
                [
                  "Deleting",
                  "The resource is being deleted"
                ],
                [
                  "Accepted",
                  "The resource create request has been accepted"
                ]
              ]
            }
          },
          {
            "siteDetails": [
              {
                "deviceConfiguration": [
                  {
                    "@added_5c800be60a614f7da08dd90aac8cc363": {
                      "#name": "nicDetails",
                      "Description": "NIC Details of device",
                      "Required": false,
                      "Type": "array",
                      "$items": {
                        "Description": "The NIC Detail of a device.",
                        "Type": "object",
                        "$properties": [
                          {
                            "#name": "adapterName",
                            "Description": "Adapter Name of NIC",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "interfaceDescription",
                            "Description": "Interface Description of NIC",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "componentId",
                            "Description": "Component Id of NIC",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "driverVersion",
                            "Description": "Driver Version of NIC",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "ip4Address",
                            "Description": "Subnet Mask of NIC",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "subnetMask",
                            "Description": "Subnet Mask of NIC",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "defaultGateway",
                            "Description": "Default Gateway of NIC",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "dnsServers",
                            "Description": "DNS Servers for NIC",
                            "Required": false,
                            "Type": "array",
                            "$items": {
                              "Type": "string"
                            }
                          },
                          {
                            "#name": "defaultIsolationId",
                            "Description": "Default Isolation of Management NIC",
                            "Required": false,
                            "Type": "string"
                          }
                        ]
                      }
                    }
                  },
                  {
                    "@added_be49053e49294257b9c36278b7dc25a2": {
                      "#name": "deviceMetadata",
                      "Description": "Device metadata details.",
                      "Required": false,
                      "Type": "string"
                    }
                  },
                  {
                    "@removed_d122c9d2723c403dbb62bcd000ba1077": {
                      "#name": "network",
                      "Description": "Network configuration.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "networkAdapters",
                          "Description": "List of network adapters.",
                          "Required": false,
                          "Type": "array",
                          "$items": {
                            "Description": "Network adapter configuration.",
                            "Type": "object",
                            "$properties": [
                              {
                                "#name": "ipAssignmentType",
                                "Description": "Type of IP assignment.",
                                "Enum": [
                                  [
                                    "Automatic",
                                    "Automatic IP assignment"
                                  ],
                                  [
                                    "Manual",
                                    "Manual IP assignment"
                                  ]
                                ],
                                "Required": true,
                                "Type": "string"
                              },
                              {
                                "#name": "ipAddress",
                                "Description": "IP address.",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "adapterName",
                                "Description": "Adapter Name.",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "macAddress",
                                "Description": "MAC address.",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "ipAddressRange",
                                "Description": "IP address range.",
                                "Required": false,
                                "Type": "object",
                                "$properties": [
                                  {
                                    "#name": "startIp",
                                    "Description": "Start IP address.",
                                    "Required": true,
                                    "Type": "string"
                                  },
                                  {
                                    "#name": "endIp",
                                    "Description": "End IP address.",
                                    "Required": true,
                                    "Type": "string"
                                  }
                                ]
                              },
                              {
                                "#name": "gateway",
                                "Description": "Gateway id.",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "subnetMask",
                                "Description": "Subnet mask.",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "dnsAddressArray",
                                "Description": "Array of DNS addresses.",
                                "Required": false,
                                "Type": "array",
                                "$items": {
                                  "Type": "string"
                                }
                              },
                              {
                                "#name": "vlanId",
                                "Description": "VLAN ID for the network setup.",
                                "Required": false,
                                "Type": "string"
                              }
                            ]
                          }
                        }
                      ]
                    }
                  },
                  {
                    "@removed_1296dcf934c64111b003aaa00b649442": {
                      "#name": "hostName",
                      "Description": "Hostname of the device.",
                      "Required": false,
                      "Type": "string"
                    }
                  },
                  {
                    "@removed_457435b9a4264fafafc09fdd520d0294": {
                      "#name": "webProxy",
                      "Description": "Web proxy configuration.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "connectionUri",
                          "Description": "Connection URI of the web proxy.",
                          "Format": "uri",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "port",
                          "Description": "Port of the web proxy.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "bypassList",
                          "Description": "Bypass list for the web proxy.",
                          "Required": false,
                          "Type": "array",
                          "$items": {
                            "Format": "uri",
                            "Type": "string"
                          }
                        }
                      ]
                    }
                  },
                  {
                    "@removed_378ef3551d7d47568fe10ccbc438f84f": {
                      "#name": "time",
                      "Description": "Time configuration.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "primaryTimeServer",
                          "Description": "Primary NTP server.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "secondaryTimeServer",
                          "Description": "Secondary NTP server.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "timeZone",
                          "Description": "Time zone.",
                          "Required": false,
                          "Type": "string"
                        }
                      ]
                    }
                  },
                  {
                    "@removed_ab539ca501024bd7ba63e55e666738c8": {
                      "#name": "storage",
                      "Description": "Storage configuration.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "partitionSize",
                          "Description": "Partition size.",
                          "Required": false,
                          "Type": "string"
                        }
                      ]
                    }
                  }
                ]
              }
            ]
          },
          {
            "reportedProperties": [
              {
                "networkProfile": [
                  {
                    "nicDetails": {
                      "$properties": [
                        {
                          "#name": "rdmaCapability",
                          "Enum": {
                            "new": [
                              [
                                "Enabled",
                                "Network Adapter on the device is RDMA Capable"
                              ],
                              [
                                "Disabled",
                                "Network Adapter on the device is RDMA Capable"
                              ]
                            ],
                            "old": [
                              [
                                "Enabled",
                                "Network Adapter on the device is RDMA Capable"
                              ],
                              [
                                "Disabled",
                                "Network Adapter on the device isn't RDMA Capable"
                              ]
                            ]
                          }
                        }
                      ]
                    }
                  },
                  {
                    "switchDetails": {
                      "Description": {
                        "new": "List of switch details for edge device.",
                        "old": "Switch Details of edge machine."
                      }
                    }
                  }
                ]
              },
              {
                "extensionProfile": [
                  {
                    "extensions": {
                      "$properties": [
                        {
                          "#name": "state",
                          "Enum": {
                            "new": [
                              [
                                "NotSpecified",
                                "Arc extension state is not specified."
                              ],
                              [
                                "Succeeded",
                                "Arc extension state is Succeeded."
                              ],
                              [
                                "Failed",
                                "Arc extension state is Failed."
                              ],
                              [
                                "Canceled",
                                "Arc extension state is Canceled."
                              ],
                              [
                                "Accepted",
                                "Arc extension state is Accepted when extension installation triggered."
                              ],
                              [
                                "Creating",
                                "Arc extension is in Creating State."
                              ],
                              [
                                "Updating",
                                "Arc extension is in Updating State."
                              ],
                              [
                                "Moving",
                                "Arc extension is in Moving State."
                              ],
                              [
                                "Deleting",
                                "Arc extension is in Deleting State."
                              ],
                              [
                                "Deleted",
                                "Arc extension is in Deleted State."
                              ]
                            ],
                            "old": [
                              [
                                "NotSpecified",
                                "Arc extension state is not specified."
                              ],
                              [
                                "Accepted",
                                "Arc extension state is Accepted when extension installation triggered."
                              ],
                              [
                                "Canceled",
                                "Arc extension state is Canceled."
                              ],
                              [
                                "Creating",
                                "Arc extension is in Creating State."
                              ],
                              [
                                "Deleted",
                                "Arc extension is in Deleted State."
                              ],
                              [
                                "Deleting",
                                "Arc extension is in Deleting State."
                              ],
                              [
                                "Failed",
                                "Arc extension state is Failed."
                              ],
                              [
                                "Moving",
                                "Arc extension is in Moving State."
                              ],
                              [
                                "Succeeded",
                                "Arc extension state is Succeeded."
                              ],
                              [
                                "Updating",
                                "Arc extension is in Updating State."
                              ]
                            ]
                          }
                        },
                        {
                          "#name": "managedBy",
                          "Description": {
                            "new": "Indicates whether the extension is managed by the user or by Azure.",
                            "old": "Extension managed by user or Azure."
                          },
                          "Enum": {
                            "new": [
                              [
                                "User",
                                "The extension is managed by the user."
                              ],
                              [
                                "Azure",
                                "The extension is managed by Azure."
                              ]
                            ],
                            "old": [
                              [
                                "User",
                                "Extension managed by user."
                              ],
                              [
                                "Azure",
                                "Extension managed by Azure."
                              ]
                            ]
                          }
                        },
                        {
                          "@removed_600d3dd385434f7fb5c7836ab1966216": {
                            "#name": "exception",
                            "Description": "Exception details while installing Arc extension.",
                            "Required": false,
                            "Type": "string"
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "NotSpecified",
                  "The provisioning state is not specified."
                ],
                [
                  "Error",
                  "An error occurred during provisioning."
                ],
                [
                  "Succeeded",
                  "Provisioning completed successfully."
                ],
                [
                  "Failed",
                  "Provisioning failed."
                ],
                [
                  "Canceled",
                  "Provisioning was canceled."
                ],
                [
                  "Connected",
                  "The resource is connected."
                ],
                [
                  "Disconnected",
                  "The resource is disconnected."
                ],
                [
                  "Deleted",
                  "The resource has been deleted."
                ],
                [
                  "Creating",
                  "The resource is being created."
                ],
                [
                  "Updating",
                  "The resource is being updated."
                ],
                [
                  "Deleting",
                  "The resource is being deleted."
                ],
                [
                  "Moving",
                  "The resource is being moved."
                ],
                [
                  "PartiallySucceeded",
                  "Provisioning partially succeeded."
                ],
                [
                  "PartiallyConnected",
                  "The resource is partially connected."
                ],
                [
                  "InProgress",
                  "Provisioning is in progress."
                ],
                [
                  "Accepted",
                  "Provisioning request has been accepted."
                ],
                [
                  "Provisioning",
                  "The resource is currently provisioning."
                ],
                [
                  "DisableInProgress",
                  "The resource is being disabled."
                ]
              ],
              "old": [
                [
                  "NotSpecified",
                  "The resource provision state is not specified"
                ],
                [
                  "Succeeded",
                  "Resource has been created."
                ],
                [
                  "Failed",
                  "Resource creation failed."
                ],
                [
                  "Canceled",
                  "Resource creation was canceled."
                ],
                [
                  "InProgress",
                  "Resource creation is in progress."
                ],
                [
                  "Provisioning",
                  "The resource is being provisioned"
                ],
                [
                  "Updating",
                  "The resource is updating"
                ],
                [
                  "Deleting",
                  "The resource is being deleted"
                ],
                [
                  "Accepted",
                  "The resource create request has been accepted"
                ]
              ]
            }
          },
          {
            "siteDetails": [
              {
                "deviceConfiguration": [
                  {
                    "@added_b0bf7ba6c1ca4b1ab6f32372dc4cd564": {
                      "#name": "nicDetails",
                      "Description": "NIC Details of device",
                      "Required": false,
                      "Type": "array",
                      "$items": {
                        "Description": "The NIC Detail of a device.",
                        "Type": "object",
                        "$properties": [
                          {
                            "#name": "adapterName",
                            "Description": "Adapter Name of NIC",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "interfaceDescription",
                            "Description": "Interface Description of NIC",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "componentId",
                            "Description": "Component Id of NIC",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "driverVersion",
                            "Description": "Driver Version of NIC",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "ip4Address",
                            "Description": "Subnet Mask of NIC",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "subnetMask",
                            "Description": "Subnet Mask of NIC",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "defaultGateway",
                            "Description": "Default Gateway of NIC",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "dnsServers",
                            "Description": "DNS Servers for NIC",
                            "Required": false,
                            "Type": "array",
                            "$items": {
                              "Type": "string"
                            }
                          },
                          {
                            "#name": "defaultIsolationId",
                            "Description": "Default Isolation of Management NIC",
                            "Required": false,
                            "Type": "string"
                          }
                        ]
                      }
                    }
                  },
                  {
                    "@added_f4bbb2bb0e3d43318e4293a093d8c245": {
                      "#name": "deviceMetadata",
                      "Description": "Device metadata details.",
                      "Required": false,
                      "Type": "string"
                    }
                  },
                  {
                    "@removed_d7cfa9804e194fa98f4c0129402dfbe2": {
                      "#name": "network",
                      "Description": "Network configuration.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "networkAdapters",
                          "Description": "List of network adapters.",
                          "Required": false,
                          "Type": "array",
                          "$items": {
                            "Description": "Network adapter configuration.",
                            "Type": "object",
                            "$properties": [
                              {
                                "#name": "ipAssignmentType",
                                "Description": "Type of IP assignment.",
                                "Enum": [
                                  [
                                    "Automatic",
                                    "Automatic IP assignment"
                                  ],
                                  [
                                    "Manual",
                                    "Manual IP assignment"
                                  ]
                                ],
                                "Required": true,
                                "Type": "string"
                              },
                              {
                                "#name": "ipAddress",
                                "Description": "IP address.",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "adapterName",
                                "Description": "Adapter Name.",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "macAddress",
                                "Description": "MAC address.",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "ipAddressRange",
                                "Description": "IP address range.",
                                "Required": false,
                                "Type": "object",
                                "$properties": [
                                  {
                                    "#name": "startIp",
                                    "Description": "Start IP address.",
                                    "Required": true,
                                    "Type": "string"
                                  },
                                  {
                                    "#name": "endIp",
                                    "Description": "End IP address.",
                                    "Required": true,
                                    "Type": "string"
                                  }
                                ]
                              },
                              {
                                "#name": "gateway",
                                "Description": "Gateway id.",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "subnetMask",
                                "Description": "Subnet mask.",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "dnsAddressArray",
                                "Description": "Array of DNS addresses.",
                                "Required": false,
                                "Type": "array",
                                "$items": {
                                  "Type": "string"
                                }
                              },
                              {
                                "#name": "vlanId",
                                "Description": "VLAN ID for the network setup.",
                                "Required": false,
                                "Type": "string"
                              }
                            ]
                          }
                        }
                      ]
                    }
                  },
                  {
                    "@removed_6e331cafce384816b19c96c3f27a2bf2": {
                      "#name": "hostName",
                      "Description": "Hostname of the device.",
                      "Required": false,
                      "Type": "string"
                    }
                  },
                  {
                    "@removed_1d1c092c4be7484fb9b2d48a980bc973": {
                      "#name": "webProxy",
                      "Description": "Web proxy configuration.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "connectionUri",
                          "Description": "Connection URI of the web proxy.",
                          "Format": "uri",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "port",
                          "Description": "Port of the web proxy.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "bypassList",
                          "Description": "Bypass list for the web proxy.",
                          "Required": false,
                          "Type": "array",
                          "$items": {
                            "Format": "uri",
                            "Type": "string"
                          }
                        }
                      ]
                    }
                  },
                  {
                    "@removed_e661f076ce934a56a0f5c71f02277047": {
                      "#name": "time",
                      "Description": "Time configuration.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "primaryTimeServer",
                          "Description": "Primary NTP server.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "secondaryTimeServer",
                          "Description": "Secondary NTP server.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "timeZone",
                          "Description": "Time zone.",
                          "Required": false,
                          "Type": "string"
                        }
                      ]
                    }
                  },
                  {
                    "@removed_f73dcda56b3644028770cd62b450132e": {
                      "#name": "storage",
                      "Description": "Storage configuration.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "partitionSize",
                          "Description": "Partition size.",
                          "Required": false,
                          "Type": "string"
                        }
                      ]
                    }
                  }
                ]
              }
            ]
          },
          {
            "reportedProperties": [
              {
                "networkProfile": [
                  {
                    "nicDetails": {
                      "$properties": [
                        {
                          "#name": "rdmaCapability",
                          "Enum": {
                            "new": [
                              [
                                "Enabled",
                                "Network Adapter on the device is RDMA Capable"
                              ],
                              [
                                "Disabled",
                                "Network Adapter on the device is RDMA Capable"
                              ]
                            ],
                            "old": [
                              [
                                "Enabled",
                                "Network Adapter on the device is RDMA Capable"
                              ],
                              [
                                "Disabled",
                                "Network Adapter on the device isn't RDMA Capable"
                              ]
                            ]
                          }
                        }
                      ]
                    }
                  },
                  {
                    "switchDetails": {
                      "Description": {
                        "new": "List of switch details for edge device.",
                        "old": "Switch Details of edge machine."
                      }
                    }
                  }
                ]
              },
              {
                "extensionProfile": [
                  {
                    "extensions": {
                      "$properties": [
                        {
                          "#name": "state",
                          "Enum": {
                            "new": [
                              [
                                "NotSpecified",
                                "Arc extension state is not specified."
                              ],
                              [
                                "Succeeded",
                                "Arc extension state is Succeeded."
                              ],
                              [
                                "Failed",
                                "Arc extension state is Failed."
                              ],
                              [
                                "Canceled",
                                "Arc extension state is Canceled."
                              ],
                              [
                                "Accepted",
                                "Arc extension state is Accepted when extension installation triggered."
                              ],
                              [
                                "Creating",
                                "Arc extension is in Creating State."
                              ],
                              [
                                "Updating",
                                "Arc extension is in Updating State."
                              ],
                              [
                                "Moving",
                                "Arc extension is in Moving State."
                              ],
                              [
                                "Deleting",
                                "Arc extension is in Deleting State."
                              ],
                              [
                                "Deleted",
                                "Arc extension is in Deleted State."
                              ]
                            ],
                            "old": [
                              [
                                "NotSpecified",
                                "Arc extension state is not specified."
                              ],
                              [
                                "Accepted",
                                "Arc extension state is Accepted when extension installation triggered."
                              ],
                              [
                                "Canceled",
                                "Arc extension state is Canceled."
                              ],
                              [
                                "Creating",
                                "Arc extension is in Creating State."
                              ],
                              [
                                "Deleted",
                                "Arc extension is in Deleted State."
                              ],
                              [
                                "Deleting",
                                "Arc extension is in Deleting State."
                              ],
                              [
                                "Failed",
                                "Arc extension state is Failed."
                              ],
                              [
                                "Moving",
                                "Arc extension is in Moving State."
                              ],
                              [
                                "Succeeded",
                                "Arc extension state is Succeeded."
                              ],
                              [
                                "Updating",
                                "Arc extension is in Updating State."
                              ]
                            ]
                          }
                        },
                        {
                          "#name": "managedBy",
                          "Description": {
                            "new": "Indicates whether the extension is managed by the user or by Azure.",
                            "old": "Extension managed by user or Azure."
                          },
                          "Enum": {
                            "new": [
                              [
                                "User",
                                "The extension is managed by the user."
                              ],
                              [
                                "Azure",
                                "The extension is managed by Azure."
                              ]
                            ],
                            "old": [
                              [
                                "User",
                                "Extension managed by user."
                              ],
                              [
                                "Azure",
                                "Extension managed by Azure."
                              ]
                            ]
                          }
                        },
                        {
                          "@removed_2939741fee50492da28244e548bd5115": {
                            "#name": "exception",
                            "Description": "Exception details while installing Arc extension.",
                            "Required": false,
                            "Type": "string"
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            ]
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "NotSpecified",
                  "The provisioning state is not specified."
                ],
                [
                  "Error",
                  "An error occurred during provisioning."
                ],
                [
                  "Succeeded",
                  "Provisioning completed successfully."
                ],
                [
                  "Failed",
                  "Provisioning failed."
                ],
                [
                  "Canceled",
                  "Provisioning was canceled."
                ],
                [
                  "Connected",
                  "The resource is connected."
                ],
                [
                  "Disconnected",
                  "The resource is disconnected."
                ],
                [
                  "Deleted",
                  "The resource has been deleted."
                ],
                [
                  "Creating",
                  "The resource is being created."
                ],
                [
                  "Updating",
                  "The resource is being updated."
                ],
                [
                  "Deleting",
                  "The resource is being deleted."
                ],
                [
                  "Moving",
                  "The resource is being moved."
                ],
                [
                  "PartiallySucceeded",
                  "Provisioning partially succeeded."
                ],
                [
                  "PartiallyConnected",
                  "The resource is partially connected."
                ],
                [
                  "InProgress",
                  "Provisioning is in progress."
                ],
                [
                  "Accepted",
                  "Provisioning request has been accepted."
                ],
                [
                  "Provisioning",
                  "The resource is currently provisioning."
                ],
                [
                  "DisableInProgress",
                  "The resource is being disabled."
                ]
              ],
              "old": [
                [
                  "NotSpecified",
                  "The resource provision state is not specified"
                ],
                [
                  "Succeeded",
                  "Resource has been created."
                ],
                [
                  "Failed",
                  "Resource creation failed."
                ],
                [
                  "Canceled",
                  "Resource creation was canceled."
                ],
                [
                  "InProgress",
                  "Resource creation is in progress."
                ],
                [
                  "Provisioning",
                  "The resource is being provisioned"
                ],
                [
                  "Updating",
                  "The resource is updating"
                ],
                [
                  "Deleting",
                  "The resource is being deleted"
                ],
                [
                  "Accepted",
                  "The resource create request has been accepted"
                ]
              ]
            }
          },
          {
            "siteDetails": [
              {
                "deviceConfiguration": [
                  {
                    "@added_9821375d85d1414da9cbf562467ff425": {
                      "#name": "nicDetails",
                      "Description": "NIC Details of device",
                      "Required": false,
                      "Type": "array",
                      "$items": {
                        "Description": "The NIC Detail of a device.",
                        "Type": "object",
                        "$properties": [
                          {
                            "#name": "adapterName",
                            "Description": "Adapter Name of NIC",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "interfaceDescription",
                            "Description": "Interface Description of NIC",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "componentId",
                            "Description": "Component Id of NIC",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "driverVersion",
                            "Description": "Driver Version of NIC",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "ip4Address",
                            "Description": "Subnet Mask of NIC",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "subnetMask",
                            "Description": "Subnet Mask of NIC",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "defaultGateway",
                            "Description": "Default Gateway of NIC",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "dnsServers",
                            "Description": "DNS Servers for NIC",
                            "Required": false,
                            "Type": "array",
                            "$items": {
                              "Type": "string"
                            }
                          },
                          {
                            "#name": "defaultIsolationId",
                            "Description": "Default Isolation of Management NIC",
                            "Required": false,
                            "Type": "string"
                          }
                        ]
                      }
                    }
                  },
                  {
                    "@added_81ff6730795843fd96a015b1cd643d0a": {
                      "#name": "deviceMetadata",
                      "Description": "Device metadata details.",
                      "Required": false,
                      "Type": "string"
                    }
                  },
                  {
                    "@removed_dededf08708344b7886bae69bfd4dae9": {
                      "#name": "network",
                      "Description": "Network configuration.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "networkAdapters",
                          "Description": "List of network adapters.",
                          "Required": false,
                          "Type": "array",
                          "$items": {
                            "Description": "Network adapter configuration.",
                            "Type": "object",
                            "$properties": [
                              {
                                "#name": "ipAssignmentType",
                                "Description": "Type of IP assignment.",
                                "Enum": [
                                  [
                                    "Automatic",
                                    "Automatic IP assignment"
                                  ],
                                  [
                                    "Manual",
                                    "Manual IP assignment"
                                  ]
                                ],
                                "Required": true,
                                "Type": "string"
                              },
                              {
                                "#name": "ipAddress",
                                "Description": "IP address.",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "adapterName",
                                "Description": "Adapter Name.",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "macAddress",
                                "Description": "MAC address.",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "ipAddressRange",
                                "Description": "IP address range.",
                                "Required": false,
                                "Type": "object",
                                "$properties": [
                                  {
                                    "#name": "startIp",
                                    "Description": "Start IP address.",
                                    "Required": true,
                                    "Type": "string"
                                  },
                                  {
                                    "#name": "endIp",
                                    "Description": "End IP address.",
                                    "Required": true,
                                    "Type": "string"
                                  }
                                ]
                              },
                              {
                                "#name": "gateway",
                                "Description": "Gateway id.",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "subnetMask",
                                "Description": "Subnet mask.",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "dnsAddressArray",
                                "Description": "Array of DNS addresses.",
                                "Required": false,
                                "Type": "array",
                                "$items": {
                                  "Type": "string"
                                }
                              },
                              {
                                "#name": "vlanId",
                                "Description": "VLAN ID for the network setup.",
                                "Required": false,
                                "Type": "string"
                              }
                            ]
                          }
                        }
                      ]
                    }
                  },
                  {
                    "@removed_5eed8a487fc0434fbd8c5fa64e90948d": {
                      "#name": "hostName",
                      "Description": "Hostname of the device.",
                      "Required": false,
                      "Type": "string"
                    }
                  },
                  {
                    "@removed_7e6a8cb10ef74acb93205dd6687891df": {
                      "#name": "webProxy",
                      "Description": "Web proxy configuration.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "connectionUri",
                          "Description": "Connection URI of the web proxy.",
                          "Format": "uri",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "port",
                          "Description": "Port of the web proxy.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "bypassList",
                          "Description": "Bypass list for the web proxy.",
                          "Required": false,
                          "Type": "array",
                          "$items": {
                            "Format": "uri",
                            "Type": "string"
                          }
                        }
                      ]
                    }
                  },
                  {
                    "@removed_ae2fb82eff974a5cbd61ec3c23feb0f0": {
                      "#name": "time",
                      "Description": "Time configuration.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "primaryTimeServer",
                          "Description": "Primary NTP server.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "secondaryTimeServer",
                          "Description": "Secondary NTP server.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "timeZone",
                          "Description": "Time zone.",
                          "Required": false,
                          "Type": "string"
                        }
                      ]
                    }
                  },
                  {
                    "@removed_d18647887f614ad7ba660a43c953878c": {
                      "#name": "storage",
                      "Description": "Storage configuration.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "partitionSize",
                          "Description": "Partition size.",
                          "Required": false,
                          "Type": "string"
                        }
                      ]
                    }
                  }
                ]
              }
            ]
          },
          {
            "reportedProperties": [
              {
                "networkProfile": [
                  {
                    "nicDetails": {
                      "$properties": [
                        {
                          "#name": "rdmaCapability",
                          "Enum": {
                            "new": [
                              [
                                "Enabled",
                                "Network Adapter on the device is RDMA Capable"
                              ],
                              [
                                "Disabled",
                                "Network Adapter on the device is RDMA Capable"
                              ]
                            ],
                            "old": [
                              [
                                "Enabled",
                                "Network Adapter on the device is RDMA Capable"
                              ],
                              [
                                "Disabled",
                                "Network Adapter on the device isn't RDMA Capable"
                              ]
                            ]
                          }
                        }
                      ]
                    }
                  },
                  {
                    "switchDetails": {
                      "Description": {
                        "new": "List of switch details for edge device.",
                        "old": "Switch Details of edge machine."
                      }
                    }
                  }
                ]
              },
              {
                "extensionProfile": [
                  {
                    "extensions": {
                      "$properties": [
                        {
                          "#name": "state",
                          "Enum": {
                            "new": [
                              [
                                "NotSpecified",
                                "Arc extension state is not specified."
                              ],
                              [
                                "Succeeded",
                                "Arc extension state is Succeeded."
                              ],
                              [
                                "Failed",
                                "Arc extension state is Failed."
                              ],
                              [
                                "Canceled",
                                "Arc extension state is Canceled."
                              ],
                              [
                                "Accepted",
                                "Arc extension state is Accepted when extension installation triggered."
                              ],
                              [
                                "Creating",
                                "Arc extension is in Creating State."
                              ],
                              [
                                "Updating",
                                "Arc extension is in Updating State."
                              ],
                              [
                                "Moving",
                                "Arc extension is in Moving State."
                              ],
                              [
                                "Deleting",
                                "Arc extension is in Deleting State."
                              ],
                              [
                                "Deleted",
                                "Arc extension is in Deleted State."
                              ]
                            ],
                            "old": [
                              [
                                "NotSpecified",
                                "Arc extension state is not specified."
                              ],
                              [
                                "Accepted",
                                "Arc extension state is Accepted when extension installation triggered."
                              ],
                              [
                                "Canceled",
                                "Arc extension state is Canceled."
                              ],
                              [
                                "Creating",
                                "Arc extension is in Creating State."
                              ],
                              [
                                "Deleted",
                                "Arc extension is in Deleted State."
                              ],
                              [
                                "Deleting",
                                "Arc extension is in Deleting State."
                              ],
                              [
                                "Failed",
                                "Arc extension state is Failed."
                              ],
                              [
                                "Moving",
                                "Arc extension is in Moving State."
                              ],
                              [
                                "Succeeded",
                                "Arc extension state is Succeeded."
                              ],
                              [
                                "Updating",
                                "Arc extension is in Updating State."
                              ]
                            ]
                          }
                        },
                        {
                          "#name": "managedBy",
                          "Description": {
                            "new": "Indicates whether the extension is managed by the user or by Azure.",
                            "old": "Extension managed by user or Azure."
                          },
                          "Enum": {
                            "new": [
                              [
                                "User",
                                "The extension is managed by the user."
                              ],
                              [
                                "Azure",
                                "The extension is managed by Azure."
                              ]
                            ],
                            "old": [
                              [
                                "User",
                                "Extension managed by user."
                              ],
                              [
                                "Azure",
                                "Extension managed by Azure."
                              ]
                            ]
                          }
                        },
                        {
                          "@removed_cd0ff462d2cc4f32b2d376aab115f5f2": {
                            "#name": "exception",
                            "Description": "Exception details while installing Arc extension.",
                            "Required": false,
                            "Type": "string"
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/edgeMachines/{edgeMachineName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
edgeMachineName:
{
Description: Name of Device ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
edgeMachineKind:
{
Description: Edge Machine type. ,
Enum:
{
Standard: EdgeMachine resource created using Zero-touch provisioning. ,
Dedicated: EdgeMachine resource created for brownfield HCI customers without zero touch provisioning. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of a resource. ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
cloudId:
{
Description: Unique, immutable resource id. ,
Required: False ,
}
string ,
arcMachineResourceGroupId:
{
Description: Optional property to create arc machine in custom resource group. ,
Format: arm-id ,
Required: False ,
}
string ,
arcMachineResourceId:
{
Description: Arc machine instance resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
arcGatewayResourceId:
{
Description: Link to Arc Gateway ARM resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
siteDetails:
{
Description: Service fetches common configuration from site. ,
Required: False ,
}
{
siteResourceId:
{
Description: Site resource Id to be set during Edge Machine resource creation. ,
Format: arm-id ,
Required: True ,
}
string ,
deviceConfiguration:
{
Description: Edge Device configuration received from site common configuration. ,
Required: False ,
}
{
nicDetails:
{
Description: NIC Details of device ,
Required: False ,
}
[
{
adapterName:
{
Description: Adapter Name of NIC ,
Required: False ,
}
string ,
interfaceDescription:
{
Description: Interface Description of NIC ,
Required: False ,
}
string ,
componentId:
{
Description: Component Id of NIC ,
Required: False ,
}
string ,
driverVersion:
{
Description: Driver Version of NIC ,
Required: False ,
}
string ,
ip4Address:
{
Description: Subnet Mask of NIC ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet Mask of NIC ,
Required: False ,
}
string ,
defaultGateway:
{
Description: Default Gateway of NIC ,
Required: False ,
}
string ,
dnsServers:
{
Description: DNS Servers for NIC ,
Required: False ,
}
[
string ,
]
,
defaultIsolationId:
{
Description: Default Isolation of Management NIC ,
Required: False ,
}
string ,
}
,
]
,
deviceMetadata:
{
Description: Device metadata details. ,
Required: False ,
}
string ,
}
,
}
,
ownershipVoucherDetails:
{
Description: Ownership voucher details for provisioned machine. ,
Required: False ,
}
{
ownershipVoucher:
{
Description: Ownership voucher in base64 encoded format ,
Format: password ,
Required: True ,
}
string ,
ownerKeyType:
{
Description: Owner key type ,
Enum:
{
MicrosoftManaged: Owner is Microsoft managed key ,
}
,
Required: True ,
}
enum ,
}
,
provisioningDetails:
{
Description: Details for device provisioning. ,
Required: False ,
}
{
osProfile:
{
Description: Operating system profile. ,
Required: True ,
}
{
osName:
{
Description: Name of the operating system. ,
Required: False ,
}
string ,
osType:
{
Description: Type of the operating system. ,
Required: False ,
}
string ,
osVersion:
{
Description: Version of the operating system. ,
Required: False ,
}
string ,
osImageLocation:
{
Description: Location of the operating system image. ,
Required: False ,
}
string ,
vsrVersion:
{
Description: Validated Solution Recipe version to be used for the job ,
Required: False ,
}
string ,
imageHash:
{
Description: Hash of the OS package downloaded ,
Required: False ,
}
string ,
gpgPubKey:
{
Description: GPG Public Key used for package verification ,
Required: False ,
}
string ,
operationType:
{
Description: Operation sub type of OS Provisioning ,
Enum:
{
Provision: OS Provisioning operation ,
Update: OS Update operation ,
ReImage: OS ReImage operation ,
}
,
Required: False ,
}
enum ,
}
,
userDetails:
{
Description: User configuration. ,
Required: False ,
}
[
{
userName:
{
Description: Name of the user. ,
Required: True ,
}
string ,
secretType:
{
Description: Type of the secret used for authentication. ,
Enum:
{
KeyVault: Key Vault based authentication ,
SshPubKey: SSH Public Key based authentication ,
}
,
Required: True ,
}
enum ,
secretLocation:
{
Description: Location of the secret used for authentication. ,
Required: False ,
}
string ,
sshPubKey:
{
Description: SSH Public Key for the user. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
devicePoolResourceId:
{
Description: A machine can only be assigned to single device pool ,
Required: False ,
}
string ,
machineState:
{
Description: OS configuration status details ,
Enum:
{
Created: Created when EdgeMachine resource created ,
Registering: EdgeMachine state during device discovery and registration ,
Unpurposed: EdgeMachine state when machine configured with restricted OS and not provisioned to deploy workloads ,
Transitioning: EdgeMachine state when transitioning from initial OS to target OS ,
Purposed: EdgeMachine state when machine configured with target OS to deploy workloads ,
Updating: EdgeMachine state when OS updates are in-progress ,
Resetting: EdgeMachine state when transitioning from target OS to restricted OS ,
Failed: EdgeMachine failed state and only option to recover is to re-provisioning machine ,
Preparing: Preparing EdgeMachine ,
}
,
Required: False ,
}
enum ,
connectivityStatus:
{
Description: machine connectivity status ,
Enum:
{
NotSpecified: The connectivity status of the machine resource is not specified. ,
Disconnected: The machine resource is disconnected. ,
Connected: The machine resource is connected. ,
}
,
Required: False ,
}
enum ,
claimedBy:
{
Description: Tracks the ID of the consuming resource, setting the machine as in-use. ,
Required: False ,
}
string ,
reportedProperties:
{
Description: Reported properties for edge machine. ,
Required: False ,
}
{
lastUpdated:
{
Description: Last time data reported. ,
Format: date-time ,
Required: False ,
}
string ,
networkProfile:
{
Description: Network details for edge machine. ,
Required: False ,
}
{
nicDetails:
{
Description: List of Network Interface Card (NIC) Details of edge machine. ,
Required: False ,
}
[
{
adapterName:
{
Description: Adapter Name of NIC ,
Required: False ,
}
string ,
interfaceDescription:
{
Description: Interface Description of NIC ,
Required: False ,
}
string ,
componentId:
{
Description: Component Id of NIC ,
Required: False ,
}
string ,
driverVersion:
{
Description: Driver Version of NIC ,
Required: False ,
}
string ,
ip4Address:
{
Description: Subnet Mask of NIC ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet Mask of NIC ,
Required: False ,
}
string ,
defaultGateway:
{
Description: Default Gateway of NIC ,
Required: False ,
}
string ,
dnsServers:
{
Description: DNS Servers for NIC ,
Required: False ,
}
[
string ,
]
,
defaultIsolationId:
{
Description: Default Isolation of Management NIC ,
Required: False ,
}
string ,
macAddress:
{
Description: MAC address information of NIC. ,
Required: False ,
}
string ,
slot:
{
Description: The slot attached to the NIC. ,
Required: False ,
}
string ,
switchName:
{
Description: The switch attached to the NIC, if any. ,
Required: False ,
}
string ,
nicType:
{
Description: The type of NIC, physical, virtual, management. ,
Required: False ,
}
string ,
vlanId:
{
Description: The VLAN ID of the physical NIC. ,
Required: False ,
}
string ,
nicStatus:
{
Description: The status of NIC, up, disconnected. ,
Required: False ,
}
string ,
rdmaCapability:
{
Description: Describes the RDMA capability of the network adapter. ,
Enum:
{
Enabled: Network Adapter on the device is RDMA Capable ,
Disabled: Network Adapter on the device is RDMA Capable ,
}
,
Required: False ,
}
enum ,
}
,
]
,
switchDetails:
{
Description: List of switch Details of edge machine. ,
Required: False ,
}
[
{
switchName:
{
Description: The name of the switch. ,
Required: False ,
}
string ,
switchType:
{
Description: The type of the switch. e.g. external, internal. ,
Required: False ,
}
string ,
extensions:
{
Description: This represents extensions installed on virtualSwitch. ,
Required: False ,
}
[
{
switchId:
{
Description: Unique identifier for virtualSwitch. ,
Required: False ,
}
string ,
extensionName:
{
Description: This will show extension name for virtualSwitch. ,
Required: False ,
}
string ,
extensionEnabled:
{
Description: This represents whether extension is enabled on virtualSwitch. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
}
,
osProfile:
{
Description: OS Properties for edge machine. ,
Required: False ,
}
{
bootType:
{
Description: The boot type of the device. e.g. UEFI, Legacy etc ,
Required: False ,
}
string ,
assemblyVersion:
{
Description: Version of assembly present on device ,
Required: False ,
}
string ,
osType:
{
Description: OS type (“windows", “linux”) ,
Required: False ,
}
string ,
osSku:
{
Description: OS SKU (e.g., “ Microsoft Azure Linux ROE“, “Azure Stack HCI", "Microsoft Azure Linux 3.0") ,
Required: False ,
}
string ,
osVersion:
{
Description: OS Version ,
Required: False ,
}
string ,
buildNumber:
{
Description: OS Build Number ,
Required: False ,
}
string ,
baseImageVersion:
{
Description: OS Base Image Version ,
Required: False ,
}
string ,
imageVersion:
{
Description: OS Image Version ,
Required: False ,
}
string ,
}
,
hardwareProfile:
{
Description: Hardware related information for edge machine. ,
Required: False ,
}
{
cpuCores:
{
Description: Number of cpu cores in the machine ,
Format: int64 ,
Required: False ,
}
integer ,
cpuSockets:
{
Description: Number of cpu sockets in the machine ,
Format: int64 ,
Required: False ,
}
integer ,
memoryCapacityInGb:
{
Description: Memory capacity of the machine ,
Format: int64 ,
Required: False ,
}
integer ,
model:
{
Description: Model info of the machine ,
Required: False ,
}
string ,
manufacturer:
{
Description: manufacturer info of the machine ,
Required: False ,
}
string ,
serialNumber:
{
Description: Serial number of the machine ,
Required: False ,
}
string ,
processorType:
{
Description: Process type of the machine ,
Required: False ,
}
string ,
}
,
storageProfile:
{
Description: Storage related information for edge machine. ,
Required: False ,
}
{
poolableDisksCount:
{
Description: Number of storage disks in the device with $CanPool as true. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
sbeDeploymentPackageInfo:
{
Description: Solution builder extension (SBE) deployment package information. ,
Required: False ,
}
{
code:
{
Description: SBE deployment validation code. ,
Required: False ,
}
string ,
message:
{
Description: A detailed message that explains the SBE package validation result. ,
Required: False ,
}
string ,
sbeManifest:
{
Description: This represents discovered update results for matching updates and store it as SBE manifest. ,
Required: False ,
}
string ,
}
,
extensionProfile:
{
Description: Extension details for edge machine. ,
Required: False ,
}
{
extensions:
{
Description: List of Arc extensions installed on edge device. ,
Required: False ,
}
[
{
extensionName:
{
Description: Arc extension name installed on edge device. ,
Required: False ,
}
string ,
state:
{
Description: Arc extension state from arc machine extension. ,
Enum:
{
NotSpecified: Arc extension state is not specified. ,
Succeeded: Arc extension state is Succeeded. ,
Failed: Arc extension state is Failed. ,
Canceled: Arc extension state is Canceled. ,
Accepted: Arc extension state is Accepted when extension installation triggered. ,
Creating: Arc extension is in Creating State. ,
Updating: Arc extension is in Updating State. ,
Moving: Arc extension is in Moving State. ,
Deleting: Arc extension is in Deleting State. ,
Deleted: Arc extension is in Deleted State. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details while installing Arc extension. ,
Required: False ,
}
[
{
exception:
{
Description: Exception details while installing extension. ,
Required: False ,
}
string ,
}
,
]
,
extensionResourceId:
{
Description: Arc Extension Azure resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Extension version installed. ,
Required: False ,
}
string ,
managedBy:
{
Description: Indicates whether the extension is managed by the user or by Azure. ,
Enum:
{
User: The extension is managed by the user. ,
Azure: The extension is managed by Azure. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
operationDetails:
{
Description: operation status details for edge machine. ,
Required: False ,
}
[
{
name:
{
Description: operation name. ,
Required: False ,
}
string ,
id:
{
Description: operation id. ,
Required: False ,
}
string ,
type:
{
Description: operation type. ,
Required: False ,
}
string ,
resourceId:
{
Description: operation resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
description:
{
Description: operation description. ,
Required: False ,
}
string ,
status:
{
Description: operation status. ,
Required: False ,
}
string ,
error:
{
Description: error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
]
,
lastSyncTimestamp:
{
Description: Last time data updated to service. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
edgeMachineKind:
{
Description: Edge Machine type. ,
Enum:
{
Standard: EdgeMachine resource created using Zero-touch provisioning. ,
Dedicated: EdgeMachine resource created for brownfield HCI customers without zero touch provisioning. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of a resource. ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
cloudId:
{
Description: Unique, immutable resource id. ,
Required: False ,
}
string ,
arcMachineResourceGroupId:
{
Description: Optional property to create arc machine in custom resource group. ,
Format: arm-id ,
Required: False ,
}
string ,
arcMachineResourceId:
{
Description: Arc machine instance resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
arcGatewayResourceId:
{
Description: Link to Arc Gateway ARM resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
siteDetails:
{
Description: Service fetches common configuration from site. ,
Required: False ,
}
{
siteResourceId:
{
Description: Site resource Id to be set during Edge Machine resource creation. ,
Format: arm-id ,
Required: True ,
}
string ,
deviceConfiguration:
{
Description: Edge Device configuration received from site common configuration. ,
Required: False ,
}
{
nicDetails:
{
Description: NIC Details of device ,
Required: False ,
}
[
{
adapterName:
{
Description: Adapter Name of NIC ,
Required: False ,
}
string ,
interfaceDescription:
{
Description: Interface Description of NIC ,
Required: False ,
}
string ,
componentId:
{
Description: Component Id of NIC ,
Required: False ,
}
string ,
driverVersion:
{
Description: Driver Version of NIC ,
Required: False ,
}
string ,
ip4Address:
{
Description: Subnet Mask of NIC ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet Mask of NIC ,
Required: False ,
}
string ,
defaultGateway:
{
Description: Default Gateway of NIC ,
Required: False ,
}
string ,
dnsServers:
{
Description: DNS Servers for NIC ,
Required: False ,
}
[
string ,
]
,
defaultIsolationId:
{
Description: Default Isolation of Management NIC ,
Required: False ,
}
string ,
}
,
]
,
deviceMetadata:
{
Description: Device metadata details. ,
Required: False ,
}
string ,
}
,
}
,
ownershipVoucherDetails:
{
Description: Ownership voucher details for provisioned machine. ,
Required: False ,
}
{
ownershipVoucher:
{
Description: Ownership voucher in base64 encoded format ,
Format: password ,
Required: True ,
}
string ,
ownerKeyType:
{
Description: Owner key type ,
Enum:
{
MicrosoftManaged: Owner is Microsoft managed key ,
}
,
Required: True ,
}
enum ,
}
,
provisioningDetails:
{
Description: Details for device provisioning. ,
Required: False ,
}
{
osProfile:
{
Description: Operating system profile. ,
Required: True ,
}
{
osName:
{
Description: Name of the operating system. ,
Required: False ,
}
string ,
osType:
{
Description: Type of the operating system. ,
Required: False ,
}
string ,
osVersion:
{
Description: Version of the operating system. ,
Required: False ,
}
string ,
osImageLocation:
{
Description: Location of the operating system image. ,
Required: False ,
}
string ,
vsrVersion:
{
Description: Validated Solution Recipe version to be used for the job ,
Required: False ,
}
string ,
imageHash:
{
Description: Hash of the OS package downloaded ,
Required: False ,
}
string ,
gpgPubKey:
{
Description: GPG Public Key used for package verification ,
Required: False ,
}
string ,
operationType:
{
Description: Operation sub type of OS Provisioning ,
Enum:
{
Provision: OS Provisioning operation ,
Update: OS Update operation ,
ReImage: OS ReImage operation ,
}
,
Required: False ,
}
enum ,
}
,
userDetails:
{
Description: User configuration. ,
Required: False ,
}
[
{
userName:
{
Description: Name of the user. ,
Required: True ,
}
string ,
secretType:
{
Description: Type of the secret used for authentication. ,
Enum:
{
KeyVault: Key Vault based authentication ,
SshPubKey: SSH Public Key based authentication ,
}
,
Required: True ,
}
enum ,
secretLocation:
{
Description: Location of the secret used for authentication. ,
Required: False ,
}
string ,
sshPubKey:
{
Description: SSH Public Key for the user. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
devicePoolResourceId:
{
Description: A machine can only be assigned to single device pool ,
Required: False ,
}
string ,
machineState:
{
Description: OS configuration status details ,
Enum:
{
Created: Created when EdgeMachine resource created ,
Registering: EdgeMachine state during device discovery and registration ,
Unpurposed: EdgeMachine state when machine configured with restricted OS and not provisioned to deploy workloads ,
Transitioning: EdgeMachine state when transitioning from initial OS to target OS ,
Purposed: EdgeMachine state when machine configured with target OS to deploy workloads ,
Updating: EdgeMachine state when OS updates are in-progress ,
Resetting: EdgeMachine state when transitioning from target OS to restricted OS ,
Failed: EdgeMachine failed state and only option to recover is to re-provisioning machine ,
Preparing: Preparing EdgeMachine ,
}
,
Required: False ,
}
enum ,
connectivityStatus:
{
Description: machine connectivity status ,
Enum:
{
NotSpecified: The connectivity status of the machine resource is not specified. ,
Disconnected: The machine resource is disconnected. ,
Connected: The machine resource is connected. ,
}
,
Required: False ,
}
enum ,
claimedBy:
{
Description: Tracks the ID of the consuming resource, setting the machine as in-use. ,
Required: False ,
}
string ,
reportedProperties:
{
Description: Reported properties for edge machine. ,
Required: False ,
}
{
lastUpdated:
{
Description: Last time data reported. ,
Format: date-time ,
Required: False ,
}
string ,
networkProfile:
{
Description: Network details for edge machine. ,
Required: False ,
}
{
nicDetails:
{
Description: List of Network Interface Card (NIC) Details of edge machine. ,
Required: False ,
}
[
{
adapterName:
{
Description: Adapter Name of NIC ,
Required: False ,
}
string ,
interfaceDescription:
{
Description: Interface Description of NIC ,
Required: False ,
}
string ,
componentId:
{
Description: Component Id of NIC ,
Required: False ,
}
string ,
driverVersion:
{
Description: Driver Version of NIC ,
Required: False ,
}
string ,
ip4Address:
{
Description: Subnet Mask of NIC ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet Mask of NIC ,
Required: False ,
}
string ,
defaultGateway:
{
Description: Default Gateway of NIC ,
Required: False ,
}
string ,
dnsServers:
{
Description: DNS Servers for NIC ,
Required: False ,
}
[
string ,
]
,
defaultIsolationId:
{
Description: Default Isolation of Management NIC ,
Required: False ,
}
string ,
macAddress:
{
Description: MAC address information of NIC. ,
Required: False ,
}
string ,
slot:
{
Description: The slot attached to the NIC. ,
Required: False ,
}
string ,
switchName:
{
Description: The switch attached to the NIC, if any. ,
Required: False ,
}
string ,
nicType:
{
Description: The type of NIC, physical, virtual, management. ,
Required: False ,
}
string ,
vlanId:
{
Description: The VLAN ID of the physical NIC. ,
Required: False ,
}
string ,
nicStatus:
{
Description: The status of NIC, up, disconnected. ,
Required: False ,
}
string ,
rdmaCapability:
{
Description: Describes the RDMA capability of the network adapter. ,
Enum:
{
Enabled: Network Adapter on the device is RDMA Capable ,
Disabled: Network Adapter on the device is RDMA Capable ,
}
,
Required: False ,
}
enum ,
}
,
]
,
switchDetails:
{
Description: List of switch Details of edge machine. ,
Required: False ,
}
[
{
switchName:
{
Description: The name of the switch. ,
Required: False ,
}
string ,
switchType:
{
Description: The type of the switch. e.g. external, internal. ,
Required: False ,
}
string ,
extensions:
{
Description: This represents extensions installed on virtualSwitch. ,
Required: False ,
}
[
{
switchId:
{
Description: Unique identifier for virtualSwitch. ,
Required: False ,
}
string ,
extensionName:
{
Description: This will show extension name for virtualSwitch. ,
Required: False ,
}
string ,
extensionEnabled:
{
Description: This represents whether extension is enabled on virtualSwitch. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
}
,
osProfile:
{
Description: OS Properties for edge machine. ,
Required: False ,
}
{
bootType:
{
Description: The boot type of the device. e.g. UEFI, Legacy etc ,
Required: False ,
}
string ,
assemblyVersion:
{
Description: Version of assembly present on device ,
Required: False ,
}
string ,
osType:
{
Description: OS type (“windows", “linux”) ,
Required: False ,
}
string ,
osSku:
{
Description: OS SKU (e.g., “ Microsoft Azure Linux ROE“, “Azure Stack HCI", "Microsoft Azure Linux 3.0") ,
Required: False ,
}
string ,
osVersion:
{
Description: OS Version ,
Required: False ,
}
string ,
buildNumber:
{
Description: OS Build Number ,
Required: False ,
}
string ,
baseImageVersion:
{
Description: OS Base Image Version ,
Required: False ,
}
string ,
imageVersion:
{
Description: OS Image Version ,
Required: False ,
}
string ,
}
,
hardwareProfile:
{
Description: Hardware related information for edge machine. ,
Required: False ,
}
{
cpuCores:
{
Description: Number of cpu cores in the machine ,
Format: int64 ,
Required: False ,
}
integer ,
cpuSockets:
{
Description: Number of cpu sockets in the machine ,
Format: int64 ,
Required: False ,
}
integer ,
memoryCapacityInGb:
{
Description: Memory capacity of the machine ,
Format: int64 ,
Required: False ,
}
integer ,
model:
{
Description: Model info of the machine ,
Required: False ,
}
string ,
manufacturer:
{
Description: manufacturer info of the machine ,
Required: False ,
}
string ,
serialNumber:
{
Description: Serial number of the machine ,
Required: False ,
}
string ,
processorType:
{
Description: Process type of the machine ,
Required: False ,
}
string ,
}
,
storageProfile:
{
Description: Storage related information for edge machine. ,
Required: False ,
}
{
poolableDisksCount:
{
Description: Number of storage disks in the device with $CanPool as true. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
sbeDeploymentPackageInfo:
{
Description: Solution builder extension (SBE) deployment package information. ,
Required: False ,
}
{
code:
{
Description: SBE deployment validation code. ,
Required: False ,
}
string ,
message:
{
Description: A detailed message that explains the SBE package validation result. ,
Required: False ,
}
string ,
sbeManifest:
{
Description: This represents discovered update results for matching updates and store it as SBE manifest. ,
Required: False ,
}
string ,
}
,
extensionProfile:
{
Description: Extension details for edge machine. ,
Required: False ,
}
{
extensions:
{
Description: List of Arc extensions installed on edge device. ,
Required: False ,
}
[
{
extensionName:
{
Description: Arc extension name installed on edge device. ,
Required: False ,
}
string ,
state:
{
Description: Arc extension state from arc machine extension. ,
Enum:
{
NotSpecified: Arc extension state is not specified. ,
Succeeded: Arc extension state is Succeeded. ,
Failed: Arc extension state is Failed. ,
Canceled: Arc extension state is Canceled. ,
Accepted: Arc extension state is Accepted when extension installation triggered. ,
Creating: Arc extension is in Creating State. ,
Updating: Arc extension is in Updating State. ,
Moving: Arc extension is in Moving State. ,
Deleting: Arc extension is in Deleting State. ,
Deleted: Arc extension is in Deleted State. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details while installing Arc extension. ,
Required: False ,
}
[
{
exception:
{
Description: Exception details while installing extension. ,
Required: False ,
}
string ,
}
,
]
,
extensionResourceId:
{
Description: Arc Extension Azure resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Extension version installed. ,
Required: False ,
}
string ,
managedBy:
{
Description: Indicates whether the extension is managed by the user or by Azure. ,
Enum:
{
User: The extension is managed by the user. ,
Azure: The extension is managed by Azure. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
operationDetails:
{
Description: operation status details for edge machine. ,
Required: False ,
}
[
{
name:
{
Description: operation name. ,
Required: False ,
}
string ,
id:
{
Description: operation id. ,
Required: False ,
}
string ,
type:
{
Description: operation type. ,
Required: False ,
}
string ,
resourceId:
{
Description: operation resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
description:
{
Description: operation description. ,
Required: False ,
}
string ,
status:
{
Description: operation status. ,
Required: False ,
}
string ,
error:
{
Description: error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
]
,
lastSyncTimestamp:
{
Description: Last time data updated to service. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: EdgeMachine details. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
edgeMachineKind:
{
Description: Edge Machine type. ,
Enum:
{
Standard: EdgeMachine resource created using Zero-touch provisioning. ,
Dedicated: EdgeMachine resource created for brownfield HCI customers without zero touch provisioning. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of a resource. ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
cloudId:
{
Description: Unique, immutable resource id. ,
Required: False ,
}
string ,
arcMachineResourceGroupId:
{
Description: Optional property to create arc machine in custom resource group. ,
Format: arm-id ,
Required: False ,
}
string ,
arcMachineResourceId:
{
Description: Arc machine instance resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
arcGatewayResourceId:
{
Description: Link to Arc Gateway ARM resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
siteDetails:
{
Description: Service fetches common configuration from site. ,
Required: False ,
}
{
siteResourceId:
{
Description: Site resource Id to be set during Edge Machine resource creation. ,
Format: arm-id ,
Required: True ,
}
string ,
deviceConfiguration:
{
Description: Edge Device configuration received from site common configuration. ,
Required: False ,
}
{
nicDetails:
{
Description: NIC Details of device ,
Required: False ,
}
[
{
adapterName:
{
Description: Adapter Name of NIC ,
Required: False ,
}
string ,
interfaceDescription:
{
Description: Interface Description of NIC ,
Required: False ,
}
string ,
componentId:
{
Description: Component Id of NIC ,
Required: False ,
}
string ,
driverVersion:
{
Description: Driver Version of NIC ,
Required: False ,
}
string ,
ip4Address:
{
Description: Subnet Mask of NIC ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet Mask of NIC ,
Required: False ,
}
string ,
defaultGateway:
{
Description: Default Gateway of NIC ,
Required: False ,
}
string ,
dnsServers:
{
Description: DNS Servers for NIC ,
Required: False ,
}
[
string ,
]
,
defaultIsolationId:
{
Description: Default Isolation of Management NIC ,
Required: False ,
}
string ,
}
,
]
,
deviceMetadata:
{
Description: Device metadata details. ,
Required: False ,
}
string ,
}
,
}
,
ownershipVoucherDetails:
{
Description: Ownership voucher details for provisioned machine. ,
Required: False ,
}
{
ownershipVoucher:
{
Description: Ownership voucher in base64 encoded format ,
Format: password ,
Required: True ,
}
string ,
ownerKeyType:
{
Description: Owner key type ,
Enum:
{
MicrosoftManaged: Owner is Microsoft managed key ,
}
,
Required: True ,
}
enum ,
}
,
provisioningDetails:
{
Description: Details for device provisioning. ,
Required: False ,
}
{
osProfile:
{
Description: Operating system profile. ,
Required: True ,
}
{
osName:
{
Description: Name of the operating system. ,
Required: False ,
}
string ,
osType:
{
Description: Type of the operating system. ,
Required: False ,
}
string ,
osVersion:
{
Description: Version of the operating system. ,
Required: False ,
}
string ,
osImageLocation:
{
Description: Location of the operating system image. ,
Required: False ,
}
string ,
vsrVersion:
{
Description: Validated Solution Recipe version to be used for the job ,
Required: False ,
}
string ,
imageHash:
{
Description: Hash of the OS package downloaded ,
Required: False ,
}
string ,
gpgPubKey:
{
Description: GPG Public Key used for package verification ,
Required: False ,
}
string ,
operationType:
{
Description: Operation sub type of OS Provisioning ,
Enum:
{
Provision: OS Provisioning operation ,
Update: OS Update operation ,
ReImage: OS ReImage operation ,
}
,
Required: False ,
}
enum ,
}
,
userDetails:
{
Description: User configuration. ,
Required: False ,
}
[
{
userName:
{
Description: Name of the user. ,
Required: True ,
}
string ,
secretType:
{
Description: Type of the secret used for authentication. ,
Enum:
{
KeyVault: Key Vault based authentication ,
SshPubKey: SSH Public Key based authentication ,
}
,
Required: True ,
}
enum ,
secretLocation:
{
Description: Location of the secret used for authentication. ,
Required: False ,
}
string ,
sshPubKey:
{
Description: SSH Public Key for the user. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
devicePoolResourceId:
{
Description: A machine can only be assigned to single device pool ,
Required: False ,
}
string ,
machineState:
{
Description: OS configuration status details ,
Enum:
{
Created: Created when EdgeMachine resource created ,
Registering: EdgeMachine state during device discovery and registration ,
Unpurposed: EdgeMachine state when machine configured with restricted OS and not provisioned to deploy workloads ,
Transitioning: EdgeMachine state when transitioning from initial OS to target OS ,
Purposed: EdgeMachine state when machine configured with target OS to deploy workloads ,
Updating: EdgeMachine state when OS updates are in-progress ,
Resetting: EdgeMachine state when transitioning from target OS to restricted OS ,
Failed: EdgeMachine failed state and only option to recover is to re-provisioning machine ,
Preparing: Preparing EdgeMachine ,
}
,
Required: False ,
}
enum ,
connectivityStatus:
{
Description: machine connectivity status ,
Enum:
{
NotSpecified: The connectivity status of the machine resource is not specified. ,
Disconnected: The machine resource is disconnected. ,
Connected: The machine resource is connected. ,
}
,
Required: False ,
}
enum ,
claimedBy:
{
Description: Tracks the ID of the consuming resource, setting the machine as in-use. ,
Required: False ,
}
string ,
reportedProperties:
{
Description: Reported properties for edge machine. ,
Required: False ,
}
{
lastUpdated:
{
Description: Last time data reported. ,
Format: date-time ,
Required: False ,
}
string ,
networkProfile:
{
Description: Network details for edge machine. ,
Required: False ,
}
{
nicDetails:
{
Description: List of Network Interface Card (NIC) Details of edge machine. ,
Required: False ,
}
[
{
adapterName:
{
Description: Adapter Name of NIC ,
Required: False ,
}
string ,
interfaceDescription:
{
Description: Interface Description of NIC ,
Required: False ,
}
string ,
componentId:
{
Description: Component Id of NIC ,
Required: False ,
}
string ,
driverVersion:
{
Description: Driver Version of NIC ,
Required: False ,
}
string ,
ip4Address:
{
Description: Subnet Mask of NIC ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet Mask of NIC ,
Required: False ,
}
string ,
defaultGateway:
{
Description: Default Gateway of NIC ,
Required: False ,
}
string ,
dnsServers:
{
Description: DNS Servers for NIC ,
Required: False ,
}
[
string ,
]
,
defaultIsolationId:
{
Description: Default Isolation of Management NIC ,
Required: False ,
}
string ,
macAddress:
{
Description: MAC address information of NIC. ,
Required: False ,
}
string ,
slot:
{
Description: The slot attached to the NIC. ,
Required: False ,
}
string ,
switchName:
{
Description: The switch attached to the NIC, if any. ,
Required: False ,
}
string ,
nicType:
{
Description: The type of NIC, physical, virtual, management. ,
Required: False ,
}
string ,
vlanId:
{
Description: The VLAN ID of the physical NIC. ,
Required: False ,
}
string ,
nicStatus:
{
Description: The status of NIC, up, disconnected. ,
Required: False ,
}
string ,
rdmaCapability:
{
Description: Describes the RDMA capability of the network adapter. ,
Enum:
{
Enabled: Network Adapter on the device is RDMA Capable ,
Disabled: Network Adapter on the device is RDMA Capable ,
}
,
Required: False ,
}
enum ,
}
,
]
,
switchDetails:
{
Description: List of switch Details of edge machine. ,
Required: False ,
}
[
{
switchName:
{
Description: The name of the switch. ,
Required: False ,
}
string ,
switchType:
{
Description: The type of the switch. e.g. external, internal. ,
Required: False ,
}
string ,
extensions:
{
Description: This represents extensions installed on virtualSwitch. ,
Required: False ,
}
[
{
switchId:
{
Description: Unique identifier for virtualSwitch. ,
Required: False ,
}
string ,
extensionName:
{
Description: This will show extension name for virtualSwitch. ,
Required: False ,
}
string ,
extensionEnabled:
{
Description: This represents whether extension is enabled on virtualSwitch. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
}
,
osProfile:
{
Description: OS Properties for edge machine. ,
Required: False ,
}
{
bootType:
{
Description: The boot type of the device. e.g. UEFI, Legacy etc ,
Required: False ,
}
string ,
assemblyVersion:
{
Description: Version of assembly present on device ,
Required: False ,
}
string ,
osType:
{
Description: OS type (“windows", “linux”) ,
Required: False ,
}
string ,
osSku:
{
Description: OS SKU (e.g., “ Microsoft Azure Linux ROE“, “Azure Stack HCI", "Microsoft Azure Linux 3.0") ,
Required: False ,
}
string ,
osVersion:
{
Description: OS Version ,
Required: False ,
}
string ,
buildNumber:
{
Description: OS Build Number ,
Required: False ,
}
string ,
baseImageVersion:
{
Description: OS Base Image Version ,
Required: False ,
}
string ,
imageVersion:
{
Description: OS Image Version ,
Required: False ,
}
string ,
}
,
hardwareProfile:
{
Description: Hardware related information for edge machine. ,
Required: False ,
}
{
cpuCores:
{
Description: Number of cpu cores in the machine ,
Format: int64 ,
Required: False ,
}
integer ,
cpuSockets:
{
Description: Number of cpu sockets in the machine ,
Format: int64 ,
Required: False ,
}
integer ,
memoryCapacityInGb:
{
Description: Memory capacity of the machine ,
Format: int64 ,
Required: False ,
}
integer ,
model:
{
Description: Model info of the machine ,
Required: False ,
}
string ,
manufacturer:
{
Description: manufacturer info of the machine ,
Required: False ,
}
string ,
serialNumber:
{
Description: Serial number of the machine ,
Required: False ,
}
string ,
processorType:
{
Description: Process type of the machine ,
Required: False ,
}
string ,
}
,
storageProfile:
{
Description: Storage related information for edge machine. ,
Required: False ,
}
{
poolableDisksCount:
{
Description: Number of storage disks in the device with $CanPool as true. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
sbeDeploymentPackageInfo:
{
Description: Solution builder extension (SBE) deployment package information. ,
Required: False ,
}
{
code:
{
Description: SBE deployment validation code. ,
Required: False ,
}
string ,
message:
{
Description: A detailed message that explains the SBE package validation result. ,
Required: False ,
}
string ,
sbeManifest:
{
Description: This represents discovered update results for matching updates and store it as SBE manifest. ,
Required: False ,
}
string ,
}
,
extensionProfile:
{
Description: Extension details for edge machine. ,
Required: False ,
}
{
extensions:
{
Description: List of Arc extensions installed on edge device. ,
Required: False ,
}
[
{
extensionName:
{
Description: Arc extension name installed on edge device. ,
Required: False ,
}
string ,
state:
{
Description: Arc extension state from arc machine extension. ,
Enum:
{
NotSpecified: Arc extension state is not specified. ,
Succeeded: Arc extension state is Succeeded. ,
Failed: Arc extension state is Failed. ,
Canceled: Arc extension state is Canceled. ,
Accepted: Arc extension state is Accepted when extension installation triggered. ,
Creating: Arc extension is in Creating State. ,
Updating: Arc extension is in Updating State. ,
Moving: Arc extension is in Moving State. ,
Deleting: Arc extension is in Deleting State. ,
Deleted: Arc extension is in Deleted State. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details while installing Arc extension. ,
Required: False ,
}
[
{
exception:
{
Description: Exception details while installing extension. ,
Required: False ,
}
string ,
}
,
]
,
extensionResourceId:
{
Description: Arc Extension Azure resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Extension version installed. ,
Required: False ,
}
string ,
managedBy:
{
Description: Indicates whether the extension is managed by the user or by Azure. ,
Enum:
{
User: The extension is managed by the user. ,
Azure: The extension is managed by Azure. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
operationDetails:
{
Description: operation status details for edge machine. ,
Required: False ,
}
[
{
name:
{
Description: operation name. ,
Required: False ,
}
string ,
id:
{
Description: operation id. ,
Required: False ,
}
string ,
type:
{
Description: operation type. ,
Required: False ,
}
string ,
resourceId:
{
Description: operation resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
description:
{
Description: operation description. ,
Required: False ,
}
string ,
status:
{
Description: operation status. ,
Required: False ,
}
string ,
error:
{
Description: error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
]
,
lastSyncTimestamp:
{
Description: Last time data updated to service. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EdgeMachines_Update (updated)
Description :  Update an edge machine.
Reference :  Link ¶

⚶ Changes

{
  "#id": "EdgeMachines_Update",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "NotSpecified",
                  "The provisioning state is not specified."
                ],
                [
                  "Error",
                  "An error occurred during provisioning."
                ],
                [
                  "Succeeded",
                  "Provisioning completed successfully."
                ],
                [
                  "Failed",
                  "Provisioning failed."
                ],
                [
                  "Canceled",
                  "Provisioning was canceled."
                ],
                [
                  "Connected",
                  "The resource is connected."
                ],
                [
                  "Disconnected",
                  "The resource is disconnected."
                ],
                [
                  "Deleted",
                  "The resource has been deleted."
                ],
                [
                  "Creating",
                  "The resource is being created."
                ],
                [
                  "Updating",
                  "The resource is being updated."
                ],
                [
                  "Deleting",
                  "The resource is being deleted."
                ],
                [
                  "Moving",
                  "The resource is being moved."
                ],
                [
                  "PartiallySucceeded",
                  "Provisioning partially succeeded."
                ],
                [
                  "PartiallyConnected",
                  "The resource is partially connected."
                ],
                [
                  "InProgress",
                  "Provisioning is in progress."
                ],
                [
                  "Accepted",
                  "Provisioning request has been accepted."
                ],
                [
                  "Provisioning",
                  "The resource is currently provisioning."
                ],
                [
                  "DisableInProgress",
                  "The resource is being disabled."
                ]
              ],
              "old": [
                [
                  "NotSpecified",
                  "The resource provision state is not specified"
                ],
                [
                  "Succeeded",
                  "Resource has been created."
                ],
                [
                  "Failed",
                  "Resource creation failed."
                ],
                [
                  "Canceled",
                  "Resource creation was canceled."
                ],
                [
                  "InProgress",
                  "Resource creation is in progress."
                ],
                [
                  "Provisioning",
                  "The resource is being provisioned"
                ],
                [
                  "Updating",
                  "The resource is updating"
                ],
                [
                  "Deleting",
                  "The resource is being deleted"
                ],
                [
                  "Accepted",
                  "The resource create request has been accepted"
                ]
              ]
            }
          },
          {
            "siteDetails": [
              {
                "deviceConfiguration": [
                  {
                    "@added_1b4ac957c11043248acae7f11235bbdf": {
                      "#name": "nicDetails",
                      "Description": "NIC Details of device",
                      "Required": false,
                      "Type": "array",
                      "$items": {
                        "Description": "The NIC Detail of a device.",
                        "Type": "object",
                        "$properties": [
                          {
                            "#name": "adapterName",
                            "Description": "Adapter Name of NIC",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "interfaceDescription",
                            "Description": "Interface Description of NIC",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "componentId",
                            "Description": "Component Id of NIC",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "driverVersion",
                            "Description": "Driver Version of NIC",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "ip4Address",
                            "Description": "Subnet Mask of NIC",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "subnetMask",
                            "Description": "Subnet Mask of NIC",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "defaultGateway",
                            "Description": "Default Gateway of NIC",
                            "Required": false,
                            "Type": "string"
                          },
                          {
                            "#name": "dnsServers",
                            "Description": "DNS Servers for NIC",
                            "Required": false,
                            "Type": "array",
                            "$items": {
                              "Type": "string"
                            }
                          },
                          {
                            "#name": "defaultIsolationId",
                            "Description": "Default Isolation of Management NIC",
                            "Required": false,
                            "Type": "string"
                          }
                        ]
                      }
                    }
                  },
                  {
                    "@added_dacf5e30ed5446959927f6daed3023a6": {
                      "#name": "deviceMetadata",
                      "Description": "Device metadata details.",
                      "Required": false,
                      "Type": "string"
                    }
                  },
                  {
                    "@removed_61c228de4cef42c29507c4c751b22804": {
                      "#name": "network",
                      "Description": "Network configuration.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "networkAdapters",
                          "Description": "List of network adapters.",
                          "Required": false,
                          "Type": "array",
                          "$items": {
                            "Description": "Network adapter configuration.",
                            "Type": "object",
                            "$properties": [
                              {
                                "#name": "ipAssignmentType",
                                "Description": "Type of IP assignment.",
                                "Enum": [
                                  [
                                    "Automatic",
                                    "Automatic IP assignment"
                                  ],
                                  [
                                    "Manual",
                                    "Manual IP assignment"
                                  ]
                                ],
                                "Required": true,
                                "Type": "string"
                              },
                              {
                                "#name": "ipAddress",
                                "Description": "IP address.",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "adapterName",
                                "Description": "Adapter Name.",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "macAddress",
                                "Description": "MAC address.",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "ipAddressRange",
                                "Description": "IP address range.",
                                "Required": false,
                                "Type": "object",
                                "$properties": [
                                  {
                                    "#name": "startIp",
                                    "Description": "Start IP address.",
                                    "Required": true,
                                    "Type": "string"
                                  },
                                  {
                                    "#name": "endIp",
                                    "Description": "End IP address.",
                                    "Required": true,
                                    "Type": "string"
                                  }
                                ]
                              },
                              {
                                "#name": "gateway",
                                "Description": "Gateway id.",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "subnetMask",
                                "Description": "Subnet mask.",
                                "Required": false,
                                "Type": "string"
                              },
                              {
                                "#name": "dnsAddressArray",
                                "Description": "Array of DNS addresses.",
                                "Required": false,
                                "Type": "array",
                                "$items": {
                                  "Type": "string"
                                }
                              },
                              {
                                "#name": "vlanId",
                                "Description": "VLAN ID for the network setup.",
                                "Required": false,
                                "Type": "string"
                              }
                            ]
                          }
                        }
                      ]
                    }
                  },
                  {
                    "@removed_ad0f3985d5eb4c00aeb92d7518486c95": {
                      "#name": "hostName",
                      "Description": "Hostname of the device.",
                      "Required": false,
                      "Type": "string"
                    }
                  },
                  {
                    "@removed_8dda376cfab34a96babbe6b76f9e6e4c": {
                      "#name": "webProxy",
                      "Description": "Web proxy configuration.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "connectionUri",
                          "Description": "Connection URI of the web proxy.",
                          "Format": "uri",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "port",
                          "Description": "Port of the web proxy.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "bypassList",
                          "Description": "Bypass list for the web proxy.",
                          "Required": false,
                          "Type": "array",
                          "$items": {
                            "Format": "uri",
                            "Type": "string"
                          }
                        }
                      ]
                    }
                  },
                  {
                    "@removed_4a03709e2f6e455ea2920ff84ba2728a": {
                      "#name": "time",
                      "Description": "Time configuration.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "primaryTimeServer",
                          "Description": "Primary NTP server.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "secondaryTimeServer",
                          "Description": "Secondary NTP server.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "timeZone",
                          "Description": "Time zone.",
                          "Required": false,
                          "Type": "string"
                        }
                      ]
                    }
                  },
                  {
                    "@removed_20a2c5ecd0c3484f8e125b9d61dc13ab": {
                      "#name": "storage",
                      "Description": "Storage configuration.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "partitionSize",
                          "Description": "Partition size.",
                          "Required": false,
                          "Type": "string"
                        }
                      ]
                    }
                  }
                ]
              }
            ]
          },
          {
            "reportedProperties": [
              {
                "networkProfile": [
                  {
                    "nicDetails": {
                      "$properties": [
                        {
                          "#name": "rdmaCapability",
                          "Enum": {
                            "new": [
                              [
                                "Enabled",
                                "Network Adapter on the device is RDMA Capable"
                              ],
                              [
                                "Disabled",
                                "Network Adapter on the device is RDMA Capable"
                              ]
                            ],
                            "old": [
                              [
                                "Enabled",
                                "Network Adapter on the device is RDMA Capable"
                              ],
                              [
                                "Disabled",
                                "Network Adapter on the device isn't RDMA Capable"
                              ]
                            ]
                          }
                        }
                      ]
                    }
                  },
                  {
                    "switchDetails": {
                      "Description": {
                        "new": "List of switch details for edge device.",
                        "old": "Switch Details of edge machine."
                      }
                    }
                  }
                ]
              },
              {
                "extensionProfile": [
                  {
                    "extensions": {
                      "$properties": [
                        {
                          "#name": "state",
                          "Enum": {
                            "new": [
                              [
                                "NotSpecified",
                                "Arc extension state is not specified."
                              ],
                              [
                                "Succeeded",
                                "Arc extension state is Succeeded."
                              ],
                              [
                                "Failed",
                                "Arc extension state is Failed."
                              ],
                              [
                                "Canceled",
                                "Arc extension state is Canceled."
                              ],
                              [
                                "Accepted",
                                "Arc extension state is Accepted when extension installation triggered."
                              ],
                              [
                                "Creating",
                                "Arc extension is in Creating State."
                              ],
                              [
                                "Updating",
                                "Arc extension is in Updating State."
                              ],
                              [
                                "Moving",
                                "Arc extension is in Moving State."
                              ],
                              [
                                "Deleting",
                                "Arc extension is in Deleting State."
                              ],
                              [
                                "Deleted",
                                "Arc extension is in Deleted State."
                              ]
                            ],
                            "old": [
                              [
                                "NotSpecified",
                                "Arc extension state is not specified."
                              ],
                              [
                                "Accepted",
                                "Arc extension state is Accepted when extension installation triggered."
                              ],
                              [
                                "Canceled",
                                "Arc extension state is Canceled."
                              ],
                              [
                                "Creating",
                                "Arc extension is in Creating State."
                              ],
                              [
                                "Deleted",
                                "Arc extension is in Deleted State."
                              ],
                              [
                                "Deleting",
                                "Arc extension is in Deleting State."
                              ],
                              [
                                "Failed",
                                "Arc extension state is Failed."
                              ],
                              [
                                "Moving",
                                "Arc extension is in Moving State."
                              ],
                              [
                                "Succeeded",
                                "Arc extension state is Succeeded."
                              ],
                              [
                                "Updating",
                                "Arc extension is in Updating State."
                              ]
                            ]
                          }
                        },
                        {
                          "#name": "managedBy",
                          "Description": {
                            "new": "Indicates whether the extension is managed by the user or by Azure.",
                            "old": "Extension managed by user or Azure."
                          },
                          "Enum": {
                            "new": [
                              [
                                "User",
                                "The extension is managed by the user."
                              ],
                              [
                                "Azure",
                                "The extension is managed by Azure."
                              ]
                            ],
                            "old": [
                              [
                                "User",
                                "Extension managed by user."
                              ],
                              [
                                "Azure",
                                "Extension managed by Azure."
                              ]
                            ]
                          }
                        },
                        {
                          "@removed_a0b00682c9644fc69f84fcb03513fd07": {
                            "#name": "exception",
                            "Description": "Exception details while installing Arc extension.",
                            "Required": false,
                            "Type": "string"
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/edgeMachines/{edgeMachineName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
edgeMachineName:
{
Description: Name of Device ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
edgeMachineKind:
{
Description: Edge Machine type. ,
Enum:
{
Standard: EdgeMachine resource created using Zero-touch provisioning. ,
Dedicated: EdgeMachine resource created for brownfield HCI customers without zero touch provisioning. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The provisioning state of a resource. ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
cloudId:
{
Description: Unique, immutable resource id. ,
Required: False ,
}
string ,
arcMachineResourceGroupId:
{
Description: Optional property to create arc machine in custom resource group. ,
Format: arm-id ,
Required: False ,
}
string ,
arcMachineResourceId:
{
Description: Arc machine instance resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
arcGatewayResourceId:
{
Description: Link to Arc Gateway ARM resource Id ,
Format: arm-id ,
Required: False ,
}
string ,
siteDetails:
{
Description: Service fetches common configuration from site. ,
Required: False ,
}
{
siteResourceId:
{
Description: Site resource Id to be set during Edge Machine resource creation. ,
Format: arm-id ,
Required: True ,
}
string ,
deviceConfiguration:
{
Description: Edge Device configuration received from site common configuration. ,
Required: False ,
}
{
nicDetails:
{
Description: NIC Details of device ,
Required: False ,
}
[
{
adapterName:
{
Description: Adapter Name of NIC ,
Required: False ,
}
string ,
interfaceDescription:
{
Description: Interface Description of NIC ,
Required: False ,
}
string ,
componentId:
{
Description: Component Id of NIC ,
Required: False ,
}
string ,
driverVersion:
{
Description: Driver Version of NIC ,
Required: False ,
}
string ,
ip4Address:
{
Description: Subnet Mask of NIC ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet Mask of NIC ,
Required: False ,
}
string ,
defaultGateway:
{
Description: Default Gateway of NIC ,
Required: False ,
}
string ,
dnsServers:
{
Description: DNS Servers for NIC ,
Required: False ,
}
[
string ,
]
,
defaultIsolationId:
{
Description: Default Isolation of Management NIC ,
Required: False ,
}
string ,
}
,
]
,
deviceMetadata:
{
Description: Device metadata details. ,
Required: False ,
}
string ,
}
,
}
,
ownershipVoucherDetails:
{
Description: Ownership voucher details for provisioned machine. ,
Required: False ,
}
{
ownershipVoucher:
{
Description: Ownership voucher in base64 encoded format ,
Format: password ,
Required: True ,
}
string ,
ownerKeyType:
{
Description: Owner key type ,
Enum:
{
MicrosoftManaged: Owner is Microsoft managed key ,
}
,
Required: True ,
}
enum ,
}
,
provisioningDetails:
{
Description: Details for device provisioning. ,
Required: False ,
}
{
osProfile:
{
Description: Operating system profile. ,
Required: True ,
}
{
osName:
{
Description: Name of the operating system. ,
Required: False ,
}
string ,
osType:
{
Description: Type of the operating system. ,
Required: False ,
}
string ,
osVersion:
{
Description: Version of the operating system. ,
Required: False ,
}
string ,
osImageLocation:
{
Description: Location of the operating system image. ,
Required: False ,
}
string ,
vsrVersion:
{
Description: Validated Solution Recipe version to be used for the job ,
Required: False ,
}
string ,
imageHash:
{
Description: Hash of the OS package downloaded ,
Required: False ,
}
string ,
gpgPubKey:
{
Description: GPG Public Key used for package verification ,
Required: False ,
}
string ,
operationType:
{
Description: Operation sub type of OS Provisioning ,
Enum:
{
Provision: OS Provisioning operation ,
Update: OS Update operation ,
ReImage: OS ReImage operation ,
}
,
Required: False ,
}
enum ,
}
,
userDetails:
{
Description: User configuration. ,
Required: False ,
}
[
{
userName:
{
Description: Name of the user. ,
Required: True ,
}
string ,
secretType:
{
Description: Type of the secret used for authentication. ,
Enum:
{
KeyVault: Key Vault based authentication ,
SshPubKey: SSH Public Key based authentication ,
}
,
Required: True ,
}
enum ,
secretLocation:
{
Description: Location of the secret used for authentication. ,
Required: False ,
}
string ,
sshPubKey:
{
Description: SSH Public Key for the user. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
devicePoolResourceId:
{
Description: A machine can only be assigned to single device pool ,
Required: False ,
}
string ,
machineState:
{
Description: OS configuration status details ,
Enum:
{
Created: Created when EdgeMachine resource created ,
Registering: EdgeMachine state during device discovery and registration ,
Unpurposed: EdgeMachine state when machine configured with restricted OS and not provisioned to deploy workloads ,
Transitioning: EdgeMachine state when transitioning from initial OS to target OS ,
Purposed: EdgeMachine state when machine configured with target OS to deploy workloads ,
Updating: EdgeMachine state when OS updates are in-progress ,
Resetting: EdgeMachine state when transitioning from target OS to restricted OS ,
Failed: EdgeMachine failed state and only option to recover is to re-provisioning machine ,
Preparing: Preparing EdgeMachine ,
}
,
Required: False ,
}
enum ,
connectivityStatus:
{
Description: machine connectivity status ,
Enum:
{
NotSpecified: The connectivity status of the machine resource is not specified. ,
Disconnected: The machine resource is disconnected. ,
Connected: The machine resource is connected. ,
}
,
Required: False ,
}
enum ,
claimedBy:
{
Description: Tracks the ID of the consuming resource, setting the machine as in-use. ,
Required: False ,
}
string ,
reportedProperties:
{
Description: Reported properties for edge machine. ,
Required: False ,
}
{
lastUpdated:
{
Description: Last time data reported. ,
Format: date-time ,
Required: False ,
}
string ,
networkProfile:
{
Description: Network details for edge machine. ,
Required: False ,
}
{
nicDetails:
{
Description: List of Network Interface Card (NIC) Details of edge machine. ,
Required: False ,
}
[
{
adapterName:
{
Description: Adapter Name of NIC ,
Required: False ,
}
string ,
interfaceDescription:
{
Description: Interface Description of NIC ,
Required: False ,
}
string ,
componentId:
{
Description: Component Id of NIC ,
Required: False ,
}
string ,
driverVersion:
{
Description: Driver Version of NIC ,
Required: False ,
}
string ,
ip4Address:
{
Description: Subnet Mask of NIC ,
Required: False ,
}
string ,
subnetMask:
{
Description: Subnet Mask of NIC ,
Required: False ,
}
string ,
defaultGateway:
{
Description: Default Gateway of NIC ,
Required: False ,
}
string ,
dnsServers:
{
Description: DNS Servers for NIC ,
Required: False ,
}
[
string ,
]
,
defaultIsolationId:
{
Description: Default Isolation of Management NIC ,
Required: False ,
}
string ,
macAddress:
{
Description: MAC address information of NIC. ,
Required: False ,
}
string ,
slot:
{
Description: The slot attached to the NIC. ,
Required: False ,
}
string ,
switchName:
{
Description: The switch attached to the NIC, if any. ,
Required: False ,
}
string ,
nicType:
{
Description: The type of NIC, physical, virtual, management. ,
Required: False ,
}
string ,
vlanId:
{
Description: The VLAN ID of the physical NIC. ,
Required: False ,
}
string ,
nicStatus:
{
Description: The status of NIC, up, disconnected. ,
Required: False ,
}
string ,
rdmaCapability:
{
Description: Describes the RDMA capability of the network adapter. ,
Enum:
{
Enabled: Network Adapter on the device is RDMA Capable ,
Disabled: Network Adapter on the device is RDMA Capable ,
}
,
Required: False ,
}
enum ,
}
,
]
,
switchDetails:
{
Description: List of switch Details of edge machine. ,
Required: False ,
}
[
{
switchName:
{
Description: The name of the switch. ,
Required: False ,
}
string ,
switchType:
{
Description: The type of the switch. e.g. external, internal. ,
Required: False ,
}
string ,
extensions:
{
Description: This represents extensions installed on virtualSwitch. ,
Required: False ,
}
[
{
switchId:
{
Description: Unique identifier for virtualSwitch. ,
Required: False ,
}
string ,
extensionName:
{
Description: This will show extension name for virtualSwitch. ,
Required: False ,
}
string ,
extensionEnabled:
{
Description: This represents whether extension is enabled on virtualSwitch. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
}
,
osProfile:
{
Description: OS Properties for edge machine. ,
Required: False ,
}
{
bootType:
{
Description: The boot type of the device. e.g. UEFI, Legacy etc ,
Required: False ,
}
string ,
assemblyVersion:
{
Description: Version of assembly present on device ,
Required: False ,
}
string ,
osType:
{
Description: OS type (“windows", “linux”) ,
Required: False ,
}
string ,
osSku:
{
Description: OS SKU (e.g., “ Microsoft Azure Linux ROE“, “Azure Stack HCI", "Microsoft Azure Linux 3.0") ,
Required: False ,
}
string ,
osVersion:
{
Description: OS Version ,
Required: False ,
}
string ,
buildNumber:
{
Description: OS Build Number ,
Required: False ,
}
string ,
baseImageVersion:
{
Description: OS Base Image Version ,
Required: False ,
}
string ,
imageVersion:
{
Description: OS Image Version ,
Required: False ,
}
string ,
}
,
hardwareProfile:
{
Description: Hardware related information for edge machine. ,
Required: False ,
}
{
cpuCores:
{
Description: Number of cpu cores in the machine ,
Format: int64 ,
Required: False ,
}
integer ,
cpuSockets:
{
Description: Number of cpu sockets in the machine ,
Format: int64 ,
Required: False ,
}
integer ,
memoryCapacityInGb:
{
Description: Memory capacity of the machine ,
Format: int64 ,
Required: False ,
}
integer ,
model:
{
Description: Model info of the machine ,
Required: False ,
}
string ,
manufacturer:
{
Description: manufacturer info of the machine ,
Required: False ,
}
string ,
serialNumber:
{
Description: Serial number of the machine ,
Required: False ,
}
string ,
processorType:
{
Description: Process type of the machine ,
Required: False ,
}
string ,
}
,
storageProfile:
{
Description: Storage related information for edge machine. ,
Required: False ,
}
{
poolableDisksCount:
{
Description: Number of storage disks in the device with $CanPool as true. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
sbeDeploymentPackageInfo:
{
Description: Solution builder extension (SBE) deployment package information. ,
Required: False ,
}
{
code:
{
Description: SBE deployment validation code. ,
Required: False ,
}
string ,
message:
{
Description: A detailed message that explains the SBE package validation result. ,
Required: False ,
}
string ,
sbeManifest:
{
Description: This represents discovered update results for matching updates and store it as SBE manifest. ,
Required: False ,
}
string ,
}
,
extensionProfile:
{
Description: Extension details for edge machine. ,
Required: False ,
}
{
extensions:
{
Description: List of Arc extensions installed on edge device. ,
Required: False ,
}
[
{
extensionName:
{
Description: Arc extension name installed on edge device. ,
Required: False ,
}
string ,
state:
{
Description: Arc extension state from arc machine extension. ,
Enum:
{
NotSpecified: Arc extension state is not specified. ,
Succeeded: Arc extension state is Succeeded. ,
Failed: Arc extension state is Failed. ,
Canceled: Arc extension state is Canceled. ,
Accepted: Arc extension state is Accepted when extension installation triggered. ,
Creating: Arc extension is in Creating State. ,
Updating: Arc extension is in Updating State. ,
Moving: Arc extension is in Moving State. ,
Deleting: Arc extension is in Deleting State. ,
Deleted: Arc extension is in Deleted State. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details while installing Arc extension. ,
Required: False ,
}
[
{
exception:
{
Description: Exception details while installing extension. ,
Required: False ,
}
string ,
}
,
]
,
extensionResourceId:
{
Description: Arc Extension Azure resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Extension version installed. ,
Required: False ,
}
string ,
managedBy:
{
Description: Indicates whether the extension is managed by the user or by Azure. ,
Enum:
{
User: The extension is managed by the user. ,
Azure: The extension is managed by Azure. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
operationDetails:
{
Description: operation status details for edge machine. ,
Required: False ,
}
[
{
name:
{
Description: operation name. ,
Required: False ,
}
string ,
id:
{
Description: operation id. ,
Required: False ,
}
string ,
type:
{
Description: operation type. ,
Required: False ,
}
string ,
resourceId:
{
Description: operation resource id. ,
Format: arm-id ,
Required: False ,
}
string ,
description:
{
Description: operation description. ,
Required: False ,
}
string ,
status:
{
Description: operation status. ,
Required: False ,
}
string ,
error:
{
Description: error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
]
,
lastSyncTimestamp:
{
Description: Last time data updated to service. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EdgeMachineJobs_List (updated)
Description :  List EdgeMachineJob resources by EdgeMachines
Reference :  Link ¶

⚶ Changes

{
  "#id": "EdgeMachineJobs_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "#name": "provisioningState",
                "Enum": {
                  "new": [
                    [
                      "NotSpecified",
                      "The provisioning state is not specified."
                    ],
                    [
                      "Error",
                      "An error occurred during provisioning."
                    ],
                    [
                      "Succeeded",
                      "Provisioning completed successfully."
                    ],
                    [
                      "Failed",
                      "Provisioning failed."
                    ],
                    [
                      "Canceled",
                      "Provisioning was canceled."
                    ],
                    [
                      "Connected",
                      "The resource is connected."
                    ],
                    [
                      "Disconnected",
                      "The resource is disconnected."
                    ],
                    [
                      "Deleted",
                      "The resource has been deleted."
                    ],
                    [
                      "Creating",
                      "The resource is being created."
                    ],
                    [
                      "Updating",
                      "The resource is being updated."
                    ],
                    [
                      "Deleting",
                      "The resource is being deleted."
                    ],
                    [
                      "Moving",
                      "The resource is being moved."
                    ],
                    [
                      "PartiallySucceeded",
                      "Provisioning partially succeeded."
                    ],
                    [
                      "PartiallyConnected",
                      "The resource is partially connected."
                    ],
                    [
                      "InProgress",
                      "Provisioning is in progress."
                    ],
                    [
                      "Accepted",
                      "Provisioning request has been accepted."
                    ],
                    [
                      "Provisioning",
                      "The resource is currently provisioning."
                    ],
                    [
                      "DisableInProgress",
                      "The resource is being disabled."
                    ]
                  ],
                  "old": [
                    [
                      "NotSpecified",
                      "The resource provision state is not specified"
                    ],
                    [
                      "Succeeded",
                      "Resource has been created."
                    ],
                    [
                      "Failed",
                      "Resource creation failed."
                    ],
                    [
                      "Canceled",
                      "Resource creation was canceled."
                    ],
                    [
                      "InProgress",
                      "Resource creation is in progress."
                    ],
                    [
                      "Provisioning",
                      "The resource is being provisioned"
                    ],
                    [
                      "Updating",
                      "The resource is updating"
                    ],
                    [
                      "Deleting",
                      "The resource is being deleted"
                    ],
                    [
                      "Accepted",
                      "The resource create request has been accepted"
                    ]
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/edgeMachines/{edgeMachineName}/jobs
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
edgeMachineName:
{
Description: Name of Device ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The EdgeMachineJob items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
jobType:
{
Description: Job Type to support polymorphic resource. ,
Enum:
{
CollectLog: Job to collect logs from the device. ,
RemoteSupport: Job to provide remote support to the device. ,
ProvisionOs: Job to provision operating system in the device. ,
DownloadOs: Job to download OS packages on to the device ,
}
,
Required: True ,
}
enum ,
deploymentMode:
{
Description: Deployment mode to trigger job. ,
Enum:
{
Validate: Validate ECE action deployment for a cluster. ,
Deploy: Deploy ECE action deployment for a cluster. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Job provisioning state ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
jobId:
{
Description: Unique, immutable job id. ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: The UTC date and time at which the job started. ,
Format: date-time ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: The UTC date and time at which the job completed. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Status of Edge device job. ,
Enum:
{
NotSpecified: The job status has not been specified. ,
ValidationInProgress: The job is currently undergoing validation. ,
ValidationSuccess: The job has successfully passed validation. ,
ValidationFailed: The job has failed validation. ,
DeploymentInProgress: The job's deployment is currently in progress. ,
DeploymentFailed: The job's deployment has failed. ,
DeploymentSuccess: The job has been successfully deployed. ,
Succeeded: The job has succeeded. ,
Failed: The job has failed. ,
Canceled: The job has been canceled. ,
Paused: The job is paused. ,
Scheduled: The job is scheduled to run. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EdgeMachineJobs_Get (updated)
Description :  Get a EdgeMachineJob
Reference :  Link ¶

⚶ Changes

{
  "#id": "EdgeMachineJobs_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "NotSpecified",
                  "The provisioning state is not specified."
                ],
                [
                  "Error",
                  "An error occurred during provisioning."
                ],
                [
                  "Succeeded",
                  "Provisioning completed successfully."
                ],
                [
                  "Failed",
                  "Provisioning failed."
                ],
                [
                  "Canceled",
                  "Provisioning was canceled."
                ],
                [
                  "Connected",
                  "The resource is connected."
                ],
                [
                  "Disconnected",
                  "The resource is disconnected."
                ],
                [
                  "Deleted",
                  "The resource has been deleted."
                ],
                [
                  "Creating",
                  "The resource is being created."
                ],
                [
                  "Updating",
                  "The resource is being updated."
                ],
                [
                  "Deleting",
                  "The resource is being deleted."
                ],
                [
                  "Moving",
                  "The resource is being moved."
                ],
                [
                  "PartiallySucceeded",
                  "Provisioning partially succeeded."
                ],
                [
                  "PartiallyConnected",
                  "The resource is partially connected."
                ],
                [
                  "InProgress",
                  "Provisioning is in progress."
                ],
                [
                  "Accepted",
                  "Provisioning request has been accepted."
                ],
                [
                  "Provisioning",
                  "The resource is currently provisioning."
                ],
                [
                  "DisableInProgress",
                  "The resource is being disabled."
                ]
              ],
              "old": [
                [
                  "NotSpecified",
                  "The resource provision state is not specified"
                ],
                [
                  "Succeeded",
                  "Resource has been created."
                ],
                [
                  "Failed",
                  "Resource creation failed."
                ],
                [
                  "Canceled",
                  "Resource creation was canceled."
                ],
                [
                  "InProgress",
                  "Resource creation is in progress."
                ],
                [
                  "Provisioning",
                  "The resource is being provisioned"
                ],
                [
                  "Updating",
                  "The resource is updating"
                ],
                [
                  "Deleting",
                  "The resource is being deleted"
                ],
                [
                  "Accepted",
                  "The resource create request has been accepted"
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/edgeMachines/{edgeMachineName}/jobs/{jobsName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
edgeMachineName:
{
Description: Name of Device ,
Required: True ,
}
string ,
jobsName:
{
Description: Name of EdgeMachineJob ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
jobType:
{
Description: Job Type to support polymorphic resource. ,
Enum:
{
CollectLog: Job to collect logs from the device. ,
RemoteSupport: Job to provide remote support to the device. ,
ProvisionOs: Job to provision operating system in the device. ,
DownloadOs: Job to download OS packages on to the device ,
}
,
Required: True ,
}
enum ,
deploymentMode:
{
Description: Deployment mode to trigger job. ,
Enum:
{
Validate: Validate ECE action deployment for a cluster. ,
Deploy: Deploy ECE action deployment for a cluster. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Job provisioning state ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
jobId:
{
Description: Unique, immutable job id. ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: The UTC date and time at which the job started. ,
Format: date-time ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: The UTC date and time at which the job completed. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Status of Edge device job. ,
Enum:
{
NotSpecified: The job status has not been specified. ,
ValidationInProgress: The job is currently undergoing validation. ,
ValidationSuccess: The job has successfully passed validation. ,
ValidationFailed: The job has failed validation. ,
DeploymentInProgress: The job's deployment is currently in progress. ,
DeploymentFailed: The job's deployment has failed. ,
DeploymentSuccess: The job has been successfully deployed. ,
Succeeded: The job has succeeded. ,
Failed: The job has failed. ,
Canceled: The job has been canceled. ,
Paused: The job is paused. ,
Scheduled: The job is scheduled to run. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EdgeMachineJobs_CreateOrUpdate (updated)
Description :  Create a EdgeMachineJob
Reference :  Link ¶

⚶ Changes

{
  "#id": "EdgeMachineJobs_CreateOrUpdate",
  "$parameters": {
    "resource": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "NotSpecified",
                  "The provisioning state is not specified."
                ],
                [
                  "Error",
                  "An error occurred during provisioning."
                ],
                [
                  "Succeeded",
                  "Provisioning completed successfully."
                ],
                [
                  "Failed",
                  "Provisioning failed."
                ],
                [
                  "Canceled",
                  "Provisioning was canceled."
                ],
                [
                  "Connected",
                  "The resource is connected."
                ],
                [
                  "Disconnected",
                  "The resource is disconnected."
                ],
                [
                  "Deleted",
                  "The resource has been deleted."
                ],
                [
                  "Creating",
                  "The resource is being created."
                ],
                [
                  "Updating",
                  "The resource is being updated."
                ],
                [
                  "Deleting",
                  "The resource is being deleted."
                ],
                [
                  "Moving",
                  "The resource is being moved."
                ],
                [
                  "PartiallySucceeded",
                  "Provisioning partially succeeded."
                ],
                [
                  "PartiallyConnected",
                  "The resource is partially connected."
                ],
                [
                  "InProgress",
                  "Provisioning is in progress."
                ],
                [
                  "Accepted",
                  "Provisioning request has been accepted."
                ],
                [
                  "Provisioning",
                  "The resource is currently provisioning."
                ],
                [
                  "DisableInProgress",
                  "The resource is being disabled."
                ]
              ],
              "old": [
                [
                  "NotSpecified",
                  "The resource provision state is not specified"
                ],
                [
                  "Succeeded",
                  "Resource has been created."
                ],
                [
                  "Failed",
                  "Resource creation failed."
                ],
                [
                  "Canceled",
                  "Resource creation was canceled."
                ],
                [
                  "InProgress",
                  "Resource creation is in progress."
                ],
                [
                  "Provisioning",
                  "The resource is being provisioned"
                ],
                [
                  "Updating",
                  "The resource is updating"
                ],
                [
                  "Deleting",
                  "The resource is being deleted"
                ],
                [
                  "Accepted",
                  "The resource create request has been accepted"
                ]
              ]
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "NotSpecified",
                  "The provisioning state is not specified."
                ],
                [
                  "Error",
                  "An error occurred during provisioning."
                ],
                [
                  "Succeeded",
                  "Provisioning completed successfully."
                ],
                [
                  "Failed",
                  "Provisioning failed."
                ],
                [
                  "Canceled",
                  "Provisioning was canceled."
                ],
                [
                  "Connected",
                  "The resource is connected."
                ],
                [
                  "Disconnected",
                  "The resource is disconnected."
                ],
                [
                  "Deleted",
                  "The resource has been deleted."
                ],
                [
                  "Creating",
                  "The resource is being created."
                ],
                [
                  "Updating",
                  "The resource is being updated."
                ],
                [
                  "Deleting",
                  "The resource is being deleted."
                ],
                [
                  "Moving",
                  "The resource is being moved."
                ],
                [
                  "PartiallySucceeded",
                  "Provisioning partially succeeded."
                ],
                [
                  "PartiallyConnected",
                  "The resource is partially connected."
                ],
                [
                  "InProgress",
                  "Provisioning is in progress."
                ],
                [
                  "Accepted",
                  "Provisioning request has been accepted."
                ],
                [
                  "Provisioning",
                  "The resource is currently provisioning."
                ],
                [
                  "DisableInProgress",
                  "The resource is being disabled."
                ]
              ],
              "old": [
                [
                  "NotSpecified",
                  "The resource provision state is not specified"
                ],
                [
                  "Succeeded",
                  "Resource has been created."
                ],
                [
                  "Failed",
                  "Resource creation failed."
                ],
                [
                  "Canceled",
                  "Resource creation was canceled."
                ],
                [
                  "InProgress",
                  "Resource creation is in progress."
                ],
                [
                  "Provisioning",
                  "The resource is being provisioned"
                ],
                [
                  "Updating",
                  "The resource is updating"
                ],
                [
                  "Deleting",
                  "The resource is being deleted"
                ],
                [
                  "Accepted",
                  "The resource create request has been accepted"
                ]
              ]
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "NotSpecified",
                  "The provisioning state is not specified."
                ],
                [
                  "Error",
                  "An error occurred during provisioning."
                ],
                [
                  "Succeeded",
                  "Provisioning completed successfully."
                ],
                [
                  "Failed",
                  "Provisioning failed."
                ],
                [
                  "Canceled",
                  "Provisioning was canceled."
                ],
                [
                  "Connected",
                  "The resource is connected."
                ],
                [
                  "Disconnected",
                  "The resource is disconnected."
                ],
                [
                  "Deleted",
                  "The resource has been deleted."
                ],
                [
                  "Creating",
                  "The resource is being created."
                ],
                [
                  "Updating",
                  "The resource is being updated."
                ],
                [
                  "Deleting",
                  "The resource is being deleted."
                ],
                [
                  "Moving",
                  "The resource is being moved."
                ],
                [
                  "PartiallySucceeded",
                  "Provisioning partially succeeded."
                ],
                [
                  "PartiallyConnected",
                  "The resource is partially connected."
                ],
                [
                  "InProgress",
                  "Provisioning is in progress."
                ],
                [
                  "Accepted",
                  "Provisioning request has been accepted."
                ],
                [
                  "Provisioning",
                  "The resource is currently provisioning."
                ],
                [
                  "DisableInProgress",
                  "The resource is being disabled."
                ]
              ],
              "old": [
                [
                  "NotSpecified",
                  "The resource provision state is not specified"
                ],
                [
                  "Succeeded",
                  "Resource has been created."
                ],
                [
                  "Failed",
                  "Resource creation failed."
                ],
                [
                  "Canceled",
                  "Resource creation was canceled."
                ],
                [
                  "InProgress",
                  "Resource creation is in progress."
                ],
                [
                  "Provisioning",
                  "The resource is being provisioned"
                ],
                [
                  "Updating",
                  "The resource is updating"
                ],
                [
                  "Deleting",
                  "The resource is being deleted"
                ],
                [
                  "Accepted",
                  "The resource create request has been accepted"
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/edgeMachines/{edgeMachineName}/jobs/{jobsName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
edgeMachineName:
{
Description: Name of Device ,
Required: True ,
}
string ,
jobsName:
{
Description: Name of EdgeMachineJob ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
jobType:
{
Description: Job Type to support polymorphic resource. ,
Enum:
{
CollectLog: Job to collect logs from the device. ,
RemoteSupport: Job to provide remote support to the device. ,
ProvisionOs: Job to provision operating system in the device. ,
DownloadOs: Job to download OS packages on to the device ,
}
,
Required: True ,
}
enum ,
deploymentMode:
{
Description: Deployment mode to trigger job. ,
Enum:
{
Validate: Validate ECE action deployment for a cluster. ,
Deploy: Deploy ECE action deployment for a cluster. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Job provisioning state ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
jobId:
{
Description: Unique, immutable job id. ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: The UTC date and time at which the job started. ,
Format: date-time ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: The UTC date and time at which the job completed. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Status of Edge device job. ,
Enum:
{
NotSpecified: The job status has not been specified. ,
ValidationInProgress: The job is currently undergoing validation. ,
ValidationSuccess: The job has successfully passed validation. ,
ValidationFailed: The job has failed validation. ,
DeploymentInProgress: The job's deployment is currently in progress. ,
DeploymentFailed: The job's deployment has failed. ,
DeploymentSuccess: The job has been successfully deployed. ,
Succeeded: The job has succeeded. ,
Failed: The job has failed. ,
Canceled: The job has been canceled. ,
Paused: The job is paused. ,
Scheduled: The job is scheduled to run. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
jobType:
{
Description: Job Type to support polymorphic resource. ,
Enum:
{
CollectLog: Job to collect logs from the device. ,
RemoteSupport: Job to provide remote support to the device. ,
ProvisionOs: Job to provision operating system in the device. ,
DownloadOs: Job to download OS packages on to the device ,
}
,
Required: True ,
}
enum ,
deploymentMode:
{
Description: Deployment mode to trigger job. ,
Enum:
{
Validate: Validate ECE action deployment for a cluster. ,
Deploy: Deploy ECE action deployment for a cluster. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Job provisioning state ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
jobId:
{
Description: Unique, immutable job id. ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: The UTC date and time at which the job started. ,
Format: date-time ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: The UTC date and time at which the job completed. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Status of Edge device job. ,
Enum:
{
NotSpecified: The job status has not been specified. ,
ValidationInProgress: The job is currently undergoing validation. ,
ValidationSuccess: The job has successfully passed validation. ,
ValidationFailed: The job has failed validation. ,
DeploymentInProgress: The job's deployment is currently in progress. ,
DeploymentFailed: The job's deployment has failed. ,
DeploymentSuccess: The job has been successfully deployed. ,
Succeeded: The job has succeeded. ,
Failed: The job has failed. ,
Canceled: The job has been canceled. ,
Paused: The job is paused. ,
Scheduled: The job is scheduled to run. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Cluster Jobs resource ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
jobType:
{
Description: Job Type to support polymorphic resource. ,
Enum:
{
CollectLog: Job to collect logs from the device. ,
RemoteSupport: Job to provide remote support to the device. ,
ProvisionOs: Job to provision operating system in the device. ,
DownloadOs: Job to download OS packages on to the device ,
}
,
Required: True ,
}
enum ,
deploymentMode:
{
Description: Deployment mode to trigger job. ,
Enum:
{
Validate: Validate ECE action deployment for a cluster. ,
Deploy: Deploy ECE action deployment for a cluster. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: Job provisioning state ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
jobId:
{
Description: Unique, immutable job id. ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: The UTC date and time at which the job started. ,
Format: date-time ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: The UTC date and time at which the job completed. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Status of Edge device job. ,
Enum:
{
NotSpecified: The job status has not been specified. ,
ValidationInProgress: The job is currently undergoing validation. ,
ValidationSuccess: The job has successfully passed validation. ,
ValidationFailed: The job has failed validation. ,
DeploymentInProgress: The job's deployment is currently in progress. ,
DeploymentFailed: The job's deployment has failed. ,
DeploymentSuccess: The job has been successfully deployed. ,
Succeeded: The job has succeeded. ,
Failed: The job has failed. ,
Canceled: The job has been canceled. ,
Paused: The job is paused. ,
Scheduled: The job is scheduled to run. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: error details. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ArcSettings_ListByCluster (removed)
Description :  Get ArcSetting resources of HCI Cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ArcSetting items on this page ,
Required: True ,
}
[
{
properties:
{
Description: ArcSetting properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the ArcSetting proxy resource. ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
arcInstanceResourceGroup:
{
Description: The resource group that hosts the Arc agents, ie. Hybrid Compute Machine resources. ,
Required: False ,
}
string ,
arcApplicationClientId:
{
Description: App id of arc AAD identity. ,
Required: False ,
}
string ,
arcApplicationTenantId:
{
Description: Tenant id of arc AAD identity. ,
Required: False ,
}
string ,
arcServicePrincipalObjectId:
{
Description: Object id of arc AAD service principal. ,
Required: False ,
}
string ,
arcApplicationObjectId:
{
Description: Object id of arc AAD identity. ,
Required: False ,
}
string ,
aggregateState:
{
Description: Aggregate state of Arc agent across the nodes in this HCI cluster. ,
Enum:
{
NotSpecified: The aggregate state is not specified. ,
Error: An error occurred in the aggregate state. ,
Succeeded: The operation successfully completed across all nodes. ,
Canceled: The operation was canceled across the nodes. ,
Failed: The operation failed on all or most nodes. ,
Connected: All nodes are connected. ,
Disconnected: All nodes are disconnected. ,
Deleted: The Arc agent has been deleted from all nodes. ,
Creating: The Arc agent is being created across the nodes. ,
Updating: The Arc agent is being updated across the nodes. ,
Deleting: The Arc agent is being deleted across the nodes. ,
Moving: The Arc agent is being moved across the nodes. ,
PartiallySucceeded: The operation succeeded on some nodes. ,
PartiallyConnected: Some nodes are connected, others are not. ,
InProgress: The operation is currently in progress across the nodes. ,
Accepted: The operation has been accepted and is pending execution. ,
Provisioning: The Arc agent is being provisioned across the nodes. ,
DisableInProgress: The Arc agent is being disabled across the nodes. ,
}
,
Required: False ,
}
enum ,
perNodeDetails:
{
Description: State of Arc agent in each of the nodes. ,
Required: False ,
}
[
{
name:
{
Description: Name of the Node in HCI Cluster ,
Required: False ,
}
string ,
arcInstance:
{
Description: Fully qualified resource ID for the Arc agent of this node. ,
Required: False ,
}
string ,
arcNodeServicePrincipalObjectId:
{
Description: The service principal id of the arc for server node ,
Required: False ,
}
string ,
state:
{
Description: State of the Arc agent in this node. Indicates the current lifecycle status of the agent, such as whether it's being provisioned, connected, updated, or has encountered an error. ,
Enum:
{
NotSpecified: The state is not specified. ,
Error: An error occurred during the agent's lifecycle. ,
Succeeded: The operation completed successfully. ,
Canceled: The operation was canceled before completion. ,
Failed: The operation failed. ,
Connected: The Arc agent is connected on this node. ,
Disconnected: The Arc agent is disconnected on this node. ,
Deleted: The Arc agent has been deleted from this node. ,
Creating: The Arc agent is being created on this node. ,
Updating: The Arc agent is being updated on this node. ,
Deleting: The Arc agent is being deleted from this node. ,
Moving: The Arc agent is being moved on this node. ,
PartiallySucceeded: The operation partially succeeded. ,
PartiallyConnected: The Arc agent is partially connected on this node. ,
InProgress: The operation is currently in progress. ,
Accepted: The operation has been accepted and is pending execution. ,
Provisioning: The Arc agent is currently being provisioned on this node. ,
DisableInProgress: The Arc agent is in the process of being disabled on this node. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
connectivityProperties:
{
Description: contains connectivity related configuration for ARC resources ,
Required: False ,
}
{
enabled:
{
Description: True indicates ARC connectivity is enabled ,
Required: False ,
}
boolean ,
serviceConfigurations:
{
Description: Service configurations associated with the connectivity resource. They are only processed by the server if 'enabled' property is set to 'true'. ,
Required: False ,
}
[
{
serviceName:
{
Description: Specifies the name of the service associated with the update or operation. This helps identify which system component or tool is involved. ,
Enum:
{
WAC: Windows Admin Center (WAC) is the service associated with this operation. ,
}
,
Required: True ,
}
enum ,
port:
{
Description: The port on which service is enabled. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
defaultExtensions:
{
Description: Properties for each of the default extensions category ,
Required: False ,
}
[
{
category:
{
Description: Default extension category ,
Required: False ,
}
string ,
consentTime:
{
Description: Consent time for extension category ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ArcSettings_Get (removed)
Description :  Get ArcSetting resource details of HCI Cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
arcSettingName:
{
Description: The name of the proxy resource holding details of HCI ArcSetting information. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: ArcSetting properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the ArcSetting proxy resource. ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
arcInstanceResourceGroup:
{
Description: The resource group that hosts the Arc agents, ie. Hybrid Compute Machine resources. ,
Required: False ,
}
string ,
arcApplicationClientId:
{
Description: App id of arc AAD identity. ,
Required: False ,
}
string ,
arcApplicationTenantId:
{
Description: Tenant id of arc AAD identity. ,
Required: False ,
}
string ,
arcServicePrincipalObjectId:
{
Description: Object id of arc AAD service principal. ,
Required: False ,
}
string ,
arcApplicationObjectId:
{
Description: Object id of arc AAD identity. ,
Required: False ,
}
string ,
aggregateState:
{
Description: Aggregate state of Arc agent across the nodes in this HCI cluster. ,
Enum:
{
NotSpecified: The aggregate state is not specified. ,
Error: An error occurred in the aggregate state. ,
Succeeded: The operation successfully completed across all nodes. ,
Canceled: The operation was canceled across the nodes. ,
Failed: The operation failed on all or most nodes. ,
Connected: All nodes are connected. ,
Disconnected: All nodes are disconnected. ,
Deleted: The Arc agent has been deleted from all nodes. ,
Creating: The Arc agent is being created across the nodes. ,
Updating: The Arc agent is being updated across the nodes. ,
Deleting: The Arc agent is being deleted across the nodes. ,
Moving: The Arc agent is being moved across the nodes. ,
PartiallySucceeded: The operation succeeded on some nodes. ,
PartiallyConnected: Some nodes are connected, others are not. ,
InProgress: The operation is currently in progress across the nodes. ,
Accepted: The operation has been accepted and is pending execution. ,
Provisioning: The Arc agent is being provisioned across the nodes. ,
DisableInProgress: The Arc agent is being disabled across the nodes. ,
}
,
Required: False ,
}
enum ,
perNodeDetails:
{
Description: State of Arc agent in each of the nodes. ,
Required: False ,
}
[
{
name:
{
Description: Name of the Node in HCI Cluster ,
Required: False ,
}
string ,
arcInstance:
{
Description: Fully qualified resource ID for the Arc agent of this node. ,
Required: False ,
}
string ,
arcNodeServicePrincipalObjectId:
{
Description: The service principal id of the arc for server node ,
Required: False ,
}
string ,
state:
{
Description: State of the Arc agent in this node. Indicates the current lifecycle status of the agent, such as whether it's being provisioned, connected, updated, or has encountered an error. ,
Enum:
{
NotSpecified: The state is not specified. ,
Error: An error occurred during the agent's lifecycle. ,
Succeeded: The operation completed successfully. ,
Canceled: The operation was canceled before completion. ,
Failed: The operation failed. ,
Connected: The Arc agent is connected on this node. ,
Disconnected: The Arc agent is disconnected on this node. ,
Deleted: The Arc agent has been deleted from this node. ,
Creating: The Arc agent is being created on this node. ,
Updating: The Arc agent is being updated on this node. ,
Deleting: The Arc agent is being deleted from this node. ,
Moving: The Arc agent is being moved on this node. ,
PartiallySucceeded: The operation partially succeeded. ,
PartiallyConnected: The Arc agent is partially connected on this node. ,
InProgress: The operation is currently in progress. ,
Accepted: The operation has been accepted and is pending execution. ,
Provisioning: The Arc agent is currently being provisioned on this node. ,
DisableInProgress: The Arc agent is in the process of being disabled on this node. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
connectivityProperties:
{
Description: contains connectivity related configuration for ARC resources ,
Required: False ,
}
{
enabled:
{
Description: True indicates ARC connectivity is enabled ,
Required: False ,
}
boolean ,
serviceConfigurations:
{
Description: Service configurations associated with the connectivity resource. They are only processed by the server if 'enabled' property is set to 'true'. ,
Required: False ,
}
[
{
serviceName:
{
Description: Specifies the name of the service associated with the update or operation. This helps identify which system component or tool is involved. ,
Enum:
{
WAC: Windows Admin Center (WAC) is the service associated with this operation. ,
}
,
Required: True ,
}
enum ,
port:
{
Description: The port on which service is enabled. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
defaultExtensions:
{
Description: Properties for each of the default extensions category ,
Required: False ,
}
[
{
category:
{
Description: Default extension category ,
Required: False ,
}
string ,
consentTime:
{
Description: Consent time for extension category ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ArcSettings_Create (removed)
Description :  Create ArcSetting for HCI cluster.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
arcSettingName:
{
Description: The name of the proxy resource holding details of HCI ArcSetting information. ,
Required: True ,
}
string ,
arcSetting:
{
Description: Parameters supplied to the Create ArcSetting resource for this HCI cluster. ,
Required: True ,
}
{
properties:
{
Description: ArcSetting properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the ArcSetting proxy resource. ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
arcInstanceResourceGroup:
{
Description: The resource group that hosts the Arc agents, ie. Hybrid Compute Machine resources. ,
Required: False ,
}
string ,
arcApplicationClientId:
{
Description: App id of arc AAD identity. ,
Required: False ,
}
string ,
arcApplicationTenantId:
{
Description: Tenant id of arc AAD identity. ,
Required: False ,
}
string ,
arcServicePrincipalObjectId:
{
Description: Object id of arc AAD service principal. ,
Required: False ,
}
string ,
arcApplicationObjectId:
{
Description: Object id of arc AAD identity. ,
Required: False ,
}
string ,
aggregateState:
{
Description: Aggregate state of Arc agent across the nodes in this HCI cluster. ,
Enum:
{
NotSpecified: The aggregate state is not specified. ,
Error: An error occurred in the aggregate state. ,
Succeeded: The operation successfully completed across all nodes. ,
Canceled: The operation was canceled across the nodes. ,
Failed: The operation failed on all or most nodes. ,
Connected: All nodes are connected. ,
Disconnected: All nodes are disconnected. ,
Deleted: The Arc agent has been deleted from all nodes. ,
Creating: The Arc agent is being created across the nodes. ,
Updating: The Arc agent is being updated across the nodes. ,
Deleting: The Arc agent is being deleted across the nodes. ,
Moving: The Arc agent is being moved across the nodes. ,
PartiallySucceeded: The operation succeeded on some nodes. ,
PartiallyConnected: Some nodes are connected, others are not. ,
InProgress: The operation is currently in progress across the nodes. ,
Accepted: The operation has been accepted and is pending execution. ,
Provisioning: The Arc agent is being provisioned across the nodes. ,
DisableInProgress: The Arc agent is being disabled across the nodes. ,
}
,
Required: False ,
}
enum ,
perNodeDetails:
{
Description: State of Arc agent in each of the nodes. ,
Required: False ,
}
[
{
name:
{
Description: Name of the Node in HCI Cluster ,
Required: False ,
}
string ,
arcInstance:
{
Description: Fully qualified resource ID for the Arc agent of this node. ,
Required: False ,
}
string ,
arcNodeServicePrincipalObjectId:
{
Description: The service principal id of the arc for server node ,
Required: False ,
}
string ,
state:
{
Description: State of the Arc agent in this node. Indicates the current lifecycle status of the agent, such as whether it's being provisioned, connected, updated, or has encountered an error. ,
Enum:
{
NotSpecified: The state is not specified. ,
Error: An error occurred during the agent's lifecycle. ,
Succeeded: The operation completed successfully. ,
Canceled: The operation was canceled before completion. ,
Failed: The operation failed. ,
Connected: The Arc agent is connected on this node. ,
Disconnected: The Arc agent is disconnected on this node. ,
Deleted: The Arc agent has been deleted from this node. ,
Creating: The Arc agent is being created on this node. ,
Updating: The Arc agent is being updated on this node. ,
Deleting: The Arc agent is being deleted from this node. ,
Moving: The Arc agent is being moved on this node. ,
PartiallySucceeded: The operation partially succeeded. ,
PartiallyConnected: The Arc agent is partially connected on this node. ,
InProgress: The operation is currently in progress. ,
Accepted: The operation has been accepted and is pending execution. ,
Provisioning: The Arc agent is currently being provisioned on this node. ,
DisableInProgress: The Arc agent is in the process of being disabled on this node. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
connectivityProperties:
{
Description: contains connectivity related configuration for ARC resources ,
Required: False ,
}
{
enabled:
{
Description: True indicates ARC connectivity is enabled ,
Required: False ,
}
boolean ,
serviceConfigurations:
{
Description: Service configurations associated with the connectivity resource. They are only processed by the server if 'enabled' property is set to 'true'. ,
Required: False ,
}
[
{
serviceName:
{
Description: Specifies the name of the service associated with the update or operation. This helps identify which system component or tool is involved. ,
Enum:
{
WAC: Windows Admin Center (WAC) is the service associated with this operation. ,
}
,
Required: True ,
}
enum ,
port:
{
Description: The port on which service is enabled. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
defaultExtensions:
{
Description: Properties for each of the default extensions category ,
Required: False ,
}
[
{
category:
{
Description: Default extension category ,
Required: False ,
}
string ,
consentTime:
{
Description: Consent time for extension category ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: ArcSetting properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the ArcSetting proxy resource. ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
arcInstanceResourceGroup:
{
Description: The resource group that hosts the Arc agents, ie. Hybrid Compute Machine resources. ,
Required: False ,
}
string ,
arcApplicationClientId:
{
Description: App id of arc AAD identity. ,
Required: False ,
}
string ,
arcApplicationTenantId:
{
Description: Tenant id of arc AAD identity. ,
Required: False ,
}
string ,
arcServicePrincipalObjectId:
{
Description: Object id of arc AAD service principal. ,
Required: False ,
}
string ,
arcApplicationObjectId:
{
Description: Object id of arc AAD identity. ,
Required: False ,
}
string ,
aggregateState:
{
Description: Aggregate state of Arc agent across the nodes in this HCI cluster. ,
Enum:
{
NotSpecified: The aggregate state is not specified. ,
Error: An error occurred in the aggregate state. ,
Succeeded: The operation successfully completed across all nodes. ,
Canceled: The operation was canceled across the nodes. ,
Failed: The operation failed on all or most nodes. ,
Connected: All nodes are connected. ,
Disconnected: All nodes are disconnected. ,
Deleted: The Arc agent has been deleted from all nodes. ,
Creating: The Arc agent is being created across the nodes. ,
Updating: The Arc agent is being updated across the nodes. ,
Deleting: The Arc agent is being deleted across the nodes. ,
Moving: The Arc agent is being moved across the nodes. ,
PartiallySucceeded: The operation succeeded on some nodes. ,
PartiallyConnected: Some nodes are connected, others are not. ,
InProgress: The operation is currently in progress across the nodes. ,
Accepted: The operation has been accepted and is pending execution. ,
Provisioning: The Arc agent is being provisioned across the nodes. ,
DisableInProgress: The Arc agent is being disabled across the nodes. ,
}
,
Required: False ,
}
enum ,
perNodeDetails:
{
Description: State of Arc agent in each of the nodes. ,
Required: False ,
}
[
{
name:
{
Description: Name of the Node in HCI Cluster ,
Required: False ,
}
string ,
arcInstance:
{
Description: Fully qualified resource ID for the Arc agent of this node. ,
Required: False ,
}
string ,
arcNodeServicePrincipalObjectId:
{
Description: The service principal id of the arc for server node ,
Required: False ,
}
string ,
state:
{
Description: State of the Arc agent in this node. Indicates the current lifecycle status of the agent, such as whether it's being provisioned, connected, updated, or has encountered an error. ,
Enum:
{
NotSpecified: The state is not specified. ,
Error: An error occurred during the agent's lifecycle. ,
Succeeded: The operation completed successfully. ,
Canceled: The operation was canceled before completion. ,
Failed: The operation failed. ,
Connected: The Arc agent is connected on this node. ,
Disconnected: The Arc agent is disconnected on this node. ,
Deleted: The Arc agent has been deleted from this node. ,
Creating: The Arc agent is being created on this node. ,
Updating: The Arc agent is being updated on this node. ,
Deleting: The Arc agent is being deleted from this node. ,
Moving: The Arc agent is being moved on this node. ,
PartiallySucceeded: The operation partially succeeded. ,
PartiallyConnected: The Arc agent is partially connected on this node. ,
InProgress: The operation is currently in progress. ,
Accepted: The operation has been accepted and is pending execution. ,
Provisioning: The Arc agent is currently being provisioned on this node. ,
DisableInProgress: The Arc agent is in the process of being disabled on this node. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
connectivityProperties:
{
Description: contains connectivity related configuration for ARC resources ,
Required: False ,
}
{
enabled:
{
Description: True indicates ARC connectivity is enabled ,
Required: False ,
}
boolean ,
serviceConfigurations:
{
Description: Service configurations associated with the connectivity resource. They are only processed by the server if 'enabled' property is set to 'true'. ,
Required: False ,
}
[
{
serviceName:
{
Description: Specifies the name of the service associated with the update or operation. This helps identify which system component or tool is involved. ,
Enum:
{
WAC: Windows Admin Center (WAC) is the service associated with this operation. ,
}
,
Required: True ,
}
enum ,
port:
{
Description: The port on which service is enabled. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
defaultExtensions:
{
Description: Properties for each of the default extensions category ,
Required: False ,
}
[
{
category:
{
Description: Default extension category ,
Required: False ,
}
string ,
consentTime:
{
Description: Consent time for extension category ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ArcSettings_Update (removed)
Description :  Update ArcSettings for HCI cluster.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
arcSettingName:
{
Description: The name of the proxy resource holding details of HCI ArcSetting information. ,
Required: True ,
}
string ,
arcSetting:
{
Description: ArcSettings parameters that needs to be updated ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: ArcSettings properties. ,
Required: False ,
}
{
connectivityProperties:
{
Description: contains connectivity related configuration for ARC resources ,
Required: False ,
}
{
enabled:
{
Description: True indicates ARC connectivity is enabled ,
Required: False ,
}
boolean ,
serviceConfigurations:
{
Description: Service configurations associated with the connectivity resource. They are only processed by the server if 'enabled' property is set to 'true'. ,
Required: False ,
}
[
{
serviceName:
{
Description: Specifies the name of the service associated with the update or operation. This helps identify which system component or tool is involved. ,
Enum:
{
WAC: Windows Admin Center (WAC) is the service associated with this operation. ,
}
,
Required: True ,
}
enum ,
port:
{
Description: The port on which service is enabled. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: ArcSetting properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the ArcSetting proxy resource. ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
arcInstanceResourceGroup:
{
Description: The resource group that hosts the Arc agents, ie. Hybrid Compute Machine resources. ,
Required: False ,
}
string ,
arcApplicationClientId:
{
Description: App id of arc AAD identity. ,
Required: False ,
}
string ,
arcApplicationTenantId:
{
Description: Tenant id of arc AAD identity. ,
Required: False ,
}
string ,
arcServicePrincipalObjectId:
{
Description: Object id of arc AAD service principal. ,
Required: False ,
}
string ,
arcApplicationObjectId:
{
Description: Object id of arc AAD identity. ,
Required: False ,
}
string ,
aggregateState:
{
Description: Aggregate state of Arc agent across the nodes in this HCI cluster. ,
Enum:
{
NotSpecified: The aggregate state is not specified. ,
Error: An error occurred in the aggregate state. ,
Succeeded: The operation successfully completed across all nodes. ,
Canceled: The operation was canceled across the nodes. ,
Failed: The operation failed on all or most nodes. ,
Connected: All nodes are connected. ,
Disconnected: All nodes are disconnected. ,
Deleted: The Arc agent has been deleted from all nodes. ,
Creating: The Arc agent is being created across the nodes. ,
Updating: The Arc agent is being updated across the nodes. ,
Deleting: The Arc agent is being deleted across the nodes. ,
Moving: The Arc agent is being moved across the nodes. ,
PartiallySucceeded: The operation succeeded on some nodes. ,
PartiallyConnected: Some nodes are connected, others are not. ,
InProgress: The operation is currently in progress across the nodes. ,
Accepted: The operation has been accepted and is pending execution. ,
Provisioning: The Arc agent is being provisioned across the nodes. ,
DisableInProgress: The Arc agent is being disabled across the nodes. ,
}
,
Required: False ,
}
enum ,
perNodeDetails:
{
Description: State of Arc agent in each of the nodes. ,
Required: False ,
}
[
{
name:
{
Description: Name of the Node in HCI Cluster ,
Required: False ,
}
string ,
arcInstance:
{
Description: Fully qualified resource ID for the Arc agent of this node. ,
Required: False ,
}
string ,
arcNodeServicePrincipalObjectId:
{
Description: The service principal id of the arc for server node ,
Required: False ,
}
string ,
state:
{
Description: State of the Arc agent in this node. Indicates the current lifecycle status of the agent, such as whether it's being provisioned, connected, updated, or has encountered an error. ,
Enum:
{
NotSpecified: The state is not specified. ,
Error: An error occurred during the agent's lifecycle. ,
Succeeded: The operation completed successfully. ,
Canceled: The operation was canceled before completion. ,
Failed: The operation failed. ,
Connected: The Arc agent is connected on this node. ,
Disconnected: The Arc agent is disconnected on this node. ,
Deleted: The Arc agent has been deleted from this node. ,
Creating: The Arc agent is being created on this node. ,
Updating: The Arc agent is being updated on this node. ,
Deleting: The Arc agent is being deleted from this node. ,
Moving: The Arc agent is being moved on this node. ,
PartiallySucceeded: The operation partially succeeded. ,
PartiallyConnected: The Arc agent is partially connected on this node. ,
InProgress: The operation is currently in progress. ,
Accepted: The operation has been accepted and is pending execution. ,
Provisioning: The Arc agent is currently being provisioned on this node. ,
DisableInProgress: The Arc agent is in the process of being disabled on this node. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
connectivityProperties:
{
Description: contains connectivity related configuration for ARC resources ,
Required: False ,
}
{
enabled:
{
Description: True indicates ARC connectivity is enabled ,
Required: False ,
}
boolean ,
serviceConfigurations:
{
Description: Service configurations associated with the connectivity resource. They are only processed by the server if 'enabled' property is set to 'true'. ,
Required: False ,
}
[
{
serviceName:
{
Description: Specifies the name of the service associated with the update or operation. This helps identify which system component or tool is involved. ,
Enum:
{
WAC: Windows Admin Center (WAC) is the service associated with this operation. ,
}
,
Required: True ,
}
enum ,
port:
{
Description: The port on which service is enabled. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
defaultExtensions:
{
Description: Properties for each of the default extensions category ,
Required: False ,
}
[
{
category:
{
Description: Default extension category ,
Required: False ,
}
string ,
consentTime:
{
Description: Consent time for extension category ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ArcSettings_Delete (removed)
Description :  Delete ArcSetting resource details of HCI Cluster.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
arcSettingName:
{
Description: The name of the proxy resource holding details of HCI ArcSetting information. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ArcSettings_GeneratePassword (removed)
Description :  Generate password for arc settings.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}/generatePassword
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
arcSettingName:
{
Description: The name of the proxy resource holding details of HCI ArcSetting information. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
secretText:
{
Required: False ,
}
string ,
keyId:
{
Required: False ,
}
string ,
startDateTime:
{
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ArcSettings_CreateIdentity (removed)
Description :  Create Aad identity for arc settings.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}/createArcIdentity
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
arcSettingName:
{
Description: The name of the proxy resource holding details of HCI ArcSetting information. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: ArcIdentity properties. ,
Required: False ,
}
{
arcApplicationClientId:
{
Required: False ,
}
string ,
arcApplicationTenantId:
{
Required: False ,
}
string ,
arcServicePrincipalObjectId:
{
Required: False ,
}
string ,
arcApplicationObjectId:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ArcSettings_Reconcile (removed)
Description :  Reconcile Arc Settings with information related to all nodes.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}/reconcile
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
arcSettingName:
{
Description: The name of the proxy resource holding details of HCI ArcSetting information. ,
Required: True ,
}
string ,
reconcileArcSettingsRequest:
{
Description: Request for reconciling Arc Settings. ,
Required: True ,
}
{
properties:
{
Description: List of Arc Nodes in the cluster ,
Required: False ,
}
{
clusterNodes:
{
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: ArcSetting properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the ArcSetting proxy resource. ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
arcInstanceResourceGroup:
{
Description: The resource group that hosts the Arc agents, ie. Hybrid Compute Machine resources. ,
Required: False ,
}
string ,
arcApplicationClientId:
{
Description: App id of arc AAD identity. ,
Required: False ,
}
string ,
arcApplicationTenantId:
{
Description: Tenant id of arc AAD identity. ,
Required: False ,
}
string ,
arcServicePrincipalObjectId:
{
Description: Object id of arc AAD service principal. ,
Required: False ,
}
string ,
arcApplicationObjectId:
{
Description: Object id of arc AAD identity. ,
Required: False ,
}
string ,
aggregateState:
{
Description: Aggregate state of Arc agent across the nodes in this HCI cluster. ,
Enum:
{
NotSpecified: The aggregate state is not specified. ,
Error: An error occurred in the aggregate state. ,
Succeeded: The operation successfully completed across all nodes. ,
Canceled: The operation was canceled across the nodes. ,
Failed: The operation failed on all or most nodes. ,
Connected: All nodes are connected. ,
Disconnected: All nodes are disconnected. ,
Deleted: The Arc agent has been deleted from all nodes. ,
Creating: The Arc agent is being created across the nodes. ,
Updating: The Arc agent is being updated across the nodes. ,
Deleting: The Arc agent is being deleted across the nodes. ,
Moving: The Arc agent is being moved across the nodes. ,
PartiallySucceeded: The operation succeeded on some nodes. ,
PartiallyConnected: Some nodes are connected, others are not. ,
InProgress: The operation is currently in progress across the nodes. ,
Accepted: The operation has been accepted and is pending execution. ,
Provisioning: The Arc agent is being provisioned across the nodes. ,
DisableInProgress: The Arc agent is being disabled across the nodes. ,
}
,
Required: False ,
}
enum ,
perNodeDetails:
{
Description: State of Arc agent in each of the nodes. ,
Required: False ,
}
[
{
name:
{
Description: Name of the Node in HCI Cluster ,
Required: False ,
}
string ,
arcInstance:
{
Description: Fully qualified resource ID for the Arc agent of this node. ,
Required: False ,
}
string ,
arcNodeServicePrincipalObjectId:
{
Description: The service principal id of the arc for server node ,
Required: False ,
}
string ,
state:
{
Description: State of the Arc agent in this node. Indicates the current lifecycle status of the agent, such as whether it's being provisioned, connected, updated, or has encountered an error. ,
Enum:
{
NotSpecified: The state is not specified. ,
Error: An error occurred during the agent's lifecycle. ,
Succeeded: The operation completed successfully. ,
Canceled: The operation was canceled before completion. ,
Failed: The operation failed. ,
Connected: The Arc agent is connected on this node. ,
Disconnected: The Arc agent is disconnected on this node. ,
Deleted: The Arc agent has been deleted from this node. ,
Creating: The Arc agent is being created on this node. ,
Updating: The Arc agent is being updated on this node. ,
Deleting: The Arc agent is being deleted from this node. ,
Moving: The Arc agent is being moved on this node. ,
PartiallySucceeded: The operation partially succeeded. ,
PartiallyConnected: The Arc agent is partially connected on this node. ,
InProgress: The operation is currently in progress. ,
Accepted: The operation has been accepted and is pending execution. ,
Provisioning: The Arc agent is currently being provisioned on this node. ,
DisableInProgress: The Arc agent is in the process of being disabled on this node. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
connectivityProperties:
{
Description: contains connectivity related configuration for ARC resources ,
Required: False ,
}
{
enabled:
{
Description: True indicates ARC connectivity is enabled ,
Required: False ,
}
boolean ,
serviceConfigurations:
{
Description: Service configurations associated with the connectivity resource. They are only processed by the server if 'enabled' property is set to 'true'. ,
Required: False ,
}
[
{
serviceName:
{
Description: Specifies the name of the service associated with the update or operation. This helps identify which system component or tool is involved. ,
Enum:
{
WAC: Windows Admin Center (WAC) is the service associated with this operation. ,
}
,
Required: True ,
}
enum ,
port:
{
Description: The port on which service is enabled. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
defaultExtensions:
{
Description: Properties for each of the default extensions category ,
Required: False ,
}
[
{
category:
{
Description: Default extension category ,
Required: False ,
}
string ,
consentTime:
{
Description: Consent time for extension category ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ArcSettings_ConsentAndInstallDefaultExtensions (removed)
Description :  Add consent time for default extensions and initiate extensions installation
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}/consentAndInstallDefaultExtensions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
arcSettingName:
{
Description: The name of the proxy resource holding details of HCI ArcSetting information. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: ArcSetting properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the ArcSetting proxy resource. ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
arcInstanceResourceGroup:
{
Description: The resource group that hosts the Arc agents, ie. Hybrid Compute Machine resources. ,
Required: False ,
}
string ,
arcApplicationClientId:
{
Description: App id of arc AAD identity. ,
Required: False ,
}
string ,
arcApplicationTenantId:
{
Description: Tenant id of arc AAD identity. ,
Required: False ,
}
string ,
arcServicePrincipalObjectId:
{
Description: Object id of arc AAD service principal. ,
Required: False ,
}
string ,
arcApplicationObjectId:
{
Description: Object id of arc AAD identity. ,
Required: False ,
}
string ,
aggregateState:
{
Description: Aggregate state of Arc agent across the nodes in this HCI cluster. ,
Enum:
{
NotSpecified: The aggregate state is not specified. ,
Error: An error occurred in the aggregate state. ,
Succeeded: The operation successfully completed across all nodes. ,
Canceled: The operation was canceled across the nodes. ,
Failed: The operation failed on all or most nodes. ,
Connected: All nodes are connected. ,
Disconnected: All nodes are disconnected. ,
Deleted: The Arc agent has been deleted from all nodes. ,
Creating: The Arc agent is being created across the nodes. ,
Updating: The Arc agent is being updated across the nodes. ,
Deleting: The Arc agent is being deleted across the nodes. ,
Moving: The Arc agent is being moved across the nodes. ,
PartiallySucceeded: The operation succeeded on some nodes. ,
PartiallyConnected: Some nodes are connected, others are not. ,
InProgress: The operation is currently in progress across the nodes. ,
Accepted: The operation has been accepted and is pending execution. ,
Provisioning: The Arc agent is being provisioned across the nodes. ,
DisableInProgress: The Arc agent is being disabled across the nodes. ,
}
,
Required: False ,
}
enum ,
perNodeDetails:
{
Description: State of Arc agent in each of the nodes. ,
Required: False ,
}
[
{
name:
{
Description: Name of the Node in HCI Cluster ,
Required: False ,
}
string ,
arcInstance:
{
Description: Fully qualified resource ID for the Arc agent of this node. ,
Required: False ,
}
string ,
arcNodeServicePrincipalObjectId:
{
Description: The service principal id of the arc for server node ,
Required: False ,
}
string ,
state:
{
Description: State of the Arc agent in this node. Indicates the current lifecycle status of the agent, such as whether it's being provisioned, connected, updated, or has encountered an error. ,
Enum:
{
NotSpecified: The state is not specified. ,
Error: An error occurred during the agent's lifecycle. ,
Succeeded: The operation completed successfully. ,
Canceled: The operation was canceled before completion. ,
Failed: The operation failed. ,
Connected: The Arc agent is connected on this node. ,
Disconnected: The Arc agent is disconnected on this node. ,
Deleted: The Arc agent has been deleted from this node. ,
Creating: The Arc agent is being created on this node. ,
Updating: The Arc agent is being updated on this node. ,
Deleting: The Arc agent is being deleted from this node. ,
Moving: The Arc agent is being moved on this node. ,
PartiallySucceeded: The operation partially succeeded. ,
PartiallyConnected: The Arc agent is partially connected on this node. ,
InProgress: The operation is currently in progress. ,
Accepted: The operation has been accepted and is pending execution. ,
Provisioning: The Arc agent is currently being provisioned on this node. ,
DisableInProgress: The Arc agent is in the process of being disabled on this node. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
connectivityProperties:
{
Description: contains connectivity related configuration for ARC resources ,
Required: False ,
}
{
enabled:
{
Description: True indicates ARC connectivity is enabled ,
Required: False ,
}
boolean ,
serviceConfigurations:
{
Description: Service configurations associated with the connectivity resource. They are only processed by the server if 'enabled' property is set to 'true'. ,
Required: False ,
}
[
{
serviceName:
{
Description: Specifies the name of the service associated with the update or operation. This helps identify which system component or tool is involved. ,
Enum:
{
WAC: Windows Admin Center (WAC) is the service associated with this operation. ,
}
,
Required: True ,
}
enum ,
port:
{
Description: The port on which service is enabled. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
defaultExtensions:
{
Description: Properties for each of the default extensions category ,
Required: False ,
}
[
{
category:
{
Description: Default extension category ,
Required: False ,
}
string ,
consentTime:
{
Description: Consent time for extension category ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ArcSettings_InitializeDisableProcess (removed)
Description :  Initializes ARC Disable process on the cluster
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}/initializeDisableProcess
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
arcSettingName:
{
Description: The name of the proxy resource holding details of HCI ArcSetting information. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_ListBySubscription (removed)
Description :  List all HCI clusters in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AzureStackHCI/clusters
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Cluster items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Cluster properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state. Indicates the current lifecycle status of the resource, including creation, update, deletion, connectivity, and error states. ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Status of the cluster agent. Indicates the current connectivity, validation, and deployment state of the agent within the cluster. ,
Enum:
{
NotYetRegistered: The cluster agent has not yet registered with Azure. ,
ConnectedRecently: The cluster agent has connected to Azure recently. ,
NotConnectedRecently: The cluster agent has not connected to Azure recently. ,
Disconnected: The cluster agent is currently disconnected from Azure. ,
Error: An error occurred in the cluster agent's operation. ,
NotSpecified: The status of the cluster agent is not specified. ,
ValidationInProgress: Validation of the cluster agent is currently in progress. ,
ValidationSuccess: Validation of the cluster agent completed successfully. ,
ValidationFailed: Validation of the cluster agent failed. ,
DeploymentInProgress: Deployment of the cluster agent is currently in progress. ,
DeploymentFailed: Deployment of the cluster agent failed. ,
DeploymentSuccess: Deployment of the cluster agent completed successfully. ,
}
,
Required: False ,
}
enum ,
connectivityStatus:
{
Description: Overall connectivity status for the cluster resource. Indicates whether the cluster is connected to Azure, partially connected, or has not recently communicated. ,
Enum:
{
NotYetRegistered: The cluster has not yet registered with Azure. ,
Connected: The cluster is fully connected to Azure. ,
NotConnectedRecently: The cluster has not connected to Azure recently. ,
PartiallyConnected: Some components of the cluster are connected, while others are not. ,
Disconnected: The cluster is not connected to Azure. ,
NotSpecified: The connectivity status is not specified. ,
}
,
Required: False ,
}
enum ,
supportStatus:
{
Description: Indicates whether the cluster is under support. ,
Enum:
{
InSupport: The cluster is under support. ,
OutOfSupport: The cluster is out of support. ,
NotSpecified: The support status is not specified. ,
}
,
Required: False ,
}
enum ,
cloudId:
{
Description: Unique, immutable resource id. ,
Required: False ,
}
string ,
ring:
{
Description: The ring to which this cluster belongs to. ,
Required: False ,
}
string ,
cloudManagementEndpoint:
{
Description: Endpoint configured for management from the Azure portal. ,
Required: False ,
}
string ,
aadClientId:
{
Description: App id of cluster AAD identity. ,
Required: False ,
}
string ,
aadTenantId:
{
Description: Tenant id of cluster AAD identity. ,
Required: False ,
}
string ,
aadApplicationObjectId:
{
Description: Object id of cluster AAD identity. ,
Required: False ,
}
string ,
aadServicePrincipalObjectId:
{
Description: Id of cluster identity service principal. ,
Required: False ,
}
string ,
softwareAssuranceProperties:
{
Description: Software Assurance properties of the cluster. ,
Required: False ,
}
{
softwareAssuranceStatus:
{
Description: Status of the Software Assurance for the cluster. ,
Enum:
{
Enabled: Software Assurance is enabled for the cluster. ,
Disabled: Software Assurance is disabled for the cluster. ,
}
,
Required: False ,
}
enum ,
softwareAssuranceIntent:
{
Description: Customer Intent for Software Assurance Benefit. ,
Enum:
{
Enable: Customer intends to enable the Software Assurance benefit. ,
Disable: Customer intends to disable the Software Assurance benefit. ,
}
,
Required: False ,
}
enum ,
lastUpdated:
{
Description: TimeStamp denoting the latest SA benefit applicability is validated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
isManagementCluster:
{
Description: Is Management Cluster, when true indicates that the cluster is used for managing other clusters ,
Required: False ,
}
boolean ,
logCollectionProperties:
{
Description: Log Collection properties of the cluster. ,
Required: False ,
}
{
fromDate:
{
Description: From DateTimeStamp from when logs need to be connected ,
Format: date-time ,
Required: False ,
}
string ,
toDate:
{
Description: To DateTimeStamp till when logs need to be connected ,
Format: date-time ,
Required: False ,
}
string ,
lastLogGenerated:
{
Description: Recent DateTimeStamp where logs are successfully generated ,
Format: date-time ,
Required: False ,
}
string ,
logCollectionSessionDetails:
{
Required: False ,
}
[
{
logStartTime:
{
Description: Start Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
logEndTime:
{
Description: End Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
timeCollected:
{
Description: Duration of logs collected ,
Format: date-time ,
Required: False ,
}
string ,
logSize:
{
Description: Size of the logs collected ,
Format: int64 ,
Required: False ,
}
integer ,
logCollectionStatus:
{
Description: LogCollection status ,
Enum:
{
None: No log collection has been initiated. ,
InProgress: Log collection is currently in progress. ,
Failed: Log collection has failed. ,
Succeeded: Log collection completed successfully. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: CorrelationId of the log collection ,
Required: False ,
}
string ,
logCollectionJobType:
{
Description: Specifies the type of log collection job. Determines whether the logs are collected immediately on demand or as part of a scheduled operation. ,
Enum:
{
OnDemand: Log collection is triggered manually and executed immediately. ,
Scheduled: Log collection is scheduled to run at a predefined time or interval. ,
}
,
Required: False ,
}
enum ,
endTimeCollected:
{
Description: End Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
logCollectionError:
{
Description: Log Collection Error details of the cluster. ,
Required: False ,
}
{
errorCode:
{
Description: Error Code of the log collection ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error Message of the log collection ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
remoteSupportProperties:
{
Description: RemoteSupport properties of the cluster. ,
Required: False ,
}
{
accessLevel:
{
Description: Remote Support Access Level ,
Enum:
{
Diagnostics: Allows remote diagnostics operations only. ,
DiagnosticsAndRepair: Allows both remote diagnostics and repair operations. ,
}
,
Required: False ,
}
enum ,
expirationTimeStamp:
{
Description: Expiration DateTimeStamp when Remote Support Access will be expired ,
Format: date-time ,
Required: False ,
}
string ,
remoteSupportType:
{
Description: Remote Support Type for cluster ,
Enum:
{
Enable: Enable remote support for the cluster. ,
Revoke: Revoke previously enabled remote support for the cluster. ,
}
,
Required: False ,
}
enum ,
remoteSupportNodeSettings:
{
Required: False ,
}
[
{
arcResourceId:
{
Description: Arc ResourceId of the Node ,
Required: False ,
}
string ,
state:
{
Description: Remote Support Access Connection State on the Node ,
Required: False ,
}
string ,
createdAt:
{
Description: Remote Support Enablement Request Created TimeStamp on the Node ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: Remote Support Enablement Request Updated TimeStamp on the Node ,
Format: date-time ,
Required: False ,
}
string ,
connectionStatus:
{
Description: Remote Support Access Connection Status on the Node ,
Required: False ,
}
string ,
connectionErrorMessage:
{
Description: Remote Support Access Connection Error Message on the Node ,
Required: False ,
}
string ,
transcriptLocation:
{
Description: Remote Support Transcript location on the node ,
Required: False ,
}
string ,
}
,
]
,
remoteSupportSessionDetails:
{
Required: False ,
}
[
{
sessionStartTime:
{
Description: Remote Support Session StartTime on the Node ,
Format: date-time ,
Required: False ,
}
string ,
sessionEndTime:
{
Description: Remote Support Session EndTime on the Node ,
Format: date-time ,
Required: False ,
}
string ,
nodeName:
{
Description: Name of the node ,
Required: False ,
}
string ,
duration:
{
Description: Duration of Remote Support Enablement ,
Format: int64 ,
Required: False ,
}
integer ,
accessLevel:
{
Description: Remote Support Access Level ,
Enum:
{
Diagnostics: Allows remote diagnostics operations only. ,
DiagnosticsAndRepair: Allows both remote diagnostics and repair operations. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
desiredProperties:
{
Description: Desired properties of the cluster. ,
Required: False ,
}
{
windowsServerSubscription:
{
Description: Desired state of Windows Server Subscription. ,
Enum:
{
Disabled: Windows Server Subscription is disabled. ,
Enabled: Windows Server Subscription is enabled. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Desired level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No diagnostic data will be emitted. ,
Basic: Basic diagnostic data will be emitted, including essential health metrics. ,
Enhanced: Enhanced diagnostic data will be emitted, including detailed performance and usage metrics. ,
}
,
Required: False ,
}
enum ,
}
,
reportedProperties:
{
Description: Properties reported by cluster agent. ,
Required: False ,
}
{
clusterName:
{
Description: Name of the on-prem cluster connected to this resource. ,
Required: False ,
}
string ,
clusterId:
{
Description: Unique id generated by the on-prem cluster. ,
Required: False ,
}
string ,
clusterVersion:
{
Description: Version of the cluster software. ,
Required: False ,
}
string ,
nodes:
{
Description: List of nodes reported by the cluster. ,
Required: False ,
}
[
{
name:
{
Description: Name of the cluster node. ,
Required: False ,
}
string ,
id:
{
Description: Id of the node in the cluster. ,
Format: float ,
Required: False ,
}
number ,
windowsServerSubscription:
{
Description: State of Windows Server Subscription. ,
Enum:
{
Disabled: Windows Server Subscription is disabled. ,
Enabled: Windows Server Subscription is enabled. ,
}
,
Required: False ,
}
enum ,
nodeType:
{
Description: Type of the cluster node hardware. ,
Enum:
{
FirstParty: All nodes in the cluster are provided and managed by Microsoft. ,
ThirdParty: All nodes in the cluster are provided and managed by a third-party vendor. ,
}
,
Required: False ,
}
enum ,
ehcResourceId:
{
Description: Edge Hardware Center Resource Id ,
Required: False ,
}
string ,
manufacturer:
{
Description: Manufacturer of the cluster node hardware. ,
Required: False ,
}
string ,
model:
{
Description: Model name of the cluster node hardware. ,
Required: False ,
}
string ,
osName:
{
Description: Operating system running on the cluster node. ,
Required: False ,
}
string ,
osVersion:
{
Description: Version of the operating system running on the cluster node. ,
Required: False ,
}
string ,
osDisplayVersion:
{
Description: Display version of the operating system running on the cluster node. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Immutable id of the cluster node. ,
Required: False ,
}
string ,
coreCount:
{
Description: Number of physical cores on the cluster node. ,
Format: float ,
Required: False ,
}
number ,
memoryInGiB:
{
Description: Total available memory on the cluster node (in GiB). ,
Format: float ,
Required: False ,
}
number ,
lastLicensingTimestamp:
{
Description: Most recent licensing timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
oemActivation:
{
Description: OEM activation status of the node. ,
Enum:
{
Disabled: OEM activation is disabled for the cluster. ,
Enabled: OEM activation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
lastUpdated:
{
Description: Last time the cluster reported the data. ,
Format: date-time ,
Required: False ,
}
string ,
msiExpirationTimeStamp:
{
Description: Specifies the expiration timestamp of the cluster's Managed Service Identity (MSI). The value is expressed in Coordinated Universal Time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
imdsAttestation:
{
Description: IMDS attestation status of the cluster. ,
Enum:
{
Disabled: IMDS attestation is disabled for the cluster. ,
Enabled: IMDS attestation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No diagnostic data will be emitted. ,
Basic: Basic diagnostic data will be emitted, including essential health metrics. ,
Enhanced: Enhanced diagnostic data will be emitted, including detailed performance and usage metrics. ,
}
,
Required: False ,
}
enum ,
supportedCapabilities:
{
Description: Capabilities supported by the cluster. ,
Required: False ,
}
[
string ,
]
,
clusterType:
{
Description: Specifies the type of hardware vendor for all nodes in the cluster. Indicates whether the nodes are provided by Microsoft or a third-party vendor. ,
Enum:
{
FirstParty: All nodes in the cluster are provided and managed by Microsoft. ,
ThirdParty: All nodes in the cluster are provided and managed by a third-party vendor. ,
}
,
Required: False ,
}
enum ,
manufacturer:
{
Description: The manufacturer of all the nodes of the cluster. ,
Required: False ,
}
string ,
oemActivation:
{
Description: OEM activation status of the cluster. ,
Enum:
{
Disabled: OEM activation is disabled for the cluster. ,
Enabled: OEM activation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
hardwareClass:
{
Description: Hardware class of the cluster. ,
Enum:
{
Small: The hardware class is small. ,
Medium: The hardware class is medium. This corresponds to the default ,
Large: The hardware class is large. ,
}
,
Required: False ,
}
enum ,
}
,
isolatedVmAttestationConfiguration:
{
Description: Attestation configurations for isolated VM (e.g. TVM, CVM) of the cluster. ,
Required: False ,
}
{
attestationResourceId:
{
Description: Fully qualified Azure resource id of the Microsoft Azure attestation resource associated with this cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
relyingPartyServiceEndpoint:
{
Description: Region specific endpoint for relying party service. ,
Required: False ,
}
string ,
attestationServiceEndpoint:
{
Description: Region specific endpoint for Microsoft Azure Attestation service for the cluster ,
Required: False ,
}
string ,
}
,
trialDaysRemaining:
{
Description: Number of days remaining in the trial period. ,
Format: float ,
Required: False ,
}
number ,
billingModel:
{
Description: Type of billing applied to the resource. ,
Required: False ,
}
string ,
registrationTimestamp:
{
Description: First cluster sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncTimestamp:
{
Description: Most recent cluster sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastBillingTimestamp:
{
Description: Most recent billing meter timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
serviceEndpoint:
{
Description: Region specific DataPath Endpoint of the cluster. ,
Required: False ,
}
string ,
resourceProviderObjectId:
{
Description: Object id of RP Service Principal ,
Required: False ,
}
string ,
secretsLocations:
{
Description: List of secret locations. ,
Required: False ,
}
[
{
secretsType:
{
Description: Type of secrets to store ,
Enum:
{
BackupSecrets: Backup secrets type ,
}
,
Required: True ,
}
enum ,
secretsLocation:
{
Description: secrets location ,
Required: True ,
}
string ,
}
,
]
,
clusterPattern:
{
Description: Supported Storage Type for HCI Cluster ,
Enum:
{
Standard: Standard cluster. ,
RackAware: RackAware cluster. ,
}
,
Required: False ,
}
enum ,
confidentialVmProperties:
{
Description: Represents the Confidential Virtual Machine (CVM) support intent and current status for the cluster resource. ,
Required: False ,
}
{
confidentialVmIntent:
{
Description: Captures the customer's intent to enable or disable CVM support on the cluster, either during initial deployment (Day-0) or at a later stage (Day-N). ,
Enum:
{
Enable: Indicates that the customer intends to enable CVM support on the cluster. ,
Disable: Indicates that the customer intends to disable CVM support on the cluster. ,
}
,
Required: False ,
}
enum ,
confidentialVmStatus:
{
Description: Captures the current status of CVM support on the cluster. ,
Enum:
{
Enabled: CVM support is fully enabled on the cluster. All nodes are CVM capable. ,
PartiallyEnabled: CVM support is partially enabled. At least one node in the cluster is CVM capable. ,
Disabled: CVM support is disabled. None of the nodes in the cluster are CVM capable. ,
}
,
Required: False ,
}
enum ,
confidentialVmStatusSummary:
{
Description: Additional context about CVM support on the cluster, such as reasons for partial enablement or hardware constraints. ,
Required: False ,
}
string ,
}
,
sdnProperties:
{
Description: Software Defined Networking Properties of the cluster ,
Required: False ,
}
{
sdnIntegrationIntent:
{
Description: Indicates whether Software Defined Networking (SDN) integration should be enabled or disabled for this deployment. ,
Enum:
{
Enable: Enable SDN integration for the deployment. ,
Disable: Disable SDN integration for the deployment. ,
}
,
Required: False ,
}
enum ,
}
,
localAvailabilityZones:
{
Description: Local Availability Zone information for HCI cluster ,
Required: False ,
}
[
{
localAvailabilityZoneName:
{
Description: Local Availability Zone name for HCI cluster ,
Required: False ,
}
string ,
nodes:
{
Description: Nodes belonging to a particular zone ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
identityProvider:
{
Description: Identity Provider for the cluster ,
Enum:
{
ActiveDirectory: Uses Active Directory as the identity provider, enabling domain-based authentication and centralized identity management. This is the default option. ,
LocalIdentity: Uses a local identity system integrated with Azure Key Vault for authentication. Suitable for AD-less environments where Active Directory is not available or required. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
kind:
{
Description: This property identifies the purpose of the Cluster deployment. For example, a valid value is AzureLocal ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_ListByResourceGroup (removed)
Description :  List all HCI clusters in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Cluster items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Cluster properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state. Indicates the current lifecycle status of the resource, including creation, update, deletion, connectivity, and error states. ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Status of the cluster agent. Indicates the current connectivity, validation, and deployment state of the agent within the cluster. ,
Enum:
{
NotYetRegistered: The cluster agent has not yet registered with Azure. ,
ConnectedRecently: The cluster agent has connected to Azure recently. ,
NotConnectedRecently: The cluster agent has not connected to Azure recently. ,
Disconnected: The cluster agent is currently disconnected from Azure. ,
Error: An error occurred in the cluster agent's operation. ,
NotSpecified: The status of the cluster agent is not specified. ,
ValidationInProgress: Validation of the cluster agent is currently in progress. ,
ValidationSuccess: Validation of the cluster agent completed successfully. ,
ValidationFailed: Validation of the cluster agent failed. ,
DeploymentInProgress: Deployment of the cluster agent is currently in progress. ,
DeploymentFailed: Deployment of the cluster agent failed. ,
DeploymentSuccess: Deployment of the cluster agent completed successfully. ,
}
,
Required: False ,
}
enum ,
connectivityStatus:
{
Description: Overall connectivity status for the cluster resource. Indicates whether the cluster is connected to Azure, partially connected, or has not recently communicated. ,
Enum:
{
NotYetRegistered: The cluster has not yet registered with Azure. ,
Connected: The cluster is fully connected to Azure. ,
NotConnectedRecently: The cluster has not connected to Azure recently. ,
PartiallyConnected: Some components of the cluster are connected, while others are not. ,
Disconnected: The cluster is not connected to Azure. ,
NotSpecified: The connectivity status is not specified. ,
}
,
Required: False ,
}
enum ,
supportStatus:
{
Description: Indicates whether the cluster is under support. ,
Enum:
{
InSupport: The cluster is under support. ,
OutOfSupport: The cluster is out of support. ,
NotSpecified: The support status is not specified. ,
}
,
Required: False ,
}
enum ,
cloudId:
{
Description: Unique, immutable resource id. ,
Required: False ,
}
string ,
ring:
{
Description: The ring to which this cluster belongs to. ,
Required: False ,
}
string ,
cloudManagementEndpoint:
{
Description: Endpoint configured for management from the Azure portal. ,
Required: False ,
}
string ,
aadClientId:
{
Description: App id of cluster AAD identity. ,
Required: False ,
}
string ,
aadTenantId:
{
Description: Tenant id of cluster AAD identity. ,
Required: False ,
}
string ,
aadApplicationObjectId:
{
Description: Object id of cluster AAD identity. ,
Required: False ,
}
string ,
aadServicePrincipalObjectId:
{
Description: Id of cluster identity service principal. ,
Required: False ,
}
string ,
softwareAssuranceProperties:
{
Description: Software Assurance properties of the cluster. ,
Required: False ,
}
{
softwareAssuranceStatus:
{
Description: Status of the Software Assurance for the cluster. ,
Enum:
{
Enabled: Software Assurance is enabled for the cluster. ,
Disabled: Software Assurance is disabled for the cluster. ,
}
,
Required: False ,
}
enum ,
softwareAssuranceIntent:
{
Description: Customer Intent for Software Assurance Benefit. ,
Enum:
{
Enable: Customer intends to enable the Software Assurance benefit. ,
Disable: Customer intends to disable the Software Assurance benefit. ,
}
,
Required: False ,
}
enum ,
lastUpdated:
{
Description: TimeStamp denoting the latest SA benefit applicability is validated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
isManagementCluster:
{
Description: Is Management Cluster, when true indicates that the cluster is used for managing other clusters ,
Required: False ,
}
boolean ,
logCollectionProperties:
{
Description: Log Collection properties of the cluster. ,
Required: False ,
}
{
fromDate:
{
Description: From DateTimeStamp from when logs need to be connected ,
Format: date-time ,
Required: False ,
}
string ,
toDate:
{
Description: To DateTimeStamp till when logs need to be connected ,
Format: date-time ,
Required: False ,
}
string ,
lastLogGenerated:
{
Description: Recent DateTimeStamp where logs are successfully generated ,
Format: date-time ,
Required: False ,
}
string ,
logCollectionSessionDetails:
{
Required: False ,
}
[
{
logStartTime:
{
Description: Start Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
logEndTime:
{
Description: End Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
timeCollected:
{
Description: Duration of logs collected ,
Format: date-time ,
Required: False ,
}
string ,
logSize:
{
Description: Size of the logs collected ,
Format: int64 ,
Required: False ,
}
integer ,
logCollectionStatus:
{
Description: LogCollection status ,
Enum:
{
None: No log collection has been initiated. ,
InProgress: Log collection is currently in progress. ,
Failed: Log collection has failed. ,
Succeeded: Log collection completed successfully. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: CorrelationId of the log collection ,
Required: False ,
}
string ,
logCollectionJobType:
{
Description: Specifies the type of log collection job. Determines whether the logs are collected immediately on demand or as part of a scheduled operation. ,
Enum:
{
OnDemand: Log collection is triggered manually and executed immediately. ,
Scheduled: Log collection is scheduled to run at a predefined time or interval. ,
}
,
Required: False ,
}
enum ,
endTimeCollected:
{
Description: End Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
logCollectionError:
{
Description: Log Collection Error details of the cluster. ,
Required: False ,
}
{
errorCode:
{
Description: Error Code of the log collection ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error Message of the log collection ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
remoteSupportProperties:
{
Description: RemoteSupport properties of the cluster. ,
Required: False ,
}
{
accessLevel:
{
Description: Remote Support Access Level ,
Enum:
{
Diagnostics: Allows remote diagnostics operations only. ,
DiagnosticsAndRepair: Allows both remote diagnostics and repair operations. ,
}
,
Required: False ,
}
enum ,
expirationTimeStamp:
{
Description: Expiration DateTimeStamp when Remote Support Access will be expired ,
Format: date-time ,
Required: False ,
}
string ,
remoteSupportType:
{
Description: Remote Support Type for cluster ,
Enum:
{
Enable: Enable remote support for the cluster. ,
Revoke: Revoke previously enabled remote support for the cluster. ,
}
,
Required: False ,
}
enum ,
remoteSupportNodeSettings:
{
Required: False ,
}
[
{
arcResourceId:
{
Description: Arc ResourceId of the Node ,
Required: False ,
}
string ,
state:
{
Description: Remote Support Access Connection State on the Node ,
Required: False ,
}
string ,
createdAt:
{
Description: Remote Support Enablement Request Created TimeStamp on the Node ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: Remote Support Enablement Request Updated TimeStamp on the Node ,
Format: date-time ,
Required: False ,
}
string ,
connectionStatus:
{
Description: Remote Support Access Connection Status on the Node ,
Required: False ,
}
string ,
connectionErrorMessage:
{
Description: Remote Support Access Connection Error Message on the Node ,
Required: False ,
}
string ,
transcriptLocation:
{
Description: Remote Support Transcript location on the node ,
Required: False ,
}
string ,
}
,
]
,
remoteSupportSessionDetails:
{
Required: False ,
}
[
{
sessionStartTime:
{
Description: Remote Support Session StartTime on the Node ,
Format: date-time ,
Required: False ,
}
string ,
sessionEndTime:
{
Description: Remote Support Session EndTime on the Node ,
Format: date-time ,
Required: False ,
}
string ,
nodeName:
{
Description: Name of the node ,
Required: False ,
}
string ,
duration:
{
Description: Duration of Remote Support Enablement ,
Format: int64 ,
Required: False ,
}
integer ,
accessLevel:
{
Description: Remote Support Access Level ,
Enum:
{
Diagnostics: Allows remote diagnostics operations only. ,
DiagnosticsAndRepair: Allows both remote diagnostics and repair operations. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
desiredProperties:
{
Description: Desired properties of the cluster. ,
Required: False ,
}
{
windowsServerSubscription:
{
Description: Desired state of Windows Server Subscription. ,
Enum:
{
Disabled: Windows Server Subscription is disabled. ,
Enabled: Windows Server Subscription is enabled. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Desired level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No diagnostic data will be emitted. ,
Basic: Basic diagnostic data will be emitted, including essential health metrics. ,
Enhanced: Enhanced diagnostic data will be emitted, including detailed performance and usage metrics. ,
}
,
Required: False ,
}
enum ,
}
,
reportedProperties:
{
Description: Properties reported by cluster agent. ,
Required: False ,
}
{
clusterName:
{
Description: Name of the on-prem cluster connected to this resource. ,
Required: False ,
}
string ,
clusterId:
{
Description: Unique id generated by the on-prem cluster. ,
Required: False ,
}
string ,
clusterVersion:
{
Description: Version of the cluster software. ,
Required: False ,
}
string ,
nodes:
{
Description: List of nodes reported by the cluster. ,
Required: False ,
}
[
{
name:
{
Description: Name of the cluster node. ,
Required: False ,
}
string ,
id:
{
Description: Id of the node in the cluster. ,
Format: float ,
Required: False ,
}
number ,
windowsServerSubscription:
{
Description: State of Windows Server Subscription. ,
Enum:
{
Disabled: Windows Server Subscription is disabled. ,
Enabled: Windows Server Subscription is enabled. ,
}
,
Required: False ,
}
enum ,
nodeType:
{
Description: Type of the cluster node hardware. ,
Enum:
{
FirstParty: All nodes in the cluster are provided and managed by Microsoft. ,
ThirdParty: All nodes in the cluster are provided and managed by a third-party vendor. ,
}
,
Required: False ,
}
enum ,
ehcResourceId:
{
Description: Edge Hardware Center Resource Id ,
Required: False ,
}
string ,
manufacturer:
{
Description: Manufacturer of the cluster node hardware. ,
Required: False ,
}
string ,
model:
{
Description: Model name of the cluster node hardware. ,
Required: False ,
}
string ,
osName:
{
Description: Operating system running on the cluster node. ,
Required: False ,
}
string ,
osVersion:
{
Description: Version of the operating system running on the cluster node. ,
Required: False ,
}
string ,
osDisplayVersion:
{
Description: Display version of the operating system running on the cluster node. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Immutable id of the cluster node. ,
Required: False ,
}
string ,
coreCount:
{
Description: Number of physical cores on the cluster node. ,
Format: float ,
Required: False ,
}
number ,
memoryInGiB:
{
Description: Total available memory on the cluster node (in GiB). ,
Format: float ,
Required: False ,
}
number ,
lastLicensingTimestamp:
{
Description: Most recent licensing timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
oemActivation:
{
Description: OEM activation status of the node. ,
Enum:
{
Disabled: OEM activation is disabled for the cluster. ,
Enabled: OEM activation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
lastUpdated:
{
Description: Last time the cluster reported the data. ,
Format: date-time ,
Required: False ,
}
string ,
msiExpirationTimeStamp:
{
Description: Specifies the expiration timestamp of the cluster's Managed Service Identity (MSI). The value is expressed in Coordinated Universal Time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
imdsAttestation:
{
Description: IMDS attestation status of the cluster. ,
Enum:
{
Disabled: IMDS attestation is disabled for the cluster. ,
Enabled: IMDS attestation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No diagnostic data will be emitted. ,
Basic: Basic diagnostic data will be emitted, including essential health metrics. ,
Enhanced: Enhanced diagnostic data will be emitted, including detailed performance and usage metrics. ,
}
,
Required: False ,
}
enum ,
supportedCapabilities:
{
Description: Capabilities supported by the cluster. ,
Required: False ,
}
[
string ,
]
,
clusterType:
{
Description: Specifies the type of hardware vendor for all nodes in the cluster. Indicates whether the nodes are provided by Microsoft or a third-party vendor. ,
Enum:
{
FirstParty: All nodes in the cluster are provided and managed by Microsoft. ,
ThirdParty: All nodes in the cluster are provided and managed by a third-party vendor. ,
}
,
Required: False ,
}
enum ,
manufacturer:
{
Description: The manufacturer of all the nodes of the cluster. ,
Required: False ,
}
string ,
oemActivation:
{
Description: OEM activation status of the cluster. ,
Enum:
{
Disabled: OEM activation is disabled for the cluster. ,
Enabled: OEM activation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
hardwareClass:
{
Description: Hardware class of the cluster. ,
Enum:
{
Small: The hardware class is small. ,
Medium: The hardware class is medium. This corresponds to the default ,
Large: The hardware class is large. ,
}
,
Required: False ,
}
enum ,
}
,
isolatedVmAttestationConfiguration:
{
Description: Attestation configurations for isolated VM (e.g. TVM, CVM) of the cluster. ,
Required: False ,
}
{
attestationResourceId:
{
Description: Fully qualified Azure resource id of the Microsoft Azure attestation resource associated with this cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
relyingPartyServiceEndpoint:
{
Description: Region specific endpoint for relying party service. ,
Required: False ,
}
string ,
attestationServiceEndpoint:
{
Description: Region specific endpoint for Microsoft Azure Attestation service for the cluster ,
Required: False ,
}
string ,
}
,
trialDaysRemaining:
{
Description: Number of days remaining in the trial period. ,
Format: float ,
Required: False ,
}
number ,
billingModel:
{
Description: Type of billing applied to the resource. ,
Required: False ,
}
string ,
registrationTimestamp:
{
Description: First cluster sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncTimestamp:
{
Description: Most recent cluster sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastBillingTimestamp:
{
Description: Most recent billing meter timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
serviceEndpoint:
{
Description: Region specific DataPath Endpoint of the cluster. ,
Required: False ,
}
string ,
resourceProviderObjectId:
{
Description: Object id of RP Service Principal ,
Required: False ,
}
string ,
secretsLocations:
{
Description: List of secret locations. ,
Required: False ,
}
[
{
secretsType:
{
Description: Type of secrets to store ,
Enum:
{
BackupSecrets: Backup secrets type ,
}
,
Required: True ,
}
enum ,
secretsLocation:
{
Description: secrets location ,
Required: True ,
}
string ,
}
,
]
,
clusterPattern:
{
Description: Supported Storage Type for HCI Cluster ,
Enum:
{
Standard: Standard cluster. ,
RackAware: RackAware cluster. ,
}
,
Required: False ,
}
enum ,
confidentialVmProperties:
{
Description: Represents the Confidential Virtual Machine (CVM) support intent and current status for the cluster resource. ,
Required: False ,
}
{
confidentialVmIntent:
{
Description: Captures the customer's intent to enable or disable CVM support on the cluster, either during initial deployment (Day-0) or at a later stage (Day-N). ,
Enum:
{
Enable: Indicates that the customer intends to enable CVM support on the cluster. ,
Disable: Indicates that the customer intends to disable CVM support on the cluster. ,
}
,
Required: False ,
}
enum ,
confidentialVmStatus:
{
Description: Captures the current status of CVM support on the cluster. ,
Enum:
{
Enabled: CVM support is fully enabled on the cluster. All nodes are CVM capable. ,
PartiallyEnabled: CVM support is partially enabled. At least one node in the cluster is CVM capable. ,
Disabled: CVM support is disabled. None of the nodes in the cluster are CVM capable. ,
}
,
Required: False ,
}
enum ,
confidentialVmStatusSummary:
{
Description: Additional context about CVM support on the cluster, such as reasons for partial enablement or hardware constraints. ,
Required: False ,
}
string ,
}
,
sdnProperties:
{
Description: Software Defined Networking Properties of the cluster ,
Required: False ,
}
{
sdnIntegrationIntent:
{
Description: Indicates whether Software Defined Networking (SDN) integration should be enabled or disabled for this deployment. ,
Enum:
{
Enable: Enable SDN integration for the deployment. ,
Disable: Disable SDN integration for the deployment. ,
}
,
Required: False ,
}
enum ,
}
,
localAvailabilityZones:
{
Description: Local Availability Zone information for HCI cluster ,
Required: False ,
}
[
{
localAvailabilityZoneName:
{
Description: Local Availability Zone name for HCI cluster ,
Required: False ,
}
string ,
nodes:
{
Description: Nodes belonging to a particular zone ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
identityProvider:
{
Description: Identity Provider for the cluster ,
Enum:
{
ActiveDirectory: Uses Active Directory as the identity provider, enabling domain-based authentication and centralized identity management. This is the default option. ,
LocalIdentity: Uses a local identity system integrated with Azure Key Vault for authentication. Suitable for AD-less environments where Active Directory is not available or required. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
kind:
{
Description: This property identifies the purpose of the Cluster deployment. For example, a valid value is AzureLocal ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_Get (removed)
Description :  Get HCI cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Cluster properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state. Indicates the current lifecycle status of the resource, including creation, update, deletion, connectivity, and error states. ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Status of the cluster agent. Indicates the current connectivity, validation, and deployment state of the agent within the cluster. ,
Enum:
{
NotYetRegistered: The cluster agent has not yet registered with Azure. ,
ConnectedRecently: The cluster agent has connected to Azure recently. ,
NotConnectedRecently: The cluster agent has not connected to Azure recently. ,
Disconnected: The cluster agent is currently disconnected from Azure. ,
Error: An error occurred in the cluster agent's operation. ,
NotSpecified: The status of the cluster agent is not specified. ,
ValidationInProgress: Validation of the cluster agent is currently in progress. ,
ValidationSuccess: Validation of the cluster agent completed successfully. ,
ValidationFailed: Validation of the cluster agent failed. ,
DeploymentInProgress: Deployment of the cluster agent is currently in progress. ,
DeploymentFailed: Deployment of the cluster agent failed. ,
DeploymentSuccess: Deployment of the cluster agent completed successfully. ,
}
,
Required: False ,
}
enum ,
connectivityStatus:
{
Description: Overall connectivity status for the cluster resource. Indicates whether the cluster is connected to Azure, partially connected, or has not recently communicated. ,
Enum:
{
NotYetRegistered: The cluster has not yet registered with Azure. ,
Connected: The cluster is fully connected to Azure. ,
NotConnectedRecently: The cluster has not connected to Azure recently. ,
PartiallyConnected: Some components of the cluster are connected, while others are not. ,
Disconnected: The cluster is not connected to Azure. ,
NotSpecified: The connectivity status is not specified. ,
}
,
Required: False ,
}
enum ,
supportStatus:
{
Description: Indicates whether the cluster is under support. ,
Enum:
{
InSupport: The cluster is under support. ,
OutOfSupport: The cluster is out of support. ,
NotSpecified: The support status is not specified. ,
}
,
Required: False ,
}
enum ,
cloudId:
{
Description: Unique, immutable resource id. ,
Required: False ,
}
string ,
ring:
{
Description: The ring to which this cluster belongs to. ,
Required: False ,
}
string ,
cloudManagementEndpoint:
{
Description: Endpoint configured for management from the Azure portal. ,
Required: False ,
}
string ,
aadClientId:
{
Description: App id of cluster AAD identity. ,
Required: False ,
}
string ,
aadTenantId:
{
Description: Tenant id of cluster AAD identity. ,
Required: False ,
}
string ,
aadApplicationObjectId:
{
Description: Object id of cluster AAD identity. ,
Required: False ,
}
string ,
aadServicePrincipalObjectId:
{
Description: Id of cluster identity service principal. ,
Required: False ,
}
string ,
softwareAssuranceProperties:
{
Description: Software Assurance properties of the cluster. ,
Required: False ,
}
{
softwareAssuranceStatus:
{
Description: Status of the Software Assurance for the cluster. ,
Enum:
{
Enabled: Software Assurance is enabled for the cluster. ,
Disabled: Software Assurance is disabled for the cluster. ,
}
,
Required: False ,
}
enum ,
softwareAssuranceIntent:
{
Description: Customer Intent for Software Assurance Benefit. ,
Enum:
{
Enable: Customer intends to enable the Software Assurance benefit. ,
Disable: Customer intends to disable the Software Assurance benefit. ,
}
,
Required: False ,
}
enum ,
lastUpdated:
{
Description: TimeStamp denoting the latest SA benefit applicability is validated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
isManagementCluster:
{
Description: Is Management Cluster, when true indicates that the cluster is used for managing other clusters ,
Required: False ,
}
boolean ,
logCollectionProperties:
{
Description: Log Collection properties of the cluster. ,
Required: False ,
}
{
fromDate:
{
Description: From DateTimeStamp from when logs need to be connected ,
Format: date-time ,
Required: False ,
}
string ,
toDate:
{
Description: To DateTimeStamp till when logs need to be connected ,
Format: date-time ,
Required: False ,
}
string ,
lastLogGenerated:
{
Description: Recent DateTimeStamp where logs are successfully generated ,
Format: date-time ,
Required: False ,
}
string ,
logCollectionSessionDetails:
{
Required: False ,
}
[
{
logStartTime:
{
Description: Start Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
logEndTime:
{
Description: End Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
timeCollected:
{
Description: Duration of logs collected ,
Format: date-time ,
Required: False ,
}
string ,
logSize:
{
Description: Size of the logs collected ,
Format: int64 ,
Required: False ,
}
integer ,
logCollectionStatus:
{
Description: LogCollection status ,
Enum:
{
None: No log collection has been initiated. ,
InProgress: Log collection is currently in progress. ,
Failed: Log collection has failed. ,
Succeeded: Log collection completed successfully. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: CorrelationId of the log collection ,
Required: False ,
}
string ,
logCollectionJobType:
{
Description: Specifies the type of log collection job. Determines whether the logs are collected immediately on demand or as part of a scheduled operation. ,
Enum:
{
OnDemand: Log collection is triggered manually and executed immediately. ,
Scheduled: Log collection is scheduled to run at a predefined time or interval. ,
}
,
Required: False ,
}
enum ,
endTimeCollected:
{
Description: End Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
logCollectionError:
{
Description: Log Collection Error details of the cluster. ,
Required: False ,
}
{
errorCode:
{
Description: Error Code of the log collection ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error Message of the log collection ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
remoteSupportProperties:
{
Description: RemoteSupport properties of the cluster. ,
Required: False ,
}
{
accessLevel:
{
Description: Remote Support Access Level ,
Enum:
{
Diagnostics: Allows remote diagnostics operations only. ,
DiagnosticsAndRepair: Allows both remote diagnostics and repair operations. ,
}
,
Required: False ,
}
enum ,
expirationTimeStamp:
{
Description: Expiration DateTimeStamp when Remote Support Access will be expired ,
Format: date-time ,
Required: False ,
}
string ,
remoteSupportType:
{
Description: Remote Support Type for cluster ,
Enum:
{
Enable: Enable remote support for the cluster. ,
Revoke: Revoke previously enabled remote support for the cluster. ,
}
,
Required: False ,
}
enum ,
remoteSupportNodeSettings:
{
Required: False ,
}
[
{
arcResourceId:
{
Description: Arc ResourceId of the Node ,
Required: False ,
}
string ,
state:
{
Description: Remote Support Access Connection State on the Node ,
Required: False ,
}
string ,
createdAt:
{
Description: Remote Support Enablement Request Created TimeStamp on the Node ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: Remote Support Enablement Request Updated TimeStamp on the Node ,
Format: date-time ,
Required: False ,
}
string ,
connectionStatus:
{
Description: Remote Support Access Connection Status on the Node ,
Required: False ,
}
string ,
connectionErrorMessage:
{
Description: Remote Support Access Connection Error Message on the Node ,
Required: False ,
}
string ,
transcriptLocation:
{
Description: Remote Support Transcript location on the node ,
Required: False ,
}
string ,
}
,
]
,
remoteSupportSessionDetails:
{
Required: False ,
}
[
{
sessionStartTime:
{
Description: Remote Support Session StartTime on the Node ,
Format: date-time ,
Required: False ,
}
string ,
sessionEndTime:
{
Description: Remote Support Session EndTime on the Node ,
Format: date-time ,
Required: False ,
}
string ,
nodeName:
{
Description: Name of the node ,
Required: False ,
}
string ,
duration:
{
Description: Duration of Remote Support Enablement ,
Format: int64 ,
Required: False ,
}
integer ,
accessLevel:
{
Description: Remote Support Access Level ,
Enum:
{
Diagnostics: Allows remote diagnostics operations only. ,
DiagnosticsAndRepair: Allows both remote diagnostics and repair operations. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
desiredProperties:
{
Description: Desired properties of the cluster. ,
Required: False ,
}
{
windowsServerSubscription:
{
Description: Desired state of Windows Server Subscription. ,
Enum:
{
Disabled: Windows Server Subscription is disabled. ,
Enabled: Windows Server Subscription is enabled. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Desired level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No diagnostic data will be emitted. ,
Basic: Basic diagnostic data will be emitted, including essential health metrics. ,
Enhanced: Enhanced diagnostic data will be emitted, including detailed performance and usage metrics. ,
}
,
Required: False ,
}
enum ,
}
,
reportedProperties:
{
Description: Properties reported by cluster agent. ,
Required: False ,
}
{
clusterName:
{
Description: Name of the on-prem cluster connected to this resource. ,
Required: False ,
}
string ,
clusterId:
{
Description: Unique id generated by the on-prem cluster. ,
Required: False ,
}
string ,
clusterVersion:
{
Description: Version of the cluster software. ,
Required: False ,
}
string ,
nodes:
{
Description: List of nodes reported by the cluster. ,
Required: False ,
}
[
{
name:
{
Description: Name of the cluster node. ,
Required: False ,
}
string ,
id:
{
Description: Id of the node in the cluster. ,
Format: float ,
Required: False ,
}
number ,
windowsServerSubscription:
{
Description: State of Windows Server Subscription. ,
Enum:
{
Disabled: Windows Server Subscription is disabled. ,
Enabled: Windows Server Subscription is enabled. ,
}
,
Required: False ,
}
enum ,
nodeType:
{
Description: Type of the cluster node hardware. ,
Enum:
{
FirstParty: All nodes in the cluster are provided and managed by Microsoft. ,
ThirdParty: All nodes in the cluster are provided and managed by a third-party vendor. ,
}
,
Required: False ,
}
enum ,
ehcResourceId:
{
Description: Edge Hardware Center Resource Id ,
Required: False ,
}
string ,
manufacturer:
{
Description: Manufacturer of the cluster node hardware. ,
Required: False ,
}
string ,
model:
{
Description: Model name of the cluster node hardware. ,
Required: False ,
}
string ,
osName:
{
Description: Operating system running on the cluster node. ,
Required: False ,
}
string ,
osVersion:
{
Description: Version of the operating system running on the cluster node. ,
Required: False ,
}
string ,
osDisplayVersion:
{
Description: Display version of the operating system running on the cluster node. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Immutable id of the cluster node. ,
Required: False ,
}
string ,
coreCount:
{
Description: Number of physical cores on the cluster node. ,
Format: float ,
Required: False ,
}
number ,
memoryInGiB:
{
Description: Total available memory on the cluster node (in GiB). ,
Format: float ,
Required: False ,
}
number ,
lastLicensingTimestamp:
{
Description: Most recent licensing timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
oemActivation:
{
Description: OEM activation status of the node. ,
Enum:
{
Disabled: OEM activation is disabled for the cluster. ,
Enabled: OEM activation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
lastUpdated:
{
Description: Last time the cluster reported the data. ,
Format: date-time ,
Required: False ,
}
string ,
msiExpirationTimeStamp:
{
Description: Specifies the expiration timestamp of the cluster's Managed Service Identity (MSI). The value is expressed in Coordinated Universal Time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
imdsAttestation:
{
Description: IMDS attestation status of the cluster. ,
Enum:
{
Disabled: IMDS attestation is disabled for the cluster. ,
Enabled: IMDS attestation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No diagnostic data will be emitted. ,
Basic: Basic diagnostic data will be emitted, including essential health metrics. ,
Enhanced: Enhanced diagnostic data will be emitted, including detailed performance and usage metrics. ,
}
,
Required: False ,
}
enum ,
supportedCapabilities:
{
Description: Capabilities supported by the cluster. ,
Required: False ,
}
[
string ,
]
,
clusterType:
{
Description: Specifies the type of hardware vendor for all nodes in the cluster. Indicates whether the nodes are provided by Microsoft or a third-party vendor. ,
Enum:
{
FirstParty: All nodes in the cluster are provided and managed by Microsoft. ,
ThirdParty: All nodes in the cluster are provided and managed by a third-party vendor. ,
}
,
Required: False ,
}
enum ,
manufacturer:
{
Description: The manufacturer of all the nodes of the cluster. ,
Required: False ,
}
string ,
oemActivation:
{
Description: OEM activation status of the cluster. ,
Enum:
{
Disabled: OEM activation is disabled for the cluster. ,
Enabled: OEM activation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
hardwareClass:
{
Description: Hardware class of the cluster. ,
Enum:
{
Small: The hardware class is small. ,
Medium: The hardware class is medium. This corresponds to the default ,
Large: The hardware class is large. ,
}
,
Required: False ,
}
enum ,
}
,
isolatedVmAttestationConfiguration:
{
Description: Attestation configurations for isolated VM (e.g. TVM, CVM) of the cluster. ,
Required: False ,
}
{
attestationResourceId:
{
Description: Fully qualified Azure resource id of the Microsoft Azure attestation resource associated with this cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
relyingPartyServiceEndpoint:
{
Description: Region specific endpoint for relying party service. ,
Required: False ,
}
string ,
attestationServiceEndpoint:
{
Description: Region specific endpoint for Microsoft Azure Attestation service for the cluster ,
Required: False ,
}
string ,
}
,
trialDaysRemaining:
{
Description: Number of days remaining in the trial period. ,
Format: float ,
Required: False ,
}
number ,
billingModel:
{
Description: Type of billing applied to the resource. ,
Required: False ,
}
string ,
registrationTimestamp:
{
Description: First cluster sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncTimestamp:
{
Description: Most recent cluster sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastBillingTimestamp:
{
Description: Most recent billing meter timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
serviceEndpoint:
{
Description: Region specific DataPath Endpoint of the cluster. ,
Required: False ,
}
string ,
resourceProviderObjectId:
{
Description: Object id of RP Service Principal ,
Required: False ,
}
string ,
secretsLocations:
{
Description: List of secret locations. ,
Required: False ,
}
[
{
secretsType:
{
Description: Type of secrets to store ,
Enum:
{
BackupSecrets: Backup secrets type ,
}
,
Required: True ,
}
enum ,
secretsLocation:
{
Description: secrets location ,
Required: True ,
}
string ,
}
,
]
,
clusterPattern:
{
Description: Supported Storage Type for HCI Cluster ,
Enum:
{
Standard: Standard cluster. ,
RackAware: RackAware cluster. ,
}
,
Required: False ,
}
enum ,
confidentialVmProperties:
{
Description: Represents the Confidential Virtual Machine (CVM) support intent and current status for the cluster resource. ,
Required: False ,
}
{
confidentialVmIntent:
{
Description: Captures the customer's intent to enable or disable CVM support on the cluster, either during initial deployment (Day-0) or at a later stage (Day-N). ,
Enum:
{
Enable: Indicates that the customer intends to enable CVM support on the cluster. ,
Disable: Indicates that the customer intends to disable CVM support on the cluster. ,
}
,
Required: False ,
}
enum ,
confidentialVmStatus:
{
Description: Captures the current status of CVM support on the cluster. ,
Enum:
{
Enabled: CVM support is fully enabled on the cluster. All nodes are CVM capable. ,
PartiallyEnabled: CVM support is partially enabled. At least one node in the cluster is CVM capable. ,
Disabled: CVM support is disabled. None of the nodes in the cluster are CVM capable. ,
}
,
Required: False ,
}
enum ,
confidentialVmStatusSummary:
{
Description: Additional context about CVM support on the cluster, such as reasons for partial enablement or hardware constraints. ,
Required: False ,
}
string ,
}
,
sdnProperties:
{
Description: Software Defined Networking Properties of the cluster ,
Required: False ,
}
{
sdnIntegrationIntent:
{
Description: Indicates whether Software Defined Networking (SDN) integration should be enabled or disabled for this deployment. ,
Enum:
{
Enable: Enable SDN integration for the deployment. ,
Disable: Disable SDN integration for the deployment. ,
}
,
Required: False ,
}
enum ,
}
,
localAvailabilityZones:
{
Description: Local Availability Zone information for HCI cluster ,
Required: False ,
}
[
{
localAvailabilityZoneName:
{
Description: Local Availability Zone name for HCI cluster ,
Required: False ,
}
string ,
nodes:
{
Description: Nodes belonging to a particular zone ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
identityProvider:
{
Description: Identity Provider for the cluster ,
Enum:
{
ActiveDirectory: Uses Active Directory as the identity provider, enabling domain-based authentication and centralized identity management. This is the default option. ,
LocalIdentity: Uses a local identity system integrated with Azure Key Vault for authentication. Suitable for AD-less environments where Active Directory is not available or required. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
kind:
{
Description: This property identifies the purpose of the Cluster deployment. For example, a valid value is AzureLocal ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_Create (removed)
Description :  Create an HCI cluster.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
cluster:
{
Description: Details of the HCI cluster. ,
Required: True ,
}
{
properties:
{
Description: Cluster properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state. Indicates the current lifecycle status of the resource, including creation, update, deletion, connectivity, and error states. ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Status of the cluster agent. Indicates the current connectivity, validation, and deployment state of the agent within the cluster. ,
Enum:
{
NotYetRegistered: The cluster agent has not yet registered with Azure. ,
ConnectedRecently: The cluster agent has connected to Azure recently. ,
NotConnectedRecently: The cluster agent has not connected to Azure recently. ,
Disconnected: The cluster agent is currently disconnected from Azure. ,
Error: An error occurred in the cluster agent's operation. ,
NotSpecified: The status of the cluster agent is not specified. ,
ValidationInProgress: Validation of the cluster agent is currently in progress. ,
ValidationSuccess: Validation of the cluster agent completed successfully. ,
ValidationFailed: Validation of the cluster agent failed. ,
DeploymentInProgress: Deployment of the cluster agent is currently in progress. ,
DeploymentFailed: Deployment of the cluster agent failed. ,
DeploymentSuccess: Deployment of the cluster agent completed successfully. ,
}
,
Required: False ,
}
enum ,
connectivityStatus:
{
Description: Overall connectivity status for the cluster resource. Indicates whether the cluster is connected to Azure, partially connected, or has not recently communicated. ,
Enum:
{
NotYetRegistered: The cluster has not yet registered with Azure. ,
Connected: The cluster is fully connected to Azure. ,
NotConnectedRecently: The cluster has not connected to Azure recently. ,
PartiallyConnected: Some components of the cluster are connected, while others are not. ,
Disconnected: The cluster is not connected to Azure. ,
NotSpecified: The connectivity status is not specified. ,
}
,
Required: False ,
}
enum ,
supportStatus:
{
Description: Indicates whether the cluster is under support. ,
Enum:
{
InSupport: The cluster is under support. ,
OutOfSupport: The cluster is out of support. ,
NotSpecified: The support status is not specified. ,
}
,
Required: False ,
}
enum ,
cloudId:
{
Description: Unique, immutable resource id. ,
Required: False ,
}
string ,
ring:
{
Description: The ring to which this cluster belongs to. ,
Required: False ,
}
string ,
cloudManagementEndpoint:
{
Description: Endpoint configured for management from the Azure portal. ,
Required: False ,
}
string ,
aadClientId:
{
Description: App id of cluster AAD identity. ,
Required: False ,
}
string ,
aadTenantId:
{
Description: Tenant id of cluster AAD identity. ,
Required: False ,
}
string ,
aadApplicationObjectId:
{
Description: Object id of cluster AAD identity. ,
Required: False ,
}
string ,
aadServicePrincipalObjectId:
{
Description: Id of cluster identity service principal. ,
Required: False ,
}
string ,
softwareAssuranceProperties:
{
Description: Software Assurance properties of the cluster. ,
Required: False ,
}
{
softwareAssuranceStatus:
{
Description: Status of the Software Assurance for the cluster. ,
Enum:
{
Enabled: Software Assurance is enabled for the cluster. ,
Disabled: Software Assurance is disabled for the cluster. ,
}
,
Required: False ,
}
enum ,
softwareAssuranceIntent:
{
Description: Customer Intent for Software Assurance Benefit. ,
Enum:
{
Enable: Customer intends to enable the Software Assurance benefit. ,
Disable: Customer intends to disable the Software Assurance benefit. ,
}
,
Required: False ,
}
enum ,
lastUpdated:
{
Description: TimeStamp denoting the latest SA benefit applicability is validated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
isManagementCluster:
{
Description: Is Management Cluster, when true indicates that the cluster is used for managing other clusters ,
Required: False ,
}
boolean ,
logCollectionProperties:
{
Description: Log Collection properties of the cluster. ,
Required: False ,
}
{
fromDate:
{
Description: From DateTimeStamp from when logs need to be connected ,
Format: date-time ,
Required: False ,
}
string ,
toDate:
{
Description: To DateTimeStamp till when logs need to be connected ,
Format: date-time ,
Required: False ,
}
string ,
lastLogGenerated:
{
Description: Recent DateTimeStamp where logs are successfully generated ,
Format: date-time ,
Required: False ,
}
string ,
logCollectionSessionDetails:
{
Required: False ,
}
[
{
logStartTime:
{
Description: Start Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
logEndTime:
{
Description: End Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
timeCollected:
{
Description: Duration of logs collected ,
Format: date-time ,
Required: False ,
}
string ,
logSize:
{
Description: Size of the logs collected ,
Format: int64 ,
Required: False ,
}
integer ,
logCollectionStatus:
{
Description: LogCollection status ,
Enum:
{
None: No log collection has been initiated. ,
InProgress: Log collection is currently in progress. ,
Failed: Log collection has failed. ,
Succeeded: Log collection completed successfully. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: CorrelationId of the log collection ,
Required: False ,
}
string ,
logCollectionJobType:
{
Description: Specifies the type of log collection job. Determines whether the logs are collected immediately on demand or as part of a scheduled operation. ,
Enum:
{
OnDemand: Log collection is triggered manually and executed immediately. ,
Scheduled: Log collection is scheduled to run at a predefined time or interval. ,
}
,
Required: False ,
}
enum ,
endTimeCollected:
{
Description: End Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
logCollectionError:
{
Description: Log Collection Error details of the cluster. ,
Required: False ,
}
{
errorCode:
{
Description: Error Code of the log collection ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error Message of the log collection ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
remoteSupportProperties:
{
Description: RemoteSupport properties of the cluster. ,
Required: False ,
}
{
accessLevel:
{
Description: Remote Support Access Level ,
Enum:
{
Diagnostics: Allows remote diagnostics operations only. ,
DiagnosticsAndRepair: Allows both remote diagnostics and repair operations. ,
}
,
Required: False ,
}
enum ,
expirationTimeStamp:
{
Description: Expiration DateTimeStamp when Remote Support Access will be expired ,
Format: date-time ,
Required: False ,
}
string ,
remoteSupportType:
{
Description: Remote Support Type for cluster ,
Enum:
{
Enable: Enable remote support for the cluster. ,
Revoke: Revoke previously enabled remote support for the cluster. ,
}
,
Required: False ,
}
enum ,
remoteSupportNodeSettings:
{
Required: False ,
}
[
{
arcResourceId:
{
Description: Arc ResourceId of the Node ,
Required: False ,
}
string ,
state:
{
Description: Remote Support Access Connection State on the Node ,
Required: False ,
}
string ,
createdAt:
{
Description: Remote Support Enablement Request Created TimeStamp on the Node ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: Remote Support Enablement Request Updated TimeStamp on the Node ,
Format: date-time ,
Required: False ,
}
string ,
connectionStatus:
{
Description: Remote Support Access Connection Status on the Node ,
Required: False ,
}
string ,
connectionErrorMessage:
{
Description: Remote Support Access Connection Error Message on the Node ,
Required: False ,
}
string ,
transcriptLocation:
{
Description: Remote Support Transcript location on the node ,
Required: False ,
}
string ,
}
,
]
,
remoteSupportSessionDetails:
{
Required: False ,
}
[
{
sessionStartTime:
{
Description: Remote Support Session StartTime on the Node ,
Format: date-time ,
Required: False ,
}
string ,
sessionEndTime:
{
Description: Remote Support Session EndTime on the Node ,
Format: date-time ,
Required: False ,
}
string ,
nodeName:
{
Description: Name of the node ,
Required: False ,
}
string ,
duration:
{
Description: Duration of Remote Support Enablement ,
Format: int64 ,
Required: False ,
}
integer ,
accessLevel:
{
Description: Remote Support Access Level ,
Enum:
{
Diagnostics: Allows remote diagnostics operations only. ,
DiagnosticsAndRepair: Allows both remote diagnostics and repair operations. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
desiredProperties:
{
Description: Desired properties of the cluster. ,
Required: False ,
}
{
windowsServerSubscription:
{
Description: Desired state of Windows Server Subscription. ,
Enum:
{
Disabled: Windows Server Subscription is disabled. ,
Enabled: Windows Server Subscription is enabled. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Desired level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No diagnostic data will be emitted. ,
Basic: Basic diagnostic data will be emitted, including essential health metrics. ,
Enhanced: Enhanced diagnostic data will be emitted, including detailed performance and usage metrics. ,
}
,
Required: False ,
}
enum ,
}
,
reportedProperties:
{
Description: Properties reported by cluster agent. ,
Required: False ,
}
{
clusterName:
{
Description: Name of the on-prem cluster connected to this resource. ,
Required: False ,
}
string ,
clusterId:
{
Description: Unique id generated by the on-prem cluster. ,
Required: False ,
}
string ,
clusterVersion:
{
Description: Version of the cluster software. ,
Required: False ,
}
string ,
nodes:
{
Description: List of nodes reported by the cluster. ,
Required: False ,
}
[
{
name:
{
Description: Name of the cluster node. ,
Required: False ,
}
string ,
id:
{
Description: Id of the node in the cluster. ,
Format: float ,
Required: False ,
}
number ,
windowsServerSubscription:
{
Description: State of Windows Server Subscription. ,
Enum:
{
Disabled: Windows Server Subscription is disabled. ,
Enabled: Windows Server Subscription is enabled. ,
}
,
Required: False ,
}
enum ,
nodeType:
{
Description: Type of the cluster node hardware. ,
Enum:
{
FirstParty: All nodes in the cluster are provided and managed by Microsoft. ,
ThirdParty: All nodes in the cluster are provided and managed by a third-party vendor. ,
}
,
Required: False ,
}
enum ,
ehcResourceId:
{
Description: Edge Hardware Center Resource Id ,
Required: False ,
}
string ,
manufacturer:
{
Description: Manufacturer of the cluster node hardware. ,
Required: False ,
}
string ,
model:
{
Description: Model name of the cluster node hardware. ,
Required: False ,
}
string ,
osName:
{
Description: Operating system running on the cluster node. ,
Required: False ,
}
string ,
osVersion:
{
Description: Version of the operating system running on the cluster node. ,
Required: False ,
}
string ,
osDisplayVersion:
{
Description: Display version of the operating system running on the cluster node. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Immutable id of the cluster node. ,
Required: False ,
}
string ,
coreCount:
{
Description: Number of physical cores on the cluster node. ,
Format: float ,
Required: False ,
}
number ,
memoryInGiB:
{
Description: Total available memory on the cluster node (in GiB). ,
Format: float ,
Required: False ,
}
number ,
lastLicensingTimestamp:
{
Description: Most recent licensing timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
oemActivation:
{
Description: OEM activation status of the node. ,
Enum:
{
Disabled: OEM activation is disabled for the cluster. ,
Enabled: OEM activation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
lastUpdated:
{
Description: Last time the cluster reported the data. ,
Format: date-time ,
Required: False ,
}
string ,
msiExpirationTimeStamp:
{
Description: Specifies the expiration timestamp of the cluster's Managed Service Identity (MSI). The value is expressed in Coordinated Universal Time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
imdsAttestation:
{
Description: IMDS attestation status of the cluster. ,
Enum:
{
Disabled: IMDS attestation is disabled for the cluster. ,
Enabled: IMDS attestation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No diagnostic data will be emitted. ,
Basic: Basic diagnostic data will be emitted, including essential health metrics. ,
Enhanced: Enhanced diagnostic data will be emitted, including detailed performance and usage metrics. ,
}
,
Required: False ,
}
enum ,
supportedCapabilities:
{
Description: Capabilities supported by the cluster. ,
Required: False ,
}
[
string ,
]
,
clusterType:
{
Description: Specifies the type of hardware vendor for all nodes in the cluster. Indicates whether the nodes are provided by Microsoft or a third-party vendor. ,
Enum:
{
FirstParty: All nodes in the cluster are provided and managed by Microsoft. ,
ThirdParty: All nodes in the cluster are provided and managed by a third-party vendor. ,
}
,
Required: False ,
}
enum ,
manufacturer:
{
Description: The manufacturer of all the nodes of the cluster. ,
Required: False ,
}
string ,
oemActivation:
{
Description: OEM activation status of the cluster. ,
Enum:
{
Disabled: OEM activation is disabled for the cluster. ,
Enabled: OEM activation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
hardwareClass:
{
Description: Hardware class of the cluster. ,
Enum:
{
Small: The hardware class is small. ,
Medium: The hardware class is medium. This corresponds to the default ,
Large: The hardware class is large. ,
}
,
Required: False ,
}
enum ,
}
,
isolatedVmAttestationConfiguration:
{
Description: Attestation configurations for isolated VM (e.g. TVM, CVM) of the cluster. ,
Required: False ,
}
{
attestationResourceId:
{
Description: Fully qualified Azure resource id of the Microsoft Azure attestation resource associated with this cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
relyingPartyServiceEndpoint:
{
Description: Region specific endpoint for relying party service. ,
Required: False ,
}
string ,
attestationServiceEndpoint:
{
Description: Region specific endpoint for Microsoft Azure Attestation service for the cluster ,
Required: False ,
}
string ,
}
,
trialDaysRemaining:
{
Description: Number of days remaining in the trial period. ,
Format: float ,
Required: False ,
}
number ,
billingModel:
{
Description: Type of billing applied to the resource. ,
Required: False ,
}
string ,
registrationTimestamp:
{
Description: First cluster sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncTimestamp:
{
Description: Most recent cluster sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastBillingTimestamp:
{
Description: Most recent billing meter timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
serviceEndpoint:
{
Description: Region specific DataPath Endpoint of the cluster. ,
Required: False ,
}
string ,
resourceProviderObjectId:
{
Description: Object id of RP Service Principal ,
Required: False ,
}
string ,
secretsLocations:
{
Description: List of secret locations. ,
Required: False ,
}
[
{
secretsType:
{
Description: Type of secrets to store ,
Enum:
{
BackupSecrets: Backup secrets type ,
}
,
Required: True ,
}
enum ,
secretsLocation:
{
Description: secrets location ,
Required: True ,
}
string ,
}
,
]
,
clusterPattern:
{
Description: Supported Storage Type for HCI Cluster ,
Enum:
{
Standard: Standard cluster. ,
RackAware: RackAware cluster. ,
}
,
Required: False ,
}
enum ,
confidentialVmProperties:
{
Description: Represents the Confidential Virtual Machine (CVM) support intent and current status for the cluster resource. ,
Required: False ,
}
{
confidentialVmIntent:
{
Description: Captures the customer's intent to enable or disable CVM support on the cluster, either during initial deployment (Day-0) or at a later stage (Day-N). ,
Enum:
{
Enable: Indicates that the customer intends to enable CVM support on the cluster. ,
Disable: Indicates that the customer intends to disable CVM support on the cluster. ,
}
,
Required: False ,
}
enum ,
confidentialVmStatus:
{
Description: Captures the current status of CVM support on the cluster. ,
Enum:
{
Enabled: CVM support is fully enabled on the cluster. All nodes are CVM capable. ,
PartiallyEnabled: CVM support is partially enabled. At least one node in the cluster is CVM capable. ,
Disabled: CVM support is disabled. None of the nodes in the cluster are CVM capable. ,
}
,
Required: False ,
}
enum ,
confidentialVmStatusSummary:
{
Description: Additional context about CVM support on the cluster, such as reasons for partial enablement or hardware constraints. ,
Required: False ,
}
string ,
}
,
sdnProperties:
{
Description: Software Defined Networking Properties of the cluster ,
Required: False ,
}
{
sdnIntegrationIntent:
{
Description: Indicates whether Software Defined Networking (SDN) integration should be enabled or disabled for this deployment. ,
Enum:
{
Enable: Enable SDN integration for the deployment. ,
Disable: Disable SDN integration for the deployment. ,
}
,
Required: False ,
}
enum ,
}
,
localAvailabilityZones:
{
Description: Local Availability Zone information for HCI cluster ,
Required: False ,
}
[
{
localAvailabilityZoneName:
{
Description: Local Availability Zone name for HCI cluster ,
Required: False ,
}
string ,
nodes:
{
Description: Nodes belonging to a particular zone ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
identityProvider:
{
Description: Identity Provider for the cluster ,
Enum:
{
ActiveDirectory: Uses Active Directory as the identity provider, enabling domain-based authentication and centralized identity management. This is the default option. ,
LocalIdentity: Uses a local identity system integrated with Azure Key Vault for authentication. Suitable for AD-less environments where Active Directory is not available or required. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
kind:
{
Description: This property identifies the purpose of the Cluster deployment. For example, a valid value is AzureLocal ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Cluster properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state. Indicates the current lifecycle status of the resource, including creation, update, deletion, connectivity, and error states. ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Status of the cluster agent. Indicates the current connectivity, validation, and deployment state of the agent within the cluster. ,
Enum:
{
NotYetRegistered: The cluster agent has not yet registered with Azure. ,
ConnectedRecently: The cluster agent has connected to Azure recently. ,
NotConnectedRecently: The cluster agent has not connected to Azure recently. ,
Disconnected: The cluster agent is currently disconnected from Azure. ,
Error: An error occurred in the cluster agent's operation. ,
NotSpecified: The status of the cluster agent is not specified. ,
ValidationInProgress: Validation of the cluster agent is currently in progress. ,
ValidationSuccess: Validation of the cluster agent completed successfully. ,
ValidationFailed: Validation of the cluster agent failed. ,
DeploymentInProgress: Deployment of the cluster agent is currently in progress. ,
DeploymentFailed: Deployment of the cluster agent failed. ,
DeploymentSuccess: Deployment of the cluster agent completed successfully. ,
}
,
Required: False ,
}
enum ,
connectivityStatus:
{
Description: Overall connectivity status for the cluster resource. Indicates whether the cluster is connected to Azure, partially connected, or has not recently communicated. ,
Enum:
{
NotYetRegistered: The cluster has not yet registered with Azure. ,
Connected: The cluster is fully connected to Azure. ,
NotConnectedRecently: The cluster has not connected to Azure recently. ,
PartiallyConnected: Some components of the cluster are connected, while others are not. ,
Disconnected: The cluster is not connected to Azure. ,
NotSpecified: The connectivity status is not specified. ,
}
,
Required: False ,
}
enum ,
supportStatus:
{
Description: Indicates whether the cluster is under support. ,
Enum:
{
InSupport: The cluster is under support. ,
OutOfSupport: The cluster is out of support. ,
NotSpecified: The support status is not specified. ,
}
,
Required: False ,
}
enum ,
cloudId:
{
Description: Unique, immutable resource id. ,
Required: False ,
}
string ,
ring:
{
Description: The ring to which this cluster belongs to. ,
Required: False ,
}
string ,
cloudManagementEndpoint:
{
Description: Endpoint configured for management from the Azure portal. ,
Required: False ,
}
string ,
aadClientId:
{
Description: App id of cluster AAD identity. ,
Required: False ,
}
string ,
aadTenantId:
{
Description: Tenant id of cluster AAD identity. ,
Required: False ,
}
string ,
aadApplicationObjectId:
{
Description: Object id of cluster AAD identity. ,
Required: False ,
}
string ,
aadServicePrincipalObjectId:
{
Description: Id of cluster identity service principal. ,
Required: False ,
}
string ,
softwareAssuranceProperties:
{
Description: Software Assurance properties of the cluster. ,
Required: False ,
}
{
softwareAssuranceStatus:
{
Description: Status of the Software Assurance for the cluster. ,
Enum:
{
Enabled: Software Assurance is enabled for the cluster. ,
Disabled: Software Assurance is disabled for the cluster. ,
}
,
Required: False ,
}
enum ,
softwareAssuranceIntent:
{
Description: Customer Intent for Software Assurance Benefit. ,
Enum:
{
Enable: Customer intends to enable the Software Assurance benefit. ,
Disable: Customer intends to disable the Software Assurance benefit. ,
}
,
Required: False ,
}
enum ,
lastUpdated:
{
Description: TimeStamp denoting the latest SA benefit applicability is validated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
isManagementCluster:
{
Description: Is Management Cluster, when true indicates that the cluster is used for managing other clusters ,
Required: False ,
}
boolean ,
logCollectionProperties:
{
Description: Log Collection properties of the cluster. ,
Required: False ,
}
{
fromDate:
{
Description: From DateTimeStamp from when logs need to be connected ,
Format: date-time ,
Required: False ,
}
string ,
toDate:
{
Description: To DateTimeStamp till when logs need to be connected ,
Format: date-time ,
Required: False ,
}
string ,
lastLogGenerated:
{
Description: Recent DateTimeStamp where logs are successfully generated ,
Format: date-time ,
Required: False ,
}
string ,
logCollectionSessionDetails:
{
Required: False ,
}
[
{
logStartTime:
{
Description: Start Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
logEndTime:
{
Description: End Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
timeCollected:
{
Description: Duration of logs collected ,
Format: date-time ,
Required: False ,
}
string ,
logSize:
{
Description: Size of the logs collected ,
Format: int64 ,
Required: False ,
}
integer ,
logCollectionStatus:
{
Description: LogCollection status ,
Enum:
{
None: No log collection has been initiated. ,
InProgress: Log collection is currently in progress. ,
Failed: Log collection has failed. ,
Succeeded: Log collection completed successfully. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: CorrelationId of the log collection ,
Required: False ,
}
string ,
logCollectionJobType:
{
Description: Specifies the type of log collection job. Determines whether the logs are collected immediately on demand or as part of a scheduled operation. ,
Enum:
{
OnDemand: Log collection is triggered manually and executed immediately. ,
Scheduled: Log collection is scheduled to run at a predefined time or interval. ,
}
,
Required: False ,
}
enum ,
endTimeCollected:
{
Description: End Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
logCollectionError:
{
Description: Log Collection Error details of the cluster. ,
Required: False ,
}
{
errorCode:
{
Description: Error Code of the log collection ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error Message of the log collection ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
remoteSupportProperties:
{
Description: RemoteSupport properties of the cluster. ,
Required: False ,
}
{
accessLevel:
{
Description: Remote Support Access Level ,
Enum:
{
Diagnostics: Allows remote diagnostics operations only. ,
DiagnosticsAndRepair: Allows both remote diagnostics and repair operations. ,
}
,
Required: False ,
}
enum ,
expirationTimeStamp:
{
Description: Expiration DateTimeStamp when Remote Support Access will be expired ,
Format: date-time ,
Required: False ,
}
string ,
remoteSupportType:
{
Description: Remote Support Type for cluster ,
Enum:
{
Enable: Enable remote support for the cluster. ,
Revoke: Revoke previously enabled remote support for the cluster. ,
}
,
Required: False ,
}
enum ,
remoteSupportNodeSettings:
{
Required: False ,
}
[
{
arcResourceId:
{
Description: Arc ResourceId of the Node ,
Required: False ,
}
string ,
state:
{
Description: Remote Support Access Connection State on the Node ,
Required: False ,
}
string ,
createdAt:
{
Description: Remote Support Enablement Request Created TimeStamp on the Node ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: Remote Support Enablement Request Updated TimeStamp on the Node ,
Format: date-time ,
Required: False ,
}
string ,
connectionStatus:
{
Description: Remote Support Access Connection Status on the Node ,
Required: False ,
}
string ,
connectionErrorMessage:
{
Description: Remote Support Access Connection Error Message on the Node ,
Required: False ,
}
string ,
transcriptLocation:
{
Description: Remote Support Transcript location on the node ,
Required: False ,
}
string ,
}
,
]
,
remoteSupportSessionDetails:
{
Required: False ,
}
[
{
sessionStartTime:
{
Description: Remote Support Session StartTime on the Node ,
Format: date-time ,
Required: False ,
}
string ,
sessionEndTime:
{
Description: Remote Support Session EndTime on the Node ,
Format: date-time ,
Required: False ,
}
string ,
nodeName:
{
Description: Name of the node ,
Required: False ,
}
string ,
duration:
{
Description: Duration of Remote Support Enablement ,
Format: int64 ,
Required: False ,
}
integer ,
accessLevel:
{
Description: Remote Support Access Level ,
Enum:
{
Diagnostics: Allows remote diagnostics operations only. ,
DiagnosticsAndRepair: Allows both remote diagnostics and repair operations. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
desiredProperties:
{
Description: Desired properties of the cluster. ,
Required: False ,
}
{
windowsServerSubscription:
{
Description: Desired state of Windows Server Subscription. ,
Enum:
{
Disabled: Windows Server Subscription is disabled. ,
Enabled: Windows Server Subscription is enabled. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Desired level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No diagnostic data will be emitted. ,
Basic: Basic diagnostic data will be emitted, including essential health metrics. ,
Enhanced: Enhanced diagnostic data will be emitted, including detailed performance and usage metrics. ,
}
,
Required: False ,
}
enum ,
}
,
reportedProperties:
{
Description: Properties reported by cluster agent. ,
Required: False ,
}
{
clusterName:
{
Description: Name of the on-prem cluster connected to this resource. ,
Required: False ,
}
string ,
clusterId:
{
Description: Unique id generated by the on-prem cluster. ,
Required: False ,
}
string ,
clusterVersion:
{
Description: Version of the cluster software. ,
Required: False ,
}
string ,
nodes:
{
Description: List of nodes reported by the cluster. ,
Required: False ,
}
[
{
name:
{
Description: Name of the cluster node. ,
Required: False ,
}
string ,
id:
{
Description: Id of the node in the cluster. ,
Format: float ,
Required: False ,
}
number ,
windowsServerSubscription:
{
Description: State of Windows Server Subscription. ,
Enum:
{
Disabled: Windows Server Subscription is disabled. ,
Enabled: Windows Server Subscription is enabled. ,
}
,
Required: False ,
}
enum ,
nodeType:
{
Description: Type of the cluster node hardware. ,
Enum:
{
FirstParty: All nodes in the cluster are provided and managed by Microsoft. ,
ThirdParty: All nodes in the cluster are provided and managed by a third-party vendor. ,
}
,
Required: False ,
}
enum ,
ehcResourceId:
{
Description: Edge Hardware Center Resource Id ,
Required: False ,
}
string ,
manufacturer:
{
Description: Manufacturer of the cluster node hardware. ,
Required: False ,
}
string ,
model:
{
Description: Model name of the cluster node hardware. ,
Required: False ,
}
string ,
osName:
{
Description: Operating system running on the cluster node. ,
Required: False ,
}
string ,
osVersion:
{
Description: Version of the operating system running on the cluster node. ,
Required: False ,
}
string ,
osDisplayVersion:
{
Description: Display version of the operating system running on the cluster node. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Immutable id of the cluster node. ,
Required: False ,
}
string ,
coreCount:
{
Description: Number of physical cores on the cluster node. ,
Format: float ,
Required: False ,
}
number ,
memoryInGiB:
{
Description: Total available memory on the cluster node (in GiB). ,
Format: float ,
Required: False ,
}
number ,
lastLicensingTimestamp:
{
Description: Most recent licensing timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
oemActivation:
{
Description: OEM activation status of the node. ,
Enum:
{
Disabled: OEM activation is disabled for the cluster. ,
Enabled: OEM activation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
lastUpdated:
{
Description: Last time the cluster reported the data. ,
Format: date-time ,
Required: False ,
}
string ,
msiExpirationTimeStamp:
{
Description: Specifies the expiration timestamp of the cluster's Managed Service Identity (MSI). The value is expressed in Coordinated Universal Time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
imdsAttestation:
{
Description: IMDS attestation status of the cluster. ,
Enum:
{
Disabled: IMDS attestation is disabled for the cluster. ,
Enabled: IMDS attestation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No diagnostic data will be emitted. ,
Basic: Basic diagnostic data will be emitted, including essential health metrics. ,
Enhanced: Enhanced diagnostic data will be emitted, including detailed performance and usage metrics. ,
}
,
Required: False ,
}
enum ,
supportedCapabilities:
{
Description: Capabilities supported by the cluster. ,
Required: False ,
}
[
string ,
]
,
clusterType:
{
Description: Specifies the type of hardware vendor for all nodes in the cluster. Indicates whether the nodes are provided by Microsoft or a third-party vendor. ,
Enum:
{
FirstParty: All nodes in the cluster are provided and managed by Microsoft. ,
ThirdParty: All nodes in the cluster are provided and managed by a third-party vendor. ,
}
,
Required: False ,
}
enum ,
manufacturer:
{
Description: The manufacturer of all the nodes of the cluster. ,
Required: False ,
}
string ,
oemActivation:
{
Description: OEM activation status of the cluster. ,
Enum:
{
Disabled: OEM activation is disabled for the cluster. ,
Enabled: OEM activation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
hardwareClass:
{
Description: Hardware class of the cluster. ,
Enum:
{
Small: The hardware class is small. ,
Medium: The hardware class is medium. This corresponds to the default ,
Large: The hardware class is large. ,
}
,
Required: False ,
}
enum ,
}
,
isolatedVmAttestationConfiguration:
{
Description: Attestation configurations for isolated VM (e.g. TVM, CVM) of the cluster. ,
Required: False ,
}
{
attestationResourceId:
{
Description: Fully qualified Azure resource id of the Microsoft Azure attestation resource associated with this cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
relyingPartyServiceEndpoint:
{
Description: Region specific endpoint for relying party service. ,
Required: False ,
}
string ,
attestationServiceEndpoint:
{
Description: Region specific endpoint for Microsoft Azure Attestation service for the cluster ,
Required: False ,
}
string ,
}
,
trialDaysRemaining:
{
Description: Number of days remaining in the trial period. ,
Format: float ,
Required: False ,
}
number ,
billingModel:
{
Description: Type of billing applied to the resource. ,
Required: False ,
}
string ,
registrationTimestamp:
{
Description: First cluster sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncTimestamp:
{
Description: Most recent cluster sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastBillingTimestamp:
{
Description: Most recent billing meter timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
serviceEndpoint:
{
Description: Region specific DataPath Endpoint of the cluster. ,
Required: False ,
}
string ,
resourceProviderObjectId:
{
Description: Object id of RP Service Principal ,
Required: False ,
}
string ,
secretsLocations:
{
Description: List of secret locations. ,
Required: False ,
}
[
{
secretsType:
{
Description: Type of secrets to store ,
Enum:
{
BackupSecrets: Backup secrets type ,
}
,
Required: True ,
}
enum ,
secretsLocation:
{
Description: secrets location ,
Required: True ,
}
string ,
}
,
]
,
clusterPattern:
{
Description: Supported Storage Type for HCI Cluster ,
Enum:
{
Standard: Standard cluster. ,
RackAware: RackAware cluster. ,
}
,
Required: False ,
}
enum ,
confidentialVmProperties:
{
Description: Represents the Confidential Virtual Machine (CVM) support intent and current status for the cluster resource. ,
Required: False ,
}
{
confidentialVmIntent:
{
Description: Captures the customer's intent to enable or disable CVM support on the cluster, either during initial deployment (Day-0) or at a later stage (Day-N). ,
Enum:
{
Enable: Indicates that the customer intends to enable CVM support on the cluster. ,
Disable: Indicates that the customer intends to disable CVM support on the cluster. ,
}
,
Required: False ,
}
enum ,
confidentialVmStatus:
{
Description: Captures the current status of CVM support on the cluster. ,
Enum:
{
Enabled: CVM support is fully enabled on the cluster. All nodes are CVM capable. ,
PartiallyEnabled: CVM support is partially enabled. At least one node in the cluster is CVM capable. ,
Disabled: CVM support is disabled. None of the nodes in the cluster are CVM capable. ,
}
,
Required: False ,
}
enum ,
confidentialVmStatusSummary:
{
Description: Additional context about CVM support on the cluster, such as reasons for partial enablement or hardware constraints. ,
Required: False ,
}
string ,
}
,
sdnProperties:
{
Description: Software Defined Networking Properties of the cluster ,
Required: False ,
}
{
sdnIntegrationIntent:
{
Description: Indicates whether Software Defined Networking (SDN) integration should be enabled or disabled for this deployment. ,
Enum:
{
Enable: Enable SDN integration for the deployment. ,
Disable: Disable SDN integration for the deployment. ,
}
,
Required: False ,
}
enum ,
}
,
localAvailabilityZones:
{
Description: Local Availability Zone information for HCI cluster ,
Required: False ,
}
[
{
localAvailabilityZoneName:
{
Description: Local Availability Zone name for HCI cluster ,
Required: False ,
}
string ,
nodes:
{
Description: Nodes belonging to a particular zone ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
identityProvider:
{
Description: Identity Provider for the cluster ,
Enum:
{
ActiveDirectory: Uses Active Directory as the identity provider, enabling domain-based authentication and centralized identity management. This is the default option. ,
LocalIdentity: Uses a local identity system integrated with Azure Key Vault for authentication. Suitable for AD-less environments where Active Directory is not available or required. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
kind:
{
Description: This property identifies the purpose of the Cluster deployment. For example, a valid value is AzureLocal ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_Update (removed)
Description :  Update an HCI cluster.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
cluster:
{
Description: Details of the HCI cluster. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
identity:
{
Description: Identity of Cluster resource ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: Cluster properties. ,
Required: False ,
}
{
cloudManagementEndpoint:
{
Description: Endpoint configured for management from the Azure portal ,
Required: False ,
}
string ,
aadClientId:
{
Description: App id of cluster AAD identity. ,
Required: False ,
}
string ,
aadTenantId:
{
Description: Tenant id of cluster AAD identity. ,
Required: False ,
}
string ,
desiredProperties:
{
Description: Desired properties of the cluster. ,
Required: False ,
}
{
windowsServerSubscription:
{
Description: Desired state of Windows Server Subscription. ,
Enum:
{
Disabled: Windows Server Subscription is disabled. ,
Enabled: Windows Server Subscription is enabled. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Desired level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No diagnostic data will be emitted. ,
Basic: Basic diagnostic data will be emitted, including essential health metrics. ,
Enhanced: Enhanced diagnostic data will be emitted, including detailed performance and usage metrics. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Cluster properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state. Indicates the current lifecycle status of the resource, including creation, update, deletion, connectivity, and error states. ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Status of the cluster agent. Indicates the current connectivity, validation, and deployment state of the agent within the cluster. ,
Enum:
{
NotYetRegistered: The cluster agent has not yet registered with Azure. ,
ConnectedRecently: The cluster agent has connected to Azure recently. ,
NotConnectedRecently: The cluster agent has not connected to Azure recently. ,
Disconnected: The cluster agent is currently disconnected from Azure. ,
Error: An error occurred in the cluster agent's operation. ,
NotSpecified: The status of the cluster agent is not specified. ,
ValidationInProgress: Validation of the cluster agent is currently in progress. ,
ValidationSuccess: Validation of the cluster agent completed successfully. ,
ValidationFailed: Validation of the cluster agent failed. ,
DeploymentInProgress: Deployment of the cluster agent is currently in progress. ,
DeploymentFailed: Deployment of the cluster agent failed. ,
DeploymentSuccess: Deployment of the cluster agent completed successfully. ,
}
,
Required: False ,
}
enum ,
connectivityStatus:
{
Description: Overall connectivity status for the cluster resource. Indicates whether the cluster is connected to Azure, partially connected, or has not recently communicated. ,
Enum:
{
NotYetRegistered: The cluster has not yet registered with Azure. ,
Connected: The cluster is fully connected to Azure. ,
NotConnectedRecently: The cluster has not connected to Azure recently. ,
PartiallyConnected: Some components of the cluster are connected, while others are not. ,
Disconnected: The cluster is not connected to Azure. ,
NotSpecified: The connectivity status is not specified. ,
}
,
Required: False ,
}
enum ,
supportStatus:
{
Description: Indicates whether the cluster is under support. ,
Enum:
{
InSupport: The cluster is under support. ,
OutOfSupport: The cluster is out of support. ,
NotSpecified: The support status is not specified. ,
}
,
Required: False ,
}
enum ,
cloudId:
{
Description: Unique, immutable resource id. ,
Required: False ,
}
string ,
ring:
{
Description: The ring to which this cluster belongs to. ,
Required: False ,
}
string ,
cloudManagementEndpoint:
{
Description: Endpoint configured for management from the Azure portal. ,
Required: False ,
}
string ,
aadClientId:
{
Description: App id of cluster AAD identity. ,
Required: False ,
}
string ,
aadTenantId:
{
Description: Tenant id of cluster AAD identity. ,
Required: False ,
}
string ,
aadApplicationObjectId:
{
Description: Object id of cluster AAD identity. ,
Required: False ,
}
string ,
aadServicePrincipalObjectId:
{
Description: Id of cluster identity service principal. ,
Required: False ,
}
string ,
softwareAssuranceProperties:
{
Description: Software Assurance properties of the cluster. ,
Required: False ,
}
{
softwareAssuranceStatus:
{
Description: Status of the Software Assurance for the cluster. ,
Enum:
{
Enabled: Software Assurance is enabled for the cluster. ,
Disabled: Software Assurance is disabled for the cluster. ,
}
,
Required: False ,
}
enum ,
softwareAssuranceIntent:
{
Description: Customer Intent for Software Assurance Benefit. ,
Enum:
{
Enable: Customer intends to enable the Software Assurance benefit. ,
Disable: Customer intends to disable the Software Assurance benefit. ,
}
,
Required: False ,
}
enum ,
lastUpdated:
{
Description: TimeStamp denoting the latest SA benefit applicability is validated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
isManagementCluster:
{
Description: Is Management Cluster, when true indicates that the cluster is used for managing other clusters ,
Required: False ,
}
boolean ,
logCollectionProperties:
{
Description: Log Collection properties of the cluster. ,
Required: False ,
}
{
fromDate:
{
Description: From DateTimeStamp from when logs need to be connected ,
Format: date-time ,
Required: False ,
}
string ,
toDate:
{
Description: To DateTimeStamp till when logs need to be connected ,
Format: date-time ,
Required: False ,
}
string ,
lastLogGenerated:
{
Description: Recent DateTimeStamp where logs are successfully generated ,
Format: date-time ,
Required: False ,
}
string ,
logCollectionSessionDetails:
{
Required: False ,
}
[
{
logStartTime:
{
Description: Start Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
logEndTime:
{
Description: End Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
timeCollected:
{
Description: Duration of logs collected ,
Format: date-time ,
Required: False ,
}
string ,
logSize:
{
Description: Size of the logs collected ,
Format: int64 ,
Required: False ,
}
integer ,
logCollectionStatus:
{
Description: LogCollection status ,
Enum:
{
None: No log collection has been initiated. ,
InProgress: Log collection is currently in progress. ,
Failed: Log collection has failed. ,
Succeeded: Log collection completed successfully. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: CorrelationId of the log collection ,
Required: False ,
}
string ,
logCollectionJobType:
{
Description: Specifies the type of log collection job. Determines whether the logs are collected immediately on demand or as part of a scheduled operation. ,
Enum:
{
OnDemand: Log collection is triggered manually and executed immediately. ,
Scheduled: Log collection is scheduled to run at a predefined time or interval. ,
}
,
Required: False ,
}
enum ,
endTimeCollected:
{
Description: End Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
logCollectionError:
{
Description: Log Collection Error details of the cluster. ,
Required: False ,
}
{
errorCode:
{
Description: Error Code of the log collection ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error Message of the log collection ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
remoteSupportProperties:
{
Description: RemoteSupport properties of the cluster. ,
Required: False ,
}
{
accessLevel:
{
Description: Remote Support Access Level ,
Enum:
{
Diagnostics: Allows remote diagnostics operations only. ,
DiagnosticsAndRepair: Allows both remote diagnostics and repair operations. ,
}
,
Required: False ,
}
enum ,
expirationTimeStamp:
{
Description: Expiration DateTimeStamp when Remote Support Access will be expired ,
Format: date-time ,
Required: False ,
}
string ,
remoteSupportType:
{
Description: Remote Support Type for cluster ,
Enum:
{
Enable: Enable remote support for the cluster. ,
Revoke: Revoke previously enabled remote support for the cluster. ,
}
,
Required: False ,
}
enum ,
remoteSupportNodeSettings:
{
Required: False ,
}
[
{
arcResourceId:
{
Description: Arc ResourceId of the Node ,
Required: False ,
}
string ,
state:
{
Description: Remote Support Access Connection State on the Node ,
Required: False ,
}
string ,
createdAt:
{
Description: Remote Support Enablement Request Created TimeStamp on the Node ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: Remote Support Enablement Request Updated TimeStamp on the Node ,
Format: date-time ,
Required: False ,
}
string ,
connectionStatus:
{
Description: Remote Support Access Connection Status on the Node ,
Required: False ,
}
string ,
connectionErrorMessage:
{
Description: Remote Support Access Connection Error Message on the Node ,
Required: False ,
}
string ,
transcriptLocation:
{
Description: Remote Support Transcript location on the node ,
Required: False ,
}
string ,
}
,
]
,
remoteSupportSessionDetails:
{
Required: False ,
}
[
{
sessionStartTime:
{
Description: Remote Support Session StartTime on the Node ,
Format: date-time ,
Required: False ,
}
string ,
sessionEndTime:
{
Description: Remote Support Session EndTime on the Node ,
Format: date-time ,
Required: False ,
}
string ,
nodeName:
{
Description: Name of the node ,
Required: False ,
}
string ,
duration:
{
Description: Duration of Remote Support Enablement ,
Format: int64 ,
Required: False ,
}
integer ,
accessLevel:
{
Description: Remote Support Access Level ,
Enum:
{
Diagnostics: Allows remote diagnostics operations only. ,
DiagnosticsAndRepair: Allows both remote diagnostics and repair operations. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
desiredProperties:
{
Description: Desired properties of the cluster. ,
Required: False ,
}
{
windowsServerSubscription:
{
Description: Desired state of Windows Server Subscription. ,
Enum:
{
Disabled: Windows Server Subscription is disabled. ,
Enabled: Windows Server Subscription is enabled. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Desired level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No diagnostic data will be emitted. ,
Basic: Basic diagnostic data will be emitted, including essential health metrics. ,
Enhanced: Enhanced diagnostic data will be emitted, including detailed performance and usage metrics. ,
}
,
Required: False ,
}
enum ,
}
,
reportedProperties:
{
Description: Properties reported by cluster agent. ,
Required: False ,
}
{
clusterName:
{
Description: Name of the on-prem cluster connected to this resource. ,
Required: False ,
}
string ,
clusterId:
{
Description: Unique id generated by the on-prem cluster. ,
Required: False ,
}
string ,
clusterVersion:
{
Description: Version of the cluster software. ,
Required: False ,
}
string ,
nodes:
{
Description: List of nodes reported by the cluster. ,
Required: False ,
}
[
{
name:
{
Description: Name of the cluster node. ,
Required: False ,
}
string ,
id:
{
Description: Id of the node in the cluster. ,
Format: float ,
Required: False ,
}
number ,
windowsServerSubscription:
{
Description: State of Windows Server Subscription. ,
Enum:
{
Disabled: Windows Server Subscription is disabled. ,
Enabled: Windows Server Subscription is enabled. ,
}
,
Required: False ,
}
enum ,
nodeType:
{
Description: Type of the cluster node hardware. ,
Enum:
{
FirstParty: All nodes in the cluster are provided and managed by Microsoft. ,
ThirdParty: All nodes in the cluster are provided and managed by a third-party vendor. ,
}
,
Required: False ,
}
enum ,
ehcResourceId:
{
Description: Edge Hardware Center Resource Id ,
Required: False ,
}
string ,
manufacturer:
{
Description: Manufacturer of the cluster node hardware. ,
Required: False ,
}
string ,
model:
{
Description: Model name of the cluster node hardware. ,
Required: False ,
}
string ,
osName:
{
Description: Operating system running on the cluster node. ,
Required: False ,
}
string ,
osVersion:
{
Description: Version of the operating system running on the cluster node. ,
Required: False ,
}
string ,
osDisplayVersion:
{
Description: Display version of the operating system running on the cluster node. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Immutable id of the cluster node. ,
Required: False ,
}
string ,
coreCount:
{
Description: Number of physical cores on the cluster node. ,
Format: float ,
Required: False ,
}
number ,
memoryInGiB:
{
Description: Total available memory on the cluster node (in GiB). ,
Format: float ,
Required: False ,
}
number ,
lastLicensingTimestamp:
{
Description: Most recent licensing timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
oemActivation:
{
Description: OEM activation status of the node. ,
Enum:
{
Disabled: OEM activation is disabled for the cluster. ,
Enabled: OEM activation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
lastUpdated:
{
Description: Last time the cluster reported the data. ,
Format: date-time ,
Required: False ,
}
string ,
msiExpirationTimeStamp:
{
Description: Specifies the expiration timestamp of the cluster's Managed Service Identity (MSI). The value is expressed in Coordinated Universal Time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
imdsAttestation:
{
Description: IMDS attestation status of the cluster. ,
Enum:
{
Disabled: IMDS attestation is disabled for the cluster. ,
Enabled: IMDS attestation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No diagnostic data will be emitted. ,
Basic: Basic diagnostic data will be emitted, including essential health metrics. ,
Enhanced: Enhanced diagnostic data will be emitted, including detailed performance and usage metrics. ,
}
,
Required: False ,
}
enum ,
supportedCapabilities:
{
Description: Capabilities supported by the cluster. ,
Required: False ,
}
[
string ,
]
,
clusterType:
{
Description: Specifies the type of hardware vendor for all nodes in the cluster. Indicates whether the nodes are provided by Microsoft or a third-party vendor. ,
Enum:
{
FirstParty: All nodes in the cluster are provided and managed by Microsoft. ,
ThirdParty: All nodes in the cluster are provided and managed by a third-party vendor. ,
}
,
Required: False ,
}
enum ,
manufacturer:
{
Description: The manufacturer of all the nodes of the cluster. ,
Required: False ,
}
string ,
oemActivation:
{
Description: OEM activation status of the cluster. ,
Enum:
{
Disabled: OEM activation is disabled for the cluster. ,
Enabled: OEM activation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
hardwareClass:
{
Description: Hardware class of the cluster. ,
Enum:
{
Small: The hardware class is small. ,
Medium: The hardware class is medium. This corresponds to the default ,
Large: The hardware class is large. ,
}
,
Required: False ,
}
enum ,
}
,
isolatedVmAttestationConfiguration:
{
Description: Attestation configurations for isolated VM (e.g. TVM, CVM) of the cluster. ,
Required: False ,
}
{
attestationResourceId:
{
Description: Fully qualified Azure resource id of the Microsoft Azure attestation resource associated with this cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
relyingPartyServiceEndpoint:
{
Description: Region specific endpoint for relying party service. ,
Required: False ,
}
string ,
attestationServiceEndpoint:
{
Description: Region specific endpoint for Microsoft Azure Attestation service for the cluster ,
Required: False ,
}
string ,
}
,
trialDaysRemaining:
{
Description: Number of days remaining in the trial period. ,
Format: float ,
Required: False ,
}
number ,
billingModel:
{
Description: Type of billing applied to the resource. ,
Required: False ,
}
string ,
registrationTimestamp:
{
Description: First cluster sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncTimestamp:
{
Description: Most recent cluster sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastBillingTimestamp:
{
Description: Most recent billing meter timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
serviceEndpoint:
{
Description: Region specific DataPath Endpoint of the cluster. ,
Required: False ,
}
string ,
resourceProviderObjectId:
{
Description: Object id of RP Service Principal ,
Required: False ,
}
string ,
secretsLocations:
{
Description: List of secret locations. ,
Required: False ,
}
[
{
secretsType:
{
Description: Type of secrets to store ,
Enum:
{
BackupSecrets: Backup secrets type ,
}
,
Required: True ,
}
enum ,
secretsLocation:
{
Description: secrets location ,
Required: True ,
}
string ,
}
,
]
,
clusterPattern:
{
Description: Supported Storage Type for HCI Cluster ,
Enum:
{
Standard: Standard cluster. ,
RackAware: RackAware cluster. ,
}
,
Required: False ,
}
enum ,
confidentialVmProperties:
{
Description: Represents the Confidential Virtual Machine (CVM) support intent and current status for the cluster resource. ,
Required: False ,
}
{
confidentialVmIntent:
{
Description: Captures the customer's intent to enable or disable CVM support on the cluster, either during initial deployment (Day-0) or at a later stage (Day-N). ,
Enum:
{
Enable: Indicates that the customer intends to enable CVM support on the cluster. ,
Disable: Indicates that the customer intends to disable CVM support on the cluster. ,
}
,
Required: False ,
}
enum ,
confidentialVmStatus:
{
Description: Captures the current status of CVM support on the cluster. ,
Enum:
{
Enabled: CVM support is fully enabled on the cluster. All nodes are CVM capable. ,
PartiallyEnabled: CVM support is partially enabled. At least one node in the cluster is CVM capable. ,
Disabled: CVM support is disabled. None of the nodes in the cluster are CVM capable. ,
}
,
Required: False ,
}
enum ,
confidentialVmStatusSummary:
{
Description: Additional context about CVM support on the cluster, such as reasons for partial enablement or hardware constraints. ,
Required: False ,
}
string ,
}
,
sdnProperties:
{
Description: Software Defined Networking Properties of the cluster ,
Required: False ,
}
{
sdnIntegrationIntent:
{
Description: Indicates whether Software Defined Networking (SDN) integration should be enabled or disabled for this deployment. ,
Enum:
{
Enable: Enable SDN integration for the deployment. ,
Disable: Disable SDN integration for the deployment. ,
}
,
Required: False ,
}
enum ,
}
,
localAvailabilityZones:
{
Description: Local Availability Zone information for HCI cluster ,
Required: False ,
}
[
{
localAvailabilityZoneName:
{
Description: Local Availability Zone name for HCI cluster ,
Required: False ,
}
string ,
nodes:
{
Description: Nodes belonging to a particular zone ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
identityProvider:
{
Description: Identity Provider for the cluster ,
Enum:
{
ActiveDirectory: Uses Active Directory as the identity provider, enabling domain-based authentication and centralized identity management. This is the default option. ,
LocalIdentity: Uses a local identity system integrated with Azure Key Vault for authentication. Suitable for AD-less environments where Active Directory is not available or required. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
kind:
{
Description: This property identifies the purpose of the Cluster deployment. For example, a valid value is AzureLocal ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_Delete (removed)
Description :  Delete an HCI cluster.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_UpdateSecretsLocations (removed)
Description :  Update cluster secrets locations.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/updateSecretsLocations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
properties:
{
Description: List of secret locations ,
Required: False ,
}
[
{
secretsType:
{
Description: Type of secrets to store ,
Enum:
{
BackupSecrets: Backup secrets type ,
}
,
Required: True ,
}
enum ,
secretsLocation:
{
Description: secrets location ,
Required: True ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Cluster properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state. Indicates the current lifecycle status of the resource, including creation, update, deletion, connectivity, and error states. ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Status of the cluster agent. Indicates the current connectivity, validation, and deployment state of the agent within the cluster. ,
Enum:
{
NotYetRegistered: The cluster agent has not yet registered with Azure. ,
ConnectedRecently: The cluster agent has connected to Azure recently. ,
NotConnectedRecently: The cluster agent has not connected to Azure recently. ,
Disconnected: The cluster agent is currently disconnected from Azure. ,
Error: An error occurred in the cluster agent's operation. ,
NotSpecified: The status of the cluster agent is not specified. ,
ValidationInProgress: Validation of the cluster agent is currently in progress. ,
ValidationSuccess: Validation of the cluster agent completed successfully. ,
ValidationFailed: Validation of the cluster agent failed. ,
DeploymentInProgress: Deployment of the cluster agent is currently in progress. ,
DeploymentFailed: Deployment of the cluster agent failed. ,
DeploymentSuccess: Deployment of the cluster agent completed successfully. ,
}
,
Required: False ,
}
enum ,
connectivityStatus:
{
Description: Overall connectivity status for the cluster resource. Indicates whether the cluster is connected to Azure, partially connected, or has not recently communicated. ,
Enum:
{
NotYetRegistered: The cluster has not yet registered with Azure. ,
Connected: The cluster is fully connected to Azure. ,
NotConnectedRecently: The cluster has not connected to Azure recently. ,
PartiallyConnected: Some components of the cluster are connected, while others are not. ,
Disconnected: The cluster is not connected to Azure. ,
NotSpecified: The connectivity status is not specified. ,
}
,
Required: False ,
}
enum ,
supportStatus:
{
Description: Indicates whether the cluster is under support. ,
Enum:
{
InSupport: The cluster is under support. ,
OutOfSupport: The cluster is out of support. ,
NotSpecified: The support status is not specified. ,
}
,
Required: False ,
}
enum ,
cloudId:
{
Description: Unique, immutable resource id. ,
Required: False ,
}
string ,
ring:
{
Description: The ring to which this cluster belongs to. ,
Required: False ,
}
string ,
cloudManagementEndpoint:
{
Description: Endpoint configured for management from the Azure portal. ,
Required: False ,
}
string ,
aadClientId:
{
Description: App id of cluster AAD identity. ,
Required: False ,
}
string ,
aadTenantId:
{
Description: Tenant id of cluster AAD identity. ,
Required: False ,
}
string ,
aadApplicationObjectId:
{
Description: Object id of cluster AAD identity. ,
Required: False ,
}
string ,
aadServicePrincipalObjectId:
{
Description: Id of cluster identity service principal. ,
Required: False ,
}
string ,
softwareAssuranceProperties:
{
Description: Software Assurance properties of the cluster. ,
Required: False ,
}
{
softwareAssuranceStatus:
{
Description: Status of the Software Assurance for the cluster. ,
Enum:
{
Enabled: Software Assurance is enabled for the cluster. ,
Disabled: Software Assurance is disabled for the cluster. ,
}
,
Required: False ,
}
enum ,
softwareAssuranceIntent:
{
Description: Customer Intent for Software Assurance Benefit. ,
Enum:
{
Enable: Customer intends to enable the Software Assurance benefit. ,
Disable: Customer intends to disable the Software Assurance benefit. ,
}
,
Required: False ,
}
enum ,
lastUpdated:
{
Description: TimeStamp denoting the latest SA benefit applicability is validated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
isManagementCluster:
{
Description: Is Management Cluster, when true indicates that the cluster is used for managing other clusters ,
Required: False ,
}
boolean ,
logCollectionProperties:
{
Description: Log Collection properties of the cluster. ,
Required: False ,
}
{
fromDate:
{
Description: From DateTimeStamp from when logs need to be connected ,
Format: date-time ,
Required: False ,
}
string ,
toDate:
{
Description: To DateTimeStamp till when logs need to be connected ,
Format: date-time ,
Required: False ,
}
string ,
lastLogGenerated:
{
Description: Recent DateTimeStamp where logs are successfully generated ,
Format: date-time ,
Required: False ,
}
string ,
logCollectionSessionDetails:
{
Required: False ,
}
[
{
logStartTime:
{
Description: Start Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
logEndTime:
{
Description: End Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
timeCollected:
{
Description: Duration of logs collected ,
Format: date-time ,
Required: False ,
}
string ,
logSize:
{
Description: Size of the logs collected ,
Format: int64 ,
Required: False ,
}
integer ,
logCollectionStatus:
{
Description: LogCollection status ,
Enum:
{
None: No log collection has been initiated. ,
InProgress: Log collection is currently in progress. ,
Failed: Log collection has failed. ,
Succeeded: Log collection completed successfully. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: CorrelationId of the log collection ,
Required: False ,
}
string ,
logCollectionJobType:
{
Description: Specifies the type of log collection job. Determines whether the logs are collected immediately on demand or as part of a scheduled operation. ,
Enum:
{
OnDemand: Log collection is triggered manually and executed immediately. ,
Scheduled: Log collection is scheduled to run at a predefined time or interval. ,
}
,
Required: False ,
}
enum ,
endTimeCollected:
{
Description: End Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
logCollectionError:
{
Description: Log Collection Error details of the cluster. ,
Required: False ,
}
{
errorCode:
{
Description: Error Code of the log collection ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error Message of the log collection ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
remoteSupportProperties:
{
Description: RemoteSupport properties of the cluster. ,
Required: False ,
}
{
accessLevel:
{
Description: Remote Support Access Level ,
Enum:
{
Diagnostics: Allows remote diagnostics operations only. ,
DiagnosticsAndRepair: Allows both remote diagnostics and repair operations. ,
}
,
Required: False ,
}
enum ,
expirationTimeStamp:
{
Description: Expiration DateTimeStamp when Remote Support Access will be expired ,
Format: date-time ,
Required: False ,
}
string ,
remoteSupportType:
{
Description: Remote Support Type for cluster ,
Enum:
{
Enable: Enable remote support for the cluster. ,
Revoke: Revoke previously enabled remote support for the cluster. ,
}
,
Required: False ,
}
enum ,
remoteSupportNodeSettings:
{
Required: False ,
}
[
{
arcResourceId:
{
Description: Arc ResourceId of the Node ,
Required: False ,
}
string ,
state:
{
Description: Remote Support Access Connection State on the Node ,
Required: False ,
}
string ,
createdAt:
{
Description: Remote Support Enablement Request Created TimeStamp on the Node ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: Remote Support Enablement Request Updated TimeStamp on the Node ,
Format: date-time ,
Required: False ,
}
string ,
connectionStatus:
{
Description: Remote Support Access Connection Status on the Node ,
Required: False ,
}
string ,
connectionErrorMessage:
{
Description: Remote Support Access Connection Error Message on the Node ,
Required: False ,
}
string ,
transcriptLocation:
{
Description: Remote Support Transcript location on the node ,
Required: False ,
}
string ,
}
,
]
,
remoteSupportSessionDetails:
{
Required: False ,
}
[
{
sessionStartTime:
{
Description: Remote Support Session StartTime on the Node ,
Format: date-time ,
Required: False ,
}
string ,
sessionEndTime:
{
Description: Remote Support Session EndTime on the Node ,
Format: date-time ,
Required: False ,
}
string ,
nodeName:
{
Description: Name of the node ,
Required: False ,
}
string ,
duration:
{
Description: Duration of Remote Support Enablement ,
Format: int64 ,
Required: False ,
}
integer ,
accessLevel:
{
Description: Remote Support Access Level ,
Enum:
{
Diagnostics: Allows remote diagnostics operations only. ,
DiagnosticsAndRepair: Allows both remote diagnostics and repair operations. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
desiredProperties:
{
Description: Desired properties of the cluster. ,
Required: False ,
}
{
windowsServerSubscription:
{
Description: Desired state of Windows Server Subscription. ,
Enum:
{
Disabled: Windows Server Subscription is disabled. ,
Enabled: Windows Server Subscription is enabled. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Desired level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No diagnostic data will be emitted. ,
Basic: Basic diagnostic data will be emitted, including essential health metrics. ,
Enhanced: Enhanced diagnostic data will be emitted, including detailed performance and usage metrics. ,
}
,
Required: False ,
}
enum ,
}
,
reportedProperties:
{
Description: Properties reported by cluster agent. ,
Required: False ,
}
{
clusterName:
{
Description: Name of the on-prem cluster connected to this resource. ,
Required: False ,
}
string ,
clusterId:
{
Description: Unique id generated by the on-prem cluster. ,
Required: False ,
}
string ,
clusterVersion:
{
Description: Version of the cluster software. ,
Required: False ,
}
string ,
nodes:
{
Description: List of nodes reported by the cluster. ,
Required: False ,
}
[
{
name:
{
Description: Name of the cluster node. ,
Required: False ,
}
string ,
id:
{
Description: Id of the node in the cluster. ,
Format: float ,
Required: False ,
}
number ,
windowsServerSubscription:
{
Description: State of Windows Server Subscription. ,
Enum:
{
Disabled: Windows Server Subscription is disabled. ,
Enabled: Windows Server Subscription is enabled. ,
}
,
Required: False ,
}
enum ,
nodeType:
{
Description: Type of the cluster node hardware. ,
Enum:
{
FirstParty: All nodes in the cluster are provided and managed by Microsoft. ,
ThirdParty: All nodes in the cluster are provided and managed by a third-party vendor. ,
}
,
Required: False ,
}
enum ,
ehcResourceId:
{
Description: Edge Hardware Center Resource Id ,
Required: False ,
}
string ,
manufacturer:
{
Description: Manufacturer of the cluster node hardware. ,
Required: False ,
}
string ,
model:
{
Description: Model name of the cluster node hardware. ,
Required: False ,
}
string ,
osName:
{
Description: Operating system running on the cluster node. ,
Required: False ,
}
string ,
osVersion:
{
Description: Version of the operating system running on the cluster node. ,
Required: False ,
}
string ,
osDisplayVersion:
{
Description: Display version of the operating system running on the cluster node. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Immutable id of the cluster node. ,
Required: False ,
}
string ,
coreCount:
{
Description: Number of physical cores on the cluster node. ,
Format: float ,
Required: False ,
}
number ,
memoryInGiB:
{
Description: Total available memory on the cluster node (in GiB). ,
Format: float ,
Required: False ,
}
number ,
lastLicensingTimestamp:
{
Description: Most recent licensing timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
oemActivation:
{
Description: OEM activation status of the node. ,
Enum:
{
Disabled: OEM activation is disabled for the cluster. ,
Enabled: OEM activation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
lastUpdated:
{
Description: Last time the cluster reported the data. ,
Format: date-time ,
Required: False ,
}
string ,
msiExpirationTimeStamp:
{
Description: Specifies the expiration timestamp of the cluster's Managed Service Identity (MSI). The value is expressed in Coordinated Universal Time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
imdsAttestation:
{
Description: IMDS attestation status of the cluster. ,
Enum:
{
Disabled: IMDS attestation is disabled for the cluster. ,
Enabled: IMDS attestation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No diagnostic data will be emitted. ,
Basic: Basic diagnostic data will be emitted, including essential health metrics. ,
Enhanced: Enhanced diagnostic data will be emitted, including detailed performance and usage metrics. ,
}
,
Required: False ,
}
enum ,
supportedCapabilities:
{
Description: Capabilities supported by the cluster. ,
Required: False ,
}
[
string ,
]
,
clusterType:
{
Description: Specifies the type of hardware vendor for all nodes in the cluster. Indicates whether the nodes are provided by Microsoft or a third-party vendor. ,
Enum:
{
FirstParty: All nodes in the cluster are provided and managed by Microsoft. ,
ThirdParty: All nodes in the cluster are provided and managed by a third-party vendor. ,
}
,
Required: False ,
}
enum ,
manufacturer:
{
Description: The manufacturer of all the nodes of the cluster. ,
Required: False ,
}
string ,
oemActivation:
{
Description: OEM activation status of the cluster. ,
Enum:
{
Disabled: OEM activation is disabled for the cluster. ,
Enabled: OEM activation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
hardwareClass:
{
Description: Hardware class of the cluster. ,
Enum:
{
Small: The hardware class is small. ,
Medium: The hardware class is medium. This corresponds to the default ,
Large: The hardware class is large. ,
}
,
Required: False ,
}
enum ,
}
,
isolatedVmAttestationConfiguration:
{
Description: Attestation configurations for isolated VM (e.g. TVM, CVM) of the cluster. ,
Required: False ,
}
{
attestationResourceId:
{
Description: Fully qualified Azure resource id of the Microsoft Azure attestation resource associated with this cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
relyingPartyServiceEndpoint:
{
Description: Region specific endpoint for relying party service. ,
Required: False ,
}
string ,
attestationServiceEndpoint:
{
Description: Region specific endpoint for Microsoft Azure Attestation service for the cluster ,
Required: False ,
}
string ,
}
,
trialDaysRemaining:
{
Description: Number of days remaining in the trial period. ,
Format: float ,
Required: False ,
}
number ,
billingModel:
{
Description: Type of billing applied to the resource. ,
Required: False ,
}
string ,
registrationTimestamp:
{
Description: First cluster sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncTimestamp:
{
Description: Most recent cluster sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastBillingTimestamp:
{
Description: Most recent billing meter timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
serviceEndpoint:
{
Description: Region specific DataPath Endpoint of the cluster. ,
Required: False ,
}
string ,
resourceProviderObjectId:
{
Description: Object id of RP Service Principal ,
Required: False ,
}
string ,
secretsLocations:
{
Description: List of secret locations. ,
Required: False ,
}
[
{
secretsType:
{
Description: Type of secrets to store ,
Enum:
{
BackupSecrets: Backup secrets type ,
}
,
Required: True ,
}
enum ,
secretsLocation:
{
Description: secrets location ,
Required: True ,
}
string ,
}
,
]
,
clusterPattern:
{
Description: Supported Storage Type for HCI Cluster ,
Enum:
{
Standard: Standard cluster. ,
RackAware: RackAware cluster. ,
}
,
Required: False ,
}
enum ,
confidentialVmProperties:
{
Description: Represents the Confidential Virtual Machine (CVM) support intent and current status for the cluster resource. ,
Required: False ,
}
{
confidentialVmIntent:
{
Description: Captures the customer's intent to enable or disable CVM support on the cluster, either during initial deployment (Day-0) or at a later stage (Day-N). ,
Enum:
{
Enable: Indicates that the customer intends to enable CVM support on the cluster. ,
Disable: Indicates that the customer intends to disable CVM support on the cluster. ,
}
,
Required: False ,
}
enum ,
confidentialVmStatus:
{
Description: Captures the current status of CVM support on the cluster. ,
Enum:
{
Enabled: CVM support is fully enabled on the cluster. All nodes are CVM capable. ,
PartiallyEnabled: CVM support is partially enabled. At least one node in the cluster is CVM capable. ,
Disabled: CVM support is disabled. None of the nodes in the cluster are CVM capable. ,
}
,
Required: False ,
}
enum ,
confidentialVmStatusSummary:
{
Description: Additional context about CVM support on the cluster, such as reasons for partial enablement or hardware constraints. ,
Required: False ,
}
string ,
}
,
sdnProperties:
{
Description: Software Defined Networking Properties of the cluster ,
Required: False ,
}
{
sdnIntegrationIntent:
{
Description: Indicates whether Software Defined Networking (SDN) integration should be enabled or disabled for this deployment. ,
Enum:
{
Enable: Enable SDN integration for the deployment. ,
Disable: Disable SDN integration for the deployment. ,
}
,
Required: False ,
}
enum ,
}
,
localAvailabilityZones:
{
Description: Local Availability Zone information for HCI cluster ,
Required: False ,
}
[
{
localAvailabilityZoneName:
{
Description: Local Availability Zone name for HCI cluster ,
Required: False ,
}
string ,
nodes:
{
Description: Nodes belonging to a particular zone ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
identityProvider:
{
Description: Identity Provider for the cluster ,
Enum:
{
ActiveDirectory: Uses Active Directory as the identity provider, enabling domain-based authentication and centralized identity management. This is the default option. ,
LocalIdentity: Uses a local identity system integrated with Azure Key Vault for authentication. Suitable for AD-less environments where Active Directory is not available or required. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
kind:
{
Description: This property identifies the purpose of the Cluster deployment. For example, a valid value is AzureLocal ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_UploadCertificate (removed)
Description :  Upload certificate.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/uploadCertificate
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
uploadCertificateRequest:
{
Description: Upload certificate request. ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
certificates:
{
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_CreateIdentity (removed)
Description :  Create cluster identity.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/createClusterIdentity
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Cluster identity properties. ,
Required: False ,
}
{
aadClientId:
{
Required: False ,
}
string ,
aadTenantId:
{
Required: False ,
}
string ,
aadServicePrincipalObjectId:
{
Required: False ,
}
string ,
aadApplicationObjectId:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_ExtendSoftwareAssuranceBenefit (removed)
Description :  Extends Software Assurance Benefit to a cluster
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/extendSoftwareAssuranceBenefit
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
softwareAssuranceChangeRequest:
{
Description: Software Assurance Change Request Payload ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
softwareAssuranceIntent:
{
Description: Customer Intent for Software Assurance Benefit. This indicates whether the customer wishes to opt in or out of the Software Assurance program, which provides licensing and support benefits. ,
Enum:
{
Enable: Customer intends to enable the Software Assurance benefit. ,
Disable: Customer intends to disable the Software Assurance benefit. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Cluster properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state. Indicates the current lifecycle status of the resource, including creation, update, deletion, connectivity, and error states. ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Status of the cluster agent. Indicates the current connectivity, validation, and deployment state of the agent within the cluster. ,
Enum:
{
NotYetRegistered: The cluster agent has not yet registered with Azure. ,
ConnectedRecently: The cluster agent has connected to Azure recently. ,
NotConnectedRecently: The cluster agent has not connected to Azure recently. ,
Disconnected: The cluster agent is currently disconnected from Azure. ,
Error: An error occurred in the cluster agent's operation. ,
NotSpecified: The status of the cluster agent is not specified. ,
ValidationInProgress: Validation of the cluster agent is currently in progress. ,
ValidationSuccess: Validation of the cluster agent completed successfully. ,
ValidationFailed: Validation of the cluster agent failed. ,
DeploymentInProgress: Deployment of the cluster agent is currently in progress. ,
DeploymentFailed: Deployment of the cluster agent failed. ,
DeploymentSuccess: Deployment of the cluster agent completed successfully. ,
}
,
Required: False ,
}
enum ,
connectivityStatus:
{
Description: Overall connectivity status for the cluster resource. Indicates whether the cluster is connected to Azure, partially connected, or has not recently communicated. ,
Enum:
{
NotYetRegistered: The cluster has not yet registered with Azure. ,
Connected: The cluster is fully connected to Azure. ,
NotConnectedRecently: The cluster has not connected to Azure recently. ,
PartiallyConnected: Some components of the cluster are connected, while others are not. ,
Disconnected: The cluster is not connected to Azure. ,
NotSpecified: The connectivity status is not specified. ,
}
,
Required: False ,
}
enum ,
supportStatus:
{
Description: Indicates whether the cluster is under support. ,
Enum:
{
InSupport: The cluster is under support. ,
OutOfSupport: The cluster is out of support. ,
NotSpecified: The support status is not specified. ,
}
,
Required: False ,
}
enum ,
cloudId:
{
Description: Unique, immutable resource id. ,
Required: False ,
}
string ,
ring:
{
Description: The ring to which this cluster belongs to. ,
Required: False ,
}
string ,
cloudManagementEndpoint:
{
Description: Endpoint configured for management from the Azure portal. ,
Required: False ,
}
string ,
aadClientId:
{
Description: App id of cluster AAD identity. ,
Required: False ,
}
string ,
aadTenantId:
{
Description: Tenant id of cluster AAD identity. ,
Required: False ,
}
string ,
aadApplicationObjectId:
{
Description: Object id of cluster AAD identity. ,
Required: False ,
}
string ,
aadServicePrincipalObjectId:
{
Description: Id of cluster identity service principal. ,
Required: False ,
}
string ,
softwareAssuranceProperties:
{
Description: Software Assurance properties of the cluster. ,
Required: False ,
}
{
softwareAssuranceStatus:
{
Description: Status of the Software Assurance for the cluster. ,
Enum:
{
Enabled: Software Assurance is enabled for the cluster. ,
Disabled: Software Assurance is disabled for the cluster. ,
}
,
Required: False ,
}
enum ,
softwareAssuranceIntent:
{
Description: Customer Intent for Software Assurance Benefit. ,
Enum:
{
Enable: Customer intends to enable the Software Assurance benefit. ,
Disable: Customer intends to disable the Software Assurance benefit. ,
}
,
Required: False ,
}
enum ,
lastUpdated:
{
Description: TimeStamp denoting the latest SA benefit applicability is validated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
isManagementCluster:
{
Description: Is Management Cluster, when true indicates that the cluster is used for managing other clusters ,
Required: False ,
}
boolean ,
logCollectionProperties:
{
Description: Log Collection properties of the cluster. ,
Required: False ,
}
{
fromDate:
{
Description: From DateTimeStamp from when logs need to be connected ,
Format: date-time ,
Required: False ,
}
string ,
toDate:
{
Description: To DateTimeStamp till when logs need to be connected ,
Format: date-time ,
Required: False ,
}
string ,
lastLogGenerated:
{
Description: Recent DateTimeStamp where logs are successfully generated ,
Format: date-time ,
Required: False ,
}
string ,
logCollectionSessionDetails:
{
Required: False ,
}
[
{
logStartTime:
{
Description: Start Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
logEndTime:
{
Description: End Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
timeCollected:
{
Description: Duration of logs collected ,
Format: date-time ,
Required: False ,
}
string ,
logSize:
{
Description: Size of the logs collected ,
Format: int64 ,
Required: False ,
}
integer ,
logCollectionStatus:
{
Description: LogCollection status ,
Enum:
{
None: No log collection has been initiated. ,
InProgress: Log collection is currently in progress. ,
Failed: Log collection has failed. ,
Succeeded: Log collection completed successfully. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: CorrelationId of the log collection ,
Required: False ,
}
string ,
logCollectionJobType:
{
Description: Specifies the type of log collection job. Determines whether the logs are collected immediately on demand or as part of a scheduled operation. ,
Enum:
{
OnDemand: Log collection is triggered manually and executed immediately. ,
Scheduled: Log collection is scheduled to run at a predefined time or interval. ,
}
,
Required: False ,
}
enum ,
endTimeCollected:
{
Description: End Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
logCollectionError:
{
Description: Log Collection Error details of the cluster. ,
Required: False ,
}
{
errorCode:
{
Description: Error Code of the log collection ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error Message of the log collection ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
remoteSupportProperties:
{
Description: RemoteSupport properties of the cluster. ,
Required: False ,
}
{
accessLevel:
{
Description: Remote Support Access Level ,
Enum:
{
Diagnostics: Allows remote diagnostics operations only. ,
DiagnosticsAndRepair: Allows both remote diagnostics and repair operations. ,
}
,
Required: False ,
}
enum ,
expirationTimeStamp:
{
Description: Expiration DateTimeStamp when Remote Support Access will be expired ,
Format: date-time ,
Required: False ,
}
string ,
remoteSupportType:
{
Description: Remote Support Type for cluster ,
Enum:
{
Enable: Enable remote support for the cluster. ,
Revoke: Revoke previously enabled remote support for the cluster. ,
}
,
Required: False ,
}
enum ,
remoteSupportNodeSettings:
{
Required: False ,
}
[
{
arcResourceId:
{
Description: Arc ResourceId of the Node ,
Required: False ,
}
string ,
state:
{
Description: Remote Support Access Connection State on the Node ,
Required: False ,
}
string ,
createdAt:
{
Description: Remote Support Enablement Request Created TimeStamp on the Node ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: Remote Support Enablement Request Updated TimeStamp on the Node ,
Format: date-time ,
Required: False ,
}
string ,
connectionStatus:
{
Description: Remote Support Access Connection Status on the Node ,
Required: False ,
}
string ,
connectionErrorMessage:
{
Description: Remote Support Access Connection Error Message on the Node ,
Required: False ,
}
string ,
transcriptLocation:
{
Description: Remote Support Transcript location on the node ,
Required: False ,
}
string ,
}
,
]
,
remoteSupportSessionDetails:
{
Required: False ,
}
[
{
sessionStartTime:
{
Description: Remote Support Session StartTime on the Node ,
Format: date-time ,
Required: False ,
}
string ,
sessionEndTime:
{
Description: Remote Support Session EndTime on the Node ,
Format: date-time ,
Required: False ,
}
string ,
nodeName:
{
Description: Name of the node ,
Required: False ,
}
string ,
duration:
{
Description: Duration of Remote Support Enablement ,
Format: int64 ,
Required: False ,
}
integer ,
accessLevel:
{
Description: Remote Support Access Level ,
Enum:
{
Diagnostics: Allows remote diagnostics operations only. ,
DiagnosticsAndRepair: Allows both remote diagnostics and repair operations. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
desiredProperties:
{
Description: Desired properties of the cluster. ,
Required: False ,
}
{
windowsServerSubscription:
{
Description: Desired state of Windows Server Subscription. ,
Enum:
{
Disabled: Windows Server Subscription is disabled. ,
Enabled: Windows Server Subscription is enabled. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Desired level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No diagnostic data will be emitted. ,
Basic: Basic diagnostic data will be emitted, including essential health metrics. ,
Enhanced: Enhanced diagnostic data will be emitted, including detailed performance and usage metrics. ,
}
,
Required: False ,
}
enum ,
}
,
reportedProperties:
{
Description: Properties reported by cluster agent. ,
Required: False ,
}
{
clusterName:
{
Description: Name of the on-prem cluster connected to this resource. ,
Required: False ,
}
string ,
clusterId:
{
Description: Unique id generated by the on-prem cluster. ,
Required: False ,
}
string ,
clusterVersion:
{
Description: Version of the cluster software. ,
Required: False ,
}
string ,
nodes:
{
Description: List of nodes reported by the cluster. ,
Required: False ,
}
[
{
name:
{
Description: Name of the cluster node. ,
Required: False ,
}
string ,
id:
{
Description: Id of the node in the cluster. ,
Format: float ,
Required: False ,
}
number ,
windowsServerSubscription:
{
Description: State of Windows Server Subscription. ,
Enum:
{
Disabled: Windows Server Subscription is disabled. ,
Enabled: Windows Server Subscription is enabled. ,
}
,
Required: False ,
}
enum ,
nodeType:
{
Description: Type of the cluster node hardware. ,
Enum:
{
FirstParty: All nodes in the cluster are provided and managed by Microsoft. ,
ThirdParty: All nodes in the cluster are provided and managed by a third-party vendor. ,
}
,
Required: False ,
}
enum ,
ehcResourceId:
{
Description: Edge Hardware Center Resource Id ,
Required: False ,
}
string ,
manufacturer:
{
Description: Manufacturer of the cluster node hardware. ,
Required: False ,
}
string ,
model:
{
Description: Model name of the cluster node hardware. ,
Required: False ,
}
string ,
osName:
{
Description: Operating system running on the cluster node. ,
Required: False ,
}
string ,
osVersion:
{
Description: Version of the operating system running on the cluster node. ,
Required: False ,
}
string ,
osDisplayVersion:
{
Description: Display version of the operating system running on the cluster node. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Immutable id of the cluster node. ,
Required: False ,
}
string ,
coreCount:
{
Description: Number of physical cores on the cluster node. ,
Format: float ,
Required: False ,
}
number ,
memoryInGiB:
{
Description: Total available memory on the cluster node (in GiB). ,
Format: float ,
Required: False ,
}
number ,
lastLicensingTimestamp:
{
Description: Most recent licensing timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
oemActivation:
{
Description: OEM activation status of the node. ,
Enum:
{
Disabled: OEM activation is disabled for the cluster. ,
Enabled: OEM activation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
lastUpdated:
{
Description: Last time the cluster reported the data. ,
Format: date-time ,
Required: False ,
}
string ,
msiExpirationTimeStamp:
{
Description: Specifies the expiration timestamp of the cluster's Managed Service Identity (MSI). The value is expressed in Coordinated Universal Time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
imdsAttestation:
{
Description: IMDS attestation status of the cluster. ,
Enum:
{
Disabled: IMDS attestation is disabled for the cluster. ,
Enabled: IMDS attestation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No diagnostic data will be emitted. ,
Basic: Basic diagnostic data will be emitted, including essential health metrics. ,
Enhanced: Enhanced diagnostic data will be emitted, including detailed performance and usage metrics. ,
}
,
Required: False ,
}
enum ,
supportedCapabilities:
{
Description: Capabilities supported by the cluster. ,
Required: False ,
}
[
string ,
]
,
clusterType:
{
Description: Specifies the type of hardware vendor for all nodes in the cluster. Indicates whether the nodes are provided by Microsoft or a third-party vendor. ,
Enum:
{
FirstParty: All nodes in the cluster are provided and managed by Microsoft. ,
ThirdParty: All nodes in the cluster are provided and managed by a third-party vendor. ,
}
,
Required: False ,
}
enum ,
manufacturer:
{
Description: The manufacturer of all the nodes of the cluster. ,
Required: False ,
}
string ,
oemActivation:
{
Description: OEM activation status of the cluster. ,
Enum:
{
Disabled: OEM activation is disabled for the cluster. ,
Enabled: OEM activation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
hardwareClass:
{
Description: Hardware class of the cluster. ,
Enum:
{
Small: The hardware class is small. ,
Medium: The hardware class is medium. This corresponds to the default ,
Large: The hardware class is large. ,
}
,
Required: False ,
}
enum ,
}
,
isolatedVmAttestationConfiguration:
{
Description: Attestation configurations for isolated VM (e.g. TVM, CVM) of the cluster. ,
Required: False ,
}
{
attestationResourceId:
{
Description: Fully qualified Azure resource id of the Microsoft Azure attestation resource associated with this cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
relyingPartyServiceEndpoint:
{
Description: Region specific endpoint for relying party service. ,
Required: False ,
}
string ,
attestationServiceEndpoint:
{
Description: Region specific endpoint for Microsoft Azure Attestation service for the cluster ,
Required: False ,
}
string ,
}
,
trialDaysRemaining:
{
Description: Number of days remaining in the trial period. ,
Format: float ,
Required: False ,
}
number ,
billingModel:
{
Description: Type of billing applied to the resource. ,
Required: False ,
}
string ,
registrationTimestamp:
{
Description: First cluster sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncTimestamp:
{
Description: Most recent cluster sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastBillingTimestamp:
{
Description: Most recent billing meter timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
serviceEndpoint:
{
Description: Region specific DataPath Endpoint of the cluster. ,
Required: False ,
}
string ,
resourceProviderObjectId:
{
Description: Object id of RP Service Principal ,
Required: False ,
}
string ,
secretsLocations:
{
Description: List of secret locations. ,
Required: False ,
}
[
{
secretsType:
{
Description: Type of secrets to store ,
Enum:
{
BackupSecrets: Backup secrets type ,
}
,
Required: True ,
}
enum ,
secretsLocation:
{
Description: secrets location ,
Required: True ,
}
string ,
}
,
]
,
clusterPattern:
{
Description: Supported Storage Type for HCI Cluster ,
Enum:
{
Standard: Standard cluster. ,
RackAware: RackAware cluster. ,
}
,
Required: False ,
}
enum ,
confidentialVmProperties:
{
Description: Represents the Confidential Virtual Machine (CVM) support intent and current status for the cluster resource. ,
Required: False ,
}
{
confidentialVmIntent:
{
Description: Captures the customer's intent to enable or disable CVM support on the cluster, either during initial deployment (Day-0) or at a later stage (Day-N). ,
Enum:
{
Enable: Indicates that the customer intends to enable CVM support on the cluster. ,
Disable: Indicates that the customer intends to disable CVM support on the cluster. ,
}
,
Required: False ,
}
enum ,
confidentialVmStatus:
{
Description: Captures the current status of CVM support on the cluster. ,
Enum:
{
Enabled: CVM support is fully enabled on the cluster. All nodes are CVM capable. ,
PartiallyEnabled: CVM support is partially enabled. At least one node in the cluster is CVM capable. ,
Disabled: CVM support is disabled. None of the nodes in the cluster are CVM capable. ,
}
,
Required: False ,
}
enum ,
confidentialVmStatusSummary:
{
Description: Additional context about CVM support on the cluster, such as reasons for partial enablement or hardware constraints. ,
Required: False ,
}
string ,
}
,
sdnProperties:
{
Description: Software Defined Networking Properties of the cluster ,
Required: False ,
}
{
sdnIntegrationIntent:
{
Description: Indicates whether Software Defined Networking (SDN) integration should be enabled or disabled for this deployment. ,
Enum:
{
Enable: Enable SDN integration for the deployment. ,
Disable: Disable SDN integration for the deployment. ,
}
,
Required: False ,
}
enum ,
}
,
localAvailabilityZones:
{
Description: Local Availability Zone information for HCI cluster ,
Required: False ,
}
[
{
localAvailabilityZoneName:
{
Description: Local Availability Zone name for HCI cluster ,
Required: False ,
}
string ,
nodes:
{
Description: Nodes belonging to a particular zone ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
identityProvider:
{
Description: Identity Provider for the cluster ,
Enum:
{
ActiveDirectory: Uses Active Directory as the identity provider, enabling domain-based authentication and centralized identity management. This is the default option. ,
LocalIdentity: Uses a local identity system integrated with Azure Key Vault for authentication. Suitable for AD-less environments where Active Directory is not available or required. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
kind:
{
Description: This property identifies the purpose of the Cluster deployment. For example, a valid value is AzureLocal ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_ChangeRing (removed)
Description :  Changes ring of a cluster
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/changeRing
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
changeRingRequest:
{
Description: Change ring request payload ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
targetRing:
{
Description: The target ring for the cluster. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Cluster properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state. Indicates the current lifecycle status of the resource, including creation, update, deletion, connectivity, and error states. ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Status of the cluster agent. Indicates the current connectivity, validation, and deployment state of the agent within the cluster. ,
Enum:
{
NotYetRegistered: The cluster agent has not yet registered with Azure. ,
ConnectedRecently: The cluster agent has connected to Azure recently. ,
NotConnectedRecently: The cluster agent has not connected to Azure recently. ,
Disconnected: The cluster agent is currently disconnected from Azure. ,
Error: An error occurred in the cluster agent's operation. ,
NotSpecified: The status of the cluster agent is not specified. ,
ValidationInProgress: Validation of the cluster agent is currently in progress. ,
ValidationSuccess: Validation of the cluster agent completed successfully. ,
ValidationFailed: Validation of the cluster agent failed. ,
DeploymentInProgress: Deployment of the cluster agent is currently in progress. ,
DeploymentFailed: Deployment of the cluster agent failed. ,
DeploymentSuccess: Deployment of the cluster agent completed successfully. ,
}
,
Required: False ,
}
enum ,
connectivityStatus:
{
Description: Overall connectivity status for the cluster resource. Indicates whether the cluster is connected to Azure, partially connected, or has not recently communicated. ,
Enum:
{
NotYetRegistered: The cluster has not yet registered with Azure. ,
Connected: The cluster is fully connected to Azure. ,
NotConnectedRecently: The cluster has not connected to Azure recently. ,
PartiallyConnected: Some components of the cluster are connected, while others are not. ,
Disconnected: The cluster is not connected to Azure. ,
NotSpecified: The connectivity status is not specified. ,
}
,
Required: False ,
}
enum ,
supportStatus:
{
Description: Indicates whether the cluster is under support. ,
Enum:
{
InSupport: The cluster is under support. ,
OutOfSupport: The cluster is out of support. ,
NotSpecified: The support status is not specified. ,
}
,
Required: False ,
}
enum ,
cloudId:
{
Description: Unique, immutable resource id. ,
Required: False ,
}
string ,
ring:
{
Description: The ring to which this cluster belongs to. ,
Required: False ,
}
string ,
cloudManagementEndpoint:
{
Description: Endpoint configured for management from the Azure portal. ,
Required: False ,
}
string ,
aadClientId:
{
Description: App id of cluster AAD identity. ,
Required: False ,
}
string ,
aadTenantId:
{
Description: Tenant id of cluster AAD identity. ,
Required: False ,
}
string ,
aadApplicationObjectId:
{
Description: Object id of cluster AAD identity. ,
Required: False ,
}
string ,
aadServicePrincipalObjectId:
{
Description: Id of cluster identity service principal. ,
Required: False ,
}
string ,
softwareAssuranceProperties:
{
Description: Software Assurance properties of the cluster. ,
Required: False ,
}
{
softwareAssuranceStatus:
{
Description: Status of the Software Assurance for the cluster. ,
Enum:
{
Enabled: Software Assurance is enabled for the cluster. ,
Disabled: Software Assurance is disabled for the cluster. ,
}
,
Required: False ,
}
enum ,
softwareAssuranceIntent:
{
Description: Customer Intent for Software Assurance Benefit. ,
Enum:
{
Enable: Customer intends to enable the Software Assurance benefit. ,
Disable: Customer intends to disable the Software Assurance benefit. ,
}
,
Required: False ,
}
enum ,
lastUpdated:
{
Description: TimeStamp denoting the latest SA benefit applicability is validated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
isManagementCluster:
{
Description: Is Management Cluster, when true indicates that the cluster is used for managing other clusters ,
Required: False ,
}
boolean ,
logCollectionProperties:
{
Description: Log Collection properties of the cluster. ,
Required: False ,
}
{
fromDate:
{
Description: From DateTimeStamp from when logs need to be connected ,
Format: date-time ,
Required: False ,
}
string ,
toDate:
{
Description: To DateTimeStamp till when logs need to be connected ,
Format: date-time ,
Required: False ,
}
string ,
lastLogGenerated:
{
Description: Recent DateTimeStamp where logs are successfully generated ,
Format: date-time ,
Required: False ,
}
string ,
logCollectionSessionDetails:
{
Required: False ,
}
[
{
logStartTime:
{
Description: Start Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
logEndTime:
{
Description: End Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
timeCollected:
{
Description: Duration of logs collected ,
Format: date-time ,
Required: False ,
}
string ,
logSize:
{
Description: Size of the logs collected ,
Format: int64 ,
Required: False ,
}
integer ,
logCollectionStatus:
{
Description: LogCollection status ,
Enum:
{
None: No log collection has been initiated. ,
InProgress: Log collection is currently in progress. ,
Failed: Log collection has failed. ,
Succeeded: Log collection completed successfully. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: CorrelationId of the log collection ,
Required: False ,
}
string ,
logCollectionJobType:
{
Description: Specifies the type of log collection job. Determines whether the logs are collected immediately on demand or as part of a scheduled operation. ,
Enum:
{
OnDemand: Log collection is triggered manually and executed immediately. ,
Scheduled: Log collection is scheduled to run at a predefined time or interval. ,
}
,
Required: False ,
}
enum ,
endTimeCollected:
{
Description: End Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
logCollectionError:
{
Description: Log Collection Error details of the cluster. ,
Required: False ,
}
{
errorCode:
{
Description: Error Code of the log collection ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error Message of the log collection ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
remoteSupportProperties:
{
Description: RemoteSupport properties of the cluster. ,
Required: False ,
}
{
accessLevel:
{
Description: Remote Support Access Level ,
Enum:
{
Diagnostics: Allows remote diagnostics operations only. ,
DiagnosticsAndRepair: Allows both remote diagnostics and repair operations. ,
}
,
Required: False ,
}
enum ,
expirationTimeStamp:
{
Description: Expiration DateTimeStamp when Remote Support Access will be expired ,
Format: date-time ,
Required: False ,
}
string ,
remoteSupportType:
{
Description: Remote Support Type for cluster ,
Enum:
{
Enable: Enable remote support for the cluster. ,
Revoke: Revoke previously enabled remote support for the cluster. ,
}
,
Required: False ,
}
enum ,
remoteSupportNodeSettings:
{
Required: False ,
}
[
{
arcResourceId:
{
Description: Arc ResourceId of the Node ,
Required: False ,
}
string ,
state:
{
Description: Remote Support Access Connection State on the Node ,
Required: False ,
}
string ,
createdAt:
{
Description: Remote Support Enablement Request Created TimeStamp on the Node ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: Remote Support Enablement Request Updated TimeStamp on the Node ,
Format: date-time ,
Required: False ,
}
string ,
connectionStatus:
{
Description: Remote Support Access Connection Status on the Node ,
Required: False ,
}
string ,
connectionErrorMessage:
{
Description: Remote Support Access Connection Error Message on the Node ,
Required: False ,
}
string ,
transcriptLocation:
{
Description: Remote Support Transcript location on the node ,
Required: False ,
}
string ,
}
,
]
,
remoteSupportSessionDetails:
{
Required: False ,
}
[
{
sessionStartTime:
{
Description: Remote Support Session StartTime on the Node ,
Format: date-time ,
Required: False ,
}
string ,
sessionEndTime:
{
Description: Remote Support Session EndTime on the Node ,
Format: date-time ,
Required: False ,
}
string ,
nodeName:
{
Description: Name of the node ,
Required: False ,
}
string ,
duration:
{
Description: Duration of Remote Support Enablement ,
Format: int64 ,
Required: False ,
}
integer ,
accessLevel:
{
Description: Remote Support Access Level ,
Enum:
{
Diagnostics: Allows remote diagnostics operations only. ,
DiagnosticsAndRepair: Allows both remote diagnostics and repair operations. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
desiredProperties:
{
Description: Desired properties of the cluster. ,
Required: False ,
}
{
windowsServerSubscription:
{
Description: Desired state of Windows Server Subscription. ,
Enum:
{
Disabled: Windows Server Subscription is disabled. ,
Enabled: Windows Server Subscription is enabled. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Desired level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No diagnostic data will be emitted. ,
Basic: Basic diagnostic data will be emitted, including essential health metrics. ,
Enhanced: Enhanced diagnostic data will be emitted, including detailed performance and usage metrics. ,
}
,
Required: False ,
}
enum ,
}
,
reportedProperties:
{
Description: Properties reported by cluster agent. ,
Required: False ,
}
{
clusterName:
{
Description: Name of the on-prem cluster connected to this resource. ,
Required: False ,
}
string ,
clusterId:
{
Description: Unique id generated by the on-prem cluster. ,
Required: False ,
}
string ,
clusterVersion:
{
Description: Version of the cluster software. ,
Required: False ,
}
string ,
nodes:
{
Description: List of nodes reported by the cluster. ,
Required: False ,
}
[
{
name:
{
Description: Name of the cluster node. ,
Required: False ,
}
string ,
id:
{
Description: Id of the node in the cluster. ,
Format: float ,
Required: False ,
}
number ,
windowsServerSubscription:
{
Description: State of Windows Server Subscription. ,
Enum:
{
Disabled: Windows Server Subscription is disabled. ,
Enabled: Windows Server Subscription is enabled. ,
}
,
Required: False ,
}
enum ,
nodeType:
{
Description: Type of the cluster node hardware. ,
Enum:
{
FirstParty: All nodes in the cluster are provided and managed by Microsoft. ,
ThirdParty: All nodes in the cluster are provided and managed by a third-party vendor. ,
}
,
Required: False ,
}
enum ,
ehcResourceId:
{
Description: Edge Hardware Center Resource Id ,
Required: False ,
}
string ,
manufacturer:
{
Description: Manufacturer of the cluster node hardware. ,
Required: False ,
}
string ,
model:
{
Description: Model name of the cluster node hardware. ,
Required: False ,
}
string ,
osName:
{
Description: Operating system running on the cluster node. ,
Required: False ,
}
string ,
osVersion:
{
Description: Version of the operating system running on the cluster node. ,
Required: False ,
}
string ,
osDisplayVersion:
{
Description: Display version of the operating system running on the cluster node. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Immutable id of the cluster node. ,
Required: False ,
}
string ,
coreCount:
{
Description: Number of physical cores on the cluster node. ,
Format: float ,
Required: False ,
}
number ,
memoryInGiB:
{
Description: Total available memory on the cluster node (in GiB). ,
Format: float ,
Required: False ,
}
number ,
lastLicensingTimestamp:
{
Description: Most recent licensing timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
oemActivation:
{
Description: OEM activation status of the node. ,
Enum:
{
Disabled: OEM activation is disabled for the cluster. ,
Enabled: OEM activation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
lastUpdated:
{
Description: Last time the cluster reported the data. ,
Format: date-time ,
Required: False ,
}
string ,
msiExpirationTimeStamp:
{
Description: Specifies the expiration timestamp of the cluster's Managed Service Identity (MSI). The value is expressed in Coordinated Universal Time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
imdsAttestation:
{
Description: IMDS attestation status of the cluster. ,
Enum:
{
Disabled: IMDS attestation is disabled for the cluster. ,
Enabled: IMDS attestation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No diagnostic data will be emitted. ,
Basic: Basic diagnostic data will be emitted, including essential health metrics. ,
Enhanced: Enhanced diagnostic data will be emitted, including detailed performance and usage metrics. ,
}
,
Required: False ,
}
enum ,
supportedCapabilities:
{
Description: Capabilities supported by the cluster. ,
Required: False ,
}
[
string ,
]
,
clusterType:
{
Description: Specifies the type of hardware vendor for all nodes in the cluster. Indicates whether the nodes are provided by Microsoft or a third-party vendor. ,
Enum:
{
FirstParty: All nodes in the cluster are provided and managed by Microsoft. ,
ThirdParty: All nodes in the cluster are provided and managed by a third-party vendor. ,
}
,
Required: False ,
}
enum ,
manufacturer:
{
Description: The manufacturer of all the nodes of the cluster. ,
Required: False ,
}
string ,
oemActivation:
{
Description: OEM activation status of the cluster. ,
Enum:
{
Disabled: OEM activation is disabled for the cluster. ,
Enabled: OEM activation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
hardwareClass:
{
Description: Hardware class of the cluster. ,
Enum:
{
Small: The hardware class is small. ,
Medium: The hardware class is medium. This corresponds to the default ,
Large: The hardware class is large. ,
}
,
Required: False ,
}
enum ,
}
,
isolatedVmAttestationConfiguration:
{
Description: Attestation configurations for isolated VM (e.g. TVM, CVM) of the cluster. ,
Required: False ,
}
{
attestationResourceId:
{
Description: Fully qualified Azure resource id of the Microsoft Azure attestation resource associated with this cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
relyingPartyServiceEndpoint:
{
Description: Region specific endpoint for relying party service. ,
Required: False ,
}
string ,
attestationServiceEndpoint:
{
Description: Region specific endpoint for Microsoft Azure Attestation service for the cluster ,
Required: False ,
}
string ,
}
,
trialDaysRemaining:
{
Description: Number of days remaining in the trial period. ,
Format: float ,
Required: False ,
}
number ,
billingModel:
{
Description: Type of billing applied to the resource. ,
Required: False ,
}
string ,
registrationTimestamp:
{
Description: First cluster sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncTimestamp:
{
Description: Most recent cluster sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastBillingTimestamp:
{
Description: Most recent billing meter timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
serviceEndpoint:
{
Description: Region specific DataPath Endpoint of the cluster. ,
Required: False ,
}
string ,
resourceProviderObjectId:
{
Description: Object id of RP Service Principal ,
Required: False ,
}
string ,
secretsLocations:
{
Description: List of secret locations. ,
Required: False ,
}
[
{
secretsType:
{
Description: Type of secrets to store ,
Enum:
{
BackupSecrets: Backup secrets type ,
}
,
Required: True ,
}
enum ,
secretsLocation:
{
Description: secrets location ,
Required: True ,
}
string ,
}
,
]
,
clusterPattern:
{
Description: Supported Storage Type for HCI Cluster ,
Enum:
{
Standard: Standard cluster. ,
RackAware: RackAware cluster. ,
}
,
Required: False ,
}
enum ,
confidentialVmProperties:
{
Description: Represents the Confidential Virtual Machine (CVM) support intent and current status for the cluster resource. ,
Required: False ,
}
{
confidentialVmIntent:
{
Description: Captures the customer's intent to enable or disable CVM support on the cluster, either during initial deployment (Day-0) or at a later stage (Day-N). ,
Enum:
{
Enable: Indicates that the customer intends to enable CVM support on the cluster. ,
Disable: Indicates that the customer intends to disable CVM support on the cluster. ,
}
,
Required: False ,
}
enum ,
confidentialVmStatus:
{
Description: Captures the current status of CVM support on the cluster. ,
Enum:
{
Enabled: CVM support is fully enabled on the cluster. All nodes are CVM capable. ,
PartiallyEnabled: CVM support is partially enabled. At least one node in the cluster is CVM capable. ,
Disabled: CVM support is disabled. None of the nodes in the cluster are CVM capable. ,
}
,
Required: False ,
}
enum ,
confidentialVmStatusSummary:
{
Description: Additional context about CVM support on the cluster, such as reasons for partial enablement or hardware constraints. ,
Required: False ,
}
string ,
}
,
sdnProperties:
{
Description: Software Defined Networking Properties of the cluster ,
Required: False ,
}
{
sdnIntegrationIntent:
{
Description: Indicates whether Software Defined Networking (SDN) integration should be enabled or disabled for this deployment. ,
Enum:
{
Enable: Enable SDN integration for the deployment. ,
Disable: Disable SDN integration for the deployment. ,
}
,
Required: False ,
}
enum ,
}
,
localAvailabilityZones:
{
Description: Local Availability Zone information for HCI cluster ,
Required: False ,
}
[
{
localAvailabilityZoneName:
{
Description: Local Availability Zone name for HCI cluster ,
Required: False ,
}
string ,
nodes:
{
Description: Nodes belonging to a particular zone ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
identityProvider:
{
Description: Identity Provider for the cluster ,
Enum:
{
ActiveDirectory: Uses Active Directory as the identity provider, enabling domain-based authentication and centralized identity management. This is the default option. ,
LocalIdentity: Uses a local identity system integrated with Azure Key Vault for authentication. Suitable for AD-less environments where Active Directory is not available or required. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
kind:
{
Description: This property identifies the purpose of the Cluster deployment. For example, a valid value is AzureLocal ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_TriggerLogCollection (removed)
Description :  Trigger Log Collection on a cluster
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/triggerLogCollection
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
logCollectionRequest:
{
Description: Trigger Log Collection Request Payload ,
Required: True ,
}
{
properties:
{
Description: Properties for Log Collection Request ,
Required: False ,
}
{
fromDate:
{
Description: From DateTimeStamp from when logs need to be connected ,
Format: date-time ,
Required: True ,
}
string ,
toDate:
{
Description: To DateTimeStamp till when logs need to be connected ,
Format: date-time ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Cluster properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state. Indicates the current lifecycle status of the resource, including creation, update, deletion, connectivity, and error states. ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Status of the cluster agent. Indicates the current connectivity, validation, and deployment state of the agent within the cluster. ,
Enum:
{
NotYetRegistered: The cluster agent has not yet registered with Azure. ,
ConnectedRecently: The cluster agent has connected to Azure recently. ,
NotConnectedRecently: The cluster agent has not connected to Azure recently. ,
Disconnected: The cluster agent is currently disconnected from Azure. ,
Error: An error occurred in the cluster agent's operation. ,
NotSpecified: The status of the cluster agent is not specified. ,
ValidationInProgress: Validation of the cluster agent is currently in progress. ,
ValidationSuccess: Validation of the cluster agent completed successfully. ,
ValidationFailed: Validation of the cluster agent failed. ,
DeploymentInProgress: Deployment of the cluster agent is currently in progress. ,
DeploymentFailed: Deployment of the cluster agent failed. ,
DeploymentSuccess: Deployment of the cluster agent completed successfully. ,
}
,
Required: False ,
}
enum ,
connectivityStatus:
{
Description: Overall connectivity status for the cluster resource. Indicates whether the cluster is connected to Azure, partially connected, or has not recently communicated. ,
Enum:
{
NotYetRegistered: The cluster has not yet registered with Azure. ,
Connected: The cluster is fully connected to Azure. ,
NotConnectedRecently: The cluster has not connected to Azure recently. ,
PartiallyConnected: Some components of the cluster are connected, while others are not. ,
Disconnected: The cluster is not connected to Azure. ,
NotSpecified: The connectivity status is not specified. ,
}
,
Required: False ,
}
enum ,
supportStatus:
{
Description: Indicates whether the cluster is under support. ,
Enum:
{
InSupport: The cluster is under support. ,
OutOfSupport: The cluster is out of support. ,
NotSpecified: The support status is not specified. ,
}
,
Required: False ,
}
enum ,
cloudId:
{
Description: Unique, immutable resource id. ,
Required: False ,
}
string ,
ring:
{
Description: The ring to which this cluster belongs to. ,
Required: False ,
}
string ,
cloudManagementEndpoint:
{
Description: Endpoint configured for management from the Azure portal. ,
Required: False ,
}
string ,
aadClientId:
{
Description: App id of cluster AAD identity. ,
Required: False ,
}
string ,
aadTenantId:
{
Description: Tenant id of cluster AAD identity. ,
Required: False ,
}
string ,
aadApplicationObjectId:
{
Description: Object id of cluster AAD identity. ,
Required: False ,
}
string ,
aadServicePrincipalObjectId:
{
Description: Id of cluster identity service principal. ,
Required: False ,
}
string ,
softwareAssuranceProperties:
{
Description: Software Assurance properties of the cluster. ,
Required: False ,
}
{
softwareAssuranceStatus:
{
Description: Status of the Software Assurance for the cluster. ,
Enum:
{
Enabled: Software Assurance is enabled for the cluster. ,
Disabled: Software Assurance is disabled for the cluster. ,
}
,
Required: False ,
}
enum ,
softwareAssuranceIntent:
{
Description: Customer Intent for Software Assurance Benefit. ,
Enum:
{
Enable: Customer intends to enable the Software Assurance benefit. ,
Disable: Customer intends to disable the Software Assurance benefit. ,
}
,
Required: False ,
}
enum ,
lastUpdated:
{
Description: TimeStamp denoting the latest SA benefit applicability is validated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
isManagementCluster:
{
Description: Is Management Cluster, when true indicates that the cluster is used for managing other clusters ,
Required: False ,
}
boolean ,
logCollectionProperties:
{
Description: Log Collection properties of the cluster. ,
Required: False ,
}
{
fromDate:
{
Description: From DateTimeStamp from when logs need to be connected ,
Format: date-time ,
Required: False ,
}
string ,
toDate:
{
Description: To DateTimeStamp till when logs need to be connected ,
Format: date-time ,
Required: False ,
}
string ,
lastLogGenerated:
{
Description: Recent DateTimeStamp where logs are successfully generated ,
Format: date-time ,
Required: False ,
}
string ,
logCollectionSessionDetails:
{
Required: False ,
}
[
{
logStartTime:
{
Description: Start Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
logEndTime:
{
Description: End Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
timeCollected:
{
Description: Duration of logs collected ,
Format: date-time ,
Required: False ,
}
string ,
logSize:
{
Description: Size of the logs collected ,
Format: int64 ,
Required: False ,
}
integer ,
logCollectionStatus:
{
Description: LogCollection status ,
Enum:
{
None: No log collection has been initiated. ,
InProgress: Log collection is currently in progress. ,
Failed: Log collection has failed. ,
Succeeded: Log collection completed successfully. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: CorrelationId of the log collection ,
Required: False ,
}
string ,
logCollectionJobType:
{
Description: Specifies the type of log collection job. Determines whether the logs are collected immediately on demand or as part of a scheduled operation. ,
Enum:
{
OnDemand: Log collection is triggered manually and executed immediately. ,
Scheduled: Log collection is scheduled to run at a predefined time or interval. ,
}
,
Required: False ,
}
enum ,
endTimeCollected:
{
Description: End Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
logCollectionError:
{
Description: Log Collection Error details of the cluster. ,
Required: False ,
}
{
errorCode:
{
Description: Error Code of the log collection ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error Message of the log collection ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
remoteSupportProperties:
{
Description: RemoteSupport properties of the cluster. ,
Required: False ,
}
{
accessLevel:
{
Description: Remote Support Access Level ,
Enum:
{
Diagnostics: Allows remote diagnostics operations only. ,
DiagnosticsAndRepair: Allows both remote diagnostics and repair operations. ,
}
,
Required: False ,
}
enum ,
expirationTimeStamp:
{
Description: Expiration DateTimeStamp when Remote Support Access will be expired ,
Format: date-time ,
Required: False ,
}
string ,
remoteSupportType:
{
Description: Remote Support Type for cluster ,
Enum:
{
Enable: Enable remote support for the cluster. ,
Revoke: Revoke previously enabled remote support for the cluster. ,
}
,
Required: False ,
}
enum ,
remoteSupportNodeSettings:
{
Required: False ,
}
[
{
arcResourceId:
{
Description: Arc ResourceId of the Node ,
Required: False ,
}
string ,
state:
{
Description: Remote Support Access Connection State on the Node ,
Required: False ,
}
string ,
createdAt:
{
Description: Remote Support Enablement Request Created TimeStamp on the Node ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: Remote Support Enablement Request Updated TimeStamp on the Node ,
Format: date-time ,
Required: False ,
}
string ,
connectionStatus:
{
Description: Remote Support Access Connection Status on the Node ,
Required: False ,
}
string ,
connectionErrorMessage:
{
Description: Remote Support Access Connection Error Message on the Node ,
Required: False ,
}
string ,
transcriptLocation:
{
Description: Remote Support Transcript location on the node ,
Required: False ,
}
string ,
}
,
]
,
remoteSupportSessionDetails:
{
Required: False ,
}
[
{
sessionStartTime:
{
Description: Remote Support Session StartTime on the Node ,
Format: date-time ,
Required: False ,
}
string ,
sessionEndTime:
{
Description: Remote Support Session EndTime on the Node ,
Format: date-time ,
Required: False ,
}
string ,
nodeName:
{
Description: Name of the node ,
Required: False ,
}
string ,
duration:
{
Description: Duration of Remote Support Enablement ,
Format: int64 ,
Required: False ,
}
integer ,
accessLevel:
{
Description: Remote Support Access Level ,
Enum:
{
Diagnostics: Allows remote diagnostics operations only. ,
DiagnosticsAndRepair: Allows both remote diagnostics and repair operations. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
desiredProperties:
{
Description: Desired properties of the cluster. ,
Required: False ,
}
{
windowsServerSubscription:
{
Description: Desired state of Windows Server Subscription. ,
Enum:
{
Disabled: Windows Server Subscription is disabled. ,
Enabled: Windows Server Subscription is enabled. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Desired level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No diagnostic data will be emitted. ,
Basic: Basic diagnostic data will be emitted, including essential health metrics. ,
Enhanced: Enhanced diagnostic data will be emitted, including detailed performance and usage metrics. ,
}
,
Required: False ,
}
enum ,
}
,
reportedProperties:
{
Description: Properties reported by cluster agent. ,
Required: False ,
}
{
clusterName:
{
Description: Name of the on-prem cluster connected to this resource. ,
Required: False ,
}
string ,
clusterId:
{
Description: Unique id generated by the on-prem cluster. ,
Required: False ,
}
string ,
clusterVersion:
{
Description: Version of the cluster software. ,
Required: False ,
}
string ,
nodes:
{
Description: List of nodes reported by the cluster. ,
Required: False ,
}
[
{
name:
{
Description: Name of the cluster node. ,
Required: False ,
}
string ,
id:
{
Description: Id of the node in the cluster. ,
Format: float ,
Required: False ,
}
number ,
windowsServerSubscription:
{
Description: State of Windows Server Subscription. ,
Enum:
{
Disabled: Windows Server Subscription is disabled. ,
Enabled: Windows Server Subscription is enabled. ,
}
,
Required: False ,
}
enum ,
nodeType:
{
Description: Type of the cluster node hardware. ,
Enum:
{
FirstParty: All nodes in the cluster are provided and managed by Microsoft. ,
ThirdParty: All nodes in the cluster are provided and managed by a third-party vendor. ,
}
,
Required: False ,
}
enum ,
ehcResourceId:
{
Description: Edge Hardware Center Resource Id ,
Required: False ,
}
string ,
manufacturer:
{
Description: Manufacturer of the cluster node hardware. ,
Required: False ,
}
string ,
model:
{
Description: Model name of the cluster node hardware. ,
Required: False ,
}
string ,
osName:
{
Description: Operating system running on the cluster node. ,
Required: False ,
}
string ,
osVersion:
{
Description: Version of the operating system running on the cluster node. ,
Required: False ,
}
string ,
osDisplayVersion:
{
Description: Display version of the operating system running on the cluster node. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Immutable id of the cluster node. ,
Required: False ,
}
string ,
coreCount:
{
Description: Number of physical cores on the cluster node. ,
Format: float ,
Required: False ,
}
number ,
memoryInGiB:
{
Description: Total available memory on the cluster node (in GiB). ,
Format: float ,
Required: False ,
}
number ,
lastLicensingTimestamp:
{
Description: Most recent licensing timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
oemActivation:
{
Description: OEM activation status of the node. ,
Enum:
{
Disabled: OEM activation is disabled for the cluster. ,
Enabled: OEM activation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
lastUpdated:
{
Description: Last time the cluster reported the data. ,
Format: date-time ,
Required: False ,
}
string ,
msiExpirationTimeStamp:
{
Description: Specifies the expiration timestamp of the cluster's Managed Service Identity (MSI). The value is expressed in Coordinated Universal Time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
imdsAttestation:
{
Description: IMDS attestation status of the cluster. ,
Enum:
{
Disabled: IMDS attestation is disabled for the cluster. ,
Enabled: IMDS attestation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No diagnostic data will be emitted. ,
Basic: Basic diagnostic data will be emitted, including essential health metrics. ,
Enhanced: Enhanced diagnostic data will be emitted, including detailed performance and usage metrics. ,
}
,
Required: False ,
}
enum ,
supportedCapabilities:
{
Description: Capabilities supported by the cluster. ,
Required: False ,
}
[
string ,
]
,
clusterType:
{
Description: Specifies the type of hardware vendor for all nodes in the cluster. Indicates whether the nodes are provided by Microsoft or a third-party vendor. ,
Enum:
{
FirstParty: All nodes in the cluster are provided and managed by Microsoft. ,
ThirdParty: All nodes in the cluster are provided and managed by a third-party vendor. ,
}
,
Required: False ,
}
enum ,
manufacturer:
{
Description: The manufacturer of all the nodes of the cluster. ,
Required: False ,
}
string ,
oemActivation:
{
Description: OEM activation status of the cluster. ,
Enum:
{
Disabled: OEM activation is disabled for the cluster. ,
Enabled: OEM activation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
hardwareClass:
{
Description: Hardware class of the cluster. ,
Enum:
{
Small: The hardware class is small. ,
Medium: The hardware class is medium. This corresponds to the default ,
Large: The hardware class is large. ,
}
,
Required: False ,
}
enum ,
}
,
isolatedVmAttestationConfiguration:
{
Description: Attestation configurations for isolated VM (e.g. TVM, CVM) of the cluster. ,
Required: False ,
}
{
attestationResourceId:
{
Description: Fully qualified Azure resource id of the Microsoft Azure attestation resource associated with this cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
relyingPartyServiceEndpoint:
{
Description: Region specific endpoint for relying party service. ,
Required: False ,
}
string ,
attestationServiceEndpoint:
{
Description: Region specific endpoint for Microsoft Azure Attestation service for the cluster ,
Required: False ,
}
string ,
}
,
trialDaysRemaining:
{
Description: Number of days remaining in the trial period. ,
Format: float ,
Required: False ,
}
number ,
billingModel:
{
Description: Type of billing applied to the resource. ,
Required: False ,
}
string ,
registrationTimestamp:
{
Description: First cluster sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncTimestamp:
{
Description: Most recent cluster sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastBillingTimestamp:
{
Description: Most recent billing meter timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
serviceEndpoint:
{
Description: Region specific DataPath Endpoint of the cluster. ,
Required: False ,
}
string ,
resourceProviderObjectId:
{
Description: Object id of RP Service Principal ,
Required: False ,
}
string ,
secretsLocations:
{
Description: List of secret locations. ,
Required: False ,
}
[
{
secretsType:
{
Description: Type of secrets to store ,
Enum:
{
BackupSecrets: Backup secrets type ,
}
,
Required: True ,
}
enum ,
secretsLocation:
{
Description: secrets location ,
Required: True ,
}
string ,
}
,
]
,
clusterPattern:
{
Description: Supported Storage Type for HCI Cluster ,
Enum:
{
Standard: Standard cluster. ,
RackAware: RackAware cluster. ,
}
,
Required: False ,
}
enum ,
confidentialVmProperties:
{
Description: Represents the Confidential Virtual Machine (CVM) support intent and current status for the cluster resource. ,
Required: False ,
}
{
confidentialVmIntent:
{
Description: Captures the customer's intent to enable or disable CVM support on the cluster, either during initial deployment (Day-0) or at a later stage (Day-N). ,
Enum:
{
Enable: Indicates that the customer intends to enable CVM support on the cluster. ,
Disable: Indicates that the customer intends to disable CVM support on the cluster. ,
}
,
Required: False ,
}
enum ,
confidentialVmStatus:
{
Description: Captures the current status of CVM support on the cluster. ,
Enum:
{
Enabled: CVM support is fully enabled on the cluster. All nodes are CVM capable. ,
PartiallyEnabled: CVM support is partially enabled. At least one node in the cluster is CVM capable. ,
Disabled: CVM support is disabled. None of the nodes in the cluster are CVM capable. ,
}
,
Required: False ,
}
enum ,
confidentialVmStatusSummary:
{
Description: Additional context about CVM support on the cluster, such as reasons for partial enablement or hardware constraints. ,
Required: False ,
}
string ,
}
,
sdnProperties:
{
Description: Software Defined Networking Properties of the cluster ,
Required: False ,
}
{
sdnIntegrationIntent:
{
Description: Indicates whether Software Defined Networking (SDN) integration should be enabled or disabled for this deployment. ,
Enum:
{
Enable: Enable SDN integration for the deployment. ,
Disable: Disable SDN integration for the deployment. ,
}
,
Required: False ,
}
enum ,
}
,
localAvailabilityZones:
{
Description: Local Availability Zone information for HCI cluster ,
Required: False ,
}
[
{
localAvailabilityZoneName:
{
Description: Local Availability Zone name for HCI cluster ,
Required: False ,
}
string ,
nodes:
{
Description: Nodes belonging to a particular zone ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
identityProvider:
{
Description: Identity Provider for the cluster ,
Enum:
{
ActiveDirectory: Uses Active Directory as the identity provider, enabling domain-based authentication and centralized identity management. This is the default option. ,
LocalIdentity: Uses a local identity system integrated with Azure Key Vault for authentication. Suitable for AD-less environments where Active Directory is not available or required. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
kind:
{
Description: This property identifies the purpose of the Cluster deployment. For example, a valid value is AzureLocal ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Clusters_ConfigureRemoteSupport (removed)
Description :  Configure RemoteSupport on a cluster
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/configureRemoteSupport
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
remoteSupportRequest:
{
Description: Configure Remote Support Request Payload ,
Required: True ,
}
{
properties:
{
Description: Properties for Remote Support Request ,
Required: False ,
}
{
accessLevel:
{
Description: Remote Support Access Level ,
Enum:
{
Diagnostics: Allows remote diagnostics operations only. ,
DiagnosticsAndRepair: Allows both remote diagnostics and repair operations. ,
}
,
Required: False ,
}
enum ,
expirationTimeStamp:
{
Description: Expiration DateTimeStamp when Remote Support Access will be expired ,
Format: date-time ,
Required: False ,
}
string ,
remoteSupportType:
{
Description: Remote Support Type for cluster ,
Enum:
{
Enable: Enable remote support for the cluster. ,
Revoke: Revoke previously enabled remote support for the cluster. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Cluster properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state. Indicates the current lifecycle status of the resource, including creation, update, deletion, connectivity, and error states. ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Status of the cluster agent. Indicates the current connectivity, validation, and deployment state of the agent within the cluster. ,
Enum:
{
NotYetRegistered: The cluster agent has not yet registered with Azure. ,
ConnectedRecently: The cluster agent has connected to Azure recently. ,
NotConnectedRecently: The cluster agent has not connected to Azure recently. ,
Disconnected: The cluster agent is currently disconnected from Azure. ,
Error: An error occurred in the cluster agent's operation. ,
NotSpecified: The status of the cluster agent is not specified. ,
ValidationInProgress: Validation of the cluster agent is currently in progress. ,
ValidationSuccess: Validation of the cluster agent completed successfully. ,
ValidationFailed: Validation of the cluster agent failed. ,
DeploymentInProgress: Deployment of the cluster agent is currently in progress. ,
DeploymentFailed: Deployment of the cluster agent failed. ,
DeploymentSuccess: Deployment of the cluster agent completed successfully. ,
}
,
Required: False ,
}
enum ,
connectivityStatus:
{
Description: Overall connectivity status for the cluster resource. Indicates whether the cluster is connected to Azure, partially connected, or has not recently communicated. ,
Enum:
{
NotYetRegistered: The cluster has not yet registered with Azure. ,
Connected: The cluster is fully connected to Azure. ,
NotConnectedRecently: The cluster has not connected to Azure recently. ,
PartiallyConnected: Some components of the cluster are connected, while others are not. ,
Disconnected: The cluster is not connected to Azure. ,
NotSpecified: The connectivity status is not specified. ,
}
,
Required: False ,
}
enum ,
supportStatus:
{
Description: Indicates whether the cluster is under support. ,
Enum:
{
InSupport: The cluster is under support. ,
OutOfSupport: The cluster is out of support. ,
NotSpecified: The support status is not specified. ,
}
,
Required: False ,
}
enum ,
cloudId:
{
Description: Unique, immutable resource id. ,
Required: False ,
}
string ,
ring:
{
Description: The ring to which this cluster belongs to. ,
Required: False ,
}
string ,
cloudManagementEndpoint:
{
Description: Endpoint configured for management from the Azure portal. ,
Required: False ,
}
string ,
aadClientId:
{
Description: App id of cluster AAD identity. ,
Required: False ,
}
string ,
aadTenantId:
{
Description: Tenant id of cluster AAD identity. ,
Required: False ,
}
string ,
aadApplicationObjectId:
{
Description: Object id of cluster AAD identity. ,
Required: False ,
}
string ,
aadServicePrincipalObjectId:
{
Description: Id of cluster identity service principal. ,
Required: False ,
}
string ,
softwareAssuranceProperties:
{
Description: Software Assurance properties of the cluster. ,
Required: False ,
}
{
softwareAssuranceStatus:
{
Description: Status of the Software Assurance for the cluster. ,
Enum:
{
Enabled: Software Assurance is enabled for the cluster. ,
Disabled: Software Assurance is disabled for the cluster. ,
}
,
Required: False ,
}
enum ,
softwareAssuranceIntent:
{
Description: Customer Intent for Software Assurance Benefit. ,
Enum:
{
Enable: Customer intends to enable the Software Assurance benefit. ,
Disable: Customer intends to disable the Software Assurance benefit. ,
}
,
Required: False ,
}
enum ,
lastUpdated:
{
Description: TimeStamp denoting the latest SA benefit applicability is validated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
isManagementCluster:
{
Description: Is Management Cluster, when true indicates that the cluster is used for managing other clusters ,
Required: False ,
}
boolean ,
logCollectionProperties:
{
Description: Log Collection properties of the cluster. ,
Required: False ,
}
{
fromDate:
{
Description: From DateTimeStamp from when logs need to be connected ,
Format: date-time ,
Required: False ,
}
string ,
toDate:
{
Description: To DateTimeStamp till when logs need to be connected ,
Format: date-time ,
Required: False ,
}
string ,
lastLogGenerated:
{
Description: Recent DateTimeStamp where logs are successfully generated ,
Format: date-time ,
Required: False ,
}
string ,
logCollectionSessionDetails:
{
Required: False ,
}
[
{
logStartTime:
{
Description: Start Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
logEndTime:
{
Description: End Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
timeCollected:
{
Description: Duration of logs collected ,
Format: date-time ,
Required: False ,
}
string ,
logSize:
{
Description: Size of the logs collected ,
Format: int64 ,
Required: False ,
}
integer ,
logCollectionStatus:
{
Description: LogCollection status ,
Enum:
{
None: No log collection has been initiated. ,
InProgress: Log collection is currently in progress. ,
Failed: Log collection has failed. ,
Succeeded: Log collection completed successfully. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: CorrelationId of the log collection ,
Required: False ,
}
string ,
logCollectionJobType:
{
Description: Specifies the type of log collection job. Determines whether the logs are collected immediately on demand or as part of a scheduled operation. ,
Enum:
{
OnDemand: Log collection is triggered manually and executed immediately. ,
Scheduled: Log collection is scheduled to run at a predefined time or interval. ,
}
,
Required: False ,
}
enum ,
endTimeCollected:
{
Description: End Time of the logs when it was collected ,
Format: date-time ,
Required: False ,
}
string ,
logCollectionError:
{
Description: Log Collection Error details of the cluster. ,
Required: False ,
}
{
errorCode:
{
Description: Error Code of the log collection ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error Message of the log collection ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
remoteSupportProperties:
{
Description: RemoteSupport properties of the cluster. ,
Required: False ,
}
{
accessLevel:
{
Description: Remote Support Access Level ,
Enum:
{
Diagnostics: Allows remote diagnostics operations only. ,
DiagnosticsAndRepair: Allows both remote diagnostics and repair operations. ,
}
,
Required: False ,
}
enum ,
expirationTimeStamp:
{
Description: Expiration DateTimeStamp when Remote Support Access will be expired ,
Format: date-time ,
Required: False ,
}
string ,
remoteSupportType:
{
Description: Remote Support Type for cluster ,
Enum:
{
Enable: Enable remote support for the cluster. ,
Revoke: Revoke previously enabled remote support for the cluster. ,
}
,
Required: False ,
}
enum ,
remoteSupportNodeSettings:
{
Required: False ,
}
[
{
arcResourceId:
{
Description: Arc ResourceId of the Node ,
Required: False ,
}
string ,
state:
{
Description: Remote Support Access Connection State on the Node ,
Required: False ,
}
string ,
createdAt:
{
Description: Remote Support Enablement Request Created TimeStamp on the Node ,
Format: date-time ,
Required: False ,
}
string ,
updatedAt:
{
Description: Remote Support Enablement Request Updated TimeStamp on the Node ,
Format: date-time ,
Required: False ,
}
string ,
connectionStatus:
{
Description: Remote Support Access Connection Status on the Node ,
Required: False ,
}
string ,
connectionErrorMessage:
{
Description: Remote Support Access Connection Error Message on the Node ,
Required: False ,
}
string ,
transcriptLocation:
{
Description: Remote Support Transcript location on the node ,
Required: False ,
}
string ,
}
,
]
,
remoteSupportSessionDetails:
{
Required: False ,
}
[
{
sessionStartTime:
{
Description: Remote Support Session StartTime on the Node ,
Format: date-time ,
Required: False ,
}
string ,
sessionEndTime:
{
Description: Remote Support Session EndTime on the Node ,
Format: date-time ,
Required: False ,
}
string ,
nodeName:
{
Description: Name of the node ,
Required: False ,
}
string ,
duration:
{
Description: Duration of Remote Support Enablement ,
Format: int64 ,
Required: False ,
}
integer ,
accessLevel:
{
Description: Remote Support Access Level ,
Enum:
{
Diagnostics: Allows remote diagnostics operations only. ,
DiagnosticsAndRepair: Allows both remote diagnostics and repair operations. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
desiredProperties:
{
Description: Desired properties of the cluster. ,
Required: False ,
}
{
windowsServerSubscription:
{
Description: Desired state of Windows Server Subscription. ,
Enum:
{
Disabled: Windows Server Subscription is disabled. ,
Enabled: Windows Server Subscription is enabled. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Desired level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No diagnostic data will be emitted. ,
Basic: Basic diagnostic data will be emitted, including essential health metrics. ,
Enhanced: Enhanced diagnostic data will be emitted, including detailed performance and usage metrics. ,
}
,
Required: False ,
}
enum ,
}
,
reportedProperties:
{
Description: Properties reported by cluster agent. ,
Required: False ,
}
{
clusterName:
{
Description: Name of the on-prem cluster connected to this resource. ,
Required: False ,
}
string ,
clusterId:
{
Description: Unique id generated by the on-prem cluster. ,
Required: False ,
}
string ,
clusterVersion:
{
Description: Version of the cluster software. ,
Required: False ,
}
string ,
nodes:
{
Description: List of nodes reported by the cluster. ,
Required: False ,
}
[
{
name:
{
Description: Name of the cluster node. ,
Required: False ,
}
string ,
id:
{
Description: Id of the node in the cluster. ,
Format: float ,
Required: False ,
}
number ,
windowsServerSubscription:
{
Description: State of Windows Server Subscription. ,
Enum:
{
Disabled: Windows Server Subscription is disabled. ,
Enabled: Windows Server Subscription is enabled. ,
}
,
Required: False ,
}
enum ,
nodeType:
{
Description: Type of the cluster node hardware. ,
Enum:
{
FirstParty: All nodes in the cluster are provided and managed by Microsoft. ,
ThirdParty: All nodes in the cluster are provided and managed by a third-party vendor. ,
}
,
Required: False ,
}
enum ,
ehcResourceId:
{
Description: Edge Hardware Center Resource Id ,
Required: False ,
}
string ,
manufacturer:
{
Description: Manufacturer of the cluster node hardware. ,
Required: False ,
}
string ,
model:
{
Description: Model name of the cluster node hardware. ,
Required: False ,
}
string ,
osName:
{
Description: Operating system running on the cluster node. ,
Required: False ,
}
string ,
osVersion:
{
Description: Version of the operating system running on the cluster node. ,
Required: False ,
}
string ,
osDisplayVersion:
{
Description: Display version of the operating system running on the cluster node. ,
Required: False ,
}
string ,
serialNumber:
{
Description: Immutable id of the cluster node. ,
Required: False ,
}
string ,
coreCount:
{
Description: Number of physical cores on the cluster node. ,
Format: float ,
Required: False ,
}
number ,
memoryInGiB:
{
Description: Total available memory on the cluster node (in GiB). ,
Format: float ,
Required: False ,
}
number ,
lastLicensingTimestamp:
{
Description: Most recent licensing timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
oemActivation:
{
Description: OEM activation status of the node. ,
Enum:
{
Disabled: OEM activation is disabled for the cluster. ,
Enabled: OEM activation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
lastUpdated:
{
Description: Last time the cluster reported the data. ,
Format: date-time ,
Required: False ,
}
string ,
msiExpirationTimeStamp:
{
Description: Specifies the expiration timestamp of the cluster's Managed Service Identity (MSI). The value is expressed in Coordinated Universal Time (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
imdsAttestation:
{
Description: IMDS attestation status of the cluster. ,
Enum:
{
Disabled: IMDS attestation is disabled for the cluster. ,
Enabled: IMDS attestation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No diagnostic data will be emitted. ,
Basic: Basic diagnostic data will be emitted, including essential health metrics. ,
Enhanced: Enhanced diagnostic data will be emitted, including detailed performance and usage metrics. ,
}
,
Required: False ,
}
enum ,
supportedCapabilities:
{
Description: Capabilities supported by the cluster. ,
Required: False ,
}
[
string ,
]
,
clusterType:
{
Description: Specifies the type of hardware vendor for all nodes in the cluster. Indicates whether the nodes are provided by Microsoft or a third-party vendor. ,
Enum:
{
FirstParty: All nodes in the cluster are provided and managed by Microsoft. ,
ThirdParty: All nodes in the cluster are provided and managed by a third-party vendor. ,
}
,
Required: False ,
}
enum ,
manufacturer:
{
Description: The manufacturer of all the nodes of the cluster. ,
Required: False ,
}
string ,
oemActivation:
{
Description: OEM activation status of the cluster. ,
Enum:
{
Disabled: OEM activation is disabled for the cluster. ,
Enabled: OEM activation is enabled for the cluster. ,
}
,
Required: False ,
}
enum ,
hardwareClass:
{
Description: Hardware class of the cluster. ,
Enum:
{
Small: The hardware class is small. ,
Medium: The hardware class is medium. This corresponds to the default ,
Large: The hardware class is large. ,
}
,
Required: False ,
}
enum ,
}
,
isolatedVmAttestationConfiguration:
{
Description: Attestation configurations for isolated VM (e.g. TVM, CVM) of the cluster. ,
Required: False ,
}
{
attestationResourceId:
{
Description: Fully qualified Azure resource id of the Microsoft Azure attestation resource associated with this cluster. ,
Format: arm-id ,
Required: False ,
}
string ,
relyingPartyServiceEndpoint:
{
Description: Region specific endpoint for relying party service. ,
Required: False ,
}
string ,
attestationServiceEndpoint:
{
Description: Region specific endpoint for Microsoft Azure Attestation service for the cluster ,
Required: False ,
}
string ,
}
,
trialDaysRemaining:
{
Description: Number of days remaining in the trial period. ,
Format: float ,
Required: False ,
}
number ,
billingModel:
{
Description: Type of billing applied to the resource. ,
Required: False ,
}
string ,
registrationTimestamp:
{
Description: First cluster sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastSyncTimestamp:
{
Description: Most recent cluster sync timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
lastBillingTimestamp:
{
Description: Most recent billing meter timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
serviceEndpoint:
{
Description: Region specific DataPath Endpoint of the cluster. ,
Required: False ,
}
string ,
resourceProviderObjectId:
{
Description: Object id of RP Service Principal ,
Required: False ,
}
string ,
secretsLocations:
{
Description: List of secret locations. ,
Required: False ,
}
[
{
secretsType:
{
Description: Type of secrets to store ,
Enum:
{
BackupSecrets: Backup secrets type ,
}
,
Required: True ,
}
enum ,
secretsLocation:
{
Description: secrets location ,
Required: True ,
}
string ,
}
,
]
,
clusterPattern:
{
Description: Supported Storage Type for HCI Cluster ,
Enum:
{
Standard: Standard cluster. ,
RackAware: RackAware cluster. ,
}
,
Required: False ,
}
enum ,
confidentialVmProperties:
{
Description: Represents the Confidential Virtual Machine (CVM) support intent and current status for the cluster resource. ,
Required: False ,
}
{
confidentialVmIntent:
{
Description: Captures the customer's intent to enable or disable CVM support on the cluster, either during initial deployment (Day-0) or at a later stage (Day-N). ,
Enum:
{
Enable: Indicates that the customer intends to enable CVM support on the cluster. ,
Disable: Indicates that the customer intends to disable CVM support on the cluster. ,
}
,
Required: False ,
}
enum ,
confidentialVmStatus:
{
Description: Captures the current status of CVM support on the cluster. ,
Enum:
{
Enabled: CVM support is fully enabled on the cluster. All nodes are CVM capable. ,
PartiallyEnabled: CVM support is partially enabled. At least one node in the cluster is CVM capable. ,
Disabled: CVM support is disabled. None of the nodes in the cluster are CVM capable. ,
}
,
Required: False ,
}
enum ,
confidentialVmStatusSummary:
{
Description: Additional context about CVM support on the cluster, such as reasons for partial enablement or hardware constraints. ,
Required: False ,
}
string ,
}
,
sdnProperties:
{
Description: Software Defined Networking Properties of the cluster ,
Required: False ,
}
{
sdnIntegrationIntent:
{
Description: Indicates whether Software Defined Networking (SDN) integration should be enabled or disabled for this deployment. ,
Enum:
{
Enable: Enable SDN integration for the deployment. ,
Disable: Disable SDN integration for the deployment. ,
}
,
Required: False ,
}
enum ,
}
,
localAvailabilityZones:
{
Description: Local Availability Zone information for HCI cluster ,
Required: False ,
}
[
{
localAvailabilityZoneName:
{
Description: Local Availability Zone name for HCI cluster ,
Required: False ,
}
string ,
nodes:
{
Description: Nodes belonging to a particular zone ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
identityProvider:
{
Description: Identity Provider for the cluster ,
Enum:
{
ActiveDirectory: Uses Active Directory as the identity provider, enabling domain-based authentication and centralized identity management. This is the default option. ,
LocalIdentity: Uses a local identity system integrated with Azure Key Vault for authentication. Suitable for AD-less environments where Active Directory is not available or required. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
kind:
{
Description: This property identifies the purpose of the Cluster deployment. For example, a valid value is AzureLocal ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeploymentSettings_ListByClusters (removed)
Description :  List DeploymentSetting resources by Clusters
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/deploymentSettings
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The DeploymentSetting items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: DeploymentSetting provisioning state ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
arcNodeResourceIds:
{
Description: Azure resource ids of Arc machines to be part of cluster. ,
Required: True ,
}
[
string ,
]
,
deploymentMode:
{
Description: The deployment mode for cluster deployment. ,
Enum:
{
Validate: Validate ECE action deployment for a cluster. ,
Deploy: Deploy ECE action deployment for a cluster. ,
}
,
Required: True ,
}
enum ,
operationType:
{
Description: The intended operation for a cluster. ,
Enum:
{
ClusterProvisioning: Cluster provisioning operation. ,
ClusterUpgrade: Cluster upgrade operation. ,
}
,
Required: False ,
}
enum ,
deploymentConfiguration:
{
Description: Scale units will contains list of deployment data ,
Required: True ,
}
{
version:
{
Description: deployment template version ,
Required: False ,
}
string ,
scaleUnits:
{
Description: Scale units will contains list of deployment data ,
Required: True ,
}
[
{
deploymentData:
{
Description: Deployment Data to deploy AzureStackHCI Cluster. ,
Required: True ,
}
{
securitySettings:
{
Description: SecuritySettings to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
hvciProtection:
{
Description: By default, Hypervisor-protected Code Integrity is enabled on your Azure HCI cluster. ,
Required: False ,
}
boolean ,
drtmProtection:
{
Description: By default, Secure Boot is enabled on your Azure HCI cluster. This setting is hardware dependent. ,
Required: False ,
}
boolean ,
driftControlEnforced:
{
Description: When set to true, the security baseline is re-applied regularly. ,
Required: False ,
}
boolean ,
credentialGuardEnforced:
{
Description: When set to true, Credential Guard is enabled. ,
Required: False ,
}
boolean ,
smbSigningEnforced:
{
Description: When set to true, the SMB default instance requires sign in for the client and server services. ,
Required: False ,
}
boolean ,
smbClusterEncryption:
{
Description: When set to true, cluster east-west traffic is encrypted. ,
Required: False ,
}
boolean ,
sideChannelMitigationEnforced:
{
Description: When set to true, all the side channel mitigations are enabled ,
Required: False ,
}
boolean ,
bitlockerBootVolume:
{
Description: When set to true, BitLocker XTS_AES 256-bit encryption is enabled for all data-at-rest on the OS volume of your Azure Stack HCI cluster. This setting is TPM-hardware dependent. ,
Required: False ,
}
boolean ,
bitlockerDataVolumes:
{
Description: When set to true, BitLocker XTS-AES 256-bit encryption is enabled for all data-at-rest on your Azure Stack HCI cluster shared volumes. ,
Required: False ,
}
boolean ,
wdacEnforced:
{
Description: WDAC is enabled by default and limits the applications and the code that you can run on your Azure Stack HCI cluster. ,
Required: False ,
}
boolean ,
}
,
observability:
{
Description: Observability config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
streamingDataClient:
{
Description: Enables telemetry data to be sent to Microsoft ,
Required: False ,
}
boolean ,
euLocation:
{
Description: Location of your cluster. The log and diagnostic data is sent to the appropriate diagnostics servers depending upon where your cluster resides. Setting this to false results in all data sent to Microsoft to be stored outside of the EU. ,
Required: False ,
}
boolean ,
episodicDataUpload:
{
Description: When set to true, collects log data to facilitate quicker issue resolution. ,
Required: False ,
}
boolean ,
}
,
cluster:
{
Description: Observability config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
name:
{
Description: The cluster name provided when preparing Active Directory. ,
Required: False ,
}
string ,
witnessType:
{
Description: Use a cloud witness if you have internet access and if you use an Azure Storage account to provide a vote on cluster quorum. A cloud witness uses Azure Blob Storage to read or write a blob file and then uses it to arbitrate in split-brain resolution. Only allowed values are 'Cloud', 'FileShare'. ,
Required: False ,
}
string ,
witnessPath:
{
Description: Specify the fileshare path for the local witness for your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
cloudAccountName:
{
Description: Specify the Azure Storage account name for cloud witness for your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
azureServiceEndpoint:
{
Description: For Azure blob service endpoint type, select either Default or Custom domain. If you selected **Custom domain, enter the domain for the blob service in this format core.windows.net. ,
Required: False ,
}
string ,
hardwareClass:
{
Description: Hardware class of the cluster. ,
Enum:
{
Small: The hardware class is small. ,
Medium: The hardware class is medium. This corresponds to the default ,
Large: The hardware class is large. ,
}
,
Required: False ,
}
enum ,
clusterPattern:
{
Description: Cluster Pattern supported. ,
Enum:
{
Standard: Standard cluster. ,
RackAware: RackAware cluster. ,
}
,
Required: False ,
}
enum ,
}
,
identityProvider:
{
Description: Identity Provider for the cluster ,
Enum:
{
ActiveDirectory: Uses Active Directory as the identity provider, enabling domain-based authentication and centralized identity management. This is the default option. ,
LocalIdentity: Uses a local identity system integrated with Azure Key Vault for authentication. Suitable for AD-less environments where Active Directory is not available or required. ,
}
,
Required: False ,
}
enum ,
storage:
{
Description: Storage config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
configurationMode:
{
Description: By default, this mode is set to Express and your storage is configured as per best practices based on the number of nodes in the cluster. Allowed values are 'Express','InfraOnly', 'KeepStorage' ,
Required: False ,
}
string ,
}
,
namingPrefix:
{
Description: naming prefix to deploy cluster. ,
Required: False ,
}
string ,
domainFqdn:
{
Description: FQDN to deploy cluster ,
Required: False ,
}
string ,
infrastructureNetwork:
{
Description: InfrastructureNetwork config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
[
{
subnetMask:
{
Description: Subnet mask that matches the provided IP address space. ,
Required: False ,
}
string ,
gateway:
{
Description: Default gateway that should be used for the provided IP address space. ,
Required: False ,
}
string ,
ipPools:
{
Description: Range of IP addresses from which addresses are allocated for nodes within a subnet. ,
Required: False ,
}
[
{
startingAddress:
{
Description: Starting IP address for the management network. A minimum of six free, contiguous IPv4 addresses (excluding your host IPs) are needed for infrastructure services such as clustering. ,
Required: False ,
}
string ,
endingAddress:
{
Description: Ending IP address for the management network. A minimum of six free, contiguous IPv4 addresses (excluding your host IPs) are needed for infrastructure services such as clustering. ,
Required: False ,
}
string ,
}
,
]
,
dnsServerConfig:
{
Description: Specifies how DNS servers are configured for the infrastructure network. Allowed values are 'UseDnsServer' to use the provided DNS servers, and 'UseForwarder' to use DNS forwarders. ,
Enum:
{
UseDnsServer: Use the provided DNS servers for the infrastructure network. ,
UseForwarder: Use DNS forwarders for the infrastructure network. ,
}
,
Required: False ,
}
enum ,
dnsZones:
{
Description: Details of the DNS Zones to be configured. ,
Required: False ,
}
[
{
dnsZoneName:
{
Description: Name of the DNS Zone to be configured. ,
Required: False ,
}
string ,
dnsForwarder:
{
Description: Forwarder details of the DNS Zone to be configured. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
dnsServers:
{
Description: IPv4 address of the DNS servers in your environment. ,
Required: False ,
}
[
string ,
]
,
useDhcp:
{
Description: Allows customers to use DHCP for Hosts and Cluster IPs. If not declared, the deployment will default to static IPs. When true, GW and DNS servers are not required ,
Required: False ,
}
boolean ,
}
,
]
,
physicalNodes:
{
Description: list of physical nodes config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
[
{
name:
{
Description: NETBIOS name of each physical server on your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
ipv4Address:
{
Description: The IPv4 address assigned to each physical server on your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
}
,
]
,
hostNetwork:
{
Description: HostNetwork config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
intents:
{
Description: The network intents assigned to the network reference pattern used for the deployment. Each intent will define its own name, traffic type, adapter names, and overrides as recommended by your OEM. ,
Required: False ,
}
[
{
name:
{
Description: Name of the network intent you wish to create. ,
Required: False ,
}
string ,
trafficType:
{
Description: List of network traffic types. Only allowed values are 'Compute', 'Storage', 'Management'. ,
Required: False ,
}
[
string ,
]
,
adapter:
{
Description: Array of network interfaces used for the network intent. ,
Required: False ,
}
[
string ,
]
,
overrideVirtualSwitchConfiguration:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
boolean ,
virtualSwitchConfigurationOverrides:
{
Description: Set virtualSwitch ConfigurationOverrides for cluster. ,
Required: False ,
}
{
enableIov:
{
Description: Enable IoV for Virtual Switch ,
Required: False ,
}
string ,
loadBalancingAlgorithm:
{
Description: Load Balancing Algorithm for Virtual Switch ,
Required: False ,
}
string ,
}
,
overrideQosPolicy:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
boolean ,
qosPolicyOverrides:
{
Description: Set QoS PolicyOverrides for cluster. ,
Required: False ,
}
{
priorityValue8021Action_Cluster:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
string ,
priorityValue8021Action_SMB:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
string ,
bandwidthPercentage_SMB:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
string ,
}
,
overrideAdapterProperty:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
boolean ,
adapterPropertyOverrides:
{
Description: Set Adapter PropertyOverrides for cluster. ,
Required: False ,
}
{
jumboPacket:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
string ,
networkDirect:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
string ,
networkDirectTechnology:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. Expected values are 'iWARP', 'RoCEv2', 'RoCE' ,
Required: False ,
}
string ,
}
,
}
,
]
,
storageNetworks:
{
Description: List of StorageNetworks config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
[
{
name:
{
Description: Name of the storage network. ,
Required: False ,
}
string ,
networkAdapterName:
{
Description: Name of the storage network adapter. ,
Required: False ,
}
string ,
vlanId:
{
Description: ID specified for the VLAN storage network. This setting is applied to the network interfaces that route the storage and VM migration traffic. ,
Required: False ,
}
string ,
storageAdapterIPInfo:
{
Description: List of Storage adapter physical nodes config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
[
{
physicalNode:
{
Description: storage adapter physical node name. ,
Required: False ,
}
string ,
ipv4Address:
{
Description: The IPv4 address assigned to each storage adapter physical node on your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
subnetMask:
{
Description: The SubnetMask address assigned to each storage adapter physical node on your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
storageConnectivitySwitchless:
{
Description: Defines how the storage adapters between nodes are connected either switch or switch less.. ,
Required: False ,
}
boolean ,
enableStorageAutoIp:
{
Description: Optional parameter required only for 3 Nodes Switchless deployments. This allows users to specify IPs and Mask for Storage NICs when Network ATC is not assigning the IPs for storage automatically. ,
Required: False ,
}
boolean ,
}
,
sdnIntegration:
{
Description: SDN Integration config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
networkController:
{
Description: network controller config for SDN Integration to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
macAddressPoolStart:
{
Description: macAddressPoolStart of network controller used for SDN Integration. ,
Required: False ,
}
string ,
macAddressPoolStop:
{
Description: macAddressPoolStop of network controller used for SDN Integration. ,
Required: False ,
}
string ,
networkVirtualizationEnabled:
{
Description: NetworkVirtualizationEnabled of network controller used for SDN Integration. ,
Required: False ,
}
boolean ,
}
,
}
,
isManagementCluster:
{
Description: Is Management Cluster, when true indicates that the cluster is used for managing other clusters ,
Required: False ,
}
boolean ,
adouPath:
{
Description: The path to the Active Directory Organizational Unit container object prepared for the deployment. ,
Required: False ,
}
string ,
secretsLocation:
{
Description: Azure key vault endpoint. This property is deprecated from 2023-12-01-preview. Please use secrets property instead. ,
Required: False ,
}
string ,
secrets:
{
Description: secrets used for cloud deployment. ,
Required: False ,
}
[
{
secretName:
{
Description: Secret name stored in keyvault. ,
Required: False ,
}
string ,
eceSecretName:
{
Description: Secret name expected for Enterprise Cloud Engine (ECE) deployment. ,
Enum:
{
AzureStackLCMUserCredential: AzureStackLCMUserCredential used for LCM operations for AzureStackHCI cluster. ,
DefaultARBApplication: DefaultARBApplication used to manage Azure Arc resource bridge (ARB) for AzureStackHCI cluster. ,
LocalAdminCredential: LocalAdminCredential used for admin operations for AzureStackHCI cluster. ,
WitnessStorageKey: WitnessStorageKey used for setting up a cloud witness for AzureStackHCI cluster. ,
}
,
Required: False ,
}
enum ,
secretLocation:
{
Description: Secret URI stored in keyvault. ,
Format: uri ,
Required: False ,
}
string ,
}
,
]
,
optionalServices:
{
Description: OptionalServices config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
customLocation:
{
Description: The name of custom location. ,
Required: False ,
}
string ,
}
,
localAvailabilityZones:
{
Description: Local Availability Zone information for HCI cluster ,
Required: False ,
}
[
{
localAvailabilityZoneName:
{
Description: Local Availability Zone name for HCI cluster ,
Required: False ,
}
string ,
nodes:
{
Description: Nodes belonging to a particular zone ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
assemblyInfo:
{
Description: Assembly Package details for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
{
packageVersion:
{
Description: Assembly Package version for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
string ,
payload:
{
Description: Payload properties for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
[
{
identifier:
{
Description: assembly identifier for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
string ,
hash:
{
Description: Hash of assembly package for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
string ,
fileName:
{
Description: File name of assembly package for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
string ,
url:
{
Description: Url of assembly package for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
sbePartnerInfo:
{
Description: Solution builder extension (SBE) partner properties ,
Required: False ,
}
{
sbeDeploymentInfo:
{
Description: SBE package and manifest information for the solution Builder Extension staged for AzureStackHCI cluster deployment. ,
Required: False ,
}
{
version:
{
Description: SBE package version. ,
Required: False ,
}
string ,
family:
{
Description: SBE family name. ,
Required: False ,
}
string ,
publisher:
{
Description: SBE manifest publisher. ,
Required: False ,
}
string ,
sbeManifestSource:
{
Description: SBE Manifest Source. ,
Required: False ,
}
string ,
sbeManifestCreationDate:
{
Description: SBE Manifest Creation Date. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
partnerProperties:
{
Description: List of SBE partner properties for AzureStackHCI cluster deployment. ,
Required: False ,
}
[
{
name:
{
Description: SBE partner property name. ,
Required: False ,
}
string ,
value:
{
Description: SBE partner property value. ,
Required: False ,
}
string ,
}
,
]
,
credentialList:
{
Description: SBE credentials list for AzureStackHCI cluster deployment. ,
Required: False ,
}
[
{
secretName:
{
Description: secret name stored in keyvault. ,
Required: False ,
}
string ,
eceSecretName:
{
Description: secret name expected for Enterprise Cloud Engine (ECE). ,
Required: False ,
}
string ,
secretLocation:
{
Description: secret URI stored in keyvault. ,
Format: uri ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
}
,
reportedProperties:
{
Description: Deployment Status reported from cluster. ,
Required: False ,
}
{
validationStatus:
{
Description: validation status of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
{
status:
{
Description: Status of ECE action AzureStackHCI Cluster Deployment. ,
Required: False ,
}
string ,
steps:
{
Description: List of steps of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
{
name:
{
Description: Name of step. ,
Required: False ,
}
string ,
description:
{
Description: Description of step. ,
Required: False ,
}
string ,
fullStepIndex:
{
Description: FullStepIndex of step. ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: Start time of step. ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: End time of step. ,
Required: False ,
}
string ,
status:
{
Description: Status of step. Allowed values are 'Error', 'Success', 'InProgress' ,
Required: False ,
}
string ,
steps:
{
Description: List of nested steps of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
string ,
]
,
exception:
{
Description: List of exceptions in AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
deploymentStatus:
{
Description: Deployment status of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
{
status:
{
Description: Status of ECE action AzureStackHCI Cluster Deployment. ,
Required: False ,
}
string ,
steps:
{
Description: List of steps of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
{
name:
{
Description: Name of step. ,
Required: False ,
}
string ,
description:
{
Description: Description of step. ,
Required: False ,
}
string ,
fullStepIndex:
{
Description: FullStepIndex of step. ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: Start time of step. ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: End time of step. ,
Required: False ,
}
string ,
status:
{
Description: Status of step. Allowed values are 'Error', 'Success', 'InProgress' ,
Required: False ,
}
string ,
steps:
{
Description: List of nested steps of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
string ,
]
,
exception:
{
Description: List of exceptions in AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeploymentSettings_Get (removed)
Description :  Get a DeploymentSetting
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/deploymentSettings/{deploymentSettingsName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
deploymentSettingsName:
{
Description: Name of Deployment Setting ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: DeploymentSetting provisioning state ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
arcNodeResourceIds:
{
Description: Azure resource ids of Arc machines to be part of cluster. ,
Required: True ,
}
[
string ,
]
,
deploymentMode:
{
Description: The deployment mode for cluster deployment. ,
Enum:
{
Validate: Validate ECE action deployment for a cluster. ,
Deploy: Deploy ECE action deployment for a cluster. ,
}
,
Required: True ,
}
enum ,
operationType:
{
Description: The intended operation for a cluster. ,
Enum:
{
ClusterProvisioning: Cluster provisioning operation. ,
ClusterUpgrade: Cluster upgrade operation. ,
}
,
Required: False ,
}
enum ,
deploymentConfiguration:
{
Description: Scale units will contains list of deployment data ,
Required: True ,
}
{
version:
{
Description: deployment template version ,
Required: False ,
}
string ,
scaleUnits:
{
Description: Scale units will contains list of deployment data ,
Required: True ,
}
[
{
deploymentData:
{
Description: Deployment Data to deploy AzureStackHCI Cluster. ,
Required: True ,
}
{
securitySettings:
{
Description: SecuritySettings to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
hvciProtection:
{
Description: By default, Hypervisor-protected Code Integrity is enabled on your Azure HCI cluster. ,
Required: False ,
}
boolean ,
drtmProtection:
{
Description: By default, Secure Boot is enabled on your Azure HCI cluster. This setting is hardware dependent. ,
Required: False ,
}
boolean ,
driftControlEnforced:
{
Description: When set to true, the security baseline is re-applied regularly. ,
Required: False ,
}
boolean ,
credentialGuardEnforced:
{
Description: When set to true, Credential Guard is enabled. ,
Required: False ,
}
boolean ,
smbSigningEnforced:
{
Description: When set to true, the SMB default instance requires sign in for the client and server services. ,
Required: False ,
}
boolean ,
smbClusterEncryption:
{
Description: When set to true, cluster east-west traffic is encrypted. ,
Required: False ,
}
boolean ,
sideChannelMitigationEnforced:
{
Description: When set to true, all the side channel mitigations are enabled ,
Required: False ,
}
boolean ,
bitlockerBootVolume:
{
Description: When set to true, BitLocker XTS_AES 256-bit encryption is enabled for all data-at-rest on the OS volume of your Azure Stack HCI cluster. This setting is TPM-hardware dependent. ,
Required: False ,
}
boolean ,
bitlockerDataVolumes:
{
Description: When set to true, BitLocker XTS-AES 256-bit encryption is enabled for all data-at-rest on your Azure Stack HCI cluster shared volumes. ,
Required: False ,
}
boolean ,
wdacEnforced:
{
Description: WDAC is enabled by default and limits the applications and the code that you can run on your Azure Stack HCI cluster. ,
Required: False ,
}
boolean ,
}
,
observability:
{
Description: Observability config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
streamingDataClient:
{
Description: Enables telemetry data to be sent to Microsoft ,
Required: False ,
}
boolean ,
euLocation:
{
Description: Location of your cluster. The log and diagnostic data is sent to the appropriate diagnostics servers depending upon where your cluster resides. Setting this to false results in all data sent to Microsoft to be stored outside of the EU. ,
Required: False ,
}
boolean ,
episodicDataUpload:
{
Description: When set to true, collects log data to facilitate quicker issue resolution. ,
Required: False ,
}
boolean ,
}
,
cluster:
{
Description: Observability config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
name:
{
Description: The cluster name provided when preparing Active Directory. ,
Required: False ,
}
string ,
witnessType:
{
Description: Use a cloud witness if you have internet access and if you use an Azure Storage account to provide a vote on cluster quorum. A cloud witness uses Azure Blob Storage to read or write a blob file and then uses it to arbitrate in split-brain resolution. Only allowed values are 'Cloud', 'FileShare'. ,
Required: False ,
}
string ,
witnessPath:
{
Description: Specify the fileshare path for the local witness for your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
cloudAccountName:
{
Description: Specify the Azure Storage account name for cloud witness for your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
azureServiceEndpoint:
{
Description: For Azure blob service endpoint type, select either Default or Custom domain. If you selected **Custom domain, enter the domain for the blob service in this format core.windows.net. ,
Required: False ,
}
string ,
hardwareClass:
{
Description: Hardware class of the cluster. ,
Enum:
{
Small: The hardware class is small. ,
Medium: The hardware class is medium. This corresponds to the default ,
Large: The hardware class is large. ,
}
,
Required: False ,
}
enum ,
clusterPattern:
{
Description: Cluster Pattern supported. ,
Enum:
{
Standard: Standard cluster. ,
RackAware: RackAware cluster. ,
}
,
Required: False ,
}
enum ,
}
,
identityProvider:
{
Description: Identity Provider for the cluster ,
Enum:
{
ActiveDirectory: Uses Active Directory as the identity provider, enabling domain-based authentication and centralized identity management. This is the default option. ,
LocalIdentity: Uses a local identity system integrated with Azure Key Vault for authentication. Suitable for AD-less environments where Active Directory is not available or required. ,
}
,
Required: False ,
}
enum ,
storage:
{
Description: Storage config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
configurationMode:
{
Description: By default, this mode is set to Express and your storage is configured as per best practices based on the number of nodes in the cluster. Allowed values are 'Express','InfraOnly', 'KeepStorage' ,
Required: False ,
}
string ,
}
,
namingPrefix:
{
Description: naming prefix to deploy cluster. ,
Required: False ,
}
string ,
domainFqdn:
{
Description: FQDN to deploy cluster ,
Required: False ,
}
string ,
infrastructureNetwork:
{
Description: InfrastructureNetwork config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
[
{
subnetMask:
{
Description: Subnet mask that matches the provided IP address space. ,
Required: False ,
}
string ,
gateway:
{
Description: Default gateway that should be used for the provided IP address space. ,
Required: False ,
}
string ,
ipPools:
{
Description: Range of IP addresses from which addresses are allocated for nodes within a subnet. ,
Required: False ,
}
[
{
startingAddress:
{
Description: Starting IP address for the management network. A minimum of six free, contiguous IPv4 addresses (excluding your host IPs) are needed for infrastructure services such as clustering. ,
Required: False ,
}
string ,
endingAddress:
{
Description: Ending IP address for the management network. A minimum of six free, contiguous IPv4 addresses (excluding your host IPs) are needed for infrastructure services such as clustering. ,
Required: False ,
}
string ,
}
,
]
,
dnsServerConfig:
{
Description: Specifies how DNS servers are configured for the infrastructure network. Allowed values are 'UseDnsServer' to use the provided DNS servers, and 'UseForwarder' to use DNS forwarders. ,
Enum:
{
UseDnsServer: Use the provided DNS servers for the infrastructure network. ,
UseForwarder: Use DNS forwarders for the infrastructure network. ,
}
,
Required: False ,
}
enum ,
dnsZones:
{
Description: Details of the DNS Zones to be configured. ,
Required: False ,
}
[
{
dnsZoneName:
{
Description: Name of the DNS Zone to be configured. ,
Required: False ,
}
string ,
dnsForwarder:
{
Description: Forwarder details of the DNS Zone to be configured. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
dnsServers:
{
Description: IPv4 address of the DNS servers in your environment. ,
Required: False ,
}
[
string ,
]
,
useDhcp:
{
Description: Allows customers to use DHCP for Hosts and Cluster IPs. If not declared, the deployment will default to static IPs. When true, GW and DNS servers are not required ,
Required: False ,
}
boolean ,
}
,
]
,
physicalNodes:
{
Description: list of physical nodes config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
[
{
name:
{
Description: NETBIOS name of each physical server on your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
ipv4Address:
{
Description: The IPv4 address assigned to each physical server on your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
}
,
]
,
hostNetwork:
{
Description: HostNetwork config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
intents:
{
Description: The network intents assigned to the network reference pattern used for the deployment. Each intent will define its own name, traffic type, adapter names, and overrides as recommended by your OEM. ,
Required: False ,
}
[
{
name:
{
Description: Name of the network intent you wish to create. ,
Required: False ,
}
string ,
trafficType:
{
Description: List of network traffic types. Only allowed values are 'Compute', 'Storage', 'Management'. ,
Required: False ,
}
[
string ,
]
,
adapter:
{
Description: Array of network interfaces used for the network intent. ,
Required: False ,
}
[
string ,
]
,
overrideVirtualSwitchConfiguration:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
boolean ,
virtualSwitchConfigurationOverrides:
{
Description: Set virtualSwitch ConfigurationOverrides for cluster. ,
Required: False ,
}
{
enableIov:
{
Description: Enable IoV for Virtual Switch ,
Required: False ,
}
string ,
loadBalancingAlgorithm:
{
Description: Load Balancing Algorithm for Virtual Switch ,
Required: False ,
}
string ,
}
,
overrideQosPolicy:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
boolean ,
qosPolicyOverrides:
{
Description: Set QoS PolicyOverrides for cluster. ,
Required: False ,
}
{
priorityValue8021Action_Cluster:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
string ,
priorityValue8021Action_SMB:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
string ,
bandwidthPercentage_SMB:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
string ,
}
,
overrideAdapterProperty:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
boolean ,
adapterPropertyOverrides:
{
Description: Set Adapter PropertyOverrides for cluster. ,
Required: False ,
}
{
jumboPacket:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
string ,
networkDirect:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
string ,
networkDirectTechnology:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. Expected values are 'iWARP', 'RoCEv2', 'RoCE' ,
Required: False ,
}
string ,
}
,
}
,
]
,
storageNetworks:
{
Description: List of StorageNetworks config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
[
{
name:
{
Description: Name of the storage network. ,
Required: False ,
}
string ,
networkAdapterName:
{
Description: Name of the storage network adapter. ,
Required: False ,
}
string ,
vlanId:
{
Description: ID specified for the VLAN storage network. This setting is applied to the network interfaces that route the storage and VM migration traffic. ,
Required: False ,
}
string ,
storageAdapterIPInfo:
{
Description: List of Storage adapter physical nodes config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
[
{
physicalNode:
{
Description: storage adapter physical node name. ,
Required: False ,
}
string ,
ipv4Address:
{
Description: The IPv4 address assigned to each storage adapter physical node on your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
subnetMask:
{
Description: The SubnetMask address assigned to each storage adapter physical node on your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
storageConnectivitySwitchless:
{
Description: Defines how the storage adapters between nodes are connected either switch or switch less.. ,
Required: False ,
}
boolean ,
enableStorageAutoIp:
{
Description: Optional parameter required only for 3 Nodes Switchless deployments. This allows users to specify IPs and Mask for Storage NICs when Network ATC is not assigning the IPs for storage automatically. ,
Required: False ,
}
boolean ,
}
,
sdnIntegration:
{
Description: SDN Integration config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
networkController:
{
Description: network controller config for SDN Integration to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
macAddressPoolStart:
{
Description: macAddressPoolStart of network controller used for SDN Integration. ,
Required: False ,
}
string ,
macAddressPoolStop:
{
Description: macAddressPoolStop of network controller used for SDN Integration. ,
Required: False ,
}
string ,
networkVirtualizationEnabled:
{
Description: NetworkVirtualizationEnabled of network controller used for SDN Integration. ,
Required: False ,
}
boolean ,
}
,
}
,
isManagementCluster:
{
Description: Is Management Cluster, when true indicates that the cluster is used for managing other clusters ,
Required: False ,
}
boolean ,
adouPath:
{
Description: The path to the Active Directory Organizational Unit container object prepared for the deployment. ,
Required: False ,
}
string ,
secretsLocation:
{
Description: Azure key vault endpoint. This property is deprecated from 2023-12-01-preview. Please use secrets property instead. ,
Required: False ,
}
string ,
secrets:
{
Description: secrets used for cloud deployment. ,
Required: False ,
}
[
{
secretName:
{
Description: Secret name stored in keyvault. ,
Required: False ,
}
string ,
eceSecretName:
{
Description: Secret name expected for Enterprise Cloud Engine (ECE) deployment. ,
Enum:
{
AzureStackLCMUserCredential: AzureStackLCMUserCredential used for LCM operations for AzureStackHCI cluster. ,
DefaultARBApplication: DefaultARBApplication used to manage Azure Arc resource bridge (ARB) for AzureStackHCI cluster. ,
LocalAdminCredential: LocalAdminCredential used for admin operations for AzureStackHCI cluster. ,
WitnessStorageKey: WitnessStorageKey used for setting up a cloud witness for AzureStackHCI cluster. ,
}
,
Required: False ,
}
enum ,
secretLocation:
{
Description: Secret URI stored in keyvault. ,
Format: uri ,
Required: False ,
}
string ,
}
,
]
,
optionalServices:
{
Description: OptionalServices config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
customLocation:
{
Description: The name of custom location. ,
Required: False ,
}
string ,
}
,
localAvailabilityZones:
{
Description: Local Availability Zone information for HCI cluster ,
Required: False ,
}
[
{
localAvailabilityZoneName:
{
Description: Local Availability Zone name for HCI cluster ,
Required: False ,
}
string ,
nodes:
{
Description: Nodes belonging to a particular zone ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
assemblyInfo:
{
Description: Assembly Package details for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
{
packageVersion:
{
Description: Assembly Package version for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
string ,
payload:
{
Description: Payload properties for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
[
{
identifier:
{
Description: assembly identifier for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
string ,
hash:
{
Description: Hash of assembly package for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
string ,
fileName:
{
Description: File name of assembly package for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
string ,
url:
{
Description: Url of assembly package for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
sbePartnerInfo:
{
Description: Solution builder extension (SBE) partner properties ,
Required: False ,
}
{
sbeDeploymentInfo:
{
Description: SBE package and manifest information for the solution Builder Extension staged for AzureStackHCI cluster deployment. ,
Required: False ,
}
{
version:
{
Description: SBE package version. ,
Required: False ,
}
string ,
family:
{
Description: SBE family name. ,
Required: False ,
}
string ,
publisher:
{
Description: SBE manifest publisher. ,
Required: False ,
}
string ,
sbeManifestSource:
{
Description: SBE Manifest Source. ,
Required: False ,
}
string ,
sbeManifestCreationDate:
{
Description: SBE Manifest Creation Date. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
partnerProperties:
{
Description: List of SBE partner properties for AzureStackHCI cluster deployment. ,
Required: False ,
}
[
{
name:
{
Description: SBE partner property name. ,
Required: False ,
}
string ,
value:
{
Description: SBE partner property value. ,
Required: False ,
}
string ,
}
,
]
,
credentialList:
{
Description: SBE credentials list for AzureStackHCI cluster deployment. ,
Required: False ,
}
[
{
secretName:
{
Description: secret name stored in keyvault. ,
Required: False ,
}
string ,
eceSecretName:
{
Description: secret name expected for Enterprise Cloud Engine (ECE). ,
Required: False ,
}
string ,
secretLocation:
{
Description: secret URI stored in keyvault. ,
Format: uri ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
}
,
reportedProperties:
{
Description: Deployment Status reported from cluster. ,
Required: False ,
}
{
validationStatus:
{
Description: validation status of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
{
status:
{
Description: Status of ECE action AzureStackHCI Cluster Deployment. ,
Required: False ,
}
string ,
steps:
{
Description: List of steps of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
{
name:
{
Description: Name of step. ,
Required: False ,
}
string ,
description:
{
Description: Description of step. ,
Required: False ,
}
string ,
fullStepIndex:
{
Description: FullStepIndex of step. ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: Start time of step. ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: End time of step. ,
Required: False ,
}
string ,
status:
{
Description: Status of step. Allowed values are 'Error', 'Success', 'InProgress' ,
Required: False ,
}
string ,
steps:
{
Description: List of nested steps of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
string ,
]
,
exception:
{
Description: List of exceptions in AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
deploymentStatus:
{
Description: Deployment status of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
{
status:
{
Description: Status of ECE action AzureStackHCI Cluster Deployment. ,
Required: False ,
}
string ,
steps:
{
Description: List of steps of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
{
name:
{
Description: Name of step. ,
Required: False ,
}
string ,
description:
{
Description: Description of step. ,
Required: False ,
}
string ,
fullStepIndex:
{
Description: FullStepIndex of step. ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: Start time of step. ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: End time of step. ,
Required: False ,
}
string ,
status:
{
Description: Status of step. Allowed values are 'Error', 'Success', 'InProgress' ,
Required: False ,
}
string ,
steps:
{
Description: List of nested steps of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
string ,
]
,
exception:
{
Description: List of exceptions in AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeploymentSettings_CreateOrUpdate (removed)
Description :  Create a DeploymentSetting
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/deploymentSettings/{deploymentSettingsName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
deploymentSettingsName:
{
Description: Name of Deployment Setting ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: DeploymentSetting provisioning state ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
arcNodeResourceIds:
{
Description: Azure resource ids of Arc machines to be part of cluster. ,
Required: True ,
}
[
string ,
]
,
deploymentMode:
{
Description: The deployment mode for cluster deployment. ,
Enum:
{
Validate: Validate ECE action deployment for a cluster. ,
Deploy: Deploy ECE action deployment for a cluster. ,
}
,
Required: True ,
}
enum ,
operationType:
{
Description: The intended operation for a cluster. ,
Enum:
{
ClusterProvisioning: Cluster provisioning operation. ,
ClusterUpgrade: Cluster upgrade operation. ,
}
,
Required: False ,
}
enum ,
deploymentConfiguration:
{
Description: Scale units will contains list of deployment data ,
Required: True ,
}
{
version:
{
Description: deployment template version ,
Required: False ,
}
string ,
scaleUnits:
{
Description: Scale units will contains list of deployment data ,
Required: True ,
}
[
{
deploymentData:
{
Description: Deployment Data to deploy AzureStackHCI Cluster. ,
Required: True ,
}
{
securitySettings:
{
Description: SecuritySettings to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
hvciProtection:
{
Description: By default, Hypervisor-protected Code Integrity is enabled on your Azure HCI cluster. ,
Required: False ,
}
boolean ,
drtmProtection:
{
Description: By default, Secure Boot is enabled on your Azure HCI cluster. This setting is hardware dependent. ,
Required: False ,
}
boolean ,
driftControlEnforced:
{
Description: When set to true, the security baseline is re-applied regularly. ,
Required: False ,
}
boolean ,
credentialGuardEnforced:
{
Description: When set to true, Credential Guard is enabled. ,
Required: False ,
}
boolean ,
smbSigningEnforced:
{
Description: When set to true, the SMB default instance requires sign in for the client and server services. ,
Required: False ,
}
boolean ,
smbClusterEncryption:
{
Description: When set to true, cluster east-west traffic is encrypted. ,
Required: False ,
}
boolean ,
sideChannelMitigationEnforced:
{
Description: When set to true, all the side channel mitigations are enabled ,
Required: False ,
}
boolean ,
bitlockerBootVolume:
{
Description: When set to true, BitLocker XTS_AES 256-bit encryption is enabled for all data-at-rest on the OS volume of your Azure Stack HCI cluster. This setting is TPM-hardware dependent. ,
Required: False ,
}
boolean ,
bitlockerDataVolumes:
{
Description: When set to true, BitLocker XTS-AES 256-bit encryption is enabled for all data-at-rest on your Azure Stack HCI cluster shared volumes. ,
Required: False ,
}
boolean ,
wdacEnforced:
{
Description: WDAC is enabled by default and limits the applications and the code that you can run on your Azure Stack HCI cluster. ,
Required: False ,
}
boolean ,
}
,
observability:
{
Description: Observability config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
streamingDataClient:
{
Description: Enables telemetry data to be sent to Microsoft ,
Required: False ,
}
boolean ,
euLocation:
{
Description: Location of your cluster. The log and diagnostic data is sent to the appropriate diagnostics servers depending upon where your cluster resides. Setting this to false results in all data sent to Microsoft to be stored outside of the EU. ,
Required: False ,
}
boolean ,
episodicDataUpload:
{
Description: When set to true, collects log data to facilitate quicker issue resolution. ,
Required: False ,
}
boolean ,
}
,
cluster:
{
Description: Observability config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
name:
{
Description: The cluster name provided when preparing Active Directory. ,
Required: False ,
}
string ,
witnessType:
{
Description: Use a cloud witness if you have internet access and if you use an Azure Storage account to provide a vote on cluster quorum. A cloud witness uses Azure Blob Storage to read or write a blob file and then uses it to arbitrate in split-brain resolution. Only allowed values are 'Cloud', 'FileShare'. ,
Required: False ,
}
string ,
witnessPath:
{
Description: Specify the fileshare path for the local witness for your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
cloudAccountName:
{
Description: Specify the Azure Storage account name for cloud witness for your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
azureServiceEndpoint:
{
Description: For Azure blob service endpoint type, select either Default or Custom domain. If you selected **Custom domain, enter the domain for the blob service in this format core.windows.net. ,
Required: False ,
}
string ,
hardwareClass:
{
Description: Hardware class of the cluster. ,
Enum:
{
Small: The hardware class is small. ,
Medium: The hardware class is medium. This corresponds to the default ,
Large: The hardware class is large. ,
}
,
Required: False ,
}
enum ,
clusterPattern:
{
Description: Cluster Pattern supported. ,
Enum:
{
Standard: Standard cluster. ,
RackAware: RackAware cluster. ,
}
,
Required: False ,
}
enum ,
}
,
identityProvider:
{
Description: Identity Provider for the cluster ,
Enum:
{
ActiveDirectory: Uses Active Directory as the identity provider, enabling domain-based authentication and centralized identity management. This is the default option. ,
LocalIdentity: Uses a local identity system integrated with Azure Key Vault for authentication. Suitable for AD-less environments where Active Directory is not available or required. ,
}
,
Required: False ,
}
enum ,
storage:
{
Description: Storage config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
configurationMode:
{
Description: By default, this mode is set to Express and your storage is configured as per best practices based on the number of nodes in the cluster. Allowed values are 'Express','InfraOnly', 'KeepStorage' ,
Required: False ,
}
string ,
}
,
namingPrefix:
{
Description: naming prefix to deploy cluster. ,
Required: False ,
}
string ,
domainFqdn:
{
Description: FQDN to deploy cluster ,
Required: False ,
}
string ,
infrastructureNetwork:
{
Description: InfrastructureNetwork config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
[
{
subnetMask:
{
Description: Subnet mask that matches the provided IP address space. ,
Required: False ,
}
string ,
gateway:
{
Description: Default gateway that should be used for the provided IP address space. ,
Required: False ,
}
string ,
ipPools:
{
Description: Range of IP addresses from which addresses are allocated for nodes within a subnet. ,
Required: False ,
}
[
{
startingAddress:
{
Description: Starting IP address for the management network. A minimum of six free, contiguous IPv4 addresses (excluding your host IPs) are needed for infrastructure services such as clustering. ,
Required: False ,
}
string ,
endingAddress:
{
Description: Ending IP address for the management network. A minimum of six free, contiguous IPv4 addresses (excluding your host IPs) are needed for infrastructure services such as clustering. ,
Required: False ,
}
string ,
}
,
]
,
dnsServerConfig:
{
Description: Specifies how DNS servers are configured for the infrastructure network. Allowed values are 'UseDnsServer' to use the provided DNS servers, and 'UseForwarder' to use DNS forwarders. ,
Enum:
{
UseDnsServer: Use the provided DNS servers for the infrastructure network. ,
UseForwarder: Use DNS forwarders for the infrastructure network. ,
}
,
Required: False ,
}
enum ,
dnsZones:
{
Description: Details of the DNS Zones to be configured. ,
Required: False ,
}
[
{
dnsZoneName:
{
Description: Name of the DNS Zone to be configured. ,
Required: False ,
}
string ,
dnsForwarder:
{
Description: Forwarder details of the DNS Zone to be configured. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
dnsServers:
{
Description: IPv4 address of the DNS servers in your environment. ,
Required: False ,
}
[
string ,
]
,
useDhcp:
{
Description: Allows customers to use DHCP for Hosts and Cluster IPs. If not declared, the deployment will default to static IPs. When true, GW and DNS servers are not required ,
Required: False ,
}
boolean ,
}
,
]
,
physicalNodes:
{
Description: list of physical nodes config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
[
{
name:
{
Description: NETBIOS name of each physical server on your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
ipv4Address:
{
Description: The IPv4 address assigned to each physical server on your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
}
,
]
,
hostNetwork:
{
Description: HostNetwork config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
intents:
{
Description: The network intents assigned to the network reference pattern used for the deployment. Each intent will define its own name, traffic type, adapter names, and overrides as recommended by your OEM. ,
Required: False ,
}
[
{
name:
{
Description: Name of the network intent you wish to create. ,
Required: False ,
}
string ,
trafficType:
{
Description: List of network traffic types. Only allowed values are 'Compute', 'Storage', 'Management'. ,
Required: False ,
}
[
string ,
]
,
adapter:
{
Description: Array of network interfaces used for the network intent. ,
Required: False ,
}
[
string ,
]
,
overrideVirtualSwitchConfiguration:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
boolean ,
virtualSwitchConfigurationOverrides:
{
Description: Set virtualSwitch ConfigurationOverrides for cluster. ,
Required: False ,
}
{
enableIov:
{
Description: Enable IoV for Virtual Switch ,
Required: False ,
}
string ,
loadBalancingAlgorithm:
{
Description: Load Balancing Algorithm for Virtual Switch ,
Required: False ,
}
string ,
}
,
overrideQosPolicy:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
boolean ,
qosPolicyOverrides:
{
Description: Set QoS PolicyOverrides for cluster. ,
Required: False ,
}
{
priorityValue8021Action_Cluster:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
string ,
priorityValue8021Action_SMB:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
string ,
bandwidthPercentage_SMB:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
string ,
}
,
overrideAdapterProperty:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
boolean ,
adapterPropertyOverrides:
{
Description: Set Adapter PropertyOverrides for cluster. ,
Required: False ,
}
{
jumboPacket:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
string ,
networkDirect:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
string ,
networkDirectTechnology:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. Expected values are 'iWARP', 'RoCEv2', 'RoCE' ,
Required: False ,
}
string ,
}
,
}
,
]
,
storageNetworks:
{
Description: List of StorageNetworks config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
[
{
name:
{
Description: Name of the storage network. ,
Required: False ,
}
string ,
networkAdapterName:
{
Description: Name of the storage network adapter. ,
Required: False ,
}
string ,
vlanId:
{
Description: ID specified for the VLAN storage network. This setting is applied to the network interfaces that route the storage and VM migration traffic. ,
Required: False ,
}
string ,
storageAdapterIPInfo:
{
Description: List of Storage adapter physical nodes config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
[
{
physicalNode:
{
Description: storage adapter physical node name. ,
Required: False ,
}
string ,
ipv4Address:
{
Description: The IPv4 address assigned to each storage adapter physical node on your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
subnetMask:
{
Description: The SubnetMask address assigned to each storage adapter physical node on your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
storageConnectivitySwitchless:
{
Description: Defines how the storage adapters between nodes are connected either switch or switch less.. ,
Required: False ,
}
boolean ,
enableStorageAutoIp:
{
Description: Optional parameter required only for 3 Nodes Switchless deployments. This allows users to specify IPs and Mask for Storage NICs when Network ATC is not assigning the IPs for storage automatically. ,
Required: False ,
}
boolean ,
}
,
sdnIntegration:
{
Description: SDN Integration config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
networkController:
{
Description: network controller config for SDN Integration to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
macAddressPoolStart:
{
Description: macAddressPoolStart of network controller used for SDN Integration. ,
Required: False ,
}
string ,
macAddressPoolStop:
{
Description: macAddressPoolStop of network controller used for SDN Integration. ,
Required: False ,
}
string ,
networkVirtualizationEnabled:
{
Description: NetworkVirtualizationEnabled of network controller used for SDN Integration. ,
Required: False ,
}
boolean ,
}
,
}
,
isManagementCluster:
{
Description: Is Management Cluster, when true indicates that the cluster is used for managing other clusters ,
Required: False ,
}
boolean ,
adouPath:
{
Description: The path to the Active Directory Organizational Unit container object prepared for the deployment. ,
Required: False ,
}
string ,
secretsLocation:
{
Description: Azure key vault endpoint. This property is deprecated from 2023-12-01-preview. Please use secrets property instead. ,
Required: False ,
}
string ,
secrets:
{
Description: secrets used for cloud deployment. ,
Required: False ,
}
[
{
secretName:
{
Description: Secret name stored in keyvault. ,
Required: False ,
}
string ,
eceSecretName:
{
Description: Secret name expected for Enterprise Cloud Engine (ECE) deployment. ,
Enum:
{
AzureStackLCMUserCredential: AzureStackLCMUserCredential used for LCM operations for AzureStackHCI cluster. ,
DefaultARBApplication: DefaultARBApplication used to manage Azure Arc resource bridge (ARB) for AzureStackHCI cluster. ,
LocalAdminCredential: LocalAdminCredential used for admin operations for AzureStackHCI cluster. ,
WitnessStorageKey: WitnessStorageKey used for setting up a cloud witness for AzureStackHCI cluster. ,
}
,
Required: False ,
}
enum ,
secretLocation:
{
Description: Secret URI stored in keyvault. ,
Format: uri ,
Required: False ,
}
string ,
}
,
]
,
optionalServices:
{
Description: OptionalServices config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
customLocation:
{
Description: The name of custom location. ,
Required: False ,
}
string ,
}
,
localAvailabilityZones:
{
Description: Local Availability Zone information for HCI cluster ,
Required: False ,
}
[
{
localAvailabilityZoneName:
{
Description: Local Availability Zone name for HCI cluster ,
Required: False ,
}
string ,
nodes:
{
Description: Nodes belonging to a particular zone ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
assemblyInfo:
{
Description: Assembly Package details for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
{
packageVersion:
{
Description: Assembly Package version for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
string ,
payload:
{
Description: Payload properties for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
[
{
identifier:
{
Description: assembly identifier for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
string ,
hash:
{
Description: Hash of assembly package for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
string ,
fileName:
{
Description: File name of assembly package for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
string ,
url:
{
Description: Url of assembly package for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
sbePartnerInfo:
{
Description: Solution builder extension (SBE) partner properties ,
Required: False ,
}
{
sbeDeploymentInfo:
{
Description: SBE package and manifest information for the solution Builder Extension staged for AzureStackHCI cluster deployment. ,
Required: False ,
}
{
version:
{
Description: SBE package version. ,
Required: False ,
}
string ,
family:
{
Description: SBE family name. ,
Required: False ,
}
string ,
publisher:
{
Description: SBE manifest publisher. ,
Required: False ,
}
string ,
sbeManifestSource:
{
Description: SBE Manifest Source. ,
Required: False ,
}
string ,
sbeManifestCreationDate:
{
Description: SBE Manifest Creation Date. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
partnerProperties:
{
Description: List of SBE partner properties for AzureStackHCI cluster deployment. ,
Required: False ,
}
[
{
name:
{
Description: SBE partner property name. ,
Required: False ,
}
string ,
value:
{
Description: SBE partner property value. ,
Required: False ,
}
string ,
}
,
]
,
credentialList:
{
Description: SBE credentials list for AzureStackHCI cluster deployment. ,
Required: False ,
}
[
{
secretName:
{
Description: secret name stored in keyvault. ,
Required: False ,
}
string ,
eceSecretName:
{
Description: secret name expected for Enterprise Cloud Engine (ECE). ,
Required: False ,
}
string ,
secretLocation:
{
Description: secret URI stored in keyvault. ,
Format: uri ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
}
,
reportedProperties:
{
Description: Deployment Status reported from cluster. ,
Required: False ,
}
{
validationStatus:
{
Description: validation status of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
{
status:
{
Description: Status of ECE action AzureStackHCI Cluster Deployment. ,
Required: False ,
}
string ,
steps:
{
Description: List of steps of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
{
name:
{
Description: Name of step. ,
Required: False ,
}
string ,
description:
{
Description: Description of step. ,
Required: False ,
}
string ,
fullStepIndex:
{
Description: FullStepIndex of step. ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: Start time of step. ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: End time of step. ,
Required: False ,
}
string ,
status:
{
Description: Status of step. Allowed values are 'Error', 'Success', 'InProgress' ,
Required: False ,
}
string ,
steps:
{
Description: List of nested steps of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
string ,
]
,
exception:
{
Description: List of exceptions in AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
deploymentStatus:
{
Description: Deployment status of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
{
status:
{
Description: Status of ECE action AzureStackHCI Cluster Deployment. ,
Required: False ,
}
string ,
steps:
{
Description: List of steps of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
{
name:
{
Description: Name of step. ,
Required: False ,
}
string ,
description:
{
Description: Description of step. ,
Required: False ,
}
string ,
fullStepIndex:
{
Description: FullStepIndex of step. ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: Start time of step. ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: End time of step. ,
Required: False ,
}
string ,
status:
{
Description: Status of step. Allowed values are 'Error', 'Success', 'InProgress' ,
Required: False ,
}
string ,
steps:
{
Description: List of nested steps of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
string ,
]
,
exception:
{
Description: List of exceptions in AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: DeploymentSetting provisioning state ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
arcNodeResourceIds:
{
Description: Azure resource ids of Arc machines to be part of cluster. ,
Required: True ,
}
[
string ,
]
,
deploymentMode:
{
Description: The deployment mode for cluster deployment. ,
Enum:
{
Validate: Validate ECE action deployment for a cluster. ,
Deploy: Deploy ECE action deployment for a cluster. ,
}
,
Required: True ,
}
enum ,
operationType:
{
Description: The intended operation for a cluster. ,
Enum:
{
ClusterProvisioning: Cluster provisioning operation. ,
ClusterUpgrade: Cluster upgrade operation. ,
}
,
Required: False ,
}
enum ,
deploymentConfiguration:
{
Description: Scale units will contains list of deployment data ,
Required: True ,
}
{
version:
{
Description: deployment template version ,
Required: False ,
}
string ,
scaleUnits:
{
Description: Scale units will contains list of deployment data ,
Required: True ,
}
[
{
deploymentData:
{
Description: Deployment Data to deploy AzureStackHCI Cluster. ,
Required: True ,
}
{
securitySettings:
{
Description: SecuritySettings to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
hvciProtection:
{
Description: By default, Hypervisor-protected Code Integrity is enabled on your Azure HCI cluster. ,
Required: False ,
}
boolean ,
drtmProtection:
{
Description: By default, Secure Boot is enabled on your Azure HCI cluster. This setting is hardware dependent. ,
Required: False ,
}
boolean ,
driftControlEnforced:
{
Description: When set to true, the security baseline is re-applied regularly. ,
Required: False ,
}
boolean ,
credentialGuardEnforced:
{
Description: When set to true, Credential Guard is enabled. ,
Required: False ,
}
boolean ,
smbSigningEnforced:
{
Description: When set to true, the SMB default instance requires sign in for the client and server services. ,
Required: False ,
}
boolean ,
smbClusterEncryption:
{
Description: When set to true, cluster east-west traffic is encrypted. ,
Required: False ,
}
boolean ,
sideChannelMitigationEnforced:
{
Description: When set to true, all the side channel mitigations are enabled ,
Required: False ,
}
boolean ,
bitlockerBootVolume:
{
Description: When set to true, BitLocker XTS_AES 256-bit encryption is enabled for all data-at-rest on the OS volume of your Azure Stack HCI cluster. This setting is TPM-hardware dependent. ,
Required: False ,
}
boolean ,
bitlockerDataVolumes:
{
Description: When set to true, BitLocker XTS-AES 256-bit encryption is enabled for all data-at-rest on your Azure Stack HCI cluster shared volumes. ,
Required: False ,
}
boolean ,
wdacEnforced:
{
Description: WDAC is enabled by default and limits the applications and the code that you can run on your Azure Stack HCI cluster. ,
Required: False ,
}
boolean ,
}
,
observability:
{
Description: Observability config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
streamingDataClient:
{
Description: Enables telemetry data to be sent to Microsoft ,
Required: False ,
}
boolean ,
euLocation:
{
Description: Location of your cluster. The log and diagnostic data is sent to the appropriate diagnostics servers depending upon where your cluster resides. Setting this to false results in all data sent to Microsoft to be stored outside of the EU. ,
Required: False ,
}
boolean ,
episodicDataUpload:
{
Description: When set to true, collects log data to facilitate quicker issue resolution. ,
Required: False ,
}
boolean ,
}
,
cluster:
{
Description: Observability config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
name:
{
Description: The cluster name provided when preparing Active Directory. ,
Required: False ,
}
string ,
witnessType:
{
Description: Use a cloud witness if you have internet access and if you use an Azure Storage account to provide a vote on cluster quorum. A cloud witness uses Azure Blob Storage to read or write a blob file and then uses it to arbitrate in split-brain resolution. Only allowed values are 'Cloud', 'FileShare'. ,
Required: False ,
}
string ,
witnessPath:
{
Description: Specify the fileshare path for the local witness for your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
cloudAccountName:
{
Description: Specify the Azure Storage account name for cloud witness for your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
azureServiceEndpoint:
{
Description: For Azure blob service endpoint type, select either Default or Custom domain. If you selected **Custom domain, enter the domain for the blob service in this format core.windows.net. ,
Required: False ,
}
string ,
hardwareClass:
{
Description: Hardware class of the cluster. ,
Enum:
{
Small: The hardware class is small. ,
Medium: The hardware class is medium. This corresponds to the default ,
Large: The hardware class is large. ,
}
,
Required: False ,
}
enum ,
clusterPattern:
{
Description: Cluster Pattern supported. ,
Enum:
{
Standard: Standard cluster. ,
RackAware: RackAware cluster. ,
}
,
Required: False ,
}
enum ,
}
,
identityProvider:
{
Description: Identity Provider for the cluster ,
Enum:
{
ActiveDirectory: Uses Active Directory as the identity provider, enabling domain-based authentication and centralized identity management. This is the default option. ,
LocalIdentity: Uses a local identity system integrated with Azure Key Vault for authentication. Suitable for AD-less environments where Active Directory is not available or required. ,
}
,
Required: False ,
}
enum ,
storage:
{
Description: Storage config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
configurationMode:
{
Description: By default, this mode is set to Express and your storage is configured as per best practices based on the number of nodes in the cluster. Allowed values are 'Express','InfraOnly', 'KeepStorage' ,
Required: False ,
}
string ,
}
,
namingPrefix:
{
Description: naming prefix to deploy cluster. ,
Required: False ,
}
string ,
domainFqdn:
{
Description: FQDN to deploy cluster ,
Required: False ,
}
string ,
infrastructureNetwork:
{
Description: InfrastructureNetwork config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
[
{
subnetMask:
{
Description: Subnet mask that matches the provided IP address space. ,
Required: False ,
}
string ,
gateway:
{
Description: Default gateway that should be used for the provided IP address space. ,
Required: False ,
}
string ,
ipPools:
{
Description: Range of IP addresses from which addresses are allocated for nodes within a subnet. ,
Required: False ,
}
[
{
startingAddress:
{
Description: Starting IP address for the management network. A minimum of six free, contiguous IPv4 addresses (excluding your host IPs) are needed for infrastructure services such as clustering. ,
Required: False ,
}
string ,
endingAddress:
{
Description: Ending IP address for the management network. A minimum of six free, contiguous IPv4 addresses (excluding your host IPs) are needed for infrastructure services such as clustering. ,
Required: False ,
}
string ,
}
,
]
,
dnsServerConfig:
{
Description: Specifies how DNS servers are configured for the infrastructure network. Allowed values are 'UseDnsServer' to use the provided DNS servers, and 'UseForwarder' to use DNS forwarders. ,
Enum:
{
UseDnsServer: Use the provided DNS servers for the infrastructure network. ,
UseForwarder: Use DNS forwarders for the infrastructure network. ,
}
,
Required: False ,
}
enum ,
dnsZones:
{
Description: Details of the DNS Zones to be configured. ,
Required: False ,
}
[
{
dnsZoneName:
{
Description: Name of the DNS Zone to be configured. ,
Required: False ,
}
string ,
dnsForwarder:
{
Description: Forwarder details of the DNS Zone to be configured. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
dnsServers:
{
Description: IPv4 address of the DNS servers in your environment. ,
Required: False ,
}
[
string ,
]
,
useDhcp:
{
Description: Allows customers to use DHCP for Hosts and Cluster IPs. If not declared, the deployment will default to static IPs. When true, GW and DNS servers are not required ,
Required: False ,
}
boolean ,
}
,
]
,
physicalNodes:
{
Description: list of physical nodes config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
[
{
name:
{
Description: NETBIOS name of each physical server on your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
ipv4Address:
{
Description: The IPv4 address assigned to each physical server on your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
}
,
]
,
hostNetwork:
{
Description: HostNetwork config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
intents:
{
Description: The network intents assigned to the network reference pattern used for the deployment. Each intent will define its own name, traffic type, adapter names, and overrides as recommended by your OEM. ,
Required: False ,
}
[
{
name:
{
Description: Name of the network intent you wish to create. ,
Required: False ,
}
string ,
trafficType:
{
Description: List of network traffic types. Only allowed values are 'Compute', 'Storage', 'Management'. ,
Required: False ,
}
[
string ,
]
,
adapter:
{
Description: Array of network interfaces used for the network intent. ,
Required: False ,
}
[
string ,
]
,
overrideVirtualSwitchConfiguration:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
boolean ,
virtualSwitchConfigurationOverrides:
{
Description: Set virtualSwitch ConfigurationOverrides for cluster. ,
Required: False ,
}
{
enableIov:
{
Description: Enable IoV for Virtual Switch ,
Required: False ,
}
string ,
loadBalancingAlgorithm:
{
Description: Load Balancing Algorithm for Virtual Switch ,
Required: False ,
}
string ,
}
,
overrideQosPolicy:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
boolean ,
qosPolicyOverrides:
{
Description: Set QoS PolicyOverrides for cluster. ,
Required: False ,
}
{
priorityValue8021Action_Cluster:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
string ,
priorityValue8021Action_SMB:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
string ,
bandwidthPercentage_SMB:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
string ,
}
,
overrideAdapterProperty:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
boolean ,
adapterPropertyOverrides:
{
Description: Set Adapter PropertyOverrides for cluster. ,
Required: False ,
}
{
jumboPacket:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
string ,
networkDirect:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
string ,
networkDirectTechnology:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. Expected values are 'iWARP', 'RoCEv2', 'RoCE' ,
Required: False ,
}
string ,
}
,
}
,
]
,
storageNetworks:
{
Description: List of StorageNetworks config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
[
{
name:
{
Description: Name of the storage network. ,
Required: False ,
}
string ,
networkAdapterName:
{
Description: Name of the storage network adapter. ,
Required: False ,
}
string ,
vlanId:
{
Description: ID specified for the VLAN storage network. This setting is applied to the network interfaces that route the storage and VM migration traffic. ,
Required: False ,
}
string ,
storageAdapterIPInfo:
{
Description: List of Storage adapter physical nodes config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
[
{
physicalNode:
{
Description: storage adapter physical node name. ,
Required: False ,
}
string ,
ipv4Address:
{
Description: The IPv4 address assigned to each storage adapter physical node on your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
subnetMask:
{
Description: The SubnetMask address assigned to each storage adapter physical node on your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
storageConnectivitySwitchless:
{
Description: Defines how the storage adapters between nodes are connected either switch or switch less.. ,
Required: False ,
}
boolean ,
enableStorageAutoIp:
{
Description: Optional parameter required only for 3 Nodes Switchless deployments. This allows users to specify IPs and Mask for Storage NICs when Network ATC is not assigning the IPs for storage automatically. ,
Required: False ,
}
boolean ,
}
,
sdnIntegration:
{
Description: SDN Integration config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
networkController:
{
Description: network controller config for SDN Integration to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
macAddressPoolStart:
{
Description: macAddressPoolStart of network controller used for SDN Integration. ,
Required: False ,
}
string ,
macAddressPoolStop:
{
Description: macAddressPoolStop of network controller used for SDN Integration. ,
Required: False ,
}
string ,
networkVirtualizationEnabled:
{
Description: NetworkVirtualizationEnabled of network controller used for SDN Integration. ,
Required: False ,
}
boolean ,
}
,
}
,
isManagementCluster:
{
Description: Is Management Cluster, when true indicates that the cluster is used for managing other clusters ,
Required: False ,
}
boolean ,
adouPath:
{
Description: The path to the Active Directory Organizational Unit container object prepared for the deployment. ,
Required: False ,
}
string ,
secretsLocation:
{
Description: Azure key vault endpoint. This property is deprecated from 2023-12-01-preview. Please use secrets property instead. ,
Required: False ,
}
string ,
secrets:
{
Description: secrets used for cloud deployment. ,
Required: False ,
}
[
{
secretName:
{
Description: Secret name stored in keyvault. ,
Required: False ,
}
string ,
eceSecretName:
{
Description: Secret name expected for Enterprise Cloud Engine (ECE) deployment. ,
Enum:
{
AzureStackLCMUserCredential: AzureStackLCMUserCredential used for LCM operations for AzureStackHCI cluster. ,
DefaultARBApplication: DefaultARBApplication used to manage Azure Arc resource bridge (ARB) for AzureStackHCI cluster. ,
LocalAdminCredential: LocalAdminCredential used for admin operations for AzureStackHCI cluster. ,
WitnessStorageKey: WitnessStorageKey used for setting up a cloud witness for AzureStackHCI cluster. ,
}
,
Required: False ,
}
enum ,
secretLocation:
{
Description: Secret URI stored in keyvault. ,
Format: uri ,
Required: False ,
}
string ,
}
,
]
,
optionalServices:
{
Description: OptionalServices config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
customLocation:
{
Description: The name of custom location. ,
Required: False ,
}
string ,
}
,
localAvailabilityZones:
{
Description: Local Availability Zone information for HCI cluster ,
Required: False ,
}
[
{
localAvailabilityZoneName:
{
Description: Local Availability Zone name for HCI cluster ,
Required: False ,
}
string ,
nodes:
{
Description: Nodes belonging to a particular zone ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
assemblyInfo:
{
Description: Assembly Package details for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
{
packageVersion:
{
Description: Assembly Package version for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
string ,
payload:
{
Description: Payload properties for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
[
{
identifier:
{
Description: assembly identifier for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
string ,
hash:
{
Description: Hash of assembly package for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
string ,
fileName:
{
Description: File name of assembly package for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
string ,
url:
{
Description: Url of assembly package for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
sbePartnerInfo:
{
Description: Solution builder extension (SBE) partner properties ,
Required: False ,
}
{
sbeDeploymentInfo:
{
Description: SBE package and manifest information for the solution Builder Extension staged for AzureStackHCI cluster deployment. ,
Required: False ,
}
{
version:
{
Description: SBE package version. ,
Required: False ,
}
string ,
family:
{
Description: SBE family name. ,
Required: False ,
}
string ,
publisher:
{
Description: SBE manifest publisher. ,
Required: False ,
}
string ,
sbeManifestSource:
{
Description: SBE Manifest Source. ,
Required: False ,
}
string ,
sbeManifestCreationDate:
{
Description: SBE Manifest Creation Date. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
partnerProperties:
{
Description: List of SBE partner properties for AzureStackHCI cluster deployment. ,
Required: False ,
}
[
{
name:
{
Description: SBE partner property name. ,
Required: False ,
}
string ,
value:
{
Description: SBE partner property value. ,
Required: False ,
}
string ,
}
,
]
,
credentialList:
{
Description: SBE credentials list for AzureStackHCI cluster deployment. ,
Required: False ,
}
[
{
secretName:
{
Description: secret name stored in keyvault. ,
Required: False ,
}
string ,
eceSecretName:
{
Description: secret name expected for Enterprise Cloud Engine (ECE). ,
Required: False ,
}
string ,
secretLocation:
{
Description: secret URI stored in keyvault. ,
Format: uri ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
}
,
reportedProperties:
{
Description: Deployment Status reported from cluster. ,
Required: False ,
}
{
validationStatus:
{
Description: validation status of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
{
status:
{
Description: Status of ECE action AzureStackHCI Cluster Deployment. ,
Required: False ,
}
string ,
steps:
{
Description: List of steps of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
{
name:
{
Description: Name of step. ,
Required: False ,
}
string ,
description:
{
Description: Description of step. ,
Required: False ,
}
string ,
fullStepIndex:
{
Description: FullStepIndex of step. ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: Start time of step. ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: End time of step. ,
Required: False ,
}
string ,
status:
{
Description: Status of step. Allowed values are 'Error', 'Success', 'InProgress' ,
Required: False ,
}
string ,
steps:
{
Description: List of nested steps of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
string ,
]
,
exception:
{
Description: List of exceptions in AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
deploymentStatus:
{
Description: Deployment status of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
{
status:
{
Description: Status of ECE action AzureStackHCI Cluster Deployment. ,
Required: False ,
}
string ,
steps:
{
Description: List of steps of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
{
name:
{
Description: Name of step. ,
Required: False ,
}
string ,
description:
{
Description: Description of step. ,
Required: False ,
}
string ,
fullStepIndex:
{
Description: FullStepIndex of step. ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: Start time of step. ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: End time of step. ,
Required: False ,
}
string ,
status:
{
Description: Status of step. Allowed values are 'Error', 'Success', 'InProgress' ,
Required: False ,
}
string ,
steps:
{
Description: List of nested steps of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
string ,
]
,
exception:
{
Description: List of exceptions in AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Edge device resource ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: DeploymentSetting provisioning state ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
arcNodeResourceIds:
{
Description: Azure resource ids of Arc machines to be part of cluster. ,
Required: True ,
}
[
string ,
]
,
deploymentMode:
{
Description: The deployment mode for cluster deployment. ,
Enum:
{
Validate: Validate ECE action deployment for a cluster. ,
Deploy: Deploy ECE action deployment for a cluster. ,
}
,
Required: True ,
}
enum ,
operationType:
{
Description: The intended operation for a cluster. ,
Enum:
{
ClusterProvisioning: Cluster provisioning operation. ,
ClusterUpgrade: Cluster upgrade operation. ,
}
,
Required: False ,
}
enum ,
deploymentConfiguration:
{
Description: Scale units will contains list of deployment data ,
Required: True ,
}
{
version:
{
Description: deployment template version ,
Required: False ,
}
string ,
scaleUnits:
{
Description: Scale units will contains list of deployment data ,
Required: True ,
}
[
{
deploymentData:
{
Description: Deployment Data to deploy AzureStackHCI Cluster. ,
Required: True ,
}
{
securitySettings:
{
Description: SecuritySettings to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
hvciProtection:
{
Description: By default, Hypervisor-protected Code Integrity is enabled on your Azure HCI cluster. ,
Required: False ,
}
boolean ,
drtmProtection:
{
Description: By default, Secure Boot is enabled on your Azure HCI cluster. This setting is hardware dependent. ,
Required: False ,
}
boolean ,
driftControlEnforced:
{
Description: When set to true, the security baseline is re-applied regularly. ,
Required: False ,
}
boolean ,
credentialGuardEnforced:
{
Description: When set to true, Credential Guard is enabled. ,
Required: False ,
}
boolean ,
smbSigningEnforced:
{
Description: When set to true, the SMB default instance requires sign in for the client and server services. ,
Required: False ,
}
boolean ,
smbClusterEncryption:
{
Description: When set to true, cluster east-west traffic is encrypted. ,
Required: False ,
}
boolean ,
sideChannelMitigationEnforced:
{
Description: When set to true, all the side channel mitigations are enabled ,
Required: False ,
}
boolean ,
bitlockerBootVolume:
{
Description: When set to true, BitLocker XTS_AES 256-bit encryption is enabled for all data-at-rest on the OS volume of your Azure Stack HCI cluster. This setting is TPM-hardware dependent. ,
Required: False ,
}
boolean ,
bitlockerDataVolumes:
{
Description: When set to true, BitLocker XTS-AES 256-bit encryption is enabled for all data-at-rest on your Azure Stack HCI cluster shared volumes. ,
Required: False ,
}
boolean ,
wdacEnforced:
{
Description: WDAC is enabled by default and limits the applications and the code that you can run on your Azure Stack HCI cluster. ,
Required: False ,
}
boolean ,
}
,
observability:
{
Description: Observability config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
streamingDataClient:
{
Description: Enables telemetry data to be sent to Microsoft ,
Required: False ,
}
boolean ,
euLocation:
{
Description: Location of your cluster. The log and diagnostic data is sent to the appropriate diagnostics servers depending upon where your cluster resides. Setting this to false results in all data sent to Microsoft to be stored outside of the EU. ,
Required: False ,
}
boolean ,
episodicDataUpload:
{
Description: When set to true, collects log data to facilitate quicker issue resolution. ,
Required: False ,
}
boolean ,
}
,
cluster:
{
Description: Observability config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
name:
{
Description: The cluster name provided when preparing Active Directory. ,
Required: False ,
}
string ,
witnessType:
{
Description: Use a cloud witness if you have internet access and if you use an Azure Storage account to provide a vote on cluster quorum. A cloud witness uses Azure Blob Storage to read or write a blob file and then uses it to arbitrate in split-brain resolution. Only allowed values are 'Cloud', 'FileShare'. ,
Required: False ,
}
string ,
witnessPath:
{
Description: Specify the fileshare path for the local witness for your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
cloudAccountName:
{
Description: Specify the Azure Storage account name for cloud witness for your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
azureServiceEndpoint:
{
Description: For Azure blob service endpoint type, select either Default or Custom domain. If you selected **Custom domain, enter the domain for the blob service in this format core.windows.net. ,
Required: False ,
}
string ,
hardwareClass:
{
Description: Hardware class of the cluster. ,
Enum:
{
Small: The hardware class is small. ,
Medium: The hardware class is medium. This corresponds to the default ,
Large: The hardware class is large. ,
}
,
Required: False ,
}
enum ,
clusterPattern:
{
Description: Cluster Pattern supported. ,
Enum:
{
Standard: Standard cluster. ,
RackAware: RackAware cluster. ,
}
,
Required: False ,
}
enum ,
}
,
identityProvider:
{
Description: Identity Provider for the cluster ,
Enum:
{
ActiveDirectory: Uses Active Directory as the identity provider, enabling domain-based authentication and centralized identity management. This is the default option. ,
LocalIdentity: Uses a local identity system integrated with Azure Key Vault for authentication. Suitable for AD-less environments where Active Directory is not available or required. ,
}
,
Required: False ,
}
enum ,
storage:
{
Description: Storage config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
configurationMode:
{
Description: By default, this mode is set to Express and your storage is configured as per best practices based on the number of nodes in the cluster. Allowed values are 'Express','InfraOnly', 'KeepStorage' ,
Required: False ,
}
string ,
}
,
namingPrefix:
{
Description: naming prefix to deploy cluster. ,
Required: False ,
}
string ,
domainFqdn:
{
Description: FQDN to deploy cluster ,
Required: False ,
}
string ,
infrastructureNetwork:
{
Description: InfrastructureNetwork config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
[
{
subnetMask:
{
Description: Subnet mask that matches the provided IP address space. ,
Required: False ,
}
string ,
gateway:
{
Description: Default gateway that should be used for the provided IP address space. ,
Required: False ,
}
string ,
ipPools:
{
Description: Range of IP addresses from which addresses are allocated for nodes within a subnet. ,
Required: False ,
}
[
{
startingAddress:
{
Description: Starting IP address for the management network. A minimum of six free, contiguous IPv4 addresses (excluding your host IPs) are needed for infrastructure services such as clustering. ,
Required: False ,
}
string ,
endingAddress:
{
Description: Ending IP address for the management network. A minimum of six free, contiguous IPv4 addresses (excluding your host IPs) are needed for infrastructure services such as clustering. ,
Required: False ,
}
string ,
}
,
]
,
dnsServerConfig:
{
Description: Specifies how DNS servers are configured for the infrastructure network. Allowed values are 'UseDnsServer' to use the provided DNS servers, and 'UseForwarder' to use DNS forwarders. ,
Enum:
{
UseDnsServer: Use the provided DNS servers for the infrastructure network. ,
UseForwarder: Use DNS forwarders for the infrastructure network. ,
}
,
Required: False ,
}
enum ,
dnsZones:
{
Description: Details of the DNS Zones to be configured. ,
Required: False ,
}
[
{
dnsZoneName:
{
Description: Name of the DNS Zone to be configured. ,
Required: False ,
}
string ,
dnsForwarder:
{
Description: Forwarder details of the DNS Zone to be configured. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
dnsServers:
{
Description: IPv4 address of the DNS servers in your environment. ,
Required: False ,
}
[
string ,
]
,
useDhcp:
{
Description: Allows customers to use DHCP for Hosts and Cluster IPs. If not declared, the deployment will default to static IPs. When true, GW and DNS servers are not required ,
Required: False ,
}
boolean ,
}
,
]
,
physicalNodes:
{
Description: list of physical nodes config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
[
{
name:
{
Description: NETBIOS name of each physical server on your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
ipv4Address:
{
Description: The IPv4 address assigned to each physical server on your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
}
,
]
,
hostNetwork:
{
Description: HostNetwork config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
intents:
{
Description: The network intents assigned to the network reference pattern used for the deployment. Each intent will define its own name, traffic type, adapter names, and overrides as recommended by your OEM. ,
Required: False ,
}
[
{
name:
{
Description: Name of the network intent you wish to create. ,
Required: False ,
}
string ,
trafficType:
{
Description: List of network traffic types. Only allowed values are 'Compute', 'Storage', 'Management'. ,
Required: False ,
}
[
string ,
]
,
adapter:
{
Description: Array of network interfaces used for the network intent. ,
Required: False ,
}
[
string ,
]
,
overrideVirtualSwitchConfiguration:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
boolean ,
virtualSwitchConfigurationOverrides:
{
Description: Set virtualSwitch ConfigurationOverrides for cluster. ,
Required: False ,
}
{
enableIov:
{
Description: Enable IoV for Virtual Switch ,
Required: False ,
}
string ,
loadBalancingAlgorithm:
{
Description: Load Balancing Algorithm for Virtual Switch ,
Required: False ,
}
string ,
}
,
overrideQosPolicy:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
boolean ,
qosPolicyOverrides:
{
Description: Set QoS PolicyOverrides for cluster. ,
Required: False ,
}
{
priorityValue8021Action_Cluster:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
string ,
priorityValue8021Action_SMB:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
string ,
bandwidthPercentage_SMB:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
string ,
}
,
overrideAdapterProperty:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
boolean ,
adapterPropertyOverrides:
{
Description: Set Adapter PropertyOverrides for cluster. ,
Required: False ,
}
{
jumboPacket:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
string ,
networkDirect:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. ,
Required: False ,
}
string ,
networkDirectTechnology:
{
Description: This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. Expected values are 'iWARP', 'RoCEv2', 'RoCE' ,
Required: False ,
}
string ,
}
,
}
,
]
,
storageNetworks:
{
Description: List of StorageNetworks config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
[
{
name:
{
Description: Name of the storage network. ,
Required: False ,
}
string ,
networkAdapterName:
{
Description: Name of the storage network adapter. ,
Required: False ,
}
string ,
vlanId:
{
Description: ID specified for the VLAN storage network. This setting is applied to the network interfaces that route the storage and VM migration traffic. ,
Required: False ,
}
string ,
storageAdapterIPInfo:
{
Description: List of Storage adapter physical nodes config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
[
{
physicalNode:
{
Description: storage adapter physical node name. ,
Required: False ,
}
string ,
ipv4Address:
{
Description: The IPv4 address assigned to each storage adapter physical node on your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
subnetMask:
{
Description: The SubnetMask address assigned to each storage adapter physical node on your Azure Stack HCI cluster. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
storageConnectivitySwitchless:
{
Description: Defines how the storage adapters between nodes are connected either switch or switch less.. ,
Required: False ,
}
boolean ,
enableStorageAutoIp:
{
Description: Optional parameter required only for 3 Nodes Switchless deployments. This allows users to specify IPs and Mask for Storage NICs when Network ATC is not assigning the IPs for storage automatically. ,
Required: False ,
}
boolean ,
}
,
sdnIntegration:
{
Description: SDN Integration config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
networkController:
{
Description: network controller config for SDN Integration to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
macAddressPoolStart:
{
Description: macAddressPoolStart of network controller used for SDN Integration. ,
Required: False ,
}
string ,
macAddressPoolStop:
{
Description: macAddressPoolStop of network controller used for SDN Integration. ,
Required: False ,
}
string ,
networkVirtualizationEnabled:
{
Description: NetworkVirtualizationEnabled of network controller used for SDN Integration. ,
Required: False ,
}
boolean ,
}
,
}
,
isManagementCluster:
{
Description: Is Management Cluster, when true indicates that the cluster is used for managing other clusters ,
Required: False ,
}
boolean ,
adouPath:
{
Description: The path to the Active Directory Organizational Unit container object prepared for the deployment. ,
Required: False ,
}
string ,
secretsLocation:
{
Description: Azure key vault endpoint. This property is deprecated from 2023-12-01-preview. Please use secrets property instead. ,
Required: False ,
}
string ,
secrets:
{
Description: secrets used for cloud deployment. ,
Required: False ,
}
[
{
secretName:
{
Description: Secret name stored in keyvault. ,
Required: False ,
}
string ,
eceSecretName:
{
Description: Secret name expected for Enterprise Cloud Engine (ECE) deployment. ,
Enum:
{
AzureStackLCMUserCredential: AzureStackLCMUserCredential used for LCM operations for AzureStackHCI cluster. ,
DefaultARBApplication: DefaultARBApplication used to manage Azure Arc resource bridge (ARB) for AzureStackHCI cluster. ,
LocalAdminCredential: LocalAdminCredential used for admin operations for AzureStackHCI cluster. ,
WitnessStorageKey: WitnessStorageKey used for setting up a cloud witness for AzureStackHCI cluster. ,
}
,
Required: False ,
}
enum ,
secretLocation:
{
Description: Secret URI stored in keyvault. ,
Format: uri ,
Required: False ,
}
string ,
}
,
]
,
optionalServices:
{
Description: OptionalServices config to deploy AzureStackHCI Cluster. ,
Required: False ,
}
{
customLocation:
{
Description: The name of custom location. ,
Required: False ,
}
string ,
}
,
localAvailabilityZones:
{
Description: Local Availability Zone information for HCI cluster ,
Required: False ,
}
[
{
localAvailabilityZoneName:
{
Description: Local Availability Zone name for HCI cluster ,
Required: False ,
}
string ,
nodes:
{
Description: Nodes belonging to a particular zone ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
assemblyInfo:
{
Description: Assembly Package details for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
{
packageVersion:
{
Description: Assembly Package version for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
string ,
payload:
{
Description: Payload properties for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
[
{
identifier:
{
Description: assembly identifier for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
string ,
hash:
{
Description: Hash of assembly package for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
string ,
fileName:
{
Description: File name of assembly package for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
string ,
url:
{
Description: Url of assembly package for Validated Solution Recipe for AzureStackHCI Cluster ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
sbePartnerInfo:
{
Description: Solution builder extension (SBE) partner properties ,
Required: False ,
}
{
sbeDeploymentInfo:
{
Description: SBE package and manifest information for the solution Builder Extension staged for AzureStackHCI cluster deployment. ,
Required: False ,
}
{
version:
{
Description: SBE package version. ,
Required: False ,
}
string ,
family:
{
Description: SBE family name. ,
Required: False ,
}
string ,
publisher:
{
Description: SBE manifest publisher. ,
Required: False ,
}
string ,
sbeManifestSource:
{
Description: SBE Manifest Source. ,
Required: False ,
}
string ,
sbeManifestCreationDate:
{
Description: SBE Manifest Creation Date. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
partnerProperties:
{
Description: List of SBE partner properties for AzureStackHCI cluster deployment. ,
Required: False ,
}
[
{
name:
{
Description: SBE partner property name. ,
Required: False ,
}
string ,
value:
{
Description: SBE partner property value. ,
Required: False ,
}
string ,
}
,
]
,
credentialList:
{
Description: SBE credentials list for AzureStackHCI cluster deployment. ,
Required: False ,
}
[
{
secretName:
{
Description: secret name stored in keyvault. ,
Required: False ,
}
string ,
eceSecretName:
{
Description: secret name expected for Enterprise Cloud Engine (ECE). ,
Required: False ,
}
string ,
secretLocation:
{
Description: secret URI stored in keyvault. ,
Format: uri ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
]
,
}
,
reportedProperties:
{
Description: Deployment Status reported from cluster. ,
Required: False ,
}
{
validationStatus:
{
Description: validation status of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
{
status:
{
Description: Status of ECE action AzureStackHCI Cluster Deployment. ,
Required: False ,
}
string ,
steps:
{
Description: List of steps of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
{
name:
{
Description: Name of step. ,
Required: False ,
}
string ,
description:
{
Description: Description of step. ,
Required: False ,
}
string ,
fullStepIndex:
{
Description: FullStepIndex of step. ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: Start time of step. ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: End time of step. ,
Required: False ,
}
string ,
status:
{
Description: Status of step. Allowed values are 'Error', 'Success', 'InProgress' ,
Required: False ,
}
string ,
steps:
{
Description: List of nested steps of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
string ,
]
,
exception:
{
Description: List of exceptions in AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
deploymentStatus:
{
Description: Deployment status of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
{
status:
{
Description: Status of ECE action AzureStackHCI Cluster Deployment. ,
Required: False ,
}
string ,
steps:
{
Description: List of steps of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
{
name:
{
Description: Name of step. ,
Required: False ,
}
string ,
description:
{
Description: Description of step. ,
Required: False ,
}
string ,
fullStepIndex:
{
Description: FullStepIndex of step. ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: Start time of step. ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: End time of step. ,
Required: False ,
}
string ,
status:
{
Description: Status of step. Allowed values are 'Error', 'Success', 'InProgress' ,
Required: False ,
}
string ,
steps:
{
Description: List of nested steps of AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
string ,
]
,
exception:
{
Description: List of exceptions in AzureStackHCI Cluster Deployment. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeploymentSettings_Delete (removed)
Description :  Delete a DeploymentSetting
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/deploymentSettings/{deploymentSettingsName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
deploymentSettingsName:
{
Description: Name of Deployment Setting ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EdgeDeviceJobs_ListByEdgeDevice (removed)
Description :  List EdgeDeviceJob resources by EdgeDevice
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.AzureStackHCI/edgeDevices/{edgeDeviceName}/jobs
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
edgeDeviceName:
{
Description: Name of Device ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The EdgeDeviceJob items on this page ,
Required: True ,
}
[
{
kind:
{
Description: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value. ,
Enum:
{
HCI: Arc-enabled edge device with HCI OS. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EdgeDeviceJobs_Get (removed)
Description :  Get a EdgeDeviceJob
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.AzureStackHCI/edgeDevices/{edgeDeviceName}/jobs/{jobsName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
edgeDeviceName:
{
Description: Name of Device ,
Required: True ,
}
string ,
jobsName:
{
Description: Name of EdgeDevice Job ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value. ,
Enum:
{
HCI: Arc-enabled edge device with HCI OS. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EdgeDeviceJobs_CreateOrUpdate (removed)
Description :  Create a EdgeDeviceJob
Reference :  Link ¶

⚼ Request

PUT:  /{resourceUri}/providers/Microsoft.AzureStackHCI/edgeDevices/{edgeDeviceName}/jobs/{jobsName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
edgeDeviceName:
{
Description: Name of Device ,
Required: True ,
}
string ,
jobsName:
{
Description: Name of EdgeDevice Job ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
kind:
{
Description: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value. ,
Enum:
{
HCI: Arc-enabled edge device with HCI OS. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
kind:
{
Description: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value. ,
Enum:
{
HCI: Arc-enabled edge device with HCI OS. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: EdgeDevice Jobs resource ,
}
{
kind:
{
Description: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value. ,
Enum:
{
HCI: Arc-enabled edge device with HCI OS. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EdgeDeviceJobs_Delete (removed)
Description :  Delete a EdgeDeviceJob
Reference :  Link ¶

⚼ Request

DELETE:  /{resourceUri}/providers/Microsoft.AzureStackHCI/edgeDevices/{edgeDeviceName}/jobs/{jobsName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
edgeDeviceName:
{
Description: Name of Device ,
Required: True ,
}
string ,
jobsName:
{
Description: Name of EdgeDevice Job ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EdgeDevices_List (removed)
Description :  List EdgeDevice resources by parent
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.AzureStackHCI/edgeDevices
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The EdgeDevice items on this page ,
Required: True ,
}
[
{
kind:
{
Description: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value. ,
Enum:
{
HCI: Arc-enabled edge device with HCI OS. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EdgeDevices_Get (removed)
Description :  Get a EdgeDevice
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.AzureStackHCI/edgeDevices/{edgeDeviceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
edgeDeviceName:
{
Description: Name of Device ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value. ,
Enum:
{
HCI: Arc-enabled edge device with HCI OS. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EdgeDevices_CreateOrUpdate (removed)
Description :  Create a EdgeDevice
Reference :  Link ¶

⚼ Request

PUT:  /{resourceUri}/providers/Microsoft.AzureStackHCI/edgeDevices/{edgeDeviceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
edgeDeviceName:
{
Description: Name of Device ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
kind:
{
Description: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value. ,
Enum:
{
HCI: Arc-enabled edge device with HCI OS. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
kind:
{
Description: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value. ,
Enum:
{
HCI: Arc-enabled edge device with HCI OS. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Edge device resource. ,
}
{
kind:
{
Description: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value. ,
Enum:
{
HCI: Arc-enabled edge device with HCI OS. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EdgeDevices_Delete (removed)
Description :  Delete a EdgeDevice
Reference :  Link ¶

⚼ Request

DELETE:  /{resourceUri}/providers/Microsoft.AzureStackHCI/edgeDevices/{edgeDeviceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
edgeDeviceName:
{
Description: Name of Device ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
EdgeDevices_Validate (removed)
Description :  A long-running resource action.
Reference :  Link ¶

⚼ Request

POST:  /{resourceUri}/providers/Microsoft.AzureStackHCI/edgeDevices/{edgeDeviceName}/validate
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
resourceUri:
{
Description: The fully qualified Azure Resource manager identifier of the resource. ,
Required: True ,
}
string ,
edgeDeviceName:
{
Description: Name of Device ,
Required: True ,
}
string ,
ValidateRequest:
{
Description: The content of the action request ,
Required: True ,
}
{
edgeDeviceIds:
{
Description: Node Ids against which, current node has to be validated. ,
Required: True ,
}
[
string ,
]
,
additionalInfo:
{
Description: Additional info required for validation. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
status:
{
Description: edge device validation status ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Extensions_ListByArcSetting (removed)
Description :  List all Extensions under ArcSetting resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}/extensions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
arcSettingName:
{
Description: The name of the proxy resource holding details of HCI ArcSetting information. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Extension items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Describes Machine Extension Properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Extension proxy resource. Indicates the current lifecycle status of the resource, such as whether it's being created, updated, deleted, or has encountered an error. ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
extensionParameters:
{
Description: Parameters specific to this extension type. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. Latest version would be used if not specified. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
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. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
string ,
protectedSettings:
{
Description: Protected settings (may contain secrets). ,
Format: password ,
Required: False ,
}
string ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. ,
Required: False ,
}
boolean ,
}
,
aggregateState:
{
Description: Aggregate state of Arc Extensions across the nodes in this HCI cluster. This reflects the overall status of the extension deployment and operation across all nodes. ,
Enum:
{
NotSpecified: The aggregate state is not specified. ,
Error: An error occurred in the aggregate state. ,
Succeeded: The operation succeeded across all nodes. ,
Canceled: The operation was canceled across the nodes. ,
Failed: The operation failed on all or most nodes. ,
Connected: All nodes are connected. ,
Disconnected: All nodes are disconnected. ,
Deleted: The extension has been deleted from all nodes. ,
Creating: The extension is being created across the nodes. ,
Updating: The extension is being updated across the nodes. ,
Deleting: The extension is being deleted across the nodes. ,
Moving: The extension is being moved across the nodes. ,
PartiallySucceeded: The operation succeeded on some nodes. ,
PartiallyConnected: Some nodes are connected, others are not. ,
InProgress: The operation is currently in progress across the nodes. ,
Accepted: The operation has been accepted and is pending execution. ,
Provisioning: The extension is currently being provisioned across the nodes. ,
UpgradeFailedRollbackSucceeded: Extension upgrade failed, but rollback succeeded across the nodes. ,
}
,
Required: False ,
}
enum ,
perNodeExtensionDetails:
{
Description: State of Arc Extension in each of the nodes. ,
Required: False ,
}
[
{
name:
{
Description: Name of the node in HCI Cluster. ,
Required: False ,
}
string ,
extension:
{
Description: Fully qualified resource ID for the particular Arc Extension on this node. ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
state:
{
Description: State of Arc Extension in this node. Reflects the current lifecycle status of the extension on the individual node, such as whether it's being created, updated, deleted, or has encountered an error. ,
Enum:
{
NotSpecified: The state is not specified. ,
Error: An error occurred during the extension lifecycle. ,
Succeeded: The extension operation completed successfully. ,
Canceled: The extension operation was canceled. ,
Failed: The extension operation failed. ,
Connected: The extension is connected on the node. ,
Disconnected: The extension is disconnected on the node. ,
Deleted: The extension has been deleted from the node. ,
Creating: The extension is being created on the node. ,
Updating: The extension is being updated on the node. ,
Deleting: The extension is being deleted from the node. ,
Moving: The extension is being moved on the node. ,
PartiallySucceeded: The extension operation partially succeeded. ,
PartiallyConnected: The extension is partially connected on the node. ,
InProgress: The extension operation is currently in progress. ,
Accepted: The extension operation has been accepted and is pending execution. ,
Provisioning: The extension is currently being provisioned on the node. ,
}
,
Required: False ,
}
enum ,
instanceView:
{
Description: The extension instance view. ,
Required: False ,
}
{
name:
{
Description: The extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "MicrosoftMonitoringAgent". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: Instance view status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. Indicates the severity or importance of the status message. ,
Enum:
{
Info: Informational message indicating normal operation. ,
Warning: Warning message indicating a potential issue or non-critical problem. ,
Error: Error message indicating a failure or critical issue. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
managedBy:
{
Description: Indicates if the extension is managed by Azure or the user. This determines who controls the deployment and lifecycle of the extension. ,
Enum:
{
User: The extension is managed by the user. ,
Azure: The extension is managed by Azure. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Extensions_Get (removed)
Description :  Get particular Arc Extension of HCI Cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}/extensions/{extensionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
arcSettingName:
{
Description: The name of the proxy resource holding details of HCI ArcSetting information. ,
Required: True ,
}
string ,
extensionName:
{
Description: The name of the machine extension. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes Machine Extension Properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Extension proxy resource. Indicates the current lifecycle status of the resource, such as whether it's being created, updated, deleted, or has encountered an error. ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
extensionParameters:
{
Description: Parameters specific to this extension type. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. Latest version would be used if not specified. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
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. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
string ,
protectedSettings:
{
Description: Protected settings (may contain secrets). ,
Format: password ,
Required: False ,
}
string ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. ,
Required: False ,
}
boolean ,
}
,
aggregateState:
{
Description: Aggregate state of Arc Extensions across the nodes in this HCI cluster. This reflects the overall status of the extension deployment and operation across all nodes. ,
Enum:
{
NotSpecified: The aggregate state is not specified. ,
Error: An error occurred in the aggregate state. ,
Succeeded: The operation succeeded across all nodes. ,
Canceled: The operation was canceled across the nodes. ,
Failed: The operation failed on all or most nodes. ,
Connected: All nodes are connected. ,
Disconnected: All nodes are disconnected. ,
Deleted: The extension has been deleted from all nodes. ,
Creating: The extension is being created across the nodes. ,
Updating: The extension is being updated across the nodes. ,
Deleting: The extension is being deleted across the nodes. ,
Moving: The extension is being moved across the nodes. ,
PartiallySucceeded: The operation succeeded on some nodes. ,
PartiallyConnected: Some nodes are connected, others are not. ,
InProgress: The operation is currently in progress across the nodes. ,
Accepted: The operation has been accepted and is pending execution. ,
Provisioning: The extension is currently being provisioned across the nodes. ,
UpgradeFailedRollbackSucceeded: Extension upgrade failed, but rollback succeeded across the nodes. ,
}
,
Required: False ,
}
enum ,
perNodeExtensionDetails:
{
Description: State of Arc Extension in each of the nodes. ,
Required: False ,
}
[
{
name:
{
Description: Name of the node in HCI Cluster. ,
Required: False ,
}
string ,
extension:
{
Description: Fully qualified resource ID for the particular Arc Extension on this node. ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
state:
{
Description: State of Arc Extension in this node. Reflects the current lifecycle status of the extension on the individual node, such as whether it's being created, updated, deleted, or has encountered an error. ,
Enum:
{
NotSpecified: The state is not specified. ,
Error: An error occurred during the extension lifecycle. ,
Succeeded: The extension operation completed successfully. ,
Canceled: The extension operation was canceled. ,
Failed: The extension operation failed. ,
Connected: The extension is connected on the node. ,
Disconnected: The extension is disconnected on the node. ,
Deleted: The extension has been deleted from the node. ,
Creating: The extension is being created on the node. ,
Updating: The extension is being updated on the node. ,
Deleting: The extension is being deleted from the node. ,
Moving: The extension is being moved on the node. ,
PartiallySucceeded: The extension operation partially succeeded. ,
PartiallyConnected: The extension is partially connected on the node. ,
InProgress: The extension operation is currently in progress. ,
Accepted: The extension operation has been accepted and is pending execution. ,
Provisioning: The extension is currently being provisioned on the node. ,
}
,
Required: False ,
}
enum ,
instanceView:
{
Description: The extension instance view. ,
Required: False ,
}
{
name:
{
Description: The extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "MicrosoftMonitoringAgent". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: Instance view status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. Indicates the severity or importance of the status message. ,
Enum:
{
Info: Informational message indicating normal operation. ,
Warning: Warning message indicating a potential issue or non-critical problem. ,
Error: Error message indicating a failure or critical issue. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
managedBy:
{
Description: Indicates if the extension is managed by Azure or the user. This determines who controls the deployment and lifecycle of the extension. ,
Enum:
{
User: The extension is managed by the user. ,
Azure: The extension is managed by Azure. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Extensions_Create (removed)
Description :  Create Extension for HCI cluster.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}/extensions/{extensionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
arcSettingName:
{
Description: The name of the proxy resource holding details of HCI ArcSetting information. ,
Required: True ,
}
string ,
extensionName:
{
Description: The name of the machine extension. ,
Required: True ,
}
string ,
extension:
{
Description: Details of the Machine Extension to be created. ,
Required: True ,
}
{
properties:
{
Description: Describes Machine Extension Properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Extension proxy resource. Indicates the current lifecycle status of the resource, such as whether it's being created, updated, deleted, or has encountered an error. ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
extensionParameters:
{
Description: Parameters specific to this extension type. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. Latest version would be used if not specified. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
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. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
string ,
protectedSettings:
{
Description: Protected settings (may contain secrets). ,
Format: password ,
Required: False ,
}
string ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. ,
Required: False ,
}
boolean ,
}
,
aggregateState:
{
Description: Aggregate state of Arc Extensions across the nodes in this HCI cluster. This reflects the overall status of the extension deployment and operation across all nodes. ,
Enum:
{
NotSpecified: The aggregate state is not specified. ,
Error: An error occurred in the aggregate state. ,
Succeeded: The operation succeeded across all nodes. ,
Canceled: The operation was canceled across the nodes. ,
Failed: The operation failed on all or most nodes. ,
Connected: All nodes are connected. ,
Disconnected: All nodes are disconnected. ,
Deleted: The extension has been deleted from all nodes. ,
Creating: The extension is being created across the nodes. ,
Updating: The extension is being updated across the nodes. ,
Deleting: The extension is being deleted across the nodes. ,
Moving: The extension is being moved across the nodes. ,
PartiallySucceeded: The operation succeeded on some nodes. ,
PartiallyConnected: Some nodes are connected, others are not. ,
InProgress: The operation is currently in progress across the nodes. ,
Accepted: The operation has been accepted and is pending execution. ,
Provisioning: The extension is currently being provisioned across the nodes. ,
UpgradeFailedRollbackSucceeded: Extension upgrade failed, but rollback succeeded across the nodes. ,
}
,
Required: False ,
}
enum ,
perNodeExtensionDetails:
{
Description: State of Arc Extension in each of the nodes. ,
Required: False ,
}
[
{
name:
{
Description: Name of the node in HCI Cluster. ,
Required: False ,
}
string ,
extension:
{
Description: Fully qualified resource ID for the particular Arc Extension on this node. ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
state:
{
Description: State of Arc Extension in this node. Reflects the current lifecycle status of the extension on the individual node, such as whether it's being created, updated, deleted, or has encountered an error. ,
Enum:
{
NotSpecified: The state is not specified. ,
Error: An error occurred during the extension lifecycle. ,
Succeeded: The extension operation completed successfully. ,
Canceled: The extension operation was canceled. ,
Failed: The extension operation failed. ,
Connected: The extension is connected on the node. ,
Disconnected: The extension is disconnected on the node. ,
Deleted: The extension has been deleted from the node. ,
Creating: The extension is being created on the node. ,
Updating: The extension is being updated on the node. ,
Deleting: The extension is being deleted from the node. ,
Moving: The extension is being moved on the node. ,
PartiallySucceeded: The extension operation partially succeeded. ,
PartiallyConnected: The extension is partially connected on the node. ,
InProgress: The extension operation is currently in progress. ,
Accepted: The extension operation has been accepted and is pending execution. ,
Provisioning: The extension is currently being provisioned on the node. ,
}
,
Required: False ,
}
enum ,
instanceView:
{
Description: The extension instance view. ,
Required: False ,
}
{
name:
{
Description: The extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "MicrosoftMonitoringAgent". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: Instance view status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. Indicates the severity or importance of the status message. ,
Enum:
{
Info: Informational message indicating normal operation. ,
Warning: Warning message indicating a potential issue or non-critical problem. ,
Error: Error message indicating a failure or critical issue. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
managedBy:
{
Description: Indicates if the extension is managed by Azure or the user. This determines who controls the deployment and lifecycle of the extension. ,
Enum:
{
User: The extension is managed by the user. ,
Azure: The extension is managed by Azure. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Describes Machine Extension Properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Extension proxy resource. Indicates the current lifecycle status of the resource, such as whether it's being created, updated, deleted, or has encountered an error. ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
extensionParameters:
{
Description: Parameters specific to this extension type. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. Latest version would be used if not specified. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
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. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
string ,
protectedSettings:
{
Description: Protected settings (may contain secrets). ,
Format: password ,
Required: False ,
}
string ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. ,
Required: False ,
}
boolean ,
}
,
aggregateState:
{
Description: Aggregate state of Arc Extensions across the nodes in this HCI cluster. This reflects the overall status of the extension deployment and operation across all nodes. ,
Enum:
{
NotSpecified: The aggregate state is not specified. ,
Error: An error occurred in the aggregate state. ,
Succeeded: The operation succeeded across all nodes. ,
Canceled: The operation was canceled across the nodes. ,
Failed: The operation failed on all or most nodes. ,
Connected: All nodes are connected. ,
Disconnected: All nodes are disconnected. ,
Deleted: The extension has been deleted from all nodes. ,
Creating: The extension is being created across the nodes. ,
Updating: The extension is being updated across the nodes. ,
Deleting: The extension is being deleted across the nodes. ,
Moving: The extension is being moved across the nodes. ,
PartiallySucceeded: The operation succeeded on some nodes. ,
PartiallyConnected: Some nodes are connected, others are not. ,
InProgress: The operation is currently in progress across the nodes. ,
Accepted: The operation has been accepted and is pending execution. ,
Provisioning: The extension is currently being provisioned across the nodes. ,
UpgradeFailedRollbackSucceeded: Extension upgrade failed, but rollback succeeded across the nodes. ,
}
,
Required: False ,
}
enum ,
perNodeExtensionDetails:
{
Description: State of Arc Extension in each of the nodes. ,
Required: False ,
}
[
{
name:
{
Description: Name of the node in HCI Cluster. ,
Required: False ,
}
string ,
extension:
{
Description: Fully qualified resource ID for the particular Arc Extension on this node. ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
state:
{
Description: State of Arc Extension in this node. Reflects the current lifecycle status of the extension on the individual node, such as whether it's being created, updated, deleted, or has encountered an error. ,
Enum:
{
NotSpecified: The state is not specified. ,
Error: An error occurred during the extension lifecycle. ,
Succeeded: The extension operation completed successfully. ,
Canceled: The extension operation was canceled. ,
Failed: The extension operation failed. ,
Connected: The extension is connected on the node. ,
Disconnected: The extension is disconnected on the node. ,
Deleted: The extension has been deleted from the node. ,
Creating: The extension is being created on the node. ,
Updating: The extension is being updated on the node. ,
Deleting: The extension is being deleted from the node. ,
Moving: The extension is being moved on the node. ,
PartiallySucceeded: The extension operation partially succeeded. ,
PartiallyConnected: The extension is partially connected on the node. ,
InProgress: The extension operation is currently in progress. ,
Accepted: The extension operation has been accepted and is pending execution. ,
Provisioning: The extension is currently being provisioned on the node. ,
}
,
Required: False ,
}
enum ,
instanceView:
{
Description: The extension instance view. ,
Required: False ,
}
{
name:
{
Description: The extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "MicrosoftMonitoringAgent". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: Instance view status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. Indicates the severity or importance of the status message. ,
Enum:
{
Info: Informational message indicating normal operation. ,
Warning: Warning message indicating a potential issue or non-critical problem. ,
Error: Error message indicating a failure or critical issue. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
managedBy:
{
Description: Indicates if the extension is managed by Azure or the user. This determines who controls the deployment and lifecycle of the extension. ,
Enum:
{
User: The extension is managed by the user. ,
Azure: The extension is managed by Azure. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Details of a particular extension in HCI Cluster. ,
}
{
properties:
{
Description: Describes Machine Extension Properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Extension proxy resource. Indicates the current lifecycle status of the resource, such as whether it's being created, updated, deleted, or has encountered an error. ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
extensionParameters:
{
Description: Parameters specific to this extension type. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. Latest version would be used if not specified. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
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. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
string ,
protectedSettings:
{
Description: Protected settings (may contain secrets). ,
Format: password ,
Required: False ,
}
string ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. ,
Required: False ,
}
boolean ,
}
,
aggregateState:
{
Description: Aggregate state of Arc Extensions across the nodes in this HCI cluster. This reflects the overall status of the extension deployment and operation across all nodes. ,
Enum:
{
NotSpecified: The aggregate state is not specified. ,
Error: An error occurred in the aggregate state. ,
Succeeded: The operation succeeded across all nodes. ,
Canceled: The operation was canceled across the nodes. ,
Failed: The operation failed on all or most nodes. ,
Connected: All nodes are connected. ,
Disconnected: All nodes are disconnected. ,
Deleted: The extension has been deleted from all nodes. ,
Creating: The extension is being created across the nodes. ,
Updating: The extension is being updated across the nodes. ,
Deleting: The extension is being deleted across the nodes. ,
Moving: The extension is being moved across the nodes. ,
PartiallySucceeded: The operation succeeded on some nodes. ,
PartiallyConnected: Some nodes are connected, others are not. ,
InProgress: The operation is currently in progress across the nodes. ,
Accepted: The operation has been accepted and is pending execution. ,
Provisioning: The extension is currently being provisioned across the nodes. ,
UpgradeFailedRollbackSucceeded: Extension upgrade failed, but rollback succeeded across the nodes. ,
}
,
Required: False ,
}
enum ,
perNodeExtensionDetails:
{
Description: State of Arc Extension in each of the nodes. ,
Required: False ,
}
[
{
name:
{
Description: Name of the node in HCI Cluster. ,
Required: False ,
}
string ,
extension:
{
Description: Fully qualified resource ID for the particular Arc Extension on this node. ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
state:
{
Description: State of Arc Extension in this node. Reflects the current lifecycle status of the extension on the individual node, such as whether it's being created, updated, deleted, or has encountered an error. ,
Enum:
{
NotSpecified: The state is not specified. ,
Error: An error occurred during the extension lifecycle. ,
Succeeded: The extension operation completed successfully. ,
Canceled: The extension operation was canceled. ,
Failed: The extension operation failed. ,
Connected: The extension is connected on the node. ,
Disconnected: The extension is disconnected on the node. ,
Deleted: The extension has been deleted from the node. ,
Creating: The extension is being created on the node. ,
Updating: The extension is being updated on the node. ,
Deleting: The extension is being deleted from the node. ,
Moving: The extension is being moved on the node. ,
PartiallySucceeded: The extension operation partially succeeded. ,
PartiallyConnected: The extension is partially connected on the node. ,
InProgress: The extension operation is currently in progress. ,
Accepted: The extension operation has been accepted and is pending execution. ,
Provisioning: The extension is currently being provisioned on the node. ,
}
,
Required: False ,
}
enum ,
instanceView:
{
Description: The extension instance view. ,
Required: False ,
}
{
name:
{
Description: The extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "MicrosoftMonitoringAgent". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: Instance view status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. Indicates the severity or importance of the status message. ,
Enum:
{
Info: Informational message indicating normal operation. ,
Warning: Warning message indicating a potential issue or non-critical problem. ,
Error: Error message indicating a failure or critical issue. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
managedBy:
{
Description: Indicates if the extension is managed by Azure or the user. This determines who controls the deployment and lifecycle of the extension. ,
Enum:
{
User: The extension is managed by the user. ,
Azure: The extension is managed by Azure. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Extensions_Update (removed)
Description :  Update Extension for HCI cluster.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}/extensions/{extensionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
arcSettingName:
{
Description: The name of the proxy resource holding details of HCI ArcSetting information. ,
Required: True ,
}
string ,
extensionName:
{
Description: The name of the machine extension. ,
Required: True ,
}
string ,
extension:
{
Description: Details of the Machine Extension to be created. ,
Required: True ,
}
{
properties:
{
Description: Describes Machine Extension Properties that can be updated. ,
Required: False ,
}
{
extensionParameters:
{
Description: Describes the properties of a Machine Extension that can be updated. ,
Required: False ,
}
{
typeHandlerVersion:
{
Description: Specifies the version of the script handler. Latest version would be used if not specified. ,
Required: False ,
}
string ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
string ,
protectedSettings:
{
Description: Protected settings (may contain secrets). ,
Format: password ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Describes Machine Extension Properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Extension proxy resource. Indicates the current lifecycle status of the resource, such as whether it's being created, updated, deleted, or has encountered an error. ,
Enum:
{
NotSpecified: The provisioning state is not specified. ,
Error: An error occurred during provisioning. ,
Succeeded: Provisioning completed successfully. ,
Failed: Provisioning failed. ,
Canceled: Provisioning was canceled. ,
Connected: The resource is connected. ,
Disconnected: The resource is disconnected. ,
Deleted: The resource has been deleted. ,
Creating: The resource is being created. ,
Updating: The resource is being updated. ,
Deleting: The resource is being deleted. ,
Moving: The resource is being moved. ,
PartiallySucceeded: Provisioning partially succeeded. ,
PartiallyConnected: The resource is partially connected. ,
InProgress: Provisioning is in progress. ,
Accepted: Provisioning request has been accepted. ,
Provisioning: The resource is currently provisioning. ,
DisableInProgress: The resource is being disabled. ,
}
,
Required: False ,
}
enum ,
extensionParameters:
{
Description: Parameters specific to this extension type. ,
Required: False ,
}
{
forceUpdateTag:
{
Description: How the extension handler should be forced to update even if the extension configuration has not changed. ,
Required: False ,
}
string ,
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "CustomScriptExtension". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. Latest version would be used if not specified. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
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. ,
Required: False ,
}
boolean ,
settings:
{
Description: Json formatted public settings for the extension. ,
Required: False ,
}
string ,
protectedSettings:
{
Description: Protected settings (may contain secrets). ,
Format: password ,
Required: False ,
}
string ,
enableAutomaticUpgrade:
{
Description: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. ,
Required: False ,
}
boolean ,
}
,
aggregateState:
{
Description: Aggregate state of Arc Extensions across the nodes in this HCI cluster. This reflects the overall status of the extension deployment and operation across all nodes. ,
Enum:
{
NotSpecified: The aggregate state is not specified. ,
Error: An error occurred in the aggregate state. ,
Succeeded: The operation succeeded across all nodes. ,
Canceled: The operation was canceled across the nodes. ,
Failed: The operation failed on all or most nodes. ,
Connected: All nodes are connected. ,
Disconnected: All nodes are disconnected. ,
Deleted: The extension has been deleted from all nodes. ,
Creating: The extension is being created across the nodes. ,
Updating: The extension is being updated across the nodes. ,
Deleting: The extension is being deleted across the nodes. ,
Moving: The extension is being moved across the nodes. ,
PartiallySucceeded: The operation succeeded on some nodes. ,
PartiallyConnected: Some nodes are connected, others are not. ,
InProgress: The operation is currently in progress across the nodes. ,
Accepted: The operation has been accepted and is pending execution. ,
Provisioning: The extension is currently being provisioned across the nodes. ,
UpgradeFailedRollbackSucceeded: Extension upgrade failed, but rollback succeeded across the nodes. ,
}
,
Required: False ,
}
enum ,
perNodeExtensionDetails:
{
Description: State of Arc Extension in each of the nodes. ,
Required: False ,
}
[
{
name:
{
Description: Name of the node in HCI Cluster. ,
Required: False ,
}
string ,
extension:
{
Description: Fully qualified resource ID for the particular Arc Extension on this node. ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
state:
{
Description: State of Arc Extension in this node. Reflects the current lifecycle status of the extension on the individual node, such as whether it's being created, updated, deleted, or has encountered an error. ,
Enum:
{
NotSpecified: The state is not specified. ,
Error: An error occurred during the extension lifecycle. ,
Succeeded: The extension operation completed successfully. ,
Canceled: The extension operation was canceled. ,
Failed: The extension operation failed. ,
Connected: The extension is connected on the node. ,
Disconnected: The extension is disconnected on the node. ,
Deleted: The extension has been deleted from the node. ,
Creating: The extension is being created on the node. ,
Updating: The extension is being updated on the node. ,
Deleting: The extension is being deleted from the node. ,
Moving: The extension is being moved on the node. ,
PartiallySucceeded: The extension operation partially succeeded. ,
PartiallyConnected: The extension is partially connected on the node. ,
InProgress: The extension operation is currently in progress. ,
Accepted: The extension operation has been accepted and is pending execution. ,
Provisioning: The extension is currently being provisioned on the node. ,
}
,
Required: False ,
}
enum ,
instanceView:
{
Description: The extension instance view. ,
Required: False ,
}
{
name:
{
Description: The extension name. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension; an example is "MicrosoftMonitoringAgent". ,
Required: False ,
}
string ,
typeHandlerVersion:
{
Description: Specifies the version of the script handler. ,
Required: False ,
}
string ,
status:
{
Description: Instance view status. ,
Required: False ,
}
{
code:
{
Description: The status code. ,
Required: False ,
}
string ,
level:
{
Description: The level code. Indicates the severity or importance of the status message. ,
Enum:
{
Info: Informational message indicating normal operation. ,
Warning: Warning message indicating a potential issue or non-critical problem. ,
Error: Error message indicating a failure or critical issue. ,
}
,
Required: False ,
}
enum ,
displayStatus:
{
Description: The short localizable label for the status. ,
Required: False ,
}
string ,
message:
{
Description: The detailed status message, including for alerts and error messages. ,
Required: False ,
}
string ,
time:
{
Description: The time of the status. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
managedBy:
{
Description: Indicates if the extension is managed by Azure or the user. This determines who controls the deployment and lifecycle of the extension. ,
Enum:
{
User: The extension is managed by the user. ,
Azure: The extension is managed by Azure. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Extensions_Delete (removed)
Description :  Delete particular Arc Extension of HCI Cluster.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}/extensions/{extensionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
arcSettingName:
{
Description: The name of the proxy resource holding details of HCI ArcSetting information. ,
Required: True ,
}
string ,
extensionName:
{
Description: The name of the machine extension. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Extensions_Upgrade (removed)
Description :  Upgrade a particular Arc Extension of HCI Cluster.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}/extensions/{extensionName}/upgrade
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
arcSettingName:
{
Description: The name of the proxy resource holding details of HCI ArcSetting information. ,
Required: True ,
}
string ,
extensionName:
{
Description: The name of the machine extension. ,
Required: True ,
}
string ,
extensionUpgradeParameters:
{
Description: Parameters supplied to the Upgrade Extensions operation. ,
Required: True ,
}
{
targetVersion:
{
Description: Extension Upgrade Target Version. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Offers_ListByPublisher (removed)
Description :  List Offers available for a publisher within the HCI Cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/publishers/{publisherName}/offers
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
publisherName:
{
Description: The name of the publisher available within HCI cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify $expand=content,contentVersion to populate additional fields related to the marketplace offer. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Offer proxy resources. ,
Required: False ,
}
[
{
properties:
{
Description: Offer properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning State ,
Required: False ,
}
string ,
publisherId:
{
Description: Identifier of the Publisher for the offer ,
Required: False ,
}
string ,
content:
{
Description: JSON serialized catalog content of the offer ,
Required: False ,
}
string ,
contentVersion:
{
Description: The API version of the catalog service used to serve the catalog content ,
Required: False ,
}
string ,
skuMappings:
{
Description: Array of SKU mappings ,
Required: False ,
}
[
{
catalogPlanId:
{
Description: Identifier of the CatalogPlan for the sku ,
Required: False ,
}
string ,
marketplaceSkuId:
{
Description: Identifier for the sku ,
Required: False ,
}
string ,
marketplaceSkuVersions:
{
Description: Array of SKU versions available ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Offers_ListByCluster (removed)
Description :  List Offers available across publishers for the HCI Cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/offers
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify $expand=content,contentVersion to populate additional fields related to the marketplace offer. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Offer proxy resources. ,
Required: False ,
}
[
{
properties:
{
Description: Offer properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning State ,
Required: False ,
}
string ,
publisherId:
{
Description: Identifier of the Publisher for the offer ,
Required: False ,
}
string ,
content:
{
Description: JSON serialized catalog content of the offer ,
Required: False ,
}
string ,
contentVersion:
{
Description: The API version of the catalog service used to serve the catalog content ,
Required: False ,
}
string ,
skuMappings:
{
Description: Array of SKU mappings ,
Required: False ,
}
[
{
catalogPlanId:
{
Description: Identifier of the CatalogPlan for the sku ,
Required: False ,
}
string ,
marketplaceSkuId:
{
Description: Identifier for the sku ,
Required: False ,
}
string ,
marketplaceSkuVersions:
{
Description: Array of SKU versions available ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Offers_Get (removed)
Description :  Get Offer resource details within a publisher of HCI Cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/publishers/{publisherName}/offers/{offerName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
publisherName:
{
Description: The name of the publisher available within HCI cluster. ,
Required: True ,
}
string ,
offerName:
{
Description: The name of the offer available within HCI cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify $expand=content,contentVersion to populate additional fields related to the marketplace offer. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Offer properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning State ,
Required: False ,
}
string ,
publisherId:
{
Description: Identifier of the Publisher for the offer ,
Required: False ,
}
string ,
content:
{
Description: JSON serialized catalog content of the offer ,
Required: False ,
}
string ,
contentVersion:
{
Description: The API version of the catalog service used to serve the catalog content ,
Required: False ,
}
string ,
skuMappings:
{
Description: Array of SKU mappings ,
Required: False ,
}
[
{
catalogPlanId:
{
Description: Identifier of the CatalogPlan for the sku ,
Required: False ,
}
string ,
marketplaceSkuId:
{
Description: Identifier for the sku ,
Required: False ,
}
string ,
marketplaceSkuVersions:
{
Description: Array of SKU versions available ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Publishers_ListByCluster (removed)
Description :  List Publishers available for the HCI Cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/publishers
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Publisher proxy resources. ,
Required: False ,
}
[
{
properties:
{
Description: Publisher properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning State ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Publishers_Get (removed)
Description :  Get Publisher resource details of HCI Cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/publishers/{publisherName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
publisherName:
{
Description: The name of the publisher available within HCI cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Publisher properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning State ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SecuritySettings_ListByClusters (removed)
Description :  List SecuritySetting resources by Clusters
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/securitySettings
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The SecuritySetting items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
securedCoreComplianceAssignment:
{
Description: Secured Core Compliance Assignment ,
Enum:
{
Audit: Report on the state of the machine, but don't make changes. ,
ApplyAndAutoCorrect: Applied to the machine. If it drifts, the local service inside the machine makes a correction at the next evaluation. ,
}
,
Required: False ,
}
enum ,
wdacComplianceAssignment:
{
Description: WDAC Compliance Assignment ,
Enum:
{
Audit: Report on the state of the machine, but don't make changes. ,
ApplyAndAutoCorrect: Applied to the machine. If it drifts, the local service inside the machine makes a correction at the next evaluation. ,
}
,
Required: False ,
}
enum ,
smbEncryptionForIntraClusterTrafficComplianceAssignment:
{
Description: SMB encryption for intra-cluster traffic Compliance Assignment ,
Enum:
{
Audit: Report on the state of the machine, but don't make changes. ,
ApplyAndAutoCorrect: Applied to the machine. If it drifts, the local service inside the machine makes a correction at the next evaluation. ,
}
,
Required: False ,
}
enum ,
securityComplianceStatus:
{
Description: Security Compliance Status ,
Required: False ,
}
{
securedCoreCompliance:
{
Description: Indicates whether HCI hosts meets secured-core server requirements. ,
Enum:
{
Compliant: The resource is compliant ,
NonCompliant: The resource is non-compliant ,
Pending: The resource compliance status is pending ,
}
,
Required: False ,
}
enum ,
wdacCompliance:
{
Description: Indicates whether HCI hosts have enforced consistent Windows Defender Application Control. ,
Enum:
{
Compliant: The resource is compliant ,
NonCompliant: The resource is non-compliant ,
Pending: The resource compliance status is pending ,
}
,
Required: False ,
}
enum ,
dataAtRestEncrypted:
{
Description: Indicates whether data at-rest encryption is enabled on Azure Stack HCI clustered volumes. ,
Enum:
{
Compliant: The resource is compliant ,
NonCompliant: The resource is non-compliant ,
Pending: The resource compliance status is pending ,
}
,
Required: False ,
}
enum ,
dataInTransitProtected:
{
Description: Indicates whether HCI cluster has data in-transit protection. ,
Enum:
{
Compliant: The resource is compliant ,
NonCompliant: The resource is non-compliant ,
Pending: The resource compliance status is pending ,
}
,
Required: False ,
}
enum ,
lastUpdated:
{
Description: Time in UTC when compliance status was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SecuritySettings_Get (removed)
Description :  Get a SecuritySetting
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/securitySettings/{securitySettingsName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
securitySettingsName:
{
Description: Name of security setting ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
securedCoreComplianceAssignment:
{
Description: Secured Core Compliance Assignment ,
Enum:
{
Audit: Report on the state of the machine, but don't make changes. ,
ApplyAndAutoCorrect: Applied to the machine. If it drifts, the local service inside the machine makes a correction at the next evaluation. ,
}
,
Required: False ,
}
enum ,
wdacComplianceAssignment:
{
Description: WDAC Compliance Assignment ,
Enum:
{
Audit: Report on the state of the machine, but don't make changes. ,
ApplyAndAutoCorrect: Applied to the machine. If it drifts, the local service inside the machine makes a correction at the next evaluation. ,
}
,
Required: False ,
}
enum ,
smbEncryptionForIntraClusterTrafficComplianceAssignment:
{
Description: SMB encryption for intra-cluster traffic Compliance Assignment ,
Enum:
{
Audit: Report on the state of the machine, but don't make changes. ,
ApplyAndAutoCorrect: Applied to the machine. If it drifts, the local service inside the machine makes a correction at the next evaluation. ,
}
,
Required: False ,
}
enum ,
securityComplianceStatus:
{
Description: Security Compliance Status ,
Required: False ,
}
{
securedCoreCompliance:
{
Description: Indicates whether HCI hosts meets secured-core server requirements. ,
Enum:
{
Compliant: The resource is compliant ,
NonCompliant: The resource is non-compliant ,
Pending: The resource compliance status is pending ,
}
,
Required: False ,
}
enum ,
wdacCompliance:
{
Description: Indicates whether HCI hosts have enforced consistent Windows Defender Application Control. ,
Enum:
{
Compliant: The resource is compliant ,
NonCompliant: The resource is non-compliant ,
Pending: The resource compliance status is pending ,
}
,
Required: False ,
}
enum ,
dataAtRestEncrypted:
{
Description: Indicates whether data at-rest encryption is enabled on Azure Stack HCI clustered volumes. ,
Enum:
{
Compliant: The resource is compliant ,
NonCompliant: The resource is non-compliant ,
Pending: The resource compliance status is pending ,
}
,
Required: False ,
}
enum ,
dataInTransitProtected:
{
Description: Indicates whether HCI cluster has data in-transit protection. ,
Enum:
{
Compliant: The resource is compliant ,
NonCompliant: The resource is non-compliant ,
Pending: The resource compliance status is pending ,
}
,
Required: False ,
}
enum ,
lastUpdated:
{
Description: Time in UTC when compliance status was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SecuritySettings_CreateOrUpdate (removed)
Description :  Create a security setting
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/securitySettings/{securitySettingsName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
securitySettingsName:
{
Description: Name of security setting ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
securedCoreComplianceAssignment:
{
Description: Secured Core Compliance Assignment ,
Enum:
{
Audit: Report on the state of the machine, but don't make changes. ,
ApplyAndAutoCorrect: Applied to the machine. If it drifts, the local service inside the machine makes a correction at the next evaluation. ,
}
,
Required: False ,
}
enum ,
wdacComplianceAssignment:
{
Description: WDAC Compliance Assignment ,
Enum:
{
Audit: Report on the state of the machine, but don't make changes. ,
ApplyAndAutoCorrect: Applied to the machine. If it drifts, the local service inside the machine makes a correction at the next evaluation. ,
}
,
Required: False ,
}
enum ,
smbEncryptionForIntraClusterTrafficComplianceAssignment:
{
Description: SMB encryption for intra-cluster traffic Compliance Assignment ,
Enum:
{
Audit: Report on the state of the machine, but don't make changes. ,
ApplyAndAutoCorrect: Applied to the machine. If it drifts, the local service inside the machine makes a correction at the next evaluation. ,
}
,
Required: False ,
}
enum ,
securityComplianceStatus:
{
Description: Security Compliance Status ,
Required: False ,
}
{
securedCoreCompliance:
{
Description: Indicates whether HCI hosts meets secured-core server requirements. ,
Enum:
{
Compliant: The resource is compliant ,
NonCompliant: The resource is non-compliant ,
Pending: The resource compliance status is pending ,
}
,
Required: False ,
}
enum ,
wdacCompliance:
{
Description: Indicates whether HCI hosts have enforced consistent Windows Defender Application Control. ,
Enum:
{
Compliant: The resource is compliant ,
NonCompliant: The resource is non-compliant ,
Pending: The resource compliance status is pending ,
}
,
Required: False ,
}
enum ,
dataAtRestEncrypted:
{
Description: Indicates whether data at-rest encryption is enabled on Azure Stack HCI clustered volumes. ,
Enum:
{
Compliant: The resource is compliant ,
NonCompliant: The resource is non-compliant ,
Pending: The resource compliance status is pending ,
}
,
Required: False ,
}
enum ,
dataInTransitProtected:
{
Description: Indicates whether HCI cluster has data in-transit protection. ,
Enum:
{
Compliant: The resource is compliant ,
NonCompliant: The resource is non-compliant ,
Pending: The resource compliance status is pending ,
}
,
Required: False ,
}
enum ,
lastUpdated:
{
Description: Time in UTC when compliance status was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
securedCoreComplianceAssignment:
{
Description: Secured Core Compliance Assignment ,
Enum:
{
Audit: Report on the state of the machine, but don't make changes. ,
ApplyAndAutoCorrect: Applied to the machine. If it drifts, the local service inside the machine makes a correction at the next evaluation. ,
}
,
Required: False ,
}
enum ,
wdacComplianceAssignment:
{
Description: WDAC Compliance Assignment ,
Enum:
{
Audit: Report on the state of the machine, but don't make changes. ,
ApplyAndAutoCorrect: Applied to the machine. If it drifts, the local service inside the machine makes a correction at the next evaluation. ,
}
,
Required: False ,
}
enum ,
smbEncryptionForIntraClusterTrafficComplianceAssignment:
{
Description: SMB encryption for intra-cluster traffic Compliance Assignment ,
Enum:
{
Audit: Report on the state of the machine, but don't make changes. ,
ApplyAndAutoCorrect: Applied to the machine. If it drifts, the local service inside the machine makes a correction at the next evaluation. ,
}
,
Required: False ,
}
enum ,
securityComplianceStatus:
{
Description: Security Compliance Status ,
Required: False ,
}
{
securedCoreCompliance:
{
Description: Indicates whether HCI hosts meets secured-core server requirements. ,
Enum:
{
Compliant: The resource is compliant ,
NonCompliant: The resource is non-compliant ,
Pending: The resource compliance status is pending ,
}
,
Required: False ,
}
enum ,
wdacCompliance:
{
Description: Indicates whether HCI hosts have enforced consistent Windows Defender Application Control. ,
Enum:
{
Compliant: The resource is compliant ,
NonCompliant: The resource is non-compliant ,
Pending: The resource compliance status is pending ,
}
,
Required: False ,
}
enum ,
dataAtRestEncrypted:
{
Description: Indicates whether data at-rest encryption is enabled on Azure Stack HCI clustered volumes. ,
Enum:
{
Compliant: The resource is compliant ,
NonCompliant: The resource is non-compliant ,
Pending: The resource compliance status is pending ,
}
,
Required: False ,
}
enum ,
dataInTransitProtected:
{
Description: Indicates whether HCI cluster has data in-transit protection. ,
Enum:
{
Compliant: The resource is compliant ,
NonCompliant: The resource is non-compliant ,
Pending: The resource compliance status is pending ,
}
,
Required: False ,
}
enum ,
lastUpdated:
{
Description: Time in UTC when compliance status was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Security settings proxy resource ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
securedCoreComplianceAssignment:
{
Description: Secured Core Compliance Assignment ,
Enum:
{
Audit: Report on the state of the machine, but don't make changes. ,
ApplyAndAutoCorrect: Applied to the machine. If it drifts, the local service inside the machine makes a correction at the next evaluation. ,
}
,
Required: False ,
}
enum ,
wdacComplianceAssignment:
{
Description: WDAC Compliance Assignment ,
Enum:
{
Audit: Report on the state of the machine, but don't make changes. ,
ApplyAndAutoCorrect: Applied to the machine. If it drifts, the local service inside the machine makes a correction at the next evaluation. ,
}
,
Required: False ,
}
enum ,
smbEncryptionForIntraClusterTrafficComplianceAssignment:
{
Description: SMB encryption for intra-cluster traffic Compliance Assignment ,
Enum:
{
Audit: Report on the state of the machine, but don't make changes. ,
ApplyAndAutoCorrect: Applied to the machine. If it drifts, the local service inside the machine makes a correction at the next evaluation. ,
}
,
Required: False ,
}
enum ,
securityComplianceStatus:
{
Description: Security Compliance Status ,
Required: False ,
}
{
securedCoreCompliance:
{
Description: Indicates whether HCI hosts meets secured-core server requirements. ,
Enum:
{
Compliant: The resource is compliant ,
NonCompliant: The resource is non-compliant ,
Pending: The resource compliance status is pending ,
}
,
Required: False ,
}
enum ,
wdacCompliance:
{
Description: Indicates whether HCI hosts have enforced consistent Windows Defender Application Control. ,
Enum:
{
Compliant: The resource is compliant ,
NonCompliant: The resource is non-compliant ,
Pending: The resource compliance status is pending ,
}
,
Required: False ,
}
enum ,
dataAtRestEncrypted:
{
Description: Indicates whether data at-rest encryption is enabled on Azure Stack HCI clustered volumes. ,
Enum:
{
Compliant: The resource is compliant ,
NonCompliant: The resource is non-compliant ,
Pending: The resource compliance status is pending ,
}
,
Required: False ,
}
enum ,
dataInTransitProtected:
{
Description: Indicates whether HCI cluster has data in-transit protection. ,
Enum:
{
Compliant: The resource is compliant ,
NonCompliant: The resource is non-compliant ,
Pending: The resource compliance status is pending ,
}
,
Required: False ,
}
enum ,
lastUpdated:
{
Description: Time in UTC when compliance status was last updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The resource is being provisioned ,
Updating: The resource is updating ,
Deleting: The resource is being deleted ,
Accepted: The resource create request has been accepted ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SecuritySettings_Delete (removed)
Description :  Delete a SecuritySetting
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/securitySettings/{securitySettingsName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
securitySettingsName:
{
Description: Name of security setting ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Skus_ListByOffer (removed)
Description :  List Skus available for a offer within the HCI Cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/publishers/{publisherName}/offers/{offerName}/skus
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
publisherName:
{
Description: The name of the publisher available within HCI cluster. ,
Required: True ,
}
string ,
offerName:
{
Description: The name of the offer available within HCI cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify $expand=content,contentVersion to populate additional fields related to the marketplace offer. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of SKU proxy resources. ,
Required: False ,
}
[
{
properties:
{
Description: SKU properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning State ,
Required: False ,
}
string ,
publisherId:
{
Description: Identifier of the Publisher for the offer ,
Required: False ,
}
string ,
offerId:
{
Description: Identifier of the Offer for the sku ,
Required: False ,
}
string ,
content:
{
Description: JSON serialized catalog content of the sku offer ,
Required: False ,
}
string ,
contentVersion:
{
Description: The API version of the catalog service used to serve the catalog content ,
Required: False ,
}
string ,
skuMappings:
{
Description: Array of SKU mappings ,
Required: False ,
}
[
{
catalogPlanId:
{
Description: Identifier of the CatalogPlan for the sku ,
Required: False ,
}
string ,
marketplaceSkuId:
{
Description: Identifier for the sku ,
Required: False ,
}
string ,
marketplaceSkuVersions:
{
Description: Array of SKU versions available ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Skus_Get (removed)
Description :  Get SKU resource details within a offer of HCI Cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/publishers/{publisherName}/offers/{offerName}/skus/{skuName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
publisherName:
{
Description: The name of the publisher available within HCI cluster. ,
Required: True ,
}
string ,
offerName:
{
Description: The name of the offer available within HCI cluster. ,
Required: True ,
}
string ,
skuName:
{
Description: The name of the SKU available within HCI cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
$expand:
{
Description: Specify $expand=content,contentVersion to populate additional fields related to the marketplace offer. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: SKU properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning State ,
Required: False ,
}
string ,
publisherId:
{
Description: Identifier of the Publisher for the offer ,
Required: False ,
}
string ,
offerId:
{
Description: Identifier of the Offer for the sku ,
Required: False ,
}
string ,
content:
{
Description: JSON serialized catalog content of the sku offer ,
Required: False ,
}
string ,
contentVersion:
{
Description: The API version of the catalog service used to serve the catalog content ,
Required: False ,
}
string ,
skuMappings:
{
Description: Array of SKU mappings ,
Required: False ,
}
[
{
catalogPlanId:
{
Description: Identifier of the CatalogPlan for the sku ,
Required: False ,
}
string ,
marketplaceSkuId:
{
Description: Identifier for the sku ,
Required: False ,
}
string ,
marketplaceSkuVersions:
{
Description: Array of SKU versions available ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
UpdateRuns_List (removed)
Description :  List all Update runs for a specified update
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/updates/{updateName}/updateRuns
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
updateName:
{
Description: The name of the Update ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Update runs ,
Required: False ,
}
[
{
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
properties:
{
Description: Describes Update Run Properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the UpdateRuns proxy resource. Indicates the current lifecycle status of the update operation, such as whether it has been accepted, is in progress, or has completed. ,
Enum:
{
Succeeded: The update operation completed successfully. ,
Failed: The update operation failed. ,
Canceled: The update operation was canceled before completion. ,
Accepted: The update operation has been accepted and is pending execution. ,
Provisioning: The update operation is currently being provisioned. ,
}
,
Required: False ,
}
enum ,
timeStarted:
{
Description: Timestamp of the update run was started. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTime:
{
Description: Timestamp of the most recently completed step in the update run. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: Duration of the update run. ,
Required: False ,
}
string ,
state:
{
Description: Represents the current state of the update run. Indicates whether the update is in progress, has completed successfully, failed, or is in an unknown state. ,
Enum:
{
Unknown: The state of the update run is not known. ,
Succeeded: The update run completed successfully. ,
InProgress: The update run is currently in progress. ,
Failed: The update run failed to complete successfully. ,
}
,
Required: False ,
}
enum ,
progress:
{
Description: Progress representation of the update run steps. ,
Required: False ,
}
{
name:
{
Description: Name of the step. ,
Required: False ,
}
string ,
description:
{
Description: More detailed description of the step. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message, specified if the step is in a failed state. ,
Required: False ,
}
string ,
status:
{
Description: Status of the step, bubbled up from the ECE action plan for installation attempts. Values are: 'Success', 'Error', 'InProgress', and 'Unknown status'. ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: When the step started, or empty if it has not started executing. ,
Format: date-time ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: When the step reached a terminal state. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTimeUtc:
{
Description: Completion time of this step or the last completed sub-step. ,
Format: date-time ,
Required: False ,
}
string ,
expectedExecutionTime:
{
Description: Expected execution time of a given step. This is optionally authored in the update action plan and can be empty. ,
Required: False ,
}
string ,
steps:
{
Description: Recursive model for child steps of this step. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
UpdateRuns_Delete (removed)
Description :  Delete specified Update Run
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/updates/{updateName}/updateRuns/{updateRunName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
updateName:
{
Description: The name of the Update ,
Required: True ,
}
string ,
updateRunName:
{
Description: The name of the Update Run ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URL to query for status of the operation. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
UpdateRuns_Put (removed)
Description :  Put Update runs for a specified update
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/updates/{updateName}/updateRuns/{updateRunName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
updateName:
{
Description: The name of the Update ,
Required: True ,
}
string ,
updateRunName:
{
Description: The name of the Update Run ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
updateRunsProperties:
{
Description: Properties of the updateRuns object ,
Required: True ,
}
{
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
properties:
{
Description: Describes Update Run Properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the UpdateRuns proxy resource. Indicates the current lifecycle status of the update operation, such as whether it has been accepted, is in progress, or has completed. ,
Enum:
{
Succeeded: The update operation completed successfully. ,
Failed: The update operation failed. ,
Canceled: The update operation was canceled before completion. ,
Accepted: The update operation has been accepted and is pending execution. ,
Provisioning: The update operation is currently being provisioned. ,
}
,
Required: False ,
}
enum ,
timeStarted:
{
Description: Timestamp of the update run was started. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTime:
{
Description: Timestamp of the most recently completed step in the update run. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: Duration of the update run. ,
Required: False ,
}
string ,
state:
{
Description: Represents the current state of the update run. Indicates whether the update is in progress, has completed successfully, failed, or is in an unknown state. ,
Enum:
{
Unknown: The state of the update run is not known. ,
Succeeded: The update run completed successfully. ,
InProgress: The update run is currently in progress. ,
Failed: The update run failed to complete successfully. ,
}
,
Required: False ,
}
enum ,
progress:
{
Description: Progress representation of the update run steps. ,
Required: False ,
}
{
name:
{
Description: Name of the step. ,
Required: False ,
}
string ,
description:
{
Description: More detailed description of the step. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message, specified if the step is in a failed state. ,
Required: False ,
}
string ,
status:
{
Description: Status of the step, bubbled up from the ECE action plan for installation attempts. Values are: 'Success', 'Error', 'InProgress', and 'Unknown status'. ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: When the step started, or empty if it has not started executing. ,
Format: date-time ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: When the step reached a terminal state. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTimeUtc:
{
Description: Completion time of this step or the last completed sub-step. ,
Format: date-time ,
Required: False ,
}
string ,
expectedExecutionTime:
{
Description: Expected execution time of a given step. This is optionally authored in the update action plan and can be empty. ,
Required: False ,
}
string ,
steps:
{
Description: Recursive model for child steps of this step. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
}

⚐ Response (200)

{
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
properties:
{
Description: Describes Update Run Properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the UpdateRuns proxy resource. Indicates the current lifecycle status of the update operation, such as whether it has been accepted, is in progress, or has completed. ,
Enum:
{
Succeeded: The update operation completed successfully. ,
Failed: The update operation failed. ,
Canceled: The update operation was canceled before completion. ,
Accepted: The update operation has been accepted and is pending execution. ,
Provisioning: The update operation is currently being provisioned. ,
}
,
Required: False ,
}
enum ,
timeStarted:
{
Description: Timestamp of the update run was started. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTime:
{
Description: Timestamp of the most recently completed step in the update run. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: Duration of the update run. ,
Required: False ,
}
string ,
state:
{
Description: Represents the current state of the update run. Indicates whether the update is in progress, has completed successfully, failed, or is in an unknown state. ,
Enum:
{
Unknown: The state of the update run is not known. ,
Succeeded: The update run completed successfully. ,
InProgress: The update run is currently in progress. ,
Failed: The update run failed to complete successfully. ,
}
,
Required: False ,
}
enum ,
progress:
{
Description: Progress representation of the update run steps. ,
Required: False ,
}
{
name:
{
Description: Name of the step. ,
Required: False ,
}
string ,
description:
{
Description: More detailed description of the step. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message, specified if the step is in a failed state. ,
Required: False ,
}
string ,
status:
{
Description: Status of the step, bubbled up from the ECE action plan for installation attempts. Values are: 'Success', 'Error', 'InProgress', and 'Unknown status'. ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: When the step started, or empty if it has not started executing. ,
Format: date-time ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: When the step reached a terminal state. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTimeUtc:
{
Description: Completion time of this step or the last completed sub-step. ,
Format: date-time ,
Required: False ,
}
string ,
expectedExecutionTime:
{
Description: Expected execution time of a given step. This is optionally authored in the update action plan and can be empty. ,
Required: False ,
}
string ,
steps:
{
Description: Recursive model for child steps of this step. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
UpdateRuns_Get (removed)
Description :  Get the Update run for a specified update
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/updates/{updateName}/updateRuns/{updateRunName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
updateName:
{
Description: The name of the Update ,
Required: True ,
}
string ,
updateRunName:
{
Description: The name of the Update Run ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
properties:
{
Description: Describes Update Run Properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the UpdateRuns proxy resource. Indicates the current lifecycle status of the update operation, such as whether it has been accepted, is in progress, or has completed. ,
Enum:
{
Succeeded: The update operation completed successfully. ,
Failed: The update operation failed. ,
Canceled: The update operation was canceled before completion. ,
Accepted: The update operation has been accepted and is pending execution. ,
Provisioning: The update operation is currently being provisioned. ,
}
,
Required: False ,
}
enum ,
timeStarted:
{
Description: Timestamp of the update run was started. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTime:
{
Description: Timestamp of the most recently completed step in the update run. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: Duration of the update run. ,
Required: False ,
}
string ,
state:
{
Description: Represents the current state of the update run. Indicates whether the update is in progress, has completed successfully, failed, or is in an unknown state. ,
Enum:
{
Unknown: The state of the update run is not known. ,
Succeeded: The update run completed successfully. ,
InProgress: The update run is currently in progress. ,
Failed: The update run failed to complete successfully. ,
}
,
Required: False ,
}
enum ,
progress:
{
Description: Progress representation of the update run steps. ,
Required: False ,
}
{
name:
{
Description: Name of the step. ,
Required: False ,
}
string ,
description:
{
Description: More detailed description of the step. ,
Required: False ,
}
string ,
errorMessage:
{
Description: Error message, specified if the step is in a failed state. ,
Required: False ,
}
string ,
status:
{
Description: Status of the step, bubbled up from the ECE action plan for installation attempts. Values are: 'Success', 'Error', 'InProgress', and 'Unknown status'. ,
Required: False ,
}
string ,
startTimeUtc:
{
Description: When the step started, or empty if it has not started executing. ,
Format: date-time ,
Required: False ,
}
string ,
endTimeUtc:
{
Description: When the step reached a terminal state. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedTimeUtc:
{
Description: Completion time of this step or the last completed sub-step. ,
Format: date-time ,
Required: False ,
}
string ,
expectedExecutionTime:
{
Description: Expected execution time of a given step. This is optionally authored in the update action plan and can be empty. ,
Required: False ,
}
string ,
steps:
{
Description: Recursive model for child steps of this step. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
UpdateSummaries_List (removed)
Description :  List all Update summaries under the HCI cluster
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/updateSummaries
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Update Summaries ,
Required: False ,
}
[
{
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
properties:
{
Description: Update summaries properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the UpdateSummaries proxy resource. Indicates the current lifecycle status of the update summary operation, such as whether it has been accepted, is in progress, or has completed. ,
Enum:
{
Succeeded: The update summary operation completed successfully. ,
Failed: The update summary operation failed. ,
Canceled: The update summary operation was canceled before completion. ,
Accepted: The update summary operation has been accepted and is pending execution. ,
Provisioning: The update summary operation is currently being provisioned. ,
}
,
Required: False ,
}
enum ,
oemFamily:
{
Description: OEM family name. ,
Required: False ,
}
string ,
currentOemVersion:
{
Description: Current OEM Version. ,
Required: False ,
}
string ,
hardwareModel:
{
Description: Name of the hardware model. ,
Required: False ,
}
string ,
packageVersions:
{
Description: Current version of each updatable component. ,
Required: False ,
}
[
{
packageType:
{
Description: Package type ,
Required: False ,
}
string ,
version:
{
Description: Package version ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Last time this component was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
currentVersion:
{
Description: Current Solution Bundle version of the stamp. ,
Required: False ,
}
string ,
currentSbeVersion:
{
Description: Current Sbe version of the stamp. ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Last time an update installation completed successfully. ,
Format: date-time ,
Required: False ,
}
string ,
lastChecked:
{
Description: Last time the update service successfully checked for updates ,
Format: date-time ,
Required: False ,
}
string ,
healthState:
{
Description: Overall health state for update-specific health checks. ,
Required: False ,
}
object ,
healthCheckResult:
{
Description: An array of pre-check result objects. ,
Required: False ,
}
[
{
name:
{
Description: Name of the individual test/rule/alert that was executed. Unique, not exposed to the customer. ,
Required: False ,
}
string ,
displayName:
{
Description: The health check DisplayName localized of the individual test executed. ,
Required: False ,
}
string ,
tags:
{
Description: Key-value pairs that allow grouping/filtering individual tests. ,
Required: False ,
}
{
key:
{
Description: Key that allow grouping/filtering individual tests. ,
Required: False ,
}
string ,
value:
{
Description: Value of the key that allow grouping/filtering individual tests. ,
Required: False ,
}
string ,
}
,
healthCheckTags:
{
Description: Key-value pairs that allow grouping/filtering individual tests. ,
Required: False ,
}
object ,
title:
{
Description: User-facing name; one or more sentences indicating the direct issue. ,
Required: False ,
}
string ,
status:
{
Description: Represents the current status of the check being performed. Indicates whether the check has completed successfully, failed, or is still in progress. ,
Enum:
{
Succeeded: The check completed successfully. ,
Failed: The check completed but failed. ,
InProgress: The check is currently in progress. ,
}
,
Required: False ,
}
enum ,
severity:
{
Description: Indicates the importance or impact level of the result. Determines whether the result is informational, a warning, or a critical issue that may block updates. ,
Enum:
{
Critical: A critical issue that blocks updates and requires immediate attention. ,
Warning: A warning that may indicate a potential issue but does not block updates. ,
Informational: General information that does not indicate any issue. ,
Hidden: The result is hidden and not shown in the output. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Detailed overview of the issue and what impact the issue has on the stamp. ,
Required: False ,
}
string ,
remediation:
{
Description: Set of steps that can be taken to resolve the issue found. ,
Required: False ,
}
string ,
targetResourceID:
{
Description: The unique identifier for the affected resource (such as a node or drive). ,
Required: False ,
}
string ,
targetResourceName:
{
Description: The name of the affected resource. ,
Required: False ,
}
string ,
targetResourceType:
{
Description: The type of resource being referred to (well-known set of nouns in infrastructure, aligning with Monitoring). ,
Required: False ,
}
string ,
timestamp:
{
Description: The time in which the HealthCheck was called. ,
Format: date-time ,
Required: False ,
}
string ,
additionalData:
{
Description: Property bag of key value pairs for additional information. ,
Required: False ,
}
string ,
healthCheckSource:
{
Description: The name of the services called for the HealthCheck (I.E. Test-AzureStack, Test-Cluster). ,
Required: False ,
}
string ,
}
,
]
,
healthCheckDate:
{
Description: Last time the package-specific checks were run. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: Overall update state of the stamp. Indicates the current status of update deployment across the stamp, including preparation, application, and any issues encountered. ,
Enum:
{
Unknown: The update state is not known. ,
AppliedSuccessfully: Updates have been successfully applied to the stamp. ,
UpdateAvailable: Updates are available but have not yet been applied. ,
UpdateInProgress: Updates are currently being applied to the stamp. ,
UpdateFailed: The update process failed. ,
NeedsAttention: The update process requires user intervention or has encountered issues needing attention. ,
PreparationInProgress: Preparation for the update is currently in progress. ,
PreparationFailed: Preparation for the update failed. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
UpdateSummaries_Delete (removed)
Description :  Delete Update Summaries
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/updateSummaries/default
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URL to query for status of the operation. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
UpdateSummaries_Put (removed)
Description :  Put Update summaries under the HCI cluster
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/updateSummaries/default
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
updateLocationProperties:
{
Description: Properties of the UpdateSummaries resource ,
Required: True ,
}
{
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
properties:
{
Description: Update summaries properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the UpdateSummaries proxy resource. Indicates the current lifecycle status of the update summary operation, such as whether it has been accepted, is in progress, or has completed. ,
Enum:
{
Succeeded: The update summary operation completed successfully. ,
Failed: The update summary operation failed. ,
Canceled: The update summary operation was canceled before completion. ,
Accepted: The update summary operation has been accepted and is pending execution. ,
Provisioning: The update summary operation is currently being provisioned. ,
}
,
Required: False ,
}
enum ,
oemFamily:
{
Description: OEM family name. ,
Required: False ,
}
string ,
currentOemVersion:
{
Description: Current OEM Version. ,
Required: False ,
}
string ,
hardwareModel:
{
Description: Name of the hardware model. ,
Required: False ,
}
string ,
packageVersions:
{
Description: Current version of each updatable component. ,
Required: False ,
}
[
{
packageType:
{
Description: Package type ,
Required: False ,
}
string ,
version:
{
Description: Package version ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Last time this component was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
currentVersion:
{
Description: Current Solution Bundle version of the stamp. ,
Required: False ,
}
string ,
currentSbeVersion:
{
Description: Current Sbe version of the stamp. ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Last time an update installation completed successfully. ,
Format: date-time ,
Required: False ,
}
string ,
lastChecked:
{
Description: Last time the update service successfully checked for updates ,
Format: date-time ,
Required: False ,
}
string ,
healthState:
{
Description: Overall health state for update-specific health checks. ,
Required: False ,
}
object ,
healthCheckResult:
{
Description: An array of pre-check result objects. ,
Required: False ,
}
[
{
name:
{
Description: Name of the individual test/rule/alert that was executed. Unique, not exposed to the customer. ,
Required: False ,
}
string ,
displayName:
{
Description: The health check DisplayName localized of the individual test executed. ,
Required: False ,
}
string ,
tags:
{
Description: Key-value pairs that allow grouping/filtering individual tests. ,
Required: False ,
}
{
key:
{
Description: Key that allow grouping/filtering individual tests. ,
Required: False ,
}
string ,
value:
{
Description: Value of the key that allow grouping/filtering individual tests. ,
Required: False ,
}
string ,
}
,
healthCheckTags:
{
Description: Key-value pairs that allow grouping/filtering individual tests. ,
Required: False ,
}
object ,
title:
{
Description: User-facing name; one or more sentences indicating the direct issue. ,
Required: False ,
}
string ,
status:
{
Description: Represents the current status of the check being performed. Indicates whether the check has completed successfully, failed, or is still in progress. ,
Enum:
{
Succeeded: The check completed successfully. ,
Failed: The check completed but failed. ,
InProgress: The check is currently in progress. ,
}
,
Required: False ,
}
enum ,
severity:
{
Description: Indicates the importance or impact level of the result. Determines whether the result is informational, a warning, or a critical issue that may block updates. ,
Enum:
{
Critical: A critical issue that blocks updates and requires immediate attention. ,
Warning: A warning that may indicate a potential issue but does not block updates. ,
Informational: General information that does not indicate any issue. ,
Hidden: The result is hidden and not shown in the output. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Detailed overview of the issue and what impact the issue has on the stamp. ,
Required: False ,
}
string ,
remediation:
{
Description: Set of steps that can be taken to resolve the issue found. ,
Required: False ,
}
string ,
targetResourceID:
{
Description: The unique identifier for the affected resource (such as a node or drive). ,
Required: False ,
}
string ,
targetResourceName:
{
Description: The name of the affected resource. ,
Required: False ,
}
string ,
targetResourceType:
{
Description: The type of resource being referred to (well-known set of nouns in infrastructure, aligning with Monitoring). ,
Required: False ,
}
string ,
timestamp:
{
Description: The time in which the HealthCheck was called. ,
Format: date-time ,
Required: False ,
}
string ,
additionalData:
{
Description: Property bag of key value pairs for additional information. ,
Required: False ,
}
string ,
healthCheckSource:
{
Description: The name of the services called for the HealthCheck (I.E. Test-AzureStack, Test-Cluster). ,
Required: False ,
}
string ,
}
,
]
,
healthCheckDate:
{
Description: Last time the package-specific checks were run. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: Overall update state of the stamp. Indicates the current status of update deployment across the stamp, including preparation, application, and any issues encountered. ,
Enum:
{
Unknown: The update state is not known. ,
AppliedSuccessfully: Updates have been successfully applied to the stamp. ,
UpdateAvailable: Updates are available but have not yet been applied. ,
UpdateInProgress: Updates are currently being applied to the stamp. ,
UpdateFailed: The update process failed. ,
NeedsAttention: The update process requires user intervention or has encountered issues needing attention. ,
PreparationInProgress: Preparation for the update is currently in progress. ,
PreparationFailed: Preparation for the update failed. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
properties:
{
Description: Update summaries properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the UpdateSummaries proxy resource. Indicates the current lifecycle status of the update summary operation, such as whether it has been accepted, is in progress, or has completed. ,
Enum:
{
Succeeded: The update summary operation completed successfully. ,
Failed: The update summary operation failed. ,
Canceled: The update summary operation was canceled before completion. ,
Accepted: The update summary operation has been accepted and is pending execution. ,
Provisioning: The update summary operation is currently being provisioned. ,
}
,
Required: False ,
}
enum ,
oemFamily:
{
Description: OEM family name. ,
Required: False ,
}
string ,
currentOemVersion:
{
Description: Current OEM Version. ,
Required: False ,
}
string ,
hardwareModel:
{
Description: Name of the hardware model. ,
Required: False ,
}
string ,
packageVersions:
{
Description: Current version of each updatable component. ,
Required: False ,
}
[
{
packageType:
{
Description: Package type ,
Required: False ,
}
string ,
version:
{
Description: Package version ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Last time this component was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
currentVersion:
{
Description: Current Solution Bundle version of the stamp. ,
Required: False ,
}
string ,
currentSbeVersion:
{
Description: Current Sbe version of the stamp. ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Last time an update installation completed successfully. ,
Format: date-time ,
Required: False ,
}
string ,
lastChecked:
{
Description: Last time the update service successfully checked for updates ,
Format: date-time ,
Required: False ,
}
string ,
healthState:
{
Description: Overall health state for update-specific health checks. ,
Required: False ,
}
object ,
healthCheckResult:
{
Description: An array of pre-check result objects. ,
Required: False ,
}
[
{
name:
{
Description: Name of the individual test/rule/alert that was executed. Unique, not exposed to the customer. ,
Required: False ,
}
string ,
displayName:
{
Description: The health check DisplayName localized of the individual test executed. ,
Required: False ,
}
string ,
tags:
{
Description: Key-value pairs that allow grouping/filtering individual tests. ,
Required: False ,
}
{
key:
{
Description: Key that allow grouping/filtering individual tests. ,
Required: False ,
}
string ,
value:
{
Description: Value of the key that allow grouping/filtering individual tests. ,
Required: False ,
}
string ,
}
,
healthCheckTags:
{
Description: Key-value pairs that allow grouping/filtering individual tests. ,
Required: False ,
}
object ,
title:
{
Description: User-facing name; one or more sentences indicating the direct issue. ,
Required: False ,
}
string ,
status:
{
Description: Represents the current status of the check being performed. Indicates whether the check has completed successfully, failed, or is still in progress. ,
Enum:
{
Succeeded: The check completed successfully. ,
Failed: The check completed but failed. ,
InProgress: The check is currently in progress. ,
}
,
Required: False ,
}
enum ,
severity:
{
Description: Indicates the importance or impact level of the result. Determines whether the result is informational, a warning, or a critical issue that may block updates. ,
Enum:
{
Critical: A critical issue that blocks updates and requires immediate attention. ,
Warning: A warning that may indicate a potential issue but does not block updates. ,
Informational: General information that does not indicate any issue. ,
Hidden: The result is hidden and not shown in the output. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Detailed overview of the issue and what impact the issue has on the stamp. ,
Required: False ,
}
string ,
remediation:
{
Description: Set of steps that can be taken to resolve the issue found. ,
Required: False ,
}
string ,
targetResourceID:
{
Description: The unique identifier for the affected resource (such as a node or drive). ,
Required: False ,
}
string ,
targetResourceName:
{
Description: The name of the affected resource. ,
Required: False ,
}
string ,
targetResourceType:
{
Description: The type of resource being referred to (well-known set of nouns in infrastructure, aligning with Monitoring). ,
Required: False ,
}
string ,
timestamp:
{
Description: The time in which the HealthCheck was called. ,
Format: date-time ,
Required: False ,
}
string ,
additionalData:
{
Description: Property bag of key value pairs for additional information. ,
Required: False ,
}
string ,
healthCheckSource:
{
Description: The name of the services called for the HealthCheck (I.E. Test-AzureStack, Test-Cluster). ,
Required: False ,
}
string ,
}
,
]
,
healthCheckDate:
{
Description: Last time the package-specific checks were run. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: Overall update state of the stamp. Indicates the current status of update deployment across the stamp, including preparation, application, and any issues encountered. ,
Enum:
{
Unknown: The update state is not known. ,
AppliedSuccessfully: Updates have been successfully applied to the stamp. ,
UpdateAvailable: Updates are available but have not yet been applied. ,
UpdateInProgress: Updates are currently being applied to the stamp. ,
UpdateFailed: The update process failed. ,
NeedsAttention: The update process requires user intervention or has encountered issues needing attention. ,
PreparationInProgress: Preparation for the update is currently in progress. ,
PreparationFailed: Preparation for the update failed. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
UpdateSummaries_Get (removed)
Description :  Get all Update summaries under the HCI cluster
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/updateSummaries/default
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
properties:
{
Description: Update summaries properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the UpdateSummaries proxy resource. Indicates the current lifecycle status of the update summary operation, such as whether it has been accepted, is in progress, or has completed. ,
Enum:
{
Succeeded: The update summary operation completed successfully. ,
Failed: The update summary operation failed. ,
Canceled: The update summary operation was canceled before completion. ,
Accepted: The update summary operation has been accepted and is pending execution. ,
Provisioning: The update summary operation is currently being provisioned. ,
}
,
Required: False ,
}
enum ,
oemFamily:
{
Description: OEM family name. ,
Required: False ,
}
string ,
currentOemVersion:
{
Description: Current OEM Version. ,
Required: False ,
}
string ,
hardwareModel:
{
Description: Name of the hardware model. ,
Required: False ,
}
string ,
packageVersions:
{
Description: Current version of each updatable component. ,
Required: False ,
}
[
{
packageType:
{
Description: Package type ,
Required: False ,
}
string ,
version:
{
Description: Package version ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Last time this component was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
currentVersion:
{
Description: Current Solution Bundle version of the stamp. ,
Required: False ,
}
string ,
currentSbeVersion:
{
Description: Current Sbe version of the stamp. ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Last time an update installation completed successfully. ,
Format: date-time ,
Required: False ,
}
string ,
lastChecked:
{
Description: Last time the update service successfully checked for updates ,
Format: date-time ,
Required: False ,
}
string ,
healthState:
{
Description: Overall health state for update-specific health checks. ,
Required: False ,
}
object ,
healthCheckResult:
{
Description: An array of pre-check result objects. ,
Required: False ,
}
[
{
name:
{
Description: Name of the individual test/rule/alert that was executed. Unique, not exposed to the customer. ,
Required: False ,
}
string ,
displayName:
{
Description: The health check DisplayName localized of the individual test executed. ,
Required: False ,
}
string ,
tags:
{
Description: Key-value pairs that allow grouping/filtering individual tests. ,
Required: False ,
}
{
key:
{
Description: Key that allow grouping/filtering individual tests. ,
Required: False ,
}
string ,
value:
{
Description: Value of the key that allow grouping/filtering individual tests. ,
Required: False ,
}
string ,
}
,
healthCheckTags:
{
Description: Key-value pairs that allow grouping/filtering individual tests. ,
Required: False ,
}
object ,
title:
{
Description: User-facing name; one or more sentences indicating the direct issue. ,
Required: False ,
}
string ,
status:
{
Description: Represents the current status of the check being performed. Indicates whether the check has completed successfully, failed, or is still in progress. ,
Enum:
{
Succeeded: The check completed successfully. ,
Failed: The check completed but failed. ,
InProgress: The check is currently in progress. ,
}
,
Required: False ,
}
enum ,
severity:
{
Description: Indicates the importance or impact level of the result. Determines whether the result is informational, a warning, or a critical issue that may block updates. ,
Enum:
{
Critical: A critical issue that blocks updates and requires immediate attention. ,
Warning: A warning that may indicate a potential issue but does not block updates. ,
Informational: General information that does not indicate any issue. ,
Hidden: The result is hidden and not shown in the output. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Detailed overview of the issue and what impact the issue has on the stamp. ,
Required: False ,
}
string ,
remediation:
{
Description: Set of steps that can be taken to resolve the issue found. ,
Required: False ,
}
string ,
targetResourceID:
{
Description: The unique identifier for the affected resource (such as a node or drive). ,
Required: False ,
}
string ,
targetResourceName:
{
Description: The name of the affected resource. ,
Required: False ,
}
string ,
targetResourceType:
{
Description: The type of resource being referred to (well-known set of nouns in infrastructure, aligning with Monitoring). ,
Required: False ,
}
string ,
timestamp:
{
Description: The time in which the HealthCheck was called. ,
Format: date-time ,
Required: False ,
}
string ,
additionalData:
{
Description: Property bag of key value pairs for additional information. ,
Required: False ,
}
string ,
healthCheckSource:
{
Description: The name of the services called for the HealthCheck (I.E. Test-AzureStack, Test-Cluster). ,
Required: False ,
}
string ,
}
,
]
,
healthCheckDate:
{
Description: Last time the package-specific checks were run. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: Overall update state of the stamp. Indicates the current status of update deployment across the stamp, including preparation, application, and any issues encountered. ,
Enum:
{
Unknown: The update state is not known. ,
AppliedSuccessfully: Updates have been successfully applied to the stamp. ,
UpdateAvailable: Updates are available but have not yet been applied. ,
UpdateInProgress: Updates are currently being applied to the stamp. ,
UpdateFailed: The update process failed. ,
NeedsAttention: The update process requires user intervention or has encountered issues needing attention. ,
PreparationInProgress: Preparation for the update is currently in progress. ,
PreparationFailed: Preparation for the update failed. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Updates_Post (removed)
Description :  Apply Update
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/updates/{updateName}/apply
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
updateName:
{
Description: The name of the Update ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URL to query for status of the operation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Updates_List (removed)
Description :  List all Updates
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/updates
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Updates ,
Required: False ,
}
[
{
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
properties:
{
Description: Update properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Updates proxy resource. Indicates the current lifecycle status of the update operation, such as whether it has been accepted, is in progress, or has completed. ,
Enum:
{
Succeeded: The update operation completed successfully. ,
Failed: The update operation failed. ,
Canceled: The update operation was canceled before completion. ,
Accepted: The update operation has been accepted and is pending execution. ,
Provisioning: The update operation is currently being provisioned. ,
}
,
Required: False ,
}
enum ,
installedDate:
{
Description: Date that the update was installed. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Description of the update. ,
Required: False ,
}
string ,
minSbeVersionRequired:
{
Description: Minimum Sbe Version of the update. ,
Required: False ,
}
string ,
state:
{
Description: Represents the current state of the update as it relates to this stamp. This includes phases such as preparation, installation, scanning, and error handling, providing insight into the update's progress and any issues encountered. ,
Enum:
{
HasPrerequisite: The update has prerequisites that must be fulfilled before it can proceed. ,
Obsolete: The update is obsolete and no longer applicable. ,
Ready: The update is ready to be installed. ,
NotApplicableBecauseAnotherUpdateIsInProgress: The update cannot be applied because another update is currently in progress. ,
Preparing: The update is currently in the preparation phase. ,
Installing: The update is currently being installed. ,
Installed: The update has been successfully installed. ,
PreparationFailed: The update preparation phase failed. ,
InstallationFailed: The update installation failed. ,
Invalid: The update is invalid and cannot be applied. ,
Recalled: The update has been recalled and should not be applied. ,
Downloading: The update is currently being downloaded. ,
DownloadFailed: The update download failed. ,
HealthChecking: A health check is being performed before applying the update. ,
HealthCheckFailed: The health check failed, preventing the update from proceeding. ,
ReadyToInstall: The update is ready to be installed after successful preparation and checks. ,
ScanInProgress: The system is scanning for updates. ,
ScanFailed: The scan for updates failed. ,
AdditionalContentRequired: Additional content is required to proceed with the update. ,
}
,
Required: False ,
}
enum ,
prerequisites:
{
Description: If update State is HasPrerequisite, this property contains an array of objects describing prerequisite updates before installing this update. Otherwise, it is empty. ,
Required: False ,
}
[
{
updateType:
{
Description: Updatable component type. ,
Required: False ,
}
string ,
version:
{
Description: Version of the prerequisite. ,
Required: False ,
}
string ,
packageName:
{
Description: Friendly name of the prerequisite. ,
Required: False ,
}
string ,
}
,
]
,
componentVersions:
{
Description: An array of component versions for a Solution Bundle update, and an empty array otherwise. ,
Required: False ,
}
[
{
packageType:
{
Description: Package type ,
Required: False ,
}
string ,
version:
{
Description: Package version ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Last time this component was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
rebootRequired:
{
Description: Indicates whether a reboot is required after the update or operation. Helps determine if a system restart is necessary to complete the process. ,
Required: False ,
}
object ,
healthState:
{
Description: Overall health state for update-specific health checks. ,
Required: False ,
}
object ,
healthCheckResult:
{
Description: An array of PrecheckResult objects. ,
Required: False ,
}
[
{
name:
{
Description: Name of the individual test/rule/alert that was executed. Unique, not exposed to the customer. ,
Required: False ,
}
string ,
displayName:
{
Description: The health check DisplayName localized of the individual test executed. ,
Required: False ,
}
string ,
tags:
{
Description: Key-value pairs that allow grouping/filtering individual tests. ,
Required: False ,
}
{
key:
{
Description: Key that allow grouping/filtering individual tests. ,
Required: False ,
}
string ,
value:
{
Description: Value of the key that allow grouping/filtering individual tests. ,
Required: False ,
}
string ,
}
,
healthCheckTags:
{
Description: Key-value pairs that allow grouping/filtering individual tests. ,
Required: False ,
}
object ,
title:
{
Description: User-facing name; one or more sentences indicating the direct issue. ,
Required: False ,
}
string ,
status:
{
Description: Represents the current status of the check being performed. Indicates whether the check has completed successfully, failed, or is still in progress. ,
Enum:
{
Succeeded: The check completed successfully. ,
Failed: The check completed but failed. ,
InProgress: The check is currently in progress. ,
}
,
Required: False ,
}
enum ,
severity:
{
Description: Indicates the importance or impact level of the result. Determines whether the result is informational, a warning, or a critical issue that may block updates. ,
Enum:
{
Critical: A critical issue that blocks updates and requires immediate attention. ,
Warning: A warning that may indicate a potential issue but does not block updates. ,
Informational: General information that does not indicate any issue. ,
Hidden: The result is hidden and not shown in the output. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Detailed overview of the issue and what impact the issue has on the stamp. ,
Required: False ,
}
string ,
remediation:
{
Description: Set of steps that can be taken to resolve the issue found. ,
Required: False ,
}
string ,
targetResourceID:
{
Description: The unique identifier for the affected resource (such as a node or drive). ,
Required: False ,
}
string ,
targetResourceName:
{
Description: The name of the affected resource. ,
Required: False ,
}
string ,
targetResourceType:
{
Description: The type of resource being referred to (well-known set of nouns in infrastructure, aligning with Monitoring). ,
Required: False ,
}
string ,
timestamp:
{
Description: The time in which the HealthCheck was called. ,
Format: date-time ,
Required: False ,
}
string ,
additionalData:
{
Description: Property bag of key value pairs for additional information. ,
Required: False ,
}
string ,
healthCheckSource:
{
Description: The name of the services called for the HealthCheck (I.E. Test-AzureStack, Test-Cluster). ,
Required: False ,
}
string ,
}
,
]
,
healthCheckDate:
{
Description: Last time the package-specific checks were run. ,
Format: date-time ,
Required: False ,
}
string ,
packagePath:
{
Description: Path where the update package is available. ,
Required: False ,
}
string ,
packageSizeInMb:
{
Description: Size of the package. This value is a combination of the size from update metadata and size of the payload that results from the live scan operation for OS update content. ,
Required: False ,
}
number ,
displayName:
{
Description: Display name of the Update ,
Required: False ,
}
string ,
version:
{
Description: Version of the update. ,
Required: False ,
}
string ,
publisher:
{
Description: Publisher of the update package. ,
Required: False ,
}
string ,
releaseLink:
{
Description: Link to release notes for the update. ,
Required: False ,
}
string ,
availabilityType:
{
Description: Indicates how the update content is made available for download. This determines whether the update is sourced locally, from an online repository, or requires user notification. ,
Enum:
{
Local: The update content is available locally within the environment. ,
Online: The update content is available from an online source. ,
Notify: The system will notify the user when update content becomes available. ,
}
,
Required: False ,
}
enum ,
packageType:
{
Description: Customer-visible type of the update. ,
Required: False ,
}
string ,
additionalProperties:
{
Description: Extensible KV pairs serialized as a string. This is currently used to report the stamp OEM family and hardware model information when an update is flagged as Invalid for the stamp based on OEM type. ,
Required: False ,
}
string ,
updateStateProperties:
{
Description: Additional information regarding the state of the update. See definition of UpdateStateProperties type below for more details on this property. ,
Required: False ,
}
{
progressPercentage:
{
Description: Progress percentage of ongoing operation. Currently this property is only valid when the update is in the Downloading state, where it maps to how much of the update content has been downloaded. ,
Required: False ,
}
number ,
notifyMessage:
{
Description: Brief message with instructions for updates of AvailabilityType Notify. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Updates_Delete (removed)
Description :  Delete specified Update
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/updates/{updateName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
updateName:
{
Description: The name of the Update ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: URL to query for status of the operation. ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Updates_Put (removed)
Description :  Put specified Update
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/updates/{updateName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
updateName:
{
Description: The name of the Update ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
updateProperties:
{
Description: Properties of the Updates object ,
Required: True ,
}
{
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
properties:
{
Description: Update properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Updates proxy resource. Indicates the current lifecycle status of the update operation, such as whether it has been accepted, is in progress, or has completed. ,
Enum:
{
Succeeded: The update operation completed successfully. ,
Failed: The update operation failed. ,
Canceled: The update operation was canceled before completion. ,
Accepted: The update operation has been accepted and is pending execution. ,
Provisioning: The update operation is currently being provisioned. ,
}
,
Required: False ,
}
enum ,
installedDate:
{
Description: Date that the update was installed. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Description of the update. ,
Required: False ,
}
string ,
minSbeVersionRequired:
{
Description: Minimum Sbe Version of the update. ,
Required: False ,
}
string ,
state:
{
Description: Represents the current state of the update as it relates to this stamp. This includes phases such as preparation, installation, scanning, and error handling, providing insight into the update's progress and any issues encountered. ,
Enum:
{
HasPrerequisite: The update has prerequisites that must be fulfilled before it can proceed. ,
Obsolete: The update is obsolete and no longer applicable. ,
Ready: The update is ready to be installed. ,
NotApplicableBecauseAnotherUpdateIsInProgress: The update cannot be applied because another update is currently in progress. ,
Preparing: The update is currently in the preparation phase. ,
Installing: The update is currently being installed. ,
Installed: The update has been successfully installed. ,
PreparationFailed: The update preparation phase failed. ,
InstallationFailed: The update installation failed. ,
Invalid: The update is invalid and cannot be applied. ,
Recalled: The update has been recalled and should not be applied. ,
Downloading: The update is currently being downloaded. ,
DownloadFailed: The update download failed. ,
HealthChecking: A health check is being performed before applying the update. ,
HealthCheckFailed: The health check failed, preventing the update from proceeding. ,
ReadyToInstall: The update is ready to be installed after successful preparation and checks. ,
ScanInProgress: The system is scanning for updates. ,
ScanFailed: The scan for updates failed. ,
AdditionalContentRequired: Additional content is required to proceed with the update. ,
}
,
Required: False ,
}
enum ,
prerequisites:
{
Description: If update State is HasPrerequisite, this property contains an array of objects describing prerequisite updates before installing this update. Otherwise, it is empty. ,
Required: False ,
}
[
{
updateType:
{
Description: Updatable component type. ,
Required: False ,
}
string ,
version:
{
Description: Version of the prerequisite. ,
Required: False ,
}
string ,
packageName:
{
Description: Friendly name of the prerequisite. ,
Required: False ,
}
string ,
}
,
]
,
componentVersions:
{
Description: An array of component versions for a Solution Bundle update, and an empty array otherwise. ,
Required: False ,
}
[
{
packageType:
{
Description: Package type ,
Required: False ,
}
string ,
version:
{
Description: Package version ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Last time this component was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
rebootRequired:
{
Description: Indicates whether a reboot is required after the update or operation. Helps determine if a system restart is necessary to complete the process. ,
Required: False ,
}
object ,
healthState:
{
Description: Overall health state for update-specific health checks. ,
Required: False ,
}
object ,
healthCheckResult:
{
Description: An array of PrecheckResult objects. ,
Required: False ,
}
[
{
name:
{
Description: Name of the individual test/rule/alert that was executed. Unique, not exposed to the customer. ,
Required: False ,
}
string ,
displayName:
{
Description: The health check DisplayName localized of the individual test executed. ,
Required: False ,
}
string ,
tags:
{
Description: Key-value pairs that allow grouping/filtering individual tests. ,
Required: False ,
}
{
key:
{
Description: Key that allow grouping/filtering individual tests. ,
Required: False ,
}
string ,
value:
{
Description: Value of the key that allow grouping/filtering individual tests. ,
Required: False ,
}
string ,
}
,
healthCheckTags:
{
Description: Key-value pairs that allow grouping/filtering individual tests. ,
Required: False ,
}
object ,
title:
{
Description: User-facing name; one or more sentences indicating the direct issue. ,
Required: False ,
}
string ,
status:
{
Description: Represents the current status of the check being performed. Indicates whether the check has completed successfully, failed, or is still in progress. ,
Enum:
{
Succeeded: The check completed successfully. ,
Failed: The check completed but failed. ,
InProgress: The check is currently in progress. ,
}
,
Required: False ,
}
enum ,
severity:
{
Description: Indicates the importance or impact level of the result. Determines whether the result is informational, a warning, or a critical issue that may block updates. ,
Enum:
{
Critical: A critical issue that blocks updates and requires immediate attention. ,
Warning: A warning that may indicate a potential issue but does not block updates. ,
Informational: General information that does not indicate any issue. ,
Hidden: The result is hidden and not shown in the output. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Detailed overview of the issue and what impact the issue has on the stamp. ,
Required: False ,
}
string ,
remediation:
{
Description: Set of steps that can be taken to resolve the issue found. ,
Required: False ,
}
string ,
targetResourceID:
{
Description: The unique identifier for the affected resource (such as a node or drive). ,
Required: False ,
}
string ,
targetResourceName:
{
Description: The name of the affected resource. ,
Required: False ,
}
string ,
targetResourceType:
{
Description: The type of resource being referred to (well-known set of nouns in infrastructure, aligning with Monitoring). ,
Required: False ,
}
string ,
timestamp:
{
Description: The time in which the HealthCheck was called. ,
Format: date-time ,
Required: False ,
}
string ,
additionalData:
{
Description: Property bag of key value pairs for additional information. ,
Required: False ,
}
string ,
healthCheckSource:
{
Description: The name of the services called for the HealthCheck (I.E. Test-AzureStack, Test-Cluster). ,
Required: False ,
}
string ,
}
,
]
,
healthCheckDate:
{
Description: Last time the package-specific checks were run. ,
Format: date-time ,
Required: False ,
}
string ,
packagePath:
{
Description: Path where the update package is available. ,
Required: False ,
}
string ,
packageSizeInMb:
{
Description: Size of the package. This value is a combination of the size from update metadata and size of the payload that results from the live scan operation for OS update content. ,
Required: False ,
}
number ,
displayName:
{
Description: Display name of the Update ,
Required: False ,
}
string ,
version:
{
Description: Version of the update. ,
Required: False ,
}
string ,
publisher:
{
Description: Publisher of the update package. ,
Required: False ,
}
string ,
releaseLink:
{
Description: Link to release notes for the update. ,
Required: False ,
}
string ,
availabilityType:
{
Description: Indicates how the update content is made available for download. This determines whether the update is sourced locally, from an online repository, or requires user notification. ,
Enum:
{
Local: The update content is available locally within the environment. ,
Online: The update content is available from an online source. ,
Notify: The system will notify the user when update content becomes available. ,
}
,
Required: False ,
}
enum ,
packageType:
{
Description: Customer-visible type of the update. ,
Required: False ,
}
string ,
additionalProperties:
{
Description: Extensible KV pairs serialized as a string. This is currently used to report the stamp OEM family and hardware model information when an update is flagged as Invalid for the stamp based on OEM type. ,
Required: False ,
}
string ,
updateStateProperties:
{
Description: Additional information regarding the state of the update. See definition of UpdateStateProperties type below for more details on this property. ,
Required: False ,
}
{
progressPercentage:
{
Description: Progress percentage of ongoing operation. Currently this property is only valid when the update is in the Downloading state, where it maps to how much of the update content has been downloaded. ,
Required: False ,
}
number ,
notifyMessage:
{
Description: Brief message with instructions for updates of AvailabilityType Notify. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
properties:
{
Description: Update properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Updates proxy resource. Indicates the current lifecycle status of the update operation, such as whether it has been accepted, is in progress, or has completed. ,
Enum:
{
Succeeded: The update operation completed successfully. ,
Failed: The update operation failed. ,
Canceled: The update operation was canceled before completion. ,
Accepted: The update operation has been accepted and is pending execution. ,
Provisioning: The update operation is currently being provisioned. ,
}
,
Required: False ,
}
enum ,
installedDate:
{
Description: Date that the update was installed. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Description of the update. ,
Required: False ,
}
string ,
minSbeVersionRequired:
{
Description: Minimum Sbe Version of the update. ,
Required: False ,
}
string ,
state:
{
Description: Represents the current state of the update as it relates to this stamp. This includes phases such as preparation, installation, scanning, and error handling, providing insight into the update's progress and any issues encountered. ,
Enum:
{
HasPrerequisite: The update has prerequisites that must be fulfilled before it can proceed. ,
Obsolete: The update is obsolete and no longer applicable. ,
Ready: The update is ready to be installed. ,
NotApplicableBecauseAnotherUpdateIsInProgress: The update cannot be applied because another update is currently in progress. ,
Preparing: The update is currently in the preparation phase. ,
Installing: The update is currently being installed. ,
Installed: The update has been successfully installed. ,
PreparationFailed: The update preparation phase failed. ,
InstallationFailed: The update installation failed. ,
Invalid: The update is invalid and cannot be applied. ,
Recalled: The update has been recalled and should not be applied. ,
Downloading: The update is currently being downloaded. ,
DownloadFailed: The update download failed. ,
HealthChecking: A health check is being performed before applying the update. ,
HealthCheckFailed: The health check failed, preventing the update from proceeding. ,
ReadyToInstall: The update is ready to be installed after successful preparation and checks. ,
ScanInProgress: The system is scanning for updates. ,
ScanFailed: The scan for updates failed. ,
AdditionalContentRequired: Additional content is required to proceed with the update. ,
}
,
Required: False ,
}
enum ,
prerequisites:
{
Description: If update State is HasPrerequisite, this property contains an array of objects describing prerequisite updates before installing this update. Otherwise, it is empty. ,
Required: False ,
}
[
{
updateType:
{
Description: Updatable component type. ,
Required: False ,
}
string ,
version:
{
Description: Version of the prerequisite. ,
Required: False ,
}
string ,
packageName:
{
Description: Friendly name of the prerequisite. ,
Required: False ,
}
string ,
}
,
]
,
componentVersions:
{
Description: An array of component versions for a Solution Bundle update, and an empty array otherwise. ,
Required: False ,
}
[
{
packageType:
{
Description: Package type ,
Required: False ,
}
string ,
version:
{
Description: Package version ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Last time this component was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
rebootRequired:
{
Description: Indicates whether a reboot is required after the update or operation. Helps determine if a system restart is necessary to complete the process. ,
Required: False ,
}
object ,
healthState:
{
Description: Overall health state for update-specific health checks. ,
Required: False ,
}
object ,
healthCheckResult:
{
Description: An array of PrecheckResult objects. ,
Required: False ,
}
[
{
name:
{
Description: Name of the individual test/rule/alert that was executed. Unique, not exposed to the customer. ,
Required: False ,
}
string ,
displayName:
{
Description: The health check DisplayName localized of the individual test executed. ,
Required: False ,
}
string ,
tags:
{
Description: Key-value pairs that allow grouping/filtering individual tests. ,
Required: False ,
}
{
key:
{
Description: Key that allow grouping/filtering individual tests. ,
Required: False ,
}
string ,
value:
{
Description: Value of the key that allow grouping/filtering individual tests. ,
Required: False ,
}
string ,
}
,
healthCheckTags:
{
Description: Key-value pairs that allow grouping/filtering individual tests. ,
Required: False ,
}
object ,
title:
{
Description: User-facing name; one or more sentences indicating the direct issue. ,
Required: False ,
}
string ,
status:
{
Description: Represents the current status of the check being performed. Indicates whether the check has completed successfully, failed, or is still in progress. ,
Enum:
{
Succeeded: The check completed successfully. ,
Failed: The check completed but failed. ,
InProgress: The check is currently in progress. ,
}
,
Required: False ,
}
enum ,
severity:
{
Description: Indicates the importance or impact level of the result. Determines whether the result is informational, a warning, or a critical issue that may block updates. ,
Enum:
{
Critical: A critical issue that blocks updates and requires immediate attention. ,
Warning: A warning that may indicate a potential issue but does not block updates. ,
Informational: General information that does not indicate any issue. ,
Hidden: The result is hidden and not shown in the output. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Detailed overview of the issue and what impact the issue has on the stamp. ,
Required: False ,
}
string ,
remediation:
{
Description: Set of steps that can be taken to resolve the issue found. ,
Required: False ,
}
string ,
targetResourceID:
{
Description: The unique identifier for the affected resource (such as a node or drive). ,
Required: False ,
}
string ,
targetResourceName:
{
Description: The name of the affected resource. ,
Required: False ,
}
string ,
targetResourceType:
{
Description: The type of resource being referred to (well-known set of nouns in infrastructure, aligning with Monitoring). ,
Required: False ,
}
string ,
timestamp:
{
Description: The time in which the HealthCheck was called. ,
Format: date-time ,
Required: False ,
}
string ,
additionalData:
{
Description: Property bag of key value pairs for additional information. ,
Required: False ,
}
string ,
healthCheckSource:
{
Description: The name of the services called for the HealthCheck (I.E. Test-AzureStack, Test-Cluster). ,
Required: False ,
}
string ,
}
,
]
,
healthCheckDate:
{
Description: Last time the package-specific checks were run. ,
Format: date-time ,
Required: False ,
}
string ,
packagePath:
{
Description: Path where the update package is available. ,
Required: False ,
}
string ,
packageSizeInMb:
{
Description: Size of the package. This value is a combination of the size from update metadata and size of the payload that results from the live scan operation for OS update content. ,
Required: False ,
}
number ,
displayName:
{
Description: Display name of the Update ,
Required: False ,
}
string ,
version:
{
Description: Version of the update. ,
Required: False ,
}
string ,
publisher:
{
Description: Publisher of the update package. ,
Required: False ,
}
string ,
releaseLink:
{
Description: Link to release notes for the update. ,
Required: False ,
}
string ,
availabilityType:
{
Description: Indicates how the update content is made available for download. This determines whether the update is sourced locally, from an online repository, or requires user notification. ,
Enum:
{
Local: The update content is available locally within the environment. ,
Online: The update content is available from an online source. ,
Notify: The system will notify the user when update content becomes available. ,
}
,
Required: False ,
}
enum ,
packageType:
{
Description: Customer-visible type of the update. ,
Required: False ,
}
string ,
additionalProperties:
{
Description: Extensible KV pairs serialized as a string. This is currently used to report the stamp OEM family and hardware model information when an update is flagged as Invalid for the stamp based on OEM type. ,
Required: False ,
}
string ,
updateStateProperties:
{
Description: Additional information regarding the state of the update. See definition of UpdateStateProperties type below for more details on this property. ,
Required: False ,
}
{
progressPercentage:
{
Description: Progress percentage of ongoing operation. Currently this property is only valid when the update is in the Downloading state, where it maps to how much of the update content has been downloaded. ,
Required: False ,
}
number ,
notifyMessage:
{
Description: Brief message with instructions for updates of AvailabilityType Notify. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Updates_Get (removed)
Description :  Get specified Update
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/updates/{updateName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
clusterName:
{
Description: The name of the cluster. ,
Required: True ,
}
string ,
updateName:
{
Description: The name of the Update ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
properties:
{
Description: Update properties ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Updates proxy resource. Indicates the current lifecycle status of the update operation, such as whether it has been accepted, is in progress, or has completed. ,
Enum:
{
Succeeded: The update operation completed successfully. ,
Failed: The update operation failed. ,
Canceled: The update operation was canceled before completion. ,
Accepted: The update operation has been accepted and is pending execution. ,
Provisioning: The update operation is currently being provisioned. ,
}
,
Required: False ,
}
enum ,
installedDate:
{
Description: Date that the update was installed. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: Description of the update. ,
Required: False ,
}
string ,
minSbeVersionRequired:
{
Description: Minimum Sbe Version of the update. ,
Required: False ,
}
string ,
state:
{
Description: Represents the current state of the update as it relates to this stamp. This includes phases such as preparation, installation, scanning, and error handling, providing insight into the update's progress and any issues encountered. ,
Enum:
{
HasPrerequisite: The update has prerequisites that must be fulfilled before it can proceed. ,
Obsolete: The update is obsolete and no longer applicable. ,
Ready: The update is ready to be installed. ,
NotApplicableBecauseAnotherUpdateIsInProgress: The update cannot be applied because another update is currently in progress. ,
Preparing: The update is currently in the preparation phase. ,
Installing: The update is currently being installed. ,
Installed: The update has been successfully installed. ,
PreparationFailed: The update preparation phase failed. ,
InstallationFailed: The update installation failed. ,
Invalid: The update is invalid and cannot be applied. ,
Recalled: The update has been recalled and should not be applied. ,
Downloading: The update is currently being downloaded. ,
DownloadFailed: The update download failed. ,
HealthChecking: A health check is being performed before applying the update. ,
HealthCheckFailed: The health check failed, preventing the update from proceeding. ,
ReadyToInstall: The update is ready to be installed after successful preparation and checks. ,
ScanInProgress: The system is scanning for updates. ,
ScanFailed: The scan for updates failed. ,
AdditionalContentRequired: Additional content is required to proceed with the update. ,
}
,
Required: False ,
}
enum ,
prerequisites:
{
Description: If update State is HasPrerequisite, this property contains an array of objects describing prerequisite updates before installing this update. Otherwise, it is empty. ,
Required: False ,
}
[
{
updateType:
{
Description: Updatable component type. ,
Required: False ,
}
string ,
version:
{
Description: Version of the prerequisite. ,
Required: False ,
}
string ,
packageName:
{
Description: Friendly name of the prerequisite. ,
Required: False ,
}
string ,
}
,
]
,
componentVersions:
{
Description: An array of component versions for a Solution Bundle update, and an empty array otherwise. ,
Required: False ,
}
[
{
packageType:
{
Description: Package type ,
Required: False ,
}
string ,
version:
{
Description: Package version ,
Required: False ,
}
string ,
lastUpdated:
{
Description: Last time this component was updated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
rebootRequired:
{
Description: Indicates whether a reboot is required after the update or operation. Helps determine if a system restart is necessary to complete the process. ,
Required: False ,
}
object ,
healthState:
{
Description: Overall health state for update-specific health checks. ,
Required: False ,
}
object ,
healthCheckResult:
{
Description: An array of PrecheckResult objects. ,
Required: False ,
}
[
{
name:
{
Description: Name of the individual test/rule/alert that was executed. Unique, not exposed to the customer. ,
Required: False ,
}
string ,
displayName:
{
Description: The health check DisplayName localized of the individual test executed. ,
Required: False ,
}
string ,
tags:
{
Description: Key-value pairs that allow grouping/filtering individual tests. ,
Required: False ,
}
{
key:
{
Description: Key that allow grouping/filtering individual tests. ,
Required: False ,
}
string ,
value:
{
Description: Value of the key that allow grouping/filtering individual tests. ,
Required: False ,
}
string ,
}
,
healthCheckTags:
{
Description: Key-value pairs that allow grouping/filtering individual tests. ,
Required: False ,
}
object ,
title:
{
Description: User-facing name; one or more sentences indicating the direct issue. ,
Required: False ,
}
string ,
status:
{
Description: Represents the current status of the check being performed. Indicates whether the check has completed successfully, failed, or is still in progress. ,
Enum:
{
Succeeded: The check completed successfully. ,
Failed: The check completed but failed. ,
InProgress: The check is currently in progress. ,
}
,
Required: False ,
}
enum ,
severity:
{
Description: Indicates the importance or impact level of the result. Determines whether the result is informational, a warning, or a critical issue that may block updates. ,
Enum:
{
Critical: A critical issue that blocks updates and requires immediate attention. ,
Warning: A warning that may indicate a potential issue but does not block updates. ,
Informational: General information that does not indicate any issue. ,
Hidden: The result is hidden and not shown in the output. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Detailed overview of the issue and what impact the issue has on the stamp. ,
Required: False ,
}
string ,
remediation:
{
Description: Set of steps that can be taken to resolve the issue found. ,
Required: False ,
}
string ,
targetResourceID:
{
Description: The unique identifier for the affected resource (such as a node or drive). ,
Required: False ,
}
string ,
targetResourceName:
{
Description: The name of the affected resource. ,
Required: False ,
}
string ,
targetResourceType:
{
Description: The type of resource being referred to (well-known set of nouns in infrastructure, aligning with Monitoring). ,
Required: False ,
}
string ,
timestamp:
{
Description: The time in which the HealthCheck was called. ,
Format: date-time ,
Required: False ,
}
string ,
additionalData:
{
Description: Property bag of key value pairs for additional information. ,
Required: False ,
}
string ,
healthCheckSource:
{
Description: The name of the services called for the HealthCheck (I.E. Test-AzureStack, Test-Cluster). ,
Required: False ,
}
string ,
}
,
]
,
healthCheckDate:
{
Description: Last time the package-specific checks were run. ,
Format: date-time ,
Required: False ,
}
string ,
packagePath:
{
Description: Path where the update package is available. ,
Required: False ,
}
string ,
packageSizeInMb:
{
Description: Size of the package. This value is a combination of the size from update metadata and size of the payload that results from the live scan operation for OS update content. ,
Required: False ,
}
number ,
displayName:
{
Description: Display name of the Update ,
Required: False ,
}
string ,
version:
{
Description: Version of the update. ,
Required: False ,
}
string ,
publisher:
{
Description: Publisher of the update package. ,
Required: False ,
}
string ,
releaseLink:
{
Description: Link to release notes for the update. ,
Required: False ,
}
string ,
availabilityType:
{
Description: Indicates how the update content is made available for download. This determines whether the update is sourced locally, from an online repository, or requires user notification. ,
Enum:
{
Local: The update content is available locally within the environment. ,
Online: The update content is available from an online source. ,
Notify: The system will notify the user when update content becomes available. ,
}
,
Required: False ,
}
enum ,
packageType:
{
Description: Customer-visible type of the update. ,
Required: False ,
}
string ,
additionalProperties:
{
Description: Extensible KV pairs serialized as a string. This is currently used to report the stamp OEM family and hardware model information when an update is flagged as Invalid for the stamp based on OEM type. ,
Required: False ,
}
string ,
updateStateProperties:
{
Description: Additional information regarding the state of the update. See definition of UpdateStateProperties type below for more details on this property. ,
Required: False ,
}
{
progressPercentage:
{
Description: Progress percentage of ongoing operation. Currently this property is only valid when the update is in the Downloading state, where it maps to how much of the update content has been downloaded. ,
Required: False ,
}
number ,
notifyMessage:
{
Description: Brief message with instructions for updates of AvailabilityType Notify. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ValidatedSolutionRecipes_ListBySubscriptionLocationResource (removed)
Description :  List all validated solution recipes.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AzureStackHCI/locations/{location}/validatedSolutionRecipes
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ValidatedSolutionRecipe items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
recipeContent:
{
Description: Represents contents of a validated solution recipe. ,
Required: True ,
}
{
info:
{
Description: Represents information about a validated solution recipe. ,
Required: True ,
}
{
solutionType:
{
Description: Represents the solution type for which this validated solution recipe is applicable. ,
Required: True ,
}
string ,
version:
{
Description: Represents the version for which this validated solution recipe is applicable. ,
Required: True ,
}
string ,
}
,
capabilities:
{
Description: Represents capabilities available in a validated solution recipe. ,
Required: False ,
}
{
clusterCapabilities:
{
Description: Represents the cluster capabilities. ,
Required: True ,
}
[
{
capabilityName:
{
Description: Represents the capability name. ,
Required: True ,
}
string ,
}
,
]
,
nodeCapabilities:
{
Description: Represents the node capabilities. ,
Required: True ,
}
[
{
capabilityName:
{
Description: Represents the capability name. ,
Required: True ,
}
string ,
}
,
]
,
}
,
components:
{
Description: Represents components available in a validated solution recipe. ,
Required: True ,
}
[
{
name:
{
Description: Represents the component's name. ,
Required: True ,
}
string ,
type:
{
Description: Represents the component's type. ,
Required: True ,
}
string ,
requiredVersion:
{
Description: Represents the component's required version. ,
Required: False ,
}
string ,
installOrder:
{
Description: Represents the component's install order. ,
Format: int64 ,
Required: False ,
}
integer ,
tags:
{
Description: Represents the component's tags. ,
Required: True ,
}
[
string ,
]
,
payloads:
{
Description: Represents the component's payloads. ,
Required: False ,
}
[
{
identifier:
{
Description: Represents the unique identifier of the payload used to query the URL. ,
Required: True ,
}
string ,
hash:
{
Description: Represents the cryptographic hash of the payload, ensuring data integrity. ,
Required: True ,
}
string ,
fileName:
{
Description: Represents the name of the file associated with the payload. ,
Required: True ,
}
string ,
url:
{
Description: Represents the URL from which the payload can be downloaded. ,
Required: True ,
}
string ,
}
,
]
,
metadata:
{
Description: Represents the component's metadata. ,
Required: False ,
}
{
extensionType:
{
Description: Represents the type of extension. ,
Required: False ,
}
string ,
publisher:
{
Description: Represents the publisher of the extension. ,
Required: False ,
}
string ,
enableAutomaticUpgrade:
{
Description: Indicates whether automatic upgrades of the extension are enabled. ,
Required: False ,
}
boolean ,
lcmUpdate:
{
Description: Indicates whether the LCM (Lifecycle Management) update of the extension is enabled. ,
Required: False ,
}
boolean ,
catalog:
{
Description: Specifies the catalog to which the extension belongs. ,
Required: False ,
}
string ,
ring:
{
Description: Specifies the ring to which the extension belongs, internally used by component. ,
Required: False ,
}
string ,
releaseTrain:
{
Description: Specifies the release train to which given component belongs. ,
Required: False ,
}
string ,
link:
{
Description: Specifies the link associated with the extension. ,
Required: False ,
}
string ,
name:
{
Description: Specifies the name of the extension. ,
Required: False ,
}
string ,
expectedHash:
{
Description: Specifies the expected hash of the extension. ,
Required: False ,
}
string ,
previewSource:
{
Description: Specifies the preview source of the extension. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
signature:
{
Description: Represents the signature of the recipe, to be used for ensuring its integrity. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ValidatedSolutionRecipes_Get (removed)
Description :  Get a validated solution recipe.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AzureStackHCI/locations/{location}/validatedSolutionRecipes/{validatedSolutionRecipeName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
validatedSolutionRecipeName:
{
Description: The name of the ValidatedSolutionRecipe ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
recipeContent:
{
Description: Represents contents of a validated solution recipe. ,
Required: True ,
}
{
info:
{
Description: Represents information about a validated solution recipe. ,
Required: True ,
}
{
solutionType:
{
Description: Represents the solution type for which this validated solution recipe is applicable. ,
Required: True ,
}
string ,
version:
{
Description: Represents the version for which this validated solution recipe is applicable. ,
Required: True ,
}
string ,
}
,
capabilities:
{
Description: Represents capabilities available in a validated solution recipe. ,
Required: False ,
}
{
clusterCapabilities:
{
Description: Represents the cluster capabilities. ,
Required: True ,
}
[
{
capabilityName:
{
Description: Represents the capability name. ,
Required: True ,
}
string ,
}
,
]
,
nodeCapabilities:
{
Description: Represents the node capabilities. ,
Required: True ,
}
[
{
capabilityName:
{
Description: Represents the capability name. ,
Required: True ,
}
string ,
}
,
]
,
}
,
components:
{
Description: Represents components available in a validated solution recipe. ,
Required: True ,
}
[
{
name:
{
Description: Represents the component's name. ,
Required: True ,
}
string ,
type:
{
Description: Represents the component's type. ,
Required: True ,
}
string ,
requiredVersion:
{
Description: Represents the component's required version. ,
Required: False ,
}
string ,
installOrder:
{
Description: Represents the component's install order. ,
Format: int64 ,
Required: False ,
}
integer ,
tags:
{
Description: Represents the component's tags. ,
Required: True ,
}
[
string ,
]
,
payloads:
{
Description: Represents the component's payloads. ,
Required: False ,
}
[
{
identifier:
{
Description: Represents the unique identifier of the payload used to query the URL. ,
Required: True ,
}
string ,
hash:
{
Description: Represents the cryptographic hash of the payload, ensuring data integrity. ,
Required: True ,
}
string ,
fileName:
{
Description: Represents the name of the file associated with the payload. ,
Required: True ,
}
string ,
url:
{
Description: Represents the URL from which the payload can be downloaded. ,
Required: True ,
}
string ,
}
,
]
,
metadata:
{
Description: Represents the component's metadata. ,
Required: False ,
}
{
extensionType:
{
Description: Represents the type of extension. ,
Required: False ,
}
string ,
publisher:
{
Description: Represents the publisher of the extension. ,
Required: False ,
}
string ,
enableAutomaticUpgrade:
{
Description: Indicates whether automatic upgrades of the extension are enabled. ,
Required: False ,
}
boolean ,
lcmUpdate:
{
Description: Indicates whether the LCM (Lifecycle Management) update of the extension is enabled. ,
Required: False ,
}
boolean ,
catalog:
{
Description: Specifies the catalog to which the extension belongs. ,
Required: False ,
}
string ,
ring:
{
Description: Specifies the ring to which the extension belongs, internally used by component. ,
Required: False ,
}
string ,
releaseTrain:
{
Description: Specifies the release train to which given component belongs. ,
Required: False ,
}
string ,
link:
{
Description: Specifies the link associated with the extension. ,
Required: False ,
}
string ,
name:
{
Description: Specifies the name of the extension. ,
Required: False ,
}
string ,
expectedHash:
{
Description: Specifies the expected hash of the extension. ,
Required: False ,
}
string ,
previewSource:
{
Description: Specifies the preview source of the extension. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
signature:
{
Description: Represents the signature of the recipe, to be used for ensuring its integrity. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}