Cluster Class

Cluster details.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Inheritance

azure.mgmt.azurestackhci.models._models_py3.TrackedResource

Cluster

Constructor

Cluster(*, location: str, tags: Optional[Dict[str, str]] = None, cloud_management_endpoint: Optional[str] = None, aad_client_id: Optional[str] = None, aad_tenant_id: Optional[str] = None, aad_application_object_id: Optional[str] = None, aad_service_principal_object_id: Optional[str] = None, desired_properties: Optional[azure.mgmt.azurestackhci.models._models_py3.ClusterDesiredProperties] = None, created_by: Optional[str] = None, created_by_type: Optional[Union[str, azure.mgmt.azurestackhci.models._azure_stack_hci_client_enums.CreatedByType]] = None, created_at: Optional[datetime.datetime] = None, last_modified_by: Optional[str] = None, last_modified_by_type: Optional[Union[str, azure.mgmt.azurestackhci.models._azure_stack_hci_client_enums.CreatedByType]] = None, last_modified_at: Optional[datetime.datetime] = None, **kwargs)

Variables

id

str

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

name

str

The name of the resource.

type

str

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

tags

dict[str, str]

A set of tags. Resource tags.

location

str

Required. The geo-location where the resource lives.

provisioning_state

str or ProvisioningState

Provisioning state. Possible values include: "Succeeded", "Failed", "Canceled", "Accepted", "Provisioning".

status

str or Status

Status of the cluster agent. Possible values include: "NotYetRegistered", "ConnectedRecently", "NotConnectedRecently", "Disconnected", "Error".

cloud_id

str

Unique, immutable resource id.

cloud_management_endpoint

str

Endpoint configured for management from the Azure portal.

aad_client_id

str

App id of cluster AAD identity.

aad_tenant_id

str

Tenant id of cluster AAD identity.

aad_application_object_id

str

Object id of cluster AAD identity.

aad_service_principal_object_id

str

Id of cluster identity service principal.

desired_properties

ClusterDesiredProperties

Desired properties of the cluster.

reported_properties

ClusterReportedProperties

Properties reported by cluster agent.

trial_days_remaining

float

Number of days remaining in the trial period.

billing_model

str

Type of billing applied to the resource.

registration_timestamp

datetime

First cluster sync timestamp.

last_sync_timestamp

datetime

Most recent cluster sync timestamp.

last_billing_timestamp

datetime

Most recent billing meter timestamp.

service_endpoint

str

Region specific DataPath Endpoint of the cluster.

created_by

str

The identity that created the resource.

created_by_type

str or CreatedByType

The type of identity that created the resource. Possible values include: "User", "Application", "ManagedIdentity", "Key".

created_at

datetime

The timestamp of resource creation (UTC).

last_modified_by

str

The identity that last modified the resource.

last_modified_by_type

str or CreatedByType

The type of identity that last modified the resource. Possible values include: "User", "Application", "ManagedIdentity", "Key".

last_modified_at

datetime

The timestamp of resource last modification (UTC).