|
| 1 | +<!-- region Generated --> |
| 2 | +# Az.DataTransfer |
| 3 | +This directory contains the PowerShell module for the DataTransfer service. |
| 4 | + |
| 5 | +--- |
| 6 | +## Info |
| 7 | +- Modifiable: yes |
| 8 | +- Generated: all |
| 9 | +- Committed: yes |
| 10 | +- Packaged: yes |
| 11 | + |
| 12 | +--- |
| 13 | +## Detail |
| 14 | +This module was primarily generated via [AutoRest](https://github.com/Azure/autorest) using the [PowerShell](https://github.com/Azure/autorest.powershell) extension. |
| 15 | + |
| 16 | +## Module Requirements |
| 17 | +- [Az.Accounts module](https://www.powershellgallery.com/packages/Az.Accounts/), version 2.7.5 or greater |
| 18 | + |
| 19 | +## Authentication |
| 20 | +AutoRest does not generate authentication code for the module. Authentication is handled via Az.Accounts by altering the HTTP payload before it is sent. |
| 21 | + |
| 22 | +## Development |
| 23 | +For information on how to develop for `Az.DataTransfer`, see [how-to.md](how-to.md). |
| 24 | +<!-- endregion --> |
| 25 | + |
| 26 | +### AutoRest Configuration |
| 27 | + |
| 28 | +> see https://aka.ms/autorest |
| 29 | +
|
| 30 | +```yaml |
| 31 | +# pin the swagger version by using the commit id instead of branch name |
| 32 | +commit: c424d91129a85194f3a0800a6bb5dcd28f8eb6eb |
| 33 | +namespace: ADT |
| 34 | +require: |
| 35 | +# readme.azure.noprofile.md is the common configuration file |
| 36 | + - $(this-folder)/../../readme.azure.noprofile.md |
| 37 | + - $(repo)/specification/azuredatatransfer/resource-manager/readme.md |
| 38 | +# If the swagger has not been put in the repo, you may uncomment the following line and refer to it locally |
| 39 | +# - (this-folder)/relative-path-to-your-local-readme.md |
| 40 | + |
| 41 | +try-require: |
| 42 | + - $(repo)/specification/azuredatatransfer/resource-manager/readme.powershell.md |
| 43 | + |
| 44 | +# For new RP, the version is 0.1.0 |
| 45 | +module-version: 0.1.0 |
| 46 | +# Normally, title is the service name |
| 47 | +title: DataTransfer |
| 48 | +subject-prefix: DataTransfer |
| 49 | + |
| 50 | +# The next three configurations are exclusive to v3, and in v4, they are activated by default. If you are still using v3, please uncomment them. |
| 51 | +# identity-correction-for-post: true |
| 52 | +# resourcegroup-append: true |
| 53 | +# nested-object-to-string: true |
| 54 | + |
| 55 | +## Flags to use PATCH method for Update-* |
| 56 | +disable-getput: true |
| 57 | +disable-transform-identity-type: true |
| 58 | +flatten-userassignedidentity: false |
| 59 | + |
| 60 | +directive: |
| 61 | + # Following are common directives which are normally required in all the RPs |
| 62 | + # 1. Remove the unexpanded parameter set |
| 63 | + # 2. For New-* cmdlets, ViaIdentity is not required |
| 64 | + # Following two directives are v4 specific |
| 65 | + - where: |
| 66 | + variant: ^(Create|Update)(?!.*?(Expanded|JsonFilePath|JsonString)) |
| 67 | + remove: true |
| 68 | + - where: |
| 69 | + variant: ^CreateViaIdentity.*$ |
| 70 | + remove: true |
| 71 | + # Follow directive is v3 specific. If you are using v3, uncomment following directive and comments out two directives above |
| 72 | + #- where: |
| 73 | + # variant: ^Create$|^CreateViaIdentity$|^CreateViaIdentityExpanded$|^Update$|^UpdateViaIdentity$ |
| 74 | + # remove: true |
| 75 | + |
| 76 | + # Remove the set-* cmdlet |
| 77 | + - where: |
| 78 | + verb: Set |
| 79 | + remove: true |
| 80 | + |
| 81 | + - remove-operation: AzureDataTransfer_validateSchema |
| 82 | + - remove-operation: AzureDataTransfer_listApprovedSchemas |
| 83 | + # - remove-operation: Flows_Get |
| 84 | + # - remove-operation: Flows_CreateOrUpdate |
| 85 | + # - remove-operation: Flows_Delete |
| 86 | + # - remove-operation: Flows_Update |
| 87 | + # - remove-operation: Flows_Enable |
| 88 | + # - remove-operation: Flows_Disable |
| 89 | + # - remove-operation: Flows_Link |
| 90 | + - remove-operation: Flows_SetPassphrase |
| 91 | + - remove-operation: Flows_GeneratePassphrase |
| 92 | + - remove-operation: Flows_GetSourceAddresses |
| 93 | + - remove-operation: Flows_SetSourceAddresses |
| 94 | + - remove-operation: Flows_GetDestinationEndpoints |
| 95 | + - remove-operation: Flows_SetDestinationEndpoints |
| 96 | + - remove-operation: Flows_GetDestinationEndpointPorts |
| 97 | + - remove-operation: Flows_SetDestinationEndpointPorts |
| 98 | + - remove-operation: Flows_GetStreamConnectionString |
| 99 | + # - remove-operation: Flows_ListByConnection |
| 100 | + # - remove-operation: Connections_Get |
| 101 | + # - remove-operation: Connections_CreateOrUpdate |
| 102 | + # - remove-operation: Connections_Delete |
| 103 | + # - remove-operation: Connections_Update |
| 104 | + # - remove-operation: Connections_Link |
| 105 | + # - remove-operation: ListPendingConnections_List |
| 106 | + # - remove-operation: ListPendingFlows_List |
| 107 | + # - remove-operation: Connections_ListByResourceGroup |
| 108 | + # - remove-operation: Connections_ListBySubscription |
| 109 | + # - remove-operation: Pipelines_Get |
| 110 | + - remove-operation: Pipelines_CreateOrUpdate |
| 111 | + - remove-operation: Pipelines_Delete |
| 112 | + - remove-operation: Pipelines_Update |
| 113 | + # - remove-operation: Pipelines_ApproveConnection |
| 114 | + # - remove-operation: Pipelines_RejectConnection |
| 115 | + - remove-operation: ListSchemas_List |
| 116 | + # - remove-operation: Pipelines_ListByResourceGroup |
| 117 | + # - remove-operation: Pipelines_ListBySubscription |
| 118 | + - remove-operation: Operations_List |
| 119 | + - remove-operation: ListFlowsByPipeline_List |
| 120 | + - remove-operation: Pipelines_ExecuteAction |
| 121 | + |
| 122 | + - where: |
| 123 | + parameter-name: Pipeline |
| 124 | + set: |
| 125 | + parameter-name: PipelineName |
| 126 | + |
| 127 | + - where: |
| 128 | + parameter-name: IdentityUserAssignedIdentity |
| 129 | + set: |
| 130 | + parameter-name: UserAssignedIdentity |
| 131 | + |
| 132 | + # Rename to avoid codegen errors |
| 133 | + - from: swagger-document |
| 134 | + where: $.definitions.streamSourceAddresses.properties.sourceAddresses |
| 135 | + transform: $['x-ms-client-name'] = 'AddressList' |
| 136 | + - from: swagger-document |
| 137 | + where: $.definitions.flowProperties.properties.connection |
| 138 | + transform: $['x-ms-client-name'] = 'FlowPropertiesConnection' |
| 139 | + |
| 140 | + # Rename approve/reject ConnectionId param |
| 141 | + - where: |
| 142 | + verb: Invoke |
| 143 | + subject: ^RejectPipelineConnection$ |
| 144 | + parameter-name: Id |
| 145 | + set: |
| 146 | + parameter-name: ConnectionId |
| 147 | + |
| 148 | + - where: |
| 149 | + verb: Approve |
| 150 | + subject: ^PipelineConnection$ |
| 151 | + parameter-name: Id |
| 152 | + set: |
| 153 | + parameter-name: ConnectionId |
| 154 | + |
| 155 | + # Rename approve/reject Connection cmdlets |
| 156 | + - where: |
| 157 | + verb: Invoke |
| 158 | + subject: ^RejectPipelineConnection$ |
| 159 | + set: |
| 160 | + verb: Deny |
| 161 | + subject: Connection |
| 162 | + |
| 163 | + - where: |
| 164 | + verb: Approve |
| 165 | + subject: ^PipelineConnection$ |
| 166 | + set: |
| 167 | + subject: Connection |
| 168 | + |
| 169 | + # Rename Link cmdlets |
| 170 | + - where: |
| 171 | + verb: Invoke |
| 172 | + subject: ^LinkConnection$ |
| 173 | + parameter-name: Id |
| 174 | + set: |
| 175 | + parameter-name: PendingConnectionId |
| 176 | + |
| 177 | + - where: |
| 178 | + verb: Invoke |
| 179 | + subject: ^LinkFlow$ |
| 180 | + parameter-name: Id |
| 181 | + set: |
| 182 | + parameter-name: PendingFlowId |
| 183 | + |
| 184 | + - where: |
| 185 | + verb: Invoke |
| 186 | + subject: ^LinkConnection$ |
| 187 | + set: |
| 188 | + subject: LinkPendingConnection |
| 189 | + |
| 190 | + - where: |
| 191 | + verb: Invoke |
| 192 | + subject: ^LinkFlow$ |
| 193 | + set: |
| 194 | + subject: LinkPendingFlow |
| 195 | + |
| 196 | + # Hide unneeded params |
| 197 | + - where: |
| 198 | + verb: New |
| 199 | + subject: ^Connection$ |
| 200 | + parameter-name: Policy |
| 201 | + hide: true |
| 202 | + |
| 203 | + - where: |
| 204 | + verb: New|Update |
| 205 | + subject: ^Flow$ |
| 206 | + parameter-name: Policy |
| 207 | + hide: true |
| 208 | + |
| 209 | + - where: |
| 210 | + verb: New|Update |
| 211 | + subject: ^Flow$ |
| 212 | + parameter-name: KeyVaultUri |
| 213 | + hide: true |
| 214 | + |
| 215 | + - where: |
| 216 | + verb: New|Update |
| 217 | + subject: ^Flow$ |
| 218 | + parameter-name: ^FlowProperty* |
| 219 | + hide: true |
| 220 | + |
| 221 | + - where: |
| 222 | + verb: Update |
| 223 | + subject: ^Flow$ |
| 224 | + parameter-name: DestinationEndpoint|DestinationEndpointPort|Passphrase|SourceAddressList |
| 225 | + hide: true |
| 226 | + |
| 227 | + # Rename Get Pending Connection/Flow cmdlets |
| 228 | + - where: |
| 229 | + verb: Get |
| 230 | + subject: ^ListPendingConnection |
| 231 | + set: |
| 232 | + subject: PendingConnection |
| 233 | + |
| 234 | + - where: |
| 235 | + verb: Get |
| 236 | + subject: ^PendingConnection |
| 237 | + parameter-name: ConnectionName |
| 238 | + set: |
| 239 | + parameter-name: Name |
| 240 | + alias: ConnectionName |
| 241 | + |
| 242 | + - where: |
| 243 | + verb: Get |
| 244 | + subject: ^ListPendingFlow |
| 245 | + set: |
| 246 | + subject: PendingFlow |
| 247 | +``` |
0 commit comments