Microsoft.Azure.Commands.DataFactories.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems xmlns="http://msh" schema="maml"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AzureRmDataFactory</command:name> <maml:description> <maml:para>Gets information about Data Factory.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureDataFactory</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-AzureRmDataFactory cmdlet gets information about data factories in an Azure resource group. If you specify the name of a data factory, this cmdlet gets information about that data factory. If you do not specify a name, this cmdlet gets information about all of the data factories in an Azure resource group.</maml:para> <maml:para>You must be in AzureResourceManager mode to run Azure Data Factory cmdlets. To switch to AzureResourceManager mode, type Switch-AzureMode AzureResourceManager.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRmDataFactory</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure resource group. This cmdlet gets information about data factories that belong to the group that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the data factory about which to get information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the data factory about which to get information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure resource group. This cmdlet gets information about data factories that belong to the group that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[Microsoft.WindowsAzure.Commands.Utilities.PSDataFactory, Microsoft.WindowsAzure.Commands.Utilities, Version=0.8.2.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] Microsoft.WindowsAzure.Commands.Utilities.PSDataFactory </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Get all data factories</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\> Get-AzureRmDataFactory -ResourceGroupName "ADF" DataFactoryName : WikiADF ResourceGroupName : ADF Location : WestUS Tags : {} Properties : Microsoft.WindowsAzure.Commands.Utilities.PSDataFactoryConfiguration DataFactoryName : WikiADF2 ResourceGroupName : ADF Location : westus Tags : {} Properties : Microsoft.WindowsAzure.Commands.Utilities.PSDataFactoryConfiguration </dev:code> <dev:remarks> <maml:para>Displays information about all data factories in the Azure subscription. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Get a specific data factory</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\> $DataFactory = Get-AzureRmDataFactory -ResourceGroupName "ADF" -Name "WikiADF" DataFactoryName : WikiADF ResourceGroupName : ADF Location : westus Tags : {} Properties : Microsoft.WindowsAzure.Commands.Utilities.PSDataFactoryConfiguration </dev:code> <dev:remarks> <maml:para>This command displays information about the data factory named WikiADF in the subscription for the resource group named ADF, and then stores it in the $DataFactory variable. Specify the DataFactory parameter in subsequent cmdlets to use the data factory stored in $DataFactory.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-AzureRmDataFactory</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmDataFactory</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, data, factories</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AzureRmDataFactoryGateway</command:name> <maml:description> <maml:para>Gets information about logical gateways in Data Factory.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureDataFactoryGateway</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-AzureRmDataFactoryGateway cmdlet gets information about logical gateways in Azure Data Factory. If you specify the name of a gateway, this cmdlet gets information about that gateway. If you do not specify a name, this cmdlet gets information about all gateways for a data factory.</maml:para> <maml:para>If you want to add an on-premises MicrosoftSQL Server as a linked service to a data factory, you must install a gateway on your on-premises computer.</maml:para> <maml:para>You must be in AzureResourceManager mode to run Azure Data Factory cmdlets. To switch to AzureResourceManager mode, type Switch-AzureMode AzureResourceManager.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRmDataFactoryGateway</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure resource group. This cmdlet gets information about logical gateways that belong to the group that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>DataFactoryName</maml:name> <maml:description> <maml:para>Specifies the name of a data factory. This cmdlet gets information about logical gateways in the data factory that this parameter specifies. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the logical gateway about which to get information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureRmDataFactoryGateway</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>DataFactory</maml:name> <maml:description> <maml:para>Specifies a PSDataFactory object. This cmdlet gets information about logical gateways in the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataFactory</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the logical gateway about which to get information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>DataFactory</maml:name> <maml:description> <maml:para>Specifies a PSDataFactory object. This cmdlet gets information about logical gateways in the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataFactory</command:parameterValue> <dev:type> <maml:name>PSDataFactory</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>DataFactoryName</maml:name> <maml:description> <maml:para>Specifies the name of a data factory. This cmdlet gets information about logical gateways in the data factory that this parameter specifies. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the logical gateway about which to get information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure resource group. This cmdlet gets information about logical gateways that belong to the group that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[Microsoft.WindowsAzure.Commands.Utilities.PSDataFactoryGateway]], Microsoft.WindowsAzure.Commands.Utilities.PSDataFactoryGateway</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Get all logical gateways in a data factory</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\> Get-AzureRmDataFactoryGateway -ResourceGroupName "ADF" -DataFactoryName "WikiADF" Name : gateway1 Description : Version : 1.3.5338.1 Status : Online VersionStatus : UpToDate CreateTime : 8/22/2014 1:40:34 AM RegisterTime : 8/22/2014 1:41:46 AM LastConnectTime : 8/22/2014 1:44:56 AM ExpiryTime : Name : gateway2 Description : Version : 1.3.5338.1 Status : Offline VersionStatus : UpToDate CreateTime : 8/29/2014 1:46:44 AM RegisterTime : 8/29/2014 1:48:36 AM LastConnectTime : 8/29/2014 1:56:56 AM ExpiryTime : </dev:code> <dev:remarks> <maml:para>This command gets information about all logical gateways for the data factory named WikiADF in the resource group named ADF. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Get a specific logical gateway in a data factory</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\> Get-AzureRmDataFactoryGateway -ResourceGroupName "ADF" -Name "Gateway01" -DataFactoryName "WikiADF" Name : Gateway01 Description : Version : 1.3.5338.1 Status : Online VersionStatus : UpToDate CreateTime : 8/22/2014 1:40:34 AM RegisterTime : 8/22/2014 1:41:46 AM LastConnectTime : 8/22/2014 1:44:56 AM ExpiryTime : </dev:code> <dev:remarks> <maml:para>This command gets information about the logical gateway named Gateway01 in the data factory named WikiADF in the resource group named ADF.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-AzureRmDataFactoryGateway</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmDataFactoryGateway</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmDataFactoryGateway</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, data, factories</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AzureRmDataFactoryHub</command:name> <maml:description> <maml:para>Gets information about hubs in Data Factory.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureDataFactoryHub</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-AzureRmDataFactoryHub cmdlet gets information about hubs in Azure Data Factory. If you specify the name of a hub, this cmdlet gets information about that hub. If you do not specify a name, this cmdlet gets information about all of the hubs in a data factory.</maml:para> <maml:para>You must be in AzureResourceManager mode to run Azure Data Factory cmdlets. To switch to AzureResourceManager mode, type Switch-AzureMode AzureResourceManager.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRmDataFactoryHub</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure resource group. This cmdlet gets information about hubs that belong to the group that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>DataFactoryName</maml:name> <maml:description> <maml:para>Specifies the name of a data factory. This cmdlet gets information about hubs in the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the hub about which to get information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureRmDataFactoryHub</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>DataFactory</maml:name> <maml:description> <maml:para>Specifies a PSDataFactory object. This cmdlet gets information about hubs in the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataFactory</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the hub about which to get information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>DataFactory</maml:name> <maml:description> <maml:para>Specifies a PSDataFactory object. This cmdlet gets information about hubs in the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataFactory</command:parameterValue> <dev:type> <maml:name>PSDataFactory</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>DataFactoryName</maml:name> <maml:description> <maml:para>Specifies the name of a data factory. This cmdlet gets information about hubs in the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the hub about which to get information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure resource group. This cmdlet gets information about hubs that belong to the group that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Get all data hubs</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Get-AzureRmDataFactoryHub -ResourceGroupName "ADFResourceGroup" -DataFactoryName "ADFDataFactory" </dev:code> <dev:remarks> <maml:para>This command gets all data hubs in the Azure resource group named ADFResourceGroup and the data factory named ADFDataFactory.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Get a specific data hub</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Get-AzureRmDataFactoryHub -ResourceGroupName "ADFResourceGroup" -DataFactoryName "ADFDataFactory" -Name "MyDataHub" </dev:code> <dev:remarks> <maml:para>This command gets information about the hub named MyDataHub in the Azure resource group named ADFResourceGroup and the data factory named ADFDataFactory.</maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureRmDataFactoryHub</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmDataFactoryHub</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, data, factories</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AzureRmDataFactoryLinkedService</command:name> <maml:description> <maml:para>Gets information about linked services in Data Factory.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureDataFactoryLinkedService</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-AzureRmDataFactoryLinkedService cmdlet gets information about linked services in Azure Data Factory. If you specify the name of a linked service, this cmdlet gets information about that linked service. If you do not specify a name, this cmdlet gets information about all the linked services in the data factory.</maml:para> <maml:para>You must be in AzureResourceManager mode to run Azure Data Factory cmdlets. To switch to AzureResourceManager mode, type Switch-AzureMode AzureResourceManager.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRmDataFactoryLinkedService</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure resource group. This cmdlet gets linked services that belong to the group that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>DataFactoryName</maml:name> <maml:description> <maml:para>Specifies the name of a data factory. This cmdlet gets linked services that belong to the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the linked service about which to get information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureRmDataFactoryLinkedService</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>DataFactory</maml:name> <maml:description> <maml:para>Specifies a PSDataFactory object. This cmdlet gets linked services that belong to the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataFactory</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the linked service about which to get information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>DataFactory</maml:name> <maml:description> <maml:para>Specifies a PSDataFactory object. This cmdlet gets linked services that belong to the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataFactory</command:parameterValue> <dev:type> <maml:name>PSDataFactory</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>DataFactoryName</maml:name> <maml:description> <maml:para>Specifies the name of a data factory. This cmdlet gets linked services that belong to the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the linked service about which to get information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure resource group. This cmdlet gets linked services that belong to the group that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[Microsoft.WindowsAzure.Commands.Utilities.PSLinkedService, Microsoft.WindowsAzure.Commands.Utilities, Version=0.8.2.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] Microsoft.WindowsAzure.Commands.Utilities.PSLinkedService </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Get information about all linked services</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\> Get-AzureRmDataFactoryLinkedService -ResourceGroupName "ADF" -DataFactoryName "WikiADF" | Format-List </dev:code> <dev:code> PS C:\>$df = Get-AzureRmDataFactory -ResourceGroupName ADF -Name WikiADFGet-AzureRmDataFactoryLinkedService -DataFactory $df | format-list LinkedServiceName : HDILinkedService ResourceGroupName : ADF DataFactoryName : WikiADF Properties : Microsoft.DataFactories.HDInsightBYOCLinkedService LinkedServiceName : LinkedServiceCuratedWikiData ResourceGroupName : ADF DataFactoryName : WikiADF Properties : Microsoft.DataFactories.AzureStorageLinkedService LinkedServiceName : LinkedServiceHDIStorage ResourceGroupName : ADF DataFactoryName : WikiADF Properties : Microsoft.DataFactories.AzureStorageLinkedService LinkedServiceName : LinkedServiceWikiAggregatedData ResourceGroupName : ADF DataFactoryName : WikiADF Properties : Microsoft.DataFactories.AzureSqlLinkedService LinkedServiceName : LinkedServiceWikipediaClickEvents ResourceGroupName : ADF DataFactoryName : WikiADF Properties : Microsoft.DataFactories.AzureStorageLinkedService </dev:code> <dev:remarks> <maml:para>This command gets information about all linked services in the data factory named WikiADF, and then passes the linked services to the Format-List cmdlet by using the pipeline operator. That Windows PowerShell cmdlet formats the results. For more information, type Get-Help Format-List.</maml:para> <maml:para>You can use either one of the following ways: </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Get information about a specific linked service</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\> Get-AzureRmDataFactoryLinkedService -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "HDILinkedService" LinkedServiceName ResourceGroupName DataFactoryName Properties ----------------- ----------------- --------------- ---------- HDILinkedService ADF WikiADF Microsoft.DataFactories.HDInsightBYOCAsset </dev:code> <dev:remarks> <maml:para>This command gets information about the linked service named HDILinkedService in the data factory named WikiADF.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 3: Get information about a specific linked service by specifying the DataFactory parameter</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>$DataFactory = Get-AzureRmDataFactory -ResourceGroupName "ADF" -Name "ContosoFactory"PS C:\> Get-AzureRmDataFactoryLinkedService -DataFactory $DataFactory | Format-Table -Property LinkedServiceName, DataFactoryName, ResourceGroupName </dev:code> <dev:remarks> <maml:para>The first command uses the Get-AzureRmDataFactory cmdlet to get the data factory named ContosoFactory, and then stores it in the $DataFactory variable. </maml:para> <maml:para>The second command gets information about the linked service for the data factory stored in $DataFactory, and then passes that information to the Format-Table cmdlet by using the pipeline operator. The Format-Table cmdlet formats the output as a dataset with the specified properties as dataset columns.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-AzureRmDataFactoryLinkedService</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmDataFactoryLinkedService</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, data, factories</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AzureRmDataFactoryPipeline</command:name> <maml:description> <maml:para>Gets information about pipelines in Data Factory.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureDataFactoryPipeline</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-AzureRmDataFactoryPipeline cmdlet gets information about pipelines in Azure Data Factory. If you specify the name of a pipeline, this cmdlet gets information about that pipeline. If you do not specify a name, this cmdlet gets information about all the pipelines in the data factory.</maml:para> <maml:para>You must be in AzureResourceManager mode to run Azure Data Factory cmdlets. To switch to AzureResourceManager mode, type Switch-AzureMode AzureResourceManager.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRmDataFactoryPipeline</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure resource group. This cmdlet gets pipelines that belong to the group that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the pipeline about which to get information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>DataFactoryName</maml:name> <maml:description> <maml:para>Specifies the name of a data factory. This cmdlet gets pipelines that belong to the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureRmDataFactoryPipeline</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>DataFactory</maml:name> <maml:description> <maml:para>Specifies a PSDataFactory object. This cmdlet gets pipelines that belong to the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataFactory</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the pipeline about which to get information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>DataFactory</maml:name> <maml:description> <maml:para>Specifies a PSDataFactory object. This cmdlet gets pipelines that belong to the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataFactory</command:parameterValue> <dev:type> <maml:name>PSDataFactory</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>DataFactoryName</maml:name> <maml:description> <maml:para>Specifies the name of a data factory. This cmdlet gets pipelines that belong to the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the pipeline about which to get information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure resource group. This cmdlet gets pipelines that belong to the group that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[Microsoft.WindowsAzure.Commands.Utilities.PSPipeline, Microsoft.WindowsAzure.Commands.Utilities, Version=0.8.2.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] Microsoft.WindowsAzure.Commands.Utilities.PSPipeline </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Get information about all pipelines</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\> Get-AzureRmDataFactoryPipeline -ResourceGroupName "ADF" -DataFactoryName "WikiADF" </dev:code> <dev:code> PS C:\>$df = Get-AzureRmDataFactory -ResourceGroupName ADF -Name WikiADFGet-AzureRmDataFactoryPipeline -DataFactory $df PipelineName ResourceGroupName DataFactoryName Properties ------------ ----------------- --------------- ---------- DPWikisample ADF WikiADF Microsoft.DataFactories.PipelineProperties DPTwittersample ADF WikiADF Microsoft.DataFactories.PipelineProperties </dev:code> <dev:remarks> <maml:para>This command gets information about all pipelines in the data factory named WikiADF. You can either one of the following example commands. The second one uses a DataFactory object as a parameter.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Get information about a specific pipeline</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\> Get-AzureRmDataFactoryPipeline -ResourceGroupName "ADF" -Name "DPWikisample" -DataFactoryName "WikiADF" | Format-List PipelineName : DPWikisample ResourceGroupName : ADF DataFactoryName : WikiADF Properties : Microsoft.DataFactories.PipelineProperties </dev:code> <dev:remarks> <maml:para>This command gets information about the pipeline named DPWikisample in the data factory named WikiADF. The command passes that information to the Format-List cmdlet by using the pipeline operator. That Windows PowerShell cmdlet formats the results. For more information, type Get-Help Format-List.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 3: Get the properties for a specific pipeline</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\> (Get-AzureRmDataFactoryPipeline -ResourceGroupName "ADF" -Name DPWikisample -DataFactoryName "WikiADF").Properties Activities : {WikiHiveActivity, BlobToSqlCopyActivity} Description : DP Wikipedia Sample Pipelines End : 6/6/2014 8:00:00 AM IsPaused : RuntimeInfo : Microsoft.DataFactories.PipelineRuntimeInfo Start : 6/5/2014 8:00:00 PM </dev:code> <dev:remarks> <maml:para>This command gets information for the pipeline named DPWikisample in the data factory named WikiADF, and then uses standard dot notation to view the Properties property associated with that pipeline.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 4: Get the activities for a specific pipeline</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\> (Get-AzureRmDataFactoryPipeline -ResourceGroupName "ADF" -Name "DPWikisample" -DataFactoryName "WikiADF").Properties.Activities Transformation : Microsoft.DataFactories.HDInsightActivityProperties Description : Inputs : {DAWikipediaClickEvents} LinkedServiceName : HDILinkedService Name : WikiHiveActivity Outputs : {DACuratedWikiData} Policy : Microsoft.DataFactories.ActivityPolicy Transformation : Microsoft.DataFactories.CopyActivityProperties Description : Inputs : {DACuratedWikiData} LinkedServiceName : HDILinkedService Name : BlobToSqlCopyActivity Outputs : {DAWikiAggregatedData} Policy : Microsoft.DataFactories.ActivityPolicy </dev:code> <dev:remarks> <maml:para>This command gets information for the pipeline named DPWikisample in the data factory named WikiADF, and then uses standard dot notation to view the Activities property associated with that pipeline.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 5: Get the runtime information for a specific pipeline</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\> (Get-AzureRmDataFactoryPipeline -ResourceGroupName "ADF" -Name "DPWikisample" -DataFactoryName "WikiADF").Properties.RuntimeInfo DeploymentTime -------------- 6/5/2014 10:36:46 PM </dev:code> <dev:remarks> <maml:para>This command gets information for the pipeline named DPWikisample in the data factory named WikiADF, and then uses standard dot notation to view the RuntimeInfo property associated with that pipeline. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 6: Get information about inputs for the first activity</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\> (Get-AzureRmDataFactoryPipeline -ResourceGroupName "ADF" -Name "DPWikisample" -DataFactoryName "WikiADF11").Properties.Activities[0].Inputs | Format-List EndTime : Length : Name : DAWikipediaClickEvents StartTime : </dev:code> <dev:remarks> <maml:para>This command gets information for the pipeline named DPWikisample in the data factory named WikiADF, and then uses standard dot notation to view the Activities property associated with that pipeline. The command displays the Inputs property of the first element of the Activities array by using the Format-List cmdlet.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-AzureRmDataFactoryPipeline</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmDataFactoryPipeline</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Resume-AzureRmDataFactoryPipeline</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmDataFactoryPipelineActivePeriod</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Suspend-AzureRmDataFactoryPipeline</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, data, factories</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AzureRmDataFactoryRun</command:name> <maml:description> <maml:para>Gets runs for a data slice of a dataset in Data Factory.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureDataFactoryRun</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-AzureRmDataFactoryRun cmdlet gets the runs for a data slice of a dataset in Azure Data Factory. A dataset in a data factory is composed of slices over the time axis. The width of a slice is determined by the schedule, either hourly or daily. A run is a unit of processing for a slice. There could be one or more runs for a slice in case of retries or in case you rerun your slice due to failures. A slice is identified by its start time. To obtain the start time of a slice, use the Get-AzureRmDataFactorySlice cmdlet. </maml:para> <maml:para> For example, to get a run for the following slice, use the start time 2015-04-02T20:00:00. ResourceGroupName : ADF DataFactoryName : SPDataFactory0924 DatasetName : MarketingCampaignEffectivenessBlobDataset Start : 5/2/2014 8:00:00 PM End : 5/3/2014 8:00:00 PM RetryCount : 0 Status : Ready LatencyStatus : </maml:para> <maml:para>You must be in AzureResourceManager mode to run Azure Data Factory cmdlets. To switch to AzureResourceManager mode, type Switch-AzureMode AzureResourceManager.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRmDataFactoryRun</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure resource group. This cmdlet gets runs for slices that belong to the group that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>DataFactoryName</maml:name> <maml:description> <maml:para>Specifies the name of a data factory. This cmdlet gets runs for slices that belong to the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases=""> <maml:name>DatasetName</maml:name> <maml:description> <maml:para>Specifies the name of the dataset. This cmdlet gets runs for slices that belong to the dataset that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases=""> <maml:name>StartDateTime</maml:name> <maml:description> <maml:para>Specifies the start of a time period as a DateTime object. This cmdlet gets runs for the data slices that match this time period. </maml:para> <maml:para>StartDateTime must be specified in the ISO8601 format. Examples: 2015-01-01Z, 2015-01-01T00:00:00Z, 2015-01-01T00:00:00.000Z (UTC), 2015-01-01T00:00:00-08:00 (Pacific Standard Time)</maml:para> <maml:para>The default time zone designator is UTC. If the time zone designator is omitted (ex: 2014-10-01), it is considered as an UTC time 2014-10-01T00:00:00Z.</maml:para> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureRmDataFactoryRun</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>DataFactory</maml:name> <maml:description> <maml:para>Specifies a PSDataFactory object. This cmdlet gets runs for slices that belong to the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataFactory</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases=""> <maml:name>DatasetName</maml:name> <maml:description> <maml:para>Specifies the name of the dataset. This cmdlet gets runs for slices that belong to the dataset that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases=""> <maml:name>StartDateTime</maml:name> <maml:description> <maml:para>Specifies the start of a time period as a DateTime object. This cmdlet gets runs for the data slices that match this time period. </maml:para> <maml:para>StartDateTime must be specified in the ISO8601 format. Examples: 2015-01-01Z, 2015-01-01T00:00:00Z, 2015-01-01T00:00:00.000Z (UTC), 2015-01-01T00:00:00-08:00 (Pacific Standard Time)</maml:para> <maml:para>The default time zone designator is UTC. If the time zone designator is omitted (ex: 2014-10-01), it is considered as an UTC time 2014-10-01T00:00:00Z.</maml:para> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>DataFactory</maml:name> <maml:description> <maml:para>Specifies a PSDataFactory object. This cmdlet gets runs for slices that belong to the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataFactory</command:parameterValue> <dev:type> <maml:name>PSDataFactory</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>DataFactoryName</maml:name> <maml:description> <maml:para>Specifies the name of a data factory. This cmdlet gets runs for slices that belong to the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure resource group. This cmdlet gets runs for slices that belong to the group that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases=""> <maml:name>StartDateTime</maml:name> <maml:description> <maml:para>Specifies the start of a time period as a DateTime object. This cmdlet gets runs for the data slices that match this time period. </maml:para> <maml:para>StartDateTime must be specified in the ISO8601 format. Examples: 2015-01-01Z, 2015-01-01T00:00:00Z, 2015-01-01T00:00:00.000Z (UTC), 2015-01-01T00:00:00-08:00 (Pacific Standard Time)</maml:para> <maml:para>The default time zone designator is UTC. If the time zone designator is omitted (ex: 2014-10-01), it is considered as an UTC time 2014-10-01T00:00:00Z.</maml:para> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases=""> <maml:name>DatasetName</maml:name> <maml:description> <maml:para>Specifies the name of the dataset. This cmdlet gets runs for slices that belong to the dataset that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[Microsoft.WindowsAzure.Commands.Utilities.PSDataSliceRun, Microsoft.WindowsAzure.Commands.Utilities, Version=0.8.2.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Get a dataset</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\> Get-AzureRmDataFactoryRun -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -DatasetName "DAWikiAggregatedData" -StartDateTime 2014-05-21T16:00:00Z Id : a7c4913c-9623-49b3-ae1e-3e45e2b68819 ResourceGroupName : ADF DataFactoryName : WikiADF DatasetName : DAWikiAggregatedData PipelineName : 249ea141-ca00-8597-fad9-a148e5e7bdba ActivityId : fcefe2bd-39b1-2d7a-7b35-bcc2b0432300 ResumptionToken : a7c4913c-9623-49b3-ae1e-3e45e2b68819 ContinuationToken : ProcessingStartTime : 5/21/2014 5:02:41 PM ProcessingEndTime : 5/21/2014 5:04:12 PM PercentComplete : 100 DataSliceStart : 5/21/2014 4:00:00 PM DataSliceEnd : 5/21/2014 5:00:00 PM Status : Succeeded Timestamp : 5/21/2014 5:02:41 PM RetryAttempt : 0 Properties : {[errors, ]} ErrorMessage : </dev:code> <dev:remarks> <maml:para>This command gets all runs for slices of the dataset named DAWikiAggregatedData in the data factory named WikiADF that start from 4 PM GMT on 05/21/2014.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmDataFactorySlice</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, data, factories</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AzureRmDataFactorySlice</command:name> <maml:description> <maml:para>Gets data slices for a dataset in Data Factory.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureDataFactorySlice</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-AzureRmDataFactorySlice cmdlet gets data slices for a dataset in Azure Data Factory. Specify a start time and an end time to define a range of data slices to view. </maml:para> <maml:para> The status of a data slice is one of the following values: -- PendingExecution. Data processing has not started. -- InProgress. Data processing is in progress. -- Ready. Data processing is completed. The data slice is ready for dependent slices to consume it. -- Failed. The run that produces the slice failed. -- Skip. Data Factory skips processing of the slice. -- Retry. Data Factory retries the run that produces the slice. -- Timed Out. Data processing has timed out. -- PendingValidation. Data slice is waiting for validation before it is processed. -- Retry Validation. Data Factory retries the validation of the slice. -- Failed Validation. Validation of the slice failed. </maml:para> <maml:para>For each of the slices, you can see more information about the run that produces the slice by using the Get-AzureRmDataFactoryRun cmdlet. </maml:para> <maml:para>You must be in AzureResourceManager mode to run Azure Data Factory cmdlets. To switch to AzureResourceManager mode, type Switch-AzureMode AzureResourceManager.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRmDataFactorySlice</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure resource group. This cmdlet gets slices that belong to the group that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>DataFactoryName</maml:name> <maml:description> <maml:para>Specifies the name of a data factory. This cmdlet gets slices that belong to the data factory that this parameter specifies. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases=""> <maml:name>DatasetName</maml:name> <maml:description> <maml:para> Specifies the name of the dataset for which this cmdlet gets slices. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases=""> <maml:name>StartDateTime</maml:name> <maml:description> <maml:para>Specifies the start of a time period as a DateTime object. This cmdlet gets slices produced after the time that this parameter specifies.</maml:para> <maml:para>StartDateTime must be specified in the ISO8601 format. Examples: 2015-01-01Z, 2015-01-01T00:00:00Z, 2015-01-01T00:00:00.000Z (UTC), 2015-01-01T00:00:00-08:00 (Pacific Standard Time)</maml:para> <maml:para>The default time zone designator is UTC. If the time zone designator is omitted (ex: 2014-10-01), it is considered as an UTC time 2014-10-01T00:00:00Z.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5" aliases=""> <maml:name>EndDateTime</maml:name> <maml:description> <maml:para>Specifies the end of a time period as a DateTime object. This cmdlet gets slices produced before the time that this parameter specifies. For more information about DateTime objects, type Get-Help Get-Date.</maml:para> <maml:para>EndDateTime must be specified in the ISO8601 format. Examples: 2015-01-01Z, 2015-01-01T00:00:00Z, 2015-01-01T00:00:00.000Z (UTC), 2015-01-01T00:00:00-08:00 (Pacific Standard Time)</maml:para> <maml:para>The default time zone designator is UTC. If the time zone designator is omitted (ex: 2014-10-01), it is considered as an UTC time 2014-10-01T00:00:00Z.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureRmDataFactorySlice</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>DataFactory</maml:name> <maml:description> <maml:para>Specifies a PSDataFactory object. This cmdlet gets slices that belong to the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataFactory</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases=""> <maml:name>DatasetName</maml:name> <maml:description> <maml:para> Specifies the name of the dataset for which this cmdlet gets slices. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases=""> <maml:name>StartDateTime</maml:name> <maml:description> <maml:para>Specifies the start of a time period as a DateTime object. This cmdlet gets slices produced after the time that this parameter specifies.</maml:para> <maml:para>StartDateTime must be specified in the ISO8601 format. Examples: 2015-01-01Z, 2015-01-01T00:00:00Z, 2015-01-01T00:00:00.000Z (UTC), 2015-01-01T00:00:00-08:00 (Pacific Standard Time)</maml:para> <maml:para>The default time zone designator is UTC. If the time zone designator is omitted (ex: 2014-10-01), it is considered as an UTC time 2014-10-01T00:00:00Z.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5" aliases=""> <maml:name>EndDateTime</maml:name> <maml:description> <maml:para>Specifies the end of a time period as a DateTime object. This cmdlet gets slices produced before the time that this parameter specifies. For more information about DateTime objects, type Get-Help Get-Date.</maml:para> <maml:para>EndDateTime must be specified in the ISO8601 format. Examples: 2015-01-01Z, 2015-01-01T00:00:00Z, 2015-01-01T00:00:00.000Z (UTC), 2015-01-01T00:00:00-08:00 (Pacific Standard Time)</maml:para> <maml:para>The default time zone designator is UTC. If the time zone designator is omitted (ex: 2014-10-01), it is considered as an UTC time 2014-10-01T00:00:00Z.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>DataFactory</maml:name> <maml:description> <maml:para>Specifies a PSDataFactory object. This cmdlet gets slices that belong to the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataFactory</command:parameterValue> <dev:type> <maml:name>PSDataFactory</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>DataFactoryName</maml:name> <maml:description> <maml:para>Specifies the name of a data factory. This cmdlet gets slices that belong to the data factory that this parameter specifies. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5" aliases=""> <maml:name>EndDateTime</maml:name> <maml:description> <maml:para>Specifies the end of a time period as a DateTime object. This cmdlet gets slices produced before the time that this parameter specifies. For more information about DateTime objects, type Get-Help Get-Date.</maml:para> <maml:para>EndDateTime must be specified in the ISO8601 format. Examples: 2015-01-01Z, 2015-01-01T00:00:00Z, 2015-01-01T00:00:00.000Z (UTC), 2015-01-01T00:00:00-08:00 (Pacific Standard Time)</maml:para> <maml:para>The default time zone designator is UTC. If the time zone designator is omitted (ex: 2014-10-01), it is considered as an UTC time 2014-10-01T00:00:00Z.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure resource group. This cmdlet gets slices that belong to the group that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases=""> <maml:name>StartDateTime</maml:name> <maml:description> <maml:para>Specifies the start of a time period as a DateTime object. This cmdlet gets slices produced after the time that this parameter specifies.</maml:para> <maml:para>StartDateTime must be specified in the ISO8601 format. Examples: 2015-01-01Z, 2015-01-01T00:00:00Z, 2015-01-01T00:00:00.000Z (UTC), 2015-01-01T00:00:00-08:00 (Pacific Standard Time)</maml:para> <maml:para>The default time zone designator is UTC. If the time zone designator is omitted (ex: 2014-10-01), it is considered as an UTC time 2014-10-01T00:00:00Z.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases=""> <maml:name>DatasetName</maml:name> <maml:description> <maml:para> Specifies the name of the dataset for which this cmdlet gets slices. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[Microsoft.WindowsAzure.Commands.Utilities.PSDataSlice, Microsoft.WindowsAzure.Commands.Utilities, Version=0.8.2.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Get data slices for a dataset</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\> Get-AzureRmDataFactorySlice -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -DatasetName "DAWikiAggregatedData" -StartDateTime 2014-05-20T10:00:00Z ResourceGroupName : ADF DataFactoryName : WikiADF DatasetName : DAWikiAggregatedData Start : 5/21/2014 1:00:00 AM End : 5/21/2014 2:00:00 AM RetryCount : 0 Status : Ready ResourceGroupName : ADF DataFactoryName : WikiADF DatasetName : DAWikiAggregatedData Start : 5/21/2014 2:00:00 AM End : 5/21/2014 3:00:00 AM RetryCount : 0 Status : Ready . . . ResourceGroupName : ADF DataFactoryName : WikiADF DatasetName : DAWikiAggregatedData Start : 5/21/2014 8:00:00 PM End : 5/21/2014 9:00:00 PM RetryCount : 0 Status : PendingExecution ResourceGroupName : ADF DataFactoryName : WikiADF DatasetName : DAWikiAggregatedData Start : 5/21/2014 9:00:00 PM End : 5/21/2014 10:00:00 PM RetryCount : 0 Status : PendingExecution . . . </dev:code> <dev:remarks> <maml:para> This command gets all the data slices for the dataset named WikiAggregatedData in the data factory named WikiADF. The command gets slices produced after the time that the StartDateTime parameter specifies. The following example code sets the availability for this dataset every hour in the JavaScript Object Notation (JSON) file. availability: { period: "Hour", periodMultiplier: 1 } </maml:para> <maml:para>Some of the results are Ready and others are PendingExecution. Ready slices have already run. The pending slices are waiting to run at the end of each hour in the interval that the Set-AzureRmDataFactoryPipelineActivePeriod cmdlet specifies. In this example, both start and end periods for the pipeline and the slice have a value of one day (24 hours). </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Set-AzureRmDataFactorySliceStatus</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureRmDataFactoryRun</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmDataFactoryPipelineActivePeriod</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, data, factories</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-AzureRmDataFactoryDataset</command:name> <maml:description> <maml:para>Gets information about datasets in Data Factory.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureDataFactoryDataset</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-AzureRmDataFactoryDataset cmdlet gets information about datasets in Azure Data Factory. If you specify the name of a dataset, this cmdlet gets information about that dataset. If you do not specify a name, this cmdlet gets information about all the datasets in the data factory.</maml:para> <maml:para>You must be in AzureResourceManager mode to run Azure Data Factory cmdlets. To switch to AzureResourceManager mode, type Switch-AzureMode AzureResourceManager.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRmDataFactoryDataset</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure resource group. This cmdlet gets datasets that belong to the group that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>DataFactoryName</maml:name> <maml:description> <maml:para>Specifies the name of a data factory. This cmdlet gets datasets that belong to the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the dataset about which to get information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureRmDataFactoryDataset</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>DataFactory</maml:name> <maml:description> <maml:para>Specifies a PSDataFactory object. This cmdlet gets datasets that belong to the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataFactory</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the dataset about which to get information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>DataFactory</maml:name> <maml:description> <maml:para>Specifies a PSDataFactory object. This cmdlet gets datasets that belong to the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataFactory</command:parameterValue> <dev:type> <maml:name>PSDataFactory</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>DataFactoryName</maml:name> <maml:description> <maml:para>Specifies the name of a data factory. This cmdlet gets datasets that belong to the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the dataset about which to get information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure resource group. This cmdlet gets datasets that belong to the group that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[Microsoft.WindowsAzure.Commands.Utilities.PSDataset, Microsoft.WindowsAzure.Commands.Utilities, Version=0.8.2.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35]] Microsoft.WindowsAzure.Commands.Utilities.PSDataset </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Get information about all datasets</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\> Get-AzureRmDataFactoryDataset -ResourceGroupName "ADF" -DataFactoryName "WikiADF" DatasetName : DACuratedWikiData ResourceGroupName : ADF DataFactoryName : WikiADF Availability : Microsoft.DataFactories.Availability Location : Policy : Structure : {} DatasetName : DAWikipediaClickEvents ResourceGroupName : ADF DataFactoryName : WikiADF Availability : Microsoft.DataFactories.Availability Location : Policy : Structure : {} DatasetName : DAWikiAggregatedData ResourceGroupName : ADF DataFactoryName : WikiADF Availability : Microsoft.DataFactories.Availability Location : Policy : Structure : {} </dev:code> <dev:remarks> <maml:para>This command gets information about all datasets in the data factory named WikiADF. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Get information about a specific dataset</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\> Get-AzureRmDataFactoryDataset -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "DAWikipediaClickEvents" DatasetName : DAWikipediaClickEvents ResourceGroupName : ADF DataFactoryName : WikiADF Availability : Microsoft.DataFactories.Availability Location : Microsoft.DataFactories.AzureBlobLocation Policy : Microsoft.DataFactories.Policy Structure : {} </dev:code> <dev:remarks> <maml:para>This command gets information about the dataset named DAWikipediaClickEvents in the data factory named WikiADF.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 3: Get the location for a specific dataset</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\> (Get-AzureRmDataFactoryDataset -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "DAWikipediaClickEvents").Location BlobPath : wikidatagateway/wikisampledatain/ FilenamePrefix : Format : LinkedServiceName : LinkedServiceWikipediaClickEvents PartitionBy : {} </dev:code> <dev:remarks> <maml:para>This command gets information for the dataset named DAWikipediaClickEvents in the data factory named WikiADF, and then uses standard dot notation to view the Location associated with that dataset. Alternatively, assign the output of the Get-AzureRmDataFactoryDataset cmdlet to a variable, and then use dot notation to view the Location property associated with the dataset object stored in that variable. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-AzureRmDataFactoryDataset</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmDataFactoryDataset</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, data, factories</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-AzureRmDataFactory</command:name> <maml:description> <maml:para>Creates a data factory.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureDataFactory</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The New-AzureRmDataFactory cmdlet creates a data factory with the specified resource group name and location. </maml:para> <maml:para> Perform these operations in the following order: -- Create a data factory. -- Create linked services. -- Create datasets. -- Create a pipeline. </maml:para> <maml:para>You must be in AzureResourceManager mode to run Azure Data Factory cmdlets. To switch to AzureResourceManager mode, type Switch-AzureMode AzureResourceManager.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureRmDataFactory</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para> Specifies the name of an Azure resource group. This cmdlet creates a data factory that belongs to the group that this parameter specifies. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the data factory to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases=""> <maml:name>Location</maml:name> <maml:description> <maml:para>Specifies the location for the data factory, such as WestUS or EastUS. Only WestUS is currently supported.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="4" aliases=""> <maml:name>Tags</maml:name> <maml:description> <maml:para> Specifies tags for the data factory. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that this cmdlet replaces an existing data factory without prompting you for confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that this cmdlet replaces an existing data factory without prompting you for confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases=""> <maml:name>Location</maml:name> <maml:description> <maml:para>Specifies the location for the data factory, such as WestUS or EastUS. Only WestUS is currently supported.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the data factory to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para> Specifies the name of an Azure resource group. This cmdlet creates a data factory that belongs to the group that this parameter specifies. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="4" aliases=""> <maml:name>Tags</maml:name> <maml:description> <maml:para> Specifies tags for the data factory. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.WindowsAzure.Commands.Utilities.PSDataFactory </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Create a data factory</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\> New-AzureRmDataFactory -ResourceGroupName "ADF" -Name "WikiADF" -Location "WestUS" DataFactoryName : WikiADF ResourceGroupName : ADF Location : WestUS Tags : {} Properties : Microsoft.WindowsAzure.Commands.Utilities.PSDataFactoryConfiguration </dev:code> <dev:remarks> <maml:para>This command creates a data factory named WikiADF in the resource group named ADF in the WestUS location.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmDataFactory</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmDataFactory</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, data, factories</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-AzureRmDataFactoryEncryptValue</command:name> <maml:description> <maml:para>Encrypts sensitive data.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureDataFactoryEncryptValue</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The New-AzureRmDataFactoryEncryptValue cmdlet encrypts sensitive data, such as a password or a MicrosoftSQL Server connection string, and returns an encrypted value.</maml:para> <maml:para>You must be in AzureResourceManager mode to run Azure Data Factory cmdlets. To switch to AzureResourceManager mode, type Switch-AzureMode AzureResourceManager.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureRmDataFactoryEncryptValue</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure resource group. This cmdlet encrypts data for the group that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>DataFactoryName</maml:name> <maml:description> <maml:para>Specifies the name of a data factory. This cmdlet encrypts data for the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases=""> <maml:name>Value</maml:name> <maml:description> <maml:para>Specifies the value to encrypt. For an on-premises SQL Server linked service and an on-premises Oracle linked service, use a connection string. For an on-premises ODBC linked service, use the credential part of the connection string. For on premises file system linked service, if the file system is local to the gateway machine, use Local or localhost, and if the file system is on a server different from the gateway machine, use \\servername.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases=""> <maml:name>GatewayName</maml:name> <maml:description> <maml:para>Specifies the name of the gateway. This cmdlet encrypts data for the gateway that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5" aliases=""> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specifies the Windows authentication credentials (user name and password) to be used. This cmdlet encrypts the credential data you specify here.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5" aliases=""> <maml:name>Type</maml:name> <maml:description> <maml:para>Specifies the linked service type. This cmdlet encrypts data for the linked service type that this parameter specifies. Allowed values: OnPremisesSqlLinkedService, OnPremisesFileSystemLinkedService, OnPremisesOracleLinkedService, OnPremisesOdbcLinkedService, "OnPremisesPostgreSqlLinkedService", "OnPremisesTeradataLinkedService", "OnPremisesMySQLLinkedService", "OnPremisesDB2LinkedService", and "OnPremisesSybaseLinkedService".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="7" aliases=""> <maml:name>NonCredentialValue</maml:name> <maml:description> <maml:para>Specifies the non-credential part of the ODBC connection string. This parameter is applicable only for the ODBC linked service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="8" aliases=""> <maml:name>AuthenticationType</maml:name> <maml:description> <maml:para>Specifies the type of authentication to be used to connect to the data source. Allowed values: Windows, Basic, or Anonymous.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="9" aliases=""> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the server name of the linked service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="10" aliases=""> <maml:name>Database</maml:name> <maml:description> <maml:para>Specifies the database name of the linked service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AzureRmDataFactoryEncryptValue</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>DataFactory</maml:name> <maml:description> <maml:para>Specifies a PSDataFactory object. This cmdlet encrypts data for the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataFactory</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""> <maml:name>Value</maml:name> <maml:description> <maml:para>Specifies the value to encrypt. For an on-premises SQL linked service and an on-premises Oracle linked service, use a connection string. For an on-premises ODBC linked service, use the credential part of the connection string. For on premises file system linked service, if the file system is local to the gateway machine, use Local or localhost, and if the file system is on a server different from the gateway machine, use \\servername.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases=""> <maml:name>GatewayName</maml:name> <maml:description> <maml:para>Specifies the name of the gateway. This cmdlet encrypts data for the gateway that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases=""> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specifies the Windows authentication credentials (user name and password) to be used. This cmdlet encrypts the credential data you specify here.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="6" aliases=""> <maml:name>Type</maml:name> <maml:description> <maml:para>Specifies the linked service type. This cmdlet encrypts data for the linked service type that this parameter specifies. Allowed values: OnPremisesSqlLinkedService, OnPremisesFileSystemLinkedService, OnPremisesOracleLinkedService, OnPremisesOdbcLinkedService, "OnPremisesPostgreSqlLinkedService", "OnPremisesTeradataLinkedService", "OnPremisesMySQLLinkedService", "OnPremisesDB2LinkedService", and "OnPremisesSybaseLinkedService".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="7" aliases=""> <maml:name>NonCredentialValue</maml:name> <maml:description> <maml:para>Specifies the non-credential part of the ODBC connection string. This parameter is applicable only for the ODBC linked service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="8" aliases=""> <maml:name>AuthenticationType</maml:name> <maml:description> <maml:para>Specifies the type of authentication to be used to connect to the data source. Allowed values: Windows, Basic, or Anonymous.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="9" aliases=""> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the server name of the linked service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="10" aliases=""> <maml:name>Database</maml:name> <maml:description> <maml:para>Specifies the database name of the linked service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>DataFactory</maml:name> <maml:description> <maml:para>Specifies a PSDataFactory object. This cmdlet encrypts data for the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataFactory</command:parameterValue> <dev:type> <maml:name>PSDataFactory</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>DataFactoryName</maml:name> <maml:description> <maml:para>Specifies the name of a data factory. This cmdlet encrypts data for the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases=""> <maml:name>GatewayName</maml:name> <maml:description> <maml:para>Specifies the name of the gateway. This cmdlet encrypts data for the gateway that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure resource group. This cmdlet encrypts data for the group that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases=""> <maml:name>Value</maml:name> <maml:description> <maml:para>Specifies the value to encrypt. For an on-premises SQL Server linked service and an on-premises Oracle linked service, use a connection string. For an on-premises ODBC linked service, use the credential part of the connection string. For an on-premises file system linked service, if the file system is local to the gateway machine, use Local or localhost, and if the file system is on a server different from the gateway machine, use \\servername.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5" aliases=""> <maml:name>Credential</maml:name> <maml:description> <maml:para>Specifies the Windows authentication credentials (user name and password) to be used. This cmdlet encrypts the credential data you specify here.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="6" aliases=""> <maml:name>Type</maml:name> <maml:description> <maml:para>Specifies the linked service type. This cmdlet encrypts data for the linked service type that this parameter specifies. Allowed values: OnPremisesSqlLinkedService, OnPremisesFileSystemLinkedService, OnPremisesOracleLinkedService, OnPremisesOdbcLinkedService, "OnPremisesPostgreSqlLinkedService", "OnPremisesTeradataLinkedService", "OnPremisesMySQLLinkedService", "OnPremisesDB2LinkedService", and "OnPremisesSybaseLinkedService".</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="7" aliases=""> <maml:name>NonCredentialValue</maml:name> <maml:description> <maml:para>Specifies the non-credential part of the ODBC connection string. This parameter is applicable only for the ODBC linked service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="8" aliases=""> <maml:name>AuthenticationType</maml:name> <maml:description> <maml:para>Specifies the type of authentication to be used to connect to the data source. Allowed values: Windows, Basic, or Anonymous.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="9" aliases=""> <maml:name>Server</maml:name> <maml:description> <maml:para>Specifies the server name of the linked service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="10" aliases=""> <maml:name>Database</maml:name> <maml:description> <maml:para>Specifies the database name of the linked service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Encrypt a non-ODBC connection string</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>$Value = ConvertTo-SecureString 'Data Source=ContosoServer;Initial Catalog=catelog;user id =user123;password=password123' -AsPlainText -Force </dev:code> <dev:code> PS C:\>New-AzureRmDataFactoryEncryptValue -DataFactoryName "WikiADF" -GatewayName "WikiGateway" -ResourceGroupName "ADF" -Value $Value -Type OnPremisesSqlLinkedService data source=ContosoServer;initial catalog=catelog;EncryptedCredential=KAAAAAABAAAQAAAAQUU5MUVBNzY4QkFCQkI3MEUwRTMxOUNFNkM0MjRDOTVDNDk3RTcyRi8XAXyE/H+f3JydTkdg5t2g1eC/VtyF3NAD3idYnhrAphPJmO0pCaG5nH2IY48L3XJi7wabrlrGF+ieiWh1bwdgdxrW+t2jWPnLvT/ENUXtcevpx/dmTGKagH8TU9HLcoL1CAanb7Vkpga1B/uzRxBnVdsdtfvBzxG2M810tj1WzL8lFzA1mO5GbB0+ge116y0scL1vxjerjl5Muv0r0scG3lhj+IF0sXUMITFvhQwOIqweR052E6JlfJu+mTNFLCCkpw1iV+rhRhKqJF752dBuWjzI1EoyQUE17oK4OevkquuhUbfJmzj9BhGKQ+VkndAZiSw19FEGSC7JzoUe/XWEs/FJYrQCCXIeNS94J9/VzN6KPYJR1pzAYCtnhq+p8Q== </dev:code> <dev:remarks> <maml:para>The first command uses the ConvertTo-SecureString cmdlet to convert the specified connection string to a SecureString object, and then stores that object in the $Value variable. For more information, type Get-Help ConvertTo-SecureString. Allowed values: SQL Server or Oracle connection string.</maml:para> <maml:para>The second command creates an encrypted value for the object stored in $Value for the specified data factory, gateway, resource group, and linked service type.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Encrypt a non-ODBC connection string that uses Windows authentication.</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>$Value = ConvertTo-SecureString 'Data Source=ContosoServer;Initial Catalog=catelog;Integrated Security=True' -AsPlainText -Force </dev:code> <dev:code> PS C:\>$Credential = Get-Credential </dev:code> <dev:code> PS C:\>New-AzureRmDataFactoryEncryptValue -DataFactoryName "WikiADF" -GatewayName "WikiGateway" -ResourceGroupName "ADF" -Value $Value -Credential $Credential -Type OnPremisesSqlLinkedService data source=ContosoServer;initial catalog=catelog;EncryptedCredential=KAAAAAABAAAQAAAAQUU5MUVBNzY4QkFCQkI3MEUwRTMxOUNFNkM0MjRDOTVDNDk3RTcyRi8XAXyE/H+f3JydTkdg5t2g1eC/VtyF3NAD3idYnhrAphPJmO0pCaG5nH2IY48L3XJi7wabrlrGF+ieiWh1bwdgdxrW+t2jWPnLvT/ENUXtcevpx/dmTGKagH8TU9HLcoL1CAanb7Vkpga1B/uzRxBnVdsdtfvBzxG2M810tj1WzL8lFzA1mO5GbB0+ge116y0scL1vxjerjl5Muv0r0scG3lhj+IF0sXUMITFvhQwOIqweR052E6JlfJu+mTNFLCCkpw1iV+rhRhKqJF752dBuWjzI1EoyQUE17oK4OevkquuhUbfJmzj9BhGKQ+VkndAZiw19FEGSC7JzoUe/XWEs/FJYrQCCXIeNS94J9/VzN6KPYJR1pzAYCtnhq+p8Q== </dev:code> <dev:remarks> <maml:para>The first command uses the ConvertTo-SecureString cmdlet to convert the specified connection string to a SecureString object, and then stores that object in the $Value variable. For more information, type Get-Help ConvertTo-SecureString. Allowed value: SQL Server connection string.</maml:para> <maml:para>The second command uses the Get-Credential cmdlet to collect the windows authentication (user name and password), and then stores that PSCredential object in the $Credential variable. For more information, type Get-Help Get-Credential.</maml:para> <maml:para>The third command creates an encrypted value for the object stored in $Value and $Credential for the specified data factory, gateway, resource group, and linked service type.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 3: Encrypt server name and credentials for File system linked service</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\> $Value = ConvertTo-SecureString '\\servername' -AsPlainText -Force PS C:\> $Credential = Get-Credential PS C:\> New-AzureRmDataFactoryEncryptValue -DataFactoryName "WikiADF" -GatewayName "WikiGateway" -ResourceGroupName "ADF" -Value $Value -Credential $Credential -Type OnPremisesFileSystemLinkedService KAAAAAABAAAQAAAAQUU5MUVBNzY4QkFCQkI3MEUwRTMxOUNFNkM0MjRDOTVDNDk3RTcyRi8XAXyE/H+f3JydTkdg5t2g1eC/VtyF3NAD3idYnhrAphPJmO0pCaG5nH2IY48L3XJi7wabrlrGF+ieiWh1bwdgdxrW+t2jWPnLvT/ENUXtcevpx/dmTGKagH8TU9HLcoL1CAanb7Vkpga1B/uzRxBnVdsdtfvBzxG2M810tj1WzL8lFzA1mO5GbB0+ge116y0scL1vxjerjl5Muv0r0scG3lhj+IF0sXUMITFvhQwOIqweR052E6JlfJu+mTNFLCCkpw1iV+rhRhKqJF752dBuWjzI1EoyQUE17oK4OevkquuhUbfJmzj9BhGKQ+VkndAZiSw19FEGSC7JzoUe/XWEs/FJYrQCCXIeNS94J9/VzN6KPYJR1pzAYCtnhq+p8Q== </dev:code> <dev:remarks> <maml:para>The first command uses the ConvertTo-SecureString cmdlet to convert the specified string to a SecureString object, and then stores that object in the $Value variable.</maml:para> <maml:para>The second command uses the Get-Credential cmdlet to collect the windows authentication (user name and password), and then stores that PSCredential object in the $Credential variable. For more information, type Get-Help Get-Credential.</maml:para> <maml:para>The third command creates an encrypted value for the object stored in $Value and $Credential for the specified data factory, gateway, resource group, and linked service type. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 4: Encrypt an ODBC connection string</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>$Value = ConvertTo-SecureString 'UID=user123;PWD=password123;AuthMode=mode1;Token=token1' -AsPlainText -Force <!--[SuppressMessage("Microsoft.Security", "CS001:SecretInline")]--> </dev:code> <dev:code> PS C:\>New-AzureRmDataFactoryEncryptValue -DataFactoryName "WikiADF" -GatewayName "WikiGateway" -ResourceGroupName "ADF" -Value $Value -Type OnPremisesOdbcLinkedService -nonCredentialValue "Driver=CustomizedDriver;Server=ContosoServer;Database=ContosoDatabase;" -AuthenticationType "Basic" Driver=CustomizedDriver;Server=ContosoServer;Database=ContosoDatabase;EncryptedCredential=KAAAAAABAAAQAAAAQUU5MUVBNzY4QkFCQkI3MEUwRTMxOUNFNkM0MjRDOTVDNDk3RTcyRi8XAXyE/H+f3JydTkdg5t2g1eC/VtyF3NAD3idYnhrAphPJmO0pCaG5nH2IY48L3XJi7wabrlrGF+ieiWh1bwdgdxrW+t2jWPnLvT/ENUXtcevpx/dmTGKagH8TU9HLcoL1CAanb7Vkpga1B/uzRxBnVdsdtfvBzxG2M810tj1WzL8lFzA1mO5GbB0+ge116y0scL1vxjerjl5Muv0r0scG3lhj+IF0sXUMITFvhQwOIqweR052E6JlfJu+mTNFLCCkpw1iV+rhRhKqJF752dBuWjzI1EoyQUE17oK4OevkquuhUbfJmzj9BhGKQ+VkndAZiSw19FEGSC7JzoUe/XWEs/FJYrQCCXIeNS94J9/VzN6KPYJR1pzAYCtnhq+p8Q== </dev:code> <dev:remarks> <maml:para>The first command uses the ConvertTo-SecureString cmdlet to convert the specified connection string to a SecureString object, and then stores that object in the $Value variable. For more information, type Get-Help ConvertTo-SecureString. Allowed values: ODBC credential connection string.</maml:para> <maml:para>The second command creates an encrypted value for the object stored in $Value for the specified data factory, gateway, resource group, and linked service type.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 5: Encrypt a windows authentication ODBC connection string</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>$Value = ConvertTo-SecureString 'AuthMode=mode1;Token=token1' -AsPlainText -Force </dev:code> <dev:code> PS C:\>$Credential = Get-Credential </dev:code> <dev:code> PS C:\>New-AzureRmDataFactoryEncryptValue -DataFactoryName "WikiADF" -GatewayName "WikiGateway" -ResourceGroupName "ADF" -Value $Value -Credential $Credential -Type OnPremisesOdbcLinkedService -nonCredentialValue "Driver=CustomizedDriver;Server=ContosoServer;Database=ContosoDatabase;" -AuthenticationType "Windows" Driver=CustomizedDriver;Server=ContosoServer;Database=ContosoDatabase;EncryptedCredential=KAAAAAABAAAQAAAAQUU5MUVBNzY4QkFCQkI3MEUwRTMxOUNFNkM0MjRDOTVDNDk3RTcyRi8XAXyE/H+f3JydTkdg5t2g1eC/VtyF3NAD3idYnhrAphPJmO0pCaG5nH2IY48L3XJi7wabrlrGF+ieiWh1bwdgdxrW+t2jWPnLvT/ENUXtcevpx/dmTGKagH8TU9HLcoL1CAanb7Vkpga1B/uzRxBnVdsdtfvBzxG2M810tj1WzL8lFzA1mO5GbB0+ge116y0scL1vxjerjl5Muv0r0scG3lhj+IF0sXUMITFvhQwOIqweR052E6JlfJu+mTNFLCCkpw1iV+rhRhKqJF752dBuWjzI1EoyQUE17oK4OevkquuhUbfJmzj9BhGKQ+VkndAZiw19FEGSC7JzoUe/XWEs/FJYrQCCXIeNS94J9/VzN6KPYJR1pzAYCtnhq+p8Q== </dev:code> <dev:remarks> <maml:para>The first command uses the ConvertTo-SecureString cmdlet to convert the specified connection string to a SecureString object, and then stores that object in the $Value variable. For more information, type Get-Help ConvertTo-SecureString. Allowed value: ODBC credential connection string.</maml:para> <maml:para>The second command uses the Get-Credential cmdlet to collect the windows authentication (user name and password), and then stores that PSCredential object in the $Credential variable. For more information, type Get-Help Get-Credential.</maml:para> <maml:para>The third command creates an encrypted value for the object stored in $Value and $Credential for the specified data factory, gateway, resource group, and linked service type.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 6: Encrypt PostgreSql, Teradata, MySQL, DB2 and Sybase linked service credentials</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>$Credential = Get-Credential </dev:code> <dev:code> PS C:\>New-AzureRmDataFactoryEncryptValue -DataFactoryName "WikiADF" -GatewayName "WikiGateway" -ResourceGroupName "ADF" -Value $Value -Credential $Credential -Type OnPremisesPostgreSqlLinkedService -AuthenticationType "Windows" -Server "ContosoServer" -Database "ContosoDatabase" KAAAAAABAAAQAAAAQUU5MUVBNzY4QkFCQkI3MEUwRTMxOUNFNkM0MjRDOTVDNDk3RTcyRi8XA== </dev:code> <dev:remarks> <maml:para>The first command uses the Get-Credential cmdlet to collect the windows authentication (user name and password), and then stores that PSCredential object in the $Credential variable. For more information, type Get-Help Get-Credential.</maml:para> <maml:para>The second command creates an encrypted value for the object stored in $Credential for the specified data factory, gateway, resource group, and linked service type.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText> </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, data, factories</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-AzureRmDataFactoryGateway</command:name> <maml:description> <maml:para>Creates a gateway for Data Factory.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureDataFactoryGateway</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The New-AzureRmDataFactoryGateway cmdlet creates a gateway in Azure Data Factory. </maml:para> <maml:para>You must be in AzureResourceManager mode to run Azure Data Factory cmdlets. To switch to AzureResourceManager mode, type Switch-AzureMode AzureResourceManager.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureRmDataFactoryGateway</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure resource group. This cmdlet creates a gateway that belongs to the group that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>DataFactoryName</maml:name> <maml:description> <maml:para>Specifies the name of a data factory. This cmdlet creates a gateway for the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the gateway to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="4" aliases=""> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies a description for the gateway.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AzureRmDataFactoryGateway</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>DataFactory</maml:name> <maml:description> <maml:para>Specifies a PSDataFactory object. This cmdlet creates a gateway for the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataFactory</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the gateway to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="4" aliases=""> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies a description for the gateway.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>DataFactory</maml:name> <maml:description> <maml:para>Specifies a PSDataFactory object. This cmdlet creates a gateway for the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataFactory</command:parameterValue> <dev:type> <maml:name>PSDataFactory</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>DataFactoryName</maml:name> <maml:description> <maml:para>Specifies the name of a data factory. This cmdlet creates a gateway for the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="4" aliases=""> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies a description for the gateway.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the gateway to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure resource group. This cmdlet creates a gateway that belongs to the group that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.DataFactories.Models.PSDataFactoryGateway</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Create a gateway</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\> New-AzureRmDataFactoryGateway -ResourceGroupName "ADF" -Name "ContosoGateway" -DataFactoryName "WikiADF" -Description "my gateway" Name : ContosoGateway Description : my gateway Version : Status : NeedRegistration VersionStatus : None CreateTime : 8/22/2014 1:40:34 AM RegisterTime : LastConnectTime : ExpiryTime : ProvisioningState : Succeeded Key : ADF#40cbb3d9-2736-4794-a8a6-e6b839b4894f@a2d875ce-c9d7-4b8b-ad65-dd3ebbb9a940@8c0d1801-e863-44af-82e6-fb2f0c00f2ae@xz#Y9R0NhAeH3u7wgnrJyiWj4Y/QIhH4fFilIdzZgwsVQA= </dev:code> <dev:remarks> <maml:para>This command creates a gateway named ContosoGateway in the data factory named WikiADF in the resource group named ADF. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Remove-AzureRmDataFactoryGateway</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmDataFactoryGateway</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, data, factories</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-AzureRmDataFactoryGatewayKey</command:name> <maml:description> <maml:para>Creates a gateway key for Data Factory.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureDataFactoryGatewayKey</command:noun> <dev:version /> </command:details> <maml:description> <maml:para> The New-AzureRmDataFactoryGatewayKey cmdlet creates a gateway key for a specified Azure Data Factory gateway. You register the gateway with a cloud service by using this key. </maml:para> <maml:para>You must be in AzureResourceManager mode to run Azure Data Factory cmdlets. To switch to AzureResourceManager mode, type Switch-AzureMode AzureResourceManager.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureRmDataFactoryGatewayKey</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure resource group. This cmdlet creates a key for a gateway that belongs to the group that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>DataFactoryName</maml:name> <maml:description> <maml:para>Specifies the name of a data factory. This cmdlet creates a gateway key for the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases=""> <maml:name>GatewayName</maml:name> <maml:description> <maml:para> Specifies the name of the gateway. This cmdlet creates a key for the gateway that this parameter specifies. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AzureRmDataFactoryGatewayKey</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>DataFactory</maml:name> <maml:description> <maml:para>Specifies a PSDataFactory object. This cmdlet creates a gateway key for the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataFactory</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases=""> <maml:name>GatewayName</maml:name> <maml:description> <maml:para> Specifies the name of the gateway. This cmdlet creates a key for the gateway that this parameter specifies. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>DataFactory</maml:name> <maml:description> <maml:para>Specifies a PSDataFactory object. This cmdlet creates a gateway key for the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataFactory</command:parameterValue> <dev:type> <maml:name>PSDataFactory</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>DataFactoryName</maml:name> <maml:description> <maml:para>Specifies the name of a data factory. This cmdlet creates a gateway key for the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases=""> <maml:name>GatewayName</maml:name> <maml:description> <maml:para> Specifies the name of the gateway. This cmdlet creates a key for the gateway that this parameter specifies. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure resource group. This cmdlet creates a key for a gateway that belongs to the group that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.WindowsAzure.Commands.Utilities.PSDataFactoryGatewayKey</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Create a gateway key</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\> New-AzureRmDataFactoryGatewayKey -ResourceGroupName "ADF" -GatewayName "ContosoGateway" -DataFactoryName "WikiADF" | Format-List GatewayKey : ADF#40cbb3d9-2736-4794-a8a6-e6b839b4894f@a2d875ce-c9d7-4b8b-ad65-dd3ebbb9a940@8c0d1801-e863-44af-82e6-fb2f0c00f2ae@xz#Y9R0NhAeH3u7wgnrJyiWj4Y/QIhH4fFilIdzZgwsVQA= </dev:code> <dev:remarks> <maml:para>This command creates a gateway key for the data factory gateway named ContosoGateway, and then passes the gateway key to the Format-List cmdlet by using the pipeline operator. For more information, type Get-Help Format-List.</maml:para> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-AzureRmDataFactoryGateway</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, data, factories</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-AzureRmDataFactoryHub</command:name> <maml:description> <maml:para>Creates a hub for Data Factory.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureDataFactoryHub</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The New-AzureRmDataFactoryHub cmdlet creates a hub for Azure Data Factory in the specified Azure resource group and in the specified data factory with the specified file definition. After you create the hub, you can use it to store and manage linked services in a group, and you can add pipelines to the hub.</maml:para> <maml:para>You must be in AzureResourceManager mode to run Azure Data Factory cmdlets. To switch to AzureResourceManager mode, type Switch-AzureMode AzureResourceManager.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureRmDataFactoryHub</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure resource group. This cmdlet creates a hub that belongs to the group that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>DataFactoryName</maml:name> <maml:description> <maml:para>Specifies the name of a data factory. This cmdlet creates a hub for the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the hub to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases=""> <maml:name>File</maml:name> <maml:description> <maml:para>Specifies the full path of the JavaScript Object Notation (JSON) file that contains the description of the hub.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that this cmdlet replaces an existing hub without prompting you for confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AzureRmDataFactoryHub</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>DataFactory</maml:name> <maml:description> <maml:para>Specifies a PSDataFactory object. This cmdlet creates a hub for the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataFactory</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the hub to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases=""> <maml:name>File</maml:name> <maml:description> <maml:para>Specifies the full path of the JavaScript Object Notation (JSON) file that contains the description of the hub.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that this cmdlet replaces an existing hub without prompting you for confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>DataFactory</maml:name> <maml:description> <maml:para>Specifies a PSDataFactory object. This cmdlet creates a hub for the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataFactory</command:parameterValue> <dev:type> <maml:name>PSDataFactory</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>DataFactoryName</maml:name> <maml:description> <maml:para>Specifies the name of a data factory. This cmdlet creates a hub for the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases=""> <maml:name>File</maml:name> <maml:description> <maml:para>Specifies the full path of the JavaScript Object Notation (JSON) file that contains the description of the hub.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that this cmdlet replaces an existing hub without prompting you for confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the hub to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure resource group. This cmdlet creates a hub that belongs to the group that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Create a hub</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>New-AzureRmDataFactoryHub -ResourceGroupName "ADFResourceGroup" -DataFactoryName "ADFDataFactory" -Name "ContosoDataHub" -File "C:\Hub.json" </dev:code> <dev:remarks> <maml:para>This command creates a hub named ContosoDataHub in the resource group ADFResourceGroup and the data factory named ADFDataFactory. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureRmDataFactoryHub</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmDataFactoryHub</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, data, factories</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-AzureRmDataFactoryLinkedService</command:name> <maml:description> <maml:para>Links a data store or a cloud service to Data Factory.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureDataFactoryLinkedService</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The New-AzureRmDataFactoryLinkedService cmdlet links a data store or a cloud service to Azure Data Factory. If you specify a name for a linked service that already exists, this cmdlet prompts you for confirmation before it replaces the linked service. If you specify the Force parameter, the cmdlet replaces the existing linked service without confirmation. </maml:para> <maml:para> Perform these operations in the following order: -- Create a data factory. -- Create linked services. -- Create datasets. -- Create a pipeline. </maml:para> <maml:para>You must be in AzureResourceManager mode to run Azure Data Factory cmdlets. To switch to AzureResourceManager mode, type Switch-AzureMode AzureResourceManager.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureRmDataFactoryLinkedService</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure resource group. This cmdlet creates a linked service for the group that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>DataFactoryName</maml:name> <maml:description> <maml:para> Specifies the name of a data factory. This cmdlet creates a linked service for the data factory that this parameter specifies. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the linked service to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases=""> <maml:name>File</maml:name> <maml:description> <maml:para>Specifies the full path of the JavaScript Object Notation (JSON) file that contains the description of the linked service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that this cmdlet replaces an existing linked service without prompting you for confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AzureRmDataFactoryLinkedService</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>DataFactory</maml:name> <maml:description> <maml:para>Specifies a PSDataFactory object. This cmdlet creates a linked service for the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataFactory</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the linked service to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases=""> <maml:name>File</maml:name> <maml:description> <maml:para>Specifies the full path of the JavaScript Object Notation (JSON) file that contains the description of the linked service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that this cmdlet replaces an existing linked service without prompting you for confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>DataFactory</maml:name> <maml:description> <maml:para>Specifies a PSDataFactory object. This cmdlet creates a linked service for the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataFactory</command:parameterValue> <dev:type> <maml:name>PSDataFactory</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>DataFactoryName</maml:name> <maml:description> <maml:para> Specifies the name of a data factory. This cmdlet creates a linked service for the data factory that this parameter specifies. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases=""> <maml:name>File</maml:name> <maml:description> <maml:para>Specifies the full path of the JavaScript Object Notation (JSON) file that contains the description of the linked service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that this cmdlet replaces an existing linked service without prompting you for confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the linked service to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure resource group. This cmdlet creates a linked service for the group that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.WindowsAzure.Commands.Utilities.PSLinkedService </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Create a linked service</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\> New-AzureRmDataFactoryLinkedService -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "LinkedServiceCuratedWikiData" -File "C:\\samples\\WikiSample\\LinkedServiceCuratedWikiData.json" | Format-List LinkedServiceName : LinkedServiceCuratedWikiData ResourceGroupName : ADF DataFactoryName : WikiADF Properties : Microsoft.DataFactories.AzureStorageLinkedService </dev:code> <dev:remarks> <maml:para>This command creates a linked service named LinkedServiceCuratedWikiData in the data factory named WikiADF. This linked service links an Azure blob store specified in the file to the data factory named WikiADF. The command passes the result to the Format-List cmdlet by using the pipeline operator. That Windows PowerShell cmdlet formats the results. For more information, type Get-Help Format-List.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmDataFactoryLinkedService</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmDataFactoryLinkedService</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, data, factories</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-AzureRmDataFactoryPipeline</command:name> <maml:description> <maml:para>Creates a pipeline in Data Factory.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureDataFactoryPipeline</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The New-AzureRmDataFactoryPipeline cmdlet creates a pipeline in Azure Data Factory. If you specify a name for a pipeline that already exists, the cmdlet prompts you for confirmation before it replaces the pipeline. If you specify the Force parameter, the cmdlet replaces the existing pipeline without confirmation. </maml:para> <maml:para> Perform these operations in the following order: -- Create a data factory. -- Create linked services. -- Create datasets. -- Create a pipeline. </maml:para> <maml:para>If a pipeline with the same name already exists in the data factory, this cmdlet prompts you to confirm whether to overwrite the existing pipeline with the new pipeline. If you confirm to overwrite the existing pipeline, the pipeline definition is also replaced.</maml:para> <maml:para>You must be in AzureResourceManager mode to run Azure Data Factory cmdlets. To switch to AzureResourceManager mode, type Switch-AzureMode AzureResourceManager.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureRmDataFactoryPipeline</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure resource group. This cmdlet creates a pipeline for the group that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the pipeline to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>DataFactoryName</maml:name> <maml:description> <maml:para> Specifies the name of a data factory. This cmdlet creates a pipeline for the data factory that this parameter specifies. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases=""> <maml:name>File</maml:name> <maml:description> <maml:para> Specifies the full path of the JavaScript Object Notation (JSON) file that contains the description of the pipeline. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that this cmdlet replaces an existing pipeline without prompting you for confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AzureRmDataFactoryPipeline</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>DataFactory</maml:name> <maml:description> <maml:para>Specifies a PSDataFactory object. This cmdlet creates a pipeline for the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataFactory</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the pipeline to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases=""> <maml:name>File</maml:name> <maml:description> <maml:para> Specifies the full path of the JavaScript Object Notation (JSON) file that contains the description of the pipeline. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that this cmdlet replaces an existing pipeline without prompting you for confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>DataFactory</maml:name> <maml:description> <maml:para>Specifies a PSDataFactory object. This cmdlet creates a pipeline for the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataFactory</command:parameterValue> <dev:type> <maml:name>PSDataFactory</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>DataFactoryName</maml:name> <maml:description> <maml:para> Specifies the name of a data factory. This cmdlet creates a pipeline for the data factory that this parameter specifies. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases=""> <maml:name>File</maml:name> <maml:description> <maml:para> Specifies the full path of the JavaScript Object Notation (JSON) file that contains the description of the pipeline. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that this cmdlet replaces an existing pipeline without prompting you for confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the pipeline to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure resource group. This cmdlet creates a pipeline for the group that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.WindowsAzure.Commands.Utilities.PSPipeline </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Create a pipeline </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\> New-AzureRmDataFactoryPipeline -ResourceGroupName "ADF" -Name "DPWikisample" -DataFactoryName "WikiADF" -File "C:\DPWikisample.json" PipelineName : DPWikisample ResourceGroupName : ADF DataFactoryName : WikiADF11 Properties : Microsoft.DataFactories.PipelineProperties </dev:code> <dev:remarks> <maml:para>This command creates a pipeline named DPWikisample in the data factory named ADF. The command bases the pipeline on information in the DPWikisample.json file. This file includes information about activities such as Copy Activity and HDInsight Activity in the pipeline. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmDataFactoryPipeline</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmDataFactoryPipeline</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Resume-AzureRmDataFactoryPipeline</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmDataFactoryPipelineActivePeriod</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Suspend-AzureRmDataFactoryPipeline</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, data, factories</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-AzureRmDataFactoryDataset</command:name> <maml:description> <maml:para>Creates a dataset in Data Factory.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureDataFactoryDataset</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The New-AzureRmDataFactoryDataset cmdlet creates a dataset in Azure Data Factory. If you specify a name for a dataset that already exists, this cmdlet prompts you for confirmation before it replaces the dataset. If you specify the Force parameter, the cmdlet replaces the existing dataset without confirmation.</maml:para> <maml:para> Perform these operations in the following order: -- Create a data factory. -- Create linked services. -- Create datasets. -- Create a pipeline. </maml:para> <maml:para>If a dataset with the same name already exists in the data factory, this cmdlet prompts you to confirm whether to overwrite the existing dataset with the new dataset. If you confirm to overwrite the existing dataset, the dataset definition is also replaced.</maml:para> <maml:para>You must be in AzureResourceManager mode to run Azure Data Factory cmdlets. To switch to AzureResourceManager mode, type Switch-AzureMode AzureResourceManager.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureRmDataFactoryDataset</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure resource group. This cmdlet creates a dataset in the group that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>DataFactoryName</maml:name> <maml:description> <maml:para>Specifies the name of a data factory. This cmdlet creates a dataset in the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the dataset to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases=""> <maml:name>File</maml:name> <maml:description> <maml:para>Specifies the full path of the JavaScript Object Notation (JSON) file that contains the description of the dataset.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that this cmdlet replaces an existing dataset without prompting you for confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AzureRmDataFactoryDataset</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>DataFactory</maml:name> <maml:description> <maml:para>Specifies a PSDataFactory object. This cmdlet creates a dataset in the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataFactory</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the dataset to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases=""> <maml:name>File</maml:name> <maml:description> <maml:para>Specifies the full path of the JavaScript Object Notation (JSON) file that contains the description of the dataset.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that this cmdlet replaces an existing dataset without prompting you for confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>DataFactory</maml:name> <maml:description> <maml:para>Specifies a PSDataFactory object. This cmdlet creates a dataset in the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataFactory</command:parameterValue> <dev:type> <maml:name>PSDataFactory</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>DataFactoryName</maml:name> <maml:description> <maml:para>Specifies the name of a data factory. This cmdlet creates a dataset in the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases=""> <maml:name>File</maml:name> <maml:description> <maml:para>Specifies the full path of the JavaScript Object Notation (JSON) file that contains the description of the dataset.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that this cmdlet replaces an existing dataset without prompting you for confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the dataset to create.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure resource group. This cmdlet creates a dataset in the group that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.WindowsAzure.Commands.Utilities.PSDataset </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Create a dataset</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\> New-AzureRmDataFactoryDataset -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "DAWikipediaClickEvents" -File "C:\\samples\\WikiSample\\DA_WikipediaClickEvents.json" DatasetName : DAWikipediaClickEvents ResourceGroupName : ADF DataFactoryName : WikiADF Availability : Microsoft.DataFactories.Availability Location : Microsoft.DataFactories.AzureBlobLocation Policy : Microsoft.DataFactories.Policy Structure : {} </dev:code> <dev:remarks> <maml:para>This command creates a dataset named DA_WikipediaClickEvents in the data factory named WikiADF. The command bases the dataset on information in the DAWikipediaClickEvents.json file. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: View availability for a new dataset</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\> $Dataset = New-AzureRmDataFactoryDataset -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "DAWikipediaClickEvents" -File "C:\\samples\\WikiSample\\DA_WikipediaClickEvents.json"PS C:\> $Dataset.Availability AnchorDateTime : Frequency : Hour Interval : 1 Offset : WaitOnExternal : Microsoft.DataFactories.WaitOnExternal </dev:code> <dev:remarks> <maml:para>The first command creates a dataset named DA_WikipediaClickEvents, as in a previous example, and then assigns that dataset to the $Dataset variable. </maml:para> <maml:para>The second command uses standard dot notation to display details about the Availability property of the dataset.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 3: View location for a new dataset</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\> $Dataset = New-AzureRmDataFactoryDataset -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "DAWikipediaClickEvents" -File "C:\\samples\\WikiSample\\DA_WikipediaClickEvents.json"PS C:\> $Dataset.Location BlobPath : wikidatagateway/wikisampledatain/ FilenamePrefix : Format : LinkedServiceName : LinkedServiceWikipediaClickEvents PartitionBy : {} </dev:code> <dev:remarks> <maml:para>The first command creates a dataset named DA_WikipediaClickEvents, as in a previous example, and then assigns that dataset to the $Dataset variable.</maml:para> <maml:para>The second command displays details about the Location property of the dataset. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 4: View validation rules for a new dataset</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\> $Dataset = New-AzureRmDataFactoryDataset -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "DAWikipediaClickEvents" -File "C:\\samples\\WikiSample\\DA_WikipediaClickEvents.json"PS C:\> $Dataset.Policy.Validation | Format-List $dataset.Location BlobPath : wikidatagateway/wikisampledatain/ FilenamePrefix : Format : LinkedServiceName : LinkedServiceWikipediaClickEvents PartitionBy : {} MinimumRows : MinimumSizeMB : 1 </dev:code> <dev:remarks> <maml:para>The first command creates a dataset named DA_WikipediaClickEvents, as in a previous example, and then assigns that dataset to the $Dataset variable.</maml:para> <maml:para>The second command gets details about the validation rules for the dataset, and then passes them to the Format-List cmdlet by using the pipeline operator. That Windows PowerShell cmdlet formats the results. For more information, type Get-Help Format-List. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmDataFactoryDataset</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmDataFactoryDataset</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, data, factories</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-AzureRmDataFactory</command:name> <maml:description> <maml:para>Removes a data factory.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureDataFactory</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-AzureRmDataFactory cmdlet removes a data factory. </maml:para> <maml:para>You must be in AzureResourceManager mode to run Azure Data Factory cmdlets. To switch to AzureResourceManager mode, type Switch-AzureMode AzureResourceManager.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureRmDataFactory</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure resource group. This cmdlet removes a data factory from the group that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="DataFactoryName"> <maml:name>Name</maml:name> <maml:description> <maml:para> Specifies the name of the data factory to remove. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that this cmdlet removes a data factory without prompting you for confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-AzureRmDataFactory</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>DataFactory</maml:name> <maml:description> <maml:para>Specifies the PSDataFactory object to remove. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataFactory</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that this cmdlet removes a data factory without prompting you for confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>DataFactory</maml:name> <maml:description> <maml:para>Specifies the PSDataFactory object to remove. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataFactory</command:parameterValue> <dev:type> <maml:name>PSDataFactory</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that this cmdlet removes a data factory without prompting you for confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="DataFactoryName"> <maml:name>Name</maml:name> <maml:description> <maml:para> Specifies the name of the data factory to remove. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure resource group. This cmdlet removes a data factory from the group that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Boolean </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Remove a data factory</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\> Remove-AzureRmDataFactory -Name "WikiADF" -ResourceGroupName "ADF" Confirm Are you sure you want to remove data factory 'WikiADF' in resource group 'ADF'? [Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y True </dev:code> <dev:remarks> <maml:para>This command removes the data factory named WikiADF from the resource group named ADF. This command returns a value of $True.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmDataFactory</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureRmDataFactory</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, data, factories</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-AzureRmDataFactoryGateway</command:name> <maml:description> <maml:para>Removes a gateway from Data Factory.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureDataFactoryGateway</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-AzureRmDataFactoryGateway cmdlet removes the specified gateway from Azure Data Factory.</maml:para> <maml:para>You must be in AzureResourceManager mode to run Azure Data Factory cmdlets. To switch to AzureResourceManager mode, type Switch-AzureMode AzureResourceManager.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureRmDataFactoryGateway</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure resource group. This cmdlet removes a gateway that belongs to the group that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>DataFactoryName</maml:name> <maml:description> <maml:para>Specifies the name of a data factory. This cmdlet removes a gateway from the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the gateway to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that this cmdlet removes a gateway without prompting you for confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-AzureRmDataFactoryGateway</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>DataFactory</maml:name> <maml:description> <maml:para>Specifies a PSDataFactory object. This cmdlet removes a gateway from the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataFactory</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the gateway to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that this cmdlet removes a gateway without prompting you for confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>DataFactory</maml:name> <maml:description> <maml:para>Specifies a PSDataFactory object. This cmdlet removes a gateway from the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataFactory</command:parameterValue> <dev:type> <maml:name>PSDataFactory</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>DataFactoryName</maml:name> <maml:description> <maml:para>Specifies the name of a data factory. This cmdlet removes a gateway from the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that this cmdlet removes a gateway without prompting you for confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the gateway to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure resource group. This cmdlet removes a gateway that belongs to the group that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Remove a gateway</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\> Remove-AzureRmDataFactoryGateway -Name "ContosoGateway" -DataFactoryName "WikiADF" -ResourceGroupName "ADF" Confirm Are you sure you want to remove gateway 'ContosoGateway' in data factory 'WikiADF'? [Y] Yes [N] No [S] Suspend [?] Help (default is Y): Y True </dev:code> <dev:remarks> <maml:para>This command removes the gateway named ContosoGateway from the data factory named WikiADF. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmDataFactoryGateway</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureRmDataFactoryGateway</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmDataFactoryGateway</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, data, factories</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-AzureRmDataFactoryHub</command:name> <maml:description> <maml:para>Removes a hub from Data Factory.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureDataFactoryHub</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-AzureRmDataFactoryHub cmdlet removes a hub from Azure Data Factory in the specified Azure resource group and in the specified data factory. If you remove a hub, all linked services and pipelines in the hub are also removed.</maml:para> <maml:para>You must be in AzureResourceManager mode to run Azure Data Factory cmdlets. To switch to AzureResourceManager mode, type Switch-AzureMode AzureResourceManager.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureRmDataFactoryHub</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure resource group. This cmdlet removes a hub from the group that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>DataFactoryName</maml:name> <maml:description> <maml:para>Specifies the name of a data factory. This cmdlet removes a hub from the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="HubName"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the hub to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that this cmdlet removes a hub without prompting you for confirmation. </maml:para> </maml:description> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-AzureRmDataFactoryHub</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>DataFactory</maml:name> <maml:description> <maml:para>Specifies a PSDataFactory object. This cmdlet removes a hub from the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataFactory</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="HubName"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the hub to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that this cmdlet removes a hub without prompting you for confirmation. </maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>DataFactory</maml:name> <maml:description> <maml:para>Specifies a PSDataFactory object. This cmdlet removes a hub from the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataFactory</command:parameterValue> <dev:type> <maml:name>PSDataFactory</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>DataFactoryName</maml:name> <maml:description> <maml:para>Specifies the name of a data factory. This cmdlet removes a hub from the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that this cmdlet removes a hub without prompting you for confirmation. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="HubName"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the hub to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure resource group. This cmdlet removes a hub from the group that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Remove a hub</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Remove-AzureRmDataFactoryHub -ResourceGroupName "ADFResourceGroup" -DataFactoryName "ADFDataFactory" -Name "ContosoDataHub" </dev:code> <dev:remarks> <maml:para>This command removes the hub named ContosoDataHub from the Azure resource group named ADFResourceGroup and the data factory named ADFDataFactory.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureRmDataFactoryHub</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureRmDataFactoryHub</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, data, factories</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-AzureRmDataFactoryLinkedService</command:name> <maml:description> <maml:para>Removes a linked service from Data Factory.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureDataFactoryLinkedService</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-AzureRmDataFactoryLinkedService cmdlet removes a linked service from Azure Data Factory. </maml:para> <maml:para>You must be in AzureResourceManager mode to run Azure Data Factory cmdlets. To switch to AzureResourceManager mode, type Switch-AzureMode AzureResourceManager.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureRmDataFactoryLinkedService</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure resource group. This cmdlet removes a linked service from the group that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>DataFactoryName</maml:name> <maml:description> <maml:para>Specifies the name of a data factory. This cmdlet removes a linked service from the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="LinkedServiceName"> <maml:name>Name</maml:name> <maml:description> <maml:para> Specifies the name of the linked service to remove. Name of the linked service. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that this cmdlet removes a linked service without prompting you for confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-AzureRmDataFactoryLinkedService</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>DataFactory</maml:name> <maml:description> <maml:para>Specifies a PSDataFactory object. This cmdlet removes a linked service from the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataFactory</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="LinkedServiceName"> <maml:name>Name</maml:name> <maml:description> <maml:para> Specifies the name of the linked service to remove. Name of the linked service. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that this cmdlet removes a linked service without prompting you for confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>DataFactory</maml:name> <maml:description> <maml:para>Specifies a PSDataFactory object. This cmdlet removes a linked service from the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataFactory</command:parameterValue> <dev:type> <maml:name>PSDataFactory</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>DataFactoryName</maml:name> <maml:description> <maml:para>Specifies the name of a data factory. This cmdlet removes a linked service from the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that this cmdlet removes a linked service without prompting you for confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="LinkedServiceName"> <maml:name>Name</maml:name> <maml:description> <maml:para> Specifies the name of the linked service to remove. Name of the linked service. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure resource group. This cmdlet removes a linked service from the group that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Boolean </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Remove a linked service</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\> Remove-AzureRmDataFactoryLinkedService -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "LinkedServiceTest" Confirm Are you sure you want to remove linked service 'LinkedServiceTest' in data factory 'WikiADF'? [Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y True </dev:code> <dev:remarks> <maml:para>This command removes the linked service named LinkedServiceTest from the data factory named WikiADF. This command returns a value of $True.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmDataFactoryLinkedService</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureRmDataFactoryLinkedService</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, data, factories</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-AzureRmDataFactoryPipeline</command:name> <maml:description> <maml:para>Removes a pipeline from Data Factory.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureDataFactoryPipeline</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-AzureRmDataFactoryPipeline cmdlet removes a pipeline from Azure Data Factory. </maml:para> <maml:para>You must be in AzureResourceManager mode to run Azure Data Factory cmdlets. To switch to AzureResourceManager mode, type Switch-AzureMode AzureResourceManager.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureRmDataFactoryPipeline</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure resource group. This cmdlet removes a pipeline from the group that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>DataFactoryName</maml:name> <maml:description> <maml:para>Specifies the name of a data factory. This cmdlet removes a pipeline from the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="PipelineName"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the pipeline to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that this cmdlet removes a pipeline without prompting you for confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-AzureRmDataFactoryPipeline</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>DataFactory</maml:name> <maml:description> <maml:para>Specifies a PSDataFactory object. This cmdlet removes a pipeline from the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataFactory</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="PipelineName"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the pipeline to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that this cmdlet removes a pipeline without prompting you for confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>DataFactory</maml:name> <maml:description> <maml:para>Specifies a PSDataFactory object. This cmdlet removes a pipeline from the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataFactory</command:parameterValue> <dev:type> <maml:name>PSDataFactory</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>DataFactoryName</maml:name> <maml:description> <maml:para>Specifies the name of a data factory. This cmdlet removes a pipeline from the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that this cmdlet removes a pipeline without prompting you for confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="PipelineName"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the pipeline to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure resource group. This cmdlet removes a pipeline from the group that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Boolean </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Remove a pipeline</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\> Remove-AzureRmDataFactoryPipeline -ResourceGroupName "ADF" -Name "DPWikisample" -DataFactoryName "WikiADF" Confirm Are you sure you want to remove pipeline 'DPWikisample' in data factory 'WikiADF'? [Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y True </dev:code> <dev:remarks> <maml:para>This cmdlet removes the pipeline named DPWikisample from the data factory named WikiADF. The command returns a value of $True.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmDataFactoryPipeline</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureRmDataFactoryPipeline</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Resume-AzureRmDataFactoryPipeline</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmDataFactoryPipelineActivePeriod</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Suspend-AzureRmDataFactoryPipeline</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, data, factories</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-AzureRmDataFactoryDataset</command:name> <maml:description> <maml:para>Removes a dataset from Data Factory.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureDataFactoryDataset</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-AzureRmDataFactoryDataset cmdlet removes a dataset from Azure Data Factory. </maml:para> <maml:para>You must be in AzureResourceManager mode to run Azure Data Factory cmdlets. To switch to AzureResourceManager mode, type Switch-AzureMode AzureResourceManager.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureRmDataFactoryDataset</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure resource group. This cmdlet removes a dataset from the group that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>DataFactoryName</maml:name> <maml:description> <maml:para>Specifies the name of a data factory. This cmdlet removes a dataset from the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="DatasetName"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the dataset to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that this cmdlet removes a dataset without prompting you for confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-AzureRmDataFactoryDataset</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>DataFactory</maml:name> <maml:description> <maml:para>Specifies a PSDataFactory object. This cmdlet removes a dataset from the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataFactory</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="DatasetName"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the dataset to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that this cmdlet removes a dataset without prompting you for confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>DataFactory</maml:name> <maml:description> <maml:para>Specifies a PSDataFactory object. This cmdlet removes a dataset from the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataFactory</command:parameterValue> <dev:type> <maml:name>PSDataFactory</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>DataFactoryName</maml:name> <maml:description> <maml:para>Specifies the name of a data factory. This cmdlet removes a dataset from the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that this cmdlet removes a dataset without prompting you for confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="DatasetName"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the dataset to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure resource group. This cmdlet removes a dataset from the group that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Boolean </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Remove a dataset</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\> Remove-AzureRmDataFactoryDataset -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -Name "DAWikiAggregatedData" Confirm Are you sure you want to remove dataset 'DAWikiAggregatedData' in data factory 'WikiADF'? [Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): y True </dev:code> <dev:remarks> <maml:para>This command removes the dataset named DAWikiAggregatedData from the data factory named WikiADF. The command returns a value of $True.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmDataFactoryDataset</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureRmDataFactoryDataset</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, data, factories</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Resume-AzureRmDataFactoryPipeline</command:name> <maml:description> <maml:para>Resumes a suspended pipeline in Data Factory.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Resume</command:verb> <command:noun>AzureDataFactoryPipeline</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Resume-AzureRmDataFactoryPipeline cmdlet resumes a suspended pipeline in Azure Data Factory. </maml:para> <maml:para>You must be in AzureResourceManager mode to run Azure Data Factory cmdlets. To switch to AzureResourceManager mode, type Switch-AzureMode AzureResourceManager.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Resume-AzureRmDataFactoryPipeline</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure resource group. This cmdlet resumes a pipeline that belongs to the group that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>DataFactoryName</maml:name> <maml:description> <maml:para>Specifies the name of a data factory. This cmdlet resumes a pipeline that belongs to the data factory that this parameter specifies. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="PipelineName"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the pipeline to resume. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that this cmdlet resumes a pipeline without prompting you for confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Resume-AzureRmDataFactoryPipeline</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>DataFactory</maml:name> <maml:description> <maml:para>Specifies a PSDataFactory object. This cmdlet resumes a pipeline that belongs to the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataFactory</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="PipelineName"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the pipeline to resume. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that this cmdlet resumes a pipeline without prompting you for confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>DataFactory</maml:name> <maml:description> <maml:para>Specifies a PSDataFactory object. This cmdlet resumes a pipeline that belongs to the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataFactory</command:parameterValue> <dev:type> <maml:name>PSDataFactory</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>DataFactoryName</maml:name> <maml:description> <maml:para>Specifies the name of a data factory. This cmdlet resumes a pipeline that belongs to the data factory that this parameter specifies. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that this cmdlet resumes a pipeline without prompting you for confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="PipelineName"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the pipeline to resume. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure resource group. This cmdlet resumes a pipeline that belongs to the group that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Boolean </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Resume a pipeline</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\> Resume-AzureRmDataFactoryPipeline -ResourceGroupName "ADF" -Name "DPWikisample" -DataFactoryName "WikiADF" Confirm Are you sure you want to resume pipeline 'DPWikisample' in data factory 'WikiADF'? [Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y True </dev:code> <dev:remarks> <maml:para>This command resumes the pipeline named DPWikisample in the data factory named WikiADF. Use the Suspend-AzureRmDataFactoryPipeline cmdlet to suspend a pipeline. The command returns a value of $True.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmDataFactoryPipeline</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureRmDataFactoryPipeline</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmDataFactoryPipeline</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmDataFactoryPipelineActivePeriod</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Suspend-AzureRmDataFactoryPipeline</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, data, factories</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Save-AzureRmDataFactoryLog</command:name> <maml:description> <maml:para>Downloads log files from HDInsight processing.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Save</command:verb> <command:noun>AzureDataFactoryLog</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>You must be in AzureResourceManager mode to run Azure Data Factory cmdlets. To switch to AzureResourceManager mode, type Switch-AzureMode AzureResourceManager.</maml:para> <maml:para>The Save-AzureRmDataFactoryLog cmdlet downloads log files associated with Azure HDInsight processing of Pig or Hive projects or for custom activities to your local hard drive. You first run the Get-AzureRmDataFactoryRun cmdlet to get an ID for an activity run for a data slice, and then use that ID to retrieve log files from the binary large object (BLOB) storage associated with the HDInsight cluster. </maml:para> <maml:para>If you do not specify –DownloadLogs parameter, the cmdlet just returns the location of log files. </maml:para> <maml:para>If you specify –DownloadLogs parameter without specifying an output directory (-Output parameter), the log files are downloaded to the default Documents folder. </maml:para> <maml:para>If you specify –DownloadLogs parameter along with an output folder (-Output), the log files are downloaded to the specified folder. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Save-AzureRmDataFactoryLog</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>DataFactory</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataFactory</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of the activity run for the data slice. Use the Get-AzureRmDataFactoryRun cmdlet to get an ID. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases=""> <maml:name>Output</maml:name> <maml:description> <maml:para>Specifies the output folder in which the downloaded log files are saved. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>DownloadLogs</maml:name> <maml:description> <maml:para>Indicates that this cmdlet downloads log files to your local computer. If Ouptut folder is not specified, files are saved to Documents folder under a subfolder. </maml:para> </maml:description> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Save-AzureRmDataFactoryLog</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure resource group. This cmdlet creates a data factory that belongs to the group that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>DataFactoryName</maml:name> <maml:description> <maml:para>Specifies the name of a data factory. This cmdlet downloads log files for the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of the activity run for the data slice. Use the Get-AzureRmDataFactoryRun cmdlet to get an ID. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases=""> <maml:name>Output</maml:name> <maml:description> <maml:para>Specifies the output folder in which the downloaded log files are saved. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>DownloadLogs</maml:name> <maml:description> <maml:para>Indicates that this cmdlet downloads log files to your local computer. If Ouptut folder is not specified, files are saved to Documents folder under a subfolder. </maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>DataFactory</maml:name> <maml:description> <maml:para> </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataFactory</command:parameterValue> <dev:type> <maml:name>PSDataFactory</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>DataFactoryName</maml:name> <maml:description> <maml:para>Specifies the name of a data factory. This cmdlet downloads log files for the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>DownloadLogs</maml:name> <maml:description> <maml:para>Indicates that this cmdlet downloads log files to your local computer. If Ouptut folder is not specified, files are saved to Documents folder under a subfolder. </maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the ID of the activity run for the data slice. Use the Get-AzureRmDataFactoryRun cmdlet to get an ID. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases=""> <maml:name>Output</maml:name> <maml:description> <maml:para>Specifies the output folder in which the downloaded log files are saved. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure resource group. This cmdlet creates a data factory that belongs to the group that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Save log files to a specific folder </maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Save-AzureRmDataFactoryLog -ResourceGroupName "ADF" -DataFactoryName "LogProcessingFactory" -Id "841b77c9-d56c-48d1-99a3-8c16c3e77d39" -DownloadLogs -Output "C:\Test" </dev:code> <dev:remarks> <maml:para>This command saves log files for the activity run with the ID of 841b77c9-d56c-48d1-99a3-8c16c3e77d39 where the activity belongs to a pipeline in the data factory named LogProcessingFactory in the resource group named ADF. The log files are saved to the C:\Test folder. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 2: Save log files to default Documents folder</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Save-AzureRmDataFactoryLog -ResourceGroupName "ADF" -DataFactoryName "LogProcessingFactory" -Id "841b77c9-d56c-48d1-99a3-8c16c3e77d39" -DownloadLogs </dev:code> <dev:remarks> <maml:para>This command saves log files to Documents folder (default).</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>Example 3: Get the location of log files</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\>Save-AzureRmDataFactoryLog -ResourceGroupName "ADF" -DataFactoryName "LogProcessingFactory" -Id "841b77c9-d56c-48d1-99a3-8c16c3e77d39" </dev:code> <dev:remarks> <maml:para>This command returns the location of log files. Note that –DownloadLogs parameter is not specified. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri> </maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureRmDataFactoryRun</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-AzureRmDataFactoryPipeline</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureRmDataFactoryPipeline</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmDataFactoryPipeline</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmDataFactoryPipelineActivePeriod</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Suspend-AzureRmDataFactoryPipeline</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, data, factories</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-AzureRmDataFactoryGateway</command:name> <maml:description> <maml:para>Sets the description for a gateway in Data Factory.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureDataFactoryGateway</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-AzureRmDataFactoryGateway cmdlet sets the description for the specified gateway in Azure Data Factory.</maml:para> <maml:para>You must be in AzureResourceManager mode to run Azure Data Factory cmdlets. To switch to AzureResourceManager mode, type Switch-AzureMode AzureResourceManager.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureRmDataFactoryGateway</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>DataFactoryName</maml:name> <maml:description> <maml:para>Specifies the name of a data factory. This cmdlet sets the description for the gateway in the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the gateway for which to set a description.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases=""> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies a description for the gateway.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-AzureRmDataFactoryGateway</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>DataFactory</maml:name> <maml:description> <maml:para>Specifies a PSDataFactory object. This cmdlet sets the description for the gateway in the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataFactory</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the gateway for which to set a description.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases=""> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies a description for the gateway.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>DataFactory</maml:name> <maml:description> <maml:para>Specifies a PSDataFactory object. This cmdlet sets the description for the gateway in the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataFactory</command:parameterValue> <dev:type> <maml:name>PSDataFactory</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>DataFactoryName</maml:name> <maml:description> <maml:para>Specifies the name of a data factory. This cmdlet sets the description for the gateway in the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases=""> <maml:name>Description</maml:name> <maml:description> <maml:para>Specifies a description for the gateway.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases=""> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the gateway for which to set a description.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>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.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Collections.Generic.List`1[[Microsoft.WindowsAzure.Commands.Utilities.PSDataFactoryGateway]], Microsoft.WindowsAzure.Commands.Utilities.PSDataFactoryGateway</maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Set the description for a gateway</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> 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 : </dev:code> <dev:remarks> <maml:para>This command sets the description for the gateway named ContosoGateway in the data factory named WikiADF. The Description parameter specifies the new description. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmDataFactoryGateway</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureRmDataFactoryGateway</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmDataFactoryGateway</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, data, factories</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-AzureRmDataFactoryPipelineActivePeriod</command:name> <maml:description> <maml:para>Configures the active period for data slices.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureDataFactoryPipelineActivePeriod</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-AzureRmDataFactoryPipelineActivePeriod cmdlet configures the active period for the data slices that are processed by a pipeline in Azure Data Factory. If you use the Set-AzureRmDataFactorySliceStatus cmdlet to modify the status of slices for a dataset, make sure that the start time and end time for a slice are in the active period of the pipeline.</maml:para> <maml:para>After you create a pipeline, you can specify the period in which data processing occurs. Specifying the active period for a pipeline defines the time duration in which the data slices are processed based on the Availability properties that were defined for each Data Factory dataset. </maml:para> <maml:para>You must be in AzureResourceManager mode to run Azure Data Factory cmdlets. To switch to AzureResourceManager mode, type Switch-AzureMode AzureResourceManager.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureRmDataFactoryPipelineActivePeriod</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para> Specifies the name of an Azure resource group. This cmdlet modifies the active period for a pipeline that belongs to the group that this parameter specifies. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>DataFactoryName</maml:name> <maml:description> <maml:para>Specifies the name of a data factory. This cmdlet modifies the active period for a pipeline that belongs to the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="Name"> <maml:name>PipelineName</maml:name> <maml:description> <maml:para>Specifies the name of the pipeline. This cmdlet sets the active period for the pipeline that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases=""> <maml:name>StartDateTime</maml:name> <maml:description> <maml:para>Specifies the start of a time period as a DateTime object. Data processing occurs or data slices are processed within this period.</maml:para> <maml:para>StartDateTime must be specified in the ISO8601 format. Examples: 2015-01-01Z, 2015-01-01T00:00:00Z, 2015-01-01T00:00:00.000Z (UTC), 2015-01-01T00:00:00-08:00 (Pacific Standard Time)</maml:para> <maml:para>The default time zone designator is UTC. If the time zone designator is omitted (ex: 2014-10-01), it is considered as an UTC time 2014-10-01T00:00:00Z.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5" aliases=""> <maml:name>EndDateTime</maml:name> <maml:description> <maml:para>Specifies the end of a time period as a DateTime object. Data processing occurs or data slices are processed within this period. For more information about DateTime objects, type Get-Help Get-Date.</maml:para> <maml:para>EndDateTime must be specified in the ISO8601 format. Examples: 2015-01-01Z, 2015-01-01T00:00:00Z, 2015-01-01T00:00:00.000Z (UTC), 2015-01-01T00:00:00-08:00 (Pacific Standard Time)</maml:para> <maml:para>The default time zone designator is UTC. If the time zone designator is omitted (ex: 2014-10-01), it is considered as an UTC time 2014-10-01T00:00:00Z.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AutoResolve</maml:name> <maml:description> <maml:para>Indicates that this cmdlet uses auto resolve.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that this cmdlet sets the active period without prompting you for confirmation.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ForceRecalculate</maml:name> <maml:description> <maml:para>Indicates that this cmdlet uses force recalculate.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-AzureRmDataFactoryPipelineActivePeriod</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>DataFactory</maml:name> <maml:description> <maml:para>Specifies a PSDataFactory object. This cmdlet modifies the active period for a pipeline that belongs to the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataFactory</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="Name"> <maml:name>PipelineName</maml:name> <maml:description> <maml:para>Specifies the name of the pipeline. This cmdlet sets the active period for the pipeline that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases=""> <maml:name>StartDateTime</maml:name> <maml:description> <maml:para>Specifies the start of a time period as a DateTime object. Data processing occurs or data slices are processed within this period.</maml:para> <maml:para>StartDateTime must be specified in the ISO8601 format. Examples: 2015-01-01Z, 2015-01-01T00:00:00Z, 2015-01-01T00:00:00.000Z (UTC), 2015-01-01T00:00:00-08:00 (Pacific Standard Time)</maml:para> <maml:para>The default time zone designator is UTC. If the time zone designator is omitted (ex: 2014-10-01), it is considered as an UTC time 2014-10-01T00:00:00Z.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5" aliases=""> <maml:name>EndDateTime</maml:name> <maml:description> <maml:para>Specifies the end of a time period as a DateTime object. Data processing occurs or data slices are processed within this period. For more information about DateTime objects, type Get-Help Get-Date.</maml:para> <maml:para>EndDateTime must be specified in the ISO8601 format. Examples: 2015-01-01Z, 2015-01-01T00:00:00Z, 2015-01-01T00:00:00.000Z (UTC), 2015-01-01T00:00:00-08:00 (Pacific Standard Time)</maml:para> <maml:para>The default time zone designator is UTC. If the time zone designator is omitted (ex: 2014-10-01), it is considered as an UTC time 2014-10-01T00:00:00Z.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AutoResolve</maml:name> <maml:description> <maml:para>Indicates that this cmdlet uses auto resolve.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that this cmdlet sets the active period without prompting you for confirmation.</maml:para> </maml:description> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ForceRecalculate</maml:name> <maml:description> <maml:para>Indicates that this cmdlet uses force recalculate.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>AutoResolve</maml:name> <maml:description> <maml:para>Indicates that this cmdlet uses auto resolve.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>DataFactory</maml:name> <maml:description> <maml:para>Specifies a PSDataFactory object. This cmdlet modifies the active period for a pipeline that belongs to the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataFactory</command:parameterValue> <dev:type> <maml:name>PSDataFactory</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>DataFactoryName</maml:name> <maml:description> <maml:para>Specifies the name of a data factory. This cmdlet modifies the active period for a pipeline that belongs to the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5" aliases=""> <maml:name>EndDateTime</maml:name> <maml:description> <maml:para>Specifies the end of a time period as a DateTime object. Data processing occurs or data slices are processed within this period. For more information about DateTime objects, type Get-Help Get-Date.</maml:para> <maml:para>EndDateTime must be specified in the ISO8601 format. Examples: 2015-01-01Z, 2015-01-01T00:00:00Z, 2015-01-01T00:00:00.000Z (UTC), 2015-01-01T00:00:00-08:00 (Pacific Standard Time)</maml:para> <maml:para>The default time zone designator is UTC. If the time zone designator is omitted (ex: 2014-10-01), it is considered as an UTC time 2014-10-01T00:00:00Z.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that this cmdlet sets the active period without prompting you for confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>ForceRecalculate</maml:name> <maml:description> <maml:para>Indicates that this cmdlet uses force recalculate.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="Name"> <maml:name>PipelineName</maml:name> <maml:description> <maml:para>Specifies the name of the pipeline. This cmdlet sets the active period for the pipeline that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para> Specifies the name of an Azure resource group. This cmdlet modifies the active period for a pipeline that belongs to the group that this parameter specifies. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases=""> <maml:name>StartDateTime</maml:name> <maml:description> <maml:para>Specifies the start of a time period as a DateTime object. Data processing occurs or data slices are processed within this period.</maml:para> <maml:para>StartDateTime must be specified in the ISO8601 format. Examples: 2015-01-01Z, 2015-01-01T00:00:00Z, 2015-01-01T00:00:00.000Z (UTC), 2015-01-01T00:00:00-08:00 (Pacific Standard Time)</maml:para> <maml:para>The default time zone designator is UTC. If the time zone designator is omitted (ex: 2014-10-01), it is considered as an UTC time 2014-10-01T00:00:00Z.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Boolean </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Configure the active period</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\> Set-AzureRmDataFactoryPipelineActivePeriod -ResourceGroupName "ADF" -PipelineName "DPWikisample" -DataFactoryName "WikiADF" -StartDateTime 2014-05-21T16:00:00Z -EndDateTime 2014-05-22T16:00:00Z Confirm Are you sure you want to set pipeline 'DPWikisample' active period from '05/21/2014 16:00:00' to '05/22/2014 16:00:00'? [Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): y True </dev:code> <dev:remarks> <maml:para>This command configures the active period for the data slices that the pipeline named DPWikisample processes. The command provides beginning and end points for the data slices as values. The command returns a value of $True.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>New-AzureRmDataFactoryPipeline</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmDataFactorySliceStatus</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, data, factories</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-AzureRmDataFactorySliceStatus</command:name> <maml:description> <maml:para>Sets the status of slices for a dataset in Data Factory.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureDataFactorySliceStatus</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-AzureRmDataFactorySliceStatus cmdlet sets the status of slices for a dataset in Azure Data Factory.</maml:para> <maml:para>You must be in AzureResourceManager mode to run Azure Data Factory cmdlets. To switch to AzureResourceManager mode, type Switch-AzureMode AzureResourceManager.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureRmDataFactorySliceStatus</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure resource group. This cmdlet modifies the status of slices that belong to the group that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>DataFactoryName</maml:name> <maml:description> <maml:para>Specifies the name of a data factory. This cmdlet modifies the status of slices that belong to the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases=""> <maml:name>DatasetName</maml:name> <maml:description> <maml:para>Specifies the name of the dataset for which this cmdlet modifies slices.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases=""> <maml:name>StartDateTime</maml:name> <maml:description> <maml:para>Specifies the start of a time period as a DateTime object. This time is the beginning of a data slice.</maml:para> <maml:para>StartDateTime must be specified in the ISO8601 format. Examples: 2015-01-01Z, 2015-01-01T00:00:00Z, 2015-01-01T00:00:00.000Z (UTC), 2015-01-01T00:00:00-08:00 (Pacific Standard Time)</maml:para> <maml:para>The default time zone designator is UTC. If the time zone designator is omitted (ex: 2014-10-01), it is considered as an UTC time 2014-10-01T00:00:00Z.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5" aliases=""> <maml:name>EndDateTime</maml:name> <maml:description> <maml:para>Specifies the end of a time period as a DateTime object. This time is the end of a data slice. For more information about DateTime objects, type Get-Help Get-Date.</maml:para> <maml:para>EndDateTime must be specified in the ISO8601 format. Examples: 2015-01-01Z, 2015-01-01T00:00:00Z, 2015-01-01T00:00:00.000Z (UTC), 2015-01-01T00:00:00-08:00 (Pacific Standard Time)</maml:para> <maml:para>The default time zone designator is UTC. If the time zone designator is omitted (ex: 2014-10-01), it is considered as an UTC time 2014-10-01T00:00:00Z.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="6" aliases=""> <maml:name>Status</maml:name> <maml:description> <maml:para> Specifies a status to assign to the data slice. Valid values are: -- Ready. Data processing has completed and the data slice is ready. -- PendingExecution. Data processing has not started yet. -- PendingValidation. Data slice is waiting for pending validation on whether it fulfills the against validation policies before being processed. -- Skip. Skip processing of the slice. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="7" aliases=""> <maml:name>UpdateType</maml:name> <maml:description> <maml:para> Specifies the type of update to the slice. Valid values are: -- Individual. Sets the status of each slice for the dataset in the specified time range. -- UpstreamInPipeline. Sets the status of each slice for the dataset and all the dependent datasets, which are used as input datasets for activities in the pipeline. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-AzureRmDataFactorySliceStatus</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>DataFactory</maml:name> <maml:description> <maml:para>Specifies a PSDataFactory object. This cmdlet modifies the status of slices that belong to the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataFactory</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases=""> <maml:name>DatasetName</maml:name> <maml:description> <maml:para>Specifies the name of the dataset for which this cmdlet modifies slices.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases=""> <maml:name>StartDateTime</maml:name> <maml:description> <maml:para>Specifies the start of a time period as a DateTime object. This time is the beginning of a data slice.</maml:para> <maml:para>StartDateTime must be specified in the ISO8601 format. Examples: 2015-01-01Z, 2015-01-01T00:00:00Z, 2015-01-01T00:00:00.000Z (UTC), 2015-01-01T00:00:00-08:00 (Pacific Standard Time)</maml:para> <maml:para>The default time zone designator is UTC. If the time zone designator is omitted (ex: 2014-10-01), it is considered as an UTC time 2014-10-01T00:00:00Z.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5" aliases=""> <maml:name>EndDateTime</maml:name> <maml:description> <maml:para>Specifies the end of a time period as a DateTime object. This time is the end of a data slice. For more information about DateTime objects, type Get-Help Get-Date.</maml:para> <maml:para>EndDateTime must be specified in the ISO8601 format. Examples: 2015-01-01Z, 2015-01-01T00:00:00Z, 2015-01-01T00:00:00.000Z (UTC), 2015-01-01T00:00:00-08:00 (Pacific Standard Time)</maml:para> <maml:para>The default time zone designator is UTC. If the time zone designator is omitted (ex: 2014-10-01), it is considered as an UTC time 2014-10-01T00:00:00Z.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="6" aliases=""> <maml:name>Status</maml:name> <maml:description> <maml:para> Specifies a status to assign to the data slice. Valid values are: -- Ready. Data processing has completed and the data slice is ready. -- PendingExecution. Data processing has not started yet. -- PendingValidation. Data slice is waiting for pending validation on whether it fulfills the against validation policies before being processed. -- Skip. Skip processing of the slice. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="7" aliases=""> <maml:name>UpdateType</maml:name> <maml:description> <maml:para> Specifies the type of update to the slice. Valid values are: -- Individual. Sets the status of each slice for the dataset in the specified time range. -- UpstreamInPipeline. Sets the status of each slice for the dataset and all the dependent datasets, which are used as input datasets for activities in the pipeline. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>DataFactory</maml:name> <maml:description> <maml:para>Specifies a PSDataFactory object. This cmdlet modifies the status of slices that belong to the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataFactory</command:parameterValue> <dev:type> <maml:name>PSDataFactory</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>DataFactoryName</maml:name> <maml:description> <maml:para>Specifies the name of a data factory. This cmdlet modifies the status of slices that belong to the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5" aliases=""> <maml:name>EndDateTime</maml:name> <maml:description> <maml:para>Specifies the end of a time period as a DateTime object. This time is the end of a data slice. For more information about DateTime objects, type Get-Help Get-Date.</maml:para> <maml:para>EndDateTime must be specified in the ISO8601 format. Examples: 2015-01-01Z, 2015-01-01T00:00:00Z, 2015-01-01T00:00:00.000Z (UTC), 2015-01-01T00:00:00-08:00 (Pacific Standard Time)</maml:para> <maml:para>The default time zone designator is UTC. If the time zone designator is omitted (ex: 2014-10-01), it is considered as an UTC time 2014-10-01T00:00:00Z.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure resource group. This cmdlet modifies the status of slices that belong to the group that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="4" aliases=""> <maml:name>StartDateTime</maml:name> <maml:description> <maml:para>Specifies the start of a time period as a DateTime object. This time is the beginning of a data slice.</maml:para> <maml:para>StartDateTime must be specified in the ISO8601 format. Examples: 2015-01-01Z, 2015-01-01T00:00:00Z, 2015-01-01T00:00:00.000Z (UTC), 2015-01-01T00:00:00-08:00 (Pacific Standard Time)</maml:para> <maml:para>The default time zone designator is UTC. If the time zone designator is omitted (ex: 2014-10-01), it is considered as an UTC time 2014-10-01T00:00:00Z.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type> <maml:name>DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="6" aliases=""> <maml:name>Status</maml:name> <maml:description> <maml:para> Specifies a status to assign to the data slice. Valid values are: -- Ready. Data processing has completed and the data slice is ready. -- PendingExecution. Data processing has not started yet. -- PendingValidation. Data slice is waiting for pending validation on whether it fulfills the against validation policies before being processed. -- Skip. Skip processing of the slice. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases=""> <maml:name>DatasetName</maml:name> <maml:description> <maml:para>Specifies the name of the dataset for which this cmdlet modifies slices.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="7" aliases=""> <maml:name>UpdateType</maml:name> <maml:description> <maml:para> Specifies the type of update to the slice. Valid values are: -- Individual. Sets the status of each slice for the dataset in the specified time range. -- UpstreamInPipeline. Sets the status of each slice for the dataset and all the dependent datasets, which are used as input datasets for activities in the pipeline. </maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Boolean </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Set the status of all slices</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\> Set-AzureRmDataFactorySliceStatus -ResourceGroupName "ADF" -DataFactoryName "WikiADF" -DatasetName "DAWikiAggregatedData" -StartDateTime 2014-05-21T16:00:00Z -EndDateTime 2014-05-21T20:00:00Z -Status "PendingExecution" -UpdateType "UpstreamInPipeline" True </dev:code> <dev:remarks> <maml:para>This command sets the status of all slices for the dataset named DAWikiAggregatedData to PendingExecution in the data factory named WikiADF. The UpdateType parameter has a value of UpstreamInPipeline, and so the command sets the status of each slice for the dataset and all dependent datasets. Dependent datasets are used as input datasets for activities in the pipeline. This command returns a value of $True.</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmDataFactorySlice</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, data, factories</maml:para> </maml:alert> </maml:alertSet> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Suspend-AzureRmDataFactoryPipeline</command:name> <maml:description> <maml:para>Suspends a pipeline in Data Factory.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Suspend</command:verb> <command:noun>AzureDataFactoryPipeline</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Suspend-AzureRmDataFactoryPipeline cmdlet suspends a pipeline in Azure Data Factory. You can resume the pipeline by using the Resume-AzureRmDataFactoryPipeline cmdlet. </maml:para> <maml:para>You must be in AzureResourceManager mode to run Azure Data Factory cmdlets. To switch to AzureResourceManager mode, type Switch-AzureMode AzureResourceManager.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Suspend-AzureRmDataFactoryPipeline</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure resource group. This cmdlet suspends a pipeline that belongs to the group that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>DataFactoryName</maml:name> <maml:description> <maml:para>Specifies the name of a data factory. This cmdlet suspends a pipeline that belongs to the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="PipelineName"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the pipeline to suspend.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that this cmdlet suspends a pipeline without prompting you for confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Suspend-AzureRmDataFactoryPipeline</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>DataFactory</maml:name> <maml:description> <maml:para>Specifies a PSDataFactory object. This cmdlet suspends a pipeline that belongs to the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataFactory</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="PipelineName"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the pipeline to suspend.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that this cmdlet suspends a pipeline without prompting you for confirmation.</maml:para> </maml:description> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>DataFactory</maml:name> <maml:description> <maml:para>Specifies a PSDataFactory object. This cmdlet suspends a pipeline that belongs to the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSDataFactory</command:parameterValue> <dev:type> <maml:name>PSDataFactory</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases=""> <maml:name>DataFactoryName</maml:name> <maml:description> <maml:para>Specifies the name of a data factory. This cmdlet suspends a pipeline that belongs to the data factory that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Indicates that this cmdlet suspends a pipeline without prompting you for confirmation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="PipelineName"> <maml:name>Name</maml:name> <maml:description> <maml:para>Specifies the name of the pipeline to suspend.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases=""> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Specifies the name of an Azure resource group. This cmdlet suspends a pipeline that belongs to the group that this parameter specifies.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Boolean </maml:name> <maml:uri> </maml:uri> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>Example 1: Suspend a pipeline</maml:title> <maml:introduction> <maml:para> </maml:para> </maml:introduction> <dev:code> PS C:\> Suspend-AzureRmDataFactoryPipeline -ResourceGroupName "ADF" -Name "DPWikiSample" -DataFactoryName "WikiADF" Confirm Are you sure you want to suspend pipeline 'DPWikisample' in data factory 'WikiADF'? [Y] Yes [N] No [S] Suspend [?] Help (default is "Y"): Y True </dev:code> <dev:remarks> <maml:para>This command suspends the pipeline named DPWikiSample in the data factory named WikiADF. The command returns a value of $True. </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>Get-AzureRmDataFactoryPipeline</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>New-AzureRmDataFactoryPipeline</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-AzureRmDataFactoryPipeline</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Resume-AzureRmDataFactoryPipeline</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-AzureRmDataFactoryPipelineActivePeriod</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText> </maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> <maml:alertSet> <maml:alert> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, data, factories</maml:para> </maml:alert> </maml:alertSet> </command:command> </helpItems> |