Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Set-AzureDataFactoryGateway

Set-AzureDataFactoryGateway

microsoft.azure.commands.datafactories.dll

Synopsis

Sets the description for a gateway in Data Factory.

Syntax

Set-AzureDataFactoryGateway [-ResourceGroupName] [-DataFactoryName] [-Name] [-Description] [<CommonParameters>]

Set-AzureDataFactoryGateway [-DataFactory] [-Name] [-Description] [<CommonParameters>]

Detailed Description

The Set-AzureDataFactoryGateway cmdlet sets the description for the specified gateway in Azure Data Factory.

You must be in AzureResourceManager mode to run Azure Data Factory cmdlets. To switch to AzureResourceManager mode, type Switch-AzureMode AzureResourceManager.

Parameters

-DataFactory <PSDataFactory>

Specifies a PSDataFactory object. This cmdlet sets the description for the gateway in the data factory that this parameter specifies.

Aliases

None

Required?

true

Position

1

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-DataFactoryName <String>

Specifies the name of a data factory. This cmdlet sets the description for the gateway in the data factory that this parameter specifies.

Aliases

None

Required?

true

Position

2

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-Description <String>

Specifies a description for the gateway.

Aliases

None

Required?

true

Position

4

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Name <String>

Specifies the name of the gateway for which to set a description.

Aliases

None

Required?

true

Position

3

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-ResourceGroupName <String>

Specifies the name of an Azure resource group. This cmdlet sets the description for a gateway that belongs to the group that this parameter specifies.

Aliases

None

Required?

true

Position

1

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

Input Type


Return Type

System.Collections.Generic.List`1[[Microsoft.WindowsAzure.Commands.Utilities.PSDataFactoryGateway]], Microsoft.WindowsAzure.Commands.Utilities.PSDataFactoryGateway

Notes

None

Examples

Example 1: Set the description for a gateway

This command sets the description for the gateway named ContosoGateway in the data factory named WikiADF. The Description parameter specifies the new description.

                    PS C:\> Set-AzureDataFactoryGateway -ResourceGroupName "ADF" -Name "ContosoGateway" -DataFactoryName "WikiADF" -Description "my gateway"
                    Name            : ContosoGateway
                    Description     : my gateway
                    Version         : 1.3.5338.1
                    Status          : Online
                    VersionStatus   : UpToDate
                    CreateTime      : 8/22/2014 1:31:09 AM
                    RegisterTime    : 8/22/2014 1:31:37 AM
                    LastConnectTime : 8/22/2014 1:41:41 AM
                    ExpiryTime      :

                

Get-AzureDataFactoryGateway
New-AzureDataFactoryGateway
Remove-AzureDataFactoryGateway