# coding=utf-8
# --------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for
# license information.
#
# Code generated by Microsoft (R) AutoRest Code Generator.
# Changes may cause incorrect behavior and will be lost if the code is
# regenerated.
# --------------------------------------------------------------------------
import uuid
from msrest.pipeline import ClientRawResponse
from .. import models
[docs]class ComputeNodeOperations(object):
"""ComputeNodeOperations operations.
:param client: Client for service requests.
:param config: Configuration of service client.
:param serializer: An object model serializer.
:param deserializer: An object model deserializer.
:ivar api_version: Client API Version. Constant value: "2018-03-01.6.1".
"""
models = models
def __init__(self, client, config, serializer, deserializer):
self._client = client
self._serialize = serializer
self._deserialize = deserializer
self.api_version = "2018-03-01.6.1"
self.config = config
[docs] def add_user(
self, pool_id, node_id, user, compute_node_add_user_options=None, custom_headers=None, raw=False, **operation_config):
"""Adds a user account to the specified compute node.
You can add a user account to a node only when it is in the idle or
running state.
:param pool_id: The ID of the pool that contains the compute node.
:type pool_id: str
:param node_id: The ID of the machine on which you want to create a
user account.
:type node_id: str
:param user: The user account to be created.
:type user: ~azure.batch.models.ComputeNodeUser
:param compute_node_add_user_options: Additional parameters for the
operation
:type compute_node_add_user_options:
~azure.batch.models.ComputeNodeAddUserOptions
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`BatchErrorException<azure.batch.models.BatchErrorException>`
"""
timeout = None
if compute_node_add_user_options is not None:
timeout = compute_node_add_user_options.timeout
client_request_id = None
if compute_node_add_user_options is not None:
client_request_id = compute_node_add_user_options.client_request_id
return_client_request_id = None
if compute_node_add_user_options is not None:
return_client_request_id = compute_node_add_user_options.return_client_request_id
ocp_date = None
if compute_node_add_user_options is not None:
ocp_date = compute_node_add_user_options.ocp_date
# Construct URL
url = self.add_user.metadata['url']
path_format_arguments = {
'poolId': self._serialize.url("pool_id", pool_id, 'str'),
'nodeId': self._serialize.url("node_id", node_id, 'str')
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("self.api_version", self.api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'int')
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; odata=minimalmetadata; charset=utf-8'
if self.config.generate_client_request_id:
header_parameters['client-request-id'] = str(uuid.uuid1())
if custom_headers:
header_parameters.update(custom_headers)
if self.config.accept_language is not None:
header_parameters['accept-language'] = self._serialize.header("self.config.accept_language", self.config.accept_language, 'str')
if client_request_id is not None:
header_parameters['client-request-id'] = self._serialize.header("client_request_id", client_request_id, 'str')
if return_client_request_id is not None:
header_parameters['return-client-request-id'] = self._serialize.header("return_client_request_id", return_client_request_id, 'bool')
if ocp_date is not None:
header_parameters['ocp-date'] = self._serialize.header("ocp_date", ocp_date, 'rfc-1123')
# Construct body
body_content = self._serialize.body(user, 'ComputeNodeUser')
# Construct and send request
request = self._client.post(url, query_parameters)
response = self._client.send(
request, header_parameters, body_content, stream=False, **operation_config)
if response.status_code not in [201]:
raise models.BatchErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
client_raw_response.add_headers({
'client-request-id': 'str',
'request-id': 'str',
'ETag': 'str',
'Last-Modified': 'rfc-1123',
'DataServiceId': 'str',
})
return client_raw_response
add_user.metadata = {'url': '/pools/{poolId}/nodes/{nodeId}/users'}
[docs] def delete_user(
self, pool_id, node_id, user_name, compute_node_delete_user_options=None, custom_headers=None, raw=False, **operation_config):
"""Deletes a user account from the specified compute node.
You can delete a user account to a node only when it is in the idle or
running state.
:param pool_id: The ID of the pool that contains the compute node.
:type pool_id: str
:param node_id: The ID of the machine on which you want to delete a
user account.
:type node_id: str
:param user_name: The name of the user account to delete.
:type user_name: str
:param compute_node_delete_user_options: Additional parameters for the
operation
:type compute_node_delete_user_options:
~azure.batch.models.ComputeNodeDeleteUserOptions
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`BatchErrorException<azure.batch.models.BatchErrorException>`
"""
timeout = None
if compute_node_delete_user_options is not None:
timeout = compute_node_delete_user_options.timeout
client_request_id = None
if compute_node_delete_user_options is not None:
client_request_id = compute_node_delete_user_options.client_request_id
return_client_request_id = None
if compute_node_delete_user_options is not None:
return_client_request_id = compute_node_delete_user_options.return_client_request_id
ocp_date = None
if compute_node_delete_user_options is not None:
ocp_date = compute_node_delete_user_options.ocp_date
# Construct URL
url = self.delete_user.metadata['url']
path_format_arguments = {
'poolId': self._serialize.url("pool_id", pool_id, 'str'),
'nodeId': self._serialize.url("node_id", node_id, 'str'),
'userName': self._serialize.url("user_name", user_name, 'str')
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("self.api_version", self.api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'int')
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if self.config.generate_client_request_id:
header_parameters['client-request-id'] = str(uuid.uuid1())
if custom_headers:
header_parameters.update(custom_headers)
if self.config.accept_language is not None:
header_parameters['accept-language'] = self._serialize.header("self.config.accept_language", self.config.accept_language, 'str')
if client_request_id is not None:
header_parameters['client-request-id'] = self._serialize.header("client_request_id", client_request_id, 'str')
if return_client_request_id is not None:
header_parameters['return-client-request-id'] = self._serialize.header("return_client_request_id", return_client_request_id, 'bool')
if ocp_date is not None:
header_parameters['ocp-date'] = self._serialize.header("ocp_date", ocp_date, 'rfc-1123')
# Construct and send request
request = self._client.delete(url, query_parameters)
response = self._client.send(request, header_parameters, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.BatchErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
client_raw_response.add_headers({
'client-request-id': 'str',
'request-id': 'str',
})
return client_raw_response
delete_user.metadata = {'url': '/pools/{poolId}/nodes/{nodeId}/users/{userName}'}
[docs] def update_user(
self, pool_id, node_id, user_name, node_update_user_parameter, compute_node_update_user_options=None, custom_headers=None, raw=False, **operation_config):
"""Updates the password and expiration time of a user account on the
specified compute node.
This operation replaces of all the updateable properties of the
account. For example, if the expiryTime element is not specified, the
current value is replaced with the default value, not left unmodified.
You can update a user account on a node only when it is in the idle or
running state.
:param pool_id: The ID of the pool that contains the compute node.
:type pool_id: str
:param node_id: The ID of the machine on which you want to update a
user account.
:type node_id: str
:param user_name: The name of the user account to update.
:type user_name: str
:param node_update_user_parameter: The parameters for the request.
:type node_update_user_parameter:
~azure.batch.models.NodeUpdateUserParameter
:param compute_node_update_user_options: Additional parameters for the
operation
:type compute_node_update_user_options:
~azure.batch.models.ComputeNodeUpdateUserOptions
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`BatchErrorException<azure.batch.models.BatchErrorException>`
"""
timeout = None
if compute_node_update_user_options is not None:
timeout = compute_node_update_user_options.timeout
client_request_id = None
if compute_node_update_user_options is not None:
client_request_id = compute_node_update_user_options.client_request_id
return_client_request_id = None
if compute_node_update_user_options is not None:
return_client_request_id = compute_node_update_user_options.return_client_request_id
ocp_date = None
if compute_node_update_user_options is not None:
ocp_date = compute_node_update_user_options.ocp_date
# Construct URL
url = self.update_user.metadata['url']
path_format_arguments = {
'poolId': self._serialize.url("pool_id", pool_id, 'str'),
'nodeId': self._serialize.url("node_id", node_id, 'str'),
'userName': self._serialize.url("user_name", user_name, 'str')
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("self.api_version", self.api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'int')
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; odata=minimalmetadata; charset=utf-8'
if self.config.generate_client_request_id:
header_parameters['client-request-id'] = str(uuid.uuid1())
if custom_headers:
header_parameters.update(custom_headers)
if self.config.accept_language is not None:
header_parameters['accept-language'] = self._serialize.header("self.config.accept_language", self.config.accept_language, 'str')
if client_request_id is not None:
header_parameters['client-request-id'] = self._serialize.header("client_request_id", client_request_id, 'str')
if return_client_request_id is not None:
header_parameters['return-client-request-id'] = self._serialize.header("return_client_request_id", return_client_request_id, 'bool')
if ocp_date is not None:
header_parameters['ocp-date'] = self._serialize.header("ocp_date", ocp_date, 'rfc-1123')
# Construct body
body_content = self._serialize.body(node_update_user_parameter, 'NodeUpdateUserParameter')
# Construct and send request
request = self._client.put(url, query_parameters)
response = self._client.send(
request, header_parameters, body_content, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.BatchErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
client_raw_response.add_headers({
'client-request-id': 'str',
'request-id': 'str',
'ETag': 'str',
'Last-Modified': 'rfc-1123',
'DataServiceId': 'str',
})
return client_raw_response
update_user.metadata = {'url': '/pools/{poolId}/nodes/{nodeId}/users/{userName}'}
[docs] def get(
self, pool_id, node_id, compute_node_get_options=None, custom_headers=None, raw=False, **operation_config):
"""Gets information about the specified compute node.
:param pool_id: The ID of the pool that contains the compute node.
:type pool_id: str
:param node_id: The ID of the compute node that you want to get
information about.
:type node_id: str
:param compute_node_get_options: Additional parameters for the
operation
:type compute_node_get_options:
~azure.batch.models.ComputeNodeGetOptions
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: ComputeNode or ClientRawResponse if raw=true
:rtype: ~azure.batch.models.ComputeNode or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`BatchErrorException<azure.batch.models.BatchErrorException>`
"""
select = None
if compute_node_get_options is not None:
select = compute_node_get_options.select
timeout = None
if compute_node_get_options is not None:
timeout = compute_node_get_options.timeout
client_request_id = None
if compute_node_get_options is not None:
client_request_id = compute_node_get_options.client_request_id
return_client_request_id = None
if compute_node_get_options is not None:
return_client_request_id = compute_node_get_options.return_client_request_id
ocp_date = None
if compute_node_get_options is not None:
ocp_date = compute_node_get_options.ocp_date
# Construct URL
url = self.get.metadata['url']
path_format_arguments = {
'poolId': self._serialize.url("pool_id", pool_id, 'str'),
'nodeId': self._serialize.url("node_id", node_id, 'str')
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("self.api_version", self.api_version, 'str')
if select is not None:
query_parameters['$select'] = self._serialize.query("select", select, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'int')
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if self.config.generate_client_request_id:
header_parameters['client-request-id'] = str(uuid.uuid1())
if custom_headers:
header_parameters.update(custom_headers)
if self.config.accept_language is not None:
header_parameters['accept-language'] = self._serialize.header("self.config.accept_language", self.config.accept_language, 'str')
if client_request_id is not None:
header_parameters['client-request-id'] = self._serialize.header("client_request_id", client_request_id, 'str')
if return_client_request_id is not None:
header_parameters['return-client-request-id'] = self._serialize.header("return_client_request_id", return_client_request_id, 'bool')
if ocp_date is not None:
header_parameters['ocp-date'] = self._serialize.header("ocp_date", ocp_date, 'rfc-1123')
# Construct and send request
request = self._client.get(url, query_parameters)
response = self._client.send(request, header_parameters, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.BatchErrorException(self._deserialize, response)
deserialized = None
header_dict = {}
if response.status_code == 200:
deserialized = self._deserialize('ComputeNode', response)
header_dict = {
'client-request-id': 'str',
'request-id': 'str',
'ETag': 'str',
'Last-Modified': 'rfc-1123',
}
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
client_raw_response.add_headers(header_dict)
return client_raw_response
return deserialized
get.metadata = {'url': '/pools/{poolId}/nodes/{nodeId}'}
[docs] def reboot(
self, pool_id, node_id, compute_node_reboot_options=None, node_reboot_option=None, custom_headers=None, raw=False, **operation_config):
"""Restarts the specified compute node.
You can restart a node only if it is in an idle or running state.
:param pool_id: The ID of the pool that contains the compute node.
:type pool_id: str
:param node_id: The ID of the compute node that you want to restart.
:type node_id: str
:param compute_node_reboot_options: Additional parameters for the
operation
:type compute_node_reboot_options:
~azure.batch.models.ComputeNodeRebootOptions
:param node_reboot_option: When to reboot the compute node and what to
do with currently running tasks. The default value is requeue.
Possible values include: 'requeue', 'terminate', 'taskCompletion',
'retainedData'
:type node_reboot_option: str or
~azure.batch.models.ComputeNodeRebootOption
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`BatchErrorException<azure.batch.models.BatchErrorException>`
"""
timeout = None
if compute_node_reboot_options is not None:
timeout = compute_node_reboot_options.timeout
client_request_id = None
if compute_node_reboot_options is not None:
client_request_id = compute_node_reboot_options.client_request_id
return_client_request_id = None
if compute_node_reboot_options is not None:
return_client_request_id = compute_node_reboot_options.return_client_request_id
ocp_date = None
if compute_node_reboot_options is not None:
ocp_date = compute_node_reboot_options.ocp_date
node_reboot_parameter = None
if node_reboot_option is not None:
node_reboot_parameter = models.NodeRebootParameter(node_reboot_option=node_reboot_option)
# Construct URL
url = self.reboot.metadata['url']
path_format_arguments = {
'poolId': self._serialize.url("pool_id", pool_id, 'str'),
'nodeId': self._serialize.url("node_id", node_id, 'str')
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("self.api_version", self.api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'int')
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; odata=minimalmetadata; charset=utf-8'
if self.config.generate_client_request_id:
header_parameters['client-request-id'] = str(uuid.uuid1())
if custom_headers:
header_parameters.update(custom_headers)
if self.config.accept_language is not None:
header_parameters['accept-language'] = self._serialize.header("self.config.accept_language", self.config.accept_language, 'str')
if client_request_id is not None:
header_parameters['client-request-id'] = self._serialize.header("client_request_id", client_request_id, 'str')
if return_client_request_id is not None:
header_parameters['return-client-request-id'] = self._serialize.header("return_client_request_id", return_client_request_id, 'bool')
if ocp_date is not None:
header_parameters['ocp-date'] = self._serialize.header("ocp_date", ocp_date, 'rfc-1123')
# Construct body
if node_reboot_parameter is not None:
body_content = self._serialize.body(node_reboot_parameter, 'NodeRebootParameter')
else:
body_content = None
# Construct and send request
request = self._client.post(url, query_parameters)
response = self._client.send(
request, header_parameters, body_content, stream=False, **operation_config)
if response.status_code not in [202]:
raise models.BatchErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
client_raw_response.add_headers({
'client-request-id': 'str',
'request-id': 'str',
'ETag': 'str',
'Last-Modified': 'rfc-1123',
'DataServiceId': 'str',
})
return client_raw_response
reboot.metadata = {'url': '/pools/{poolId}/nodes/{nodeId}/reboot'}
[docs] def reimage(
self, pool_id, node_id, compute_node_reimage_options=None, node_reimage_option=None, custom_headers=None, raw=False, **operation_config):
"""Reinstalls the operating system on the specified compute node.
You can reinstall the operating system on a node only if it is in an
idle or running state. This API can be invoked only on pools created
with the cloud service configuration property.
:param pool_id: The ID of the pool that contains the compute node.
:type pool_id: str
:param node_id: The ID of the compute node that you want to restart.
:type node_id: str
:param compute_node_reimage_options: Additional parameters for the
operation
:type compute_node_reimage_options:
~azure.batch.models.ComputeNodeReimageOptions
:param node_reimage_option: When to reimage the compute node and what
to do with currently running tasks. The default value is requeue.
Possible values include: 'requeue', 'terminate', 'taskCompletion',
'retainedData'
:type node_reimage_option: str or
~azure.batch.models.ComputeNodeReimageOption
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`BatchErrorException<azure.batch.models.BatchErrorException>`
"""
timeout = None
if compute_node_reimage_options is not None:
timeout = compute_node_reimage_options.timeout
client_request_id = None
if compute_node_reimage_options is not None:
client_request_id = compute_node_reimage_options.client_request_id
return_client_request_id = None
if compute_node_reimage_options is not None:
return_client_request_id = compute_node_reimage_options.return_client_request_id
ocp_date = None
if compute_node_reimage_options is not None:
ocp_date = compute_node_reimage_options.ocp_date
node_reimage_parameter = None
if node_reimage_option is not None:
node_reimage_parameter = models.NodeReimageParameter(node_reimage_option=node_reimage_option)
# Construct URL
url = self.reimage.metadata['url']
path_format_arguments = {
'poolId': self._serialize.url("pool_id", pool_id, 'str'),
'nodeId': self._serialize.url("node_id", node_id, 'str')
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("self.api_version", self.api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'int')
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; odata=minimalmetadata; charset=utf-8'
if self.config.generate_client_request_id:
header_parameters['client-request-id'] = str(uuid.uuid1())
if custom_headers:
header_parameters.update(custom_headers)
if self.config.accept_language is not None:
header_parameters['accept-language'] = self._serialize.header("self.config.accept_language", self.config.accept_language, 'str')
if client_request_id is not None:
header_parameters['client-request-id'] = self._serialize.header("client_request_id", client_request_id, 'str')
if return_client_request_id is not None:
header_parameters['return-client-request-id'] = self._serialize.header("return_client_request_id", return_client_request_id, 'bool')
if ocp_date is not None:
header_parameters['ocp-date'] = self._serialize.header("ocp_date", ocp_date, 'rfc-1123')
# Construct body
if node_reimage_parameter is not None:
body_content = self._serialize.body(node_reimage_parameter, 'NodeReimageParameter')
else:
body_content = None
# Construct and send request
request = self._client.post(url, query_parameters)
response = self._client.send(
request, header_parameters, body_content, stream=False, **operation_config)
if response.status_code not in [202]:
raise models.BatchErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
client_raw_response.add_headers({
'client-request-id': 'str',
'request-id': 'str',
'ETag': 'str',
'Last-Modified': 'rfc-1123',
'DataServiceId': 'str',
})
return client_raw_response
reimage.metadata = {'url': '/pools/{poolId}/nodes/{nodeId}/reimage'}
[docs] def disable_scheduling(
self, pool_id, node_id, compute_node_disable_scheduling_options=None, node_disable_scheduling_option=None, custom_headers=None, raw=False, **operation_config):
"""Disables task scheduling on the specified compute node.
You can disable task scheduling on a node only if its current
scheduling state is enabled.
:param pool_id: The ID of the pool that contains the compute node.
:type pool_id: str
:param node_id: The ID of the compute node on which you want to
disable task scheduling.
:type node_id: str
:param compute_node_disable_scheduling_options: Additional parameters
for the operation
:type compute_node_disable_scheduling_options:
~azure.batch.models.ComputeNodeDisableSchedulingOptions
:param node_disable_scheduling_option: What to do with currently
running tasks when disabling task scheduling on the compute node. The
default value is requeue. Possible values include: 'requeue',
'terminate', 'taskCompletion'
:type node_disable_scheduling_option: str or
~azure.batch.models.DisableComputeNodeSchedulingOption
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`BatchErrorException<azure.batch.models.BatchErrorException>`
"""
timeout = None
if compute_node_disable_scheduling_options is not None:
timeout = compute_node_disable_scheduling_options.timeout
client_request_id = None
if compute_node_disable_scheduling_options is not None:
client_request_id = compute_node_disable_scheduling_options.client_request_id
return_client_request_id = None
if compute_node_disable_scheduling_options is not None:
return_client_request_id = compute_node_disable_scheduling_options.return_client_request_id
ocp_date = None
if compute_node_disable_scheduling_options is not None:
ocp_date = compute_node_disable_scheduling_options.ocp_date
node_disable_scheduling_parameter = None
if node_disable_scheduling_option is not None:
node_disable_scheduling_parameter = models.NodeDisableSchedulingParameter(node_disable_scheduling_option=node_disable_scheduling_option)
# Construct URL
url = self.disable_scheduling.metadata['url']
path_format_arguments = {
'poolId': self._serialize.url("pool_id", pool_id, 'str'),
'nodeId': self._serialize.url("node_id", node_id, 'str')
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("self.api_version", self.api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'int')
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; odata=minimalmetadata; charset=utf-8'
if self.config.generate_client_request_id:
header_parameters['client-request-id'] = str(uuid.uuid1())
if custom_headers:
header_parameters.update(custom_headers)
if self.config.accept_language is not None:
header_parameters['accept-language'] = self._serialize.header("self.config.accept_language", self.config.accept_language, 'str')
if client_request_id is not None:
header_parameters['client-request-id'] = self._serialize.header("client_request_id", client_request_id, 'str')
if return_client_request_id is not None:
header_parameters['return-client-request-id'] = self._serialize.header("return_client_request_id", return_client_request_id, 'bool')
if ocp_date is not None:
header_parameters['ocp-date'] = self._serialize.header("ocp_date", ocp_date, 'rfc-1123')
# Construct body
if node_disable_scheduling_parameter is not None:
body_content = self._serialize.body(node_disable_scheduling_parameter, 'NodeDisableSchedulingParameter')
else:
body_content = None
# Construct and send request
request = self._client.post(url, query_parameters)
response = self._client.send(
request, header_parameters, body_content, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.BatchErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
client_raw_response.add_headers({
'client-request-id': 'str',
'request-id': 'str',
'ETag': 'str',
'Last-Modified': 'rfc-1123',
'DataServiceId': 'str',
})
return client_raw_response
disable_scheduling.metadata = {'url': '/pools/{poolId}/nodes/{nodeId}/disablescheduling'}
[docs] def enable_scheduling(
self, pool_id, node_id, compute_node_enable_scheduling_options=None, custom_headers=None, raw=False, **operation_config):
"""Enables task scheduling on the specified compute node.
You can enable task scheduling on a node only if its current scheduling
state is disabled.
:param pool_id: The ID of the pool that contains the compute node.
:type pool_id: str
:param node_id: The ID of the compute node on which you want to enable
task scheduling.
:type node_id: str
:param compute_node_enable_scheduling_options: Additional parameters
for the operation
:type compute_node_enable_scheduling_options:
~azure.batch.models.ComputeNodeEnableSchedulingOptions
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`BatchErrorException<azure.batch.models.BatchErrorException>`
"""
timeout = None
if compute_node_enable_scheduling_options is not None:
timeout = compute_node_enable_scheduling_options.timeout
client_request_id = None
if compute_node_enable_scheduling_options is not None:
client_request_id = compute_node_enable_scheduling_options.client_request_id
return_client_request_id = None
if compute_node_enable_scheduling_options is not None:
return_client_request_id = compute_node_enable_scheduling_options.return_client_request_id
ocp_date = None
if compute_node_enable_scheduling_options is not None:
ocp_date = compute_node_enable_scheduling_options.ocp_date
# Construct URL
url = self.enable_scheduling.metadata['url']
path_format_arguments = {
'poolId': self._serialize.url("pool_id", pool_id, 'str'),
'nodeId': self._serialize.url("node_id", node_id, 'str')
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("self.api_version", self.api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'int')
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if self.config.generate_client_request_id:
header_parameters['client-request-id'] = str(uuid.uuid1())
if custom_headers:
header_parameters.update(custom_headers)
if self.config.accept_language is not None:
header_parameters['accept-language'] = self._serialize.header("self.config.accept_language", self.config.accept_language, 'str')
if client_request_id is not None:
header_parameters['client-request-id'] = self._serialize.header("client_request_id", client_request_id, 'str')
if return_client_request_id is not None:
header_parameters['return-client-request-id'] = self._serialize.header("return_client_request_id", return_client_request_id, 'bool')
if ocp_date is not None:
header_parameters['ocp-date'] = self._serialize.header("ocp_date", ocp_date, 'rfc-1123')
# Construct and send request
request = self._client.post(url, query_parameters)
response = self._client.send(request, header_parameters, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.BatchErrorException(self._deserialize, response)
if raw:
client_raw_response = ClientRawResponse(None, response)
client_raw_response.add_headers({
'client-request-id': 'str',
'request-id': 'str',
'ETag': 'str',
'Last-Modified': 'rfc-1123',
'DataServiceId': 'str',
})
return client_raw_response
enable_scheduling.metadata = {'url': '/pools/{poolId}/nodes/{nodeId}/enablescheduling'}
[docs] def get_remote_login_settings(
self, pool_id, node_id, compute_node_get_remote_login_settings_options=None, custom_headers=None, raw=False, **operation_config):
"""Gets the settings required for remote login to a compute node.
Before you can remotely login to a node using the remote login
settings, you must create a user account on the node. This API can be
invoked only on pools created with the virtual machine configuration
property. For pools created with a cloud service configuration, see the
GetRemoteDesktop API.
:param pool_id: The ID of the pool that contains the compute node.
:type pool_id: str
:param node_id: The ID of the compute node for which to obtain the
remote login settings.
:type node_id: str
:param compute_node_get_remote_login_settings_options: Additional
parameters for the operation
:type compute_node_get_remote_login_settings_options:
~azure.batch.models.ComputeNodeGetRemoteLoginSettingsOptions
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: ComputeNodeGetRemoteLoginSettingsResult or ClientRawResponse
if raw=true
:rtype: ~azure.batch.models.ComputeNodeGetRemoteLoginSettingsResult or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`BatchErrorException<azure.batch.models.BatchErrorException>`
"""
timeout = None
if compute_node_get_remote_login_settings_options is not None:
timeout = compute_node_get_remote_login_settings_options.timeout
client_request_id = None
if compute_node_get_remote_login_settings_options is not None:
client_request_id = compute_node_get_remote_login_settings_options.client_request_id
return_client_request_id = None
if compute_node_get_remote_login_settings_options is not None:
return_client_request_id = compute_node_get_remote_login_settings_options.return_client_request_id
ocp_date = None
if compute_node_get_remote_login_settings_options is not None:
ocp_date = compute_node_get_remote_login_settings_options.ocp_date
# Construct URL
url = self.get_remote_login_settings.metadata['url']
path_format_arguments = {
'poolId': self._serialize.url("pool_id", pool_id, 'str'),
'nodeId': self._serialize.url("node_id", node_id, 'str')
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("self.api_version", self.api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'int')
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if self.config.generate_client_request_id:
header_parameters['client-request-id'] = str(uuid.uuid1())
if custom_headers:
header_parameters.update(custom_headers)
if self.config.accept_language is not None:
header_parameters['accept-language'] = self._serialize.header("self.config.accept_language", self.config.accept_language, 'str')
if client_request_id is not None:
header_parameters['client-request-id'] = self._serialize.header("client_request_id", client_request_id, 'str')
if return_client_request_id is not None:
header_parameters['return-client-request-id'] = self._serialize.header("return_client_request_id", return_client_request_id, 'bool')
if ocp_date is not None:
header_parameters['ocp-date'] = self._serialize.header("ocp_date", ocp_date, 'rfc-1123')
# Construct and send request
request = self._client.get(url, query_parameters)
response = self._client.send(request, header_parameters, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.BatchErrorException(self._deserialize, response)
deserialized = None
header_dict = {}
if response.status_code == 200:
deserialized = self._deserialize('ComputeNodeGetRemoteLoginSettingsResult', response)
header_dict = {
'client-request-id': 'str',
'request-id': 'str',
'ETag': 'str',
'Last-Modified': 'rfc-1123',
}
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
client_raw_response.add_headers(header_dict)
return client_raw_response
return deserialized
get_remote_login_settings.metadata = {'url': '/pools/{poolId}/nodes/{nodeId}/remoteloginsettings'}
[docs] def get_remote_desktop(
self, pool_id, node_id, compute_node_get_remote_desktop_options=None, custom_headers=None, raw=False, callback=None, **operation_config):
"""Gets the Remote Desktop Protocol file for the specified compute node.
Before you can access a node by using the RDP file, you must create a
user account on the node. This API can only be invoked on pools created
with a cloud service configuration. For pools created with a virtual
machine configuration, see the GetRemoteLoginSettings API.
:param pool_id: The ID of the pool that contains the compute node.
:type pool_id: str
:param node_id: The ID of the compute node for which you want to get
the Remote Desktop Protocol file.
:type node_id: str
:param compute_node_get_remote_desktop_options: Additional parameters
for the operation
:type compute_node_get_remote_desktop_options:
~azure.batch.models.ComputeNodeGetRemoteDesktopOptions
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param callback: When specified, will be called with each chunk of
data that is streamed. The callback should take two arguments, the
bytes of the current chunk of data and the response object. If the
data is uploading, response will be None.
:type callback: Callable[Bytes, response=None]
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: object or ClientRawResponse if raw=true
:rtype: Generator or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`BatchErrorException<azure.batch.models.BatchErrorException>`
"""
timeout = None
if compute_node_get_remote_desktop_options is not None:
timeout = compute_node_get_remote_desktop_options.timeout
client_request_id = None
if compute_node_get_remote_desktop_options is not None:
client_request_id = compute_node_get_remote_desktop_options.client_request_id
return_client_request_id = None
if compute_node_get_remote_desktop_options is not None:
return_client_request_id = compute_node_get_remote_desktop_options.return_client_request_id
ocp_date = None
if compute_node_get_remote_desktop_options is not None:
ocp_date = compute_node_get_remote_desktop_options.ocp_date
# Construct URL
url = self.get_remote_desktop.metadata['url']
path_format_arguments = {
'poolId': self._serialize.url("pool_id", pool_id, 'str'),
'nodeId': self._serialize.url("node_id", node_id, 'str')
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("self.api_version", self.api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'int')
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if self.config.generate_client_request_id:
header_parameters['client-request-id'] = str(uuid.uuid1())
if custom_headers:
header_parameters.update(custom_headers)
if self.config.accept_language is not None:
header_parameters['accept-language'] = self._serialize.header("self.config.accept_language", self.config.accept_language, 'str')
if client_request_id is not None:
header_parameters['client-request-id'] = self._serialize.header("client_request_id", client_request_id, 'str')
if return_client_request_id is not None:
header_parameters['return-client-request-id'] = self._serialize.header("return_client_request_id", return_client_request_id, 'bool')
if ocp_date is not None:
header_parameters['ocp-date'] = self._serialize.header("ocp_date", ocp_date, 'rfc-1123')
# Construct and send request
request = self._client.get(url, query_parameters)
response = self._client.send(request, header_parameters, stream=True, **operation_config)
if response.status_code not in [200]:
raise models.BatchErrorException(self._deserialize, response)
deserialized = None
header_dict = {}
if response.status_code == 200:
deserialized = self._client.stream_download(response, callback)
header_dict = {
'client-request-id': 'str',
'request-id': 'str',
'ETag': 'str',
'Last-Modified': 'rfc-1123',
}
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
client_raw_response.add_headers(header_dict)
return client_raw_response
return deserialized
get_remote_desktop.metadata = {'url': '/pools/{poolId}/nodes/{nodeId}/rdp'}
[docs] def upload_batch_service_logs(
self, pool_id, node_id, upload_batch_service_logs_configuration, compute_node_upload_batch_service_logs_options=None, custom_headers=None, raw=False, **operation_config):
"""Upload Azure Batch service log files from the specified compute node to
Azure Blob Storage.
This is for gathering Azure Batch service log files in an automated
fashion from nodes if you are experiencing an error and wish to
escalate to Azure support. The Azure Batch service log files should be
shared with Azure support to aid in debugging issues with the Batch
service.
:param pool_id: The ID of the pool that contains the compute node.
:type pool_id: str
:param node_id: The ID of the compute node from which you want to
upload the Azure Batch service log files.
:type node_id: str
:param upload_batch_service_logs_configuration: The Azure Batch
service log files upload configuration.
:type upload_batch_service_logs_configuration:
~azure.batch.models.UploadBatchServiceLogsConfiguration
:param compute_node_upload_batch_service_logs_options: Additional
parameters for the operation
:type compute_node_upload_batch_service_logs_options:
~azure.batch.models.ComputeNodeUploadBatchServiceLogsOptions
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: UploadBatchServiceLogsResult or ClientRawResponse if raw=true
:rtype: ~azure.batch.models.UploadBatchServiceLogsResult or
~msrest.pipeline.ClientRawResponse
:raises:
:class:`BatchErrorException<azure.batch.models.BatchErrorException>`
"""
timeout = None
if compute_node_upload_batch_service_logs_options is not None:
timeout = compute_node_upload_batch_service_logs_options.timeout
client_request_id = None
if compute_node_upload_batch_service_logs_options is not None:
client_request_id = compute_node_upload_batch_service_logs_options.client_request_id
return_client_request_id = None
if compute_node_upload_batch_service_logs_options is not None:
return_client_request_id = compute_node_upload_batch_service_logs_options.return_client_request_id
ocp_date = None
if compute_node_upload_batch_service_logs_options is not None:
ocp_date = compute_node_upload_batch_service_logs_options.ocp_date
# Construct URL
url = self.upload_batch_service_logs.metadata['url']
path_format_arguments = {
'poolId': self._serialize.url("pool_id", pool_id, 'str'),
'nodeId': self._serialize.url("node_id", node_id, 'str')
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("self.api_version", self.api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'int')
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; odata=minimalmetadata; charset=utf-8'
if self.config.generate_client_request_id:
header_parameters['client-request-id'] = str(uuid.uuid1())
if custom_headers:
header_parameters.update(custom_headers)
if self.config.accept_language is not None:
header_parameters['accept-language'] = self._serialize.header("self.config.accept_language", self.config.accept_language, 'str')
if client_request_id is not None:
header_parameters['client-request-id'] = self._serialize.header("client_request_id", client_request_id, 'str')
if return_client_request_id is not None:
header_parameters['return-client-request-id'] = self._serialize.header("return_client_request_id", return_client_request_id, 'bool')
if ocp_date is not None:
header_parameters['ocp-date'] = self._serialize.header("ocp_date", ocp_date, 'rfc-1123')
# Construct body
body_content = self._serialize.body(upload_batch_service_logs_configuration, 'UploadBatchServiceLogsConfiguration')
# Construct and send request
request = self._client.post(url, query_parameters)
response = self._client.send(
request, header_parameters, body_content, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.BatchErrorException(self._deserialize, response)
deserialized = None
header_dict = {}
if response.status_code == 200:
deserialized = self._deserialize('UploadBatchServiceLogsResult', response)
header_dict = {
'client-request-id': 'str',
'request-id': 'str',
}
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
client_raw_response.add_headers(header_dict)
return client_raw_response
return deserialized
upload_batch_service_logs.metadata = {'url': '/pools/{poolId}/nodes/{nodeId}/uploadbatchservicelogs'}
[docs] def list(
self, pool_id, compute_node_list_options=None, custom_headers=None, raw=False, **operation_config):
"""Lists the compute nodes in the specified pool.
:param pool_id: The ID of the pool from which you want to list nodes.
:type pool_id: str
:param compute_node_list_options: Additional parameters for the
operation
:type compute_node_list_options:
~azure.batch.models.ComputeNodeListOptions
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: An iterator like instance of ComputeNode
:rtype:
~azure.batch.models.ComputeNodePaged[~azure.batch.models.ComputeNode]
:raises:
:class:`BatchErrorException<azure.batch.models.BatchErrorException>`
"""
filter = None
if compute_node_list_options is not None:
filter = compute_node_list_options.filter
select = None
if compute_node_list_options is not None:
select = compute_node_list_options.select
max_results = None
if compute_node_list_options is not None:
max_results = compute_node_list_options.max_results
timeout = None
if compute_node_list_options is not None:
timeout = compute_node_list_options.timeout
client_request_id = None
if compute_node_list_options is not None:
client_request_id = compute_node_list_options.client_request_id
return_client_request_id = None
if compute_node_list_options is not None:
return_client_request_id = compute_node_list_options.return_client_request_id
ocp_date = None
if compute_node_list_options is not None:
ocp_date = compute_node_list_options.ocp_date
def internal_paging(next_link=None, raw=False):
if not next_link:
# Construct URL
url = self.list.metadata['url']
path_format_arguments = {
'poolId': self._serialize.url("pool_id", pool_id, 'str')
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
query_parameters['api-version'] = self._serialize.query("self.api_version", self.api_version, 'str')
if filter is not None:
query_parameters['$filter'] = self._serialize.query("filter", filter, 'str')
if select is not None:
query_parameters['$select'] = self._serialize.query("select", select, 'str')
if max_results is not None:
query_parameters['maxresults'] = self._serialize.query("max_results", max_results, 'int', maximum=1000, minimum=1)
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'int')
else:
url = next_link
query_parameters = {}
# Construct headers
header_parameters = {}
header_parameters['Content-Type'] = 'application/json; charset=utf-8'
if self.config.generate_client_request_id:
header_parameters['client-request-id'] = str(uuid.uuid1())
if custom_headers:
header_parameters.update(custom_headers)
if self.config.accept_language is not None:
header_parameters['accept-language'] = self._serialize.header("self.config.accept_language", self.config.accept_language, 'str')
if client_request_id is not None:
header_parameters['client-request-id'] = self._serialize.header("client_request_id", client_request_id, 'str')
if return_client_request_id is not None:
header_parameters['return-client-request-id'] = self._serialize.header("return_client_request_id", return_client_request_id, 'bool')
if ocp_date is not None:
header_parameters['ocp-date'] = self._serialize.header("ocp_date", ocp_date, 'rfc-1123')
# Construct and send request
request = self._client.get(url, query_parameters)
response = self._client.send(
request, header_parameters, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.BatchErrorException(self._deserialize, response)
return response
# Deserialize response
deserialized = models.ComputeNodePaged(internal_paging, self._deserialize.dependencies)
if raw:
header_dict = {}
client_raw_response = models.ComputeNodePaged(internal_paging, self._deserialize.dependencies, header_dict)
return client_raw_response
return deserialized
list.metadata = {'url': '/pools/{poolId}/nodes'}