Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -13,21 +13,19 @@


class AppInsightsReference(Model):
"""Specifies Azure Application Insights information for performance counters
reporting.
"""Azure Application Insights information for performance counters reporting.

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

:param component: Required. Specifies the Azure Application Insights
component resource id.
:param component: Required. Component ID. Azure Application Insights
component resource ID.
:type component: ~azure.mgmt.batchai.models.ResourceId
:param instrumentation_key: Value of the Azure Application Insights
instrumentation key.
:param instrumentation_key: Instrumentation Key. Value of the Azure
Application Insights instrumentation key.
:type instrumentation_key: str
:param instrumentation_key_secret_reference: Specifies a KeyVault Secret
containing Azure Application Insights instrumentation key. Specifies
KeyVault Store and Secret which contains Azure Application Insights
instrumentation key. One of instumentationKey or
:param instrumentation_key_secret_reference: Instrumentation key KeyVault
Secret reference. KeyVault Store and Secret which contains Azure
Application Insights instrumentation key. One of instrumentationKey or
instrumentationKeySecretReference must be specified.
:type instrumentation_key_secret_reference:
~azure.mgmt.batchai.models.KeyVaultSecretReference
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,21 +13,19 @@


class AppInsightsReference(Model):
"""Specifies Azure Application Insights information for performance counters
reporting.
"""Azure Application Insights information for performance counters reporting.

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

:param component: Required. Specifies the Azure Application Insights
component resource id.
:param component: Required. Component ID. Azure Application Insights
component resource ID.
:type component: ~azure.mgmt.batchai.models.ResourceId
:param instrumentation_key: Value of the Azure Application Insights
instrumentation key.
:param instrumentation_key: Instrumentation Key. Value of the Azure
Application Insights instrumentation key.
:type instrumentation_key: str
:param instrumentation_key_secret_reference: Specifies a KeyVault Secret
containing Azure Application Insights instrumentation key. Specifies
KeyVault Store and Secret which contains Azure Application Insights
instrumentation key. One of instumentationKey or
:param instrumentation_key_secret_reference: Instrumentation key KeyVault
Secret reference. KeyVault Store and Secret which contains Azure
Application Insights instrumentation key. One of instrumentationKey or
instrumentationKeySecretReference must be specified.
:type instrumentation_key_secret_reference:
~azure.mgmt.batchai.models.KeyVaultSecretReference
Expand Down
22 changes: 12 additions & 10 deletions azure-mgmt-batchai/azure/mgmt/batchai/models/auto_scale_settings.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,21 +13,23 @@


class AutoScaleSettings(Model):
"""The system automatically scales the cluster up and down (within
minimumNodeCount and maximumNodeCount) based on the pending and running
jobs on the cluster.
"""Auto-scale settings for the cluster. The system automatically scales the
cluster up and down (within minimumNodeCount and maximumNodeCount) based on
the number of queued and running jobs assigned to the cluster.

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

:param minimum_node_count: Required. Specifies the minimum number of
compute nodes the cluster can have.
:param minimum_node_count: Required. Minimum node count. The minimum
number of compute nodes the Batch AI service will try to allocate for the
cluster. Note, the actual number of nodes can be less than the specified
value if the subscription has not enough quota to fulfill the request.
:type minimum_node_count: int
:param maximum_node_count: Required. Specifies the maximum number of
compute nodes the cluster can have.
:param maximum_node_count: Required. Maximum node count. The maximum
number of compute nodes the cluster can have.
:type maximum_node_count: int
:param initial_node_count: Specifies the number of compute nodes to
allocate on cluster creation. Note that this value is used only during
cluster creation. Default value: 0 .
:param initial_node_count: Initial node count. The number of compute nodes
to allocate on cluster creation. Note that this value is used only during
cluster creation. Default: 0. Default value: 0 .
:type initial_node_count: int
"""

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,21 +13,23 @@


class AutoScaleSettings(Model):
"""The system automatically scales the cluster up and down (within
minimumNodeCount and maximumNodeCount) based on the pending and running
jobs on the cluster.
"""Auto-scale settings for the cluster. The system automatically scales the
cluster up and down (within minimumNodeCount and maximumNodeCount) based on
the number of queued and running jobs assigned to the cluster.

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

:param minimum_node_count: Required. Specifies the minimum number of
compute nodes the cluster can have.
:param minimum_node_count: Required. Minimum node count. The minimum
number of compute nodes the Batch AI service will try to allocate for the
cluster. Note, the actual number of nodes can be less than the specified
value if the subscription has not enough quota to fulfill the request.
:type minimum_node_count: int
:param maximum_node_count: Required. Specifies the maximum number of
compute nodes the cluster can have.
:param maximum_node_count: Required. Maximum node count. The maximum
number of compute nodes the cluster can have.
:type maximum_node_count: int
:param initial_node_count: Specifies the number of compute nodes to
allocate on cluster creation. Note that this value is used only during
cluster creation. Default value: 0 .
:param initial_node_count: Initial node count. The number of compute nodes
to allocate on cluster creation. Note that this value is used only during
cluster creation. Default: 0. Default value: 0 .
:type initial_node_count: int
"""

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,27 +13,27 @@


