From 32eee25bf8b323706e7dfa0c1a63c14d0685d685 Mon Sep 17 00:00:00 2001 From: Faizan Uddin Fahad Khan Date: Mon, 13 Oct 2025 20:21:51 +0530 Subject: [PATCH 1/2] Support for API version 2025-10-10 --- .../Properties/AssemblyInfo.cs | 5 +- .../DataTransfer.Autorest/README.md | 25 +- .../connections-flows.json | 2 +- .../connections.json | 2 +- .../pipelines-flowProfiles.json | 52 ++ .../pipelines.json | 6 +- .../docs/Approve-AzDataTransferConnection.md | 6 +- .../docs/Az.DataTransfer.md | 15 +- .../docs/Deny-AzDataTransferConnection.md | 6 +- .../docs/Get-AzDataTransferFlowProfile.md | 295 +++++++++ .../docs/Get-AzDataTransferPipeline.md | 6 +- .../docs/New-AzDataTransferConnection.md | 45 +- .../docs/New-AzDataTransferFlow.md | 234 ++++++- .../docs/New-AzDataTransferFlowProfile.md | 576 +++++++++++++++++ .../docs/Update-AzDataTransferFlowProfile.md | 600 ++++++++++++++++++ .../examples/Get-AzDataTransferFlowProfile.md | 22 + .../examples/New-AzDataTransferFlowProfile.md | 22 + .../Update-AzDataTransferFlowProfile.md | 22 + .../DataTransfer.Autorest/generate-info.json | 2 +- ...sferAzureDataTransferFlowProfile.Tests.ps1 | 33 + .../Get-AzDataTransferFlowProfile.Tests.ps1 | 33 + ...et-AzDataTransferFlowProfileTest.Tests.ps1 | 33 + .../New-AzDataTransferFlowProfile.Tests.ps1 | 29 + ...Remove-AzDataTransferFlowProfile.Tests.ps1 | 29 + ...Update-AzDataTransferFlowProfile.Tests.ps1 | 37 ++ 25 files changed, 2091 insertions(+), 46 deletions(-) create mode 100644 src/DataTransfer/DataTransfer.Autorest/UX/Microsoft.AzureDataTransfer/pipelines-flowProfiles.json create mode 100644 src/DataTransfer/DataTransfer.Autorest/docs/Get-AzDataTransferFlowProfile.md create mode 100644 src/DataTransfer/DataTransfer.Autorest/docs/New-AzDataTransferFlowProfile.md create mode 100644 src/DataTransfer/DataTransfer.Autorest/docs/Update-AzDataTransferFlowProfile.md create mode 100644 src/DataTransfer/DataTransfer.Autorest/examples/Get-AzDataTransferFlowProfile.md create mode 100644 src/DataTransfer/DataTransfer.Autorest/examples/New-AzDataTransferFlowProfile.md create mode 100644 src/DataTransfer/DataTransfer.Autorest/examples/Update-AzDataTransferFlowProfile.md create mode 100644 src/DataTransfer/DataTransfer.Autorest/test/Get-AzDataTransferAzureDataTransferFlowProfile.Tests.ps1 create mode 100644 src/DataTransfer/DataTransfer.Autorest/test/Get-AzDataTransferFlowProfile.Tests.ps1 create mode 100644 src/DataTransfer/DataTransfer.Autorest/test/Get-AzDataTransferFlowProfileTest.Tests.ps1 create mode 100644 src/DataTransfer/DataTransfer.Autorest/test/New-AzDataTransferFlowProfile.Tests.ps1 create mode 100644 src/DataTransfer/DataTransfer.Autorest/test/Remove-AzDataTransferFlowProfile.Tests.ps1 create mode 100644 src/DataTransfer/DataTransfer.Autorest/test/Update-AzDataTransferFlowProfile.Tests.ps1 diff --git a/src/DataTransfer/DataTransfer.Autorest/Properties/AssemblyInfo.cs b/src/DataTransfer/DataTransfer.Autorest/Properties/AssemblyInfo.cs index f5613433c8e9..c7960de52ce8 100644 --- a/src/DataTransfer/DataTransfer.Autorest/Properties/AssemblyInfo.cs +++ b/src/DataTransfer/DataTransfer.Autorest/Properties/AssemblyInfo.cs @@ -20,7 +20,8 @@ [assembly: System.Reflection.AssemblyCopyrightAttribute("Copyright © Microsoft")] [assembly: System.Reflection.AssemblyProductAttribute("Microsoft Azure PowerShell")] [assembly: System.Reflection.AssemblyTitleAttribute("Microsoft Azure PowerShell - DataTransfer")] -[assembly: System.Reflection.AssemblyFileVersionAttribute("0.1.0")] -[assembly: System.Reflection.AssemblyVersionAttribute("0.1.0")] +[assembly: System.Reflection.AssemblyFileVersionAttribute("1.0.0")] +[assembly: System.Reflection.AssemblyVersionAttribute("1.0.0")] [assembly: System.Runtime.InteropServices.ComVisibleAttribute(false)] [assembly: System.CLSCompliantAttribute(false)] + diff --git a/src/DataTransfer/DataTransfer.Autorest/README.md b/src/DataTransfer/DataTransfer.Autorest/README.md index f5c452c1de93..cf6c80f07e3a 100644 --- a/src/DataTransfer/DataTransfer.Autorest/README.md +++ b/src/DataTransfer/DataTransfer.Autorest/README.md @@ -29,7 +29,7 @@ For information on how to develop for `Az.DataTransfer`, see [how-to.md](how-to. ```yaml # pin the swagger version by using the commit id instead of branch name -commit: c424d91129a85194f3a0800a6bb5dcd28f8eb6eb +commit: a7ed089176a106a5ac433d1df0630545a5ad27bf namespace: ADT require: # readme.azure.noprofile.md is the common configuration file @@ -250,4 +250,27 @@ directive: verb: Invoke subject: ^ExecutePipelineAction hide: true + + ## Hide Remove-FlowProfile command + - where: + verb: Remove + subject: ^FlowProfile + hide: true + + - where: + verb: Get + subject: ^AzureDataTransferFlowProfile + set: + subject: FlowProfile + + # Fix the AntiviruAvSolution parameter name to correct spelling + - where: + parameter-name: AntiviruAvSolution + set: + parameter-name: AntivirusAvSolution + + - where: + property-name: AntiviruAvSolution + set: + property-name: AntivirusAvSolution ``` diff --git a/src/DataTransfer/DataTransfer.Autorest/UX/Microsoft.AzureDataTransfer/connections-flows.json b/src/DataTransfer/DataTransfer.Autorest/UX/Microsoft.AzureDataTransfer/connections-flows.json index 59dff646ed3e..64685caf2691 100644 --- a/src/DataTransfer/DataTransfer.Autorest/UX/Microsoft.AzureDataTransfer/connections-flows.json +++ b/src/DataTransfer/DataTransfer.Autorest/UX/Microsoft.AzureDataTransfer/connections-flows.json @@ -1,6 +1,6 @@ { "resourceType": "connections/flows", - "apiVersion": "2025-05-21", + "apiVersion": "2025-10-10-preview", "learnMore": { "url": "https://learn.microsoft.com/powershell/module/az.datatransfer" }, diff --git a/src/DataTransfer/DataTransfer.Autorest/UX/Microsoft.AzureDataTransfer/connections.json b/src/DataTransfer/DataTransfer.Autorest/UX/Microsoft.AzureDataTransfer/connections.json index a0afe5196f7d..008be46f7b1b 100644 --- a/src/DataTransfer/DataTransfer.Autorest/UX/Microsoft.AzureDataTransfer/connections.json +++ b/src/DataTransfer/DataTransfer.Autorest/UX/Microsoft.AzureDataTransfer/connections.json @@ -1,6 +1,6 @@ { "resourceType": "connections", - "apiVersion": "2025-05-21", + "apiVersion": "2025-10-10-preview", "learnMore": { "url": "https://learn.microsoft.com/powershell/module/az.datatransfer" }, diff --git a/src/DataTransfer/DataTransfer.Autorest/UX/Microsoft.AzureDataTransfer/pipelines-flowProfiles.json b/src/DataTransfer/DataTransfer.Autorest/UX/Microsoft.AzureDataTransfer/pipelines-flowProfiles.json new file mode 100644 index 000000000000..feb7795700c7 --- /dev/null +++ b/src/DataTransfer/DataTransfer.Autorest/UX/Microsoft.AzureDataTransfer/pipelines-flowProfiles.json @@ -0,0 +1,52 @@ +{ + "resourceType": "pipelines/flowProfiles", + "apiVersion": "2025-10-10-preview", + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.datatransfer" + }, + "commands": [ + { + "name": "Get-AzDataTransferFlowProfile", + "description": "Retrieves the specified FlowProfile resource.", + "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines/{pipelineName}/flowProfiles/{flowProfileName}", + "help": { + "learnMore": { + "url": "https://learn.microsoft.com/powershell/module/az.datatransfer/get-azdatatransferflowprofile" + }, + "parameterSets": [ + { + "parameters": [ + "-Name ", + "-PipelineName ", + "-ResourceGroupName ", + "[-SubscriptionId ]" + ] + } + ] + }, + "examples": [ + { + "description": "Retrieves the specified FlowProfile resource.", + "parameters": [ + { + "name": "-Name", + "value": "[Path.flowProfileName]" + }, + { + "name": "-PipelineName", + "value": "[Path.pipelineName]" + }, + { + "name": "-ResourceGroupName", + "value": "[Path.resourceGroupName]" + }, + { + "name": "-SubscriptionId", + "value": "[Path.subscriptionId]" + } + ] + } + ] + } + ] +} diff --git a/src/DataTransfer/DataTransfer.Autorest/UX/Microsoft.AzureDataTransfer/pipelines.json b/src/DataTransfer/DataTransfer.Autorest/UX/Microsoft.AzureDataTransfer/pipelines.json index 5dfd2dea88b5..98fb2ce2b42c 100644 --- a/src/DataTransfer/DataTransfer.Autorest/UX/Microsoft.AzureDataTransfer/pipelines.json +++ b/src/DataTransfer/DataTransfer.Autorest/UX/Microsoft.AzureDataTransfer/pipelines.json @@ -1,13 +1,13 @@ { "resourceType": "pipelines", - "apiVersion": "2025-05-21", + "apiVersion": "2025-10-10-preview", "learnMore": { "url": "https://learn.microsoft.com/powershell/module/az.datatransfer" }, "commands": [ { "name": "Get-AzDataTransferPipeline", - "description": "Gets pipeline resource.", + "description": "Retrieves the specified Pipeline resource.", "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureDataTransfer/pipelines/{pipelineName}", "help": { "learnMore": { @@ -25,7 +25,7 @@ }, "examples": [ { - "description": "Gets pipeline resource.", + "description": "Retrieves the specified Pipeline resource.", "parameters": [ { "name": "-Name", diff --git a/src/DataTransfer/DataTransfer.Autorest/docs/Approve-AzDataTransferConnection.md b/src/DataTransfer/DataTransfer.Autorest/docs/Approve-AzDataTransferConnection.md index 9f3860566fb5..a8e1633826e6 100644 --- a/src/DataTransfer/DataTransfer.Autorest/docs/Approve-AzDataTransferConnection.md +++ b/src/DataTransfer/DataTransfer.Autorest/docs/Approve-AzDataTransferConnection.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Approve-AzDataTransferConnection ## SYNOPSIS -Approves the specified connection request in a pipeline. +Approves a pending connection request associated with the specified Pipeline. ## SYNTAX @@ -54,7 +54,7 @@ Approve-AzDataTransferConnection -PipelineName -ResourceGroupName -ResourceGroupName ``` ## DESCRIPTION -Rejects the specified connection request in a pipeline. +Rejects a pending connection request associated with the specified Pipeline. ## EXAMPLES @@ -233,7 +233,7 @@ Accept wildcard characters: False ``` ### -PipelineName -The name for the pipeline to perform the operation on. +The name of the pipeline on which to operate. ```yaml Type: System.String diff --git a/src/DataTransfer/DataTransfer.Autorest/docs/Get-AzDataTransferFlowProfile.md b/src/DataTransfer/DataTransfer.Autorest/docs/Get-AzDataTransferFlowProfile.md new file mode 100644 index 000000000000..ebf5dcc7a8d8 --- /dev/null +++ b/src/DataTransfer/DataTransfer.Autorest/docs/Get-AzDataTransferFlowProfile.md @@ -0,0 +1,295 @@ +--- +external help file: +Module Name: Az.DataTransfer +online version: https://learn.microsoft.com/powershell/module/az.datatransfer/get-azdatatransferflowprofile +schema: 2.0.0 +--- + +# Get-AzDataTransferFlowProfile + +## SYNOPSIS +Retrieves the specified FlowProfile resource. + +## SYNTAX + +### ListExpanded (Default) +``` +Get-AzDataTransferFlowProfile [-PipelineName ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### Get +``` +Get-AzDataTransferFlowProfile -Name -PipelineName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [] +``` + +### GetViaIdentity +``` +Get-AzDataTransferFlowProfile -InputObject [-DefaultProfile ] + [] +``` + +### GetViaIdentityPipeline +``` +Get-AzDataTransferFlowProfile -Name -PipelineInputObject + [-DefaultProfile ] [] +``` + +### List +``` +Get-AzDataTransferFlowProfile -Body [-DefaultProfile ] [-Confirm] + [-WhatIf] [] +``` + +### List1 +``` +Get-AzDataTransferFlowProfile -PipelineName -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [] +``` + +### ListViaJsonFilePath +``` +Get-AzDataTransferFlowProfile -JsonFilePath [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### ListViaJsonString +``` +Get-AzDataTransferFlowProfile -JsonString [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +## DESCRIPTION +Retrieves the specified FlowProfile resource. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -Body +Defines the required request body for retrieving FlowProfile information for a provided pipeline. + +```yaml +Type: ADT.Models.IListFlowProfilesRequest +Parameter Sets: List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: ADT.Models.IDataTransferIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the List operation + +```yaml +Type: System.String +Parameter Sets: ListViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the List operation + +```yaml +Type: System.String +Parameter Sets: ListViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the FlowProfile resource to operate on. +Must be 3 to 64 characters long and contain only alphanumeric characters or hyphens. + +```yaml +Type: System.String +Parameter Sets: Get, GetViaIdentityPipeline +Aliases: FlowProfileName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PipelineInputObject +Identity Parameter + +```yaml +Type: ADT.Models.IDataTransferIdentity +Parameter Sets: GetViaIdentityPipeline +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PipelineName +The name of the pipeline on which to operate. + +```yaml +Type: System.String +Parameter Sets: Get, List1, ListExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: Get, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### ADT.Models.IDataTransferIdentity + +### ADT.Models.IListFlowProfilesRequest + +## OUTPUTS + +### ADT.Models.IFlowProfile + +### ADT.Models.IFlowProfilesListResult + +## NOTES + +## RELATED LINKS + diff --git a/src/DataTransfer/DataTransfer.Autorest/docs/Get-AzDataTransferPipeline.md b/src/DataTransfer/DataTransfer.Autorest/docs/Get-AzDataTransferPipeline.md index 89fc4077f78c..8064b56d8f56 100644 --- a/src/DataTransfer/DataTransfer.Autorest/docs/Get-AzDataTransferPipeline.md +++ b/src/DataTransfer/DataTransfer.Autorest/docs/Get-AzDataTransferPipeline.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-AzDataTransferPipeline ## SYNOPSIS -Gets pipeline resource. +Retrieves the specified Pipeline resource. ## SYNTAX @@ -36,7 +36,7 @@ Get-AzDataTransferPipeline -ResourceGroupName [-SubscriptionId -ResourceGroupName -Location - [-SubscriptionId ] [-Direction ] [-FlowType ] [-IdentityType ] + [-SubscriptionId ] [-ApiHostname ] [-Direction ] + [-FlowProfileList ] [-FlowType ] [-IdentityType ] [-Justification ] [-Pin ] [-PipelineName ] [-PrimaryContact ] [-RemoteSubscriptionId ] [-RequirementId ] [-Schema ] [-SchemaUri ] [-SecondaryContact ] [-Tag ] [-UserAssignedIdentity ] @@ -192,6 +193,21 @@ This example creates a new connection named `Connection03` in the resource group ## PARAMETERS +### -ApiHostname +Hostname specific to API Flows + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -AsJob Run the command as a job @@ -238,8 +254,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -FlowProfileList +Provides a list of FlowProfiles . + +```yaml +Type: ADT.Models.IFlowProfileMetadata[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -FlowType -The flow types being requested for this connection +The flow types being requested for this connection. +This FlowType property has reached end of life support starting version 2025-05-30-preview. +Please create a FlowProfile resource instead. ```yaml Type: System.String[] @@ -450,7 +483,9 @@ Accept wildcard characters: False ``` ### -Schema -The schemas for this connection +The schemas for this connection. +The schemas property has reached end of life support starting version 2025-05-30-preview. +Please create and use a FlowProfile resource instead. ```yaml Type: ADT.Models.ISchema[] @@ -465,7 +500,9 @@ Accept wildcard characters: False ``` ### -SchemaUri -The schema URIs for this connection +The schema URIs for this connection. +The schemaUris property has reached end of life support starting version 2025-05-30-preview. +Please create and use a FlowProfile resource instead. ```yaml Type: System.String[] diff --git a/src/DataTransfer/DataTransfer.Autorest/docs/New-AzDataTransferFlow.md b/src/DataTransfer/DataTransfer.Autorest/docs/New-AzDataTransferFlow.md index f20a89758b6b..bafa2e6ea7be 100644 --- a/src/DataTransfer/DataTransfer.Autorest/docs/New-AzDataTransferFlow.md +++ b/src/DataTransfer/DataTransfer.Autorest/docs/New-AzDataTransferFlow.md @@ -16,21 +16,25 @@ Create the flow resource. ``` New-AzDataTransferFlow -ConnectionName -Name -ResourceGroupName -Location [-SubscriptionId ] [-ApiFlowOptionApiMode ] [-ApiFlowOptionAudienceOverride ] - [-ApiFlowOptionCname ] [-ApiFlowOptionIdentityTranslation ] - [-ApiFlowOptionRemoteCallingModeClientId ] [-ApiFlowOptionRemoteEndpoint ] - [-ApiFlowOptionSenderClientId ] [-ConnectionId ] [-ConnectionLocation ] - [-ConnectionSubscriptionName ] [-ConsumerGroup ] [-CustomerManagedKeyVaultUri ] - [-DataType ] [-DestinationEndpoint ] [-DestinationEndpointPort ] - [-EventHubId ] [-FlowType ] [-IdentityType ] [-MessagingOptionBillingTier ] - [-Passphrase ] [-PlanName ] [-PlanProduct ] [-PlanPromotionCode ] - [-PlanPublisher ] [-PlanVersion ] [-PropertiesConnectionName ] - [-SchemaConnectionId ] [-SchemaContent ] [-SchemaDirection ] [-SchemaId ] - [-SchemaName ] [-SchemaStatus ] [-SchemaType ] [-SchemaUri ] - [-ServiceBusQueueId ] [-SourceAddress ] [-Status ] [-StorageAccountId ] - [-StorageAccountName ] [-StorageContainerName ] [-StorageTableName ] - [-StreamId ] [-StreamLatency ] [-StreamProtocol ] [-Tag ] - [-UserAssignedIdentity ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] - [] + [-ApiFlowOptionAuthentication ] [-ApiFlowOptionCname ] + [-ApiFlowOptionIdentityTranslation ] [-ApiFlowOptionRemoteCallingModeClientId ] + [-ApiFlowOptionRemoteEndpoint ] [-ApiFlowOptionSenderClientId ] [-ConnectionId ] + [-ConnectionLocation ] [-ConnectionSubscriptionName ] [-ConsumerGroup ] + [-CustomerManagedKeyVaultUri ] [-DataType ] [-DestinationEndpoint ] + [-DestinationEndpointPort ] [-EventHubId ] [-FlowDataType ] + [-FlowProfileDescription ] [-FlowProfileId ] [-FlowProfileName ] + [-FlowProfilePipeline ] [-FlowProfileReplicationScenario ] [-FlowProfileStatus ] + [-FlowType ] [-IdentityType ] [-MessagingOptionBillingTier ] + [-MessagingOptionPerformancePriority ] [-Passphrase ] [-PlanName ] + [-PlanProduct ] [-PlanPromotionCode ] [-PlanPublisher ] [-PlanVersion ] + [-PropertiesConnectionName ] [-RemoteEndpointSettingAuthentication ] + [-RemoteEndpointSettingEndpoint ] [-SchemaConnectionId ] [-SchemaContent ] + [-SchemaDirection ] [-SchemaId ] [-SchemaName ] [-SchemaStatus ] + [-SchemaType ] [-SchemaUri ] [-ServiceBusQueueId ] [-SourceAddress ] + [-Status ] [-StorageAccountId ] [-StorageAccountName ] + [-StorageContainerName ] [-StorageTableName ] [-StreamId ] [-StreamLatency ] + [-StreamProtocol ] [-Tag ] [-UserAssignedIdentity ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] ``` ### CreateViaJsonFilePath @@ -229,7 +233,9 @@ Accept wildcard characters: False ``` ### -ApiFlowOptionAudienceOverride -Optional field to override the audience of the remote endpoint +Optional field to override the audience of the remote endpoint. +The property has reached end of life support starting version 2025-05-30-preview. +Please create and use the authentication property instead. ```yaml Type: System.String @@ -243,6 +249,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ApiFlowOptionAuthentication +Optional and for advanced used only. +A list of authentication methods to use when accessing the Azure Data Transfer API Flow. +If not provided, the default S2S authentication using Entra (API Flow Managed Identity) and RBAC will be applied. + +```yaml +Type: ADT.Models.IAuthentication[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ApiFlowOptionCname Unique CNAME to represent the Azure Data Transfer API Flow instance @@ -259,7 +282,9 @@ Accept wildcard characters: False ``` ### -ApiFlowOptionIdentityTranslation -Flag for if Azure Data Transfer API Flow should extract the user token +Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. +The property has reached end of life support starting version 2025-05-30-preview. +Please create and use the authentication property instead. ```yaml Type: System.String @@ -274,7 +299,9 @@ Accept wildcard characters: False ``` ### -ApiFlowOptionRemoteCallingModeClientId -Remote stub app registration Client ID +Remote stub app registration Client ID. +The property has reached end of life support starting version 2025-05-30-preview. +Please create and use the authentication property instead. ```yaml Type: System.String @@ -289,7 +316,9 @@ Accept wildcard characters: False ``` ### -ApiFlowOptionRemoteEndpoint -Remote host to which communication needs to be made +Remote host to which communication needs to be made. +The property has reached end of life support starting version 2025-05-30-preview. +Please create and use the remoteEndpointSettings.endpoint property instead. ```yaml Type: System.String @@ -304,7 +333,9 @@ Accept wildcard characters: False ``` ### -ApiFlowOptionSenderClientId -Sender's app user assigned Manage Identity client ID +Sender's app user assigned Manage Identity client ID. +The property has reached end of life support starting version 2025-05-30-preview. +Please create and use the authentication property instead. ```yaml Type: System.String @@ -425,6 +456,8 @@ Accept wildcard characters: False ### -DataType Type of data to transfer via the flow. +The property has reached end of life support starting version 2025-05-30-preview. +Please create and use a FlowProfile resource instead. ```yaml Type: System.String @@ -499,8 +532,118 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -FlowDataType +The Flow's data class. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FlowProfileDescription +A description of the FlowProfile and its rulesets. +The description should describe the flowprofile's purpose and rulesets applied. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FlowProfileId +A guid represented as a string for the FlowProfile resource, assigned by the system. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FlowProfileName +The name of the FlowProfile. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FlowProfilePipeline +The name of the parent Pipeline Azure resource associated with this FlowProfile. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FlowProfileReplicationScenario +The data replication scenario handled by this FlowProfile. +Please note, that this value cannot be updated after creation. +See the FlowProfilePatchProperties to see updateable properties. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FlowProfileStatus +The operational status of the FlowProfile. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -FlowType -The flow type for this flow +The flow type for this flow. +The property has reached end of life support starting version 2025-05-30-preview. +Please create and use a FlowProfile resource instead. ```yaml Type: System.String @@ -589,6 +732,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -MessagingOptionPerformancePriority +Field indicating whether to enable guaranteed delivery on the flow or not. +The default disabled option chooses speed over consistency. +When enabled, messages are delivered with minimal delay, but delivery is not guaranteed under all conditions + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name The name for the flow to perform the operation on. @@ -729,6 +889,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -RemoteEndpointSettingAuthentication +Optional and for advanced used only. +A list of authentication methods to use when accessing the remote endpoint. +If not provided, the default S2S authentication using Entra (API Flow Managed Identity) and RBAC will be applied. + +```yaml +Type: ADT.Models.IAuthentication[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoteEndpointSettingEndpoint +The remote endpoint uri all API calls. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. diff --git a/src/DataTransfer/DataTransfer.Autorest/docs/New-AzDataTransferFlowProfile.md b/src/DataTransfer/DataTransfer.Autorest/docs/New-AzDataTransferFlowProfile.md new file mode 100644 index 000000000000..4e45b6250ca0 --- /dev/null +++ b/src/DataTransfer/DataTransfer.Autorest/docs/New-AzDataTransferFlowProfile.md @@ -0,0 +1,576 @@ +--- +external help file: +Module Name: Az.DataTransfer +online version: https://learn.microsoft.com/powershell/module/az.datatransfer/new-azdatatransferflowprofile +schema: 2.0.0 +--- + +# New-AzDataTransferFlowProfile + +## SYNOPSIS +Create a new FlowProfile or create an existing one. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzDataTransferFlowProfile -Name -PipelineName -ResourceGroupName + -Location [-SubscriptionId ] [-AntivirusAvSolution ] + [-ArchiveMaximumCompressionRatioLimit ] [-ArchiveMaximumDepthLimit ] + [-ArchiveMaximumExpansionSizeLimit ] [-ArchiveMinimumSizeForExpansion ] + [-DataSizeMaximum ] [-DataSizeMinimum ] [-Description ] [-IdentityType ] + [-MimeFilter ] [-MimeFilterType ] [-ReplicationScenario ] + [-Status ] [-Tag ] [-TextMatchingDeny ] [-UserAssignedIdentity ] + [-XmlFilterDefaultNamespace ] [-XmlFilterReference ] [-XmlFilterSchema ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### CreateViaJsonFilePath +``` +New-AzDataTransferFlowProfile -Name -PipelineName -ResourceGroupName + -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +### CreateViaJsonString +``` +New-AzDataTransferFlowProfile -Name -PipelineName -ResourceGroupName + -JsonString [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +Create a new FlowProfile or create an existing one. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AntivirusAvSolution +Optional. +The list of antiviruses to be used as a scanning solution for replicating data. + +```yaml +Type: System.String[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ArchiveMaximumCompressionRatioLimit +Optional. +Provides the multiplication value for an archive in total based on the initial object being validated. +This value takes the root object size and multiplies it by this value to create a maximum. +Once this maximum is exceeded, the archive is failed. +Used to detect and block archives with suspiciously high compression (e.g., zip bombs). + +```yaml +Type: System.Double +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ArchiveMaximumDepthLimit +Optional. +The maximum depth of nested archives that can be expanded. +Limits how many layers of embedded archives will be processed. +Archives exceeding the max limit will be denied for replication. + +```yaml +Type: System.Int64 +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ArchiveMaximumExpansionSizeLimit +Optional. +The combined maximum size (in bytes) of all extracted files that an expanded archive is allowed to reach. +Archives exceeding the max limit will be denied for replication. + +```yaml +Type: System.Int64 +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ArchiveMinimumSizeForExpansion +Optional. +Default is 0. +The minimum archive file size (in bytes) required to trigger expansion during replication. +Any archive file size below the configured threshold will skip the rest of the configured rulesets for archives. + +```yaml +Type: System.Int64 +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataSizeMaximum +Optional. +Specifies the maximum allowed size (in bytes) for files to be replicated. +Any file size greater than maximum will be denied replication. + +```yaml +Type: System.Int64 +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataSizeMinimum +Optional. +Default is 0. +Specifies the minimum required size (in bytes) for a file to be eligible for replication. +Any file size less than minimum will be denied replication. + +```yaml +Type: System.Int64 +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +A user-defined description of the FlowProfile. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MimeFilter +Defines the Media types (f.k.a MIME types) and associated file extensions to be filtered. +For more detail, please refer to the MimeTypeFiler model. + +```yaml +Type: ADT.Models.IMimeTypeFilter[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MimeFilterType +Specifies whether the filter is an allow list or deny list. +For more detail, please refer to the FilterType model. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the FlowProfile resource to operate on. +Must be 3 to 64 characters long and contain only alphanumeric characters or hyphens. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: FlowProfileName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PipelineName +The name of the pipeline on which to operate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicationScenario +The data replication scenario handled by this FlowProfile. +Please not, that this value cannot be updated after creation. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Status +The operational status of the FlowProfile. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TextMatchingDeny +A list of text patterns to block, each with matching rules and case sensitivity options. + +```yaml +Type: ADT.Models.ITextMatch[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentity +The set of user assigned identities associated with the resource. +The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. +The dictionary values can be empty objects ({}) in requests. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -XmlFilterDefaultNamespace +The default XML namespace used for schema validation. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -XmlFilterReference +Defines the method for referencing the xml schema. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -XmlFilterSchema +The inline XSD schema to be used for validation. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### ADT.Models.IFlowProfile + +## NOTES + +## RELATED LINKS + diff --git a/src/DataTransfer/DataTransfer.Autorest/docs/Update-AzDataTransferFlowProfile.md b/src/DataTransfer/DataTransfer.Autorest/docs/Update-AzDataTransferFlowProfile.md new file mode 100644 index 000000000000..544841113e8e --- /dev/null +++ b/src/DataTransfer/DataTransfer.Autorest/docs/Update-AzDataTransferFlowProfile.md @@ -0,0 +1,600 @@ +--- +external help file: +Module Name: Az.DataTransfer +online version: https://learn.microsoft.com/powershell/module/az.datatransfer/update-azdatatransferflowprofile +schema: 2.0.0 +--- + +# Update-AzDataTransferFlowProfile + +## SYNOPSIS +Applies partial update to an existing FlowProfile resource. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzDataTransferFlowProfile -Name -PipelineName -ResourceGroupName + [-SubscriptionId ] [-AntivirusAvSolution ] [-ArchiveMaximumCompressionRatioLimit ] + [-ArchiveMaximumDepthLimit ] [-ArchiveMaximumExpansionSizeLimit ] + [-ArchiveMinimumSizeForExpansion ] [-DataSizeMaximum ] [-DataSizeMinimum ] + [-Description ] [-IdentityType ] [-MimeFilter ] [-MimeFilterType ] + [-Status ] [-Tag ] [-TextMatchingDeny ] [-UserAssignedIdentity ] + [-XmlFilterDefaultNamespace ] [-XmlFilterReference ] [-XmlFilterSchema ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzDataTransferFlowProfile -InputObject [-AntivirusAvSolution ] + [-ArchiveMaximumCompressionRatioLimit ] [-ArchiveMaximumDepthLimit ] + [-ArchiveMaximumExpansionSizeLimit ] [-ArchiveMinimumSizeForExpansion ] + [-DataSizeMaximum ] [-DataSizeMinimum ] [-Description ] [-IdentityType ] + [-MimeFilter ] [-MimeFilterType ] [-Status ] [-Tag ] + [-TextMatchingDeny ] [-UserAssignedIdentity ] [-XmlFilterDefaultNamespace ] + [-XmlFilterReference ] [-XmlFilterSchema ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-Confirm] [-WhatIf] [] +``` + +### UpdateViaIdentityPipelineExpanded +``` +Update-AzDataTransferFlowProfile -Name -PipelineInputObject + [-AntivirusAvSolution ] [-ArchiveMaximumCompressionRatioLimit ] + [-ArchiveMaximumDepthLimit ] [-ArchiveMaximumExpansionSizeLimit ] + [-ArchiveMinimumSizeForExpansion ] [-DataSizeMaximum ] [-DataSizeMinimum ] + [-Description ] [-IdentityType ] [-MimeFilter ] [-MimeFilterType ] + [-Status ] [-Tag ] [-TextMatchingDeny ] [-UserAssignedIdentity ] + [-XmlFilterDefaultNamespace ] [-XmlFilterReference ] [-XmlFilterSchema ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### UpdateViaJsonFilePath +``` +Update-AzDataTransferFlowProfile -Name -PipelineName -ResourceGroupName + -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +### UpdateViaJsonString +``` +Update-AzDataTransferFlowProfile -Name -PipelineName -ResourceGroupName + -JsonString [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] + [-WhatIf] [] +``` + +## DESCRIPTION +Applies partial update to an existing FlowProfile resource. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AntivirusAvSolution +Optional. +The list of antiviruses to be used as a scanning solution for replicating data. + +```yaml +Type: System.String[] +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded, UpdateViaIdentityPipelineExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ArchiveMaximumCompressionRatioLimit +Optional. +Provides the multiplication value for an archive in total based on the initial object being validated. +This value takes the root object size and multiplies it by this value to create a maximum. +Once this maximum is exceeded, the archive is failed. +Used to detect and block archives with suspiciously high compression (e.g., zip bombs). + +```yaml +Type: System.Double +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded, UpdateViaIdentityPipelineExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ArchiveMaximumDepthLimit +Optional. +The maximum depth of nested archives that can be expanded. +Limits how many layers of embedded archives will be processed. +Archives exceeding the max limit will be denied for replication. + +```yaml +Type: System.Int64 +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded, UpdateViaIdentityPipelineExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ArchiveMaximumExpansionSizeLimit +Optional. +The combined maximum size (in bytes) of all extracted files that an expanded archive is allowed to reach. +Archives exceeding the max limit will be denied for replication. + +```yaml +Type: System.Int64 +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded, UpdateViaIdentityPipelineExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ArchiveMinimumSizeForExpansion +Optional. +Default is 0. +The minimum archive file size (in bytes) required to trigger expansion during replication. +Any archive file size below the configured threshold will skip the rest of the configured rulesets for archives. + +```yaml +Type: System.Int64 +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded, UpdateViaIdentityPipelineExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataSizeMaximum +Optional. +Specifies the maximum allowed size (in bytes) for files to be replicated. +Any file size greater than maximum will be denied replication. + +```yaml +Type: System.Int64 +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded, UpdateViaIdentityPipelineExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataSizeMinimum +Optional. +Default is 0. +Specifies the minimum required size (in bytes) for a file to be eligible for replication. +Any file size less than minimum will be denied replication. + +```yaml +Type: System.Int64 +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded, UpdateViaIdentityPipelineExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +A description of the FlowProfile that defines the replication scenario. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded, UpdateViaIdentityPipelineExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded, UpdateViaIdentityPipelineExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: ADT.Models.IDataTransferIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MimeFilter +Defines the Media types (f.k.a MIME types) and associated file extensions to be filtered. +For more detail, please refer to the MimeTypeFiler model. + +```yaml +Type: ADT.Models.IMimeTypeFilter[] +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded, UpdateViaIdentityPipelineExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MimeFilterType +Specifies whether the filter is an allow list or deny list. +For more detail, please refer to the FilterType model. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded, UpdateViaIdentityPipelineExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the FlowProfile resource to operate on. +Must be 3 to 64 characters long and contain only alphanumeric characters or hyphens. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityPipelineExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Aliases: FlowProfileName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PipelineInputObject +Identity Parameter + +```yaml +Type: ADT.Models.IDataTransferIdentity +Parameter Sets: UpdateViaIdentityPipelineExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PipelineName +The name of the pipeline on which to operate. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Status +The operational status of the FlowProfile. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded, UpdateViaIdentityPipelineExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonFilePath, UpdateViaJsonString +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded, UpdateViaIdentityPipelineExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TextMatchingDeny +A list of text patterns to block, each with matching rules and case sensitivity options. + +```yaml +Type: ADT.Models.ITextMatch[] +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded, UpdateViaIdentityPipelineExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentity +The set of user assigned identities associated with the resource. +The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. +The dictionary values can be empty objects ({}) in requests. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded, UpdateViaIdentityPipelineExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -XmlFilterDefaultNamespace +The default XML namespace used for schema validation. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded, UpdateViaIdentityPipelineExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -XmlFilterReference +Defines the method for referencing the xml schema. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded, UpdateViaIdentityPipelineExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -XmlFilterSchema +The inline XSD schema to be used for validation. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded, UpdateViaIdentityPipelineExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### ADT.Models.IDataTransferIdentity + +## OUTPUTS + +### ADT.Models.IFlowProfile + +## NOTES + +## RELATED LINKS + diff --git a/src/DataTransfer/DataTransfer.Autorest/examples/Get-AzDataTransferFlowProfile.md b/src/DataTransfer/DataTransfer.Autorest/examples/Get-AzDataTransferFlowProfile.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/DataTransfer/DataTransfer.Autorest/examples/Get-AzDataTransferFlowProfile.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/DataTransfer/DataTransfer.Autorest/examples/New-AzDataTransferFlowProfile.md b/src/DataTransfer/DataTransfer.Autorest/examples/New-AzDataTransferFlowProfile.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/DataTransfer/DataTransfer.Autorest/examples/New-AzDataTransferFlowProfile.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/DataTransfer/DataTransfer.Autorest/examples/Update-AzDataTransferFlowProfile.md b/src/DataTransfer/DataTransfer.Autorest/examples/Update-AzDataTransferFlowProfile.md new file mode 100644 index 000000000000..0371f56c36d2 --- /dev/null +++ b/src/DataTransfer/DataTransfer.Autorest/examples/Update-AzDataTransferFlowProfile.md @@ -0,0 +1,22 @@ +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + diff --git a/src/DataTransfer/DataTransfer.Autorest/generate-info.json b/src/DataTransfer/DataTransfer.Autorest/generate-info.json index df3e844b8d95..2ee40944c3e3 100644 --- a/src/DataTransfer/DataTransfer.Autorest/generate-info.json +++ b/src/DataTransfer/DataTransfer.Autorest/generate-info.json @@ -1,3 +1,3 @@ { - "generate_Id": "995ae0b3-5f6b-41c4-afb7-ad9678833aca" + "generate_Id": "23968956-ba83-430d-9fea-64096410fe1a" } diff --git a/src/DataTransfer/DataTransfer.Autorest/test/Get-AzDataTransferAzureDataTransferFlowProfile.Tests.ps1 b/src/DataTransfer/DataTransfer.Autorest/test/Get-AzDataTransferAzureDataTransferFlowProfile.Tests.ps1 new file mode 100644 index 000000000000..8b79a0e149d9 --- /dev/null +++ b/src/DataTransfer/DataTransfer.Autorest/test/Get-AzDataTransferAzureDataTransferFlowProfile.Tests.ps1 @@ -0,0 +1,33 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Get-AzDataTransferAzureDataTransferFlowProfile')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Get-AzDataTransferAzureDataTransferFlowProfile.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Get-AzDataTransferAzureDataTransferFlowProfile' { + It 'ListExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'List' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'ListViaJsonFilePath' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'ListViaJsonString' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/DataTransfer/DataTransfer.Autorest/test/Get-AzDataTransferFlowProfile.Tests.ps1 b/src/DataTransfer/DataTransfer.Autorest/test/Get-AzDataTransferFlowProfile.Tests.ps1 new file mode 100644 index 000000000000..625cb6ce0769 --- /dev/null +++ b/src/DataTransfer/DataTransfer.Autorest/test/Get-AzDataTransferFlowProfile.Tests.ps1 @@ -0,0 +1,33 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Get-AzDataTransferFlowProfile')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Get-AzDataTransferFlowProfile.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Get-AzDataTransferFlowProfile' { + It 'List' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentityPipeline' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'Get' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'GetViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/DataTransfer/DataTransfer.Autorest/test/Get-AzDataTransferFlowProfileTest.Tests.ps1 b/src/DataTransfer/DataTransfer.Autorest/test/Get-AzDataTransferFlowProfileTest.Tests.ps1 new file mode 100644 index 000000000000..f7fb880baf0b --- /dev/null +++ b/src/DataTransfer/DataTransfer.Autorest/test/Get-AzDataTransferFlowProfileTest.Tests.ps1 @@ -0,0 +1,33 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Get-AzDataTransferFlowProfileTest')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Get-AzDataTransferFlowProfileTest.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Get-AzDataTransferFlowProfileTest' { + It 'ListExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'List' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'ListViaJsonFilePath' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'ListViaJsonString' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/DataTransfer/DataTransfer.Autorest/test/New-AzDataTransferFlowProfile.Tests.ps1 b/src/DataTransfer/DataTransfer.Autorest/test/New-AzDataTransferFlowProfile.Tests.ps1 new file mode 100644 index 000000000000..1b5a66f23809 --- /dev/null +++ b/src/DataTransfer/DataTransfer.Autorest/test/New-AzDataTransferFlowProfile.Tests.ps1 @@ -0,0 +1,29 @@ +if(($null -eq $TestName) -or ($TestName -contains 'New-AzDataTransferFlowProfile')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'New-AzDataTransferFlowProfile.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'New-AzDataTransferFlowProfile' { + It 'CreateExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CreateViaJsonFilePath' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'CreateViaJsonString' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/DataTransfer/DataTransfer.Autorest/test/Remove-AzDataTransferFlowProfile.Tests.ps1 b/src/DataTransfer/DataTransfer.Autorest/test/Remove-AzDataTransferFlowProfile.Tests.ps1 new file mode 100644 index 000000000000..5d7a0f75b106 --- /dev/null +++ b/src/DataTransfer/DataTransfer.Autorest/test/Remove-AzDataTransferFlowProfile.Tests.ps1 @@ -0,0 +1,29 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Remove-AzDataTransferFlowProfile')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Remove-AzDataTransferFlowProfile.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Remove-AzDataTransferFlowProfile' { + It 'Delete' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'DeleteViaIdentityPipeline' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'DeleteViaIdentity' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} diff --git a/src/DataTransfer/DataTransfer.Autorest/test/Update-AzDataTransferFlowProfile.Tests.ps1 b/src/DataTransfer/DataTransfer.Autorest/test/Update-AzDataTransferFlowProfile.Tests.ps1 new file mode 100644 index 000000000000..6704aab257b7 --- /dev/null +++ b/src/DataTransfer/DataTransfer.Autorest/test/Update-AzDataTransferFlowProfile.Tests.ps1 @@ -0,0 +1,37 @@ +if(($null -eq $TestName) -or ($TestName -contains 'Update-AzDataTransferFlowProfile')) +{ + $loadEnvPath = Join-Path $PSScriptRoot 'loadEnv.ps1' + if (-Not (Test-Path -Path $loadEnvPath)) { + $loadEnvPath = Join-Path $PSScriptRoot '..\loadEnv.ps1' + } + . ($loadEnvPath) + $TestRecordingFile = Join-Path $PSScriptRoot 'Update-AzDataTransferFlowProfile.Recording.json' + $currentPath = $PSScriptRoot + while(-not $mockingPath) { + $mockingPath = Get-ChildItem -Path $currentPath -Recurse -Include 'HttpPipelineMocking.ps1' -File + $currentPath = Split-Path -Path $currentPath -Parent + } + . ($mockingPath | Select-Object -First 1).FullName +} + +Describe 'Update-AzDataTransferFlowProfile' { + It 'UpdateExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'UpdateViaJsonString' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'UpdateViaJsonFilePath' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'UpdateViaIdentityPipelineExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } + + It 'UpdateViaIdentityExpanded' -skip { + { throw [System.NotImplementedException] } | Should -Not -Throw + } +} From 999bd9e8ae90f6439d8d32d4c122f42bd4e2d7ac Mon Sep 17 00:00:00 2001 From: Faizan Uddin Fahad Khan Date: Mon, 13 Oct 2025 20:22:39 +0530 Subject: [PATCH 2/2] add help docs --- src/DataTransfer/DataTransfer.sln | 28 +- .../DataTransfer/Az.DataTransfer.psd1 | 16 +- .../help/Approve-AzDataTransferConnection.md | 6 +- .../DataTransfer/help/Az.DataTransfer.md | 15 +- .../help/Deny-AzDataTransferConnection.md | 6 +- .../help/Get-AzDataTransferFlowProfile.md | 307 +++++++++ .../help/Get-AzDataTransferPipeline.md | 6 +- .../help/New-AzDataTransferConnection.md | 54 +- .../help/New-AzDataTransferFlow.md | 235 ++++++- .../help/New-AzDataTransferFlowProfile.md | 576 +++++++++++++++++ .../help/Update-AzDataTransferFlowProfile.md | 601 ++++++++++++++++++ 11 files changed, 1787 insertions(+), 63 deletions(-) create mode 100644 src/DataTransfer/DataTransfer/help/Get-AzDataTransferFlowProfile.md create mode 100644 src/DataTransfer/DataTransfer/help/New-AzDataTransferFlowProfile.md create mode 100644 src/DataTransfer/DataTransfer/help/Update-AzDataTransferFlowProfile.md diff --git a/src/DataTransfer/DataTransfer.sln b/src/DataTransfer/DataTransfer.sln index f3cc06451f9e..88420082585a 100644 --- a/src/DataTransfer/DataTransfer.sln +++ b/src/DataTransfer/DataTransfer.sln @@ -21,7 +21,7 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "DataTransfer", "DataTransfe EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "DataTransfer.Autorest", "DataTransfer.Autorest", "{E3651BD2-2AAA-41CF-2DFA-F6780C65890A}" EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Az.DataTransfer", "..\..\generated\DataTransfer\DataTransfer.Autorest\Az.DataTransfer.csproj", "{820429A9-ADC6-4F66-B038-1DAFBB605A78}" +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Az.DataTransfer", "..\..\generated\DataTransfer\DataTransfer.Autorest\Az.DataTransfer.csproj", "{32D241CF-7D78-455F-908B-3351058F6BB0}" EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution @@ -117,18 +117,18 @@ Global {23D2B465-3259-453B-A927-C5C4E7EE2375}.Release|x64.Build.0 = Release|Any CPU {23D2B465-3259-453B-A927-C5C4E7EE2375}.Release|x86.ActiveCfg = Release|Any CPU {23D2B465-3259-453B-A927-C5C4E7EE2375}.Release|x86.Build.0 = Release|Any CPU - {820429A9-ADC6-4F66-B038-1DAFBB605A78}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {820429A9-ADC6-4F66-B038-1DAFBB605A78}.Debug|Any CPU.Build.0 = Debug|Any CPU - {820429A9-ADC6-4F66-B038-1DAFBB605A78}.Debug|x64.ActiveCfg = Debug|Any CPU - {820429A9-ADC6-4F66-B038-1DAFBB605A78}.Debug|x64.Build.0 = Debug|Any CPU - {820429A9-ADC6-4F66-B038-1DAFBB605A78}.Debug|x86.ActiveCfg = Debug|Any CPU - {820429A9-ADC6-4F66-B038-1DAFBB605A78}.Debug|x86.Build.0 = Debug|Any CPU - {820429A9-ADC6-4F66-B038-1DAFBB605A78}.Release|Any CPU.ActiveCfg = Release|Any CPU - {820429A9-ADC6-4F66-B038-1DAFBB605A78}.Release|Any CPU.Build.0 = Release|Any CPU - {820429A9-ADC6-4F66-B038-1DAFBB605A78}.Release|x64.ActiveCfg = Release|Any CPU - {820429A9-ADC6-4F66-B038-1DAFBB605A78}.Release|x64.Build.0 = Release|Any CPU - {820429A9-ADC6-4F66-B038-1DAFBB605A78}.Release|x86.ActiveCfg = Release|Any CPU - {820429A9-ADC6-4F66-B038-1DAFBB605A78}.Release|x86.Build.0 = Release|Any CPU + {32D241CF-7D78-455F-908B-3351058F6BB0}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {32D241CF-7D78-455F-908B-3351058F6BB0}.Debug|Any CPU.Build.0 = Debug|Any CPU + {32D241CF-7D78-455F-908B-3351058F6BB0}.Debug|x64.ActiveCfg = Debug|Any CPU + {32D241CF-7D78-455F-908B-3351058F6BB0}.Debug|x64.Build.0 = Debug|Any CPU + {32D241CF-7D78-455F-908B-3351058F6BB0}.Debug|x86.ActiveCfg = Debug|Any CPU + {32D241CF-7D78-455F-908B-3351058F6BB0}.Debug|x86.Build.0 = Debug|Any CPU + {32D241CF-7D78-455F-908B-3351058F6BB0}.Release|Any CPU.ActiveCfg = Release|Any CPU + {32D241CF-7D78-455F-908B-3351058F6BB0}.Release|Any CPU.Build.0 = Release|Any CPU + {32D241CF-7D78-455F-908B-3351058F6BB0}.Release|x64.ActiveCfg = Release|Any CPU + {32D241CF-7D78-455F-908B-3351058F6BB0}.Release|x64.Build.0 = Release|Any CPU + {32D241CF-7D78-455F-908B-3351058F6BB0}.Release|x86.ActiveCfg = Release|Any CPU + {32D241CF-7D78-455F-908B-3351058F6BB0}.Release|x86.Build.0 = Release|Any CPU EndGlobalSection GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE @@ -140,6 +140,6 @@ Global {4BDF5DC6-A518-46E6-99C6-3AF3BFE24451} = {32836310-FB5E-5A92-56B4-44D826EF11F5} {244454EF-5EAF-40F6-895F-DA49D8681DFF} = {32836310-FB5E-5A92-56B4-44D826EF11F5} {081B7423-0DAA-462B-ACF1-4C7600C6D131} = {32836310-FB5E-5A92-56B4-44D826EF11F5} - {820429A9-ADC6-4F66-B038-1DAFBB605A78} = {E3651BD2-2AAA-41CF-2DFA-F6780C65890A} + {32D241CF-7D78-455F-908B-3351058F6BB0} = {E3651BD2-2AAA-41CF-2DFA-F6780C65890A} EndGlobalSection EndGlobal diff --git a/src/DataTransfer/DataTransfer/Az.DataTransfer.psd1 b/src/DataTransfer/DataTransfer/Az.DataTransfer.psd1 index 1c1fd2fa2339..98fc240a8aa6 100644 --- a/src/DataTransfer/DataTransfer/Az.DataTransfer.psd1 +++ b/src/DataTransfer/DataTransfer/Az.DataTransfer.psd1 @@ -3,7 +3,7 @@ # # Generated by: Microsoft Corporation # -# Generated on: 8/27/2025 +# Generated on: 10/13/2025 # @{ @@ -57,10 +57,10 @@ RequiredModules = @(@{ModuleName = 'Az.Accounts'; ModuleVersion = '5.3.0'; }) RequiredAssemblies = 'DataTransfer.Autorest/bin/Az.DataTransfer.private.dll' # Script files (.ps1) that are run in the caller's environment prior to importing this module. -# ScriptsToProcess = @() +ScriptsToProcess = @() # Type files (.ps1xml) to be loaded when importing this module -# TypesToProcess = @() +TypesToProcess = @() # Format files (.ps1xml) to be loaded when importing this module FormatsToProcess = 'DataTransfer.Autorest/Az.DataTransfer.format.ps1xml' @@ -75,13 +75,15 @@ FunctionsToExport = 'Approve-AzDataTransferConnection', 'Deny-AzDataTransferConn 'Enable-AzDataTransferConnection', 'Enable-AzDataTransferFlow', 'Enable-AzDataTransferFlowType', 'Enable-AzDataTransferPipeline', 'Get-AzDataTransferConnection', 'Get-AzDataTransferFlow', + 'Get-AzDataTransferFlowProfile', 'Get-AzDataTransferPendingConnection', 'Get-AzDataTransferPendingFlow', 'Get-AzDataTransferPipeline', 'Invoke-AzDataTransferLinkPendingConnection', 'Invoke-AzDataTransferLinkPendingFlow', 'New-AzDataTransferConnection', 'New-AzDataTransferFlow', - 'Remove-AzDataTransferConnection', 'Remove-AzDataTransferFlow', - 'Update-AzDataTransferConnection', 'Update-AzDataTransferFlow' + 'New-AzDataTransferFlowProfile', 'Remove-AzDataTransferConnection', + 'Remove-AzDataTransferFlow', 'Update-AzDataTransferConnection', + 'Update-AzDataTransferFlow', 'Update-AzDataTransferFlowProfile' # Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export. CmdletsToExport = @() @@ -107,7 +109,7 @@ PrivateData = @{ PSData = @{ # Tags applied to this module. These help with module discovery in online galleries. - Tags = 'Azure','ResourceManager','ARM','PSModule','DataTransfer' + Tags = 'Azure', 'ResourceManager', 'ARM', 'PSModule', 'DataTransfer' # A URL to the license for this module. LicenseUri = 'https://aka.ms/azps-license' @@ -133,7 +135,7 @@ PrivateData = @{ } # End of PSData hashtable - } # End of PrivateData hashtable +} # End of PrivateData hashtable # HelpInfo URI of this module # HelpInfoURI = '' diff --git a/src/DataTransfer/DataTransfer/help/Approve-AzDataTransferConnection.md b/src/DataTransfer/DataTransfer/help/Approve-AzDataTransferConnection.md index 4ee4e802fa25..b1dee86d2186 100644 --- a/src/DataTransfer/DataTransfer/help/Approve-AzDataTransferConnection.md +++ b/src/DataTransfer/DataTransfer/help/Approve-AzDataTransferConnection.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Approve-AzDataTransferConnection ## SYNOPSIS -Approves the specified connection request in a pipeline. +Approves a pending connection request associated with the specified Pipeline. ## SYNTAX @@ -55,7 +55,7 @@ Approve-AzDataTransferConnection -InputObject -Connectio ``` ## DESCRIPTION -Approves the specified connection request in a pipeline. +Approves a pending connection request associated with the specified Pipeline. ## EXAMPLES @@ -234,7 +234,7 @@ Accept wildcard characters: False ``` ### -PipelineName -The name for the pipeline to perform the operation on. +The name of the pipeline on which to operate. ```yaml Type: System.String diff --git a/src/DataTransfer/DataTransfer/help/Az.DataTransfer.md b/src/DataTransfer/DataTransfer/help/Az.DataTransfer.md index 729b1c810a1f..fc38403a71b2 100644 --- a/src/DataTransfer/DataTransfer/help/Az.DataTransfer.md +++ b/src/DataTransfer/DataTransfer/help/Az.DataTransfer.md @@ -12,10 +12,10 @@ Microsoft Azure PowerShell: DataTransfer cmdlets ## Az.DataTransfer Cmdlets ### [Approve-AzDataTransferConnection](Approve-AzDataTransferConnection.md) -Approves the specified connection request in a pipeline. +Approves a pending connection request associated with the specified Pipeline. ### [Deny-AzDataTransferConnection](Deny-AzDataTransferConnection.md) -Rejects the specified connection request in a pipeline. +Rejects a pending connection request associated with the specified Pipeline. ### [Disable-AzDataTransferConnection](Disable-AzDataTransferConnection.md) Disables Azure Data Transfer connections. @@ -47,6 +47,9 @@ Gets connection resource. ### [Get-AzDataTransferFlow](Get-AzDataTransferFlow.md) Gets flow resource. +### [Get-AzDataTransferFlowProfile](Get-AzDataTransferFlowProfile.md) +Retrieves the specified FlowProfile resource. + ### [Get-AzDataTransferPendingConnection](Get-AzDataTransferPendingConnection.md) Lists all pending remote connections that are linkable to this connection. @@ -54,7 +57,7 @@ Lists all pending remote connections that are linkable to this connection. Lists all remote flows that have not yet been linked to local flows ### [Get-AzDataTransferPipeline](Get-AzDataTransferPipeline.md) -Gets pipeline resource. +Retrieves the specified Pipeline resource. ### [Invoke-AzDataTransferLinkPendingConnection](Invoke-AzDataTransferLinkPendingConnection.md) Links the connection to its pending connection. @@ -68,6 +71,9 @@ Create the connection resource. ### [New-AzDataTransferFlow](New-AzDataTransferFlow.md) Create the flow resource. +### [New-AzDataTransferFlowProfile](New-AzDataTransferFlowProfile.md) +Create a new FlowProfile or create an existing one. + ### [Remove-AzDataTransferConnection](Remove-AzDataTransferConnection.md) Deletes the connection resource. @@ -80,3 +86,6 @@ Update the connection resource. ### [Update-AzDataTransferFlow](Update-AzDataTransferFlow.md) Update the flow resource. +### [Update-AzDataTransferFlowProfile](Update-AzDataTransferFlowProfile.md) +Applies partial update to an existing FlowProfile resource. + diff --git a/src/DataTransfer/DataTransfer/help/Deny-AzDataTransferConnection.md b/src/DataTransfer/DataTransfer/help/Deny-AzDataTransferConnection.md index bcd3ab46770e..c44ec97f24b6 100644 --- a/src/DataTransfer/DataTransfer/help/Deny-AzDataTransferConnection.md +++ b/src/DataTransfer/DataTransfer/help/Deny-AzDataTransferConnection.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Deny-AzDataTransferConnection ## SYNOPSIS -Rejects the specified connection request in a pipeline. +Rejects a pending connection request associated with the specified Pipeline. ## SYNTAX @@ -55,7 +55,7 @@ Deny-AzDataTransferConnection -InputObject -Connection < ``` ## DESCRIPTION -Rejects the specified connection request in a pipeline. +Rejects a pending connection request associated with the specified Pipeline. ## EXAMPLES @@ -234,7 +234,7 @@ Accept wildcard characters: False ``` ### -PipelineName -The name for the pipeline to perform the operation on. +The name of the pipeline on which to operate. ```yaml Type: System.String diff --git a/src/DataTransfer/DataTransfer/help/Get-AzDataTransferFlowProfile.md b/src/DataTransfer/DataTransfer/help/Get-AzDataTransferFlowProfile.md new file mode 100644 index 000000000000..8fd51193fd66 --- /dev/null +++ b/src/DataTransfer/DataTransfer/help/Get-AzDataTransferFlowProfile.md @@ -0,0 +1,307 @@ +--- +external help file: Az.DataTransfer-help.xml +Module Name: Az.DataTransfer +online version: https://learn.microsoft.com/powershell/module/az.datatransfer/get-azdatatransferflowprofile +schema: 2.0.0 +--- + +# Get-AzDataTransferFlowProfile + +## SYNOPSIS +Retrieves the specified FlowProfile resource. + +## SYNTAX + +### ListExpanded (Default) +``` +Get-AzDataTransferFlowProfile [-PipelineName ] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### GetViaIdentityPipeline +``` +Get-AzDataTransferFlowProfile -Name -PipelineInputObject + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### Get +``` +Get-AzDataTransferFlowProfile -Name -PipelineName -ResourceGroupName + [-SubscriptionId ] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] +``` + +### List1 +``` +Get-AzDataTransferFlowProfile -PipelineName -ResourceGroupName [-SubscriptionId ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### GetViaIdentity +``` +Get-AzDataTransferFlowProfile -InputObject [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### List +``` +Get-AzDataTransferFlowProfile -Body [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### ListViaJsonFilePath +``` +Get-AzDataTransferFlowProfile -JsonFilePath [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### ListViaJsonString +``` +Get-AzDataTransferFlowProfile -JsonString [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Retrieves the specified FlowProfile resource. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -Body +Defines the required request body for retrieving FlowProfile information for a provided pipeline. + +```yaml +Type: ADT.Models.IListFlowProfilesRequest +Parameter Sets: List +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: ADT.Models.IDataTransferIdentity +Parameter Sets: GetViaIdentity +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the List operation + +```yaml +Type: System.String +Parameter Sets: ListViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the List operation + +```yaml +Type: System.String +Parameter Sets: ListViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the FlowProfile resource to operate on. +Must be 3 to 64 characters long and contain only alphanumeric characters or hyphens. + +```yaml +Type: System.String +Parameter Sets: GetViaIdentityPipeline, Get +Aliases: FlowProfileName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PipelineInputObject +Identity Parameter + +```yaml +Type: ADT.Models.IDataTransferIdentity +Parameter Sets: GetViaIdentityPipeline +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PipelineName +The name of the pipeline on which to operate. + +```yaml +Type: System.String +Parameter Sets: ListExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: Get, List1 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String[] +Parameter Sets: Get, List1 +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### ADT.Models.IDataTransferIdentity + +### ADT.Models.IListFlowProfilesRequest + +## OUTPUTS + +### ADT.Models.IFlowProfile + +### ADT.Models.IFlowProfilesListResult + +## NOTES + +## RELATED LINKS diff --git a/src/DataTransfer/DataTransfer/help/Get-AzDataTransferPipeline.md b/src/DataTransfer/DataTransfer/help/Get-AzDataTransferPipeline.md index 138d9e81b4b3..71509abc8a48 100644 --- a/src/DataTransfer/DataTransfer/help/Get-AzDataTransferPipeline.md +++ b/src/DataTransfer/DataTransfer/help/Get-AzDataTransferPipeline.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-AzDataTransferPipeline ## SYNOPSIS -Gets pipeline resource. +Retrieves the specified Pipeline resource. ## SYNTAX @@ -37,7 +37,7 @@ Get-AzDataTransferPipeline -InputObject [-DefaultProfile ``` ## DESCRIPTION -Gets pipeline resource. +Retrieves the specified Pipeline resource. ## EXAMPLES @@ -186,7 +186,7 @@ Accept wildcard characters: False ``` ### -Name -The name for the pipeline to perform the operation on. +The name of the pipeline on which to operate. ```yaml Type: System.String diff --git a/src/DataTransfer/DataTransfer/help/New-AzDataTransferConnection.md b/src/DataTransfer/DataTransfer/help/New-AzDataTransferConnection.md index bc438926177d..1aa5822630f4 100644 --- a/src/DataTransfer/DataTransfer/help/New-AzDataTransferConnection.md +++ b/src/DataTransfer/DataTransfer/help/New-AzDataTransferConnection.md @@ -15,12 +15,12 @@ Create the connection resource. ### CreateExpanded (Default) ``` New-AzDataTransferConnection -Name -ResourceGroupName [-SubscriptionId ] - -Location [-Direction ] [-FlowType ] [-IdentityType ] - [-Justification ] [-Pin ] [-PipelineName ] [-PrimaryContact ] - [-RemoteSubscriptionId ] [-RequirementId ] [-Schema ] [-SchemaUri ] - [-SecondaryContact ] [-Tag ] [-UserAssignedIdentity ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] - [] + -Location [-ApiHostname ] [-Direction ] [-FlowProfileList ] + [-FlowType ] [-IdentityType ] [-Justification ] [-Pin ] + [-PipelineName ] [-PrimaryContact ] [-RemoteSubscriptionId ] [-RequirementId ] + [-Schema ] [-SchemaUri ] [-SecondaryContact ] [-Tag ] + [-UserAssignedIdentity ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] ``` ### CreateViaJsonFilePath @@ -193,6 +193,21 @@ This example creates a new connection named `Connection03` in the resource group ## PARAMETERS +### -ApiHostname +Hostname specific to API Flows + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -AsJob Run the command as a job @@ -239,8 +254,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -FlowProfileList +Provides a list of FlowProfiles . + +```yaml +Type: ADT.Models.IFlowProfileMetadata[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -FlowType -The flow types being requested for this connection +The flow types being requested for this connection. +This FlowType property has reached end of life support starting version 2025-05-30-preview. +Please create a FlowProfile resource instead. ```yaml Type: System.String[] @@ -451,7 +483,9 @@ Accept wildcard characters: False ``` ### -Schema -The schemas for this connection +The schemas for this connection. +The schemas property has reached end of life support starting version 2025-05-30-preview. +Please create and use a FlowProfile resource instead. ```yaml Type: ADT.Models.ISchema[] @@ -466,7 +500,9 @@ Accept wildcard characters: False ``` ### -SchemaUri -The schema URIs for this connection +The schema URIs for this connection. +The schemaUris property has reached end of life support starting version 2025-05-30-preview. +Please create and use a FlowProfile resource instead. ```yaml Type: System.String[] diff --git a/src/DataTransfer/DataTransfer/help/New-AzDataTransferFlow.md b/src/DataTransfer/DataTransfer/help/New-AzDataTransferFlow.md index 50a586f1c912..a33eef89875e 100644 --- a/src/DataTransfer/DataTransfer/help/New-AzDataTransferFlow.md +++ b/src/DataTransfer/DataTransfer/help/New-AzDataTransferFlow.md @@ -16,21 +16,26 @@ Create the flow resource. ``` New-AzDataTransferFlow -ConnectionName -Name -ResourceGroupName [-SubscriptionId ] -Location [-ApiFlowOptionApiMode ] - [-ApiFlowOptionAudienceOverride ] [-ApiFlowOptionCname ] - [-ApiFlowOptionIdentityTranslation ] [-ApiFlowOptionRemoteCallingModeClientId ] - [-ApiFlowOptionRemoteEndpoint ] [-ApiFlowOptionSenderClientId ] [-ConnectionId ] - [-ConnectionLocation ] [-ConnectionSubscriptionName ] [-ConsumerGroup ] - [-CustomerManagedKeyVaultUri ] [-DataType ] [-DestinationEndpoint ] - [-DestinationEndpointPort ] [-EventHubId ] [-FlowType ] [-IdentityType ] - [-MessagingOptionBillingTier ] [-Passphrase ] [-PlanName ] [-PlanProduct ] - [-PlanPromotionCode ] [-PlanPublisher ] [-PlanVersion ] - [-PropertiesConnectionName ] [-SchemaConnectionId ] [-SchemaContent ] - [-SchemaDirection ] [-SchemaId ] [-SchemaName ] [-SchemaStatus ] - [-SchemaType ] [-SchemaUri ] [-ServiceBusQueueId ] [-SourceAddress ] - [-Status ] [-StorageAccountId ] [-StorageAccountName ] - [-StorageContainerName ] [-StorageTableName ] [-StreamId ] [-StreamLatency ] - [-StreamProtocol ] [-Tag ] [-UserAssignedIdentity ] [-DefaultProfile ] - [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] + [-ApiFlowOptionAudienceOverride ] [-ApiFlowOptionAuthentication ] + [-ApiFlowOptionCname ] [-ApiFlowOptionIdentityTranslation ] + [-ApiFlowOptionRemoteCallingModeClientId ] [-ApiFlowOptionRemoteEndpoint ] + [-ApiFlowOptionSenderClientId ] [-ConnectionId ] [-ConnectionLocation ] + [-ConnectionSubscriptionName ] [-ConsumerGroup ] [-CustomerManagedKeyVaultUri ] + [-DataType ] [-DestinationEndpoint ] [-DestinationEndpointPort ] + [-EventHubId ] [-FlowDataType ] [-FlowProfileDescription ] [-FlowProfileId ] + [-FlowProfileName ] [-FlowProfilePipeline ] [-FlowProfileReplicationScenario ] + [-FlowProfileStatus ] [-FlowType ] [-IdentityType ] + [-MessagingOptionBillingTier ] [-MessagingOptionPerformancePriority ] [-Passphrase ] + [-PlanName ] [-PlanProduct ] [-PlanPromotionCode ] [-PlanPublisher ] + [-PlanVersion ] [-PropertiesConnectionName ] + [-RemoteEndpointSettingAuthentication ] [-RemoteEndpointSettingEndpoint ] + [-SchemaConnectionId ] [-SchemaContent ] [-SchemaDirection ] [-SchemaId ] + [-SchemaName ] [-SchemaStatus ] [-SchemaType ] [-SchemaUri ] + [-ServiceBusQueueId ] [-SourceAddress ] [-Status ] [-StorageAccountId ] + [-StorageAccountName ] [-StorageContainerName ] [-StorageTableName ] + [-StreamId ] [-StreamLatency ] [-StreamProtocol ] [-Tag ] + [-UserAssignedIdentity ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] ``` ### CreateViaJsonFilePath @@ -229,7 +234,9 @@ Accept wildcard characters: False ``` ### -ApiFlowOptionAudienceOverride -Optional field to override the audience of the remote endpoint +Optional field to override the audience of the remote endpoint. +The property has reached end of life support starting version 2025-05-30-preview. +Please create and use the authentication property instead. ```yaml Type: System.String @@ -243,6 +250,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ApiFlowOptionAuthentication +Optional and for advanced used only. +A list of authentication methods to use when accessing the Azure Data Transfer API Flow. +If not provided, the default S2S authentication using Entra (API Flow Managed Identity) and RBAC will be applied. + +```yaml +Type: ADT.Models.IAuthentication[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ApiFlowOptionCname Unique CNAME to represent the Azure Data Transfer API Flow instance @@ -259,7 +283,9 @@ Accept wildcard characters: False ``` ### -ApiFlowOptionIdentityTranslation -Flag for if Azure Data Transfer API Flow should extract the user token +Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. +The property has reached end of life support starting version 2025-05-30-preview. +Please create and use the authentication property instead. ```yaml Type: System.String @@ -274,7 +300,9 @@ Accept wildcard characters: False ``` ### -ApiFlowOptionRemoteCallingModeClientId -Remote stub app registration Client ID +Remote stub app registration Client ID. +The property has reached end of life support starting version 2025-05-30-preview. +Please create and use the authentication property instead. ```yaml Type: System.String @@ -289,7 +317,9 @@ Accept wildcard characters: False ``` ### -ApiFlowOptionRemoteEndpoint -Remote host to which communication needs to be made +Remote host to which communication needs to be made. +The property has reached end of life support starting version 2025-05-30-preview. +Please create and use the remoteEndpointSettings.endpoint property instead. ```yaml Type: System.String @@ -304,7 +334,9 @@ Accept wildcard characters: False ``` ### -ApiFlowOptionSenderClientId -Sender's app user assigned Manage Identity client ID +Sender's app user assigned Manage Identity client ID. +The property has reached end of life support starting version 2025-05-30-preview. +Please create and use the authentication property instead. ```yaml Type: System.String @@ -425,6 +457,8 @@ Accept wildcard characters: False ### -DataType Type of data to transfer via the flow. +The property has reached end of life support starting version 2025-05-30-preview. +Please create and use a FlowProfile resource instead. ```yaml Type: System.String @@ -499,8 +533,118 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -FlowDataType +The Flow's data class. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FlowProfileDescription +A description of the FlowProfile and its rulesets. +The description should describe the flowprofile's purpose and rulesets applied. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FlowProfileId +A guid represented as a string for the FlowProfile resource, assigned by the system. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FlowProfileName +The name of the FlowProfile. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FlowProfilePipeline +The name of the parent Pipeline Azure resource associated with this FlowProfile. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FlowProfileReplicationScenario +The data replication scenario handled by this FlowProfile. +Please note, that this value cannot be updated after creation. +See the FlowProfilePatchProperties to see updateable properties. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FlowProfileStatus +The operational status of the FlowProfile. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -FlowType -The flow type for this flow +The flow type for this flow. +The property has reached end of life support starting version 2025-05-30-preview. +Please create and use a FlowProfile resource instead. ```yaml Type: System.String @@ -589,6 +733,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -MessagingOptionPerformancePriority +Field indicating whether to enable guaranteed delivery on the flow or not. +The default disabled option chooses speed over consistency. +When enabled, messages are delivered with minimal delay, but delivery is not guaranteed under all conditions + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name The name for the flow to perform the operation on. @@ -729,6 +890,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -RemoteEndpointSettingAuthentication +Optional and for advanced used only. +A list of authentication methods to use when accessing the remote endpoint. +If not provided, the default S2S authentication using Entra (API Flow Managed Identity) and RBAC will be applied. + +```yaml +Type: ADT.Models.IAuthentication[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RemoteEndpointSettingEndpoint +The remote endpoint uri all API calls. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The name of the resource group. The name is case insensitive. diff --git a/src/DataTransfer/DataTransfer/help/New-AzDataTransferFlowProfile.md b/src/DataTransfer/DataTransfer/help/New-AzDataTransferFlowProfile.md new file mode 100644 index 000000000000..d4cccb0092c8 --- /dev/null +++ b/src/DataTransfer/DataTransfer/help/New-AzDataTransferFlowProfile.md @@ -0,0 +1,576 @@ +--- +external help file: Az.DataTransfer-help.xml +Module Name: Az.DataTransfer +online version: https://learn.microsoft.com/powershell/module/az.datatransfer/new-azdatatransferflowprofile +schema: 2.0.0 +--- + +# New-AzDataTransferFlowProfile + +## SYNOPSIS +Create a new FlowProfile or create an existing one. + +## SYNTAX + +### CreateExpanded (Default) +``` +New-AzDataTransferFlowProfile -Name -PipelineName -ResourceGroupName + [-SubscriptionId ] -Location [-AntivirusAvSolution ] + [-ArchiveMaximumCompressionRatioLimit ] [-ArchiveMaximumDepthLimit ] + [-ArchiveMaximumExpansionSizeLimit ] [-ArchiveMinimumSizeForExpansion ] + [-DataSizeMaximum ] [-DataSizeMinimum ] [-Description ] [-IdentityType ] + [-MimeFilter ] [-MimeFilterType ] [-ReplicationScenario ] + [-Status ] [-Tag ] [-TextMatchingDeny ] [-UserAssignedIdentity ] + [-XmlFilterDefaultNamespace ] [-XmlFilterReference ] [-XmlFilterSchema ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] +``` + +### CreateViaJsonFilePath +``` +New-AzDataTransferFlowProfile -Name -PipelineName -ResourceGroupName + [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### CreateViaJsonString +``` +New-AzDataTransferFlowProfile -Name -PipelineName -ResourceGroupName + [-SubscriptionId ] -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Create a new FlowProfile or create an existing one. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AntivirusAvSolution +Optional. +The list of antiviruses to be used as a scanning solution for replicating data. + +```yaml +Type: System.String[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ArchiveMaximumCompressionRatioLimit +Optional. +Provides the multiplication value for an archive in total based on the initial object being validated. +This value takes the root object size and multiplies it by this value to create a maximum. +Once this maximum is exceeded, the archive is failed. +Used to detect and block archives with suspiciously high compression (e.g., zip bombs). + +```yaml +Type: System.Double +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ArchiveMaximumDepthLimit +Optional. +The maximum depth of nested archives that can be expanded. +Limits how many layers of embedded archives will be processed. +Archives exceeding the max limit will be denied for replication. + +```yaml +Type: System.Int64 +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ArchiveMaximumExpansionSizeLimit +Optional. +The combined maximum size (in bytes) of all extracted files that an expanded archive is allowed to reach. +Archives exceeding the max limit will be denied for replication. + +```yaml +Type: System.Int64 +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ArchiveMinimumSizeForExpansion +Optional. +Default is 0. +The minimum archive file size (in bytes) required to trigger expansion during replication. +Any archive file size below the configured threshold will skip the rest of the configured rulesets for archives. + +```yaml +Type: System.Int64 +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataSizeMaximum +Optional. +Specifies the maximum allowed size (in bytes) for files to be replicated. +Any file size greater than maximum will be denied replication. + +```yaml +Type: System.Int64 +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataSizeMinimum +Optional. +Default is 0. +Specifies the minimum required size (in bytes) for a file to be eligible for replication. +Any file size less than minimum will be denied replication. + +```yaml +Type: System.Int64 +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +A user-defined description of the FlowProfile. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Location +The geo-location where the resource lives + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MimeFilter +Defines the Media types (f.k.a MIME types) and associated file extensions to be filtered. +For more detail, please refer to the MimeTypeFiler model. + +```yaml +Type: ADT.Models.IMimeTypeFilter[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MimeFilterType +Specifies whether the filter is an allow list or deny list. +For more detail, please refer to the FilterType model. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the FlowProfile resource to operate on. +Must be 3 to 64 characters long and contain only alphanumeric characters or hyphens. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: FlowProfileName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PipelineName +The name of the pipeline on which to operate. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplicationScenario +The data replication scenario handled by this FlowProfile. +Please not, that this value cannot be updated after creation. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Status +The operational status of the FlowProfile. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TextMatchingDeny +A list of text patterns to block, each with matching rules and case sensitivity options. + +```yaml +Type: ADT.Models.ITextMatch[] +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentity +The set of user assigned identities associated with the resource. +The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. +The dictionary values can be empty objects ({}) in requests. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -XmlFilterDefaultNamespace +The default XML namespace used for schema validation. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -XmlFilterReference +Defines the method for referencing the xml schema. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -XmlFilterSchema +The inline XSD schema to be used for validation. + +```yaml +Type: System.String +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### ADT.Models.IFlowProfile + +## NOTES + +## RELATED LINKS diff --git a/src/DataTransfer/DataTransfer/help/Update-AzDataTransferFlowProfile.md b/src/DataTransfer/DataTransfer/help/Update-AzDataTransferFlowProfile.md new file mode 100644 index 000000000000..1abbf629b465 --- /dev/null +++ b/src/DataTransfer/DataTransfer/help/Update-AzDataTransferFlowProfile.md @@ -0,0 +1,601 @@ +--- +external help file: Az.DataTransfer-help.xml +Module Name: Az.DataTransfer +online version: https://learn.microsoft.com/powershell/module/az.datatransfer/update-azdatatransferflowprofile +schema: 2.0.0 +--- + +# Update-AzDataTransferFlowProfile + +## SYNOPSIS +Applies partial update to an existing FlowProfile resource. + +## SYNTAX + +### UpdateExpanded (Default) +``` +Update-AzDataTransferFlowProfile -Name -PipelineName -ResourceGroupName + [-SubscriptionId ] [-AntivirusAvSolution ] [-ArchiveMaximumCompressionRatioLimit ] + [-ArchiveMaximumDepthLimit ] [-ArchiveMaximumExpansionSizeLimit ] + [-ArchiveMinimumSizeForExpansion ] [-DataSizeMaximum ] [-DataSizeMinimum ] + [-Description ] [-IdentityType ] [-MimeFilter ] [-MimeFilterType ] + [-Status ] [-Tag ] [-TextMatchingDeny ] [-UserAssignedIdentity ] + [-XmlFilterDefaultNamespace ] [-XmlFilterReference ] [-XmlFilterSchema ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] +``` + +### UpdateViaJsonString +``` +Update-AzDataTransferFlowProfile -Name -PipelineName -ResourceGroupName + [-SubscriptionId ] -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### UpdateViaJsonFilePath +``` +Update-AzDataTransferFlowProfile -Name -PipelineName -ResourceGroupName + [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### UpdateViaIdentityPipelineExpanded +``` +Update-AzDataTransferFlowProfile -Name -PipelineInputObject + [-AntivirusAvSolution ] [-ArchiveMaximumCompressionRatioLimit ] + [-ArchiveMaximumDepthLimit ] [-ArchiveMaximumExpansionSizeLimit ] + [-ArchiveMinimumSizeForExpansion ] [-DataSizeMaximum ] [-DataSizeMinimum ] + [-Description ] [-IdentityType ] [-MimeFilter ] [-MimeFilterType ] + [-Status ] [-Tag ] [-TextMatchingDeny ] [-UserAssignedIdentity ] + [-XmlFilterDefaultNamespace ] [-XmlFilterReference ] [-XmlFilterSchema ] + [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] + [] +``` + +### UpdateViaIdentityExpanded +``` +Update-AzDataTransferFlowProfile -InputObject [-AntivirusAvSolution ] + [-ArchiveMaximumCompressionRatioLimit ] [-ArchiveMaximumDepthLimit ] + [-ArchiveMaximumExpansionSizeLimit ] [-ArchiveMinimumSizeForExpansion ] + [-DataSizeMaximum ] [-DataSizeMinimum ] [-Description ] [-IdentityType ] + [-MimeFilter ] [-MimeFilterType ] [-Status ] [-Tag ] + [-TextMatchingDeny ] [-UserAssignedIdentity ] [-XmlFilterDefaultNamespace ] + [-XmlFilterReference ] [-XmlFilterSchema ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Applies partial update to an existing FlowProfile resource. + +## EXAMPLES + +### Example 1: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +### Example 2: {{ Add title here }} +```powershell +{{ Add code here }} +``` + +```output +{{ Add output here (remove the output block if the example doesn't have an output) }} +``` + +{{ Add description here }} + +## PARAMETERS + +### -AntivirusAvSolution +Optional. +The list of antiviruses to be used as a scanning solution for replicating data. + +```yaml +Type: System.String[] +Parameter Sets: UpdateExpanded, UpdateViaIdentityPipelineExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ArchiveMaximumCompressionRatioLimit +Optional. +Provides the multiplication value for an archive in total based on the initial object being validated. +This value takes the root object size and multiplies it by this value to create a maximum. +Once this maximum is exceeded, the archive is failed. +Used to detect and block archives with suspiciously high compression (e.g., zip bombs). + +```yaml +Type: System.Double +Parameter Sets: UpdateExpanded, UpdateViaIdentityPipelineExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ArchiveMaximumDepthLimit +Optional. +The maximum depth of nested archives that can be expanded. +Limits how many layers of embedded archives will be processed. +Archives exceeding the max limit will be denied for replication. + +```yaml +Type: System.Int64 +Parameter Sets: UpdateExpanded, UpdateViaIdentityPipelineExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ArchiveMaximumExpansionSizeLimit +Optional. +The combined maximum size (in bytes) of all extracted files that an expanded archive is allowed to reach. +Archives exceeding the max limit will be denied for replication. + +```yaml +Type: System.Int64 +Parameter Sets: UpdateExpanded, UpdateViaIdentityPipelineExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ArchiveMinimumSizeForExpansion +Optional. +Default is 0. +The minimum archive file size (in bytes) required to trigger expansion during replication. +Any archive file size below the configured threshold will skip the rest of the configured rulesets for archives. + +```yaml +Type: System.Int64 +Parameter Sets: UpdateExpanded, UpdateViaIdentityPipelineExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AsJob +Run the command as a job + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataSizeMaximum +Optional. +Specifies the maximum allowed size (in bytes) for files to be replicated. +Any file size greater than maximum will be denied replication. + +```yaml +Type: System.Int64 +Parameter Sets: UpdateExpanded, UpdateViaIdentityPipelineExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DataSizeMinimum +Optional. +Default is 0. +Specifies the minimum required size (in bytes) for a file to be eligible for replication. +Any file size less than minimum will be denied replication. + +```yaml +Type: System.Int64 +Parameter Sets: UpdateExpanded, UpdateViaIdentityPipelineExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. + +```yaml +Type: System.Management.Automation.PSObject +Parameter Sets: (All) +Aliases: AzureRMContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +A description of the FlowProfile that defines the replication scenario. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityPipelineExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IdentityType +Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityPipelineExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Identity Parameter + +```yaml +Type: ADT.Models.IDataTransferIdentity +Parameter Sets: UpdateViaIdentityExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -JsonFilePath +Path of Json file supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Update operation + +```yaml +Type: System.String +Parameter Sets: UpdateViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MimeFilter +Defines the Media types (f.k.a MIME types) and associated file extensions to be filtered. +For more detail, please refer to the MimeTypeFiler model. + +```yaml +Type: ADT.Models.IMimeTypeFilter[] +Parameter Sets: UpdateExpanded, UpdateViaIdentityPipelineExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MimeFilterType +Specifies whether the filter is an allow list or deny list. +For more detail, please refer to the FilterType model. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityPipelineExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the FlowProfile resource to operate on. +Must be 3 to 64 characters long and contain only alphanumeric characters or hyphens. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath, UpdateViaIdentityPipelineExpanded +Aliases: FlowProfileName + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PipelineInputObject +Identity Parameter + +```yaml +Type: ADT.Models.IDataTransferIdentity +Parameter Sets: UpdateViaIdentityPipelineExpanded +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -PipelineName +The name of the pipeline on which to operate. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceGroupName +The name of the resource group. +The name is case insensitive. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Status +The operational status of the FlowProfile. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityPipelineExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SubscriptionId +The ID of the target subscription. +The value must be an UUID. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath +Aliases: + +Required: False +Position: Named +Default value: (Get-AzContext).Subscription.Id +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Resource tags. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: UpdateExpanded, UpdateViaIdentityPipelineExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TextMatchingDeny +A list of text patterns to block, each with matching rules and case sensitivity options. + +```yaml +Type: ADT.Models.ITextMatch[] +Parameter Sets: UpdateExpanded, UpdateViaIdentityPipelineExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentity +The set of user assigned identities associated with the resource. +The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. +The dictionary values can be empty objects ({}) in requests. + +```yaml +Type: System.Collections.Hashtable +Parameter Sets: UpdateExpanded, UpdateViaIdentityPipelineExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -XmlFilterDefaultNamespace +The default XML namespace used for schema validation. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityPipelineExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -XmlFilterReference +Defines the method for referencing the xml schema. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityPipelineExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -XmlFilterSchema +The inline XSD schema to be used for validation. + +```yaml +Type: System.String +Parameter Sets: UpdateExpanded, UpdateViaIdentityPipelineExpanded, UpdateViaIdentityExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### ADT.Models.IDataTransferIdentity + +## OUTPUTS + +### ADT.Models.IFlowProfile + +## NOTES + +## RELATED LINKS