Skip to content

Commit e693dec

Browse files
committed
Taking review comments
1 parent 0802026 commit e693dec

File tree

6 files changed

+1633
-4
lines changed

6 files changed

+1633
-4
lines changed

src/azure-data-transfer/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ az azure-data-transfer pipeline show
3232
3333
```
3434

35-
##### Approve a connection in a pipeline
35+
##### Approves the specified connection request in a pipeline.
3636

3737
```
3838
az azure-data-transfer pipeline approve-connection \
@@ -102,7 +102,7 @@ az azure-data-transfer connection link \
102102
##### List connections in a resource group
103103

104104
```
105-
az azure-data-transfer connection link \
105+
az azure-data-transfer connection list \
106106
--resource-group groupName \
107107
--maxItems 10
108108
--nextToken <Link from previous response>

src/azure-data-transfer/azext_azure_data_transfer/_help.py

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,24 @@
1010

1111
from knack.help_files import helps # pylint: disable=unused-import
1212

13+
helps['azure-data-transfer pipeline list'] = """
14+
type: command
15+
short-summary: List Pipeline resources by Subscription or Resource Group.
16+
examples:
17+
- name: List all pipelines in a resource group.
18+
text: az azure-data-transfer pipeline list --resource-group resourceGroup
19+
- name: List all pipelines in a subscription.
20+
text: az azure-data-transfer pipeline list
21+
"""
22+
23+
helps['azure-data-transfer pipeline show'] = """
24+
type: command
25+
short-summary: Gets Pipeline resource by name.
26+
examples:
27+
- name: Get a pipeline by name in a resource group.
28+
text: az azure-data-transfer pipeline show --resource-group resourceGroup --name pipelineName
29+
"""
30+
1331
helps['azure-data-transfer pipeline approve-connection'] = """
1432
type: command
1533
short-summary: Approves the specified connection in a pipeline.
@@ -36,6 +54,38 @@
3654
text: az azure-data-transfer connection create --resource-group {rg} --connection-name {sendConnection} --direction Send --location {location} --flow-types ["Mission"] --pipeline {pipeline} --primary-contact abc@microsoft.com --secondary-contacts abc@microsoft.com --pin {pin}
3755
"""
3856

57+
helps['azure-data-transfer connection show'] = """
58+
type: command
59+
short-summary: Get the connection resource.
60+
examples:
61+
- name: Get a connection by name in a resource group.
62+
text: az azure-data-transfer connection show --resource-group {rg} --name {connectionName}
63+
"""
64+
65+
helps['azure-data-transfer connection update'] = """
66+
type: command
67+
short-summary: Update the connection resource.
68+
examples:
69+
- name: Update a connection by name in a resource group. Update of tags is only supported.
70+
text: az azure-data-transfer connection update --resource-group {rg} --name {connectionName} --tags key1=value1 key2=value2
71+
"""
72+
73+
helps['azure-data-transfer connection delete'] = """
74+
type: command
75+
short-summary: Delete the connection resource.
76+
examples:
77+
- name: Delete a connection by name in a resource group.
78+
text: az azure-data-transfer connection delete --resource-group {rg} --name {connectionName}
79+
"""
80+
81+
helps['azure-data-transfer connection list'] = """
82+
type: command
83+
short-summary: List connections in a subscription.
84+
examples:
85+
- name: Gets all the connections in a resource group. Pagination is supported by page size and next token.
86+
text: az azure-data-transfer connection list --resource-group {rg} --max-items 10 --next-token {nextToken}
87+
"""
88+
3989
helps['azure-data-transfer connection link'] = """
4090
type: command
4191
short-summary: Link receive side connection with a send side connection.
@@ -44,6 +94,22 @@
4494
text: az azure-data-transfer connection link --resource-group {rg} --name receiveConnectionName --id {sendId}
4595
"""
4696

97+
helps['azure-data-transfer connection list-pending-connection'] = """
98+
type: command
99+
short-summary: Lists all pending connections for a receive connection.
100+
examples:
101+
- name: List all pending connections for a receive connection in the remote subscription of the receive side connection
102+
text: az azure-data-transfer connection list-pending-connection --resource-group {rg} --name {receiveConnectionName}
103+
"""
104+
105+
helps['azure-data-transfer connection list-pending-flow'] = """
106+
type: command
107+
short-summary: List all pending flows for linking to a receive flow.
108+
examples:
109+
- name: List all pending flows for linking to a receive flow.
110+
text: az azure-data-transfer connection list-pending-flow --resource-group {rg} --connection-name {receiveConnectionName}
111+
"""
112+
47113
helps['azure-data-transfer connection flow create'] = """
48114
type: command
49115
short-summary: Create the flow resource.
@@ -52,10 +118,58 @@
52118
text: az azure-data-transfer connection flow create --resource-group resourceGroup --connection-name connectionName --name flowName --flow-type "Mission" --location WestUs --status "Enabled" --storage-account /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup/Microsoft.Storage/storageAccounts/accountName --storage-container-name testContainer --data-type "Blob"
53119
"""
54120

121+
helps['azure-data-transfer connection flow show'] = """
122+
type: command
123+
short-summary: Get the flow resource.
124+
examples:
125+
- name: Get a flow by name in a resource group.
126+
text: az azure-data-transfer connection flow show --resource-group {rg} --connection-name {connectionName} --name {flowName}
127+
"""
128+
129+
helps['azure-data-transfer connection flow update'] = """
130+
type: command
131+
short-summary: Update the flow resource.
132+
examples:
133+
- name: Update a flow by name in a resource group. Update of tags is only supported.
134+
text: az azure-data-transfer connection flow update --resource-group {rg} --connection-name {connectionName} --name {flowName} --tags key1=value1 key2=value2
135+
"""
136+
137+
helps['azure-data-transfer connection flow delete'] = """
138+
type: command
139+
short-summary: Delete the flow resource.
140+
examples:
141+
- name: Delete a flow by name in a resource group.
142+
text: az azure-data-transfer connection flow delete --resource-group {rg} --name {connectionName}
143+
"""
144+
145+
helps['azure-data-transfer connection flow list'] = """
146+
type: command
147+
short-summary: List flows in a subscription.
148+
examples:
149+
- name: Gets all the flows in a resource group. Pagination is supported by page size and next token.
150+
text: az azure-data-transfer connection flow list --resource-group {rg} --connection-name {connectionName} --max-items 10 --next-token {nextToken}
151+
"""
152+
55153
helps['azure-data-transfer connection flow link'] = """
56154
type: command
57155
short-summary: Links the specified flow.
58156
examples:
59157
- name: Links the receive side flow with a send side flow.
60158
text: az azure-data-transfer connection flow link --resource-group resourceGroup --connection-name connectionName --name receiveFlowName --id /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup/providers/microsoft.azuredatatransfer/flows/sendFlow
61159
"""
160+
161+
helps['azure-data-transfer connection flow disable'] = """
162+
type: command
163+
short-summary: Disable the flow resource.
164+
examples:
165+
- name: Disable a flow by name in a resource group.
166+
text: az azure-data-transfer connection flow disable --resource-group {rg} --name {connectionName}
167+
"""
168+
169+
helps['azure-data-transfer connection flow enable'] = """
170+
type: command
171+
short-summary: Enable the flow resource.
172+
examples:
173+
- name: Enable a flow by name in a resource group.
174+
text: az azure-data-transfer connection flow enable --resource-group {rg} --name {connectionName}
175+
"""

src/azure-data-transfer/azext_azure_data_transfer/aaz/latest/azure_data_transfer/pipeline/_approve_connection.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ class ApproveConnection(AAZCommand):
1919
"""Approves the specified connection request in a pipeline.
2020
2121
:example: Approves the specified connection in a pipeline
22-
az azure-data-transfer pipeline approve-connection --resource-group testRG --pipeline-name testPipeline --connection-id /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection --status-reason Example reason
22+
az azure-data-transfer pipeline approve-connection --resource-group testRG --pipeline-name testPipeline --connection-id /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRG/providers/Microsoft.AzureDataTransfer/connections/testConnection --status-reason Reason
2323
"""
2424

2525
_aaz_info = {

0 commit comments

Comments
 (0)