Skip to content

Commit f994d4e

Browse files
author
Larry Franks
committed
updating to add identity information
1 parent bc8c314 commit f994d4e

File tree

3 files changed

+37
-4
lines changed

3 files changed

+37
-4
lines changed

articles/machine-learning/reference-yaml-job-command.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ ms.custom: cliv2, event-tier1-build-2022
1010

1111
author: balapv
1212
ms.author: balapv
13-
ms.date: 08/08/2022
13+
ms.date: 11/28/2022
1414
ms.reviewer: larryfr
1515
---
1616

@@ -48,6 +48,7 @@ The source JSON schema can be found at https://azuremlschemas.azureedge.net/late
4848
| `inputs.<input_name>` | number, integer, boolean, string or object | One of a literal value (of type number, integer, boolean, or string) or an object containing a [job input data specification](#job-inputs). | | |
4949
| `outputs` | object | Dictionary of output configurations of the job. The key is a name for the output within the context of the job and the value is the output configuration. <br><br> Outputs can be referenced in the `command` using the `${{ outputs.<output_name> }}` expression. | |
5050
| `outputs.<output_name>` | object | You can leave the object empty, in which case by default the output will be of type `uri_folder` and Azure ML will system-generate an output location for the output. File(s) to the output directory will be written via read-write mount. If you want to specify a different mode for the output, provide an object containing the [job output specification](#job-outputs). | |
51+
| `identity` | object | The identity is used for data accessing. It can be [UserIdentityConfiguration](#useridentityconfiguration), [ManagedIdentityConfiguration](#managedidentityconfiguration) or None. If it's UserIdentityConfiguration the identity of job submitter will be used to access input data and write result to output folder, otherwise, the managed identity of the compute target will be used | |
5152

5253
### Distribution configurations
5354

@@ -88,6 +89,16 @@ The source JSON schema can be found at https://azuremlschemas.azureedge.net/late
8889
| `type` | string | The type of job output. For the default `uri_folder` type, the output will correspond to a folder. | `uri_folder` , `mlflow_model`, `custom_model`| `uri_folder` |
8990
| `mode` | string | Mode of how output file(s) will get delivered to the destination storage. For read-write mount mode (`rw_mount`) the output directory will be a mounted directory. For upload mode the file(s) written will get uploaded at the end of the job. | `rw_mount`, `upload` | `rw_mount` |
9091

92+
### Identity configurations
93+
94+
#### UserIdentityConfiguration
95+
96+
| Key | Type | Description | Allowed values |
97+
| --- | ---- | ----------- | -------------- |
98+
| `type` | const | **Required.** Identity type. | `user_identity` |
99+
100+
#### ManagedIdentityConfiguration| Key | Type | Description | Allowed values | | --- | ---- | ----------- | -------------- | | `type` | const | **Required.** Identity type. | `managed` or `managed_identity` |
101+
91102
## Remarks
92103

93104
The `az ml job` command can be used for managing Azure Machine Learning jobs.

articles/machine-learning/reference-yaml-job-pipeline.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ms.topic: reference
99
ms.custom: cliv2, event-tier1-build-2022
1010
author: cloga
1111
ms.author: lochen
12-
ms.date: 08/08/2022
12+
ms.date: 11/28/2022
1313
ms.reviewer: scottpolly
1414
---
1515

@@ -42,6 +42,7 @@ The source JSON schema can be found at https://azuremlschemas.azureedge.net/late
4242
| `inputs.<input_name>` | number, integer, boolean, string or object | One of a literal value (of type number, integer, boolean, or string) or an object containing a [job input data specification](#job-inputs). | | |
4343
| `outputs` | object | Dictionary of output configurations of the pipeline job. The key is a name for the output within the context of the job and the value is the output configuration. <br><br> These pipeline outputs can be referenced by the outputs of an individual step job in the pipeline using the `${{ parents.outputs.<output_name> }}` expression. For more information on how to bind the inputs of a pipeline step to the inputs of the top-level pipeline job, see the [Expression syntax for binding inputs and outputs between steps in a pipeline job](reference-yaml-core-syntax.md#binding-inputs-and-outputs-between-steps-in-a-pipeline-job). | |
4444
| `outputs.<output_name>` | object | You can leave the object empty, in which case by default the output will be of type `uri_folder` and Azure ML will system-generate an output location for the output based on the following templatized path: `{settings.datastore}/azureml/{job-name}/{output-name}/`. File(s) to the output directory will be written via read-write mount. If you want to specify a different mode for the output, provide an object containing the [job output specification](#job-outputs). | |
45+
| `identity` | object | The identity is used for data accessing. It can be [UserIdentityConfiguration](#useridentityconfiguration), [ManagedIdentityConfiguration](#managedidentityconfiguration) or None. If it's UserIdentityConfiguration the identity of job submitter will be used to access input data and write result to output folder, otherwise, the managed identity of the compute target will be used | |
4546

4647
### Attributes of the `settings` key
4748

@@ -66,6 +67,16 @@ The source JSON schema can be found at https://azuremlschemas.azureedge.net/late
6667
| `type` | string | The type of job output. For the default `uri_folder` type, the output will correspond to a folder. | `uri_file`, `uri_folder`, `mltable`, `mlflow_model` | `uri_folder` |
6768
| `mode` | string | Mode of how output file(s) will get delivered to the destination storage. For read-write mount mode (`rw_mount`) the output directory will be a mounted directory. For upload mode the file(s) written will get uploaded at the end of the job. | `rw_mount`, `upload` | `rw_mount` |
6869

70+
### Identity configurations
71+
72+
#### UserIdentityConfiguration
73+
74+
| Key | Type | Description | Allowed values |
75+
| --- | ---- | ----------- | -------------- |
76+
| `type` | const | **Required.** Identity type. | `user_identity` |
77+
78+
#### ManagedIdentityConfiguration| Key | Type | Description | Allowed values | | --- | ---- | ----------- | -------------- | | `type` | const | **Required.** Identity type. | `managed` or `managed_identity` |
79+
6980
## Remarks
7081

7182
The `az ml job` commands can be used for managing Azure Machine Learning pipeline jobs.

articles/machine-learning/reference-yaml-job-sweep.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ ms.topic: reference
99
ms.custom: cliv2, event-tier1-build-2022
1010
ms.author: amipatel
1111
author: amibp
12-
ms.date: 08/08/2022
13-
ms.reviewer: nibaccam
12+
ms.date: 11/28/2022
13+
ms.reviewer: larryfr
1414
---
1515

1616
# CLI (v2) sweep job YAML schema
@@ -47,6 +47,7 @@ The source JSON schema can be found at https://azuremlschemas.azureedge.net/late
4747
| `inputs.<input_name>` | number, integer, boolean, string or object | One of a literal value (of type number, integer, boolean, or string) or an object containing a [job input data specification](#job-inputs). | | |
4848
| `outputs` | object | Dictionary of output configurations of the job. The key is a name for the output within the context of the job and the value is the output configuration. <br><br> Outputs can be referenced in the `command` using the `${{ outputs.<output_name> }}` expression. | |
4949
| `outputs.<output_name>` | object | You can leave the object empty, in which case by default the output will be of type `uri_folder` and Azure ML will system-generate an output location for the output. File(s) to the output directory will be written via read-write mount. If you want to specify a different mode for the output, provide an object containing the [job output specification](#job-outputs). | |
50+
| `identity` | object | The identity is used for data accessing. It can be [UserIdentityConfiguration](#useridentityconfiguration), [ManagedIdentityConfiguration](#managedidentityconfiguration) or None. If it's UserIdentityConfiguration the identity of job submitter will be used to access input data and write result to output folder, otherwise, the managed identity of the compute target will be used | |
5051

5152
### Sampling algorithms
5253

@@ -216,6 +217,16 @@ The source JSON schema can be found at https://azuremlschemas.azureedge.net/late
216217
| `type` | string | The type of job output. For the default `uri_folder` type, the output will correspond to a folder. | `uri_file`, `uri_folder`, `mltable`, `mlflow_model` | `uri_folder` |
217218
| `mode` | string | Mode of how output file(s) will get delivered to the destination storage. For read-write mount mode (`rw_mount`) the output directory will be a mounted directory. For upload mode the file(s) written will get uploaded at the end of the job. | `rw_mount`, `upload` | `rw_mount` |
218219

220+
### Identity configurations
221+
222+
#### UserIdentityConfiguration
223+
224+
| Key | Type | Description | Allowed values |
225+
| --- | ---- | ----------- | -------------- |
226+
| `type` | const | **Required.** Identity type. | `user_identity` |
227+
228+
#### ManagedIdentityConfiguration| Key | Type | Description | Allowed values | | --- | ---- | ----------- | -------------- | | `type` | const | **Required.** Identity type. | `managed` or `managed_identity` |
229+
219230
## Remarks
220231

221232
The `az ml job` command can be used for managing Azure Machine Learning jobs.

0 commit comments

Comments
 (0)