Disable-AzDataTransferFlow

Module:

Az.DataTransfer Module

Disables the specified flow

Syntax

Disable (Default)

Disable-AzDataTransferFlow
    -ConnectionName <String>
    -Name <String>
    -ResourceGroupName <String>
    [-SubscriptionId <String>]
    [-DefaultProfile <PSObject>]
    [-AsJob]
    [-NoWait]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

DisableViaIdentityConnection

Disable-AzDataTransferFlow
    -Name <String>
    -ConnectionInputObject <IDataTransferIdentity>
    [-DefaultProfile <PSObject>]
    [-AsJob]
    [-NoWait]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

DisableViaIdentity

Disable-AzDataTransferFlow
    -InputObject <IDataTransferIdentity>
    [-DefaultProfile <PSObject>]
    [-AsJob]
    [-NoWait]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Disables the specified flow

Examples

Example 1: Disable a specific flow

Disable-AzDataTransferFlow -ResourceGroupName ResourceGroup01 -ConnectionName Connection01 -Name Flow01 -Confirm:$false

ApiFlowOptionApiMode                   :
ApiFlowOptionAudienceOverride          :
ApiFlowOptionCname                     :
ApiFlowOptionIdentityTranslation       :
ApiFlowOptionRemoteCallingModeClientId :
ApiFlowOptionRemoteEndpoint            :
ApiFlowOptionSenderClientId            :
ConnectionId                           :
ConnectionLocation                     :
ConnectionName                         :
ConnectionSubscriptionName             :
ConsumerGroup                          :
CustomerManagedKeyVaultUri             :
DataType                               : Blob
DestinationEndpoint                    :
DestinationEndpointPort                :
EventHubId                             :
FlowId                                 :
FlowType                               : Mission
ForceDisabledStatus                    :
Id                                     : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.AzureDataTransfer/connections/Connection01/flows/Flow01
IdentityPrincipalId                    :
IdentityTenantId                       :
IdentityType                           : None
IdentityUserAssignedIdentity           : {}
KeyVaultUri                            :
LinkStatus                             : Unlinked
LinkedFlowId                           :
Location                               : EastUS
MessagingOptionBillingTier             :
Name                                   : Flow01
Passphrase                             :
PlanName                               :
PlanProduct                            :
PlanPromotionCode                      :
PlanPublisher                          :
PlanVersion                            :
Policy                                 :
ProvisioningState                      : Succeeded
ResourceGroupName                      : ResourceGroup01
SchemaConnectionId                     :
SchemaContent                          :
SchemaDirection                        :
SchemaId                               :
SchemaName                             :
SchemaStatus                           :
SchemaType                             :
SchemaUri                              :
ServiceBusQueueId                      :
SourceAddressSourceAddresses           :
Status                                 : Disabled
StorageAccountId                       :
StorageAccountName                     : /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ResourceGroup01/providers/Microsoft.Storage/storageAccounts/storageAccount01
StorageContainerName                   : teststorage
StorageTableName                       :
StreamId                               :
StreamLatency                          :
StreamProtocol                         :
SystemDataCreatedAt                    : 6/11/2099 7:09:52 AM
SystemDataCreatedBy                    : test@test.com
SystemDataCreatedByType                : User
SystemDataLastModifiedAt               : 6/11/2099 7:09:52 AM
SystemDataLastModifiedBy               : test@test.com
SystemDataLastModifiedByType           : User
Tag                                    : {
                                           "Environment": "Production",
                                           "creationTime": "2099-06-11T07:14:45.0294500Z",
                                           "vteam": "Experience"
                                         }
Type                                   : microsoft.azuredatatransfer/connections/flows

This example disables a specific flow named Flow01 in the connection Connection01 within the resource group ResourceGroup01 without prompting for confirmation.

Parameters

-AsJob

Run the command as a job

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	cf

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ConnectionInputObject

Identity Parameter

Parameter properties

Type:	IDataTransferIdentity
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

DisableViaIdentityConnection

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ConnectionName

The name for the connection to perform the operation on.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

Disable

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Parameter properties

Type:	PSObject
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	AzureRMContext, AzureCredential

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-InputObject

Identity Parameter

Parameter properties

Type:	IDataTransferIdentity
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

DisableViaIdentity

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Name

The name for the flow to perform the operation on.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	FlowName

Parameter sets

Disable

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

DisableViaIdentityConnection

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-NoWait

Run the command asynchronously

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ResourceGroupName

The name of the resource group. The name is case insensitive.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

Disable

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-SubscriptionId

The ID of the target subscription. The value must be an UUID.

Parameter properties

Type:	String
Default value:	(Get-AzContext).Subscription.Id
Supports wildcards:	False
DontShow:	False

Parameter sets

Disable

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	wi

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

IDataTransferIdentity

Outputs

IFlow