azure.mgmt.hdinsight.models module¶
-
exception
azure.mgmt.hdinsight.models.ErrorResponseException(deserialize, response, *args)[source]¶ Bases:
msrest.exceptions.HttpOperationErrorServer responsed with exception of type: ‘ErrorResponse’.
Parameters: - deserialize – A deserializer
- response – Server response to be deserialized.
-
class
azure.mgmt.hdinsight.models.ClusterDefinition(*, blueprint: str = None, kind: str = None, component_version=None, configurations=None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelThe cluster definition.
Parameters:
-
class
azure.mgmt.hdinsight.models.SecurityProfile(*, directory_type=None, domain: str = None, organizational_unit_dn: str = None, ldaps_urls=None, domain_username: str = None, domain_user_password: str = None, cluster_users_group_dns=None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelThe security profile which contains Ssh public key for the HDInsight cluster.
Parameters: - directory_type (str or DirectoryType) – The directory type. Possible values include: ‘ActiveDirectory’
- domain (str) – The organization’s active directory domain.
- organizational_unit_dn (str) – The organizational unit within the Active Directory to place the cluster and service accounts.
- ldaps_urls (list[str]) – The LDAPS protocol URLs to communicate with the Active Directory.
- domain_username (str) – The domain user account that will have admin privileges on the cluster.
- domain_user_password (str) – The domain admin password.
- cluster_users_group_dns (list[str]) – Optional. The Distinguished Names for cluster user groups
-
class
azure.mgmt.hdinsight.models.HardwareProfile(*, vm_size: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelThe hardware profile.
Parameters: vm_size (str) – The size of the VM
-
class
azure.mgmt.hdinsight.models.VirtualNetworkProfile(*, id: str = None, subnet: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelThe virtual network properties.
Parameters:
-
class
azure.mgmt.hdinsight.models.DataDisksGroups(*, disks_per_node: int = None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelThe data disks groups for the role.
Variables are only populated by the server, and will be ignored when sending a request.
Parameters: disks_per_node (int) – The number of disks per node.
Variables:
-
class
azure.mgmt.hdinsight.models.SshPublicKey(*, certificate_data: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelThe SSH public key for the cluster nodes.
Parameters: certificate_data (str) – The certificate for SSH.
-
class
azure.mgmt.hdinsight.models.SshProfile(*, public_keys=None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelThe list of SSH public keys.
Parameters: public_keys (list[SshPublicKey]) – The list of SSH public keys.
-
class
azure.mgmt.hdinsight.models.LinuxOperatingSystemProfile(*, username: str = None, password: str = None, ssh_profile=None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelThe ssh username, password, and ssh public key.
Parameters: - username (str) – The username.
- password (str) – The password.
- ssh_profile (SshProfile) – The SSH profile.
-
class
azure.mgmt.hdinsight.models.OsProfile(*, linux_operating_system_profile=None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelThe Linux operation systems profile.
Parameters: linux_operating_system_profile (LinuxOperatingSystemProfile) – The Linux OS profile.
-
class
azure.mgmt.hdinsight.models.ScriptAction(*, name: str, uri: str, parameters: str, **kwargs)[source]¶ Bases:
msrest.serialization.ModelDescribes a script action on role on the cluster.
All required parameters must be populated in order to send to Azure.
Parameters:
-
class
azure.mgmt.hdinsight.models.Role(*, name: str = None, min_instance_count: int = None, target_instance_count: int = None, hardware_profile=None, os_profile=None, virtual_network_profile=None, data_disks_groups=None, script_actions=None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelDescribes a role on the cluster.
Parameters: - name (str) – The name of the role.
- min_instance_count (int) – The minimum instance count of the cluster.
- target_instance_count (int) – The instance count of the cluster.
- hardware_profile (HardwareProfile) – The hardware profile.
- os_profile (OsProfile) – The operating system profile.
- virtual_network_profile (VirtualNetworkProfile) – The virtual network profile.
- data_disks_groups (list[DataDisksGroups]) – The data disks groups for the role.
- script_actions (list[ScriptAction]) – The list of script actions on the role.
-
class
azure.mgmt.hdinsight.models.ComputeProfile(*, roles=None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelDescribes the compute profile.
Parameters: roles (list[Role]) – The list of roles in the cluster.
-
class
azure.mgmt.hdinsight.models.StorageAccount(*, name: str = None, is_default: bool = None, container: str = None, file_system: str = None, key: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelThe storage Account.
Parameters: - name (str) – The name of the storage account.
- is_default (bool) – Whether or not the storage account is the default storage account.
- container (str) – The container in the storage account, only to be specified for WASB storage accounts.
- file_system (str) – The filesystem, only to be specified for Azure Data Lake Storage Gen 2.
- key (str) – The storage account access key.
-
class
azure.mgmt.hdinsight.models.StorageProfile(*, storageaccounts=None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelThe storage profile.
Parameters: storageaccounts (list[StorageAccount]) – The list of storage accounts in the cluster.
-
class
azure.mgmt.hdinsight.models.ClusterCreateProperties(*, cluster_version: str = None, os_type=None, tier=None, cluster_definition=None, security_profile=None, compute_profile=None, storage_profile=None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelThe cluster create parameters.
Parameters: - cluster_version (str) – The version of the cluster.
- os_type (str or OSType) – The type of operating system. Possible values include: ‘Windows’, ‘Linux’
- tier (str or Tier) – The cluster tier. Possible values include: ‘Standard’, ‘Premium’
- cluster_definition (ClusterDefinition) – The cluster definition.
- security_profile (SecurityProfile) – The security profile.
- compute_profile (ComputeProfile) – The compute profile.
- storage_profile (StorageProfile) – The storage profile.
-
class
azure.mgmt.hdinsight.models.ClusterCreateParametersExtended(*, location: str = None, tags=None, properties=None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelThe CreateCluster request parameters.
Parameters: - location (str) – The location of the cluster.
- tags (dict[str, str]) – The resource tags.
- properties (ClusterCreateProperties) – The cluster create parameters.
-
class
azure.mgmt.hdinsight.models.ClusterPatchParameters(*, tags=None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelThe PatchCluster request parameters.
Parameters: tags (dict[str, str]) – The resource tags.
-
class
azure.mgmt.hdinsight.models.QuotaInfo(*, cores_used: int = None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelThe quota properties for the cluster.
Parameters: cores_used (int) – The cores used by the cluster.
-
class
azure.mgmt.hdinsight.models.Errors(*, code: str = None, message: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelThe error message associated with the cluster creation.
Parameters:
-
class
azure.mgmt.hdinsight.models.ConnectivityEndpoint(*, name: str = None, protocol: str = None, location: str = None, port: int = None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelThe connectivity properties.
Parameters:
-
class
azure.mgmt.hdinsight.models.ClusterGetProperties(*, cluster_definition, cluster_version: str = None, os_type=None, tier=None, security_profile=None, compute_profile=None, provisioning_state=None, created_date: str = None, cluster_state: str = None, quota_info=None, errors=None, connectivity_endpoints=None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelThe properties of cluster.
All required parameters must be populated in order to send to Azure.
Parameters: - cluster_version (str) – The version of the cluster.
- os_type (str or OSType) – The type of operating system. Possible values include: ‘Windows’, ‘Linux’
- tier (str or Tier) – The cluster tier. Possible values include: ‘Standard’, ‘Premium’
- cluster_definition (ClusterDefinition) – Required. The cluster definition.
- 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. Possible values include: ‘InProgress’, ‘Failed’, ‘Succeeded’, ‘Canceled’, ‘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.
-
class
azure.mgmt.hdinsight.models.Cluster(*, location: str = None, tags=None, etag: str = None, properties=None, **kwargs)[source]¶ Bases:
azure.mgmt.hdinsight.models.tracked_resource_py3.TrackedResourceThe HDInsight cluster.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters:
-
class
azure.mgmt.hdinsight.models.RuntimeScriptAction(*, name: str, uri: str, roles, parameters: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelDescribes a script action on a running 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 Azure.
Parameters: Variables: application_name (str) – The application name of the script action, if any.
-
class
azure.mgmt.hdinsight.models.ExecuteScriptActionParameters(*, persist_on_success: bool, script_actions=None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelThe parameters for the script actions to execute on a running cluster.
All required parameters must be populated in order to send to Azure.
Parameters: - script_actions (list[RuntimeScriptAction]) – The list of run time script actions.
- persist_on_success (bool) – Required. Gets or sets if the scripts needs to be persisted.
-
class
azure.mgmt.hdinsight.models.ClusterListPersistedScriptActionsResult(*, value=None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelThe ListPersistedScriptActions operation response.
Variables are only populated by the server, and will be ignored when sending a request.
Parameters: value (list[RuntimeScriptAction]) – The list of Persisted Script Actions. Variables: next_link (str) – The link (url) to the next page of results.
-
class
azure.mgmt.hdinsight.models.ScriptActionExecutionSummary(**kwargs)[source]¶ Bases:
msrest.serialization.ModelThe execution summary of a script action.
Variables are only populated by the server, and will be ignored when sending a request.
Variables:
-
class
azure.mgmt.hdinsight.models.RuntimeScriptActionDetail(*, name: str, uri: str, roles, parameters: str = None, **kwargs)[source]¶ Bases:
azure.mgmt.hdinsight.models.runtime_script_action_py3.RuntimeScriptActionThe execution details of a script action.
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.
Parameters: Variables: - application_name (str) – The application name of the script action, if any.
- script_execution_id (long) – The execution id of the script action.
- start_time (str) – The start time of script action execution.
- end_time (str) – The end time of script action execution.
- status (str) – The current execution status of the script action.
- operation (str) – The reason why the script action was executed.
- execution_summary (list[ScriptActionExecutionSummary]) – The summary of script action execution result.
- debug_information (str) – The script action execution debug information.
-
class
azure.mgmt.hdinsight.models.ClusterListRuntimeScriptActionDetailResult(**kwargs)[source]¶ Bases:
msrest.serialization.ModelThe list runtime script action detail response.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: - value (list[RuntimeScriptActionDetail]) – The list of persisted script action details for the cluster.
- next_link (str) – The link (url) to the next page of results.
-
class
azure.mgmt.hdinsight.models.ClusterResizeParameters(*, target_instance_count: int = None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelThe Resize Cluster request parameters.
Parameters: target_instance_count (int) – The target instance count for the operation.
-
class
azure.mgmt.hdinsight.models.OperationResource(*, status=None, error=None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelThe azure async operation response.
Parameters: - status (str or AsyncOperationState) – The async operation state. Possible values include: ‘InProgress’, ‘Succeeded’, ‘Failed’
- error (Errors) – The operation error information.
-
class
azure.mgmt.hdinsight.models.Resource(**kwargs)[source]¶ Bases:
msrest.serialization.ModelThe core properties of ARM resources.
Variables are only populated by the server, and will be ignored when sending a request.
Variables:
-
class
azure.mgmt.hdinsight.models.TrackedResource(*, location: str = None, tags=None, **kwargs)[source]¶ Bases:
azure.mgmt.hdinsight.models.resource_py3.ResourceThe resource model definition for a ARM tracked top level resource.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters:
-
class
azure.mgmt.hdinsight.models.ProxyResource(**kwargs)[source]¶ Bases:
azure.mgmt.hdinsight.models.resource_py3.ResourceThe resource model definition for a ARM proxy resource. It will have everything other than required location and tags.
Variables are only populated by the server, and will be ignored when sending a request.
Variables:
-
class
azure.mgmt.hdinsight.models.ErrorResponse(*, code: str = None, message: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelDescribes the format of Error response.
Parameters:
-
class
azure.mgmt.hdinsight.models.ApplicationGetHttpsEndpoint(*, additional_properties=None, access_modes=None, location: str = None, destination_port: int = None, public_port: int = None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelGets the application HTTP endpoints.
Parameters: - additional_properties (dict[str, str]) – Unmatched properties from the message are deserialized this collection
- access_modes (list[str]) – The list of access modes for the application.
- location (str) – The location of the endpoint.
- destination_port (int) – The destination port to connect to.
- public_port (int) – The public port to connect to.
-
class
azure.mgmt.hdinsight.models.ApplicationGetEndpoint(*, location: str = None, destination_port: int = None, public_port: int = None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelGets the application SSH endpoint.
Parameters:
-
class
azure.mgmt.hdinsight.models.ApplicationProperties(*, compute_profile=None, install_script_actions=None, uninstall_script_actions=None, https_endpoints=None, ssh_endpoints=None, application_type: str = None, errors=None, additional_properties: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelThe HDInsight cluster application GET response.
Variables are only populated by the server, and will be ignored when sending a request.
Parameters: - compute_profile (ComputeProfile) – The list of roles in the cluster.
- install_script_actions (list[RuntimeScriptAction]) – The list of install script actions.
- uninstall_script_actions (list[RuntimeScriptAction]) – The list of uninstall script actions.
- https_endpoints (list[ApplicationGetHttpsEndpoint]) – The list of application HTTPS endpoints.
- ssh_endpoints (list[ApplicationGetEndpoint]) – The list of application SSH endpoints.
- application_type (str) – The application type.
- errors (list[Errors]) – The list of errors.
- additional_properties (str) – The additional properties for application.
Variables:
-
class
azure.mgmt.hdinsight.models.Application(*, etag: str = None, tags=None, properties=None, **kwargs)[source]¶ Bases:
azure.mgmt.hdinsight.models.proxy_resource_py3.ProxyResourceThe HDInsight cluster application.
Variables are only populated by the server, and will be ignored when sending a request.
Variables: Parameters: - etag (str) – The ETag for the application
- tags (dict[str, str]) – The tags for the application.
- properties (ApplicationProperties) – The properties of the application.
-
class
azure.mgmt.hdinsight.models.VersionSpec(*, friendly_name: str = None, display_name: str = None, is_default: str = None, component_versions=None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelThe version properties.
Parameters:
-
class
azure.mgmt.hdinsight.models.VersionsCapability(*, available=None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelThe version capability.
Parameters: available (list[VersionSpec]) – The list of version capabilities.
-
class
azure.mgmt.hdinsight.models.RegionsCapability(*, available=None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelThe regions capability.
Parameters: available (list[str]) – The list of region capabilities.
-
class
azure.mgmt.hdinsight.models.VmSizesCapability(*, available=None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelThe virtual machine sizes capability.
Parameters: available (list[str]) – The list of virtual machine size capabilities.
-
class
azure.mgmt.hdinsight.models.VmSizeCompatibilityFilter(*, filter_mode: str = None, regions=None, cluster_flavors=None, node_types=None, cluster_versions=None, vmsizes=None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelThe virtual machine type compatibility filter.
Parameters: - filter_mode (str) – The mode for the filter.
- regions (list[str]) – The list of regions.
- cluster_flavors (list[str]) – The list of cluster types available.
- node_types (list[str]) – The list of node types.
- cluster_versions (list[str]) – The list of cluster versions.
- vmsizes (list[str]) – The list of virtual machine sizes.
-
class
azure.mgmt.hdinsight.models.RegionalQuotaCapability(*, region_name: str = None, cores_used: int = None, cores_available: int = None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelThe regional quota capacity.
Parameters: - region_name (str) – The region name.
- cores_used (long) – The number of cores used in the region.
- cores_available (long) – The number of courses available in the region.
-
class
azure.mgmt.hdinsight.models.QuotaCapability(*, regional_quotas=None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelThe regional quota capability.
Parameters: regional_quotas (list[RegionalQuotaCapability]) – The list of region quota capabilities.
-
class
azure.mgmt.hdinsight.models.CapabilitiesResult(*, versions=None, regions=None, vm_sizes=None, vm_size_filters=None, features=None, quota=None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelThe Get Capabilities operation response.
Parameters: - versions (dict[str, VersionsCapability]) – The version capability.
- regions (dict[str, RegionsCapability]) – The virtual machine size compatibilty features.
- vm_sizes (dict[str, VmSizesCapability]) – The virtual machine sizes.
- vm_size_filters (list[VmSizeCompatibilityFilter]) – The virtual machine size compatibilty filters.
- features (list[str]) – The capabilty features.
- quota (QuotaCapability) – The quota capability.
-
class
azure.mgmt.hdinsight.models.LocalizedName(*, value: str = None, localized_value: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelThe details about the localizable name of a type of usage.
Parameters:
-
class
azure.mgmt.hdinsight.models.Usage(*, unit: str = None, current_value: int = None, limit: int = None, name=None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelThe details about the usage of a particular limited resource.
Parameters: - unit (str) – The type of measurement for usage.
- current_value (int) – The current usage.
- limit (int) – The maximum allowed usage.
- name (LocalizedName) – The details about the localizable name of the used resource.
-
class
azure.mgmt.hdinsight.models.UsagesListResult(*, value=None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelThe response for the operation to get regional usages for a subscription.
Parameters: value (list[Usage]) – The list of usages.
-
class
azure.mgmt.hdinsight.models.Extension(*, workspace_id: str = None, primary_key: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelCluster monitoring extensions.
Parameters:
-
class
azure.mgmt.hdinsight.models.ClusterMonitoringResponse(*, cluster_monitoring_enabled: bool = None, workspace_id: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelThe Operations Management Suite (OMS) status response.
Parameters:
-
class
azure.mgmt.hdinsight.models.ClusterMonitoringRequest(*, workspace_id: str = None, primary_key: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelThe Operations Management Suite (OMS) parameters.
Parameters:
-
class
azure.mgmt.hdinsight.models.ScriptActionPersistedGetResponseSpec(*, name: str = None, uri: str = None, parameters: str = None, roles=None, application_name: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelThe persisted script action for cluster.
Parameters:
-
class
azure.mgmt.hdinsight.models.OperationDisplay(*, provider: str = None, resource: str = None, operation: str = None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelThe object that represents the operation.
Parameters:
-
class
azure.mgmt.hdinsight.models.Operation(*, name: str = None, display=None, **kwargs)[source]¶ Bases:
msrest.serialization.ModelThe HDInsight REST API operation.
Parameters: - name (str) – The operation name: {provider}/{resource}/{operation}
- display (OperationDisplay) – The object that represents the operation.
-
class
azure.mgmt.hdinsight.models.ClusterPaged(*args, **kwargs)[source]¶ Bases:
msrest.paging.PagedA paging container for iterating over a list of
Clusterobject
-
class
azure.mgmt.hdinsight.models.ApplicationPaged(*args, **kwargs)[source]¶ Bases:
msrest.paging.PagedA paging container for iterating over a list of
Applicationobject
-
class
azure.mgmt.hdinsight.models.RuntimeScriptActionDetailPaged(*args, **kwargs)[source]¶ Bases:
msrest.paging.PagedA paging container for iterating over a list of
RuntimeScriptActionDetailobject
-
class
azure.mgmt.hdinsight.models.OperationPaged(*args, **kwargs)[source]¶ Bases:
msrest.paging.PagedA paging container for iterating over a list of
Operationobject
-
class
azure.mgmt.hdinsight.models.DirectoryType[source]¶ -
An enumeration.
-
active_directory= 'ActiveDirectory'¶
-
-
class
azure.mgmt.hdinsight.models.OSType[source]¶ -
An enumeration.
-
linux= 'Linux'¶
-
windows= 'Windows'¶
-