Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

typo: batchai/resource-manager/Microsoft.BatchAI/BatchAI #4546

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 @@ -236,7 +236,7 @@
],
"responses": {
"200": {
"description": "The operation was successful. The response contains information abouth the cluster.",
"description": "The operation was successful. The response contains information about the cluster.",
"schema": {
"$ref": "#/definitions/Cluster"
}
Expand Down Expand Up @@ -1518,7 +1518,7 @@
"NodeSetup": {
"properties": {
"setupTask": {
"title": "Specifies a setup task which can be used to customize the compute nodes of the cluster. The NodeSetup task runs everytime a VM is rebooted. For that reason the task code needs to be idempotent. Generally it is used to either download static data that is required for all jobs that run on the cluster VMs or to download/install software.",
"title": "Specifies a setup task which can be used to customize the compute nodes of the cluster. The NodeSetup task runs every time a VM is rebooted. For that reason the task code needs to be idempotent. Generally it is used to either download static data that is required for all jobs that run on the cluster VMs or to download/install software.",
"$ref": "#/definitions/SetupTask"
},
"mountVolumes": {
Expand Down Expand Up @@ -1608,7 +1608,7 @@
"vmPriority": {
"type": "string",
"title": "dedicated or lowpriority.",
"description": "The default value is dedicated. The node can get preempted while the task is running if lowpriority is choosen. This is best suited if the workload is checkpointing and can be restarted.",
"description": "The default value is dedicated. The node can get preempted while the task is running if lowpriority is chosen. This is best suited if the workload is checkpointing and can be restarted.",
"default": "dedicated",
"enum": [
"dedicated",
Expand Down Expand Up @@ -1997,7 +1997,7 @@
"executionState": {
"type": "string",
"title": "The current state of the job.",
"description": "The current state of the job. Possible values are: queued - The job is queued and able to run. A job enters this state when it is created, or when it is awaiting a retry after a failed run. running - The job is running on a compute cluster. This includes job-level preparation such as downloading resource files or set up container specified on the job - it does not necessarily mean that the job command line has started executing. terminating - The job is terminated by the user, the terminate operation is in progress. succeeded - The job has completed running succesfully and exited with exit code 0. failed - The job has finished unsuccessfully (failed with a non-zero exit code) and has exhausted its retry limit. A job is also marked as failed if an error occurred launching the job.",
"description": "The current state of the job. Possible values are: queued - The job is queued and able to run. A job enters this state when it is created, or when it is awaiting a retry after a failed run. running - The job is running on a compute cluster. This includes job-level preparation such as downloading resource files or set up container specified on the job - it does not necessarily mean that the job command line has started executing. terminating - The job is terminated by the user, the terminate operation is in progress. succeeded - The job has completed running successfully and exited with exit code 0. failed - The job has finished unsuccessfully (failed with a non-zero exit code) and has exhausted its retry limit. A job is also marked as failed if an error occurred launching the job.",
"enum": [
"queued",
"running",
Expand Down Expand Up @@ -2148,7 +2148,7 @@
},
"downloadUrl": {
"type": "string",
"title": "file downloand url, example: https://mystg.blob.core.windows.net/mycontainer/myModel_1.dnn",
"title": "file download url, example: https://mystg.blob.core.windows.net/mycontainer/myModel_1.dnn",
"description": "This will be returned only if the model has been archived. During job run, this won't be returned and customers can use SSH tunneling to download. Users can use Get Remote Login Information API to get the IP address and port information of all the compute nodes running the job."
},
"properties": {
Expand Down Expand Up @@ -2740,7 +2740,7 @@
"parameterServerCount": {
"type": "integer",
"format": "int32",
"title": "The number of parmeter server tasks.",
"title": "The number of parameter server tasks.",
"description": "If specified, the value must be less than or equal to nodeCount. If not specified, the default value is equal to 1 for distributed TensorFlow training (This property is not applicable for single machine training). This property can be specified only for distributed TensorFlow training."
}
},
Expand Down Expand Up @@ -2929,7 +2929,7 @@
"required": false,
"type": "string",
"x-ms-parameter-location": "method",
"description": "An OData $select clause. Used to select the properties to be returned in the GET respnose.",
"description": "An OData $select clause. Used to select the properties to be returned in the GET response.",
"x-ms-parameter-grouping": {
"postfix": "Options"
}
Expand All @@ -2940,7 +2940,7 @@
"required": false,
"type": "string",
"x-ms-parameter-location": "method",
"description": "An OData $filter clause.. Used to filter results that are returned in the GET respnose.",
"description": "An OData $filter clause. Used to filter results that are returned in the GET response.",
"x-ms-parameter-grouping": {
"postfix": "Options"
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -277,7 +277,7 @@
],
"responses": {
"200": {
"description": "The operation was successful. The response contains information abouth the cluster.",
"description": "The operation was successful. The response contains information about the cluster.",
"schema": {
"$ref": "#/definitions/Cluster"
}
Expand Down Expand Up @@ -1656,7 +1656,7 @@
},
"instrumentationKeySecretReference": {
"title": "Specifies a KeyVault Secret containing Azure Application Insights instrumentation key.",
"description": "Specifies KeyVault Store and Secret which contains Azure Application Insights instrumentation key. One of instumentationKey or instrumentationKeySecretReference must be specified.",
"description": "Specifies KeyVault Store and Secret which contains Azure Application Insights instrumentation key. One of instrumentationKey or instrumentationKeySecretReference must be specified.",
"$ref": "#/definitions/KeyVaultSecretReference"
}
},
Expand All @@ -1668,7 +1668,7 @@
"NodeSetup": {
"properties": {
"setupTask": {
"title": "Specifies a setup task which can be used to customize the compute nodes of the cluster. The NodeSetup task runs everytime a VM is rebooted. For that reason the task code needs to be idempotent. Generally it is used to either download static data that is required for all jobs that run on the cluster VMs or to download/install software.",
"title": "Specifies a setup task which can be used to customize the compute nodes of the cluster. The NodeSetup task runs every time a VM is rebooted. For that reason the task code needs to be idempotent. Generally it is used to either download static data that is required for all jobs that run on the cluster VMs or to download/install software.",
"$ref": "#/definitions/SetupTask"
},
"mountVolumes": {
Expand Down Expand Up @@ -1717,7 +1717,7 @@
"stdOutErrPathSuffix": {
"type": "string",
"title": "A path segment appended by Batch AI to stdOutErrPathPrefix to form a path where stdout and stderr of the setup task will be uploaded.",
"description": "Batch AI creates the setup task output directories under an unique path to avoid conflicts between different clusters. You can concatinate stdOutErrPathPrefix and stdOutErrPathSuffix to get the full path to the output directory.",
"description": "Batch AI creates the setup task output directories under an unique path to avoid conflicts between different clusters. You can concatenate stdOutErrPathPrefix and stdOutErrPathSuffix to get the full path to the output directory.",
"readOnly": true
}
},
Expand Down Expand Up @@ -1778,7 +1778,7 @@
"vmPriority": {
"type": "string",
"title": "dedicated or lowpriority.",
"description": "The default value is dedicated. The node can get preempted while the task is running if lowpriority is choosen. This is best suited if the workload is checkpointing and can be restarted.",
"description": "The default value is dedicated. The node can get preempted while the task is running if lowpriority is chosen. This is best suited if the workload is checkpointing and can be restarted.",
"default": "dedicated",
"enum": [
"dedicated",
Expand Down Expand Up @@ -1930,7 +1930,7 @@
},
"mountVolumes": {
"title": "Information on mount volumes to be used by the job.",
"description": "These volumes will be mounted before the job execution and will be unmouted after the job completion. The volumes will be mounted at location specified by $AZ_BATCHAI_JOB_MOUNT_ROOT environment variable.",
"description": "These volumes will be mounted before the job execution and will be unmounted after the job completion. The volumes will be mounted at location specified by $AZ_BATCHAI_JOB_MOUNT_ROOT environment variable.",
"$ref": "#/definitions/MountVolumes"
},
"nodeCount": {
Expand Down Expand Up @@ -2074,7 +2074,7 @@
},
"mountVolumes": {
"title": "Information on mount volumes to be used by the job.",
"description": "These volumes will be mounted before the job execution and will be unmouted after the job completion. The volumes will be mounted at location specified by $AZ_BATCHAI_JOB_MOUNT_ROOT environment variable.",
"description": "These volumes will be mounted before the job execution and will be unmounted after the job completion. The volumes will be mounted at location specified by $AZ_BATCHAI_JOB_MOUNT_ROOT environment variable.",
"$ref": "#/definitions/MountVolumes"
},
"jobOutputDirectoryPathSegment": {
Expand Down Expand Up @@ -2206,7 +2206,7 @@
"executionState": {
"type": "string",
"title": "The current state of the job.",
"description": "The current state of the job. Possible values are: queued - The job is queued and able to run. A job enters this state when it is created, or when it is awaiting a retry after a failed run. running - The job is running on a compute cluster. This includes job-level preparation such as downloading resource files or set up container specified on the job - it does not necessarily mean that the job command line has started executing. terminating - The job is terminated by the user, the terminate operation is in progress. succeeded - The job has completed running succesfully and exited with exit code 0. failed - The job has finished unsuccessfully (failed with a non-zero exit code) and has exhausted its retry limit. A job is also marked as failed if an error occurred launching the job.",
"description": "The current state of the job. Possible values are: queued - The job is queued and able to run. A job enters this state when it is created, or when it is awaiting a retry after a failed run. running - The job is running on a compute cluster. This includes job-level preparation such as downloading resource files or set up container specified on the job - it does not necessarily mean that the job command line has started executing. terminating - The job is terminated by the user, the terminate operation is in progress. succeeded - The job has completed running successfully and exited with exit code 0. failed - The job has finished unsuccessfully (failed with a non-zero exit code) and has exhausted its retry limit. A job is also marked as failed if an error occurred launching the job.",
"enum": [
"queued",
"running",
Expand Down Expand Up @@ -2742,7 +2742,7 @@
"relativeMountPath": {
"type": "string",
"title": "Specifies the relative path on the compute node where the File Server will be mounted.",
"description": "Note that all cluster level file servers will be mounted under $AZ_BATCHAI_MOUNT_ROOT location and job level file servers will be mouted under $AZ_BATCHAI_JOB_MOUNT_ROOT."
"description": "Note that all cluster level file servers will be mounted under $AZ_BATCHAI_MOUNT_ROOT location and job level file servers will be mounted under $AZ_BATCHAI_JOB_MOUNT_ROOT."
},
"mountOptions": {
"type": "string",
Expand Down Expand Up @@ -3005,7 +3005,7 @@
"parameterServerCount": {
"type": "integer",
"format": "int32",
"title": "The number of parmeter server tasks.",
"title": "The number of parameter server tasks.",
"description": "If specified, the value must be less than or equal to nodeCount. If not specified, the default value is equal to 1 for distributed TensorFlow training (This property is not applicable for single machine training). This property can be specified only for distributed TensorFlow training."
}
},
Expand Down Expand Up @@ -3193,7 +3193,7 @@
"required": false,
"type": "string",
"x-ms-parameter-location": "method",
"description": "An OData $select clause. Used to select the properties to be returned in the GET respnose.",
"description": "An OData $select clause. Used to select the properties to be returned in the GET response.",
"x-ms-parameter-grouping": {
"postfix": "Options"
}
Expand All @@ -3204,7 +3204,7 @@
"required": false,
"type": "string",
"x-ms-parameter-location": "method",
"description": "An OData $filter clause.. Used to filter results that are returned in the GET respnose.",
"description": "An OData $filter clause. Used to filter results that are returned in the GET response.",
"x-ms-parameter-grouping": {
"postfix": "Options"
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1606,7 +1606,7 @@
"properties": {
"sourceVault": {
"title": "Key Vault resource identifier.",
"description": "Fully qualified resource indentifier of the Key Vault.",
"description": "Fully qualified resource identifier of the Key Vault.",
"$ref": "#/definitions/ResourceId"
},
"secretUrl": {
Expand Down Expand Up @@ -2297,7 +2297,7 @@
},
"mountVolumes": {
"title": "Mount volumes.",
"description": "Information on mount volumes to be used by the job. These volumes will be mounted before the job execution and will be unmouted after the job completion. The volumes will be mounted at location specified by $AZ_BATCHAI_JOB_MOUNT_ROOT environment variable.",
"description": "Information on mount volumes to be used by the job. These volumes will be mounted before the job execution and will be unmounted after the job completion. The volumes will be mounted at location specified by $AZ_BATCHAI_JOB_MOUNT_ROOT environment variable.",
"$ref": "#/definitions/MountVolumes"
},
"nodeCount": {
Expand Down Expand Up @@ -2452,7 +2452,7 @@
},
"mountVolumes": {
"title": "Mount volumes.",
"description": "Collection of mount volumes available to the job during execution. These volumes are mounted before the job execution and unmouted after the job completion. The volumes are mounted at location specified by $AZ_BATCHAI_JOB_MOUNT_ROOT environment variable.",
"description": "Collection of mount volumes available to the job during execution. These volumes are mounted before the job execution and unmounted after the job completion. The volumes are mounted at location specified by $AZ_BATCHAI_JOB_MOUNT_ROOT environment variable.",
"$ref": "#/definitions/MountVolumes"
},
"nodeCount": {
Expand Down Expand Up @@ -2602,7 +2602,7 @@
"readOnly": true,
"type": "string",
"title": "Execution state.",
"description": "The current state of the job. Possible values are: queued - The job is queued and able to run. A job enters this state when it is created, or when it is awaiting a retry after a failed run. running - The job is running on a compute cluster. This includes job-level preparation such as downloading resource files or set up container specified on the job - it does not necessarily mean that the job command line has started executing. terminating - The job is terminated by the user, the terminate operation is in progress. succeeded - The job has completed running succesfully and exited with exit code 0. failed - The job has finished unsuccessfully (failed with a non-zero exit code) and has exhausted its retry limit. A job is also marked as failed if an error occurred launching the job.",
"description": "The current state of the job. Possible values are: queued - The job is queued and able to run. A job enters this state when it is created, or when it is awaiting a retry after a failed run. running - The job is running on a compute cluster. This includes job-level preparation such as downloading resource files or set up container specified on the job - it does not necessarily mean that the job command line has started executing. terminating - The job is terminated by the user, the terminate operation is in progress. succeeded - The job has completed running successfully and exited with exit code 0. failed - The job has finished unsuccessfully (failed with a non-zero exit code) and has exhausted its retry limit. A job is also marked as failed if an error occurred launching the job.",
"enum": [
"queued",
"running",
Expand Down Expand Up @@ -3041,7 +3041,7 @@
"id": {
"type": "string",
"title": "ID.",
"description": "The ID of the output directory. The job can use AZ_BATCHAI_OUTPUT_<id> environment variale to find the directory path, where <id> is the value of id attribute."
"description": "The ID of the output directory. The job can use AZ_BATCHAI_OUTPUT_<id> environment variable to find the directory path, where <id> is the value of id attribute."
},
"pathPrefix": {
"type": "string",
Expand Down Expand Up @@ -3196,7 +3196,7 @@
"description": "The relative path on the compute node where the unmanaged file system will be mounted. Note that all cluster level unmanaged file systems will be mounted under $AZ_BATCHAI_MOUNT_ROOT location and all job level unmanaged file systems will be mounted under $AZ_BATCHAI_JOB_MOUNT_ROOT."
}
},
"description": "Unmananged file system mounting configuration.",
"description": "Unmanaged file system mounting configuration.",
"required": [
"mountCommand",
"relativeMountPath"
Expand Down