|
42 | 42 | type: command
|
43 | 43 | short-summary: "Create a factory."
|
44 | 44 | parameters:
|
45 |
| - - name: --factory-vsts-configuration |
46 |
| - short-summary: "Factory's VSTS repo information." |
| 45 | + - name: --identity |
| 46 | + short-summary: "User assigned identity to use to authenticate to customer's key vault. If not provided Managed \ |
| 47 | +Service Identity will be used." |
47 | 48 | long-summary: |
|
48 |
| - Usage: --factory-vsts-configuration project-name=XX tenant-id=XX type=XX account-name=XX \ |
49 |
| -repository-name=XX collaboration-branch=XX root-folder=XX last-commit-id=XX |
50 |
| -
|
51 |
| - project-name: Required. VSTS project name. |
52 |
| - tenant-id: VSTS tenant id. |
53 |
| - type: Required. Type of repo configuration. |
54 |
| - account-name: Required. Account name. |
55 |
| - repository-name: Required. Repository name. |
56 |
| - collaboration-branch: Required. Collaboration branch. |
57 |
| - root-folder: Required. Root folder. |
58 |
| - last-commit-id: Last commit id. |
59 |
| - - name: --factory-git-hub-configuration |
60 |
| - short-summary: "Factory's GitHub repo information." |
61 |
| - long-summary: | |
62 |
| - Usage: --factory-git-hub-configuration host-name=XX type=XX account-name=XX repository-name=XX \ |
63 |
| -collaboration-branch=XX root-folder=XX last-commit-id=XX |
| 49 | + Usage: --identity user-assigned-identity=XX |
64 | 50 |
|
65 |
| - host-name: GitHub Enterprise host name. For example: https://github.mydomain.com |
66 |
| - type: Required. Type of repo configuration. |
67 |
| - account-name: Required. Account name. |
68 |
| - repository-name: Required. Repository name. |
69 |
| - collaboration-branch: Required. Collaboration branch. |
70 |
| - root-folder: Required. Root folder. |
71 |
| - last-commit-id: Last commit id. |
| 51 | + user-assigned-identity: The resource id of the user assigned identity to authenticate to customer's key \ |
| 52 | +vault. |
72 | 53 | examples:
|
73 | 54 | - name: Factories_CreateOrUpdate
|
74 | 55 | text: |-
|
|
98 | 79 | helps['datafactory configure-factory-repo'] = """
|
99 | 80 | type: command
|
100 | 81 | short-summary: "Updates a factory's repo information."
|
101 |
| - parameters: |
102 |
| - - name: --factory-vsts-configuration |
103 |
| - short-summary: "Factory's VSTS repo information." |
104 |
| - long-summary: | |
105 |
| - Usage: --factory-vsts-configuration project-name=XX tenant-id=XX type=XX account-name=XX \ |
106 |
| -repository-name=XX collaboration-branch=XX root-folder=XX last-commit-id=XX |
107 |
| -
|
108 |
| - project-name: Required. VSTS project name. |
109 |
| - tenant-id: VSTS tenant id. |
110 |
| - type: Required. Type of repo configuration. |
111 |
| - account-name: Required. Account name. |
112 |
| - repository-name: Required. Repository name. |
113 |
| - collaboration-branch: Required. Collaboration branch. |
114 |
| - root-folder: Required. Root folder. |
115 |
| - last-commit-id: Last commit id. |
116 |
| - - name: --factory-git-hub-configuration |
117 |
| - short-summary: "Factory's GitHub repo information." |
118 |
| - long-summary: | |
119 |
| - Usage: --factory-git-hub-configuration host-name=XX type=XX account-name=XX repository-name=XX \ |
120 |
| -collaboration-branch=XX root-folder=XX last-commit-id=XX |
121 |
| -
|
122 |
| - host-name: GitHub Enterprise host name. For example: https://github.mydomain.com |
123 |
| - type: Required. Type of repo configuration. |
124 |
| - account-name: Required. Account name. |
125 |
| - repository-name: Required. Repository name. |
126 |
| - collaboration-branch: Required. Collaboration branch. |
127 |
| - root-folder: Required. Root folder. |
128 |
| - last-commit-id: Last commit id. |
129 | 82 | examples:
|
130 | 83 | - name: Factories_ConfigureFactoryRepo
|
131 | 84 | text: |-
|
132 | 85 | az datafactory configure-factory-repo --factory-resource-id "/subscriptions/12345678-1234-1234-1234-1234\
|
133 | 86 | 5678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName" \
|
134 |
| ---factory-vsts-configuration account-name="ADF" collaboration-branch="master" last-commit-id="" project-name="project" \ |
135 |
| -repository-name="repo" root-folder="/" tenant-id="" --location "East US" |
| 87 | +--repo-configuration "{\\"type\\":\\"FactoryVSTSConfiguration\\",\\"accountName\\":\\"ADF\\",\\"collaborationBranch\\":\ |
| 88 | +\\"master\\",\\"lastCommitId\\":\\"\\",\\"projectName\\":\\"project\\",\\"repositoryName\\":\\"repo\\",\\"rootFolder\\"\ |
| 89 | +:\\"/\\",\\"tenantId\\":\\"\\"}" --location "East US" |
136 | 90 | """
|
137 | 91 |
|
138 | 92 | helps['datafactory get-data-plane-access'] = """
|
|
149 | 103 | helps['datafactory get-git-hub-access-token'] = """
|
150 | 104 | type: command
|
151 | 105 | short-summary: "Get GitHub Access Token."
|
| 106 | + parameters: |
| 107 | + - name: --git-hub-client-secret |
| 108 | + short-summary: "GitHub bring your own app client secret information." |
| 109 | + long-summary: | |
| 110 | + Usage: --git-hub-client-secret byoa-secret-akv-url=XX byoa-secret-name=XX |
| 111 | +
|
| 112 | + byoa-secret-akv-url: Bring your own app client secret AKV URL. |
| 113 | + byoa-secret-name: Bring your own app client secret name in AKV. |
152 | 114 | examples:
|
153 | 115 | - name: Factories_GetGitHubAccessToken
|
154 | 116 | text: |-
|
|
206 | 168 | helps['datafactory integration-runtime managed create'] = """
|
207 | 169 | type: command
|
208 | 170 | short-summary: "Create an integration runtime."
|
| 171 | + parameters: |
| 172 | + - name: --managed-virtual-network |
| 173 | + short-summary: "Managed Virtual Network reference." |
| 174 | + long-summary: | |
| 175 | + Usage: --managed-virtual-network reference-name=XX |
| 176 | +
|
| 177 | + reference-name: Required. Reference ManagedVirtualNetwork name. |
209 | 178 | """
|
210 | 179 |
|
211 | 180 | helps['datafactory integration-runtime self-hosted'] = """
|
|
286 | 255 | "exampleIntegrationRuntime" --resource-group "exampleResourceGroup"
|
287 | 256 | """
|
288 | 257 |
|
| 258 | +helps['datafactory integration-runtime list-outbound-network-dependency-endpoint'] = """ |
| 259 | + type: command |
| 260 | + short-summary: "Gets the list of outbound network dependencies for a given Azure-SSIS integration runtime." |
| 261 | + examples: |
| 262 | + - name: IntegrationRuntimes_OutboundNetworkDependenciesEndpoints |
| 263 | + text: |- |
| 264 | + az datafactory integration-runtime list-outbound-network-dependency-endpoint --factory-name \ |
| 265 | +"exampleFactoryName" --name "exampleIntegrationRuntime" --resource-group "exampleResourceGroup" |
| 266 | +""" |
| 267 | + |
289 | 268 | helps['datafactory integration-runtime regenerate-auth-key'] = """
|
290 | 269 | type: command
|
291 | 270 | short-summary: "Regenerates the authentication key for an integration runtime."
|
|
591 | 570 | taset\\"}],\\"typeProperties\\":{\\"dataIntegrationUnits\\":32,\\"sink\\":{\\"type\\":\\"BlobSink\\"},\\"source\\":{\\"\
|
592 | 571 | type\\":\\"BlobSource\\"}}}],\\"isSequential\\":true,\\"items\\":{\\"type\\":\\"Expression\\",\\"value\\":\\"@pipeline(\
|
593 | 572 | ).parameters.OutputBlobNameList\\"}}}]" --parameters "{\\"OutputBlobNameList\\":{\\"type\\":\\"Array\\"}}" --duration \
|
594 |
| -"0.00:10:00" --name "examplePipeline" --resource-group "exampleResourceGroup" |
| 573 | +"0.00:10:00" --pipeline-name "examplePipeline" --resource-group "exampleResourceGroup" |
595 | 574 | """
|
596 | 575 |
|
597 | 576 | helps['datafactory pipeline delete'] = """
|
|
902 | 881 | az datafactory trigger-run rerun --factory-name "exampleFactoryName" --resource-group \
|
903 | 882 | "exampleResourceGroup" --run-id "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b" --trigger-name "exampleTrigger"
|
904 | 883 | """
|
| 884 | + |
| 885 | +helps['datafactory private-end-point-connection'] = """ |
| 886 | + type: group |
| 887 | + short-summary: Manage private end point connection with datafactory |
| 888 | +""" |
| 889 | + |
| 890 | +helps['datafactory private-end-point-connection list'] = """ |
| 891 | + type: command |
| 892 | + short-summary: "Lists Private endpoint connections." |
| 893 | + examples: |
| 894 | + - name: privateEndPointConnections_ListByFactory |
| 895 | + text: |- |
| 896 | + az datafactory private-end-point-connection list --factory-name "exampleFactoryName" --resource-group \ |
| 897 | +"exampleResourceGroup" |
| 898 | +""" |
| 899 | + |
| 900 | +helps['datafactory private-endpoint-connection'] = """ |
| 901 | + type: group |
| 902 | + short-summary: Manage private endpoint connection with datafactory |
| 903 | +""" |
| 904 | + |
| 905 | +helps['datafactory private-endpoint-connection show'] = """ |
| 906 | + type: command |
| 907 | + short-summary: "Gets a private endpoint connection." |
| 908 | + examples: |
| 909 | + - name: Get a private endpoint connection for a datafactory. |
| 910 | + text: |- |
| 911 | + az datafactory private-endpoint-connection show --factory-name "exampleFactoryName" --name "connection" \ |
| 912 | +--resource-group "exampleResourceGroup" |
| 913 | +""" |
| 914 | + |
| 915 | +helps['datafactory private-endpoint-connection create'] = """ |
| 916 | + type: command |
| 917 | + short-summary: "Approves or rejects a private endpoint connection." |
| 918 | + parameters: |
| 919 | + - name: --private-link-service-connection-state |
| 920 | + short-summary: "The state of a private link connection" |
| 921 | + long-summary: | |
| 922 | + Usage: --private-link-service-connection-state status=XX description=XX actions-required=XX |
| 923 | +
|
| 924 | + status: Status of a private link connection |
| 925 | + description: Description of a private link connection |
| 926 | + actions-required: ActionsRequired for a private link connection |
| 927 | + examples: |
| 928 | + - name: Approves or rejects a private endpoint connection for a factory. |
| 929 | + text: |- |
| 930 | + az datafactory private-endpoint-connection create --factory-name "exampleFactoryName" --name \ |
| 931 | +"connection" --private-link-service-connection-state description="Approved by admin." actions-required="" \ |
| 932 | +status="Approved" --resource-group "exampleResourceGroup" |
| 933 | +""" |
| 934 | + |
| 935 | +helps['datafactory private-endpoint-connection update'] = """ |
| 936 | + type: command |
| 937 | + short-summary: "Approves or rejects a private endpoint connection." |
| 938 | + parameters: |
| 939 | + - name: --private-link-service-connection-state |
| 940 | + short-summary: "The state of a private link connection" |
| 941 | + long-summary: | |
| 942 | + Usage: --private-link-service-connection-state status=XX description=XX actions-required=XX |
| 943 | +
|
| 944 | + status: Status of a private link connection |
| 945 | + description: Description of a private link connection |
| 946 | + actions-required: ActionsRequired for a private link connection |
| 947 | +""" |
| 948 | + |
| 949 | +helps['datafactory private-endpoint-connection delete'] = """ |
| 950 | + type: command |
| 951 | + short-summary: "Deletes a private endpoint connection." |
| 952 | + examples: |
| 953 | + - name: Delete a private endpoint connection for a datafactory. |
| 954 | + text: |- |
| 955 | + az datafactory private-endpoint-connection delete --factory-name "exampleFactoryName" --name \ |
| 956 | +"connection" --resource-group "exampleResourceGroup" |
| 957 | +""" |
| 958 | + |
| 959 | +helps['datafactory private-link-resource'] = """ |
| 960 | + type: group |
| 961 | + short-summary: Manage private link resource with datafactory |
| 962 | +""" |
| 963 | + |
| 964 | +helps['datafactory private-link-resource show'] = """ |
| 965 | + type: command |
| 966 | + short-summary: "Gets the private link resources." |
| 967 | + examples: |
| 968 | + - name: Get private link resources of a site |
| 969 | + text: |- |
| 970 | + az datafactory private-link-resource show --factory-name "exampleFactoryName" --resource-group \ |
| 971 | +"exampleResourceGroup" |
| 972 | +""" |
0 commit comments