class AzureBlobFileSystemReference(Model):
"""Provides required information, for the service to be able to mount Azure
Blob Storage container on the cluster nodes.
"""Azure Blob Storage Container mounting configuration.

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

:param account_name: Required. Name of the Azure Blob Storage account.
:param account_name: Required. Account name. Name of the Azure storage
account.
:type account_name: str
:param container_name: Required. Name of the Azure Blob Storage container
to mount on the cluster.
:param container_name: Required. Container name. Name of the Azure Blob
Storage container to mount on the cluster.
:type container_name: str
:param credentials: Required. Information of the Azure Blob Storage
account credentials.
:param credentials: Required. Credentials. Information about the Azure
storage credentials.
:type credentials: ~azure.mgmt.batchai.models.AzureStorageCredentialsInfo
:param relative_mount_path: Required. Specifies the relative path on the
compute node where the Azure Blob file system will be mounted. Note that
all cluster level blob file systems will be mounted under
$AZ_BATCHAI_MOUNT_ROOT location and all job level blob file systems will
be mounted under $AZ_BATCHAI_JOB_MOUNT_ROOT.
:param relative_mount_path: Required. Relative mount path. The relative
path on the compute node where the Azure File container will be mounted.
Note that all cluster level containers will be mounted under
$AZ_BATCHAI_MOUNT_ROOT location and all job level containers will be
mounted under $AZ_BATCHAI_JOB_MOUNT_ROOT.
:type relative_mount_path: str
:param mount_options: Specifies the various mount options that can be used
to configure Blob file system.
:param mount_options: Mount options. Mount options for mounting blobfuse
file system.
:type mount_options: str
"""

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,27 +13,27 @@


class AzureBlobFileSystemReference(Model):
"""Provides required information, for the service to be able to mount Azure
Blob Storage container on the cluster nodes.
"""Azure Blob Storage Container mounting configuration.

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

:param account_name: Required. Name of the Azure Blob Storage account.
:param account_name: Required. Account name. Name of the Azure storage
account.
:type account_name: str
:param container_name: Required. Name of the Azure Blob Storage container
to mount on the cluster.
:param container_name: Required. Container name. Name of the Azure Blob
Storage container to mount on the cluster.
:type container_name: str
:param credentials: Required. Information of the Azure Blob Storage
account credentials.
:param credentials: Required. Credentials. Information about the Azure
storage credentials.
:type credentials: ~azure.mgmt.batchai.models.AzureStorageCredentialsInfo
:param relative_mount_path: Required. Specifies the relative path on the
compute node where the Azure Blob file system will be mounted. Note that
all cluster level blob file systems will be mounted under
$AZ_BATCHAI_MOUNT_ROOT location and all job level blob file systems will
be mounted under $AZ_BATCHAI_JOB_MOUNT_ROOT.
:param relative_mount_path: Required. Relative mount path. The relative
path on the compute node where the Azure File container will be mounted.
Note that all cluster level containers will be mounted under
$AZ_BATCHAI_MOUNT_ROOT location and all job level containers will be
mounted under $AZ_BATCHAI_JOB_MOUNT_ROOT.
:type relative_mount_path: str
:param mount_options: Specifies the various mount options that can be used
to configure Blob file system.
:param mount_options: Mount options. Mount options for mounting blobfuse
file system.
:type mount_options: str
"""

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,27 +13,30 @@


class AzureFileShareReference(Model):
"""Details of the Azure File Share to mount on the cluster.
"""Azure File Share mounting configuration.

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

