< Back
Set-AzureRmDataFactoryGateway
Post
NAME Set-AzureRmDataFactoryGateway
SYNOPSIS
Sets the description for a gateway in Azure Data Factory.
SYNTAX
Set-AzureRmDataFactoryGateway [-DataFactory] <PSDataFactory> [-Name] <String> [-Description] <String> [-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Set-AzureRmDataFactoryGateway [-ResourceGroupName] <String> [-DataFactoryName] <String> [-Name] <String> [-Description] <String> [-DefaultProfile
<IAzureContextContainer>] [<CommonParameters>]
DESCRIPTION
The Set-AzureRmDataFactoryGateway cmdlet sets the description for the specified gateway in Azure Data Factory.
PARAMETERS
-DataFactory <PSDataFactory>
Specifies a PSDataFactory object. This cmdlet sets the description for the gateway in the data factory that this parameter specifies.
Required? true
Position? 0
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.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Description <String>
Specifies a description for the gateway.
Required? true
Position? 3
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.
Required? true
Position? 2
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.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
System.Collections.Generic.List`1[[Microsoft.WindowsAzure.Commands.Utilities.PSDataFactoryGateway]],
Microsoft.WindowsAzure.Commands.Utilities.PSDataFactoryGateway
NOTES
* Keywords: azure, azurerm, arm, resource, management, manager, data, factories
Example 1: Set the description for a gateway
PS C:\\>Set-AzureRmDataFactoryGateway -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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... orygateway
Get-AzureRmDataFactoryGateway
New-AzureRmDataFactoryGateway
Remove-AzureRmDataFactoryGateway
SYNOPSIS
Sets the description for a gateway in Azure Data Factory.
SYNTAX
Set-AzureRmDataFactoryGateway [-DataFactory] <PSDataFactory> [-Name] <String> [-Description] <String> [-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Set-AzureRmDataFactoryGateway [-ResourceGroupName] <String> [-DataFactoryName] <String> [-Name] <String> [-Description] <String> [-DefaultProfile
<IAzureContextContainer>] [<CommonParameters>]
DESCRIPTION
The Set-AzureRmDataFactoryGateway cmdlet sets the description for the specified gateway in Azure Data Factory.
PARAMETERS
-DataFactory <PSDataFactory>
Specifies a PSDataFactory object. This cmdlet sets the description for the gateway in the data factory that this parameter specifies.
Required? true
Position? 0
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.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Description <String>
Specifies a description for the gateway.
Required? true
Position? 3
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.
Required? true
Position? 2
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.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
System.Collections.Generic.List`1[[Microsoft.WindowsAzure.Commands.Utilities.PSDataFactoryGateway]],
Microsoft.WindowsAzure.Commands.Utilities.PSDataFactoryGateway
NOTES
* Keywords: azure, azurerm, arm, resource, management, manager, data, factories
Example 1: Set the description for a gateway
PS C:\\>Set-AzureRmDataFactoryGateway -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.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... orygateway
Get-AzureRmDataFactoryGateway
New-AzureRmDataFactoryGateway
Remove-AzureRmDataFactoryGateway