ClusterGetProperties Class

The properties of cluster.

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 server.

Constructor

ClusterGetProperties(*, cluster_definition: _models.ClusterDefinition, cluster_version: str | None = None, cluster_hdp_version: str | None = None, os_type: str | _models.OSType | None = None, tier: str | _models.Tier | None = None, cluster_id: str | None = None, kafka_rest_properties: _models.KafkaRestProperties | None = None, security_profile: _models.SecurityProfile | None = None, compute_profile: _models.ComputeProfile | None = None, provisioning_state: str | _models.HDInsightClusterProvisioningState | None = None, created_date: str | None = None, cluster_state: str | None = None, quota_info: _models.QuotaInfo | None = None, errors: list['_models.Errors'] | None = None, connectivity_endpoints: list['_models.ConnectivityEndpoint'] | None = None, disk_encryption_properties: _models.DiskEncryptionProperties | None = None, encryption_in_transit_properties: _models.EncryptionInTransitProperties | None = None, storage_profile: _models.StorageProfile | None = None, min_supported_tls_version: str | None = None, excluded_services_config: _models.ExcludedServicesConfig | None = None, network_properties: _models.NetworkProperties | None = None, compute_isolation_properties: _models.ComputeIsolationProperties | None = None, private_link_configurations: list['_models.PrivateLinkConfiguration'] | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
cluster_version	str The version of the cluster. Default value: None
cluster_hdp_version	str The hdp version of the cluster. Default value: None
os_type	str or OSType The type of operating system. Known values are: "Windows" and "Linux". Default value: None
tier	str or Tier The cluster tier. Known values are: "Standard" and "Premium". Default value: None
cluster_id	str The cluster id. Default value: None
cluster_definition	ClusterDefinition The cluster definition. Required.
kafka_rest_properties	KafkaRestProperties The cluster kafka rest proxy configuration. Default value: None
security_profile	SecurityProfile The security profile. Default value: None
compute_profile	ComputeProfile The compute profile. Default value: None
provisioning_state	str or HDInsightClusterProvisioningState The provisioning state, which only appears in the response. Known values are: "InProgress", "Failed", "Succeeded", "Canceled", and "Deleting". Default value: None
created_date	str The date on which the cluster was created. Default value: None
cluster_state	str The state of the cluster. Default value: None
quota_info	QuotaInfo The quota information. Default value: None
errors	list[Errors] The list of errors. Default value: None
connectivity_endpoints	list[ConnectivityEndpoint] The list of connectivity endpoints. Default value: None
disk_encryption_properties	DiskEncryptionProperties The disk encryption properties. Default value: None
encryption_in_transit_properties	EncryptionInTransitProperties The encryption-in-transit properties. Default value: None
storage_profile	StorageProfile The storage profile. Default value: None
min_supported_tls_version	str The minimal supported tls version. Default value: None
excluded_services_config	ExcludedServicesConfig The excluded services config. Default value: None
network_properties	NetworkProperties The network properties. Default value: None
compute_isolation_properties	ComputeIsolationProperties The compute isolation properties. Default value: None
private_link_configurations	list[PrivateLinkConfiguration] The private link configurations. Default value: None

Variables

Name	Description
cluster_version	str The version of the cluster.
cluster_hdp_version	str The hdp version of the cluster.
os_type	str or OSType The type of operating system. Known values are: "Windows" and "Linux".
tier	str or Tier The cluster tier. Known values are: "Standard" and "Premium".
cluster_id	str The cluster id.
cluster_definition	ClusterDefinition The cluster definition. Required.
kafka_rest_properties	KafkaRestProperties The cluster kafka rest proxy configuration.
security_profile	SecurityProfile The security profile.
compute_profile	ComputeProfile The compute profile.
provisioning_state	str or HDInsightClusterProvisioningState The provisioning state, which only appears in the response. Known values are: "InProgress", "Failed", "Succeeded", "Canceled", and "Deleting".
created_date	str The date on which the cluster was created.
cluster_state	str The state of the cluster.
quota_info	QuotaInfo The quota information.
errors	list[Errors] The list of errors.
connectivity_endpoints	list[ConnectivityEndpoint] The list of connectivity endpoints.
disk_encryption_properties	DiskEncryptionProperties The disk encryption properties.
encryption_in_transit_properties	EncryptionInTransitProperties The encryption-in-transit properties.
storage_profile	StorageProfile The storage profile.
min_supported_tls_version	str The minimal supported tls version.
excluded_services_config	ExcludedServicesConfig The excluded services config.
network_properties	NetworkProperties The network properties.
compute_isolation_properties	ComputeIsolationProperties The compute isolation properties.
private_link_configurations	list[PrivateLinkConfiguration] The private link configurations.
private_endpoint_connections	list[PrivateEndpointConnection] The list of private endpoint connections.

Feedback

Was this page helpful?