Edit

Share via

Set-AzDataFactoryGateway

  • Reference
Module:
Az.DataFactory

Sets the description for a gateway in Azure Data Factory.

Syntax

Set-AzDataFactoryGateway
   [-DataFactoryName] <String>
   [-Name] <String>
   [-Description] <String>
   [-ResourceGroupName] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Set-AzDataFactoryGateway
   [-DataFactory] <PSDataFactory>
   [-Name] <String>
   [-Description] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

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

Examples

Example 1: Set the description for a gateway

Set-AzDataFactoryGateway -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      :

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

Parameters

-DataFactory

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

Type:PSDataFactory
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-DataFactoryName

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

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

Specifies a description for the gateway.

Type:String
Position:3
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Name

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

Type:String
Position:2
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ResourceGroupName

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.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Inputs

PSDataFactory

String

Outputs

PSDataFactoryGateway

Notes

  • Keywords: azure, azurerm, arm, resource, management, manager, data, factories