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

2025/03/28 • 66 new methods

ArcSettings_ListByCluster (new)
Description :  Get ArcSetting resources of HCI Cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings
{
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of ArcSetting proxy resources. ,
Required: False ,
}
[
{
properties:
{
Description: ArcSetting properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the ArcSetting proxy resource. ,
Enum:
{
NotSpecified: No description available. ,
Error: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Connected: No description available. ,
Disconnected: No description available. ,
Deleted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
PartiallySucceeded: No description available. ,
PartiallyConnected: No description available. ,
InProgress: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
DisableInProgress: No description available. ,
}
,
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: No description available. ,
Error: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Connected: No description available. ,
Disconnected: No description available. ,
Deleted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
PartiallySucceeded: No description available. ,
PartiallyConnected: No description available. ,
InProgress: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
DisableInProgress: No description available. ,
}
,
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 Arc agent in this node. ,
Enum:
{
NotSpecified: No description available. ,
Error: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Connected: No description available. ,
Disconnected: No description available. ,
Deleted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
PartiallySucceeded: No description available. ,
PartiallyConnected: No description available. ,
InProgress: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
DisableInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
connectivityProperties:
{
Description: contains connectivity related configuration for ARC resources ,
Required: False ,
}
object ,
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: 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 ,
}
,
]
,
}
,
}
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}
{
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: ArcSetting properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the ArcSetting proxy resource. ,
Enum:
{
NotSpecified: No description available. ,
Error: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Connected: No description available. ,
Disconnected: No description available. ,
Deleted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
PartiallySucceeded: No description available. ,
PartiallyConnected: No description available. ,
InProgress: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
DisableInProgress: No description available. ,
}
,
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: No description available. ,
Error: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Connected: No description available. ,
Disconnected: No description available. ,
Deleted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
PartiallySucceeded: No description available. ,
PartiallyConnected: No description available. ,
InProgress: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
DisableInProgress: No description available. ,
}
,
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 Arc agent in this node. ,
Enum:
{
NotSpecified: No description available. ,
Error: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Connected: No description available. ,
Disconnected: No description available. ,
Deleted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
PartiallySucceeded: No description available. ,
PartiallyConnected: No description available. ,
InProgress: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
DisableInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
connectivityProperties:
{
Description: contains connectivity related configuration for ARC resources ,
Required: False ,
}
object ,
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}
{
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: No description available. ,
Error: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Connected: No description available. ,
Disconnected: No description available. ,
Deleted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
PartiallySucceeded: No description available. ,
PartiallyConnected: No description available. ,
InProgress: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
DisableInProgress: No description available. ,
}
,
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: No description available. ,
Error: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Connected: No description available. ,
Disconnected: No description available. ,
Deleted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
PartiallySucceeded: No description available. ,
PartiallyConnected: No description available. ,
InProgress: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
DisableInProgress: No description available. ,
}
,
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 Arc agent in this node. ,
Enum:
{
NotSpecified: No description available. ,
Error: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Connected: No description available. ,
Disconnected: No description available. ,
Deleted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
PartiallySucceeded: No description available. ,
PartiallyConnected: No description available. ,
InProgress: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
DisableInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
connectivityProperties:
{
Description: contains connectivity related configuration for ARC resources ,
Required: False ,
}
object ,
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 ,
}
,
]
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: ArcSetting properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the ArcSetting proxy resource. ,
Enum:
{
NotSpecified: No description available. ,
Error: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Connected: No description available. ,
Disconnected: No description available. ,
Deleted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
PartiallySucceeded: No description available. ,
PartiallyConnected: No description available. ,
InProgress: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
DisableInProgress: No description available. ,
}
,
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: No description available. ,
Error: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Connected: No description available. ,
Disconnected: No description available. ,
Deleted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
PartiallySucceeded: No description available. ,
PartiallyConnected: No description available. ,
InProgress: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
DisableInProgress: No description available. ,
}
,
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 Arc agent in this node. ,
Enum:
{
NotSpecified: No description available. ,
Error: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Connected: No description available. ,
Disconnected: No description available. ,
Deleted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
PartiallySucceeded: No description available. ,
PartiallyConnected: No description available. ,
InProgress: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
DisableInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
connectivityProperties:
{
Description: contains connectivity related configuration for ARC resources ,
Required: False ,
}
object ,
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}
{
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 ,
}
object ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: ArcSetting properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the ArcSetting proxy resource. ,
Enum:
{
NotSpecified: No description available. ,
Error: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Connected: No description available. ,
Disconnected: No description available. ,
Deleted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
PartiallySucceeded: No description available. ,
PartiallyConnected: No description available. ,
InProgress: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
DisableInProgress: No description available. ,
}
,
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: No description available. ,
Error: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Connected: No description available. ,
Disconnected: No description available. ,
Deleted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
PartiallySucceeded: No description available. ,
PartiallyConnected: No description available. ,
InProgress: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
DisableInProgress: No description available. ,
}
,
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 Arc agent in this node. ,
Enum:
{
NotSpecified: No description available. ,
Error: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Connected: No description available. ,
Disconnected: No description available. ,
Deleted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
PartiallySucceeded: No description available. ,
PartiallyConnected: No description available. ,
InProgress: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
DisableInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
connectivityProperties:
{
Description: contains connectivity related configuration for ARC resources ,
Required: False ,
}
object ,
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}
{
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ 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 (new)
Description :  Generate password for arc settings.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}/generatePassword
{
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 ,
api-version:
{
Description: The API version to use for this operation. ,
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 (new)
Description :  Create Aad identity for arc settings.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingName}/createArcIdentity
{
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 ,
api-version:
{
Description: The API version to use for this operation. ,
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)

{}

⚐ 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
{
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: ArcSetting properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the ArcSetting proxy resource. ,
Enum:
{
NotSpecified: No description available. ,
Error: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Connected: No description available. ,
Disconnected: No description available. ,
Deleted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
PartiallySucceeded: No description available. ,
PartiallyConnected: No description available. ,
InProgress: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
DisableInProgress: No description available. ,
}
,
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: No description available. ,
Error: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Connected: No description available. ,
Disconnected: No description available. ,
Deleted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
PartiallySucceeded: No description available. ,
PartiallyConnected: No description available. ,
InProgress: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
DisableInProgress: No description available. ,
}
,
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 Arc agent in this node. ,
Enum:
{
NotSpecified: No description available. ,
Error: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Connected: No description available. ,
Disconnected: No description available. ,
Deleted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
PartiallySucceeded: No description available. ,
PartiallyConnected: No description available. ,
InProgress: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
DisableInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
connectivityProperties:
{
Description: contains connectivity related configuration for ARC resources ,
Required: False ,
}
object ,
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 (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
{
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ 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
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of clusters. ,
Required: False ,
}
[
{
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 ,
}
{
provisioningState:
{
Description: Provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
NotSpecified: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Deleted: No description available. ,
PartiallySucceeded: No description available. ,
InProgress: No description available. ,
DisableInProgress: No description available. ,
Connected: No description available. ,
PartiallyConnected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Status of the cluster agent. ,
Enum:
{
NotYetRegistered: No description available. ,
ConnectedRecently: No description available. ,
NotConnectedRecently: No description available. ,
Disconnected: No description available. ,
Error: No description available. ,
NotSpecified: No description available. ,
ValidationInProgress: No description available. ,
ValidationSuccess: No description available. ,
ValidationFailed: No description available. ,
DeploymentInProgress: No description available. ,
DeploymentFailed: No description available. ,
DeploymentSuccess: No description available. ,
}
,
Required: False ,
}
enum ,
connectivityStatus:
{
Description: Overall connectivity status for the cluster resource. ,
Enum:
{
NotYetRegistered: No description available. ,
Connected: No description available. ,
NotConnectedRecently: No description available. ,
PartiallyConnected: No description available. ,
Disconnected: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
cloudId:
{
Description: Unique, immutable resource id. ,
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: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
softwareAssuranceIntent:
{
Description: Customer Intent for Software Assurance Benefit. ,
Enum:
{
Enable: No description available. ,
Disable: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdated:
{
Description: TimeStamp denoting the latest SA benefit applicability is validated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
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 description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: CorrelationId of the log collection ,
Required: False ,
}
string ,
logCollectionJobType:
{
Description: LogCollection job type ,
Enum:
{
OnDemand: No description available. ,
Scheduled: No description available. ,
}
,
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: No description available. ,
DiagnosticsAndRepair: No description available. ,
}
,
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: No description available. ,
Revoke: No description available. ,
}
,
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: No description available. ,
DiagnosticsAndRepair: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
desiredProperties:
{
Description: Desired properties of the cluster. ,
Required: False ,
}
{
windowsServerSubscription:
{
Description: Desired state of Windows Server Subscription. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Desired level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No description available. ,
Basic: No description available. ,
Enhanced: No description available. ,
}
,
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. ,
Required: False ,
}
number ,
windowsServerSubscription:
{
Description: State of Windows Server Subscription. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
nodeType:
{
Description: Type of the cluster node hardware. ,
Enum:
{
FirstParty: No description available. ,
ThirdParty: No description available. ,
}
,
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. ,
Required: False ,
}
number ,
memoryInGiB:
{
Description: Total available memory on the cluster node (in GiB). ,
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: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
lastUpdated:
{
Description: Last time the cluster reported the data. ,
Format: date-time ,
Required: False ,
}
string ,
imdsAttestation:
{
Description: IMDS attestation status of the cluster. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No description available. ,
Basic: No description available. ,
Enhanced: No description available. ,
}
,
Required: False ,
}
enum ,
supportedCapabilities:
{
Description: Capabilities supported by the cluster. ,
Required: False ,
}
[
string ,
]
,
clusterType:
{
Description: The node type of all the nodes of the cluster. ,
Enum:
{
FirstParty: No description available. ,
ThirdParty: No description available. ,
}
,
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: No description available. ,
Enabled: No description available. ,
}
,
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. ,
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 ,
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 ,
]
,
}
,
]
,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Clusters_ListByResourceGroup (new)
Description :  List all HCI clusters in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters
{
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of clusters. ,
Required: False ,
}
[
{
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 ,
}
{
provisioningState:
{
Description: Provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
NotSpecified: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Deleted: No description available. ,
PartiallySucceeded: No description available. ,
InProgress: No description available. ,
DisableInProgress: No description available. ,
Connected: No description available. ,
PartiallyConnected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Status of the cluster agent. ,
Enum:
{
NotYetRegistered: No description available. ,
ConnectedRecently: No description available. ,
NotConnectedRecently: No description available. ,
Disconnected: No description available. ,
Error: No description available. ,
NotSpecified: No description available. ,
ValidationInProgress: No description available. ,
ValidationSuccess: No description available. ,
ValidationFailed: No description available. ,
DeploymentInProgress: No description available. ,
DeploymentFailed: No description available. ,
DeploymentSuccess: No description available. ,
}
,
Required: False ,
}
enum ,
connectivityStatus:
{
Description: Overall connectivity status for the cluster resource. ,
Enum:
{
NotYetRegistered: No description available. ,
Connected: No description available. ,
NotConnectedRecently: No description available. ,
PartiallyConnected: No description available. ,
Disconnected: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
cloudId:
{
Description: Unique, immutable resource id. ,
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: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
softwareAssuranceIntent:
{
Description: Customer Intent for Software Assurance Benefit. ,
Enum:
{
Enable: No description available. ,
Disable: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdated:
{
Description: TimeStamp denoting the latest SA benefit applicability is validated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
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 description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: CorrelationId of the log collection ,
Required: False ,
}
string ,
logCollectionJobType:
{
Description: LogCollection job type ,
Enum:
{
OnDemand: No description available. ,
Scheduled: No description available. ,
}
,
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: No description available. ,
DiagnosticsAndRepair: No description available. ,
}
,
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: No description available. ,
Revoke: No description available. ,
}
,
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: No description available. ,
DiagnosticsAndRepair: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
desiredProperties:
{
Description: Desired properties of the cluster. ,
Required: False ,
}
{
windowsServerSubscription:
{
Description: Desired state of Windows Server Subscription. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Desired level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No description available. ,
Basic: No description available. ,
Enhanced: No description available. ,
}
,
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. ,
Required: False ,
}
number ,
windowsServerSubscription:
{
Description: State of Windows Server Subscription. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
nodeType:
{
Description: Type of the cluster node hardware. ,
Enum:
{
FirstParty: No description available. ,
ThirdParty: No description available. ,
}
,
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. ,
Required: False ,
}
number ,
memoryInGiB:
{
Description: Total available memory on the cluster node (in GiB). ,
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: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
lastUpdated:
{
Description: Last time the cluster reported the data. ,
Format: date-time ,
Required: False ,
}
string ,
imdsAttestation:
{
Description: IMDS attestation status of the cluster. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No description available. ,
Basic: No description available. ,
Enhanced: No description available. ,
}
,
Required: False ,
}
enum ,
supportedCapabilities:
{
Description: Capabilities supported by the cluster. ,
Required: False ,
}
[
string ,
]
,
clusterType:
{
Description: The node type of all the nodes of the cluster. ,
Enum:
{
FirstParty: No description available. ,
ThirdParty: No description available. ,
}
,
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: No description available. ,
Enabled: No description available. ,
}
,
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. ,
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 ,
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 ,
]
,
}
,
]
,
}
,
}
,
]
,
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 ,
}
,
]
,
}
,
}
Clusters_Get (new)
Description :  Get HCI cluster.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}
{
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 ,
}
{
provisioningState:
{
Description: Provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
NotSpecified: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Deleted: No description available. ,
PartiallySucceeded: No description available. ,
InProgress: No description available. ,
DisableInProgress: No description available. ,
Connected: No description available. ,
PartiallyConnected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Status of the cluster agent. ,
Enum:
{
NotYetRegistered: No description available. ,
ConnectedRecently: No description available. ,
NotConnectedRecently: No description available. ,
Disconnected: No description available. ,
Error: No description available. ,
NotSpecified: No description available. ,
ValidationInProgress: No description available. ,
ValidationSuccess: No description available. ,
ValidationFailed: No description available. ,
DeploymentInProgress: No description available. ,
DeploymentFailed: No description available. ,
DeploymentSuccess: No description available. ,
}
,
Required: False ,
}
enum ,
connectivityStatus:
{
Description: Overall connectivity status for the cluster resource. ,
Enum:
{
NotYetRegistered: No description available. ,
Connected: No description available. ,
NotConnectedRecently: No description available. ,
PartiallyConnected: No description available. ,
Disconnected: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
cloudId:
{
Description: Unique, immutable resource id. ,
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: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
softwareAssuranceIntent:
{
Description: Customer Intent for Software Assurance Benefit. ,
Enum:
{
Enable: No description available. ,
Disable: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdated:
{
Description: TimeStamp denoting the latest SA benefit applicability is validated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
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 description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: CorrelationId of the log collection ,
Required: False ,
}
string ,
logCollectionJobType:
{
Description: LogCollection job type ,
Enum:
{
OnDemand: No description available. ,
Scheduled: No description available. ,
}
,
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: No description available. ,
DiagnosticsAndRepair: No description available. ,
}
,
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: No description available. ,
Revoke: No description available. ,
}
,
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: No description available. ,
DiagnosticsAndRepair: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
desiredProperties:
{
Description: Desired properties of the cluster. ,
Required: False ,
}
{
windowsServerSubscription:
{
Description: Desired state of Windows Server Subscription. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Desired level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No description available. ,
Basic: No description available. ,
Enhanced: No description available. ,
}
,
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. ,
Required: False ,
}
number ,
windowsServerSubscription:
{
Description: State of Windows Server Subscription. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
nodeType:
{
Description: Type of the cluster node hardware. ,
Enum:
{
FirstParty: No description available. ,
ThirdParty: No description available. ,
}
,
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. ,
Required: False ,
}
number ,
memoryInGiB:
{
Description: Total available memory on the cluster node (in GiB). ,
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: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
lastUpdated:
{
Description: Last time the cluster reported the data. ,
Format: date-time ,
Required: False ,
}
string ,
imdsAttestation:
{
Description: IMDS attestation status of the cluster. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No description available. ,
Basic: No description available. ,
Enhanced: No description available. ,
}
,
Required: False ,
}
enum ,
supportedCapabilities:
{
Description: Capabilities supported by the cluster. ,
Required: False ,
}
[
string ,
]
,
clusterType:
{
Description: The node type of all the nodes of the cluster. ,
Enum:
{
FirstParty: No description available. ,
ThirdParty: No description available. ,
}
,
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: No description available. ,
Enabled: No description available. ,
}
,
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. ,
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 ,
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 ,
]
,
}
,
]
,
}
,
}

⚐ 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}
{
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
cluster:
{
Description: Details of the HCI cluster. ,
Required: True ,
}
{
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 ,
}
{
provisioningState:
{
Description: Provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
NotSpecified: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Deleted: No description available. ,
PartiallySucceeded: No description available. ,
InProgress: No description available. ,
DisableInProgress: No description available. ,
Connected: No description available. ,
PartiallyConnected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Status of the cluster agent. ,
Enum:
{
NotYetRegistered: No description available. ,
ConnectedRecently: No description available. ,
NotConnectedRecently: No description available. ,
Disconnected: No description available. ,
Error: No description available. ,
NotSpecified: No description available. ,
ValidationInProgress: No description available. ,
ValidationSuccess: No description available. ,
ValidationFailed: No description available. ,
DeploymentInProgress: No description available. ,
DeploymentFailed: No description available. ,
DeploymentSuccess: No description available. ,
}
,
Required: False ,
}
enum ,
connectivityStatus:
{
Description: Overall connectivity status for the cluster resource. ,
Enum:
{
NotYetRegistered: No description available. ,
Connected: No description available. ,
NotConnectedRecently: No description available. ,
PartiallyConnected: No description available. ,
Disconnected: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
cloudId:
{
Description: Unique, immutable resource id. ,
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: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
softwareAssuranceIntent:
{
Description: Customer Intent for Software Assurance Benefit. ,
Enum:
{
Enable: No description available. ,
Disable: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdated:
{
Description: TimeStamp denoting the latest SA benefit applicability is validated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
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 description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: CorrelationId of the log collection ,
Required: False ,
}
string ,
logCollectionJobType:
{
Description: LogCollection job type ,
Enum:
{
OnDemand: No description available. ,
Scheduled: No description available. ,
}
,
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: No description available. ,
DiagnosticsAndRepair: No description available. ,
}
,
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: No description available. ,
Revoke: No description available. ,
}
,
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: No description available. ,
DiagnosticsAndRepair: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
desiredProperties:
{
Description: Desired properties of the cluster. ,
Required: False ,
}
{
windowsServerSubscription:
{
Description: Desired state of Windows Server Subscription. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Desired level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No description available. ,
Basic: No description available. ,
Enhanced: No description available. ,
}
,
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. ,
Required: False ,
}
number ,
windowsServerSubscription:
{
Description: State of Windows Server Subscription. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
nodeType:
{
Description: Type of the cluster node hardware. ,
Enum:
{
FirstParty: No description available. ,
ThirdParty: No description available. ,
}
,
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. ,
Required: False ,
}
number ,
memoryInGiB:
{
Description: Total available memory on the cluster node (in GiB). ,
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: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
lastUpdated:
{
Description: Last time the cluster reported the data. ,
Format: date-time ,
Required: False ,
}
string ,
imdsAttestation:
{
Description: IMDS attestation status of the cluster. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No description available. ,
Basic: No description available. ,
Enhanced: No description available. ,
}
,
Required: False ,
}
enum ,
supportedCapabilities:
{
Description: Capabilities supported by the cluster. ,
Required: False ,
}
[
string ,
]
,
clusterType:
{
Description: The node type of all the nodes of the cluster. ,
Enum:
{
FirstParty: No description available. ,
ThirdParty: No description available. ,
}
,
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: No description available. ,
Enabled: No description available. ,
}
,
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. ,
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 ,
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 ,
]
,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
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 ,
}
{
provisioningState:
{
Description: Provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
NotSpecified: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Deleted: No description available. ,
PartiallySucceeded: No description available. ,
InProgress: No description available. ,
DisableInProgress: No description available. ,
Connected: No description available. ,
PartiallyConnected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Status of the cluster agent. ,
Enum:
{
NotYetRegistered: No description available. ,
ConnectedRecently: No description available. ,
NotConnectedRecently: No description available. ,
Disconnected: No description available. ,
Error: No description available. ,
NotSpecified: No description available. ,
ValidationInProgress: No description available. ,
ValidationSuccess: No description available. ,
ValidationFailed: No description available. ,
DeploymentInProgress: No description available. ,
DeploymentFailed: No description available. ,
DeploymentSuccess: No description available. ,
}
,
Required: False ,
}
enum ,
connectivityStatus:
{
Description: Overall connectivity status for the cluster resource. ,
Enum:
{
NotYetRegistered: No description available. ,
Connected: No description available. ,
NotConnectedRecently: No description available. ,
PartiallyConnected: No description available. ,
Disconnected: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
cloudId:
{
Description: Unique, immutable resource id. ,
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: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
softwareAssuranceIntent:
{
Description: Customer Intent for Software Assurance Benefit. ,
Enum:
{
Enable: No description available. ,
Disable: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdated:
{
Description: TimeStamp denoting the latest SA benefit applicability is validated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
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 description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: CorrelationId of the log collection ,
Required: False ,
}
string ,
logCollectionJobType:
{
Description: LogCollection job type ,
Enum:
{
OnDemand: No description available. ,
Scheduled: No description available. ,
}
,
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: No description available. ,
DiagnosticsAndRepair: No description available. ,
}
,
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: No description available. ,
Revoke: No description available. ,
}
,
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: No description available. ,
DiagnosticsAndRepair: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
desiredProperties:
{
Description: Desired properties of the cluster. ,
Required: False ,
}
{
windowsServerSubscription:
{
Description: Desired state of Windows Server Subscription. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Desired level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No description available. ,
Basic: No description available. ,
Enhanced: No description available. ,
}
,
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. ,
Required: False ,
}
number ,
windowsServerSubscription:
{
Description: State of Windows Server Subscription. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
nodeType:
{
Description: Type of the cluster node hardware. ,
Enum:
{
FirstParty: No description available. ,
ThirdParty: No description available. ,
}
,
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. ,
Required: False ,
}
number ,
memoryInGiB:
{
Description: Total available memory on the cluster node (in GiB). ,
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: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
lastUpdated:
{
Description: Last time the cluster reported the data. ,
Format: date-time ,
Required: False ,
}
string ,
imdsAttestation:
{
Description: IMDS attestation status of the cluster. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No description available. ,
Basic: No description available. ,
Enhanced: No description available. ,
}
,
Required: False ,
}
enum ,
supportedCapabilities:
{
Description: Capabilities supported by the cluster. ,
Required: False ,
}
[
string ,
]
,
clusterType:
{
Description: The node type of all the nodes of the cluster. ,
Enum:
{
FirstParty: No description available. ,
ThirdParty: No description available. ,
}
,
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: No description available. ,
Enabled: No description available. ,
}
,
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. ,
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 ,
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 ,
]
,
}
,
]
,
}
,
}

⚐ 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}
{
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 ,
api-version:
{
Description: The API version to use for this operation. ,
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: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Desired level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No description available. ,
Basic: No description available. ,
Enhanced: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
}

⚐ Response (200)

{
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 ,
}
{
provisioningState:
{
Description: Provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
NotSpecified: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Deleted: No description available. ,
PartiallySucceeded: No description available. ,
InProgress: No description available. ,
DisableInProgress: No description available. ,
Connected: No description available. ,
PartiallyConnected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Status of the cluster agent. ,
Enum:
{
NotYetRegistered: No description available. ,
ConnectedRecently: No description available. ,
NotConnectedRecently: No description available. ,
Disconnected: No description available. ,
Error: No description available. ,
NotSpecified: No description available. ,
ValidationInProgress: No description available. ,
ValidationSuccess: No description available. ,
ValidationFailed: No description available. ,
DeploymentInProgress: No description available. ,
DeploymentFailed: No description available. ,
DeploymentSuccess: No description available. ,
}
,
Required: False ,
}
enum ,
connectivityStatus:
{
Description: Overall connectivity status for the cluster resource. ,
Enum:
{
NotYetRegistered: No description available. ,
Connected: No description available. ,
NotConnectedRecently: No description available. ,
PartiallyConnected: No description available. ,
Disconnected: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
cloudId:
{
Description: Unique, immutable resource id. ,
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: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
softwareAssuranceIntent:
{
Description: Customer Intent for Software Assurance Benefit. ,
Enum:
{
Enable: No description available. ,
Disable: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdated:
{
Description: TimeStamp denoting the latest SA benefit applicability is validated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
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 description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: CorrelationId of the log collection ,
Required: False ,
}
string ,
logCollectionJobType:
{
Description: LogCollection job type ,
Enum:
{
OnDemand: No description available. ,
Scheduled: No description available. ,
}
,
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: No description available. ,
DiagnosticsAndRepair: No description available. ,
}
,
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: No description available. ,
Revoke: No description available. ,
}
,
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: No description available. ,
DiagnosticsAndRepair: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
desiredProperties:
{
Description: Desired properties of the cluster. ,
Required: False ,
}
{
windowsServerSubscription:
{
Description: Desired state of Windows Server Subscription. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Desired level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No description available. ,
Basic: No description available. ,
Enhanced: No description available. ,
}
,
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. ,
Required: False ,
}
number ,
windowsServerSubscription:
{
Description: State of Windows Server Subscription. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
nodeType:
{
Description: Type of the cluster node hardware. ,
Enum:
{
FirstParty: No description available. ,
ThirdParty: No description available. ,
}
,
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. ,
Required: False ,
}
number ,
memoryInGiB:
{
Description: Total available memory on the cluster node (in GiB). ,
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: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
lastUpdated:
{
Description: Last time the cluster reported the data. ,
Format: date-time ,
Required: False ,
}
string ,
imdsAttestation:
{
Description: IMDS attestation status of the cluster. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No description available. ,
Basic: No description available. ,
Enhanced: No description available. ,
}
,
Required: False ,
}
enum ,
supportedCapabilities:
{
Description: Capabilities supported by the cluster. ,
Required: False ,
}
[
string ,
]
,
clusterType:
{
Description: The node type of all the nodes of the cluster. ,
Enum:
{
FirstParty: No description available. ,
ThirdParty: No description available. ,
}
,
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: No description available. ,
Enabled: No description available. ,
}
,
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. ,
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 ,
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 ,
]
,
}
,
]
,
}
,
}

⚐ 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}
{
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ 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 (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)

{
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 ,
}
{
provisioningState:
{
Description: Provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
NotSpecified: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Deleted: No description available. ,
PartiallySucceeded: No description available. ,
InProgress: No description available. ,
DisableInProgress: No description available. ,
Connected: No description available. ,
PartiallyConnected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Status of the cluster agent. ,
Enum:
{
NotYetRegistered: No description available. ,
ConnectedRecently: No description available. ,
NotConnectedRecently: No description available. ,
Disconnected: No description available. ,
Error: No description available. ,
NotSpecified: No description available. ,
ValidationInProgress: No description available. ,
ValidationSuccess: No description available. ,
ValidationFailed: No description available. ,
DeploymentInProgress: No description available. ,
DeploymentFailed: No description available. ,
DeploymentSuccess: No description available. ,
}
,
Required: False ,
}
enum ,
connectivityStatus:
{
Description: Overall connectivity status for the cluster resource. ,
Enum:
{
NotYetRegistered: No description available. ,
Connected: No description available. ,
NotConnectedRecently: No description available. ,
PartiallyConnected: No description available. ,
Disconnected: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
cloudId:
{
Description: Unique, immutable resource id. ,
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: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
softwareAssuranceIntent:
{
Description: Customer Intent for Software Assurance Benefit. ,
Enum:
{
Enable: No description available. ,
Disable: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdated:
{
Description: TimeStamp denoting the latest SA benefit applicability is validated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
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 description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: CorrelationId of the log collection ,
Required: False ,
}
string ,
logCollectionJobType:
{
Description: LogCollection job type ,
Enum:
{
OnDemand: No description available. ,
Scheduled: No description available. ,
}
,
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: No description available. ,
DiagnosticsAndRepair: No description available. ,
}
,
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: No description available. ,
Revoke: No description available. ,
}
,
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: No description available. ,
DiagnosticsAndRepair: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
desiredProperties:
{
Description: Desired properties of the cluster. ,
Required: False ,
}
{
windowsServerSubscription:
{
Description: Desired state of Windows Server Subscription. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Desired level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No description available. ,
Basic: No description available. ,
Enhanced: No description available. ,
}
,
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. ,
Required: False ,
}
number ,
windowsServerSubscription:
{
Description: State of Windows Server Subscription. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
nodeType:
{
Description: Type of the cluster node hardware. ,
Enum:
{
FirstParty: No description available. ,
ThirdParty: No description available. ,
}
,
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. ,
Required: False ,
}
number ,
memoryInGiB:
{
Description: Total available memory on the cluster node (in GiB). ,
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: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
lastUpdated:
{
Description: Last time the cluster reported the data. ,
Format: date-time ,
Required: False ,
}
string ,
imdsAttestation:
{
Description: IMDS attestation status of the cluster. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No description available. ,
Basic: No description available. ,
Enhanced: No description available. ,
}
,
Required: False ,
}
enum ,
supportedCapabilities:
{
Description: Capabilities supported by the cluster. ,
Required: False ,
}
[
string ,
]
,
clusterType:
{
Description: The node type of all the nodes of the cluster. ,
Enum:
{
FirstParty: No description available. ,
ThirdParty: No description available. ,
}
,
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: No description available. ,
Enabled: No description available. ,
}
,
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. ,
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 ,
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 ,
]
,
}
,
]
,
}
,
}

⚐ 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 (new)
Description :  Upload certificate.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/uploadCertificate
{
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
uploadCertificateRequest:
{
Description: Upload certificate request. ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
certificates:
{
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (202)

{}

⚐ 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
{
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 ,
api-version:
{
Description: The API version to use for this operation. ,
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)

{}

⚐ 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
{
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
softwareAssuranceChangeRequest:
{
Description: Software Assurance Change Request Payload ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
softwareAssuranceIntent:
{
Enum:
{
Enable: No description available. ,
Disable: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
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 ,
}
{
provisioningState:
{
Description: Provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
NotSpecified: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Deleted: No description available. ,
PartiallySucceeded: No description available. ,
InProgress: No description available. ,
DisableInProgress: No description available. ,
Connected: No description available. ,
PartiallyConnected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Status of the cluster agent. ,
Enum:
{
NotYetRegistered: No description available. ,
ConnectedRecently: No description available. ,
NotConnectedRecently: No description available. ,
Disconnected: No description available. ,
Error: No description available. ,
NotSpecified: No description available. ,
ValidationInProgress: No description available. ,
ValidationSuccess: No description available. ,
ValidationFailed: No description available. ,
DeploymentInProgress: No description available. ,
DeploymentFailed: No description available. ,
DeploymentSuccess: No description available. ,
}
,
Required: False ,
}
enum ,
connectivityStatus:
{
Description: Overall connectivity status for the cluster resource. ,
Enum:
{
NotYetRegistered: No description available. ,
Connected: No description available. ,
NotConnectedRecently: No description available. ,
PartiallyConnected: No description available. ,
Disconnected: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
cloudId:
{
Description: Unique, immutable resource id. ,
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: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
softwareAssuranceIntent:
{
Description: Customer Intent for Software Assurance Benefit. ,
Enum:
{
Enable: No description available. ,
Disable: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdated:
{
Description: TimeStamp denoting the latest SA benefit applicability is validated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
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 description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: CorrelationId of the log collection ,
Required: False ,
}
string ,
logCollectionJobType:
{
Description: LogCollection job type ,
Enum:
{
OnDemand: No description available. ,
Scheduled: No description available. ,
}
,
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: No description available. ,
DiagnosticsAndRepair: No description available. ,
}
,
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: No description available. ,
Revoke: No description available. ,
}
,
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: No description available. ,
DiagnosticsAndRepair: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
desiredProperties:
{
Description: Desired properties of the cluster. ,
Required: False ,
}
{
windowsServerSubscription:
{
Description: Desired state of Windows Server Subscription. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Desired level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No description available. ,
Basic: No description available. ,
Enhanced: No description available. ,
}
,
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. ,
Required: False ,
}
number ,
windowsServerSubscription:
{
Description: State of Windows Server Subscription. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
nodeType:
{
Description: Type of the cluster node hardware. ,
Enum:
{
FirstParty: No description available. ,
ThirdParty: No description available. ,
}
,
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. ,
Required: False ,
}
number ,
memoryInGiB:
{
Description: Total available memory on the cluster node (in GiB). ,
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: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
lastUpdated:
{
Description: Last time the cluster reported the data. ,
Format: date-time ,
Required: False ,
}
string ,
imdsAttestation:
{
Description: IMDS attestation status of the cluster. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No description available. ,
Basic: No description available. ,
Enhanced: No description available. ,
}
,
Required: False ,
}
enum ,
supportedCapabilities:
{
Description: Capabilities supported by the cluster. ,
Required: False ,
}
[
string ,
]
,
clusterType:
{
Description: The node type of all the nodes of the cluster. ,
Enum:
{
FirstParty: No description available. ,
ThirdParty: No description available. ,
}
,
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: No description available. ,
Enabled: No description available. ,
}
,
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. ,
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 ,
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 ,
]
,
}
,
]
,
}
,
}

⚐ Response (202)

{}

⚐ 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
{
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 ,
api-version:
{
Description: The API version to use for this operation. ,
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)

{
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 ,
}
{
provisioningState:
{
Description: Provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
NotSpecified: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Deleted: No description available. ,
PartiallySucceeded: No description available. ,
InProgress: No description available. ,
DisableInProgress: No description available. ,
Connected: No description available. ,
PartiallyConnected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Status of the cluster agent. ,
Enum:
{
NotYetRegistered: No description available. ,
ConnectedRecently: No description available. ,
NotConnectedRecently: No description available. ,
Disconnected: No description available. ,
Error: No description available. ,
NotSpecified: No description available. ,
ValidationInProgress: No description available. ,
ValidationSuccess: No description available. ,
ValidationFailed: No description available. ,
DeploymentInProgress: No description available. ,
DeploymentFailed: No description available. ,
DeploymentSuccess: No description available. ,
}
,
Required: False ,
}
enum ,
connectivityStatus:
{
Description: Overall connectivity status for the cluster resource. ,
Enum:
{
NotYetRegistered: No description available. ,
Connected: No description available. ,
NotConnectedRecently: No description available. ,
PartiallyConnected: No description available. ,
Disconnected: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
cloudId:
{
Description: Unique, immutable resource id. ,
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: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
softwareAssuranceIntent:
{
Description: Customer Intent for Software Assurance Benefit. ,
Enum:
{
Enable: No description available. ,
Disable: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdated:
{
Description: TimeStamp denoting the latest SA benefit applicability is validated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
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 description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: CorrelationId of the log collection ,
Required: False ,
}
string ,
logCollectionJobType:
{
Description: LogCollection job type ,
Enum:
{
OnDemand: No description available. ,
Scheduled: No description available. ,
}
,
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: No description available. ,
DiagnosticsAndRepair: No description available. ,
}
,
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: No description available. ,
Revoke: No description available. ,
}
,
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: No description available. ,
DiagnosticsAndRepair: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
desiredProperties:
{
Description: Desired properties of the cluster. ,
Required: False ,
}
{
windowsServerSubscription:
{
Description: Desired state of Windows Server Subscription. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Desired level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No description available. ,
Basic: No description available. ,
Enhanced: No description available. ,
}
,
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. ,
Required: False ,
}
number ,
windowsServerSubscription:
{
Description: State of Windows Server Subscription. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
nodeType:
{
Description: Type of the cluster node hardware. ,
Enum:
{
FirstParty: No description available. ,
ThirdParty: No description available. ,
}
,
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. ,
Required: False ,
}
number ,
memoryInGiB:
{
Description: Total available memory on the cluster node (in GiB). ,
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: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
lastUpdated:
{
Description: Last time the cluster reported the data. ,
Format: date-time ,
Required: False ,
}
string ,
imdsAttestation:
{
Description: IMDS attestation status of the cluster. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No description available. ,
Basic: No description available. ,
Enhanced: No description available. ,
}
,
Required: False ,
}
enum ,
supportedCapabilities:
{
Description: Capabilities supported by the cluster. ,
Required: False ,
}
[
string ,
]
,
clusterType:
{
Description: The node type of all the nodes of the cluster. ,
Enum:
{
FirstParty: No description available. ,
ThirdParty: No description available. ,
}
,
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: No description available. ,
Enabled: No description available. ,
}
,
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. ,
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 ,
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 ,
]
,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: 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_ConfigureRemoteSupport (new)
Description :  Configure RemoteSupport on a cluster
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/configureRemoteSupport
{
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 ,
api-version:
{
Description: The API version to use for this operation. ,
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: No description available. ,
DiagnosticsAndRepair: No description available. ,
}
,
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: No description available. ,
Revoke: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
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 ,
}
{
provisioningState:
{
Description: Provisioning state. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
NotSpecified: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
Deleted: No description available. ,
PartiallySucceeded: No description available. ,
InProgress: No description available. ,
DisableInProgress: No description available. ,
Connected: No description available. ,
PartiallyConnected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Status of the cluster agent. ,
Enum:
{
NotYetRegistered: No description available. ,
ConnectedRecently: No description available. ,
NotConnectedRecently: No description available. ,
Disconnected: No description available. ,
Error: No description available. ,
NotSpecified: No description available. ,
ValidationInProgress: No description available. ,
ValidationSuccess: No description available. ,
ValidationFailed: No description available. ,
DeploymentInProgress: No description available. ,
DeploymentFailed: No description available. ,
DeploymentSuccess: No description available. ,
}
,
Required: False ,
}
enum ,
connectivityStatus:
{
Description: Overall connectivity status for the cluster resource. ,
Enum:
{
NotYetRegistered: No description available. ,
Connected: No description available. ,
NotConnectedRecently: No description available. ,
PartiallyConnected: No description available. ,
Disconnected: No description available. ,
NotSpecified: No description available. ,
}
,
Required: False ,
}
enum ,
cloudId:
{
Description: Unique, immutable resource id. ,
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: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
softwareAssuranceIntent:
{
Description: Customer Intent for Software Assurance Benefit. ,
Enum:
{
Enable: No description available. ,
Disable: No description available. ,
}
,
Required: False ,
}
enum ,
lastUpdated:
{
Description: TimeStamp denoting the latest SA benefit applicability is validated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
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 description available. ,
InProgress: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
}
,
Required: False ,
}
enum ,
correlationId:
{
Description: CorrelationId of the log collection ,
Required: False ,
}
string ,
logCollectionJobType:
{
Description: LogCollection job type ,
Enum:
{
OnDemand: No description available. ,
Scheduled: No description available. ,
}
,
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: No description available. ,
DiagnosticsAndRepair: No description available. ,
}
,
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: No description available. ,
Revoke: No description available. ,
}
,
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: No description available. ,
DiagnosticsAndRepair: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
desiredProperties:
{
Description: Desired properties of the cluster. ,
Required: False ,
}
{
windowsServerSubscription:
{
Description: Desired state of Windows Server Subscription. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Desired level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No description available. ,
Basic: No description available. ,
Enhanced: No description available. ,
}
,
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. ,
Required: False ,
}
number ,
windowsServerSubscription:
{
Description: State of Windows Server Subscription. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
nodeType:
{
Description: Type of the cluster node hardware. ,
Enum:
{
FirstParty: No description available. ,
ThirdParty: No description available. ,
}
,
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. ,
Required: False ,
}
number ,
memoryInGiB:
{
Description: Total available memory on the cluster node (in GiB). ,
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: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
lastUpdated:
{
Description: Last time the cluster reported the data. ,
Format: date-time ,
Required: False ,
}
string ,
imdsAttestation:
{
Description: IMDS attestation status of the cluster. ,
Enum:
{
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
diagnosticLevel:
{
Description: Level of diagnostic data emitted by the cluster. ,
Enum:
{
Off: No description available. ,
Basic: No description available. ,
Enhanced: No description available. ,
}
,
Required: False ,
}
enum ,
supportedCapabilities:
{
Description: Capabilities supported by the cluster. ,
Required: False ,
}
[
string ,
]
,
clusterType:
{
Description: The node type of all the nodes of the cluster. ,
Enum:
{
FirstParty: No description available. ,
ThirdParty: No description available. ,
}
,
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: No description available. ,
Enabled: No description available. ,
}
,
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. ,
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 ,
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 ,
]
,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: 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_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:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
NotSpecified: The resource provision state is not specified ,
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 ,
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 ,
clusterPattern:
{
Description: Cluster Pattern supported. ,
Enum:
{
Standard: Standard cluster. ,
RackAware: RackAware 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 ,
}
,
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 ,
}
,
]
,
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 ,
}
,
}
,
adouPath:
{
Description: The path to the Active Directory Organizational Unit container object prepared for the deployment. ,
Required: False ,
}
string ,
secretsLocation:
{
Description: Azure keyvault 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:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
NotSpecified: The resource provision state is not specified ,
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 ,
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 ,
clusterPattern:
{
Description: Cluster Pattern supported. ,
Enum:
{
Standard: Standard cluster. ,
RackAware: RackAware 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 ,
}
,
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 ,
}
,
]
,
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 ,
}
,
}
,
adouPath:
{
Description: The path to the Active Directory Organizational Unit container object prepared for the deployment. ,
Required: False ,
}
string ,
secretsLocation:
{
Description: Azure keyvault 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:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
NotSpecified: The resource provision state is not specified ,
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 ,
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 ,
clusterPattern:
{
Description: Cluster Pattern supported. ,
Enum:
{
Standard: Standard cluster. ,
RackAware: RackAware 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 ,
}
,
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 ,
}
,
]
,
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 ,
}
,
}
,
adouPath:
{
Description: The path to the Active Directory Organizational Unit container object prepared for the deployment. ,
Required: False ,
}
string ,
secretsLocation:
{
Description: Azure keyvault 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:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
NotSpecified: The resource provision state is not specified ,
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 ,
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 ,
clusterPattern:
{
Description: Cluster Pattern supported. ,
Enum:
{
Standard: Standard cluster. ,
RackAware: RackAware 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 ,
}
,
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 ,
}
,
]
,
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 ,
}
,
}
,
adouPath:
{
Description: The path to the Active Directory Organizational Unit container object prepared for the deployment. ,
Required: False ,
}
string ,
secretsLocation:
{
Description: Azure keyvault 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:
{
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:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
NotSpecified: The resource provision state is not specified ,
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 ,
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 ,
clusterPattern:
{
Description: Cluster Pattern supported. ,
Enum:
{
Standard: Standard cluster. ,
RackAware: RackAware 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 ,
}
,
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 ,
}
,
]
,
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 ,
}
,
}
,
adouPath:
{
Description: The path to the Active Directory Organizational Unit container object prepared for the deployment. ,
Required: False ,
}
string ,
secretsLocation:
{
Description: Azure keyvault 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)

{
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 ,
}
,
]
,
}
,
}
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: The name of the EdgeDevice ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The EdgeDeviceJob items on this page ,
Required: True ,
}
[
{
kind:
{
Description: Edge Solution type to support polymorphic resource. ,
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: The name of the EdgeDevice ,
Required: True ,
}
string ,
jobsName:
{
Description: Name of EdgeDevice Job ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Edge Solution type to support polymorphic resource. ,
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: The name of the EdgeDevice ,
Required: True ,
}
string ,
jobsName:
{
Description: Name of EdgeDevice Job ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
kind:
{
Description: Edge Solution type to support polymorphic resource. ,
Enum:
{
HCI: Arc-enabled edge device with HCI OS. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
kind:
{
Description: Edge Solution type to support polymorphic resource. ,
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: Edge Solution type to support polymorphic resource. ,
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: The name of the EdgeDevice ,
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 (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: Device kind to support polymorphic resource. ,
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: Device kind to support polymorphic resource. ,
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: Device kind to support polymorphic resource. ,
Enum:
{
HCI: Arc-enabled edge device with HCI OS. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
kind:
{
Description: Device kind to support polymorphic resource. ,
Enum:
{
HCI: Arc-enabled edge device with HCI OS. ,
}
,
Required: True ,
}
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: Edge device resource. ,
}
{
kind:
{
Description: Device kind to support polymorphic resource. ,
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)

{
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 ,
}
,
]
,
}
,
}
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)

{
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 (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
{
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 ,
arcSettingName:
{
Description: The name of the proxy resource holding details of HCI ArcSetting information. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Extensions in HCI cluster. ,
Required: False ,
}
[
{
properties:
{
Description: Describes Machine Extension Properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Extension proxy resource. ,
Enum:
{
NotSpecified: No description available. ,
Error: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Connected: No description available. ,
Disconnected: No description available. ,
Deleted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
PartiallySucceeded: No description available. ,
PartiallyConnected: No description available. ,
InProgress: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
}
,
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 ,
}
object ,
protectedSettings:
{
Description: Protected settings (may contain secrets). ,
Required: False ,
}
object ,
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. ,
Enum:
{
NotSpecified: No description available. ,
Error: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Connected: No description available. ,
Disconnected: No description available. ,
Deleted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
PartiallySucceeded: No description available. ,
PartiallyConnected: No description available. ,
InProgress: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
UpgradeFailedRollbackSucceeded: No description available. ,
}
,
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. ,
Enum:
{
NotSpecified: No description available. ,
Error: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Connected: No description available. ,
Disconnected: No description available. ,
Deleted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
PartiallySucceeded: No description available. ,
PartiallyConnected: No description available. ,
InProgress: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
}
,
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. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
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. ,
Enum:
{
Azure: No description available. ,
User: No description available. ,
}
,
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 ,
}
,
]
,
}
,
}
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}
{
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 ,
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes Machine Extension Properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Extension proxy resource. ,
Enum:
{
NotSpecified: No description available. ,
Error: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Connected: No description available. ,
Disconnected: No description available. ,
Deleted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
PartiallySucceeded: No description available. ,
PartiallyConnected: No description available. ,
InProgress: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
}
,
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 ,
}
object ,
protectedSettings:
{
Description: Protected settings (may contain secrets). ,
Required: False ,
}
object ,
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. ,
Enum:
{
NotSpecified: No description available. ,
Error: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Connected: No description available. ,
Disconnected: No description available. ,
Deleted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
PartiallySucceeded: No description available. ,
PartiallyConnected: No description available. ,
InProgress: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
UpgradeFailedRollbackSucceeded: No description available. ,
}
,
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. ,
Enum:
{
NotSpecified: No description available. ,
Error: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Connected: No description available. ,
Disconnected: No description available. ,
Deleted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
PartiallySucceeded: No description available. ,
PartiallyConnected: No description available. ,
InProgress: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
}
,
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. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
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. ,
Enum:
{
Azure: No description available. ,
User: No description available. ,
}
,
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}
{
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 ,
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. ,
Enum:
{
NotSpecified: No description available. ,
Error: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Connected: No description available. ,
Disconnected: No description available. ,
Deleted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
PartiallySucceeded: No description available. ,
PartiallyConnected: No description available. ,
InProgress: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
}
,
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 ,
}
object ,
protectedSettings:
{
Description: Protected settings (may contain secrets). ,
Required: False ,
}
object ,
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. ,
Enum:
{
NotSpecified: No description available. ,
Error: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Connected: No description available. ,
Disconnected: No description available. ,
Deleted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
PartiallySucceeded: No description available. ,
PartiallyConnected: No description available. ,
InProgress: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
UpgradeFailedRollbackSucceeded: No description available. ,
}
,
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. ,
Enum:
{
NotSpecified: No description available. ,
Error: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Connected: No description available. ,
Disconnected: No description available. ,
Deleted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
PartiallySucceeded: No description available. ,
PartiallyConnected: No description available. ,
InProgress: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
}
,
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. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
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. ,
Enum:
{
Azure: No description available. ,
User: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes Machine Extension Properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Extension proxy resource. ,
Enum:
{
NotSpecified: No description available. ,
Error: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Connected: No description available. ,
Disconnected: No description available. ,
Deleted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
PartiallySucceeded: No description available. ,
PartiallyConnected: No description available. ,
InProgress: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
}
,
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 ,
}
object ,
protectedSettings:
{
Description: Protected settings (may contain secrets). ,
Required: False ,
}
object ,
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. ,
Enum:
{
NotSpecified: No description available. ,
Error: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Connected: No description available. ,
Disconnected: No description available. ,
Deleted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
PartiallySucceeded: No description available. ,
PartiallyConnected: No description available. ,
InProgress: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
UpgradeFailedRollbackSucceeded: No description available. ,
}
,
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. ,
Enum:
{
NotSpecified: No description available. ,
Error: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Connected: No description available. ,
Disconnected: No description available. ,
Deleted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
PartiallySucceeded: No description available. ,
PartiallyConnected: No description available. ,
InProgress: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
}
,
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. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
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. ,
Enum:
{
Azure: No description available. ,
User: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Describes Machine Extension Properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Extension proxy resource. ,
Enum:
{
NotSpecified: No description available. ,
Error: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Connected: No description available. ,
Disconnected: No description available. ,
Deleted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
PartiallySucceeded: No description available. ,
PartiallyConnected: No description available. ,
InProgress: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
}
,
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 ,
}
object ,
protectedSettings:
{
Description: Protected settings (may contain secrets). ,
Required: False ,
}
object ,
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. ,
Enum:
{
NotSpecified: No description available. ,
Error: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Connected: No description available. ,
Disconnected: No description available. ,
Deleted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
PartiallySucceeded: No description available. ,
PartiallyConnected: No description available. ,
InProgress: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
UpgradeFailedRollbackSucceeded: No description available. ,
}
,
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. ,
Enum:
{
NotSpecified: No description available. ,
Error: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Connected: No description available. ,
Disconnected: No description available. ,
Deleted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
PartiallySucceeded: No description available. ,
PartiallyConnected: No description available. ,
InProgress: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
}
,
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. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
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. ,
Enum:
{
Azure: No description available. ,
User: No description available. ,
}
,
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}
{
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 ,
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 ,
}
object ,
protectedSettings:
{
Description: Protected settings (may contain secrets). ,
Required: False ,
}
object ,
}
,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Describes Machine Extension Properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of the Extension proxy resource. ,
Enum:
{
NotSpecified: No description available. ,
Error: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Connected: No description available. ,
Disconnected: No description available. ,
Deleted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
PartiallySucceeded: No description available. ,
PartiallyConnected: No description available. ,
InProgress: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
}
,
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 ,
}
object ,
protectedSettings:
{
Description: Protected settings (may contain secrets). ,
Required: False ,
}
object ,
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. ,
Enum:
{
NotSpecified: No description available. ,
Error: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Connected: No description available. ,
Disconnected: No description available. ,
Deleted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
PartiallySucceeded: No description available. ,
PartiallyConnected: No description available. ,
InProgress: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
UpgradeFailedRollbackSucceeded: No description available. ,
}
,
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. ,
Enum:
{
NotSpecified: No description available. ,
Error: No description available. ,
Succeeded: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Connected: No description available. ,
Disconnected: No description available. ,
Deleted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Moving: No description available. ,
PartiallySucceeded: No description available. ,
PartiallyConnected: No description available. ,
InProgress: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
}
,
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. ,
Enum:
{
Info: No description available. ,
Warning: No description available. ,
Error: No description available. ,
}
,
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. ,
Enum:
{
Azure: No description available. ,
User: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{}

⚐ 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}
{
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 ,
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 ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ 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
{
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 ,
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 ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ 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_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 ,
}
,
]
,
}
,
}
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 ,
}
,
]
,
}
,
}
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 ,
}
,
]
,
}
,
}
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 ,
}
,
]
,
}
,
}
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 ,
}
,
]
,
}
,
}
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. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
}
,
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: State of the update run. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
}
,
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 (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 ,
}
,
]
,
}
,
}
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. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
}
,
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: State of the update run. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
}
,
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. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
}
,
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: State of the update run. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
}
,
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 (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. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
}
,
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: State of the update run. ,
Enum:
{
Unknown: No description available. ,
Succeeded: No description available. ,
InProgress: No description available. ,
Failed: No description available. ,
}
,
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 (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. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
}
,
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: The status of the check running (i.e. Failed, Succeeded, In Progress). This answers whether the check ran, and passed or failed. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
severity:
{
Description: Severity of the result (Critical, Warning, Informational, Hidden). This answers how important the result is. Critical is the only update-blocking severity. ,
Enum:
{
Critical: No description available. ,
Warning: No description available. ,
Informational: No description available. ,
Hidden: No description available. ,
}
,
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. ,
Enum:
{
Unknown: No description available. ,
AppliedSuccessfully: No description available. ,
UpdateAvailable: No description available. ,
UpdateInProgress: No description available. ,
UpdateFailed: No description available. ,
NeedsAttention: No description available. ,
PreparationInProgress: No description available. ,
PreparationFailed: No description available. ,
}
,
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 (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 ,
}
,
]
,
}
,
}
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. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
}
,
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: The status of the check running (i.e. Failed, Succeeded, In Progress). This answers whether the check ran, and passed or failed. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
severity:
{
Description: Severity of the result (Critical, Warning, Informational, Hidden). This answers how important the result is. Critical is the only update-blocking severity. ,
Enum:
{
Critical: No description available. ,
Warning: No description available. ,
Informational: No description available. ,
Hidden: No description available. ,
}
,
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. ,
Enum:
{
Unknown: No description available. ,
AppliedSuccessfully: No description available. ,
UpdateAvailable: No description available. ,
UpdateInProgress: No description available. ,
UpdateFailed: No description available. ,
NeedsAttention: No description available. ,
PreparationInProgress: No description available. ,
PreparationFailed: No description available. ,
}
,
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. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
}
,
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: The status of the check running (i.e. Failed, Succeeded, In Progress). This answers whether the check ran, and passed or failed. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
severity:
{
Description: Severity of the result (Critical, Warning, Informational, Hidden). This answers how important the result is. Critical is the only update-blocking severity. ,
Enum:
{
Critical: No description available. ,
Warning: No description available. ,
Informational: No description available. ,
Hidden: No description available. ,
}
,
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. ,
Enum:
{
Unknown: No description available. ,
AppliedSuccessfully: No description available. ,
UpdateAvailable: No description available. ,
UpdateInProgress: No description available. ,
UpdateFailed: No description available. ,
NeedsAttention: No description available. ,
PreparationInProgress: No description available. ,
PreparationFailed: No description available. ,
}
,
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 (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. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
}
,
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: The status of the check running (i.e. Failed, Succeeded, In Progress). This answers whether the check ran, and passed or failed. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
severity:
{
Description: Severity of the result (Critical, Warning, Informational, Hidden). This answers how important the result is. Critical is the only update-blocking severity. ,
Enum:
{
Critical: No description available. ,
Warning: No description available. ,
Informational: No description available. ,
Hidden: No description available. ,
}
,
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. ,
Enum:
{
Unknown: No description available. ,
AppliedSuccessfully: No description available. ,
UpdateAvailable: No description available. ,
UpdateInProgress: No description available. ,
UpdateFailed: No description available. ,
NeedsAttention: No description available. ,
PreparationInProgress: No description available. ,
PreparationFailed: No description available. ,
}
,
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 (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 ,
}
,
]
,
}
,
}
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. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
}
,
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: State of the update as it relates to this stamp. ,
Enum:
{
HasPrerequisite: No description available. ,
Obsolete: No description available. ,
Ready: No description available. ,
NotApplicableBecauseAnotherUpdateIsInProgress: No description available. ,
Preparing: No description available. ,
Installing: No description available. ,
Installed: No description available. ,
PreparationFailed: No description available. ,
InstallationFailed: No description available. ,
Invalid: No description available. ,
Recalled: No description available. ,
Downloading: No description available. ,
DownloadFailed: No description available. ,
HealthChecking: No description available. ,
HealthCheckFailed: No description available. ,
ReadyToInstall: No description available. ,
ScanInProgress: No description available. ,
ScanFailed: No description available. ,
AdditionalContentRequired: No description available. ,
}
,
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:
{
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: The status of the check running (i.e. Failed, Succeeded, In Progress). This answers whether the check ran, and passed or failed. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
severity:
{
Description: Severity of the result (Critical, Warning, Informational, Hidden). This answers how important the result is. Critical is the only update-blocking severity. ,
Enum:
{
Critical: No description available. ,
Warning: No description available. ,
Informational: No description available. ,
Hidden: No description available. ,
}
,
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 the way the update content can be downloaded. ,
Enum:
{
Local: No description available. ,
Online: No description available. ,
Notify: No description 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 (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_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. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
}
,
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: State of the update as it relates to this stamp. ,
Enum:
{
HasPrerequisite: No description available. ,
Obsolete: No description available. ,
Ready: No description available. ,
NotApplicableBecauseAnotherUpdateIsInProgress: No description available. ,
Preparing: No description available. ,
Installing: No description available. ,
Installed: No description available. ,
PreparationFailed: No description available. ,
InstallationFailed: No description available. ,
Invalid: No description available. ,
Recalled: No description available. ,
Downloading: No description available. ,
DownloadFailed: No description available. ,
HealthChecking: No description available. ,
HealthCheckFailed: No description available. ,
ReadyToInstall: No description available. ,
ScanInProgress: No description available. ,
ScanFailed: No description available. ,
AdditionalContentRequired: No description available. ,
}
,
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:
{
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: The status of the check running (i.e. Failed, Succeeded, In Progress). This answers whether the check ran, and passed or failed. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
severity:
{
Description: Severity of the result (Critical, Warning, Informational, Hidden). This answers how important the result is. Critical is the only update-blocking severity. ,
Enum:
{
Critical: No description available. ,
Warning: No description available. ,
Informational: No description available. ,
Hidden: No description available. ,
}
,
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 the way the update content can be downloaded. ,
Enum:
{
Local: No description available. ,
Online: No description available. ,
Notify: No description 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. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
}
,
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: State of the update as it relates to this stamp. ,
Enum:
{
HasPrerequisite: No description available. ,
Obsolete: No description available. ,
Ready: No description available. ,
NotApplicableBecauseAnotherUpdateIsInProgress: No description available. ,
Preparing: No description available. ,
Installing: No description available. ,
Installed: No description available. ,
PreparationFailed: No description available. ,
InstallationFailed: No description available. ,
Invalid: No description available. ,
Recalled: No description available. ,
Downloading: No description available. ,
DownloadFailed: No description available. ,
HealthChecking: No description available. ,
HealthCheckFailed: No description available. ,
ReadyToInstall: No description available. ,
ScanInProgress: No description available. ,
ScanFailed: No description available. ,
AdditionalContentRequired: No description available. ,
}
,
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:
{
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: The status of the check running (i.e. Failed, Succeeded, In Progress). This answers whether the check ran, and passed or failed. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
severity:
{
Description: Severity of the result (Critical, Warning, Informational, Hidden). This answers how important the result is. Critical is the only update-blocking severity. ,
Enum:
{
Critical: No description available. ,
Warning: No description available. ,
Informational: No description available. ,
Hidden: No description available. ,
}
,
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 the way the update content can be downloaded. ,
Enum:
{
Local: No description available. ,
Online: No description available. ,
Notify: No description 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 (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. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
Accepted: No description available. ,
Provisioning: No description available. ,
}
,
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: State of the update as it relates to this stamp. ,
Enum:
{
HasPrerequisite: No description available. ,
Obsolete: No description available. ,
Ready: No description available. ,
NotApplicableBecauseAnotherUpdateIsInProgress: No description available. ,
Preparing: No description available. ,
Installing: No description available. ,
Installed: No description available. ,
PreparationFailed: No description available. ,
InstallationFailed: No description available. ,
Invalid: No description available. ,
Recalled: No description available. ,
Downloading: No description available. ,
DownloadFailed: No description available. ,
HealthChecking: No description available. ,
HealthCheckFailed: No description available. ,
ReadyToInstall: No description available. ,
ScanInProgress: No description available. ,
ScanFailed: No description available. ,
AdditionalContentRequired: No description available. ,
}
,
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:
{
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: The status of the check running (i.e. Failed, Succeeded, In Progress). This answers whether the check ran, and passed or failed. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
severity:
{
Description: Severity of the result (Critical, Warning, Informational, Hidden). This answers how important the result is. Critical is the only update-blocking severity. ,
Enum:
{
Critical: No description available. ,
Warning: No description available. ,
Informational: No description available. ,
Hidden: No description available. ,
}
,
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 the way the update content can be downloaded. ,
Enum:
{
Local: No description available. ,
Online: No description available. ,
Notify: No description 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 (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 ,
}
,
]
,
}
,
}