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

2025/01/06 • 65 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: string ,
resourceGroupName: string ,
clusterName: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
provisioningState: enum ,
arcInstanceResourceGroup: string ,
arcApplicationClientId: string ,
arcApplicationTenantId: string ,
arcServicePrincipalObjectId: string ,
arcApplicationObjectId: string ,
aggregateState: enum ,
perNodeDetails:
[
{
name: string ,
arcInstance: string ,
arcNodeServicePrincipalObjectId: string ,
state: enum ,
}
,
]
,
connectivityProperties: object ,
defaultExtensions:
[
{
category: string ,
consentTime: string ,
}
,
]
,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: 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: string ,
resourceGroupName: string ,
clusterName: string ,
arcSettingName: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
provisioningState: enum ,
arcInstanceResourceGroup: string ,
arcApplicationClientId: string ,
arcApplicationTenantId: string ,
arcServicePrincipalObjectId: string ,
arcApplicationObjectId: string ,
aggregateState: enum ,
perNodeDetails:
[
{
name: string ,
arcInstance: string ,
arcNodeServicePrincipalObjectId: string ,
state: enum ,
}
,
]
,
connectivityProperties: object ,
defaultExtensions:
[
{
category: string ,
consentTime: string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: 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: string ,
resourceGroupName: string ,
clusterName: string ,
arcSettingName: string ,
arcSetting:
{
properties:
{
provisioningState: enum ,
arcInstanceResourceGroup: string ,
arcApplicationClientId: string ,
arcApplicationTenantId: string ,
arcServicePrincipalObjectId: string ,
arcApplicationObjectId: string ,
aggregateState: enum ,
perNodeDetails:
[
{
name: string ,
arcInstance: string ,
arcNodeServicePrincipalObjectId: string ,
state: enum ,
}
,
]
,
connectivityProperties: object ,
defaultExtensions:
[
{
category: string ,
consentTime: string ,
}
,
]
,
}
,
}
,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
provisioningState: enum ,
arcInstanceResourceGroup: string ,
arcApplicationClientId: string ,
arcApplicationTenantId: string ,
arcServicePrincipalObjectId: string ,
arcApplicationObjectId: string ,
aggregateState: enum ,
perNodeDetails:
[
{
name: string ,
arcInstance: string ,
arcNodeServicePrincipalObjectId: string ,
state: enum ,
}
,
]
,
connectivityProperties: object ,
defaultExtensions:
[
{
category: string ,
consentTime: string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: 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: string ,
resourceGroupName: string ,
clusterName: string ,
arcSettingName: string ,
arcSetting:
{
tags: object ,
properties:
{
connectivityProperties: object ,
}
,
}
,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
provisioningState: enum ,
arcInstanceResourceGroup: string ,
arcApplicationClientId: string ,
arcApplicationTenantId: string ,
arcServicePrincipalObjectId: string ,
arcApplicationObjectId: string ,
aggregateState: enum ,
perNodeDetails:
[
{
name: string ,
arcInstance: string ,
arcNodeServicePrincipalObjectId: string ,
state: enum ,
}
,
]
,
connectivityProperties: object ,
defaultExtensions:
[
{
category: string ,
consentTime: string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: 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: string ,
resourceGroupName: string ,
clusterName: string ,
arcSettingName: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: 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: string ,
resourceGroupName: string ,
clusterName: string ,
arcSettingName: string ,
api-version: string ,
}

⚐ Response (200)

{
secretText: string ,
keyId: string ,
startDateTime: string ,
endDateTime: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: 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: string ,
resourceGroupName: string ,
clusterName: string ,
arcSettingName: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
arcApplicationClientId: string ,
arcApplicationTenantId: string ,
arcServicePrincipalObjectId: string ,
arcApplicationObjectId: string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: 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: string ,
resourceGroupName: string ,
clusterName: string ,
arcSettingName: string ,
api-version: string ,
}

⚐ Response (200)

{
properties:
{
provisioningState: enum ,
arcInstanceResourceGroup: string ,
arcApplicationClientId: string ,
arcApplicationTenantId: string ,
arcServicePrincipalObjectId: string ,
arcApplicationObjectId: string ,
aggregateState: enum ,
perNodeDetails:
[
{
name: string ,
arcInstance: string ,
arcNodeServicePrincipalObjectId: string ,
state: enum ,
}
,
]
,
connectivityProperties: object ,
defaultExtensions:
[
{
category: string ,
consentTime: string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: 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: string ,
resourceGroupName: string ,
clusterName: string ,
arcSettingName: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AzureStackHCI/clusters
{
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
properties:
{
provisioningState: enum ,
status: enum ,
connectivityStatus: enum ,
cloudId: string ,
cloudManagementEndpoint: string ,
aadClientId: string ,
aadTenantId: string ,
aadApplicationObjectId: string ,
aadServicePrincipalObjectId: string ,
softwareAssuranceProperties:
{
softwareAssuranceStatus: enum ,
softwareAssuranceIntent: enum ,
lastUpdated: string ,
}
,
logCollectionProperties:
{
fromDate: string ,
toDate: string ,
lastLogGenerated: string ,
logCollectionSessionDetails:
[
{
logStartTime: string ,
logEndTime: string ,
timeCollected: string ,
logSize: integer ,
logCollectionStatus: enum ,
correlationId: string ,
logCollectionJobType: enum ,
endTimeCollected: string ,
logCollectionError:
{
errorCode: string ,
errorMessage: string ,
}
,
}
,
]
,
}
,
remoteSupportProperties:
{
accessLevel: enum ,
expirationTimeStamp: string ,
remoteSupportType: enum ,
remoteSupportNodeSettings:
[
{
arcResourceId: string ,
state: string ,
createdAt: string ,
updatedAt: string ,
connectionStatus: string ,
connectionErrorMessage: string ,
transcriptLocation: string ,
}
,
]
,
remoteSupportSessionDetails:
[
{
sessionStartTime: string ,
sessionEndTime: string ,
nodeName: string ,
duration: integer ,
accessLevel: enum ,
}
,
]
,
}
,
desiredProperties:
{
windowsServerSubscription: enum ,
diagnosticLevel: enum ,
}
,
reportedProperties:
{
clusterName: string ,
clusterId: string ,
clusterVersion: string ,
nodes:
[
{
name: string ,
id: number ,
windowsServerSubscription: enum ,
nodeType: enum ,
ehcResourceId: string ,
manufacturer: string ,
model: string ,
osName: string ,
osVersion: string ,
osDisplayVersion: string ,
serialNumber: string ,
coreCount: number ,
memoryInGiB: number ,
lastLicensingTimestamp: string ,
oemActivation: enum ,
}
,
]
,
lastUpdated: string ,
imdsAttestation: enum ,
diagnosticLevel: enum ,
supportedCapabilities:
[
string ,
]
,
clusterType: enum ,
manufacturer: string ,
oemActivation: enum ,
hardwareClass: enum ,
}
,
isolatedVmAttestationConfiguration:
{
attestationResourceId: string ,
relyingPartyServiceEndpoint: string ,
attestationServiceEndpoint: string ,
}
,
trialDaysRemaining: number ,
billingModel: string ,
registrationTimestamp: string ,
lastSyncTimestamp: string ,
lastBillingTimestamp: string ,
serviceEndpoint: string ,
resourceProviderObjectId: string ,
secretsLocations:
[
{
secretsType: enum ,
secretsLocation: string ,
}
,
]
,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: 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: string ,
resourceGroupName: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
properties:
{
provisioningState: enum ,
status: enum ,
connectivityStatus: enum ,
cloudId: string ,
cloudManagementEndpoint: string ,
aadClientId: string ,
aadTenantId: string ,
aadApplicationObjectId: string ,
aadServicePrincipalObjectId: string ,
softwareAssuranceProperties:
{
softwareAssuranceStatus: enum ,
softwareAssuranceIntent: enum ,
lastUpdated: string ,
}
,
logCollectionProperties:
{
fromDate: string ,
toDate: string ,
lastLogGenerated: string ,
logCollectionSessionDetails:
[
{
logStartTime: string ,
logEndTime: string ,
timeCollected: string ,
logSize: integer ,
logCollectionStatus: enum ,
correlationId: string ,
logCollectionJobType: enum ,
endTimeCollected: string ,
logCollectionError:
{
errorCode: string ,
errorMessage: string ,
}
,
}
,
]
,
}
,
remoteSupportProperties:
{
accessLevel: enum ,
expirationTimeStamp: string ,
remoteSupportType: enum ,
remoteSupportNodeSettings:
[
{
arcResourceId: string ,
state: string ,
createdAt: string ,
updatedAt: string ,
connectionStatus: string ,
connectionErrorMessage: string ,
transcriptLocation: string ,
}
,
]
,
remoteSupportSessionDetails:
[
{
sessionStartTime: string ,
sessionEndTime: string ,
nodeName: string ,
duration: integer ,
accessLevel: enum ,
}
,
]
,
}
,
desiredProperties:
{
windowsServerSubscription: enum ,
diagnosticLevel: enum ,
}
,
reportedProperties:
{
clusterName: string ,
clusterId: string ,
clusterVersion: string ,
nodes:
[
{
name: string ,
id: number ,
windowsServerSubscription: enum ,
nodeType: enum ,
ehcResourceId: string ,
manufacturer: string ,
model: string ,
osName: string ,
osVersion: string ,
osDisplayVersion: string ,
serialNumber: string ,
coreCount: number ,
memoryInGiB: number ,
lastLicensingTimestamp: string ,
oemActivation: enum ,
}
,
]
,
lastUpdated: string ,
imdsAttestation: enum ,
diagnosticLevel: enum ,
supportedCapabilities:
[
string ,
]
,
clusterType: enum ,
manufacturer: string ,
oemActivation: enum ,
hardwareClass: enum ,
}
,
isolatedVmAttestationConfiguration:
{
attestationResourceId: string ,
relyingPartyServiceEndpoint: string ,
attestationServiceEndpoint: string ,
}
,
trialDaysRemaining: number ,
billingModel: string ,
registrationTimestamp: string ,
lastSyncTimestamp: string ,
lastBillingTimestamp: string ,
serviceEndpoint: string ,
resourceProviderObjectId: string ,
secretsLocations:
[
{
secretsType: enum ,
secretsLocation: string ,
}
,
]
,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}
{
subscriptionId: string ,
resourceGroupName: string ,
clusterName: string ,
api-version: string ,
}

⚐ Response (200)

{
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
properties:
{
provisioningState: enum ,
status: enum ,
connectivityStatus: enum ,
cloudId: string ,
cloudManagementEndpoint: string ,
aadClientId: string ,
aadTenantId: string ,
aadApplicationObjectId: string ,
aadServicePrincipalObjectId: string ,
softwareAssuranceProperties:
{
softwareAssuranceStatus: enum ,
softwareAssuranceIntent: enum ,
lastUpdated: string ,
}
,
logCollectionProperties:
{
fromDate: string ,
toDate: string ,
lastLogGenerated: string ,
logCollectionSessionDetails:
[
{
logStartTime: string ,
logEndTime: string ,
timeCollected: string ,
logSize: integer ,
logCollectionStatus: enum ,
correlationId: string ,
logCollectionJobType: enum ,
endTimeCollected: string ,
logCollectionError:
{
errorCode: string ,
errorMessage: string ,
}
,
}
,
]
,
}
,
remoteSupportProperties:
{
accessLevel: enum ,
expirationTimeStamp: string ,
remoteSupportType: enum ,
remoteSupportNodeSettings:
[
{
arcResourceId: string ,
state: string ,
createdAt: string ,
updatedAt: string ,
connectionStatus: string ,
connectionErrorMessage: string ,
transcriptLocation: string ,
}
,
]
,
remoteSupportSessionDetails:
[
{
sessionStartTime: string ,
sessionEndTime: string ,
nodeName: string ,
duration: integer ,
accessLevel: enum ,
}
,
]
,
}
,
desiredProperties:
{
windowsServerSubscription: enum ,
diagnosticLevel: enum ,
}
,
reportedProperties:
{
clusterName: string ,
clusterId: string ,
clusterVersion: string ,
nodes:
[
{
name: string ,
id: number ,
windowsServerSubscription: enum ,
nodeType: enum ,
ehcResourceId: string ,
manufacturer: string ,
model: string ,
osName: string ,
osVersion: string ,
osDisplayVersion: string ,
serialNumber: string ,
coreCount: number ,
memoryInGiB: number ,
lastLicensingTimestamp: string ,
oemActivation: enum ,
}
,
]
,
lastUpdated: string ,
imdsAttestation: enum ,
diagnosticLevel: enum ,
supportedCapabilities:
[
string ,
]
,
clusterType: enum ,
manufacturer: string ,
oemActivation: enum ,
hardwareClass: enum ,
}
,
isolatedVmAttestationConfiguration:
{
attestationResourceId: string ,
relyingPartyServiceEndpoint: string ,
attestationServiceEndpoint: string ,
}
,
trialDaysRemaining: number ,
billingModel: string ,
registrationTimestamp: string ,
lastSyncTimestamp: string ,
lastBillingTimestamp: string ,
serviceEndpoint: string ,
resourceProviderObjectId: string ,
secretsLocations:
[
{
secretsType: enum ,
secretsLocation: string ,
}
,
]
,
}
,
}

⚐ Response (default)

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

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}
{
subscriptionId: string ,
resourceGroupName: string ,
clusterName: string ,
api-version: string ,
cluster:
{
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
properties:
{
provisioningState: enum ,
status: enum ,
connectivityStatus: enum ,
cloudId: string ,
cloudManagementEndpoint: string ,
aadClientId: string ,
aadTenantId: string ,
aadApplicationObjectId: string ,
aadServicePrincipalObjectId: string ,
softwareAssuranceProperties:
{
softwareAssuranceStatus: enum ,
softwareAssuranceIntent: enum ,
lastUpdated: string ,
}
,
logCollectionProperties:
{
fromDate: string ,
toDate: string ,
lastLogGenerated: string ,
logCollectionSessionDetails:
[
{
logStartTime: string ,
logEndTime: string ,
timeCollected: string ,
logSize: integer ,
logCollectionStatus: enum ,
correlationId: string ,
logCollectionJobType: enum ,
endTimeCollected: string ,
logCollectionError:
{
errorCode: string ,
errorMessage: string ,
}
,
}
,
]
,
}
,
remoteSupportProperties:
{
accessLevel: enum ,
expirationTimeStamp: string ,
remoteSupportType: enum ,
remoteSupportNodeSettings:
[
{
arcResourceId: string ,
state: string ,
createdAt: string ,
updatedAt: string ,
connectionStatus: string ,
connectionErrorMessage: string ,
transcriptLocation: string ,
}
,
]
,
remoteSupportSessionDetails:
[
{
sessionStartTime: string ,
sessionEndTime: string ,
nodeName: string ,
duration: integer ,
accessLevel: enum ,
}
,
]
,
}
,
desiredProperties:
{
windowsServerSubscription: enum ,
diagnosticLevel: enum ,
}
,
reportedProperties:
{
clusterName: string ,
clusterId: string ,
clusterVersion: string ,
nodes:
[
{
name: string ,
id: number ,
windowsServerSubscription: enum ,
nodeType: enum ,
ehcResourceId: string ,
manufacturer: string ,
model: string ,
osName: string ,
osVersion: string ,
osDisplayVersion: string ,
serialNumber: string ,
coreCount: number ,
memoryInGiB: number ,
lastLicensingTimestamp: string ,
oemActivation: enum ,
}
,
]
,
lastUpdated: string ,
imdsAttestation: enum ,
diagnosticLevel: enum ,
supportedCapabilities:
[
string ,
]
,
clusterType: enum ,
manufacturer: string ,
oemActivation: enum ,
hardwareClass: enum ,
}
,
isolatedVmAttestationConfiguration:
{
attestationResourceId: string ,
relyingPartyServiceEndpoint: string ,
attestationServiceEndpoint: string ,
}
,
trialDaysRemaining: number ,
billingModel: string ,
registrationTimestamp: string ,
lastSyncTimestamp: string ,
lastBillingTimestamp: string ,
serviceEndpoint: string ,
resourceProviderObjectId: string ,
secretsLocations:
[
{
secretsType: enum ,
secretsLocation: string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
properties:
{
provisioningState: enum ,
status: enum ,
connectivityStatus: enum ,
cloudId: string ,
cloudManagementEndpoint: string ,
aadClientId: string ,
aadTenantId: string ,
aadApplicationObjectId: string ,
aadServicePrincipalObjectId: string ,
softwareAssuranceProperties:
{
softwareAssuranceStatus: enum ,
softwareAssuranceIntent: enum ,
lastUpdated: string ,
}
,
logCollectionProperties:
{
fromDate: string ,
toDate: string ,
lastLogGenerated: string ,
logCollectionSessionDetails:
[
{
logStartTime: string ,
logEndTime: string ,
timeCollected: string ,
logSize: integer ,
logCollectionStatus: enum ,
correlationId: string ,
logCollectionJobType: enum ,
endTimeCollected: string ,
logCollectionError:
{
errorCode: string ,
errorMessage: string ,
}
,
}
,
]
,
}
,
remoteSupportProperties:
{
accessLevel: enum ,
expirationTimeStamp: string ,
remoteSupportType: enum ,
remoteSupportNodeSettings:
[
{
arcResourceId: string ,
state: string ,
createdAt: string ,
updatedAt: string ,
connectionStatus: string ,
connectionErrorMessage: string ,
transcriptLocation: string ,
}
,
]
,
remoteSupportSessionDetails:
[
{
sessionStartTime: string ,
sessionEndTime: string ,
nodeName: string ,
duration: integer ,
accessLevel: enum ,
}
,
]
,
}
,
desiredProperties:
{
windowsServerSubscription: enum ,
diagnosticLevel: enum ,
}
,
reportedProperties:
{
clusterName: string ,
clusterId: string ,
clusterVersion: string ,
nodes:
[
{
name: string ,
id: number ,
windowsServerSubscription: enum ,
nodeType: enum ,
ehcResourceId: string ,
manufacturer: string ,
model: string ,
osName: string ,
osVersion: string ,
osDisplayVersion: string ,
serialNumber: string ,
coreCount: number ,
memoryInGiB: number ,
lastLicensingTimestamp: string ,
oemActivation: enum ,
}
,
]
,
lastUpdated: string ,
imdsAttestation: enum ,
diagnosticLevel: enum ,
supportedCapabilities:
[
string ,
]
,
clusterType: enum ,
manufacturer: string ,
oemActivation: enum ,
hardwareClass: enum ,
}
,
isolatedVmAttestationConfiguration:
{
attestationResourceId: string ,
relyingPartyServiceEndpoint: string ,
attestationServiceEndpoint: string ,
}
,
trialDaysRemaining: number ,
billingModel: string ,
registrationTimestamp: string ,
lastSyncTimestamp: string ,
lastBillingTimestamp: string ,
serviceEndpoint: string ,
resourceProviderObjectId: string ,
secretsLocations:
[
{
secretsType: enum ,
secretsLocation: string ,
}
,
]
,
}
,
}

⚐ Response (default)

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

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}
{
subscriptionId: string ,
resourceGroupName: string ,
clusterName: string ,
api-version: string ,
cluster:
{
tags: object ,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
properties:
{
cloudManagementEndpoint: string ,
aadClientId: string ,
aadTenantId: string ,
desiredProperties:
{
windowsServerSubscription: enum ,
diagnosticLevel: enum ,
}
,
}
,
}
,
}

⚐ Response (200)

{
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
properties:
{
provisioningState: enum ,
status: enum ,
connectivityStatus: enum ,
cloudId: string ,
cloudManagementEndpoint: string ,
aadClientId: string ,
aadTenantId: string ,
aadApplicationObjectId: string ,
aadServicePrincipalObjectId: string ,
softwareAssuranceProperties:
{
softwareAssuranceStatus: enum ,
softwareAssuranceIntent: enum ,
lastUpdated: string ,
}
,
logCollectionProperties:
{
fromDate: string ,
toDate: string ,
lastLogGenerated: string ,
logCollectionSessionDetails:
[
{
logStartTime: string ,
logEndTime: string ,
timeCollected: string ,
logSize: integer ,
logCollectionStatus: enum ,
correlationId: string ,
logCollectionJobType: enum ,
endTimeCollected: string ,
logCollectionError:
{
errorCode: string ,
errorMessage: string ,
}
,
}
,
]
,
}
,
remoteSupportProperties:
{
accessLevel: enum ,
expirationTimeStamp: string ,
remoteSupportType: enum ,
remoteSupportNodeSettings:
[
{
arcResourceId: string ,
state: string ,
createdAt: string ,
updatedAt: string ,
connectionStatus: string ,
connectionErrorMessage: string ,
transcriptLocation: string ,
}
,
]
,
remoteSupportSessionDetails:
[
{
sessionStartTime: string ,
sessionEndTime: string ,
nodeName: string ,
duration: integer ,
accessLevel: enum ,
}
,
]
,
}
,
desiredProperties:
{
windowsServerSubscription: enum ,
diagnosticLevel: enum ,
}
,
reportedProperties:
{
clusterName: string ,
clusterId: string ,
clusterVersion: string ,
nodes:
[
{
name: string ,
id: number ,
windowsServerSubscription: enum ,
nodeType: enum ,
ehcResourceId: string ,
manufacturer: string ,
model: string ,
osName: string ,
osVersion: string ,
osDisplayVersion: string ,
serialNumber: string ,
coreCount: number ,
memoryInGiB: number ,
lastLicensingTimestamp: string ,
oemActivation: enum ,
}
,
]