azure.mgmt.batchai.operations module¶
-
class
azure.mgmt.batchai.operations.
Operations
(client, config, serializer, deserializer)[source]¶ Bases:
object
Operations operations.
Parameters: - client – Client for service requests.
- config – Configuration of service client.
- serializer – An object model serializer.
- deserializer – An object model deserializer.
Variables: api_version – Specifies the version of API used for this request. Constant value: “2018-05-01”.
-
list
(custom_headers=None, raw=False, **operation_config)[source]¶ Lists available operations for the Microsoft.BatchAI provider.
Parameters: - custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of Operation
Return type: Raises: CloudError
-
models
= <module 'azure.mgmt.batchai.models' from '/usr/lib/python3/dist-packages/azure/mgmt/batchai/models/__init__.py'>¶
-
class
azure.mgmt.batchai.operations.
UsagesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
UsagesOperations operations.
Parameters: - client – Client for service requests.
- config – Configuration of service client.
- serializer – An object model serializer.
- deserializer – An object model deserializer.
Variables: api_version – Specifies the version of API used for this request. Constant value: “2018-05-01”.
-
list
(location, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the current usage information as well as limits for Batch AI resources for given subscription.
Parameters: - location (str) – The location for which resource usage is queried.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of Usage
Return type: Raises: CloudError
-
models
= <module 'azure.mgmt.batchai.models' from '/usr/lib/python3/dist-packages/azure/mgmt/batchai/models/__init__.py'>¶
-
class
azure.mgmt.batchai.operations.
WorkspacesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
WorkspacesOperations operations.
Parameters: - client – Client for service requests.
- config – Configuration of service client.
- serializer – An object model serializer.
- deserializer – An object model deserializer.
Variables: api_version – Specifies the version of API used for this request. Constant value: “2018-05-01”.
-
create
(resource_group_name, workspace_name, location, tags=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Creates a Workspace.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- workspace_name (str) – The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- location (str) – The region in which to create the Workspace.
- tags (dict[str, str]) – The user specified tags associated with the Workspace.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns Workspace or ClientRawResponse<Workspace> if raw==True
Return type: AzureOperationPoller[Workspace] or AzureOperationPoller[ClientRawResponse[Workspace]]
Raises: CloudError
-
delete
(resource_group_name, workspace_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Deletes a Workspace.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- workspace_name (str) – The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
Return type: AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
Raises: CloudError
-
get
(resource_group_name, workspace_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets information about a Workspace.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- workspace_name (str) – The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: Workspace or ClientRawResponse if raw=true
Return type: Workspace or ClientRawResponse
Raises: CloudError
-
list
(workspaces_list_options=None, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a list of Workspaces associated with the given subscription.
Parameters: - workspaces_list_options (WorkspacesListOptions) – Additional parameters for the operation
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of Workspace
Return type: Raises: CloudError
-
list_by_resource_group
(resource_group_name, workspaces_list_by_resource_group_options=None, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a list of Workspaces within the specified resource group.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- workspaces_list_by_resource_group_options (WorkspacesListByResourceGroupOptions) – Additional parameters for the operation
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of Workspace
Return type: Raises: CloudError
-
update
(resource_group_name, workspace_name, tags=None, custom_headers=None, raw=False, **operation_config)[source]¶ Updates properties of a Workspace.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- workspace_name (str) – The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- tags (dict[str, str]) – The user specified tags associated with the Workspace.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: Workspace or ClientRawResponse if raw=true
Return type: Workspace or ClientRawResponse
Raises: CloudError
-
models
= <module 'azure.mgmt.batchai.models' from '/usr/lib/python3/dist-packages/azure/mgmt/batchai/models/__init__.py'>¶
-
class
azure.mgmt.batchai.operations.
ExperimentsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ExperimentsOperations operations.
Parameters: - client – Client for service requests.
- config – Configuration of service client.
- serializer – An object model serializer.
- deserializer – An object model deserializer.
Variables: api_version – Specifies the version of API used for this request. Constant value: “2018-05-01”.
-
create
(resource_group_name, workspace_name, experiment_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Creates an Experiment.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- workspace_name (str) – The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- experiment_name (str) – The name of the experiment. Experiment names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns Experiment or ClientRawResponse<Experiment> if raw==True
Return type: AzureOperationPoller[Experiment] or AzureOperationPoller[ClientRawResponse[Experiment]]
Raises: CloudError
-
delete
(resource_group_name, workspace_name, experiment_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Deletes an Experiment.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- workspace_name (str) – The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- experiment_name (str) – The name of the experiment. Experiment names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
Return type: AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
Raises: CloudError
-
get
(resource_group_name, workspace_name, experiment_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets information about an Experiment.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- workspace_name (str) – The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- experiment_name (str) – The name of the experiment. Experiment names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: Experiment or ClientRawResponse if raw=true
Return type: Experiment or ClientRawResponse
Raises: CloudError
-
list_by_workspace
(resource_group_name, workspace_name, experiments_list_by_workspace_options=None, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a list of Experiments within the specified Workspace.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- workspace_name (str) – The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- experiments_list_by_workspace_options (ExperimentsListByWorkspaceOptions) – Additional parameters for the operation
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of Experiment
Return type: Raises: CloudError
-
models
= <module 'azure.mgmt.batchai.models' from '/usr/lib/python3/dist-packages/azure/mgmt/batchai/models/__init__.py'>¶
-
class
azure.mgmt.batchai.operations.
JobsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
JobsOperations operations.
Parameters: - client – Client for service requests.
- config – Configuration of service client.
- serializer – An object model serializer.
- deserializer – An object model deserializer.
Variables: api_version – Specifies the version of API used for this request. Constant value: “2018-05-01”.
-
create
(resource_group_name, workspace_name, experiment_name, job_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Creates a Job in the given Experiment.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- workspace_name (str) – The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- experiment_name (str) – The name of the experiment. Experiment names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- job_name (str) – The name of the job within the specified resource group. Job names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- parameters (JobCreateParameters) – The parameters to provide for job creation.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns Job or ClientRawResponse<Job> if raw==True
Return type: AzureOperationPoller[Job] or AzureOperationPoller[ClientRawResponse[Job]]
Raises: CloudError
-
delete
(resource_group_name, workspace_name, experiment_name, job_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Deletes a Job.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- workspace_name (str) – The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- experiment_name (str) – The name of the experiment. Experiment names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- job_name (str) – The name of the job within the specified resource group. Job names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
Return type: AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
Raises: CloudError
-
get
(resource_group_name, workspace_name, experiment_name, job_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets information about a Job.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- workspace_name (str) – The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- experiment_name (str) – The name of the experiment. Experiment names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- job_name (str) – The name of the job within the specified resource group. Job names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: Job or ClientRawResponse if raw=true
Return type: Job or ClientRawResponse
Raises: CloudError
-
list_by_experiment
(resource_group_name, workspace_name, experiment_name, jobs_list_by_experiment_options=None, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a list of Jobs within the specified Experiment.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- workspace_name (str) – The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- experiment_name (str) – The name of the experiment. Experiment names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- jobs_list_by_experiment_options (JobsListByExperimentOptions) – Additional parameters for the operation
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of Job
Return type: Raises: CloudError
-
list_output_files
(resource_group_name, workspace_name, experiment_name, job_name, jobs_list_output_files_options, custom_headers=None, raw=False, **operation_config)[source]¶ List all directories and files inside the given directory of the Job’s output directory (if the output directory is on Azure File Share or Azure Storage Container).
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- workspace_name (str) – The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- experiment_name (str) – The name of the experiment. Experiment names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- job_name (str) – The name of the job within the specified resource group. Job names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- jobs_list_output_files_options (JobsListOutputFilesOptions) – Additional parameters for the operation
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of File
Return type: Raises: CloudError
-
list_remote_login_information
(resource_group_name, workspace_name, experiment_name, job_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a list of currently existing nodes which were used for the Job execution. The returned information contains the node ID, its public IP and SSH port.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- workspace_name (str) – The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- experiment_name (str) – The name of the experiment. Experiment names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- job_name (str) – The name of the job within the specified resource group. Job names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of RemoteLoginInformation
Return type: Raises: CloudError
-
terminate
(resource_group_name, workspace_name, experiment_name, job_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Terminates a job.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- workspace_name (str) – The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- experiment_name (str) – The name of the experiment. Experiment names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- job_name (str) – The name of the job within the specified resource group. Job names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
Return type: AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
Raises: CloudError
-
models
= <module 'azure.mgmt.batchai.models' from '/usr/lib/python3/dist-packages/azure/mgmt/batchai/models/__init__.py'>¶
-
class
azure.mgmt.batchai.operations.
FileServersOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
FileServersOperations operations.
Parameters: - client – Client for service requests.
- config – Configuration of service client.
- serializer – An object model serializer.
- deserializer – An object model deserializer.
Variables: api_version – Specifies the version of API used for this request. Constant value: “2018-05-01”.
-
create
(resource_group_name, workspace_name, file_server_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Creates a File Server in the given workspace.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- workspace_name (str) – The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- file_server_name (str) – The name of the file server within the specified resource group. File server names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- parameters (FileServerCreateParameters) – The parameters to provide for File Server creation.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns FileServer or ClientRawResponse<FileServer> if raw==True
Return type: AzureOperationPoller[FileServer] or AzureOperationPoller[ClientRawResponse[FileServer]]
Raises: CloudError
-
delete
(resource_group_name, workspace_name, file_server_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Deletes a File Server.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- workspace_name (str) – The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- file_server_name (str) – The name of the file server within the specified resource group. File server names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
Return type: AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
Raises: CloudError
-
get
(resource_group_name, workspace_name, file_server_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets information about a File Server.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- workspace_name (str) – The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- file_server_name (str) – The name of the file server within the specified resource group. File server names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: FileServer or ClientRawResponse if raw=true
Return type: FileServer or ClientRawResponse
Raises: CloudError
-
list_by_workspace
(resource_group_name, workspace_name, file_servers_list_by_workspace_options=None, custom_headers=None, raw=False, **operation_config)[source]¶ Gets a list of File Servers associated with the specified workspace.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- workspace_name (str) – The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- file_servers_list_by_workspace_options (FileServersListByWorkspaceOptions) – Additional parameters for the operation
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of FileServer
Return type: Raises: CloudError
-
models
= <module 'azure.mgmt.batchai.models' from '/usr/lib/python3/dist-packages/azure/mgmt/batchai/models/__init__.py'>¶
-
class
azure.mgmt.batchai.operations.
ClustersOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ClustersOperations operations.
Parameters: - client – Client for service requests.
- config – Configuration of service client.
- serializer – An object model serializer.
- deserializer – An object model deserializer.
Variables: api_version – Specifies the version of API used for this request. Constant value: “2018-05-01”.
-
create
(resource_group_name, workspace_name, cluster_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Creates a Cluster in the given Workspace.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- workspace_name (str) – The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- cluster_name (str) – The name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- parameters (ClusterCreateParameters) – The parameters to provide for the Cluster creation.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns Cluster or ClientRawResponse<Cluster> if raw==True
Return type: AzureOperationPoller[Cluster] or AzureOperationPoller[ClientRawResponse[Cluster]]
Raises: CloudError
-
delete
(resource_group_name, workspace_name, cluster_name, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Deletes a Cluster.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- workspace_name (str) – The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- cluster_name (str) – The name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
- polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
Returns: An instance of LROPoller that returns None or ClientRawResponse<None> if raw==True
Return type: AzureOperationPoller[None] or AzureOperationPoller[ClientRawResponse[None]]
Raises: CloudError
-
get
(resource_group_name, workspace_name, cluster_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets information about a Cluster.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- workspace_name (str) – The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- cluster_name (str) – The name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: Cluster or ClientRawResponse if raw=true
Return type: Cluster or ClientRawResponse
Raises: CloudError
-
list_by_workspace
(resource_group_name, workspace_name, clusters_list_by_workspace_options=None, custom_headers=None, raw=False, **operation_config)[source]¶ Gets information about Clusters associated with the given Workspace.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- workspace_name (str) – The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- clusters_list_by_workspace_options (ClustersListByWorkspaceOptions) – Additional parameters for the operation
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of Cluster
Return type: Raises: CloudError
-
list_remote_login_information
(resource_group_name, workspace_name, cluster_name, custom_headers=None, raw=False, **operation_config)[source]¶ Get the IP address, port of all the compute nodes in the Cluster.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- workspace_name (str) – The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- cluster_name (str) – The name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of RemoteLoginInformation
Return type: Raises: CloudError
-
update
(resource_group_name, workspace_name, cluster_name, scale_settings=None, custom_headers=None, raw=False, **operation_config)[source]¶ Updates properties of a Cluster.
Parameters: - resource_group_name (str) – Name of the resource group to which the resource belongs.
- workspace_name (str) – The name of the workspace. Workspace names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- cluster_name (str) – The name of the cluster within the specified resource group. Cluster names can only contain a combination of alphanumeric characters along with dash (-) and underscore (_). The name must be from 1 through 64 characters long.
- scale_settings (ScaleSettings) – Desired scale for the cluster
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: Cluster or ClientRawResponse if raw=true
Return type: Cluster or ClientRawResponse
Raises: CloudError
-
models
= <module 'azure.mgmt.batchai.models' from '/usr/lib/python3/dist-packages/azure/mgmt/batchai/models/__init__.py'>¶