:param account_name: Required. Name of the storage account.
:param account_name: Required. Account name. Name of the Azure storage
account.
:type account_name: str
:param azure_file_url: Required. URL to access the Azure File.
:param azure_file_url: Required. Azure File URL. URL to access the Azure
File.
:type azure_file_url: str
:param credentials: Required. Information of the Azure File credentials.
:param credentials: Required. Credentials. Information about the Azure
storage credentials.
:type credentials: ~azure.mgmt.batchai.models.AzureStorageCredentialsInfo
:param relative_mount_path: Required. Specifies the relative path on the
compute node where the Azure file share will be mounted. Note that all
cluster level file shares will be mounted under $AZ_BATCHAI_MOUNT_ROOT
location and all job level file shares will be mounted under
$AZ_BATCHAI_JOB_MOUNT_ROOT.
:param relative_mount_path: Required. Relative mount path. The relative
path on the compute node where the Azure File share will be mounted. Note
that all cluster level file shares will be mounted under
$AZ_BATCHAI_MOUNT_ROOT location and all job level file shares will be
mounted under $AZ_BATCHAI_JOB_MOUNT_ROOT.
:type relative_mount_path: str
:param file_mode: Specifies the file mode. Default value is 0777. Valid
only if OS is linux. Default value: "0777" .
:param file_mode: File mode. File mode for files on the mounted file
share. Default value: 0777. Default value: "0777" .
:type file_mode: str
:param directory_mode: Specifies the directory Mode. Default value is
0777. Valid only if OS is linux. Default value: "0777" .
:param directory_mode: Directory mode. File mode for directories on the
mounted file share. Default value: 0777. Default value: "0777" .
:type directory_mode: str
"""

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,27 +13,30 @@


class AzureFileShareReference(Model):
"""Details of the Azure File Share to mount on the cluster.
"""Azure File Share mounting configuration.

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

:param account_name: Required. Name of the storage account.
:param account_name: Required. Account name. Name of the Azure storage
account.
:type account_name: str
:param azure_file_url: Required. URL to access the Azure File.
:param azure_file_url: Required. Azure File URL. URL to access the Azure
File.
:type azure_file_url: str
:param credentials: Required. Information of the Azure File credentials.
:param credentials: Required. Credentials. Information about the Azure
storage credentials.
:type credentials: ~azure.mgmt.batchai.models.AzureStorageCredentialsInfo
:param relative_mount_path: Required. Specifies the relative path on the
compute node where the Azure file share will be mounted. Note that all
cluster level file shares will be mounted under $AZ_BATCHAI_MOUNT_ROOT
location and all job level file shares will be mounted under
$AZ_BATCHAI_JOB_MOUNT_ROOT.
:param relative_mount_path: Required. Relative mount path. The relative
path on the compute node where the Azure File share will be mounted. Note
that all cluster level file shares will be mounted under
$AZ_BATCHAI_MOUNT_ROOT location and all job level file shares will be
mounted under $AZ_BATCHAI_JOB_MOUNT_ROOT.
:type relative_mount_path: str
:param file_mode: Specifies the file mode. Default value is 0777. Valid
only if OS is linux. Default value: "0777" .
:param file_mode: File mode. File mode for files on the mounted file
share. Default value: 0777. Default value: "0777" .
:type file_mode: str
:param directory_mode: Specifies the directory Mode. Default value is
0777. Valid only if OS is linux. Default value: "0777" .
:param directory_mode: Directory mode. File mode for directories on the
mounted file share. Default value: 0777. Default value: "0777" .
:type directory_mode: str
"""

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,14 @@


class AzureStorageCredentialsInfo(Model):
"""Credentials to access Azure File Share.
"""Azure storage account credentials.

:param account_key: Storage account key. One of accountKey or
:param account_key: Account key. Storage account key. One of accountKey or
accountKeySecretReference must be specified.
:type account_key: str
:param account_key_secret_reference: Specifies the location of the storage
account key, which is a Key Vault Secret. Users can store their secrets in
Azure KeyVault and pass it to the Batch AI Service to integrate with
KeyVault. One of accountKey or accountKeySecretReference must be
specified.
:param account_key_secret_reference: Account key secret reference.
Information about KeyVault secret storing the storage account key. One of
accountKey or accountKeySecretReference must be specified.
:type account_key_secret_reference:
~azure.mgmt.batchai.models.KeyVaultSecretReference
"""
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,14 @@


class AzureStorageCredentialsInfo(Model):
"""Credentials to access Azure File Share.
"""Azure storage account credentials.

:param account_key: Storage account key. One of accountKey or
:param account_key: Account key. Storage account key. One of accountKey or
accountKeySecretReference must be specified.
:type account_key: str
:param account_key_secret_reference: Specifies the location of the storage
account key, which is a Key Vault Secret. Users can store their secrets in
Azure KeyVault and pass it to the Batch AI Service to integrate with
KeyVault. One of accountKey or accountKeySecretReference must be
specified.
:param account_key_secret_reference: Account key secret reference.
Information about KeyVault secret storing the storage account key. One of
accountKey or accountKeySecretReference must be specified.
:type account_key_secret_reference:
~azure.mgmt.batchai.models.KeyVaultSecretReference
"""
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ class BatchAIError(Model):
Variables are only populated by the server, and will be ignored when
sending a request.

:ivar code: An identifier for the error. Codes are invariant and are
:ivar code: An identifier of the error. Codes are invariant and are
intended to be consumed programmatically.
:vartype code: str
:ivar message: A message describing the error, intended to be suitable for
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ class BatchAIError(Model):
Variables are only populated by the server, and will be ignored when
sending a request.

:ivar code: An identifier for the error. Codes are invariant and are
:ivar code: An identifier of the error. Codes are invariant and are
intended to be consumed programmatically.
:vartype code: str
:ivar message: A message describing the error, intended to be suitable for
Expand Down
13 changes: 7 additions & 6 deletions azure-mgmt-batchai/azure/mgmt/batchai/models/caffe2_settings.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,18 @@


class Caffe2Settings(Model):
"""Specifies the settings for Caffe2 job.
"""Caffe2 job settings.

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

:param python_script_file_path: Required. The path and file name of the
python script to execute the job.
:param python_script_file_path: Required. Python script file path. The
python script to execute.
:type python_script_file_path: str
:param python_interpreter_path: The path to python interpreter.
:param python_interpreter_path: Python interpreter path. The path to the
Python interpreter.
:type python_interpreter_path: str
:param command_line_args: Command line arguments that needs to be passed
to the python script.
:param command_line_args: Command line arguments. Command line arguments
that need to be passed to the python script.
:type command_line_args: str
"""

Expand Down
Loading