diff --git a/src/ResourceManager/EventGrid/Commands.EventGrid/help/Get-AzureRmEventGridSubscription.md b/src/ResourceManager/EventGrid/Commands.EventGrid/help/Get-AzureRmEventGridSubscription.md index f44fc7657eda..f43c0eaf2f85 100644 --- a/src/ResourceManager/EventGrid/Commands.EventGrid/help/Get-AzureRmEventGridSubscription.md +++ b/src/ResourceManager/EventGrid/Commands.EventGrid/help/Get-AzureRmEventGridSubscription.md @@ -15,24 +15,27 @@ Gets the details of an event subscription, or gets a list of all event subscript ### EventSubscriptionTopicNameParameterSet (Default) ``` Get-AzureRmEventGridSubscription [[-EventSubscriptionName] ] [[-ResourceGroupName] ] - [[-TopicName] ] [-IncludeFullEndpointUrl] [] + [[-TopicName] ] [-IncludeFullEndpointUrl] [-DefaultProfile ] + [] ``` ### ResourceIdEventSubscriptionParameterSet ``` Get-AzureRmEventGridSubscription [[-EventSubscriptionName] ] [-ResourceId] - [-IncludeFullEndpointUrl] [] + [-IncludeFullEndpointUrl] [-DefaultProfile ] [] ``` ### EventSubscriptionTopicTypeNameParameterSet ``` Get-AzureRmEventGridSubscription [[-ResourceGroupName] ] [[-TopicTypeName] ] - [[-Location] ] [-IncludeFullEndpointUrl] [] + [[-Location] ] [-IncludeFullEndpointUrl] [-DefaultProfile ] + [] ``` ### EventSubscriptionInputObjectSet ``` -Get-AzureRmEventGridSubscription [-InputObject] [] +Get-AzureRmEventGridSubscription [-InputObject] [-DefaultProfile ] + [] ``` ## DESCRIPTION @@ -121,6 +124,21 @@ Gets the list of all event subscriptions created for the specific resource group ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -EventSubscriptionName The name of the event subscription diff --git a/src/ResourceManager/EventGrid/Commands.EventGrid/help/Get-AzureRmEventGridTopic.md b/src/ResourceManager/EventGrid/Commands.EventGrid/help/Get-AzureRmEventGridTopic.md index e2fdd14414a4..049611edbfbe 100644 --- a/src/ResourceManager/EventGrid/Commands.EventGrid/help/Get-AzureRmEventGridTopic.md +++ b/src/ResourceManager/EventGrid/Commands.EventGrid/help/Get-AzureRmEventGridTopic.md @@ -12,19 +12,22 @@ Gets the details of an Event Grid topic, or gets a list of all Event Grid topics ## SYNTAX -### TopicNameParameterSet (Default) +### ResourceGroupNameParameterSet (Default) ``` -Get-AzureRmEventGridTopic [-ResourceGroupName] [-Name] [] +Get-AzureRmEventGridTopic [[-ResourceGroupName] ] [-DefaultProfile ] + [] ``` -### ResourceGroupNameParameterSet +### TopicNameParameterSet ``` -Get-AzureRmEventGridTopic [[-ResourceGroupName] ] [] +Get-AzureRmEventGridTopic [-ResourceGroupName] [-Name] + [-DefaultProfile ] [] ``` ### ResourceIdEventSubscriptionParameterSet ``` -Get-AzureRmEventGridTopic [-ResourceId] [] +Get-AzureRmEventGridTopic [-ResourceId] [-DefaultProfile ] + [] ``` ## DESCRIPTION @@ -64,6 +67,21 @@ List all the Event Grid topics in the subscription. ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name EventGrid Topic Name. @@ -84,10 +102,10 @@ Resource Group Name. ```yaml Type: String -Parameter Sets: TopicNameParameterSet +Parameter Sets: ResourceGroupNameParameterSet Aliases: ResourceGroup -Required: True +Required: False Position: 0 Default value: None Accept pipeline input: True (ByPropertyName) @@ -96,10 +114,10 @@ Accept wildcard characters: False ```yaml Type: String -Parameter Sets: ResourceGroupNameParameterSet +Parameter Sets: TopicNameParameterSet Aliases: ResourceGroup -Required: False +Required: True Position: 0 Default value: None Accept pipeline input: True (ByPropertyName) diff --git a/src/ResourceManager/EventGrid/Commands.EventGrid/help/Get-AzureRmEventGridTopicKey.md b/src/ResourceManager/EventGrid/Commands.EventGrid/help/Get-AzureRmEventGridTopicKey.md index 69702cbdab0d..b589bb3d20bb 100644 --- a/src/ResourceManager/EventGrid/Commands.EventGrid/help/Get-AzureRmEventGridTopicKey.md +++ b/src/ResourceManager/EventGrid/Commands.EventGrid/help/Get-AzureRmEventGridTopicKey.md @@ -14,17 +14,20 @@ Gets the shared access keys used to publish events to an Event Grid topic. ### TopicNameParameterSet (Default) ``` -Get-AzureRmEventGridTopicKey [-ResourceGroupName] [-Name] [] +Get-AzureRmEventGridTopicKey [-ResourceGroupName] [-Name] + [-DefaultProfile ] [] ``` ### TopicInputObjectParameterSet ``` -Get-AzureRmEventGridTopicKey [-InputObject] [] +Get-AzureRmEventGridTopicKey [-InputObject] [-DefaultProfile ] + [] ``` ### ResourceIdEventSubscriptionParameterSet ``` -Get-AzureRmEventGridTopicKey [-ResourceId] [] +Get-AzureRmEventGridTopicKey [-ResourceId] [-DefaultProfile ] + [] ``` ## DESCRIPTION @@ -48,6 +51,21 @@ Gets the shared access keys of Event Grid topic \`Topic1\` in resource group \`M ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InputObject EventGrid Topic object. diff --git a/src/ResourceManager/EventGrid/Commands.EventGrid/help/Get-AzureRmEventGridTopicType.md b/src/ResourceManager/EventGrid/Commands.EventGrid/help/Get-AzureRmEventGridTopicType.md index 0717aecf791d..6d59f307a5f2 100644 --- a/src/ResourceManager/EventGrid/Commands.EventGrid/help/Get-AzureRmEventGridTopicType.md +++ b/src/ResourceManager/EventGrid/Commands.EventGrid/help/Get-AzureRmEventGridTopicType.md @@ -13,7 +13,8 @@ Gets the details about the topic types supported by Azure Event Grid. ## SYNTAX ``` -Get-AzureRmEventGridTopicType [[-Name] ] [-IncludeEventTypeData] [] +Get-AzureRmEventGridTopicType [[-Name] ] [-IncludeEventTypeData] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -47,6 +48,21 @@ Gets information about the StorageAccounts topic type, including the event types ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -IncludeEventTypeData If specified, the response will include the event types supported by a topic type. diff --git a/src/ResourceManager/EventGrid/Commands.EventGrid/help/New-AzureRmEventGridSubscription.md b/src/ResourceManager/EventGrid/Commands.EventGrid/help/New-AzureRmEventGridSubscription.md index b010e3a74051..ae767f2228ca 100644 --- a/src/ResourceManager/EventGrid/Commands.EventGrid/help/New-AzureRmEventGridSubscription.md +++ b/src/ResourceManager/EventGrid/Commands.EventGrid/help/New-AzureRmEventGridSubscription.md @@ -12,36 +12,36 @@ Creates a new Azure Event Grid Event Subscription to a topic, Azure resource, Az ## SYNTAX -### CustomTopicEventSubscriptionParameterSet (Default) +### ResourceGroupNameParameterSet (Default) ``` New-AzureRmEventGridSubscription [-EventSubscriptionName] [-Endpoint] - [-ResourceGroupName] [-TopicName] [[-EndpointType] ] [[-SubjectBeginsWith] ] + [[-ResourceGroupName] ] [[-EndpointType] ] [[-SubjectBeginsWith] ] [[-SubjectEndsWith] ] [-SubjectCaseSensitive] [[-IncludedEventType] ] [[-Label] ] - [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### ResourceIdEventSubscriptionParameterSet ``` New-AzureRmEventGridSubscription [-ResourceId] [-EventSubscriptionName] [-Endpoint] [[-EndpointType] ] [[-SubjectBeginsWith] ] [[-SubjectEndsWith] ] - [-SubjectCaseSensitive] [[-IncludedEventType] ] [[-Label] ] [-WhatIf] [-Confirm] - [] + [-SubjectCaseSensitive] [[-IncludedEventType] ] [[-Label] ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### EventSubscriptionInputObjectSet ``` New-AzureRmEventGridSubscription [-InputObject] [-EventSubscriptionName] [-Endpoint] [[-EndpointType] ] [[-SubjectBeginsWith] ] [[-SubjectEndsWith] ] - [-SubjectCaseSensitive] [[-IncludedEventType] ] [[-Label] ] [-WhatIf] [-Confirm] - [] + [-SubjectCaseSensitive] [[-IncludedEventType] ] [[-Label] ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` -### ResourceGroupNameParameterSet +### CustomTopicEventSubscriptionParameterSet ``` New-AzureRmEventGridSubscription [-EventSubscriptionName] [-Endpoint] - [[-ResourceGroupName] ] [[-EndpointType] ] [[-SubjectBeginsWith] ] + [-ResourceGroupName] [-TopicName] [[-EndpointType] ] [[-SubjectBeginsWith] ] [[-SubjectEndsWith] ] [-SubjectCaseSensitive] [[-IncludedEventType] ] [[-Label] ] - [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -99,13 +99,28 @@ Creates a new event subscription \`EventSubscription1\` to an EventHub namespace ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Endpoint Event subscription destination endpoint. This can be a webhook URL or the Azure resource ID of an EventHub. ```yaml Type: String -Parameter Sets: CustomTopicEventSubscriptionParameterSet, ResourceIdEventSubscriptionParameterSet, ResourceGroupNameParameterSet +Parameter Sets: ResourceGroupNameParameterSet, ResourceIdEventSubscriptionParameterSet, CustomTopicEventSubscriptionParameterSet Aliases: Required: True @@ -133,7 +148,7 @@ This can be webhook or eventhub ```yaml Type: String -Parameter Sets: CustomTopicEventSubscriptionParameterSet, ResourceIdEventSubscriptionParameterSet, ResourceGroupNameParameterSet +Parameter Sets: ResourceGroupNameParameterSet, ResourceIdEventSubscriptionParameterSet, CustomTopicEventSubscriptionParameterSet Aliases: Accepted values: webhook, eventhub @@ -162,7 +177,7 @@ The name of the event subscription ```yaml Type: String -Parameter Sets: CustomTopicEventSubscriptionParameterSet, ResourceIdEventSubscriptionParameterSet, ResourceGroupNameParameterSet +Parameter Sets: ResourceGroupNameParameterSet, ResourceIdEventSubscriptionParameterSet, CustomTopicEventSubscriptionParameterSet Aliases: Required: True @@ -189,7 +204,7 @@ Filter that specifies a list of event types to include.If not specified, all eve ```yaml Type: String[] -Parameter Sets: CustomTopicEventSubscriptionParameterSet, ResourceIdEventSubscriptionParameterSet, ResourceGroupNameParameterSet +Parameter Sets: ResourceGroupNameParameterSet, ResourceIdEventSubscriptionParameterSet, CustomTopicEventSubscriptionParameterSet Aliases: Required: False @@ -231,7 +246,7 @@ Labels for the event subscription ```yaml Type: String[] -Parameter Sets: CustomTopicEventSubscriptionParameterSet, ResourceIdEventSubscriptionParameterSet, ResourceGroupNameParameterSet +Parameter Sets: ResourceGroupNameParameterSet, ResourceIdEventSubscriptionParameterSet, CustomTopicEventSubscriptionParameterSet Aliases: Required: False @@ -258,10 +273,10 @@ The resource group of the topic. ```yaml Type: String -Parameter Sets: CustomTopicEventSubscriptionParameterSet +Parameter Sets: ResourceGroupNameParameterSet Aliases: ResourceGroup -Required: True +Required: False Position: 2 Default value: None Accept pipeline input: True (ByPropertyName) @@ -270,10 +285,10 @@ Accept wildcard characters: False ```yaml Type: String -Parameter Sets: ResourceGroupNameParameterSet +Parameter Sets: CustomTopicEventSubscriptionParameterSet Aliases: ResourceGroup -Required: False +Required: True Position: 2 Default value: None Accept pipeline input: True (ByPropertyName) @@ -301,7 +316,7 @@ If not specified, events with all subject prefixes will be included. ```yaml Type: String -Parameter Sets: CustomTopicEventSubscriptionParameterSet, ResourceIdEventSubscriptionParameterSet, ResourceGroupNameParameterSet +Parameter Sets: ResourceGroupNameParameterSet, ResourceIdEventSubscriptionParameterSet, CustomTopicEventSubscriptionParameterSet Aliases: Required: False @@ -345,7 +360,7 @@ If not specified, events with all subject suffixes will be included. ```yaml Type: String -Parameter Sets: CustomTopicEventSubscriptionParameterSet, ResourceIdEventSubscriptionParameterSet, ResourceGroupNameParameterSet +Parameter Sets: ResourceGroupNameParameterSet, ResourceIdEventSubscriptionParameterSet, CustomTopicEventSubscriptionParameterSet Aliases: Required: False diff --git a/src/ResourceManager/EventGrid/Commands.EventGrid/help/New-AzureRmEventGridTopic.md b/src/ResourceManager/EventGrid/Commands.EventGrid/help/New-AzureRmEventGridTopic.md index c2ed520965a0..3aaf01a8baea 100644 --- a/src/ResourceManager/EventGrid/Commands.EventGrid/help/New-AzureRmEventGridTopic.md +++ b/src/ResourceManager/EventGrid/Commands.EventGrid/help/New-AzureRmEventGridTopic.md @@ -14,7 +14,7 @@ Creates a new Azure Event Grid Topic. ``` New-AzureRmEventGridTopic [-ResourceGroupName] [-Name] [-Location] - [[-Tag] ] [-WhatIf] [-Confirm] [] + [[-Tag] ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -38,6 +38,21 @@ Creates an Event Grid topic \`Topic1\` in the specified geographic location \`we ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Location The location of the topic diff --git a/src/ResourceManager/EventGrid/Commands.EventGrid/help/New-AzureRmEventGridTopicKey.md b/src/ResourceManager/EventGrid/Commands.EventGrid/help/New-AzureRmEventGridTopicKey.md index d03218f7d6a5..6954b88cd3c1 100644 --- a/src/ResourceManager/EventGrid/Commands.EventGrid/help/New-AzureRmEventGridTopicKey.md +++ b/src/ResourceManager/EventGrid/Commands.EventGrid/help/New-AzureRmEventGridTopicKey.md @@ -14,20 +14,20 @@ Regenerates the shared access key for an Azure Event Grid Topic. ### TopicNameParameterSet (Default) ``` -New-AzureRmEventGridTopicKey [-ResourceGroupName] [-TopicName] [-KeyName] [-WhatIf] - [-Confirm] [] +New-AzureRmEventGridTopicKey [-ResourceGroupName] [-TopicName] [-KeyName] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### TopicInputObjectParameterSet ``` -New-AzureRmEventGridTopicKey [-KeyName] [-InputObject] [-WhatIf] [-Confirm] - [] +New-AzureRmEventGridTopicKey [-KeyName] [-InputObject] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### ResourceIdEventSubscriptionParameterSet ``` -New-AzureRmEventGridTopicKey [-KeyName] [-ResourceId] [-WhatIf] [-Confirm] - [] +New-AzureRmEventGridTopicKey [-KeyName] [-ResourceId] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -51,6 +51,21 @@ Regenerate the key corresponding to key \'key1'\ of Event Grid topic \`Topic1\` ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InputObject EventGrid Topic object. diff --git a/src/ResourceManager/EventGrid/Commands.EventGrid/help/Remove-AzureRmEventGridSubscription.md b/src/ResourceManager/EventGrid/Commands.EventGrid/help/Remove-AzureRmEventGridSubscription.md index dacc7f682a74..f2d35cd8a207 100644 --- a/src/ResourceManager/EventGrid/Commands.EventGrid/help/Remove-AzureRmEventGridSubscription.md +++ b/src/ResourceManager/EventGrid/Commands.EventGrid/help/Remove-AzureRmEventGridSubscription.md @@ -12,22 +12,29 @@ Removes an Azure Event Grid event subscription. ## SYNTAX -### EventSubscriptionNameParameterSet (Default) +### ResourceGroupNameParameterSet (Default) ``` Remove-AzureRmEventGridSubscription [-EventSubscriptionName] [[-ResourceGroupName] ] - [[-TopicName] ] [-PassThru] [-WhatIf] [-Confirm] [] + [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### ResourceIdEventSubscriptionParameterSet ``` Remove-AzureRmEventGridSubscription [-ResourceId] [-EventSubscriptionName] [-PassThru] - [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### EventSubscriptionInputObjectSet ``` Remove-AzureRmEventGridSubscription [-InputObject] [-EventSubscriptionName] [-PassThru] - [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### TopicNameParameterSet +``` +Remove-AzureRmEventGridSubscription [-EventSubscriptionName] [-ResourceGroupName] + [-TopicName] [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -72,12 +79,27 @@ Removes the event subscription \`EventSubscription1\` to an Event Grid Topic. ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -EventSubscriptionName Name of the event subscription that needs to be removed. ```yaml Type: String -Parameter Sets: EventSubscriptionNameParameterSet, ResourceIdEventSubscriptionParameterSet +Parameter Sets: ResourceGroupNameParameterSet, ResourceIdEventSubscriptionParameterSet, TopicNameParameterSet Aliases: Required: True @@ -134,7 +156,7 @@ Resource Group Name. ```yaml Type: String -Parameter Sets: EventSubscriptionNameParameterSet +Parameter Sets: ResourceGroupNameParameterSet Aliases: ResourceGroup Required: False @@ -144,6 +166,18 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +```yaml +Type: String +Parameter Sets: TopicNameParameterSet +Aliases: ResourceGroup + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + ### -ResourceId Identifier of the resource whose event subscription needs to be removed. @@ -164,10 +198,10 @@ Event Grid Topic Name. ```yaml Type: String -Parameter Sets: EventSubscriptionNameParameterSet +Parameter Sets: TopicNameParameterSet Aliases: -Required: False +Required: True Position: 2 Default value: None Accept pipeline input: True (ByPropertyName) diff --git a/src/ResourceManager/EventGrid/Commands.EventGrid/help/Remove-AzureRmEventGridTopic.md b/src/ResourceManager/EventGrid/Commands.EventGrid/help/Remove-AzureRmEventGridTopic.md index 5c0deadad09f..921a19112ddd 100644 --- a/src/ResourceManager/EventGrid/Commands.EventGrid/help/Remove-AzureRmEventGridTopic.md +++ b/src/ResourceManager/EventGrid/Commands.EventGrid/help/Remove-AzureRmEventGridTopic.md @@ -14,18 +14,20 @@ Removes an Azure Event Grid Topic. ### TopicNameParameterSet (Default) ``` -Remove-AzureRmEventGridTopic [-ResourceGroupName] [-Name] [-PassThru] [-WhatIf] [-Confirm] - [] +Remove-AzureRmEventGridTopic [-ResourceGroupName] [-Name] [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### ResourceIdEventSubscriptionParameterSet ``` -Remove-AzureRmEventGridTopic [-ResourceId] [-PassThru] [-WhatIf] [-Confirm] [] +Remove-AzureRmEventGridTopic [-ResourceId] [-PassThru] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] ``` ### TopicInputObjectParameterSet ``` -Remove-AzureRmEventGridTopic [-InputObject] [-PassThru] [-WhatIf] [-Confirm] [] +Remove-AzureRmEventGridTopic [-InputObject] [-PassThru] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -49,6 +51,21 @@ Removes the Event Grid topic \`Topic1\` in resource group \`MyResourceGroupName\ ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InputObject EventGrid Topic object. diff --git a/src/ResourceManager/EventGrid/Commands.EventGrid/help/Set-AzureRmEventGridTopic.md b/src/ResourceManager/EventGrid/Commands.EventGrid/help/Set-AzureRmEventGridTopic.md index c68f2bd2c510..a396e22e55bc 100644 --- a/src/ResourceManager/EventGrid/Commands.EventGrid/help/Set-AzureRmEventGridTopic.md +++ b/src/ResourceManager/EventGrid/Commands.EventGrid/help/Set-AzureRmEventGridTopic.md @@ -14,20 +14,20 @@ Set the properties of an Event Grid topic. ### TopicNameParameterSet (Default) ``` -Set-AzureRmEventGridTopic [-ResourceGroupName] [-Name] [-Tag] [-WhatIf] - [-Confirm] [] +Set-AzureRmEventGridTopic [-ResourceGroupName] [-Name] [-Tag] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### ResourceIdEventSubscriptionParameterSet ``` -Set-AzureRmEventGridTopic [-ResourceId] [-Tag] [-WhatIf] [-Confirm] - [] +Set-AzureRmEventGridTopic [-ResourceId] [-Tag] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] ``` ### TopicInputObjectParameterSet ``` -Set-AzureRmEventGridTopic [-InputObject] [-Tag] [-WhatIf] [-Confirm] - [] +Set-AzureRmEventGridTopic [-InputObject] [-Tag] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -44,6 +44,21 @@ Sets the properties of the Event Grid topic \`Topic1\` in resource group \`MyRes ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InputObject EventGrid Topic object. diff --git a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Add-AzureRmHDInsightClusterIdentity.md b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Add-AzureRmHDInsightClusterIdentity.md index 47ee69f8c3f9..6b5750af8a34 100644 --- a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Add-AzureRmHDInsightClusterIdentity.md +++ b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Add-AzureRmHDInsightClusterIdentity.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml +Module Name: AzureRM.HDInsight ms.assetid: A40AB6AB-D3CB-4A6C-B614-0B22085759DA online version: schema: 2.0.0 @@ -15,14 +16,15 @@ Adds a cluster identity to a cluster configuration object. ### CertificateFilePath (Default) ``` Add-AzureRmHDInsightClusterIdentity [-Config] [-ObjectId] - [-CertificateFilePath] [-CertificatePassword] [[-AadTenantId] ] [] + [-CertificateFilePath] [-CertificatePassword] [[-AadTenantId] ] + [-DefaultProfile ] [] ``` ### CertificateFileContents ``` Add-AzureRmHDInsightClusterIdentity [-Config] [-ObjectId] [-CertificateFileContents] [-CertificatePassword] [[-AadTenantId] ] - [] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -155,6 +157,21 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ObjectId Specifies the Azure AD object ID (a GUID) of the Azure AD Service Principal that represents the cluster. The cluster will use this when accessing Azure Data Lake Store. @@ -177,11 +194,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### AzureHDInsightConfig - Parameter 'Config' accepts value of type 'AzureHDInsightConfig' from the pipeline ### Guid - Parameter 'ObjectId' accepts value of type 'Guid' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Add-AzureRmHDInsightComponentVersion.md b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Add-AzureRmHDInsightComponentVersion.md index 3623ba2fbc67..dab9de9baee1 100644 --- a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Add-AzureRmHDInsightComponentVersion.md +++ b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Add-AzureRmHDInsightComponentVersion.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml +Module Name: AzureRM.HDInsight ms.assetid: 774848C9-47A1-4C43-B6FA-B3C0C3C76470 online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Adds a version for a service running in a cluster to a cluster configuration obj ``` Add-AzureRmHDInsightComponentVersion [-Config] [-ComponentName] - [-ComponentVersion] [-WhatIf] [-Confirm] [] + [-ComponentVersion] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -29,6 +31,8 @@ The Add-AzureRmHDInsightComponentVersion cmdlet adds a version for a service run + + ``` PS C:\> # Primary storage account info $storageAccountResourceGroupName = "Group" @@ -111,6 +115,21 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Confirm Prompts you for confirmation before running the cmdlet. @@ -145,7 +164,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### AzureHDInsightConfig - Parameter 'Config' accepts value of type 'AzureHDInsightConfig' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Add-AzureRmHDInsightConfigValues.md b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Add-AzureRmHDInsightConfigValues.md index d35019d5ac16..a54aff07bf9a 100644 --- a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Add-AzureRmHDInsightConfigValues.md +++ b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Add-AzureRmHDInsightConfigValues.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml +Module Name: AzureRM.HDInsight ms.assetid: 4C3CF283-DD4F-4D2A-ABEC-84AC7B005D6A online version: schema: 2.0.0 @@ -18,7 +19,8 @@ Add-AzureRmHDInsightConfigValues [-Config] [-Core ] [-OozieSite ] [-OozieEnv ] [-WebHCat ] [-HBaseSite ] [-HBaseEnv ] [-Storm ] [-Yarn ] [-MapRed ] [-Tez ] [-Hdfs ] [-RServer ] - [-SparkDefaults ] [-SparkThriftConf ] [] + [-SparkDefaults ] [-SparkThriftConf ] [-DefaultProfile ] + [] ``` ### Spark2 @@ -27,7 +29,8 @@ Add-AzureRmHDInsightConfigValues [-Config] [-Core ] [-OozieSite ] [-OozieEnv ] [-WebHCat ] [-HBaseSite ] [-HBaseEnv ] [-Storm ] [-Yarn ] [-MapRed ] [-Tez ] [-Hdfs ] [-RServer ] - [-Spark2Defaults ] [-Spark2ThriftConf ] [] + [-Spark2Defaults ] [-Spark2ThriftConf ] [-DefaultProfile ] + [] ``` ## DESCRIPTION @@ -110,6 +113,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -HBaseEnv Specifies the HBase Env configurations of this HDInsight cluster. @@ -371,7 +389,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### AzureHDInsightConfig - Parameter 'Config' accepts value of type 'AzureHDInsightConfig' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Add-AzureRmHDInsightMetastore.md b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Add-AzureRmHDInsightMetastore.md index 9c683c2bcd24..93dc8f4a1582 100644 --- a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Add-AzureRmHDInsightMetastore.md +++ b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Add-AzureRmHDInsightMetastore.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml +Module Name: AzureRM.HDInsight ms.assetid: 8BD3B8BD-DC87-4A94-9FCA-611D11D5E065 online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Adds a SQL Database to serve as a Hive or Oozie metastore to a cluster configura ``` Add-AzureRmHDInsightMetastore [-Config] [-MetastoreType] - [-SqlAzureServerName] [-DatabaseName] [-Credential] [] + [-SqlAzureServerName] [-DatabaseName] [-Credential] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -127,6 +129,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -MetastoreType Specifies the type of metastore. Possible values are HiveMetastore or OozieMetastore. @@ -165,7 +182,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### AzureHDInsightConfig - Parameter 'Config' accepts value of type 'AzureHDInsightConfig' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Add-AzureRmHDInsightScriptAction.md b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Add-AzureRmHDInsightScriptAction.md index c489061d1dc9..ee6594352c36 100644 --- a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Add-AzureRmHDInsightScriptAction.md +++ b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Add-AzureRmHDInsightScriptAction.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml +Module Name: AzureRM.HDInsight ms.assetid: 8F0634BD-D817-4365-B6D1-924DC36AE4C9 online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Adds a script action to a cluster configuration object. ``` Add-AzureRmHDInsightScriptAction [-Config] [-NodeType] [-Uri] - [-Name] [[-Parameters] ] [] + [-Name] [[-Parameters] ] [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -97,6 +98,21 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Specifies the name of the script action. @@ -169,7 +185,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### AzureHDInsightConfig - Parameter 'Config' accepts value of type 'AzureHDInsightConfig' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Add-AzureRmHDInsightSecurityProfile.md b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Add-AzureRmHDInsightSecurityProfile.md index 652ba1ae3577..4c0600bf0e62 100644 --- a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Add-AzureRmHDInsightSecurityProfile.md +++ b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Add-AzureRmHDInsightSecurityProfile.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml +Module Name: AzureRM.HDInsight ms.assetid: FB37494B-4035-45B7-88AB-DF33CEEF0D0A online version: schema: 2.0.0 @@ -15,7 +16,8 @@ Adds a security profileto a cluster configuration object. ``` Add-AzureRmHDInsightSecurityProfile [-Config] -Domain -DomainUserCredential -OrganizationalUnitDN -LdapsUrls - [-ClusterUsersGroupDNs ] [-WhatIf] [-Confirm] [] + [-ClusterUsersGroupDNs ] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -64,6 +66,21 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Domain Active Directory domain for the cluster @@ -159,7 +176,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### AzureHDInsightConfig - Parameter 'Config' accepts value of type 'AzureHDInsightConfig' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Add-AzureRmHDInsightStorage.md b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Add-AzureRmHDInsightStorage.md index 189d4f336bc2..0487f0f0ebee 100644 --- a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Add-AzureRmHDInsightStorage.md +++ b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Add-AzureRmHDInsightStorage.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml +Module Name: AzureRM.HDInsight ms.assetid: 2C2AF43D-18BF-4036-A355-FC27E406B18A online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Adds an Azure Storage key to a cluster configuration object. ``` Add-AzureRmHDInsightStorage [-Config] [-StorageAccountName] - [-StorageAccountKey] [] + [-StorageAccountKey] [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -86,6 +87,21 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -StorageAccountKey Specifies the storage account key for the storage account to be added to the new cluster. @@ -122,7 +138,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### AzureHDInsightConfig - Parameter 'Config' accepts value of type 'AzureHDInsightConfig' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/HDInsight/Commands.HDInsight/help/AzureRM.HDInsight.md b/src/ResourceManager/HDInsight/Commands.HDInsight/help/AzureRM.HDInsight.md index 1cad68c129e3..e6f7a5e01546 100644 --- a/src/ResourceManager/HDInsight/Commands.HDInsight/help/AzureRM.HDInsight.md +++ b/src/ResourceManager/HDInsight/Commands.HDInsight/help/AzureRM.HDInsight.md @@ -32,6 +32,12 @@ Adds a security profileto a cluster configuration object. ### [Add-AzureRmHDInsightStorage](Add-AzureRmHDInsightStorage.md) Adds an Azure Storage key to a cluster configuration object. +### [Disable-AzureRmHDInsightOperationsManagementSuite](Disable-AzureRmHDInsightOperationsManagementSuite.md) +Disables Operations Management Suite (OMS) in a HDInsight cluster and relevant logs will stop flowing to the OMS workspace specified during enable. + +### [Enable-AzureRmHDInsightOperationsManagementSuite](Enable-AzureRmHDInsightOperationsManagementSuite.md) +Enables Operations Management Suite (OMS) in a HDInsight cluster and relevant logs will be sent to the OMS workspace specified during enable. + ### [Get-AzureRmHDInsightCluster](Get-AzureRmHDInsightCluster.md) Gets and lists all of the Azure HDInsight clusters associated with the current subscription or a specified resource group, or retrieves a specific cluster. @@ -41,6 +47,9 @@ Gets the list of jobs from a cluster and lists them in reverse chronological ord ### [Get-AzureRmHDInsightJobOutput](Get-AzureRmHDInsightJobOutput.md) Gets the log output for a job from the storage account associated with a specified cluster. +### [Get-AzureRmHDInsightOperationsManagementSuite](Get-AzureRmHDInsightOperationsManagementSuite.md) +Gets the status of Operations Management Suite (OMS) installation on the cluster. + ### [Get-AzureRmHDInsightPersistedScriptAction](Get-AzureRmHDInsightPersistedScriptAction.md) Gets the persisted script actions for a cluster and lists them in chronological order, or gets details for a specified persisted script action. diff --git a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Disable-AzureRmHDInsightOperationsManagementSuite.md b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Disable-AzureRmHDInsightOperationsManagementSuite.md index 36b8665d918f..45aa4a02d412 100644 --- a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Disable-AzureRmHDInsightOperationsManagementSuite.md +++ b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Disable-AzureRmHDInsightOperationsManagementSuite.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml +Module Name: AzureRM.HDInsight online version: schema: 2.0.0 --- @@ -13,7 +14,7 @@ Disables Operations Management Suite (OMS) in a HDInsight cluster and relevant l ``` Disable-AzureRmHDInsightOperationsManagementSuite [-Name] [-ResourceGroupName ] - [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -53,6 +54,21 @@ Operations Management Suite (OMS) will be disabled on the HDInsight cluster and ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name The name of the cluster to disable Operations Management Suite(OMS). @@ -83,6 +99,36 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Enable-AzureRmHDInsightOperationsManagementSuite.md b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Enable-AzureRmHDInsightOperationsManagementSuite.md index e5f73e13fdd7..8f7c1ef8a8e9 100644 --- a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Enable-AzureRmHDInsightOperationsManagementSuite.md +++ b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Enable-AzureRmHDInsightOperationsManagementSuite.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml +Module Name: AzureRM.HDInsight online version: schema: 2.0.0 --- @@ -13,7 +14,8 @@ Enables Operations Management Suite (OMS) in a HDInsight cluster and relevant lo ``` Enable-AzureRmHDInsightOperationsManagementSuite [-Name] [-WorkspaceId] - [-PrimaryKey] [-ResourceGroupName ] [] + [-PrimaryKey] [-ResourceGroupName ] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -53,6 +55,21 @@ Operations Management Suite (OMS) will be enabled on the HDInsight cluster and r ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name The name of the cluster to enable Operations Management Suite(OMS). @@ -113,6 +130,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Get-AzureRmHDInsightCluster.md b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Get-AzureRmHDInsightCluster.md index 1a1b6a35a069..e2234f7fccb6 100644 --- a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Get-AzureRmHDInsightCluster.md +++ b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Get-AzureRmHDInsightCluster.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml +Module Name: AzureRM.HDInsight ms.assetid: FA154E07-EA26-4688-986E-C53C3A9E4F06 online version: schema: 2.0.0 @@ -13,7 +14,8 @@ Gets and lists all of the Azure HDInsight clusters associated with the current s ## SYNTAX ``` -Get-AzureRmHDInsightCluster [[-ResourceGroupName] ] [[-ClusterName] ] [] +Get-AzureRmHDInsightCluster [[-ResourceGroupName] ] [[-ClusterName] ] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -46,6 +48,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of the resource group. diff --git a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Get-AzureRmHDInsightJob.md b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Get-AzureRmHDInsightJob.md index 6aa307864ed3..dab9fcc5030f 100644 --- a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Get-AzureRmHDInsightJob.md +++ b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Get-AzureRmHDInsightJob.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml +Module Name: AzureRM.HDInsight ms.assetid: AFE90092-8B25-4897-8D3A-3E732CC5CBA6 online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Gets the list of jobs from a cluster and lists them in reverse chronological ord ``` Get-AzureRmHDInsightJob [-ClusterName] [-HttpCredential] [[-JobId] ] - [-NumOfJobs ] [-ResourceGroupName ] [] + [-NumOfJobs ] [-ResourceGroupName ] [-DefaultProfile ] + [] ``` ## DESCRIPTION @@ -60,6 +62,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -HttpCredential Specifies the cluster login (HTTP) credentials for the cluster. diff --git a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Get-AzureRmHDInsightJobOutput.md b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Get-AzureRmHDInsightJobOutput.md index 8ec370ac3d5f..99b49c13dd4c 100644 --- a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Get-AzureRmHDInsightJobOutput.md +++ b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Get-AzureRmHDInsightJobOutput.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml +Module Name: AzureRM.HDInsight ms.assetid: 5871C962-27D7-4EC8-927E-D4CAE5F23C58 online version: schema: 2.0.0 @@ -16,7 +17,7 @@ Gets the log output for a job from the storage account associated with a specifi Get-AzureRmHDInsightJobOutput [-ClusterName] [-JobId] [[-DefaultContainer] ] [[-DefaultStorageAccountName] ] [[-DefaultStorageAccountKey] ] [-HttpCredential] [-ResourceGroupName ] [-DisplayOutputType ] - [] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -78,6 +79,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DefaultStorageAccountKey Specifies the default Storage account key. diff --git a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Get-AzureRmHDInsightOperationsManagementSuite.md b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Get-AzureRmHDInsightOperationsManagementSuite.md index 3f6638325e9c..2def9293f2ca 100644 --- a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Get-AzureRmHDInsightOperationsManagementSuite.md +++ b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Get-AzureRmHDInsightOperationsManagementSuite.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml +Module Name: AzureRM.HDInsight online version: schema: 2.0.0 --- @@ -13,7 +14,7 @@ Gets the status of Operations Management Suite (OMS) installation on the cluster ``` Get-AzureRmHDInsightOperationsManagementSuite [-Name] [-ResourceGroupName ] - [] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -67,6 +68,21 @@ Operations Management Suite (OMS) is disabled on the cluster because the Cluster ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name The name of the cluster to get the status of Operations Management Suite(OMS). diff --git a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Get-AzureRmHDInsightPersistedScriptAction.md b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Get-AzureRmHDInsightPersistedScriptAction.md index fe1a7d4cd26d..d965460a3f01 100644 --- a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Get-AzureRmHDInsightPersistedScriptAction.md +++ b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Get-AzureRmHDInsightPersistedScriptAction.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml +Module Name: AzureRM.HDInsight ms.assetid: 2B7C1B83-EEEA-4BD1-9E9B-1F3070295995 online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Gets the persisted script actions for a cluster and lists them in chronological ``` Get-AzureRmHDInsightPersistedScriptAction [-ClusterName] [[-Name] ] - [-ResourceGroupName ] [] + [-ResourceGroupName ] [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -46,6 +47,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Specifies the name of the persisted script action. diff --git a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Get-AzureRmHDInsightProperties.md b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Get-AzureRmHDInsightProperties.md index ab897e330cdf..542a450a58d1 100644 --- a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Get-AzureRmHDInsightProperties.md +++ b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Get-AzureRmHDInsightProperties.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml +Module Name: AzureRM.HDInsight ms.assetid: 606C5453-F841-4574-95F8-5CC29A4186E1 online version: schema: 2.0.0 @@ -13,7 +14,8 @@ Gets properties about the HDInsight service, such as available locations and cap ## SYNTAX ``` -Get-AzureRmHDInsightProperties [-Location] [] +Get-AzureRmHDInsightProperties [-Location] [-DefaultProfile ] + [] ``` ## DESCRIPTION @@ -30,6 +32,21 @@ This command gets properties from an HDInsight service from location East US 2. ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Location Specifies the location for which to fetch HDInsight properties. diff --git a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Get-AzureRmHDInsightScriptActionHistory.md b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Get-AzureRmHDInsightScriptActionHistory.md index b5c1fc6aec27..d7f389068d60 100644 --- a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Get-AzureRmHDInsightScriptActionHistory.md +++ b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Get-AzureRmHDInsightScriptActionHistory.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml +Module Name: AzureRM.HDInsight ms.assetid: CE690DB0-0CD4-4841-B219-C208173D4730 online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Gets the script action history for a cluster and lists it in reverse chronologic ``` Get-AzureRmHDInsightScriptActionHistory [-ClusterName] [[-ScriptExecutionId] ] - [-ResourceGroupName ] [] + [-ResourceGroupName ] [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -46,6 +47,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of the resource group. diff --git a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Grant-AzureRmHDInsightHttpServicesAccess.md b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Grant-AzureRmHDInsightHttpServicesAccess.md index 58141f1a1ac3..c1d659a88f0c 100644 --- a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Grant-AzureRmHDInsightHttpServicesAccess.md +++ b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Grant-AzureRmHDInsightHttpServicesAccess.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml +Module Name: AzureRM.HDInsight ms.assetid: 3F321D94-2B0B-48CA-9778-8090373F7FE0 online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Grants HTTP access to the cluster. ``` Grant-AzureRmHDInsightHttpServicesAccess [-ClusterName] [-HttpCredential] - [-ResourceGroupName ] [] + [-ResourceGroupName ] [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -52,6 +53,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -HttpCredential Specifies the cluster login (HTTP) credentials for the cluster. diff --git a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Grant-AzureRmHDInsightRdpServicesAccess.md b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Grant-AzureRmHDInsightRdpServicesAccess.md index 714de584bd8a..ec21c5d5e8d0 100644 --- a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Grant-AzureRmHDInsightRdpServicesAccess.md +++ b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Grant-AzureRmHDInsightRdpServicesAccess.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml +Module Name: AzureRM.HDInsight ms.assetid: 6288DD8A-FF23-4B12-A065-856DBAE200E8 online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Grants RDP access to the Windows cluster. ``` Grant-AzureRmHDInsightRdpServicesAccess [-ClusterName] [-RdpCredential] - [-RdpAccessExpiry] [-ResourceGroupName ] [] + [-RdpAccessExpiry] [-ResourceGroupName ] [-DefaultProfile ] + [] ``` ## DESCRIPTION @@ -53,6 +55,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RdpAccessExpiry Specifies the expiration, as a **DateTime** object, for RDP access to a cluster. diff --git a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Invoke-AzureRmHDInsightHiveJob.md b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Invoke-AzureRmHDInsightHiveJob.md index 4c7a0a57498d..b51a63f012b4 100644 --- a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Invoke-AzureRmHDInsightHiveJob.md +++ b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Invoke-AzureRmHDInsightHiveJob.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml +Module Name: AzureRM.HDInsight ms.assetid: 3C6DCC81-82F7-4044-AFBC-4EE1BCC306F2 online version: schema: 2.0.0 @@ -16,7 +17,7 @@ Submits a Hive query to an HDInsight cluster and retrieves query results in one Invoke-AzureRmHDInsightHiveJob [-Arguments ] [-Files ] [-StatusFolder ] [-Defines ] [-File ] [-JobName ] [-Query ] [-RunAsFileJob] [-DefaultContainer ] [-DefaultStorageAccountName ] [-DefaultStorageAccountKey ] - [] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -89,6 +90,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DefaultStorageAccountKey Specifies the account key for the default storage account that the HDInsight cluster uses. diff --git a/src/ResourceManager/HDInsight/Commands.HDInsight/help/New-AzureRmHDInsightCluster.md b/src/ResourceManager/HDInsight/Commands.HDInsight/help/New-AzureRmHDInsightCluster.md index ca6862113bb7..0230af4e0904 100644 --- a/src/ResourceManager/HDInsight/Commands.HDInsight/help/New-AzureRmHDInsightCluster.md +++ b/src/ResourceManager/HDInsight/Commands.HDInsight/help/New-AzureRmHDInsightCluster.md @@ -30,7 +30,8 @@ New-AzureRmHDInsightCluster [-Location] [-ResourceGroupName] [ [-VirtualNetworkId ] [-SubnetName ] [-OSType ] [-ClusterTier ] [-SshCredential ] [-SshPublicKey ] [-RdpCredential ] [-RdpAccessExpiry ] [-ObjectId ] [-CertificatePassword ] [-AadTenantId ] - [-SecurityProfile ] [-DisksPerWorkerNode ] [] + [-SecurityProfile ] [-DisksPerWorkerNode ] + [-DefaultProfile ] [] ``` ### CertificateFilePath @@ -51,7 +52,7 @@ New-AzureRmHDInsightCluster [-Location] [-ResourceGroupName] [ [-SshCredential ] [-SshPublicKey ] [-RdpCredential ] [-RdpAccessExpiry ] [-ObjectId ] [-CertificateFilePath ] [-CertificatePassword ] [-AadTenantId ] [-SecurityProfile ] - [-DisksPerWorkerNode ] [] + [-DisksPerWorkerNode ] [-DefaultProfile ] [] ``` ### CertificateFileContents @@ -72,7 +73,7 @@ New-AzureRmHDInsightCluster [-Location] [-ResourceGroupName] [ [-SshCredential ] [-SshPublicKey ] [-RdpCredential ] [-RdpAccessExpiry ] [-ObjectId ] [-CertificateFileContents ] [-CertificatePassword ] [-AadTenantId ] [-SecurityProfile ] - [-DisksPerWorkerNode ] [] + [-DisksPerWorkerNode ] [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -89,6 +90,8 @@ The New-AzureHDInsightCluster creates an Azure HDInsight cluster by using the sp + + ``` PS C:\> # Primary storage account info $storageAccountResourceGroupName = "Group" @@ -312,6 +315,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DefaultStorageAccountKey Specifies the account key for the default Azure Storage account that the HDInsight cluster will use. You can alternatively use the Set-AzureRmHDInsightDefaultStorage cmdlet. diff --git a/src/ResourceManager/HDInsight/Commands.HDInsight/help/New-AzureRmHDInsightClusterConfig.md b/src/ResourceManager/HDInsight/Commands.HDInsight/help/New-AzureRmHDInsightClusterConfig.md index 66941a4188ed..31677b8e6b7f 100644 --- a/src/ResourceManager/HDInsight/Commands.HDInsight/help/New-AzureRmHDInsightClusterConfig.md +++ b/src/ResourceManager/HDInsight/Commands.HDInsight/help/New-AzureRmHDInsightClusterConfig.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml +Module Name: AzureRM.HDInsight ms.assetid: 2C06626F-E5A9-48C2-AEA2-B448AD254C2E online version: schema: 2.0.0 @@ -18,7 +19,8 @@ New-AzureRmHDInsightClusterConfig [-DefaultStorageAccountName ] [-Defaul [-HiveMetastore ] [-HeadNodeSize ] [-WorkerNodeSize ] [-EdgeNodeSize ] [-ZookeeperNodeSize ] [-ClusterType ] [-ClusterTier ] [-ObjectId ] [-CertificateFileContents ] [-CertificateFilePath ] - [-CertificatePassword ] [-AadTenantId ] [] + [-CertificatePassword ] [-AadTenantId ] [-DefaultProfile ] + [] ``` ## DESCRIPTION @@ -173,6 +175,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DefaultStorageAccountKey Specifies the account key for the default Azure Storage account that the HDInsight cluster will use. diff --git a/src/ResourceManager/HDInsight/Commands.HDInsight/help/New-AzureRmHDInsightHiveJobDefinition.md b/src/ResourceManager/HDInsight/Commands.HDInsight/help/New-AzureRmHDInsightHiveJobDefinition.md index f27f1a1df06c..959d8af36ba2 100644 --- a/src/ResourceManager/HDInsight/Commands.HDInsight/help/New-AzureRmHDInsightHiveJobDefinition.md +++ b/src/ResourceManager/HDInsight/Commands.HDInsight/help/New-AzureRmHDInsightHiveJobDefinition.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml +Module Name: AzureRM.HDInsight ms.assetid: 580D3388-4E18-4E67-866F-1FCF5E54AB3A online version: schema: 2.0.0 @@ -15,7 +16,7 @@ Creates a Hive job object. ``` New-AzureRmHDInsightHiveJobDefinition [-Arguments ] [-Files ] [-StatusFolder ] [-Defines ] [-File ] [-JobName ] [-Query ] [-RunAsFileJob] - [] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -60,6 +61,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Defines Specifies Hadoop configuration values to set for when the job runs. diff --git a/src/ResourceManager/HDInsight/Commands.HDInsight/help/New-AzureRmHDInsightMapReduceJobDefinition.md b/src/ResourceManager/HDInsight/Commands.HDInsight/help/New-AzureRmHDInsightMapReduceJobDefinition.md index e6068a79d215..8b9361ae869e 100644 --- a/src/ResourceManager/HDInsight/Commands.HDInsight/help/New-AzureRmHDInsightMapReduceJobDefinition.md +++ b/src/ResourceManager/HDInsight/Commands.HDInsight/help/New-AzureRmHDInsightMapReduceJobDefinition.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml +Module Name: AzureRM.HDInsight ms.assetid: 6BF6F9A7-BED3-4CCE-9E0A-46ECBFF55DA9 online version: schema: 2.0.0 @@ -15,7 +16,7 @@ Creates a MapReduce job object. ``` New-AzureRmHDInsightMapReduceJobDefinition [-Arguments ] [-Files ] [-StatusFolder ] -ClassName [-Defines ] -JarFile [-JobName ] [-LibJars ] - [] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -72,6 +73,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Defines Specifies Hadoop configuration values to set for when the job runs. diff --git a/src/ResourceManager/HDInsight/Commands.HDInsight/help/New-AzureRmHDInsightPigJobDefinition.md b/src/ResourceManager/HDInsight/Commands.HDInsight/help/New-AzureRmHDInsightPigJobDefinition.md index 3ddf568d2707..478c5870145a 100644 --- a/src/ResourceManager/HDInsight/Commands.HDInsight/help/New-AzureRmHDInsightPigJobDefinition.md +++ b/src/ResourceManager/HDInsight/Commands.HDInsight/help/New-AzureRmHDInsightPigJobDefinition.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml +Module Name: AzureRM.HDInsight ms.assetid: B9BA5FD1-A4F8-4E24-8FCB-847649B82AB6 online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Creates a Pig job object. ``` New-AzureRmHDInsightPigJobDefinition [-Arguments ] [-Files ] [-StatusFolder ] - [-File ] [-Query ] [] + [-File ] [-Query ] [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -59,6 +60,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -File Specifies the path to a file that contains the query to run. The file must be available on the storage account associated with the cluster. diff --git a/src/ResourceManager/HDInsight/Commands.HDInsight/help/New-AzureRmHDInsightSqoopJobDefinition.md b/src/ResourceManager/HDInsight/Commands.HDInsight/help/New-AzureRmHDInsightSqoopJobDefinition.md index 3ae055eb2210..5014a4381ec5 100644 --- a/src/ResourceManager/HDInsight/Commands.HDInsight/help/New-AzureRmHDInsightSqoopJobDefinition.md +++ b/src/ResourceManager/HDInsight/Commands.HDInsight/help/New-AzureRmHDInsightSqoopJobDefinition.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml +Module Name: AzureRM.HDInsight ms.assetid: 4ED47646-542B-4983-B46B-B603BE33D499 online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Creates a Sqoop job object. ``` New-AzureRmHDInsightSqoopJobDefinition [-Files ] [-StatusFolder ] [-File ] - [-Command ] [-LibDir ] [] + [-Command ] [-LibDir ] [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -53,6 +54,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -File Specifies the path to a file that contains the query to run. The file must be available on the Storage account associated with the cluster. diff --git a/src/ResourceManager/HDInsight/Commands.HDInsight/help/New-AzureRmHDInsightStreamingMapReduceJobDefinition.md b/src/ResourceManager/HDInsight/Commands.HDInsight/help/New-AzureRmHDInsightStreamingMapReduceJobDefinition.md index 93cafc7c2731..4176f1664db7 100644 --- a/src/ResourceManager/HDInsight/Commands.HDInsight/help/New-AzureRmHDInsightStreamingMapReduceJobDefinition.md +++ b/src/ResourceManager/HDInsight/Commands.HDInsight/help/New-AzureRmHDInsightStreamingMapReduceJobDefinition.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml +Module Name: AzureRM.HDInsight ms.assetid: 17CB76E7-2F91-4EFE-9DA3-F083F02235E1 online version: schema: 2.0.0 @@ -15,7 +16,8 @@ Creates a Streaming MapReduce job object. ``` New-AzureRmHDInsightStreamingMapReduceJobDefinition [-Arguments ] [-File ] [-Files ] [-StatusFolder ] [-CommandEnvironment ] [-Defines ] - -InputPath [-Mapper ] [-OutputPath ] [-Reducer ] [] + -InputPath [-Mapper ] [-OutputPath ] [-Reducer ] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -75,6 +77,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Defines Specifies Hadoop configuration values to set for when the job runs. diff --git a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Remove-AzureRmHDInsightCluster.md b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Remove-AzureRmHDInsightCluster.md index 68fffb67d8ed..2f45b026f28e 100644 --- a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Remove-AzureRmHDInsightCluster.md +++ b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Remove-AzureRmHDInsightCluster.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml +Module Name: AzureRM.HDInsight ms.assetid: 87B3C102-0A8C-4FFA-8429-594D2360AC32 online version: schema: 2.0.0 @@ -13,7 +14,8 @@ Removes the specified HDInsight cluster from the current subscription. ## SYNTAX ``` -Remove-AzureRmHDInsightCluster [-ClusterName] [-ResourceGroupName ] [] +Remove-AzureRmHDInsightCluster [-ClusterName] [-ResourceGroupName ] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -48,6 +50,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of the resource group. diff --git a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Remove-AzureRmHDInsightPersistedScriptAction.md b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Remove-AzureRmHDInsightPersistedScriptAction.md index 4b9b65a06f41..2c5e51f0d286 100644 --- a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Remove-AzureRmHDInsightPersistedScriptAction.md +++ b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Remove-AzureRmHDInsightPersistedScriptAction.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml +Module Name: AzureRM.HDInsight ms.assetid: 08D1D6AC-D064-4E2D-9C22-0B65E7BE4DA7 online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Removes an persisted script action from an HDInsight cluster. ``` Remove-AzureRmHDInsightPersistedScriptAction [-ClusterName] [-Name] - [-ResourceGroupName ] [] + [-ResourceGroupName ] [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -49,6 +50,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Specifies the name of the persisted script action to be removed. diff --git a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Revoke-AzureRmHDInsightHttpServicesAccess.md b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Revoke-AzureRmHDInsightHttpServicesAccess.md index 30f5c889d792..bd61c18e9e94 100644 --- a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Revoke-AzureRmHDInsightHttpServicesAccess.md +++ b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Revoke-AzureRmHDInsightHttpServicesAccess.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml +Module Name: AzureRM.HDInsight ms.assetid: 670EAFC0-3F8D-4F3D-8B62-448F04378F8B online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Disables HTTP access to the cluster. ``` Revoke-AzureRmHDInsightHttpServicesAccess [-ClusterName] [-ResourceGroupName ] - [] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -47,6 +48,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of the resource group. diff --git a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Revoke-AzureRmHDInsightRdpServicesAccess.md b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Revoke-AzureRmHDInsightRdpServicesAccess.md index adccc6fdc894..b57331cececa 100644 --- a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Revoke-AzureRmHDInsightRdpServicesAccess.md +++ b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Revoke-AzureRmHDInsightRdpServicesAccess.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml +Module Name: AzureRM.HDInsight ms.assetid: 8C6D9533-68FD-4AFF-91FB-8307A8C8EAEB online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Disables RDP access to a Windows cluster. ``` Revoke-AzureRmHDInsightRdpServicesAccess [-ClusterName] [-ResourceGroupName ] - [] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -46,6 +47,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of the resource group. diff --git a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Set-AzureRmHDInsightClusterSize.md b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Set-AzureRmHDInsightClusterSize.md index 47b8fb11062b..dbd0e583f888 100644 --- a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Set-AzureRmHDInsightClusterSize.md +++ b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Set-AzureRmHDInsightClusterSize.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml +Module Name: AzureRM.HDInsight ms.assetid: A9A8C4B9-6346-4186-9D73-3A56437BFB2F online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Sets the number of Worker nodes in a specified cluster. ``` Set-AzureRmHDInsightClusterSize [-ClusterName] [-TargetInstanceCount] - [-ResourceGroupName ] [] + [-ResourceGroupName ] [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -46,6 +47,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of the resource group. diff --git a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Set-AzureRmHDInsightDefaultStorage.md b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Set-AzureRmHDInsightDefaultStorage.md index ac6af1cef5a6..6edd51a242e6 100644 --- a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Set-AzureRmHDInsightDefaultStorage.md +++ b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Set-AzureRmHDInsightDefaultStorage.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml +Module Name: AzureRM.HDInsight ms.assetid: 37E41DA2-B65B-4AA2-B6AB-F93CCA881C72 online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Sets the default Storage account setting in a cluster configuration object. ``` Set-AzureRmHDInsightDefaultStorage [-Config] [-StorageAccountName] - [[-StorageAccountKey] ] [-StorageAccountType ] [] + [[-StorageAccountKey] ] [-StorageAccountType ] [-DefaultProfile ] + [] ``` ## DESCRIPTION @@ -77,6 +79,21 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -StorageAccountKey Specifies the account key for the default Azure Storage account that the HDInsight cluster will use. @@ -129,7 +146,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### AzureHDInsightConfig - Parameter 'Config' accepts value of type 'AzureHDInsightConfig' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Set-AzureRmHDInsightPersistedScriptAction.md b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Set-AzureRmHDInsightPersistedScriptAction.md index cda716c16cb5..6c8856868866 100644 --- a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Set-AzureRmHDInsightPersistedScriptAction.md +++ b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Set-AzureRmHDInsightPersistedScriptAction.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml +Module Name: AzureRM.HDInsight ms.assetid: 92F21752-4FB6-4162-B542-DA25ACA3340B online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Sets a previously executed script action to be a persisted script action. ``` Set-AzureRmHDInsightPersistedScriptAction [-ClusterName] [-ScriptExecutionId] - [-ResourceGroupName ] [] + [-ResourceGroupName ] [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -50,6 +51,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of the resource group. diff --git a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Start-AzureRmHDInsightJob.md b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Start-AzureRmHDInsightJob.md index d45e6a2658a5..5c76efd70565 100644 --- a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Start-AzureRmHDInsightJob.md +++ b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Start-AzureRmHDInsightJob.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml +Module Name: AzureRM.HDInsight ms.assetid: 0225C7CA-74B4-4ACC-870C-9539DF6ECC47 online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Starts a defined Azure HDInsight job on a specified cluster. ``` Start-AzureRmHDInsightJob [-ClusterName] [-JobDefinition] - [-HttpCredential] [-ResourceGroupName ] [] + [-HttpCredential] [-ResourceGroupName ] [-DefaultProfile ] + [] ``` ## DESCRIPTION @@ -59,6 +61,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -HttpCredential Specifies the cluster login (HTTP) credentials for the cluster. @@ -110,7 +127,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### AzureHDInsightJobDefinition - Parameter 'JobDefinition' accepts value of type 'AzureHDInsightJobDefinition' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Stop-AzureRmHDInsightJob.md b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Stop-AzureRmHDInsightJob.md index 7ee4e8f97639..bf239aa7e9dc 100644 --- a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Stop-AzureRmHDInsightJob.md +++ b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Stop-AzureRmHDInsightJob.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml +Module Name: AzureRM.HDInsight ms.assetid: FD27C755-9AAF-42DA-8425-1661C92B6C68 online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Stops a specified running job on a cluster. ``` Stop-AzureRmHDInsightJob [-ClusterName] [-JobId] [-HttpCredential] - [-ResourceGroupName ] [] + [-ResourceGroupName ] [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -52,6 +53,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -HttpCredential Specifies the cluster login (HTTP) credentials for the cluster. @@ -103,7 +119,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### String - Parameter 'JobId' accepts value of type 'String' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Submit-AzureRmHDInsightScriptAction.md b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Submit-AzureRmHDInsightScriptAction.md index 53779de40401..600eb07fd6f8 100644 --- a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Submit-AzureRmHDInsightScriptAction.md +++ b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Submit-AzureRmHDInsightScriptAction.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml +Module Name: AzureRM.HDInsight ms.assetid: 15C5D659-472B-41DD-806A-A0A175434EE3 online version: schema: 2.0.0 @@ -15,7 +16,8 @@ Submits a new script action to an Azure HDInsight cluster. ``` Submit-AzureRmHDInsightScriptAction [-ClusterName] [-Name] [-Uri] [-NodeTypes] [[-Parameters] ] [[-ApplicationName] ] - [-PersistOnSuccess] [-ResourceGroupName ] [] + [-PersistOnSuccess] [-ResourceGroupName ] [-DefaultProfile ] + [] ``` ## DESCRIPTION @@ -68,6 +70,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Specifies the name of the script action. diff --git a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Use-AzureRmHDInsightCluster.md b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Use-AzureRmHDInsightCluster.md index a736df3f736f..a45d004ff13e 100644 --- a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Use-AzureRmHDInsightCluster.md +++ b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Use-AzureRmHDInsightCluster.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml +Module Name: AzureRM.HDInsight ms.assetid: 92E876FE-AA7B-43AA-915F-D02AC5CEF0CA online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Selects a cluster to be used with the Invoke-RmAzureHDInsightHiveJob cmdlet. ``` Use-AzureRmHDInsightCluster [-ClusterName] [-HttpCredential] - [-ResourceGroupName ] [] + [-ResourceGroupName ] [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -52,6 +53,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -HttpCredential Specifies the cluster login (HTTP) credentials for the cluster. diff --git a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Wait-AzureRmHDInsightJob.md b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Wait-AzureRmHDInsightJob.md index b093716e4521..32910b1a2a9a 100644 --- a/src/ResourceManager/HDInsight/Commands.HDInsight/help/Wait-AzureRmHDInsightJob.md +++ b/src/ResourceManager/HDInsight/Commands.HDInsight/help/Wait-AzureRmHDInsightJob.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.HDInsight.dll-Help.xml +Module Name: AzureRM.HDInsight ms.assetid: 677E19F2-CC6C-4C16-B1FD-3A15D0FF1ECA online version: schema: 2.0.0 @@ -15,7 +16,7 @@ Waits for the completion or failure of a specified job. ``` Wait-AzureRmHDInsightJob [-ClusterName] [-JobId] [-HttpCredential] [-ResourceGroupName ] [-TimeoutInSeconds ] [-WaitIntervalInSeconds ] - [] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -63,6 +64,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -HttpCredential Specifies the cluster login (HTTP) credentials for the cluster. @@ -144,7 +160,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### String - Parameter 'JobId' accepts value of type 'String' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/Insights/Commands.Insights/help/Add-AzureRmAutoscaleSetting.md b/src/ResourceManager/Insights/Commands.Insights/help/Add-AzureRmAutoscaleSetting.md index 13270fbc2b4d..da354db90937 100644 --- a/src/ResourceManager/Insights/Commands.Insights/help/Add-AzureRmAutoscaleSetting.md +++ b/src/ResourceManager/Insights/Commands.Insights/help/Add-AzureRmAutoscaleSetting.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml +Module Name: AzureRM.Insights ms.assetid: 7436F31F-9DCB-4365-BA6D-41BDB5D7FCB6 online version: schema: 2.0.0 @@ -15,18 +16,18 @@ Creates an Autoscale setting. ### Parameters for Add-AzureRmAutoscaleSetting cmdlet in the update semantics ``` Add-AzureRmAutoscaleSetting -SettingSpec -ResourceGroup [-DisableSetting] - [-AutoscaleProfiles ] - [-Notifications ] - [] + [-AutoscaleProfiles ] + [-Notifications ] + [-DefaultProfile ] [] ``` ### Parameters for Add-AzureRmAutoscaleSetting cmdlet in the create semantics ``` Add-AzureRmAutoscaleSetting -Location -Name -ResourceGroup [-DisableSetting] - [-AutoscaleProfiles ] + [-AutoscaleProfiles ] -TargetResourceId - [-Notifications ] - [] + [-Notifications ] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -59,7 +60,7 @@ The final command creates an Autoscale setting using the profiles in $Profile1 a Specifies a list of profiles to add to the Autoscale setting, or $Null to add no profile. ```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Management.Insights.Models.AutoscaleProfile] +Type: System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.AutoscaleProfile] Parameter Sets: (All) Aliases: @@ -70,6 +71,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DisableSetting Disables an existing Autoscale setting. @@ -119,7 +135,7 @@ Accept wildcard characters: False Specifies a list of comma-separated notifications. ```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Management.Insights.Models.AutoscaleNotification] +Type: System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.AutoscaleNotification] Parameter Sets: (All) Aliases: diff --git a/src/ResourceManager/Insights/Commands.Insights/help/Add-AzureRmLogAlertRule.md b/src/ResourceManager/Insights/Commands.Insights/help/Add-AzureRmLogAlertRule.md index 68630d31d66b..b1d8daa61ecc 100644 --- a/src/ResourceManager/Insights/Commands.Insights/help/Add-AzureRmLogAlertRule.md +++ b/src/ResourceManager/Insights/Commands.Insights/help/Add-AzureRmLogAlertRule.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml +Module Name: AzureRM.Insights ms.assetid: 11A521DF-E77C-4D6F-A2D9-1C2CF8972F57 online version: schema: 2.0.0 @@ -16,8 +17,8 @@ Adds or replaces a log alert rule. Add-AzureRmLogAlertRule [-TargetResourceGroup ] [-TargetResourceId ] [-Level ] -OperationName [-TargetResourceProvider ] [-Status ] [-SubStatus ] -Location [-Description ] [-DisableRule] -ResourceGroup -Name - [-Actions ] - [] + [-Actions ] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -44,7 +45,7 @@ This command adds or updates an event-based alert rule. Specifies a comma-separated list of actions. ```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Management.Insights.Models.RuleAction] +Type: System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.RuleAction] Parameter Sets: (All) Aliases: @@ -55,6 +56,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Description Specifies a description of the rule. diff --git a/src/ResourceManager/Insights/Commands.Insights/help/Add-AzureRmLogProfile.md b/src/ResourceManager/Insights/Commands.Insights/help/Add-AzureRmLogProfile.md index f507e881ecdf..06ebb2805b3a 100644 --- a/src/ResourceManager/Insights/Commands.Insights/help/Add-AzureRmLogProfile.md +++ b/src/ResourceManager/Insights/Commands.Insights/help/Add-AzureRmLogProfile.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml +Module Name: AzureRM.Insights ms.assetid: 18D5B95E-4CF1-4C79-AE8B-9F4DA49B46A9 online version: schema: 2.0.0 @@ -23,16 +24,18 @@ In the activity log, events can pertain to a region or could be "Global". Global ``` Add-AzureRmLogProfile -Name [-StorageAccountId ] [-ServiceBusRuleId ] [-RetentionInDays ] -Locations - [-Categories ] [] + [-Categories ] [-DefaultProfile ] + [] ``` ## DESCRIPTION The **Add-AzureRmLogProfile** cmdlet creates a log profile. ## EXAMPLES -### Example 1 : Add a new log profile to export the activity log matching the location condition to a storage account -```yaml -Add-AzureRmLogProfile -Locations "Global","West US" -Name ExportLogProfile -StorageAccountId /subscriptions/40gpe80s-9sb7-4f07-9042-b1b6a92ja9fk/resourceGroups/activitylogRG/providers/Microsoft.Storage/storageAccounts/activitylogstorageaccount + +### Example 1 : Add a new log profile to export the activity log matching the location condition to a storage account +``` +Add-AzureRmLogProfile -Locations "Global","West US" -Name ExportLogProfile -StorageAccountId /subscriptions/40gpe80s-9sb7-4f07-9042-b1b6a92ja9fk/resourceGroups/activitylogRG/providers/Microsoft.Storage/storageAccounts/activitylogstorageaccount ``` ## PARAMETERS @@ -52,6 +55,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Locations Specifies the location of the log profile. Valid values: Run below cmdlet to get the latest list of locations. diff --git a/src/ResourceManager/Insights/Commands.Insights/help/Add-AzureRmMetricAlertRule.md b/src/ResourceManager/Insights/Commands.Insights/help/Add-AzureRmMetricAlertRule.md index afc1e88b2680..2ef6342b39bc 100644 --- a/src/ResourceManager/Insights/Commands.Insights/help/Add-AzureRmMetricAlertRule.md +++ b/src/ResourceManager/Insights/Commands.Insights/help/Add-AzureRmMetricAlertRule.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml +Module Name: AzureRM.Insights ms.assetid: A90564B5-57D7-48EB-976D-38C03D930289 online version: schema: 2.0.0 @@ -16,8 +17,8 @@ Adds or updates a metric-based alert rule. Add-AzureRmMetricAlertRule -WindowSize -Operator -Threshold -TargetResourceId -MetricName -TimeAggregationOperator -Location [-Description ] [-DisableRule] -ResourceGroup -Name - [-Actions ] - [] + [-Actions ] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -64,7 +65,7 @@ This command creates a metric alert rule for a website. Specifies a comma-separated list of actions. ```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Management.Insights.Models.RuleAction] +Type: System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.RuleAction] Parameter Sets: (All) Aliases: @@ -75,6 +76,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Description Specifies a description of the rule. diff --git a/src/ResourceManager/Insights/Commands.Insights/help/Add-AzureRmWebtestAlertRule.md b/src/ResourceManager/Insights/Commands.Insights/help/Add-AzureRmWebtestAlertRule.md index daf7e7a69118..ce1b2ad72623 100644 --- a/src/ResourceManager/Insights/Commands.Insights/help/Add-AzureRmWebtestAlertRule.md +++ b/src/ResourceManager/Insights/Commands.Insights/help/Add-AzureRmWebtestAlertRule.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml +Module Name: AzureRM.Insights ms.assetid: FBAE5F75-1E28-4F1C-A9ED-20075FFD4AC7 online version: schema: 2.0.0 @@ -16,8 +17,8 @@ Adds or updates a webtest alert rule. Add-AzureRmWebtestAlertRule -MetricName -TargetResourceUri -WindowSize -FailedLocationCount [-MetricNamespace ] -Location [-Description ] [-DisableRule] -ResourceGroup -Name - [-Actions ] - [] + [-Actions ] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -42,7 +43,7 @@ This command adds or updates a webtest alert rule. Specifies a comma-separated list of actions. ```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Management.Insights.Models.RuleAction] +Type: System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.RuleAction] Parameter Sets: (All) Aliases: @@ -53,6 +54,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Description Specifies a description of the rule. diff --git a/src/ResourceManager/Insights/Commands.Insights/help/AzureRM.Insights.md b/src/ResourceManager/Insights/Commands.Insights/help/AzureRM.Insights.md index fe2740b07ca3..068c036f785f 100644 --- a/src/ResourceManager/Insights/Commands.Insights/help/AzureRM.Insights.md +++ b/src/ResourceManager/Insights/Commands.Insights/help/AzureRM.Insights.md @@ -18,7 +18,15 @@ Creates an Autoscale setting. Adds or replaces a log alert rule. ### [Add-AzureRmLogProfile](Add-AzureRmLogProfile.md) -Creates a log profile. +Creates a new activity log profile. This profile is used to either archive the activity log to an Azure storage account or stream it to an Azure event hub in the same subscription. + +- **Storage Account** - Only standard storage account (premium storage account is not supported) is supported. It could either be of type ARM or Classic. If it's logged to a storage account, the cost of storing the activity log is billed at normal standard storage rates. There could be only one log profile per subscription consequentially only one storage account per subscription can be used to export activity log. + +- **Event Hub** - There could be only one log profile per subscription consequentially only one event hub per subscription can be used to export activity log. If activity log is streamed to an event hub, standard event hub pricing will apply. + +In the activity log, events can pertain to a region or could be "Global". Global essentially means these events are region agnostics and are independent of region, in fact majority of events fall into this category. If the activity log profile is set from the portal, it implicitly adds "Global" along with any other region selected in the user interface. When using the cmdlet, the location as "Global" must be explicitly mentioned apart from any other region. + +**Note** :- **Failing to set "Global" in the locations will result in a majority of activity log not getting exported.** ### [Add-AzureRmMetricAlertRule](Add-AzureRmMetricAlertRule.md) Adds or updates a metric-based alert rule. @@ -27,13 +35,16 @@ Adds or updates a metric-based alert rule. Adds or updates a webtest alert rule. ### [Disable-AzureRmActivityLogAlert](Disable-AzureRmActivityLogAlert.md) -Disables an activity log alert resource and optionally sets its tags. +Disables an activity log alert and sets its tags. ### [Enable-AzureRmActivityLogAlert](Enable-AzureRmActivityLogAlert.md) -Enables an activity log alert resource and optionally sets its tags. +Enables an activity log alert and sets its Tags. + +### [Get-AzureRmActionGroup](Get-AzureRmActionGroup.md) +Gets action group(s). ### [Get-AzureRmActivityLogAlert](Get-AzureRmActivityLogAlert.md) -Gets an activity log alert resource. +Gets one or more activity log alert resources. ### [Get-AzureRmAlertHistory](Get-AzureRmAlertHistory.md) Gets the history of alerts. @@ -66,10 +77,13 @@ Gets metric definitions. Gets the usage metrics for a resource. ### [New-AzureRmActionGroup](New-AzureRmActionGroup.md) -Creates a new action group reference in memory. +Creates an ActionGroup reference object in memory. + +### [New-AzureRmActionGroupReceiver](New-AzureRmActionGroupReceiver.md) +Creates an new action group receiver. ### [New-AzureRmActivityLogAlertCondition](New-AzureRmActivityLogAlertCondition.md) -Creates a new activity log alert condition in memory. +Creates an new activity log alert condition object in memory. ### [New-AzureRmAlertRuleEmail](New-AzureRmAlertRuleEmail.md) Creates an email action for an alert rule. @@ -89,6 +103,9 @@ Creates an Autoscale rule. ### [New-AzureRmAutoscaleWebhook](New-AzureRmAutoscaleWebhook.md) Creates an Autoscale webhook. +### [Remove-AzureRmActionGroup](Remove-AzureRmActionGroup.md) +Removes an action group. + ### [Remove-AzureRmActivityLogAlert](Remove-AzureRmActivityLogAlert.md) Removes an activity log alert. @@ -101,8 +118,12 @@ Removes an Autoscale setting. ### [Remove-AzureRmLogProfile](Remove-AzureRmLogProfile.md) Removes a log profile. +### [Set-AzureRmActionGroup](Set-AzureRmActionGroup.md) +Creates a new or updates an existing action group. + ### [Set-AzureRmActivityLogAlert](Set-AzureRmActivityLogAlert.md) -Creates or updates an activity log alert. +Creates a new or sets an existing activity log alert. ### [Set-AzureRmDiagnosticSetting](Set-AzureRmDiagnosticSetting.md) Sets the logs and metrics settings for the resource. + diff --git a/src/ResourceManager/Insights/Commands.Insights/help/Disable-AzureRmActivityLogAlert.md b/src/ResourceManager/Insights/Commands.Insights/help/Disable-AzureRmActivityLogAlert.md index 97e5ce7548d7..9f9a911b138d 100644 --- a/src/ResourceManager/Insights/Commands.Insights/help/Disable-AzureRmActivityLogAlert.md +++ b/src/ResourceManager/Insights/Commands.Insights/help/Disable-AzureRmActivityLogAlert.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml +Module Name: AzureRM.Insights ms.assetid: B5F2388E-0136-4F8A-8577-67CE2A45671E online version: schema: 2.0.0 @@ -12,8 +13,22 @@ Disables an activity log alert and sets its tags. ## SYNTAX +### Default parameters for disable an activity log alert ``` -Disable-AzureRmActivityLogAlert [-InputObject ] [-ResourceId ] [-Name -ResourceGroupName ] [] +Disable-AzureRmActivityLogAlert -Name -ResourceGroupName + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### Parameters to disable an activity log alerts taking value from the pipe +``` +Disable-AzureRmActivityLogAlert -InputObject + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### Parameters to disable an activity log alerts taking the value of ResourceId from the pipe +``` +Disable-AzureRmActivityLogAlert -ResourceId [-DefaultProfile ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -33,7 +48,6 @@ This command changes the tags property of the activity log alert called alert1 a ### Example 2: Disable an activity log alert using a PSActivityLogAlertResource object as input ``` - PS C:\>$obj = Get-AzureRmActivityLogAlert -ResourceGroup "Default-activityLogAlerts" -Name "alert1" PS C:\>Disable-AzureRmActivityLogAlert -InputObject $obj ``` @@ -42,37 +56,49 @@ This command disables an activity log alert called alert1. For this it uses a PS ### Example 3: Disable the ActivityLogAlert using the ResourceId parameter ``` - PS C:\>Find-AzureRmResource -ResourceGroupEquals "myResourceGroup" -ResourceNameEquals "myLogAlert" | Disable-AzureRmActivityLogAlert - ``` This command disables the ActivityLogAlert using the ResourceId parameter from the pipe. - ## PARAMETERS -### -Name -The name of the activity log alert. +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure ```yaml -Type: System.String -Parameter Sets: DisableActivityLogAlertDeafultParamGroup +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Sets the InputObject tags property of the call to extract the required name, resource group name, and the optional tag properties. + +```yaml +Type: PSActivityLogAlertResource +Parameter Sets: Parameters to disable an activity log alerts taking value from the pipe Aliases: Required: True Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -ResourceGroupName -The name of the resource group where the alert resource is going to exist. +### -Name +The name of the activity log alert. ```yaml -Type: System.String -Parameter Sets: DisableActivityLogAlertDeafultParamGroup +Type: String +Parameter Sets: Default parameters for disable an activity log alert Aliases: Required: True @@ -82,18 +108,18 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -InputObject -Sets the InputObject tags property of the call to extract the required name, resource group name, and the optional tag properties. +### -ResourceGroupName +The name of the resource group where the alert resource is going to exist. ```yaml -Type: Microsoft.Azure.Commands.Insights.OutputClasses.PSActivityLogAlertResource -Parameter Sets: DisableActivityLogAlertFromPipeParamGroup +Type: String +Parameter Sets: Default parameters for disable an activity log alert Aliases: Required: True Position: Named Default value: None -Accept pipeline input: True (FromPipeline) +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` @@ -101,8 +127,8 @@ Accept wildcard characters: False Sets the ResourceId tags property of the call to extract the required name, resource group name properties. ```yaml -Type: System.String -Parameter Sets: DisableActivityLogAlertFromResourceIdParamGroup +Type: String +Parameter Sets: Parameters to disable an activity log alerts taking the value of ResourceId from the pipe Aliases: Required: True @@ -112,6 +138,36 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/src/ResourceManager/Insights/Commands.Insights/help/Enable-AzureRmActivityLogAlert.md b/src/ResourceManager/Insights/Commands.Insights/help/Enable-AzureRmActivityLogAlert.md index 27bb1dfc5e71..a62b75689e40 100644 --- a/src/ResourceManager/Insights/Commands.Insights/help/Enable-AzureRmActivityLogAlert.md +++ b/src/ResourceManager/Insights/Commands.Insights/help/Enable-AzureRmActivityLogAlert.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml +Module Name: AzureRM.Insights ms.assetid: B5F2388E-0136-4F8A-8577-67CE2A45671E online version: schema: 2.0.0 @@ -12,8 +13,22 @@ Enables an activity log alert and sets its Tags. ## SYNTAX +### Default parameters for enable an activity log alert ``` -Enable-AzureRmActivityLogAlert [-InputObject ] [-ResourceId ] [-Name -ResourceGroupName ] [] +Enable-AzureRmActivityLogAlert -Name -ResourceGroupName + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### Parameters to enable an activity log alerts taking value from the pipe +``` +Enable-AzureRmActivityLogAlert -InputObject + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### Parameters to enable an activity log alerts taking the value of ResourceId from the pipe +``` +Enable-AzureRmActivityLogAlert -ResourceId [-DefaultProfile ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -31,7 +46,6 @@ This command enables the activity log alert called alert1 in the resource group ### Example 2: Enable an activity log alert using a PSActivityLogAlertResource object as input ``` - PS C:\>$obj = Get-AzureRmActivityLogAlert -ResourceGroup "Default-activityLogAlerts" -Name "alert1" PS C:\>Enable-AzureRmActivityLogAlert -InputObject $obj ``` @@ -40,36 +54,49 @@ This command enables an activity log alert called alert1. For this it uses a PSA ### Example 3: Enable the ActivityLogAlert using the ResourceId parameter ``` - PS C:\>Find-AzureRmResource -ResourceGroupEquals "myResourceGroup" -ResourceNameEquals "myLogAlert" | Enable-AzureRmActivityLogAlert - ``` This command enables the ActivityLogAlert using the ResourceId parameter from the pipe. ## PARAMETERS -### -Name -The name of the activity log alert. +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Sets the InputObject tags property of the call to extract the required name, resource group name, and the optional tags properties. ```yaml -Type: System.String -Parameter Sets: EnableActivityLogAlertDeafultParamGroup +Type: PSActivityLogAlertResource +Parameter Sets: Parameters to enable an activity log alerts taking value from the pipe Aliases: Required: True Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -ResourceGroupName -The name of the resource group where the alert resource is going to exist. +### -Name +The name of the activity log alert. ```yaml -Type: System.String -Parameter Sets: EnableActivityLogAlertDeafultParamGroup +Type: String +Parameter Sets: Default parameters for enable an activity log alert Aliases: Required: True @@ -79,18 +106,18 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -InputObject -Sets the InputObject tags property of the call to extract the required name, resource group name, and the optional tags properties. +### -ResourceGroupName +The name of the resource group where the alert resource is going to exist. ```yaml -Type: Microsoft.Azure.Commands.Insights.OutputClasses.PSActivityLogAlertResource -Parameter Sets: EnableActivityLogAlertFromPipeParamGroup +Type: String +Parameter Sets: Default parameters for enable an activity log alert Aliases: Required: True Position: Named Default value: None -Accept pipeline input: True (FromPipeline) +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` @@ -98,8 +125,8 @@ Accept wildcard characters: False Sets the ResourceId tags property of the call to extract the required name, resource group name properties. ```yaml -Type: System.String -Parameter Sets: EnableActivityLogAlertFromResourceIdParamGroup +Type: String +Parameter Sets: Parameters to enable an activity log alerts taking the value of ResourceId from the pipe Aliases: Required: True @@ -109,6 +136,36 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmActionGroup.md b/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmActionGroup.md index 1b2750ff0ea9..32ab136377e1 100644 --- a/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmActionGroup.md +++ b/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmActionGroup.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml +Module Name: AzureRM.Insights ms.assetid: 1CA26790-C791-4BFD-B986-70F28E3B095B online version: schema: 2.0.0 @@ -12,8 +13,16 @@ Gets action group(s). ## SYNTAX +### BySubscriptionOrResourceGroup (Default) ``` -Get-AzureRmActionGroup [-Name ] [-ResourceGroup ] [] +Get-AzureRmActionGroup [-ResourceGroupName ] [-DefaultProfile ] + [] +``` + +### ByName +``` +Get-AzureRmActionGroup -ResourceGroupName -Name [-DefaultProfile ] + [] ``` ## DESCRIPTION @@ -44,28 +53,42 @@ This command lists one (a list with a single element) action group. ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name The name of the action group. ```yaml -Type: System.String -Parameter Sets: (All) +Type: String +Parameter Sets: ByName Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -ResourceGroup -The name of the resource group where the action group exists. -If Name is not null or empty, this parameter must contain and non empty string. +### -ResourceGroupName +The resource group name ```yaml -Type: System.String -Parameter Sets: (All) +Type: String +Parameter Sets: BySubscriptionOrResourceGroup Aliases: Required: False @@ -75,6 +98,18 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +```yaml +Type: String +Parameter Sets: ByName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmActivityLogAlert.md b/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmActivityLogAlert.md index 01da0f9d6db8..125c1186c3b1 100644 --- a/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmActivityLogAlert.md +++ b/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmActivityLogAlert.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml +Module Name: AzureRM.Insights ms.assetid: 85492E00-3776-4F20-A444-9C28CC6154B7 online version: schema: 2.0.0 @@ -12,8 +13,16 @@ Gets one or more activity log alert resources. ## SYNTAX +### Default parameters for get an activity log alert ``` -Get-AzureRmActivityLogAlert [-Name ] [-ResourceGroupName ] [] +Get-AzureRmActivityLogAlert [-ResourceGroupName] [-Name] + [-DefaultProfile ] [] +``` + +### Parameters to make sure the resource group is given when the name is given +``` +Get-AzureRmActivityLogAlert [[-ResourceGroupName] ] [-DefaultProfile ] + [] ``` ## DESCRIPTION @@ -44,17 +53,32 @@ This command lists one (a list with a single element) activity log alert. ## PARAMETERS -### -Name -The name of the activity log alert. +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure ```yaml -Type: System.String +Type: IAzureContextContainer Parameter Sets: (All) -Aliases: +Aliases: AzureRmContext, AzureCredential Required: False Position: Named Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The name of the activity log alert. + +```yaml +Type: String +Parameter Sets: Default parameters for get an activity log alert +Aliases: + +Required: True +Position: 1 +Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` @@ -64,12 +88,24 @@ The name of the resource group where the alert resource exists. If Name is not null or empty, this parameter must contain and non empty string. ```yaml -Type: System.String -Parameter Sets: (All) +Type: String +Parameter Sets: Default parameters for get an activity log alert +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: String +Parameter Sets: Parameters to make sure the resource group is given when the name is given Aliases: Required: False -Position: Named +Position: 0 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False diff --git a/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmAlertHistory.md b/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmAlertHistory.md index c30fa39b69e8..842b28d93c23 100644 --- a/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmAlertHistory.md +++ b/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmAlertHistory.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml +Module Name: AzureRM.Insights ms.assetid: 1EDFCAC4-6A66-4124-8192-B7F0D3C5BCFC online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Gets the history of alerts. ``` Get-AzureRmAlertHistory [-ResourceId ] [-StartTime ] [-EndTime ] [-Status ] - [-Caller ] [-DetailedOutput] [] + [-Caller ] [-DetailedOutput] [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -284,6 +285,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DetailedOutput Displays full details in the output. diff --git a/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmAlertRule.md b/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmAlertRule.md index b228e94e1258..8204b4090832 100644 --- a/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmAlertRule.md +++ b/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmAlertRule.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml +Module Name: AzureRM.Insights ms.assetid: A837077C-0A79-431C-93D2-799B2134EE69 online version: schema: 2.0.0 @@ -14,17 +15,20 @@ Gets alert rules. ### Parameters for Get-AzureRmAlertRule cmdlet ``` -Get-AzureRmAlertRule -ResourceGroup [-DetailedOutput] [] +Get-AzureRmAlertRule -ResourceGroup [-DetailedOutput] [-DefaultProfile ] + [] ``` ### Parameters for Get-AzureRmAlertRule cmdlet using name ``` -Get-AzureRmAlertRule -ResourceGroup -Name [-DetailedOutput] [] +Get-AzureRmAlertRule -ResourceGroup -Name [-DetailedOutput] + [-DefaultProfile ] [] ``` ### Parameters for Get-AzureRmAlertRule cmdlet using target resource uri ``` -Get-AzureRmAlertRule -ResourceGroup -TargetResourceId [-DetailedOutput] [] +Get-AzureRmAlertRule -ResourceGroup -TargetResourceId [-DetailedOutput] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -58,6 +62,21 @@ The *DetailedOutput* parameter is specified, so the output is detailed. ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DetailedOutput Displays full details in the output. diff --git a/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmAutoscaleHistory.md b/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmAutoscaleHistory.md index ae488b86397b..c7f05ff88bd6 100644 --- a/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmAutoscaleHistory.md +++ b/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmAutoscaleHistory.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml +Module Name: AzureRM.Insights ms.assetid: A70F4C03-E842-45D5-9323-DC5B14B569F1 online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Gets the Autoscale history. ``` Get-AzureRmAutoscaleHistory [-ResourceId ] [-StartTime ] [-EndTime ] - [-Status ] [-Caller ] [-DetailedOutput] [] + [-Status ] [-Caller ] [-DetailedOutput] [-DefaultProfile ] + [] ``` ## DESCRIPTION @@ -186,6 +188,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DetailedOutput Indicates that this operation included detailed output. If you do not specify this parameter, the output is summarized. diff --git a/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmAutoscaleSetting.md b/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmAutoscaleSetting.md index d773bbc1b56a..e70fdd9695da 100644 --- a/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmAutoscaleSetting.md +++ b/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmAutoscaleSetting.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml +Module Name: AzureRM.Insights ms.assetid: 989CE245-FD1D-4E1D-90A2-2D7DA3975D0B online version: schema: 2.0.0 @@ -13,7 +14,8 @@ Gets Autoscale settings. ## SYNTAX ``` -Get-AzureRmAutoscaleSetting -ResourceGroup [-Name ] [-DetailedOutput] [] +Get-AzureRmAutoscaleSetting -ResourceGroup [-Name ] [-DetailedOutput] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -200,6 +202,21 @@ This command gets the Autoscale setting named DefaultServerFarm-Default-Web-East ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DetailedOutput Indicates that this operation displays full details in the output. diff --git a/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmDiagnosticSetting.md b/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmDiagnosticSetting.md index ccb3ada4e880..b58a1de98e74 100644 --- a/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmDiagnosticSetting.md +++ b/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmDiagnosticSetting.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml +Module Name: AzureRM.Insights ms.assetid: 60B497F6-98A2-4C60-B142-FF5CD123362D online version: schema: 2.0.0 @@ -13,7 +14,8 @@ Gets the logged categories and time grains. ## SYNTAX ``` -Get-AzureRmDiagnosticSetting [-ResourceId] [] +Get-AzureRmDiagnosticSetting [-ResourceId] [-DefaultProfile ] + [] ``` ## DESCRIPTION @@ -39,6 +41,21 @@ This command gets the categories and time grains that are logged for an Azure Ke ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceId Specifies the ID of the resource. diff --git a/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmLog.md b/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmLog.md index 1a1fb38cd976..390d23718e96 100644 --- a/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmLog.md +++ b/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmLog.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml +Module Name: AzureRM.Insights ms.assetid: 85492E00-3776-4F20-A444-9C28CC6154B7 online version: schema: 2.0.0 @@ -15,31 +16,35 @@ Gets a log of events. ### Query on CorrelationId ``` Get-AzureRmLog [-StartTime ] [-EndTime ] [-Status ] [-Caller ] - [-DetailedOutput] [-CorrelationId] [-MaxEvents ] [] + [-DetailedOutput] [-CorrelationId] [-MaxEvents ] [-DefaultProfile ] + [] ``` ### Query on ResourceIdName ``` Get-AzureRmLog [-StartTime ] [-EndTime ] [-Status ] [-Caller ] - [-DetailedOutput] [-ResourceId] [-MaxEvents ] [] + [-DetailedOutput] [-ResourceId] [-MaxEvents ] [-DefaultProfile ] + [] ``` ### Query on ResourceGroupProvider ``` Get-AzureRmLog [-StartTime ] [-EndTime ] [-Status ] [-Caller ] - [-DetailedOutput] [-ResourceGroup] [-MaxEvents ] [] + [-DetailedOutput] [-ResourceGroup] [-MaxEvents ] [-DefaultProfile ] + [] ``` ### Query on ResourceProvider ``` Get-AzureRmLog [-StartTime ] [-EndTime ] [-Status ] [-Caller ] - [-DetailedOutput] [-ResourceProvider] [-MaxEvents ] [] + [-DetailedOutput] [-ResourceProvider] [-MaxEvents ] [-DefaultProfile ] + [] ``` ### Query at subscription level ``` Get-AzureRmLog [-StartTime ] [-EndTime ] [-Status ] [-Caller ] - [-DetailedOutput] [-MaxEvents ] [] + [-DetailedOutput] [-MaxEvents ] [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -224,6 +229,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DetailedOutput Indicates that this cmdlet displays detailed output. By default, output is summarized. diff --git a/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmLogProfile.md b/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmLogProfile.md index bc21a8fa607a..2246ead7bff3 100644 --- a/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmLogProfile.md +++ b/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmLogProfile.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml +Module Name: AzureRM.Insights ms.assetid: 019EFD94-4087-45F6-812D-FBDFE1B2E48A online version: schema: 2.0.0 @@ -13,7 +14,7 @@ Gets a log profile. ## SYNTAX ``` -Get-AzureRmLogProfile [-Name ] [] +Get-AzureRmLogProfile [-Name ] [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -28,6 +29,21 @@ The **Get-AzureRmLogProfile** cmdlet gets a log profile. ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Specifies the name of the log profile to get. diff --git a/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmMetric.md b/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmMetric.md index fced3a5dcebc..bd554598019d 100644 --- a/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmMetric.md +++ b/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmMetric.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml +Module Name: AzureRM.Insights ms.assetid: EAFB9C98-000C-4EAC-A32D-6B0F1939AA2F online version: schema: 2.0.0 @@ -12,9 +13,17 @@ Gets the metric values of a resource. ## SYNTAX +### Parameters for Get-AzureRmMetric cmdlet in the default mode ``` -Get-AzureRmMetric [-ResourceId] [-TimeGrain] [-StartTime ] [-EndTime ] - [-MetricNames ] [-DetailedOutput] [] +Get-AzureRmMetric [-ResourceId] [[-MetricNames] ] [-DetailedOutput] + [-DefaultProfile ] [] +``` + +### Parameters for Get-AzureRmMetric cmdlet in the full param set mode +``` +Get-AzureRmMetric [-ResourceId] [-TimeGrain ] [-AggregationType ] + [-StartTime ] [-EndTime ] [-MetricNames] [-DetailedOutput] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -152,6 +161,37 @@ This command gets detailed output for the Requests metric. ## PARAMETERS +### -AggregationType +The aggregation type of the query + +```yaml +Type: AggregationType +Parameter Sets: Parameters for Get-AzureRmMetric cmdlet in the full param set mode +Aliases: +Accepted values: None, Average, Count, Minimum, Maximum, Total + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure. + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DetailedOutput Indicates that this cmdlet displays detailed output. By default, output is summarized. @@ -174,7 +214,7 @@ The default is the current time. ```yaml Type: DateTime -Parameter Sets: (All) +Parameter Sets: Parameters for Get-AzureRmMetric cmdlet in the full param set mode Aliases: Required: False @@ -189,11 +229,23 @@ Specifies an array of names of metrics. ```yaml Type: String[] -Parameter Sets: (All) +Parameter Sets: Parameters for Get-AzureRmMetric cmdlet in the default mode Aliases: Required: False -Position: Named +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: String[] +Parameter Sets: Parameters for Get-AzureRmMetric cmdlet in the full param set mode +Aliases: + +Required: True +Position: 1 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False @@ -220,7 +272,7 @@ The default is the current local time minus one hour. ```yaml Type: DateTime -Parameter Sets: (All) +Parameter Sets: Parameters for Get-AzureRmMetric cmdlet in the full param set mode Aliases: Required: False @@ -235,11 +287,11 @@ Specifies the time grain of the metric as a **TimeSpan** object in the format hh ```yaml Type: TimeSpan -Parameter Sets: (All) +Parameter Sets: Parameters for Get-AzureRmMetric cmdlet in the full param set mode Aliases: -Required: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False diff --git a/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmMetricDefinition.md b/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmMetricDefinition.md index 7de63d174ffe..b7dfdf0b99da 100644 --- a/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmMetricDefinition.md +++ b/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmMetricDefinition.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml +Module Name: AzureRM.Insights ms.assetid: 7915A7AC-5A47-4868-B846-2896BCEBFAB2 online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Gets metric definitions. ``` Get-AzureRmMetricDefinition [-ResourceId] [-MetricNames ] [-DetailedOutput] - [] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -128,6 +129,21 @@ The output is detailed. ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DetailedOutput Indicates that this operation included detailed output. If you do not specify this parameter, the output is summarized. diff --git a/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmUsage.md b/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmUsage.md index 78d25aab74e8..de788550fc8b 100644 --- a/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmUsage.md +++ b/src/ResourceManager/Insights/Commands.Insights/help/Get-AzureRmUsage.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml +Module Name: AzureRM.Insights ms.assetid: CA67985F-C5D5-4CF4-81A4-C35FD769AF0A online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Gets the usage metrics for a resource. ``` Get-AzureRmUsage [-ResourceId] [-ApiVersion ] [-StartTime ] [-EndTime ] - [-MetricNames ] [] + [-MetricNames ] [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -46,6 +47,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -EndTime Specifies the latest time and date to search. diff --git a/src/ResourceManager/Insights/Commands.Insights/help/New-AzureRmActionGroup.md b/src/ResourceManager/Insights/Commands.Insights/help/New-AzureRmActionGroup.md index 87cb85308039..05794e0e1322 100644 --- a/src/ResourceManager/Insights/Commands.Insights/help/New-AzureRmActionGroup.md +++ b/src/ResourceManager/Insights/Commands.Insights/help/New-AzureRmActionGroup.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml +Module Name: AzureRM.Insights ms.assetid: A4C605DD-9B2E-4EE9-BD1F-1352D605C33F online version: schema: 2.0.0 @@ -13,7 +14,9 @@ Creates an ActionGroup reference object in memory. ## SYNTAX ``` -New-AzureRmActionGroup -ActionGroupId -WebhookProperties System.Collections.Generic.Dictionary`1[, ] [] +New-AzureRmActionGroup -ActionGroupId + [-WebhookProperty ] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -45,11 +48,26 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -WebhookProperties -The dictionary of webhook properties, i.e. list of unique string, string pairs. +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure ```yaml -Type: System.Collections.Generic.Dictionary`1[, ] +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WebhookProperty +The webhook properties of the action group + +```yaml +Type: System.Collections.Generic.Dictionary`2[System.String,System.String] Parameter Sets: (All) Aliases: diff --git a/src/ResourceManager/Insights/Commands.Insights/help/New-AzureRmActionGroupReceiver.md b/src/ResourceManager/Insights/Commands.Insights/help/New-AzureRmActionGroupReceiver.md index 488673421693..b1723f4f41e1 100644 --- a/src/ResourceManager/Insights/Commands.Insights/help/New-AzureRmActionGroupReceiver.md +++ b/src/ResourceManager/Insights/Commands.Insights/help/New-AzureRmActionGroupReceiver.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml +Module Name: AzureRM.Insights ms.assetid: 9830CD16-D797-47EB-BEF5-6CFE3454BCAA online version: schema: 2.0.0 @@ -12,8 +13,22 @@ Creates an new action group receiver. ## SYNTAX +### NewEmailReceiver (Default) ``` -New-AzureRmActionGroupReceiver -Name [-EmailReceiver] [-EmailAddress ] [-SmsReceiver] [-CountryCode ] [-PhoneNumber ] [-WebhookReceiver] [-ServiceUri ] [] +New-AzureRmActionGroupReceiver -Name [-EmailReceiver] -EmailAddress + [-DefaultProfile ] [] +``` + +### NewSmsReceiver +``` +New-AzureRmActionGroupReceiver -Name [-SmsReceiver] [-CountryCode ] -PhoneNumber + [-DefaultProfile ] [] +``` + +### NewWebhookReceiver +``` +New-AzureRmActionGroupReceiver -Name [-WebhookReceiver] -ServiceUri + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -44,33 +59,33 @@ This command creates a new webhook receiver in memory. ## PARAMETERS -### -Name -Specifies the name for the receiver. +### -CountryCode +Specifies the country code for the SMS receiver. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: NewSmsReceiver Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -EmailReceiver -Specifies to create an Email receiver +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure ```yaml -Type: SwitchParameter +Type: IAzureContextContainer Parameter Sets: (All) -Aliases: +Aliases: AzureRmContext, AzureCredential Required: False Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` @@ -79,7 +94,7 @@ Specifies the address for the Email receiver. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: NewEmailReceiver Aliases: Required: True @@ -89,12 +104,12 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -SmsReceiver -Specifies to create a SMS receiver +### -EmailReceiver +Specifies to create an Email receiver ```yaml Type: SwitchParameter -Parameter Sets: (All) +Parameter Sets: NewEmailReceiver Aliases: Required: False @@ -104,8 +119,8 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -CountryCode -Specifies the country code for the SMS receiver. +### -Name +Specifies the name for the receiver. ```yaml Type: String @@ -124,7 +139,7 @@ Specifies the phone number for the SMS receiver. ```yaml Type: String -Parameter Sets: (All) +Parameter Sets: NewSmsReceiver Aliases: Required: True @@ -134,12 +149,27 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -WebhookReceiver -Specifies to create a webhook receiver +### -ServiceUri +Specifies the URI for the webhook receiver. + +```yaml +Type: String +Parameter Sets: NewWebhookReceiver +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SmsReceiver +Specifies to create a SMS receiver ```yaml Type: SwitchParameter -Parameter Sets: (All) +Parameter Sets: NewSmsReceiver Aliases: Required: False @@ -149,15 +179,15 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -ServiceUri -Specifies the URI for the webhook receiver. +### -WebhookReceiver +Specifies to create a webhook receiver ```yaml -Type: String -Parameter Sets: (All) +Type: SwitchParameter +Parameter Sets: NewWebhookReceiver Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: True (ByPropertyName) diff --git a/src/ResourceManager/Insights/Commands.Insights/help/New-AzureRmActivityLogAlertCondition.md b/src/ResourceManager/Insights/Commands.Insights/help/New-AzureRmActivityLogAlertCondition.md index 64568b663e91..8f0e6d578083 100644 --- a/src/ResourceManager/Insights/Commands.Insights/help/New-AzureRmActivityLogAlertCondition.md +++ b/src/ResourceManager/Insights/Commands.Insights/help/New-AzureRmActivityLogAlertCondition.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml +Module Name: AzureRM.Insights ms.assetid: 5E854358-CA9D-4336-BA6A-BF7B1FADAB50 online version: schema: 2.0.0 @@ -13,7 +14,8 @@ Creates an new activity log alert condition object in memory. ## SYNTAX ``` -New-AzureRmActivityLogAlertCondition -Field -Equal [] +New-AzureRmActivityLogAlertCondition -Field -Equal [-DefaultProfile ] + [] ``` ## DESCRIPTION @@ -32,8 +34,23 @@ This command creates a new activity log alert condition object in memory. ## PARAMETERS -### -Field -Specifies the field for the condition. +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Equal +Specifies the equals property for the leaf condition. ```yaml Type: String @@ -47,8 +64,8 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Equal -Specifies the equals property for the leaf condition. +### -Field +Specifies the field for the condition. ```yaml Type: String diff --git a/src/ResourceManager/Insights/Commands.Insights/help/New-AzureRmAlertRuleEmail.md b/src/ResourceManager/Insights/Commands.Insights/help/New-AzureRmAlertRuleEmail.md index b3ce78a73da7..4320072135bf 100644 --- a/src/ResourceManager/Insights/Commands.Insights/help/New-AzureRmAlertRuleEmail.md +++ b/src/ResourceManager/Insights/Commands.Insights/help/New-AzureRmAlertRuleEmail.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml +Module Name: AzureRM.Insights ms.assetid: B1000C10-265E-4465-B167-F1251470BE3E online version: schema: 2.0.0 @@ -13,7 +14,8 @@ Creates an email action for an alert rule. ## SYNTAX ``` -New-AzureRmAlertRuleEmail [[-CustomEmails] ] [-SendToServiceOwners] [] +New-AzureRmAlertRuleEmail [[-CustomEmails] ] [-SendToServiceOwners] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -59,6 +61,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SendToServiceOwners Indicates that this operation sends an e-mail to the service owners when the rule fires. diff --git a/src/ResourceManager/Insights/Commands.Insights/help/New-AzureRmAlertRuleWebhook.md b/src/ResourceManager/Insights/Commands.Insights/help/New-AzureRmAlertRuleWebhook.md index 6b5540736fad..4a277c882864 100644 --- a/src/ResourceManager/Insights/Commands.Insights/help/New-AzureRmAlertRuleWebhook.md +++ b/src/ResourceManager/Insights/Commands.Insights/help/New-AzureRmAlertRuleWebhook.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml +Module Name: AzureRM.Insights ms.assetid: 0137ECA3-37E1-4064-8A65-A582519E9017 online version: schema: 2.0.0 @@ -13,7 +14,8 @@ Creates an alert rule webhook. ## SYNTAX ``` -New-AzureRmAlertRuleWebhook [-ServiceUri] [[-Properties] ] [] +New-AzureRmAlertRuleWebhook [-ServiceUri] [[-Properties] ] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -37,6 +39,21 @@ This command creates an alert rule webhook for Contoso.com that has one property ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Properties Specifies the list of properties in the format @(property1 = 'value1',....). diff --git a/src/ResourceManager/Insights/Commands.Insights/help/New-AzureRmAutoscaleNotification.md b/src/ResourceManager/Insights/Commands.Insights/help/New-AzureRmAutoscaleNotification.md index 5d34bfedeccc..af5e2c150ae9 100644 --- a/src/ResourceManager/Insights/Commands.Insights/help/New-AzureRmAutoscaleNotification.md +++ b/src/ResourceManager/Insights/Commands.Insights/help/New-AzureRmAutoscaleNotification.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml +Module Name: AzureRM.Insights ms.assetid: B5B5F494-D912-40D0-99E2-A62FAACA3EC9 online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Creates an Autoscale email notification. ``` New-AzureRmAutoscaleNotification [[-Webhooks] ] [[-CustomEmails] ] - [-SendEmailToSubscriptionAdministrator] [-SendEmailToSubscriptionCoAdministrators] [] + [-SendEmailToSubscriptionAdministrator] [-SendEmailToSubscriptionCoAdministrators] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -53,6 +55,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SendEmailToSubscriptionAdministrator Indicates that this operation sends an email notification to the subscription administrator. diff --git a/src/ResourceManager/Insights/Commands.Insights/help/New-AzureRmAutoscaleProfile.md b/src/ResourceManager/Insights/Commands.Insights/help/New-AzureRmAutoscaleProfile.md index 582ab74b9a3f..a387a9bc0b37 100644 --- a/src/ResourceManager/Insights/Commands.Insights/help/New-AzureRmAutoscaleProfile.md +++ b/src/ResourceManager/Insights/Commands.Insights/help/New-AzureRmAutoscaleProfile.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml +Module Name: AzureRM.Insights ms.assetid: A4C605DD-9B2E-4EE9-BD1F-1352D605C33F online version: schema: 2.0.0 @@ -16,16 +17,16 @@ Creates an Autoscale profile. ``` New-AzureRmAutoscaleProfile -Name -DefaultCapacity -MaximumCapacity -MinimumCapacity - -Rules - [] + -Rules + [-DefaultProfile ] [] ``` ### Parameters for New-AzureRmAutoscaleProfile cmdlet using fix date scheduling ``` New-AzureRmAutoscaleProfile -Name -DefaultCapacity -MaximumCapacity -MinimumCapacity -StartTimeWindow -EndTimeWindow -TimeWindowTimeZone - -Rules - [] + -Rules + [-DefaultProfile ] [] ``` ### Parameters for New-AzureRmAutoscaleProfile cmdlet using recurrent scheduling @@ -36,8 +37,8 @@ New-AzureRmAutoscaleProfile -Name -DefaultCapacity -MaximumCap -ScheduleHours -ScheduleMinutes -ScheduleTimeZone - -Rules - [] + -Rules + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -136,6 +137,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -EndTimeWindow Specifies the end of the time window. @@ -228,7 +244,7 @@ Accept wildcard characters: False Specifies the list of rules to add to the profile. ```yaml -Type: System.Collections.Generic.List`1[Microsoft.Azure.Management.Insights.Models.ScaleRule] +Type: System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.ScaleRule] Parameter Sets: (All) Aliases: diff --git a/src/ResourceManager/Insights/Commands.Insights/help/New-AzureRmAutoscaleRule.md b/src/ResourceManager/Insights/Commands.Insights/help/New-AzureRmAutoscaleRule.md index 72936ee18444..600c2f99f2b5 100644 --- a/src/ResourceManager/Insights/Commands.Insights/help/New-AzureRmAutoscaleRule.md +++ b/src/ResourceManager/Insights/Commands.Insights/help/New-AzureRmAutoscaleRule.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml +Module Name: AzureRM.Insights ms.assetid: 5E854358-CA9D-4336-BA6A-BF7B1FADAB50 online version: schema: 2.0.0 @@ -17,7 +18,7 @@ New-AzureRmAutoscaleRule -MetricName -MetricResourceId -Operat -MetricStatistic -Threshold [-TimeAggregationOperator ] -TimeGrain [-TimeWindow ] -ScaleActionCooldown -ScaleActionDirection [-ScaleActionScaleType ] -ScaleActionValue - [] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -52,6 +53,21 @@ The second command creates a second rule for the Requests metric, and then store ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -MetricName Specifies the name of the metric. diff --git a/src/ResourceManager/Insights/Commands.Insights/help/New-AzureRmAutoscaleWebhook.md b/src/ResourceManager/Insights/Commands.Insights/help/New-AzureRmAutoscaleWebhook.md index 32ae6cc4f079..1d66d3ddb0c7 100644 --- a/src/ResourceManager/Insights/Commands.Insights/help/New-AzureRmAutoscaleWebhook.md +++ b/src/ResourceManager/Insights/Commands.Insights/help/New-AzureRmAutoscaleWebhook.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml +Module Name: AzureRM.Insights ms.assetid: 674A11E4-36B9-4075-9F4E-952BD9FF07A7 online version: schema: 2.0.0 @@ -13,7 +14,8 @@ Creates an Autoscale webhook. ## SYNTAX ``` -New-AzureRmAutoscaleWebhook [-ServiceUri] [[-Properties] ] [] +New-AzureRmAutoscaleWebhook [-ServiceUri] [[-Properties] ] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -28,6 +30,21 @@ The **New-AzureRmAutoscaleWebhook** cmdlet creates an Autoscale webhook. ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Properties Specifies the list of properties in the format @(property1 = 'value1',....). diff --git a/src/ResourceManager/Insights/Commands.Insights/help/Remove-AzureRmActionGroup.md b/src/ResourceManager/Insights/Commands.Insights/help/Remove-AzureRmActionGroup.md index f2b5f7be4d07..4884ca53a9d1 100644 --- a/src/ResourceManager/Insights/Commands.Insights/help/Remove-AzureRmActionGroup.md +++ b/src/ResourceManager/Insights/Commands.Insights/help/Remove-AzureRmActionGroup.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml +Module Name: AzureRM.Insights ms.assetid: 8D8FE2FE-03E7-453E-B968-E28B07E42EF2 online version: schema: 2.0.0 @@ -12,8 +13,22 @@ Removes an action group. ## SYNTAX +### ByPropertyName (Default) ``` -Remove-AzureRmActionGroup -ResourceGroup -Name [] +Remove-AzureRmActionGroup -ResourceGroupName -Name [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### ByResourceId +``` +Remove-AzureRmActionGroup -ResourceId [-DefaultProfile ] [-WhatIf] [-Confirm] + [] +``` + +### ByInputObject +``` +Remove-AzureRmActionGroup -InputObject [-DefaultProfile ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -31,12 +46,42 @@ RequestId ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +The action group resourc + +```yaml +Type: PSActionGroupResource +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -Name The name of the action group. ```yaml -Type: System.String -Parameter Sets: (All) +Type: String +Parameter Sets: ByPropertyName Aliases: Required: True @@ -46,12 +91,27 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -ResourceGroup -The name of the resource group where the action group exists. +### -ResourceGroupName +The resource group nam ```yaml -Type: System.String -Parameter Sets: (All) +Type: String +Parameter Sets: ByPropertyName +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ResourceId +The resource i + +```yaml +Type: String +Parameter Sets: ByResourceId Aliases: Required: True @@ -61,8 +121,38 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters -This cmdlet supports the common parameters: -Force, -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/src/ResourceManager/Insights/Commands.Insights/help/Remove-AzureRmActivityLogAlert.md b/src/ResourceManager/Insights/Commands.Insights/help/Remove-AzureRmActivityLogAlert.md index 71070a198381..a84abb7b595c 100644 --- a/src/ResourceManager/Insights/Commands.Insights/help/Remove-AzureRmActivityLogAlert.md +++ b/src/ResourceManager/Insights/Commands.Insights/help/Remove-AzureRmActivityLogAlert.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml +Module Name: AzureRM.Insights ms.assetid: C7EC21C7-1C7E-49B2-9B33-486532FCDAEC online version: schema: 2.0.0 @@ -12,8 +13,22 @@ Removes an activity log alert. ## SYNTAX +### Default parameters for remove an activity log alert ``` -Remove-AzureRmActivityLogAlert [-InputObject ] [-ResourceId ] [-ResourceGroupName -Name ] [] +Remove-AzureRmActivityLogAlert -ResourceGroupName -Name + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### Parameters to remove an activity log alerts taking value from the pipe +``` +Remove-AzureRmActivityLogAlert -InputObject + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### Parameters to remove an activity log alerts taking the value of ResourceId from the pipe +``` +Remove-AzureRmActivityLogAlert -ResourceId [-DefaultProfile ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -44,36 +59,49 @@ Removes an activity log alert using a PSActivityLogAlertResource as input. ### Example 3: Remove the ActivityLogAlert using the ResourceId parameter ``` - PS C:\>Find-AzureRmResource -ResourceGroupEquals "myResourceGroup" -ResourceNameEquals "myLogAlert" | Remove-AzureRmActivityLogAlert - ``` This command removes the ActivityLogAlert using the ResourceId parameter from the pipe. ## PARAMETERS -### -Name -The name of the activity log alert. +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure ```yaml -Type: System.String -Parameter Sets: RemoveActivityLogAlertDeafultParamGroup +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InputObject +Sets the InputObject tags property of the call to extract the required name, and resource group name properties. + +```yaml +Type: PSActivityLogAlertResource +Parameter Sets: Parameters to remove an activity log alerts taking value from the pipe Aliases: Required: True Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -ResourceGroupName -The name of the resource group where the alert resource exists. +### -Name +The name of the activity log alert. ```yaml -Type: System.String -Parameter Sets: RemoveActivityLogAlertDeafultParamGroup +Type: String +Parameter Sets: Default parameters for remove an activity log alert Aliases: Required: True @@ -83,18 +111,18 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -InputObject -Sets the InputObject tags property of the call to extract the required name, and resource group name properties. +### -ResourceGroupName +The name of the resource group where the alert resource exists. ```yaml -Type: Microsoft.Azure.Commands.Insights.OutputClasses.PSActivityLogAlertResource -Parameter Sets: RemoveActivityLogAlertFromPipeParamGroup +Type: String +Parameter Sets: Default parameters for remove an activity log alert Aliases: Required: True Position: Named Default value: None -Accept pipeline input: True (FromPipeline) +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` @@ -102,8 +130,8 @@ Accept wildcard characters: False Sets the ResourceId tags property of the call to extract the required name, resource group name properties. ```yaml -Type: System.String -Parameter Sets: RemoveActivityLogAlertFromResourceIdParamGroup +Type: String +Parameter Sets: Parameters to remove an activity log alerts taking the value of ResourceId from the pipe Aliases: Required: True @@ -113,6 +141,36 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/src/ResourceManager/Insights/Commands.Insights/help/Remove-AzureRmAlertRule.md b/src/ResourceManager/Insights/Commands.Insights/help/Remove-AzureRmAlertRule.md index 6079cc3222b6..7ecd6ad7a247 100644 --- a/src/ResourceManager/Insights/Commands.Insights/help/Remove-AzureRmAlertRule.md +++ b/src/ResourceManager/Insights/Commands.Insights/help/Remove-AzureRmAlertRule.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml +Module Name: AzureRM.Insights ms.assetid: C7EC21C7-1C7E-49B2-9B33-486532FCDAEC online version: schema: 2.0.0 @@ -13,7 +14,8 @@ Removes an alert rule. ## SYNTAX ``` -Remove-AzureRmAlertRule -ResourceGroup -Name [] +Remove-AzureRmAlertRule -ResourceGroup -Name [-DefaultProfile ] + [] ``` ## DESCRIPTION @@ -34,6 +36,21 @@ This command removes the alert rule named myalert-7da64548-214d-42ca-b12b-b245bb ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Specifies the name of the alert rule to remove. diff --git a/src/ResourceManager/Insights/Commands.Insights/help/Remove-AzureRmAutoscaleSetting.md b/src/ResourceManager/Insights/Commands.Insights/help/Remove-AzureRmAutoscaleSetting.md index 8930277c1e4f..6b9ade544ebd 100644 --- a/src/ResourceManager/Insights/Commands.Insights/help/Remove-AzureRmAutoscaleSetting.md +++ b/src/ResourceManager/Insights/Commands.Insights/help/Remove-AzureRmAutoscaleSetting.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml +Module Name: AzureRM.Insights ms.assetid: 6140E973-D7AB-4A28-A4FA-818E08129372 online version: schema: 2.0.0 @@ -13,7 +14,8 @@ Removes an Autoscale setting. ## SYNTAX ``` -Remove-AzureRmAutoscaleSetting -ResourceGroup -Name [] +Remove-AzureRmAutoscaleSetting -ResourceGroup -Name + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -29,6 +31,21 @@ You must specify the name of the setting and the name of the resource group to w ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Specifies the name of the Autoscale setting to remove. diff --git a/src/ResourceManager/Insights/Commands.Insights/help/Remove-AzureRmLogProfile.md b/src/ResourceManager/Insights/Commands.Insights/help/Remove-AzureRmLogProfile.md index 768f6c5c6bf9..01f03b070ebe 100644 --- a/src/ResourceManager/Insights/Commands.Insights/help/Remove-AzureRmLogProfile.md +++ b/src/ResourceManager/Insights/Commands.Insights/help/Remove-AzureRmLogProfile.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml +Module Name: AzureRM.Insights ms.assetid: DDA137FD-4EB3-4FB7-A202-978922038AFC online version: schema: 2.0.0 @@ -13,7 +14,8 @@ Removes a log profile. ## SYNTAX ``` -Remove-AzureRmLogProfile -Name [] +Remove-AzureRmLogProfile -Name [-PassThru] [-DefaultProfile ] + [] ``` ## DESCRIPTION @@ -28,6 +30,21 @@ The **Remove-AzureRmLogProfile** cmdlet removes a log profile. ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Specifies the name of the log profile to remove. @@ -43,6 +60,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -PassThru +{{Fill PassThru Description}} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/src/ResourceManager/Insights/Commands.Insights/help/Set-AzureRmActionGroup.md b/src/ResourceManager/Insights/Commands.Insights/help/Set-AzureRmActionGroup.md index a2c200bebd14..533d0e5cac76 100644 --- a/src/ResourceManager/Insights/Commands.Insights/help/Set-AzureRmActionGroup.md +++ b/src/ResourceManager/Insights/Commands.Insights/help/Set-AzureRmActionGroup.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml +Module Name: AzureRM.Insights ms.assetid: 4A6816DB-0E46-44F0-8AE9-180B1C4AAB22 online version: schema: 2.0.0 @@ -12,10 +13,28 @@ Creates a new or updates an existing action group. ## SYNTAX +### ByPropertyName (Default) ``` -Set-AzureRmActionGroup -Name -ResourceGroup -ShortName - -Receiver - [-DisableGroup] [-Tags , ]>] +Set-AzureRmActionGroup -ResourceGroupName -Name -ShortName + -Receiver + [-DisableGroup] [-Tag ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### ByResourceId +``` +Set-AzureRmActionGroup -ShortName + -Receiver + [-DisableGroup] [-Tag ] + -ResourceId [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### ByInputObject +``` +Set-AzureRmActionGroup [-ShortName ] [-DisableGroup] + [-Tag ] + -InputObject [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -28,7 +47,6 @@ The **Set-AzureRmActionGroup** cmdlet creates a new or updates an existing actio PS C:\>$email1 = New-AzureRmActionGroupReceiver -Name 'user1' -EmailReceiver -EmailAddress 'user1@example.com' PS C:\>$sms1 = New-AzureRmActionGroupReceiver -Name 'user2' -SmsReceiver -CountryCode '1' -PhoneNumber '5555555555' PS C:\>Set-AzureRmActionGroup -Name $actionGroupName -ResourceGroup $resourceGroupName -ShortName $shortName -Receiver $email1,$sms1 - ``` The first two commands create two receivers. @@ -36,12 +54,69 @@ The final command creates an Action Group including the two receivers. ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableGroup +Disables the action group. + +```yaml +Type: SwitchParameter +Parameter Sets: ByPropertyName, ByResourceId +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: SwitchParameter +Parameter Sets: ByInputObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -InputObject +The action group resourc + +```yaml +Type: PSActionGroupResource +Parameter Sets: ByInputObject +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -Name The name of the action group. ```yaml -Type: System.String -Parameter Sets: (All) +Type: String +Parameter Sets: ByPropertyName Aliases: Required: True @@ -51,12 +126,12 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -ResourceGroup -The name of the resource group where the action group is going to exist. +### -Receiver +The list of receivers of the action group. ```yaml -Type: System.String -Parameter Sets: (All) +Type: System.Collections.Generic.List`1[Microsoft.Azure.Commands.Insights.OutputClasses.PSActionGroupReceiverBase] +Parameter Sets: ByPropertyName, ByResourceId Aliases: Required: True @@ -66,12 +141,12 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -ShortName -The short name of the action group. +### -ResourceGroupName +The resource group nam ```yaml -Type: -Parameter Sets: (All) +Type: String +Parameter Sets: ByPropertyName Aliases: Required: True @@ -81,12 +156,12 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Receiver -The list of receivers of the action group. +### -ResourceId +The resource i ```yaml -Type: -Parameter Sets: (All) +Type: String +Parameter Sets: ByResourceId Aliases: Required: True @@ -96,12 +171,24 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -DisableGroup -Disables the action group. +### -ShortName +The short name of the action group. ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: String +Parameter Sets: ByPropertyName, ByResourceId +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: String +Parameter Sets: ByInputObject Aliases: Required: False @@ -111,12 +198,12 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Tags -Sets the tags property of the activity log alert resource. +### -Tag +The tags of the action group resourc ```yaml -Type: System.Collections.Generic.Dictionary`1[, ] -Parameter Sets: (All) +Type: System.Collections.Generic.IDictionary`2[System.String,System.String] +Parameter Sets: ByPropertyName, ByResourceId Aliases: Required: False @@ -126,8 +213,50 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +```yaml +Type: System.Collections.Generic.IDictionary`2[System.String,System.String] +Parameter Sets: ByInputObject +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters -This cmdlet supports the common parameters: -Force, -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/src/ResourceManager/Insights/Commands.Insights/help/Set-AzureRmActivityLogAlert.md b/src/ResourceManager/Insights/Commands.Insights/help/Set-AzureRmActivityLogAlert.md index 09bfb033c853..000b99a78c0e 100644 --- a/src/ResourceManager/Insights/Commands.Insights/help/Set-AzureRmActivityLogAlert.md +++ b/src/ResourceManager/Insights/Commands.Insights/help/Set-AzureRmActivityLogAlert.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml +Module Name: AzureRM.Insights ms.assetid: 7436F31F-9DCB-4365-BA6D-41BDB5D7FCB6 online version: schema: 2.0.0 @@ -12,12 +13,35 @@ Creates a new or sets an existing activity log alert. ## SYNTAX +### Default parameters for set activity log alert ``` -Set-AzureRmActivityLogAlert [-InputObject [-Scope ] [-Condition ] - [-Action ] [-DisableAlert] [-Description ] [-Tag , ]>]] [-ResourceId [-Location ] [-Scope ] [-Condition ] - [-Action ] [-DisableAlert] [-Description ] [-Tag , ]>]] -Location -Name -ResourceGroupName - -Scope -Condition - -Action [-DisableAlert] [-Description ] [-Tag , ]>] [] +Set-AzureRmActivityLogAlert -Location -Name -ResourceGroupName + -Scope + -Condition + -Action + [-DisableAlert] [-Description ] + [-Tag ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### Parameters to set an activity log alerts taking the value of ResourceId from the pipe +``` +Set-AzureRmActivityLogAlert [-Location ] [-Scope ] + [-Condition ] + [-Action ] + [-DisableAlert] [-Description ] + [-Tag ] -ResourceId + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### Parameters to set an activity log alerts taking value from the pipe +``` +Set-AzureRmActivityLogAlert [-Scope ] + [-Condition ] + [-Action ] + [-Description ] [-Tag ] + -InputObject [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -38,7 +62,6 @@ PS C:\>$dict = New-Object "System.Collections.Generic.Dictionary``2[System.Strin PS C:\>$dict.Add('key1', 'value1') PS C:\>$actionGrp1 = New-AzureRmActionGroup -ActionGroupId 'actiongr1' -WebhookProperties $dict PS C:\>Set-AzureRmActivityLogAlert -Location $location -Name $alertName -ResourceGroupName $resourceGroupName -Scope 'scope1','scope2' -Action $actionGrp1 -Condition $condition1, $condition2 - ``` The first four commands create leaf condition and and action group. @@ -55,7 +78,6 @@ PS C:\>$dict = New-Object "System.Collections.Generic.Dictionary``2[System.Strin PS C:\>$dict.Add('key1', 'value1') PS C:\>$actionGrp1 = New-AzureRmActionGroup -ActionGroupId 'actiongr1' -WebhookProperties $dict PS C:\>Set-AzureRmActivityLogAlert -Location $location -Name $alertName -ResourceGroupName $resourceGroupName -Scope 'scope1','scope2' -Action $actionGrp1 -Condition $condition1, $condition2 -DisableAlert - ``` The first four commands create leaf condition and and action group. @@ -68,7 +90,6 @@ PS C:\>$alert = Get-AzureRmActivityLogAlert -Name $alertName -ResourceGroupName PS C:\>$alert.Description = 'Changing the description' PS C:\>$alert.Enabled = $false PS C:\>Set-AzureRmActivityLogAlert -InputObject $alert - ``` The first command is similar to a nop, it sets the alert with the same values it already contained @@ -77,49 +98,59 @@ The rest of the commands retrieve the alert rule, change the description and dis ### Example 4: Set an activity log alert based using the ResourceId value from the pipe ``` PS C:\>Find-AzureRmResource -ResourceGroupEquals "myResourceGroup" -ResourceNameEquals "myLogAlert" | Set-AzureRmActivityLogAlert -DisableAlert - ``` If the given log alert rule exists this command disables it. ## PARAMETERS -### -Location -The location where the activity log alert will exist. +### -Action +The list of action groups for the activity log alert. ```yaml -Type: System.String -Parameter Sets: SetActivityLogAlertDefaultParamGroup, SetActivityLogAlertFromResourceIdParamGroup +Type: System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.ActivityLogAlertActionGroup] +Parameter Sets: Default parameters for set activity log alert Aliases: -Required: True for SetActivityLogAlertDefaultParamGroup, False for SetActivityLogAlertFromResourceIdParamGroup +Required: True Position: Named Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Name -The name of the activity log alert. +```yaml +Type: System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.ActivityLogAlertActionGroup] +Parameter Sets: Parameters to set an activity log alerts taking the value of ResourceId from the pipe +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` ```yaml -Type: System.String -Parameter Sets: SetActivityLogAlertDefaultParamGroup +Type: System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.ActivityLogAlertActionGroup] +Parameter Sets: Parameters to set an activity log alerts taking value from the pipe Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -ResourceGroupName -The name of the resource group where the alert resource is going to exist. +### -Condition +The list of conditions for the activity log alert. + +**NOTE**: In the list of conditions there must be at least one with the Field equal to "Category". The backend responds with 400 (BadRequest) if this condition is not present. ```yaml -Type: System.String -Parameter Sets: SetActivityLogAlertDefaultParamGroup +Type: System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.ActivityLogAlertLeafCondition] +Parameter Sets: Default parameters for set activity log alert Aliases: Required: True @@ -129,47 +160,66 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Scope -The list of scopes for the activity log alert. - ```yaml -Type: -Parameter Sets: (All) +Type: System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.ActivityLogAlertLeafCondition] +Parameter Sets: Parameters to set an activity log alerts taking the value of ResourceId from the pipe Aliases: -Required: True for SetActivityLogAlertDefaultParamGroup, False for SetActivityLogAlertFromPipeParamGroup and SetActivityLogAlertFromResourceIdParamGroup +Required: False Position: Named Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Condition -The list of conditions for the activity log alert. +```yaml +Type: System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.ActivityLogAlertLeafCondition] +Parameter Sets: Parameters to set an activity log alerts taking value from the pipe +Aliases: -**NOTE**: In the list of conditions there must be at least one with the Field equal to "Category". The backend responds with 400 (BadRequest) if this condition is not present. +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure ```yaml -Type: +Type: IAzureContextContainer Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +The description of the alert resource. + +```yaml +Type: String +Parameter Sets: Default parameters for set activity log alert, Parameters to set an activity log alerts taking the value of ResourceId from the pipe Aliases: -Required: True for SetActivityLogAlertDefaultParamGroup, False for SetActivityLogAlertFromPipeParamGroup and SetActivityLogAlertFromResourceIdParamGroup +Required: False Position: Named Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Action -The list of action groups for the activity log alert. - ```yaml -Type: -Parameter Sets: (All) +Type: String +Parameter Sets: Parameters to set an activity log alerts taking value from the pipe Aliases: -Required: True for SetActivityLogAlertDefaultParamGroup, False for SetActivityLogAlertFromPipeParamGroup and SetActivityLogAlertFromResourceIdParamGroup +Required: False Position: Named Default value: None Accept pipeline input: True (ByPropertyName) @@ -181,22 +231,49 @@ Allows the user to create a disabled the activity log alert. If not given, the a ```yaml Type: SwitchParameter -Parameter Sets: (All) +Parameter Sets: Default parameters for set activity log alert, Parameters to set an activity log alerts taking the value of ResourceId from the pipe Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -The description of the alert resource. +### -InputObject +Sets the InputObject tags property of the call to extract the required name, and resource group name properties. ```yaml -Type: System.String -Parameter Sets: (All) +Type: PSActivityLogAlertResource +Parameter Sets: Parameters to set an activity log alerts taking value from the pipe +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Location +The location where the activity log alert will exist. + +```yaml +Type: String +Parameter Sets: Default parameters for set activity log alert +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: String +Parameter Sets: Parameters to set an activity log alerts taking the value of ResourceId from the pipe Aliases: Required: False @@ -206,33 +283,33 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Tag -Sets the tags property of the activity log alert resource. +### -Name +The name of the activity log alert. ```yaml -Type: System.Collections.Generic.Dictionary`1[, ] -Parameter Sets: (All) +Type: String +Parameter Sets: Default parameters for set activity log alert Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -InputObject -Sets the InputObject tags property of the call to extract the required name, and resource group name properties. +### -ResourceGroupName +The name of the resource group where the alert resource is going to exist. ```yaml -Type: Microsoft.Azure.Commands.Insights.OutputClasses.PSActivityLogAlertResource -Parameter Sets: SetActivityLogAlertFromPipeParamGroup +Type: String +Parameter Sets: Default parameters for set activity log alert Aliases: Required: True Position: Named Default value: None -Accept pipeline input: True (FromPipeline) +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` @@ -240,8 +317,8 @@ Accept wildcard characters: False Sets the ResourceId tags property of the call to extract the required name, resource group name properties. ```yaml -Type: System.String -Parameter Sets: SetActivityLogAlertFromResourceIdParamGroup +Type: String +Parameter Sets: Parameters to set an activity log alerts taking the value of ResourceId from the pipe Aliases: Required: True @@ -251,6 +328,102 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -Scope +The list of scopes for the activity log alert. + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: Default parameters for set activity log alert +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: Parameters to set an activity log alerts taking the value of ResourceId from the pipe +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.Collections.Generic.List`1[System.String] +Parameter Sets: Parameters to set an activity log alerts taking value from the pipe +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Tag +Sets the tags property of the activity log alert resource. + +```yaml +Type: System.Collections.Generic.Dictionary`2[System.String,System.String] +Parameter Sets: Default parameters for set activity log alert, Parameters to set an activity log alerts taking the value of ResourceId from the pipe +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +```yaml +Type: System.Collections.Generic.Dictionary`2[System.String,System.String] +Parameter Sets: Parameters to set an activity log alerts taking value from the pipe +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/src/ResourceManager/Insights/Commands.Insights/help/Set-AzureRmDiagnosticSetting.md b/src/ResourceManager/Insights/Commands.Insights/help/Set-AzureRmDiagnosticSetting.md index a54584ba8c32..dae63b57da64 100644 --- a/src/ResourceManager/Insights/Commands.Insights/help/Set-AzureRmDiagnosticSetting.md +++ b/src/ResourceManager/Insights/Commands.Insights/help/Set-AzureRmDiagnosticSetting.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Insights.dll-Help.xml +Module Name: AzureRM.Insights ms.assetid: B5F2388E-0136-4F8A-8577-67CE2A45671E online version: schema: 2.0.0 @@ -14,9 +15,11 @@ Sets the logs and metrics settings for the resource. ``` Set-AzureRmDiagnosticSetting -ResourceId [-StorageAccountId ] [-ServiceBusRuleId ] - [-Enabled ] [-Categories ] + [-EventHubAuthorizationRuleId ] [-Enabled ] + [-Categories ] [-Timegrains ] [-RetentionEnabled ] - [-WorkspaceId ] [-RetentionInDays ] [] + [-WorkspaceId ] [-RetentionInDays ] [-DefaultProfile ] + [] ``` ## DESCRIPTION @@ -90,6 +93,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Enabled Indicates whether to enable diagnostics. Specify $True to enable diagnostics, or $False to disable diagnostics. @@ -106,6 +124,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -EventHubAuthorizationRuleId +The event hub rule i + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + ### -ResourceId Specifies the ID of the resource. diff --git a/src/ResourceManager/IotHub/Commands.IotHub/help/Add-AzureRmIotHubEventHubConsumerGroup.md b/src/ResourceManager/IotHub/Commands.IotHub/help/Add-AzureRmIotHubEventHubConsumerGroup.md index 2f8b8f69b663..4f2396cc0dd4 100644 --- a/src/ResourceManager/IotHub/Commands.IotHub/help/Add-AzureRmIotHubEventHubConsumerGroup.md +++ b/src/ResourceManager/IotHub/Commands.IotHub/help/Add-AzureRmIotHubEventHubConsumerGroup.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.IotHub.dll-Help.xml +Module Name: AzureRM.IotHub online version: schema: 2.0.0 --- @@ -13,8 +14,8 @@ Creates an eventhub consumer group. ``` Add-AzureRmIotHubEventHubConsumerGroup [-ResourceGroupName] [-Name] - [-EventHubEndpointName] [-EventHubConsumerGroupName] [-WhatIf] [-Confirm] - [] + [-EventHubEndpointName] [-EventHubConsumerGroupName] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -38,6 +39,21 @@ Adds a new consumergroup named "myconsumergroup" to the eventhub for operations ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -EventHubConsumerGroupName Name of the EventHub ConsumerGroup that you want to add. @@ -61,6 +77,7 @@ Possible values events, operationsMonitoringEvents Type: String Parameter Sets: (All) Aliases: +Accepted values: events, operationsMonitoringEvents Required: True Position: 2 diff --git a/src/ResourceManager/IotHub/Commands.IotHub/help/Add-AzureRmIotHubKey.md b/src/ResourceManager/IotHub/Commands.IotHub/help/Add-AzureRmIotHubKey.md index cf6752e9c445..99d4b2a7e1a1 100644 --- a/src/ResourceManager/IotHub/Commands.IotHub/help/Add-AzureRmIotHubKey.md +++ b/src/ResourceManager/IotHub/Commands.IotHub/help/Add-AzureRmIotHubKey.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.IotHub.dll-Help.xml +Module Name: AzureRM.IotHub online version: schema: 2.0.0 --- @@ -12,9 +13,9 @@ Creates an IotHub Key. ## SYNTAX ``` -Add-AzureRmIotHubKey [-ResourceGroupName] [-Name] [-KeyName] - [[-PrimaryKey] ] [[-SecondaryKey] ] [-Rights] [-WhatIf] [-Confirm] - [] +Add-AzureRmIotHubKey [-ResourceGroupName] [-Name] [-KeyName] [-PrimaryKey ] + [-SecondaryKey ] -Rights [-DefaultProfile ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -32,6 +33,21 @@ Creates a key named "mykey" for the iothub "myiothub" with RegistryRead permissi ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -KeyName Name of the Key @@ -71,7 +87,7 @@ Parameter Sets: (All) Aliases: Required: False -Position: 3 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -102,7 +118,7 @@ Aliases: Accepted values: RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect Required: True -Position: 5 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -117,7 +133,7 @@ Parameter Sets: (All) Aliases: Required: False -Position: 4 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHub.md b/src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHub.md index e2c60b476230..f457589431f0 100644 --- a/src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHub.md +++ b/src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHub.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.IotHub.dll-Help.xml +Module Name: AzureRM.IotHub online version: schema: 2.0.0 --- @@ -13,12 +14,14 @@ Gets information about the IotHubs in a subscription. ### ListIotHubsByResourceGroup (Default) ``` -Get-AzureRmIotHub [[-ResourceGroupName] ] [] +Get-AzureRmIotHub [[-ResourceGroupName] ] [-DefaultProfile ] + [] ``` ### GetIotHubByName ``` -Get-AzureRmIotHub [-ResourceGroupName] [-Name] [] +Get-AzureRmIotHub [-ResourceGroupName] [-Name] [-DefaultProfile ] + [] ``` ## DESCRIPTION @@ -50,6 +53,21 @@ Gets information about the IotHub named "myiothub". ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Name of the IotHub diff --git a/src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHubConnectionString.md b/src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHubConnectionString.md index d433f2de4578..7ffb0a6510b4 100644 --- a/src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHubConnectionString.md +++ b/src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHubConnectionString.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.IotHub.dll-Help.xml +Module Name: AzureRM.IotHub online version: schema: 2.0.0 --- @@ -13,7 +14,7 @@ Gets the IotHub connectionstrings. ``` Get-AzureRmIotHubConnectionString [-ResourceGroupName] [-Name] [[-KeyName] ] - [] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -38,6 +39,21 @@ Gets the connectionstrings for the key named "mykey" for the iothub named "myiot ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -KeyName Name of the Key diff --git a/src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHubEventHubConsumerGroup.md b/src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHubEventHubConsumerGroup.md index ac2a54e23fbb..d47150949ff5 100644 --- a/src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHubEventHubConsumerGroup.md +++ b/src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHubEventHubConsumerGroup.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.IotHub.dll-Help.xml +Module Name: AzureRM.IotHub online version: schema: 2.0.0 --- @@ -13,7 +14,7 @@ Gets all the eventhub consumergroups. ``` Get-AzureRmIotHubEventHubConsumerGroup [-ResourceGroupName] [-Name] - [-EventHubEndpointName] [] + [-EventHubEndpointName] [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -37,6 +38,21 @@ Gets all the eventhub consumergroups for the operationsMonitoringEvents eventhub ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -EventHubEndpointName Name of the Event Hub endpoint. Possible values events, operationsMonitoringEvents @@ -45,6 +61,7 @@ Possible values events, operationsMonitoringEvents Type: String Parameter Sets: (All) Aliases: +Accepted values: events, operationsMonitoringEvents Required: True Position: 2 diff --git a/src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHubJob.md b/src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHubJob.md index 0b4e3b7564af..1a50c6f1e490 100644 --- a/src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHubJob.md +++ b/src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHubJob.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.IotHub.dll-Help.xml +Module Name: AzureRM.IotHub online version: schema: 2.0.0 --- @@ -12,7 +13,8 @@ Gets the information about an IotHub job. ## SYNTAX ``` -Get-AzureRmIotHubJob [-ResourceGroupName] [-Name] [[-JobId] ] [] +Get-AzureRmIotHubJob [-ResourceGroupName] [-Name] [[-JobId] ] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -38,6 +40,21 @@ Gets information about the job with the identifier "3630fc31-4caa-43e8-a232-ea05 ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -JobId The Job Identifier. diff --git a/src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHubKey.md b/src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHubKey.md index ec2d6d0f6b27..7cc68f7b3d54 100644 --- a/src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHubKey.md +++ b/src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHubKey.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.IotHub.dll-Help.xml +Module Name: AzureRM.IotHub online version: schema: 2.0.0 --- @@ -12,7 +13,8 @@ Gets an IotHub Key. ## SYNTAX ``` -Get-AzureRmIotHubKey [-ResourceGroupName] [-Name] [[-KeyName] ] [] +Get-AzureRmIotHubKey [-ResourceGroupName] [-Name] [[-KeyName] ] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -37,6 +39,21 @@ Gets the information for a key named "iothubowner" for the IotHub named "myiothu ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -KeyName Name of the Key diff --git a/src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHubQuotaMetric.md b/src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHubQuotaMetric.md index 62ced51f06e7..e5b202d113f4 100644 --- a/src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHubQuotaMetric.md +++ b/src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHubQuotaMetric.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.IotHub.dll-Help.xml +Module Name: AzureRM.IotHub online version: schema: 2.0.0 --- @@ -12,7 +13,8 @@ Gets the Quota Metrics for an IotHub. ## SYNTAX ``` -Get-AzureRmIotHubQuotaMetric [-ResourceGroupName] [-Name] [] +Get-AzureRmIotHubQuotaMetric [-ResourceGroupName] [-Name] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -29,6 +31,21 @@ Gets the Quota Metric information for the IotHub named "myiothub" ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Name of the IoT hub. diff --git a/src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHubRegistryStatistic.md b/src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHubRegistryStatistic.md index 9ea8006734c9..4f3906cc3f24 100644 --- a/src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHubRegistryStatistic.md +++ b/src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHubRegistryStatistic.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.IotHub.dll-Help.xml +Module Name: AzureRM.IotHub online version: schema: 2.0.0 --- @@ -12,7 +13,8 @@ Gets the RegistryStatistics for an IotHub. ## SYNTAX ``` -Get-AzureRmIotHubRegistryStatistic [-ResourceGroupName] [-Name] [] +Get-AzureRmIotHubRegistryStatistic [-ResourceGroupName] [-Name] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -30,6 +32,21 @@ Gets the RegistryStatictics for the IotHub named "myiothub" ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Name of the IoT hub. diff --git a/src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHubValidSku.md b/src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHubValidSku.md index 46b83ecf7b64..a411bcb18f08 100644 --- a/src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHubValidSku.md +++ b/src/ResourceManager/IotHub/Commands.IotHub/help/Get-AzureRmIotHubValidSku.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.IotHub.dll-Help.xml +Module Name: AzureRM.IotHub online version: schema: 2.0.0 --- @@ -12,7 +13,8 @@ Gets all valid skus that this IotHub can transition to. ## SYNTAX ``` -Get-AzureRmIotHubValidSku [-ResourceGroupName] [-Name] [] +Get-AzureRmIotHubValidSku [-ResourceGroupName] [-Name] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -31,6 +33,21 @@ Gets a list of all skus for the IotHub named "myiothub" ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Name of the IoT hub. diff --git a/src/ResourceManager/IotHub/Commands.IotHub/help/New-AzureRmIotHub.md b/src/ResourceManager/IotHub/Commands.IotHub/help/New-AzureRmIotHub.md index 69a053db961f..311b66ca59fa 100644 --- a/src/ResourceManager/IotHub/Commands.IotHub/help/New-AzureRmIotHub.md +++ b/src/ResourceManager/IotHub/Commands.IotHub/help/New-AzureRmIotHub.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.IotHub.dll-Help.xml +Module Name: AzureRM.IotHub online version: schema: 2.0.0 --- @@ -12,8 +13,9 @@ Creates a new IotHub. ## SYNTAX ``` -New-AzureRmIotHub [-ResourceGroupName] [-Name] [-SkuName] [-Units] - [-Location] [-Properties ] [-WhatIf] [-Confirm] [] +New-AzureRmIotHub -ResourceGroupName -Name -SkuName -Units + -Location [-Properties ] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -40,6 +42,21 @@ $psCloudToDeviceProperties = New-Object Microsoft.Azure.Commands.Management.IotH ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Location Location where the IoT hub needs to be created. @@ -49,7 +66,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 4 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -64,7 +81,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 1 +Position: Named Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False @@ -94,7 +111,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 0 +Position: Named Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False @@ -110,7 +127,7 @@ Aliases: Accepted values: F1, S1, S2, S3 Required: True -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -125,7 +142,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 3 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/src/ResourceManager/IotHub/Commands.IotHub/help/New-AzureRmIotHubExportDevices.md b/src/ResourceManager/IotHub/Commands.IotHub/help/New-AzureRmIotHubExportDevices.md index 5eb6f8e9bdab..76d0a043d4ad 100644 --- a/src/ResourceManager/IotHub/Commands.IotHub/help/New-AzureRmIotHubExportDevices.md +++ b/src/ResourceManager/IotHub/Commands.IotHub/help/New-AzureRmIotHubExportDevices.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.IotHub.dll-Help.xml +Module Name: AzureRM.IotHub online version: schema: 2.0.0 --- @@ -13,7 +14,8 @@ Creates a new export devices job. ``` New-AzureRmIotHubExportDevices [-ResourceGroupName] [-Name] - [-ExportBlobContainerUri] [-WhatIf] [-Confirm] [] + [-ExportBlobContainerUri] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -33,6 +35,21 @@ Creates a new export device request for the IotHub "myiothub" excluding the keys ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ExportBlobContainerUri The Uri to export the blob to. diff --git a/src/ResourceManager/IotHub/Commands.IotHub/help/New-AzureRmIotHubImportDevices.md b/src/ResourceManager/IotHub/Commands.IotHub/help/New-AzureRmIotHubImportDevices.md index 2078cd641aeb..bf04624c0afe 100644 --- a/src/ResourceManager/IotHub/Commands.IotHub/help/New-AzureRmIotHubImportDevices.md +++ b/src/ResourceManager/IotHub/Commands.IotHub/help/New-AzureRmIotHubImportDevices.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.IotHub.dll-Help.xml +Module Name: AzureRM.IotHub online version: schema: 2.0.0 --- @@ -13,7 +14,8 @@ Creates a new import devices job. ``` New-AzureRmIotHubImportDevices [-ResourceGroupName] [-Name] [-InputBlobContainerUri] - [-OutputBlobContainerUri] [-WhatIf] [-Confirm] [] + [-OutputBlobContainerUri] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -33,6 +35,21 @@ Creates a new import device request for the IotHub "myiothub". ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InputBlobContainerUri Input Blob Container Uri for FileUpload diff --git a/src/ResourceManager/IotHub/Commands.IotHub/help/Remove-AzureRmIotHub.md b/src/ResourceManager/IotHub/Commands.IotHub/help/Remove-AzureRmIotHub.md index f224ae9f34d9..dc7c61ba1c63 100644 --- a/src/ResourceManager/IotHub/Commands.IotHub/help/Remove-AzureRmIotHub.md +++ b/src/ResourceManager/IotHub/Commands.IotHub/help/Remove-AzureRmIotHub.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.IotHub.dll-Help.xml +Module Name: AzureRM.IotHub online version: schema: 2.0.0 --- @@ -12,7 +13,8 @@ Deletes an IotHub. ## SYNTAX ``` -Remove-AzureRmIotHub [-ResourceGroupName] [-Name] [-WhatIf] [-Confirm] [] +Remove-AzureRmIotHub [-ResourceGroupName] [-Name] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -29,6 +31,21 @@ Removes an IotHub named "myiothub" ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Name of the IotHub diff --git a/src/ResourceManager/IotHub/Commands.IotHub/help/Remove-AzureRmIotHubEventHubConsumerGroup.md b/src/ResourceManager/IotHub/Commands.IotHub/help/Remove-AzureRmIotHubEventHubConsumerGroup.md index 4908cfc12b7f..0e255708d9f6 100644 --- a/src/ResourceManager/IotHub/Commands.IotHub/help/Remove-AzureRmIotHubEventHubConsumerGroup.md +++ b/src/ResourceManager/IotHub/Commands.IotHub/help/Remove-AzureRmIotHubEventHubConsumerGroup.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.IotHub.dll-Help.xml +Module Name: AzureRM.IotHub online version: schema: 2.0.0 --- @@ -13,8 +14,8 @@ Deletes an eventhub consumergroup. ``` Remove-AzureRmIotHubEventHubConsumerGroup [-ResourceGroupName] [-Name] - [-EventHubEndpointName] [-EventHubConsumerGroupName] [-WhatIf] [-Confirm] - [] + [-EventHubEndpointName] [-EventHubConsumerGroupName] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -31,6 +32,21 @@ Removes the consumergroup named myconsumergroup from the IotHub named "myiothub" ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -EventHubConsumerGroupName EventHub ConsumerGroup Name. @@ -54,6 +70,7 @@ Possible values events, operationsMonitoringEvents Type: String Parameter Sets: (All) Aliases: +Accepted values: events, operationsMonitoringEvents Required: True Position: 2 diff --git a/src/ResourceManager/IotHub/Commands.IotHub/help/Remove-AzureRmIotHubKey.md b/src/ResourceManager/IotHub/Commands.IotHub/help/Remove-AzureRmIotHubKey.md index 5cb9b84cd0e5..428ded14f153 100644 --- a/src/ResourceManager/IotHub/Commands.IotHub/help/Remove-AzureRmIotHubKey.md +++ b/src/ResourceManager/IotHub/Commands.IotHub/help/Remove-AzureRmIotHubKey.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.IotHub.dll-Help.xml +Module Name: AzureRM.IotHub online version: schema: 2.0.0 --- @@ -12,8 +13,8 @@ Removes an IotHub Key. ## SYNTAX ``` -Remove-AzureRmIotHubKey [-ResourceGroupName] [-Name] [-KeyName] [-WhatIf] [-Confirm] - [] +Remove-AzureRmIotHubKey [-ResourceGroupName] [-Name] [-KeyName] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -31,6 +32,21 @@ Removes the key named iothubowner1 from the IotHub named "myiothub" ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -KeyName Name of the Key diff --git a/src/ResourceManager/IotHub/Commands.IotHub/help/Set-AzureRmIotHub.md b/src/ResourceManager/IotHub/Commands.IotHub/help/Set-AzureRmIotHub.md index e63c2594e079..1f3c89b46df2 100644 --- a/src/ResourceManager/IotHub/Commands.IotHub/help/Set-AzureRmIotHub.md +++ b/src/ResourceManager/IotHub/Commands.IotHub/help/Set-AzureRmIotHub.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.IotHub.dll-Help.xml +Module Name: AzureRM.IotHub online version: schema: 2.0.0 --- @@ -13,53 +14,54 @@ Updates the properties of an IotHub. ### UpdateSku (Default) ``` -Set-AzureRmIotHub [-ResourceGroupName] [-Name] -SkuName [-Units ] - [-WhatIf] [-Confirm] [] +Set-AzureRmIotHub -ResourceGroupName -Name -SkuName [-Units ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### UpdateEventHubEndpointProperties ``` -Set-AzureRmIotHub [-ResourceGroupName] [-Name] -EventHubRetentionTimeInDays [-WhatIf] - [-Confirm] [] +Set-AzureRmIotHub -ResourceGroupName -Name -EventHubRetentionTimeInDays + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### UpdateFileUploadProperties ``` -Set-AzureRmIotHub [-ResourceGroupName] [-Name] [-FileUploadStorageConnectionString ] +Set-AzureRmIotHub -ResourceGroupName -Name [-FileUploadStorageConnectionString ] [-FileUploadContainerName ] [-FileUploadSasUriTtl ] [-FileUploadNotificationTtl ] - [-FileUploadNotificationMaxDeliveryCount ] -EnableFileUploadNotifications [-WhatIf] - [-Confirm] [] + [-FileUploadNotificationMaxDeliveryCount ] -EnableFileUploadNotifications + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### UpdateCloudToDeviceProperties ``` -Set-AzureRmIotHub [-ResourceGroupName] [-Name] -CloudToDevice - [-WhatIf] [-Confirm] [] +Set-AzureRmIotHub -ResourceGroupName -Name -CloudToDevice + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### UpdateOperationsMonitoringProperties ``` -Set-AzureRmIotHub [-ResourceGroupName] [-Name] - -OperationsMonitoringProperties [-WhatIf] [-Confirm] [] +Set-AzureRmIotHub -ResourceGroupName -Name + -OperationsMonitoringProperties [-DefaultProfile ] + [-WhatIf] [-Confirm] [] ``` ### UpdateRoutingProperties ``` -Set-AzureRmIotHub [-ResourceGroupName] [-Name] [-RoutingProperties ] - [-WhatIf] [-Confirm] [] +Set-AzureRmIotHub -ResourceGroupName -Name [-RoutingProperties ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### UpdateRouteProperties ``` -Set-AzureRmIotHub [-ResourceGroupName] [-Name] +Set-AzureRmIotHub -ResourceGroupName -Name [-Routes ] - [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### UpdateFallbackRouteProperty ``` -Set-AzureRmIotHub [-ResourceGroupName] [-Name] [-FallbackRoute ] - [-WhatIf] [-Confirm] [] +Set-AzureRmIotHub -ResourceGroupName -Name [-FallbackRoute ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -98,6 +100,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -EnableFileUploadNotifications Flag that specifies whether notifications should be enabled for file upload. @@ -227,7 +244,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 1 +Position: Named Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False @@ -257,7 +274,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 0 +Position: Named Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False diff --git a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Add-AzureKeyVaultCertificate.md b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Add-AzureKeyVaultCertificate.md index 7bd867cbf8fd..e8db38db14f4 100644 --- a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Add-AzureKeyVaultCertificate.md +++ b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Add-AzureKeyVaultCertificate.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml +Module Name: AzureRM.KeyVault ms.assetid: 89299823-3382-402D-9458-519466748051 online version: schema: 2.0.0 @@ -14,8 +15,8 @@ Adds a certificate to a key vault. ``` Add-AzureKeyVaultCertificate [-VaultName] [-Name] - [[-CertificatePolicy] ] [-Tag ] [-WhatIf] [-Confirm] - [] + [[-CertificatePolicy] ] [-Tag ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -93,12 +94,27 @@ Parameter Sets: (All) Aliases: Required: False -Position: 3 +Position: 2 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Specifies the name of the certificate to add. @@ -108,7 +124,7 @@ Parameter Sets: (All) Aliases: CertificateName Required: True -Position: 2 +Position: 1 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False @@ -140,7 +156,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 1 +Position: 0 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False diff --git a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Add-AzureKeyVaultCertificateContact.md b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Add-AzureKeyVaultCertificateContact.md index 67a8871a29ee..ba723cee717f 100644 --- a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Add-AzureKeyVaultCertificateContact.md +++ b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Add-AzureKeyVaultCertificateContact.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml +Module Name: AzureRM.KeyVault ms.assetid: 2D3021B3-12C5-4797-8BF2-800E3CEAC56C online version: schema: 2.0.0 @@ -13,8 +14,8 @@ Adds a contact for certificate notifications. ## SYNTAX ``` -Add-AzureKeyVaultCertificateContact [-VaultName] [-EmailAddress] [-PassThru] [-WhatIf] - [-Confirm] [] +Add-AzureKeyVaultCertificateContact [-VaultName] [-EmailAddress] [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -33,6 +34,21 @@ This command adds Patti Fuller as a certificate contact for the ContosoKV01 key ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -EmailAddress Specifies the email address of the contact. @@ -42,7 +58,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 2 +Position: 1 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False @@ -73,7 +89,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 1 +Position: 0 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False diff --git a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Add-AzureKeyVaultKey.md b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Add-AzureKeyVaultKey.md index 502656f71b9a..7ffe575e75c7 100644 --- a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Add-AzureKeyVaultKey.md +++ b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Add-AzureKeyVaultKey.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml +Module Name: AzureRM.KeyVault ms.assetid: 846F781C-73A3-4BBE-ABD9-897371109FBE online version: http://go.microsoft.com/fwlink/?LinkId=690295 schema: 2.0.0 @@ -15,15 +16,16 @@ Creates a key in a key vault or imports a key into a key vault. ### Create (Default) ``` Add-AzureKeyVaultKey [-VaultName] [-Name] -Destination [-Disable] - [-KeyOps ] [-Expires ] [-NotBefore ] [-Tag ] [-WhatIf] [-Confirm] - [] + [-KeyOps ] [-Expires ] [-NotBefore ] [-Tag ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### Import ``` Add-AzureKeyVaultKey [-VaultName] [-Name] -KeyFilePath [-KeyFilePassword ] [-Destination ] [-Disable] [-KeyOps ] - [-Expires ] [-NotBefore ] [-Tag ] [-WhatIf] [-Confirm] [] + [-Expires ] [-NotBefore ] [-Tag ] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -141,13 +143,13 @@ stored in $tags. ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure ```yaml -Type: SwitchParameter +Type: IAzureContextContainer Parameter Sets: (All) -Aliases: cf +Aliases: AzureRmContext, AzureCredential Required: False Position: Named @@ -177,7 +179,7 @@ extension, it imports the key as a software-protected key. ```yaml Type: String Parameter Sets: Create -Aliases: +Aliases: Accepted values: HSM, Software Required: True @@ -190,7 +192,7 @@ Accept wildcard characters: False ```yaml Type: String Parameter Sets: Import -Aliases: +Aliases: Accepted values: HSM, Software Required: False @@ -207,7 +209,7 @@ the key will fail. Use this parameter if you are preloading keys that you intend ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -225,7 +227,7 @@ parameter, the key does not expire. ```yaml Type: DateTime Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -243,7 +245,7 @@ name extension. ```yaml Type: SecureString Parameter Sets: Import -Aliases: +Aliases: Required: False Position: Named @@ -267,7 +269,7 @@ When you specify this parameter, the *Destination* parameter is optional. ```yaml Type: String Parameter Sets: Import -Aliases: +Aliases: Required: True Position: Named @@ -295,7 +297,7 @@ the [JSON Web Key (JWK) specification](http://go.microsoft.com/fwlink/?LinkID=61 ```yaml Type: String[] Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -330,7 +332,7 @@ parameter, the key can be used immediately. ```yaml Type: DateTime Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -363,7 +365,7 @@ FQDN of a key vault based on the name that this parameter specifies and your cur ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 @@ -372,6 +374,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. diff --git a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Add-AzureKeyVaultManagedStorageAccount.md b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Add-AzureKeyVaultManagedStorageAccount.md index 5d643acea73b..dfcddd06705e 100644 --- a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Add-AzureKeyVaultManagedStorageAccount.md +++ b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Add-AzureKeyVaultManagedStorageAccount.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml +Module Name: AzureRM.KeyVault online version: https://msdn.microsoft.com/en-us/library/dn868052.aspx schema: 2.0.0 --- @@ -14,7 +15,8 @@ Adds an existing Azure Storage Account to the specified key vault for its keys t ``` Add-AzureKeyVaultManagedStorageAccount [-VaultName] [-AccountName] [-AccountResourceId] [-ActiveKeyName] [-DisableAutoRegenerateKey] - [-RegenerationPeriod ] [-Disable] [-Tag ] [-WhatIf] [-Confirm] [] + [-RegenerationPeriod ] [-Disable] [-Tag ] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -86,7 +88,7 @@ Name of the storage account key that must be used for generating sas tokens. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 3 @@ -95,13 +97,13 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure ```yaml -Type: SwitchParameter +Type: IAzureContextContainer Parameter Sets: (All) -Aliases: cf +Aliases: AzureRmContext, AzureCredential Required: False Position: Named @@ -116,7 +118,7 @@ Disables the use of managed storage account's key for generation of sas tokens. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -133,7 +135,7 @@ storage account are not auto regenerated. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -149,7 +151,7 @@ which managed storage account's inactive keygets auto regenerated and becomes th ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -182,7 +184,7 @@ Cmdlet constructs the FQDN of a vault based on the name and currently selected e ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 @@ -191,6 +193,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. diff --git a/src/ResourceManager/KeyVault/Commands.KeyVault/help/AzureRM.KeyVault.md b/src/ResourceManager/KeyVault/Commands.KeyVault/help/AzureRM.KeyVault.md index f06ec42c0b40..b71a952438df 100644 --- a/src/ResourceManager/KeyVault/Commands.KeyVault/help/AzureRM.KeyVault.md +++ b/src/ResourceManager/KeyVault/Commands.KeyVault/help/AzureRM.KeyVault.md @@ -20,8 +20,8 @@ Adds a contact for certificate notifications. ### [Add-AzureKeyVaultKey](Add-AzureKeyVaultKey.md) Creates a key in a key vault or imports a key into a key vault. -### [Add-AzureKeyVaultManagedStorageAccount](Add-AzureKeyVaultManagedStorageAccount.md) -Adds a KeyVault-managed storage account to a key vault. +### [Add-AzureKeyVaultManagedStorageAccount](Add-AzureKeyVaultManagedStorageAccount.md) +Adds an existing Azure Storage Account to the specified key vault for its keys to be managed by the Key Vault service. ### [Backup-AzureKeyVaultKey](Backup-AzureKeyVaultKey.md) Backs up a key in a key vault. @@ -59,6 +59,9 @@ Gets the secrets in a key vault. ### [Get-AzureRmKeyVault](Get-AzureRmKeyVault.md) Gets key vaults. +### [Import-AzureKeyVaultCertificate](Import-AzureKeyVaultCertificate.md) +Imports a certificate to a key vault. + ### [New-AzureKeyVaultCertificateAdministratorDetails](New-AzureKeyVaultCertificateAdministratorDetails.md) Creates an in-memory certificate administrator details object. @@ -116,17 +119,17 @@ Sets a certificate issuer in a key vault. ### [Set-AzureKeyVaultCertificatePolicy](Set-AzureKeyVaultCertificatePolicy.md) Creates or updates the policy for a certificate in a key vault. -### [Set-AzureKeyVaultCertificatePolicy](Set-AzureKeyVaultCertificatePolicy.md) -Creates or updates the policy for a certificate in a key vault. +### [Set-AzureKeyVaultKeyAttribute](Set-AzureKeyVaultKeyAttribute.md) +Updates the attributes of a key in a key vault. -### [Set-AzureKeyVaultCertificatePolicy](Set-AzureKeyVaultCertificatePolicy.md) -Creates or updates the policy for a certificate in a key vault. +### [Set-AzureKeyVaultManagedStorageSasDefinition](Set-AzureKeyVaultManagedStorageSasDefinition.md) +Sets a Shared Access Signature (SAS) definition with Key Vault for a given Key Vault managed Azure Storage Account. -### [Set-AzureKeyVaultCertificatePolicy](Set-AzureKeyVaultCertificatePolicy.md) -Creates or updates the policy for a certificate in a key vault. +### [Set-AzureKeyVaultSecret](Set-AzureKeyVaultSecret.md) +Creates or updates a secret in a key vault. -### [Set-AzureKeyVaultCertificatePolicy](Set-AzureKeyVaultCertificatePolicy.md) -Creates or updates the policy for a certificate in a key vault. +### [Set-AzureKeyVaultSecretAttribute](Set-AzureKeyVaultSecretAttribute.md) +Updates attributes of a secret in a key vault. ### [Set-AzureRmKeyVaultAccessPolicy](Set-AzureRmKeyVaultAccessPolicy.md) Grants or modifies existing permissions for a user, application, or security group to perform operations with a key vault. @@ -146,8 +149,8 @@ Recovers a deleted secret in a key vault into an active state. ### [Undo-AzureRmKeyVaultRemoval](Undo-AzureRmKeyVaultRemoval.md) Recovers a deleted key vault into an active state. -### [Undo-AzureRmKeyVaultRemoval](Undo-AzureRmKeyVaultRemoval.md) -Recovers a deleted key vault into an active state. +### [Update-AzureKeyVaultManagedStorageAccount](Update-AzureKeyVaultManagedStorageAccount.md) +Update editable attributes of a Key Vault managed Azure Storage Account. ### [Update-AzureKeyVaultManagedStorageAccountKey](Update-AzureKeyVaultManagedStorageAccountKey.md) Regenerates the specified key of Key Vault managed Azure Storage Account. diff --git a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Backup-AzureKeyVaultKey.md b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Backup-AzureKeyVaultKey.md index 78435de8f662..2f40bf70f162 100644 --- a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Backup-AzureKeyVaultKey.md +++ b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Backup-AzureKeyVaultKey.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml +Module Name: AzureRM.KeyVault ms.assetid: A82392AA-B12B-443E-8704-7CF5A9F8ED58 online version: http://go.microsoft.com/fwlink/?LinkId=690296 schema: 2.0.0 @@ -14,14 +15,14 @@ Backs up a key in a key vault. ### ByKeyName (Default) ``` -Backup-AzureKeyVaultKey [-VaultName] [-Name] [[-OutputFile] ] [-Force] [-WhatIf] - [-Confirm] [] +Backup-AzureKeyVaultKey [-VaultName] [-Name] [[-OutputFile] ] [-Force] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### ByKey ``` -Backup-AzureKeyVaultKey [-Key] [[-OutputFile] ] [-Force] [-WhatIf] [-Confirm] - [] +Backup-AzureKeyVaultKey [-Key] [[-OutputFile] ] [-Force] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -63,6 +64,21 @@ This command creates a backup of the key named $key.Name in the vault named $key ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Overwrite the given file if it exists @@ -102,7 +118,7 @@ Parameter Sets: ByKeyName Aliases: KeyName Required: True -Position: 2 +Position: 1 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False @@ -119,7 +135,7 @@ Parameter Sets: (All) Aliases: Required: False -Position: 3 +Position: 2 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False @@ -134,7 +150,7 @@ Parameter Sets: ByKeyName Aliases: Required: True -Position: 1 +Position: 0 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False diff --git a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Backup-AzureKeyVaultSecret.md b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Backup-AzureKeyVaultSecret.md index fc89ae120cd7..bd1178196ad2 100644 --- a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Backup-AzureKeyVaultSecret.md +++ b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Backup-AzureKeyVaultSecret.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml +Module Name: AzureRM.KeyVault ms.assetid: 80AAA327-77C6-4372-9461-FFED5A15E678 online version: http://go.microsoft.com/fwlink/?LinkId=690296 schema: 2.0.0 @@ -14,14 +15,14 @@ Backs up a secret in a key vault. ### BySecretName (Default) ``` -Backup-AzureKeyVaultSecret [-VaultName] [-Name] [[-OutputFile] ] [-Force] [-WhatIf] - [-Confirm] [] +Backup-AzureKeyVaultSecret [-VaultName] [-Name] [[-OutputFile] ] [-Force] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### BySecret ``` -Backup-AzureKeyVaultSecret [-Secret] [[-OutputFile] ] [-Force] [-WhatIf] [-Confirm] - [] +Backup-AzureKeyVaultSecret [-Secret] [[-OutputFile] ] [-Force] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -61,6 +62,21 @@ This command uses the $secret object's vault name and name to retrieves the secr ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Prompts you for confirmation before overwriting the output file, if that exists. diff --git a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureKeyVaultCertificate.md b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureKeyVaultCertificate.md index 6200a3920132..20ee6ed5ade6 100644 --- a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureKeyVaultCertificate.md +++ b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureKeyVaultCertificate.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml +Module Name: AzureRM.KeyVault ms.assetid: 363FA51E-D075-4800-A4BE-BFF63FD25C90 online version: schema: 2.0.0 @@ -14,27 +15,26 @@ Gets a certificate from a key vault. ### ByVaultName (Default) ``` -Get-AzureKeyVaultCertificate [-VaultName] [] -``` - -### ByDeletedCertificates -``` -Get-AzureKeyVaultCertificate [-VaultName] [-Name] [-InRemovedState] [] +Get-AzureKeyVaultCertificate [-VaultName] [-DefaultProfile ] + [] ``` ### ByCertificateName ``` -Get-AzureKeyVaultCertificate [-VaultName] [-Name] [[-Version] ] [] +Get-AzureKeyVaultCertificate [-VaultName] [-Name] [[-Version] ] + [-DefaultProfile ] [] ``` ### ByCertificateVersions ``` -Get-AzureKeyVaultCertificate [-VaultName] [-Name] [-IncludeVersions] [] +Get-AzureKeyVaultCertificate [-VaultName] [-Name] [-IncludeVersions] + [-DefaultProfile ] [] ``` ### ByDeletedCertificates ``` -Get-AzureKeyVaultCertificate [-VaultName] [[-Name] ] [-InRemovedState] [] +Get-AzureKeyVaultCertificate [-VaultName] [[-Name] ] [-InRemovedState] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -90,6 +90,21 @@ This command will return metadata such as the deletion date, and the scheduled p ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -IncludeVersions Indicates that this operation gets all versions of the certificate. @@ -106,7 +121,9 @@ Accept wildcard characters: False ``` ### -InRemovedState -Specifies whether to include previously deleted certificates in the output.```yaml +Specifies whether to include previously deleted certificates in the output + +```yaml Type: SwitchParameter Parameter Sets: ByDeletedCertificates Aliases: @@ -123,11 +140,11 @@ Specifies the name of the certificate to get. ```yaml Type: String -Parameter Sets: ByDeletedCertificates, ByCertificateName, ByCertificateVersions +Parameter Sets: ByCertificateName, ByCertificateVersions Aliases: CertificateName Required: True -Position: 2 +Position: 1 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False @@ -139,7 +156,7 @@ Parameter Sets: ByDeletedCertificates Aliases: CertificateName Required: False -Position: 2 +Position: 1 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False @@ -154,7 +171,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 1 +Position: 0 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False @@ -169,7 +186,7 @@ Parameter Sets: ByCertificateName Aliases: CertificateVersion Required: False -Position: 3 +Position: 2 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False diff --git a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureKeyVaultCertificateContact.md b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureKeyVaultCertificateContact.md index 9de772505807..ecc9ca8fcc1a 100644 --- a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureKeyVaultCertificateContact.md +++ b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureKeyVaultCertificateContact.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml +Module Name: AzureRM.KeyVault ms.assetid: 200C68A3-A79C-4517-8E5D-8128F6C73A5C online version: schema: 2.0.0 @@ -13,7 +14,8 @@ Gets contacts that are registered for certificate notifications for a key vault. ## SYNTAX ``` -Get-AzureKeyVaultCertificateContact [-VaultName] [] +Get-AzureKeyVaultCertificateContact [-VaultName] [-DefaultProfile ] + [] ``` ## DESCRIPTION @@ -30,6 +32,21 @@ This command gets all of the contacts for the certificate objects in the Contoso ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -VaultName Specifies the name of the key vault. @@ -39,7 +56,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 1 +Position: 0 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False diff --git a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureKeyVaultCertificateIssuer.md b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureKeyVaultCertificateIssuer.md index e6c3ec453315..9d1a8398818d 100644 --- a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureKeyVaultCertificateIssuer.md +++ b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureKeyVaultCertificateIssuer.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml +Module Name: AzureRM.KeyVault ms.assetid: 5F856280-C561-47B5-AA96-27E34C86D604 online version: schema: 2.0.0 @@ -14,12 +15,14 @@ Gets a certificate issuer for a key vault. ### ByVaultName (Default) ``` -Get-AzureKeyVaultCertificateIssuer [-VaultName] [] +Get-AzureKeyVaultCertificateIssuer [-VaultName] [-DefaultProfile ] + [] ``` ### ByName ``` -Get-AzureKeyVaultCertificateIssuer [-VaultName] [-Name] [] +Get-AzureKeyVaultCertificateIssuer [-VaultName] [-Name] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -41,6 +44,21 @@ This command gets the certificate issuer named TestIssuer01. ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Specifies the name of the certificate issuer to get. @@ -50,7 +68,7 @@ Parameter Sets: ByName Aliases: IssuerName Required: True -Position: 2 +Position: 1 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False @@ -65,7 +83,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 1 +Position: 0 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False diff --git a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureKeyVaultCertificateOperation.md b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureKeyVaultCertificateOperation.md index f03359083842..905bb1de93e2 100644 --- a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureKeyVaultCertificateOperation.md +++ b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureKeyVaultCertificateOperation.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml +Module Name: AzureRM.KeyVault ms.assetid: 0743C43D-2A1F-4950-B0F3-1FED4014EEC5 online version: schema: 2.0.0 @@ -13,7 +14,8 @@ Gets the status of a certificate operation. ## SYNTAX ``` -Get-AzureKeyVaultCertificateOperation [-VaultName] [-Name] [] +Get-AzureKeyVaultCertificateOperation [-VaultName] [-Name] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -40,6 +42,21 @@ This command gets the status of the certificate operation for TestCert01 on the ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Specifies the name of a certificate. @@ -49,7 +66,7 @@ Parameter Sets: (All) Aliases: CertificateName Required: True -Position: 2 +Position: 1 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False @@ -64,7 +81,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 1 +Position: 0 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False diff --git a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureKeyVaultCertificatePolicy.md b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureKeyVaultCertificatePolicy.md index 3662db8fdaab..82d433d72e13 100644 --- a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureKeyVaultCertificatePolicy.md +++ b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureKeyVaultCertificatePolicy.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml +Module Name: AzureRM.KeyVault ms.assetid: 0729687C-3104-4136-A80D-16BAEBD6B76C online version: schema: 2.0.0 @@ -13,7 +14,8 @@ Gets the policy for a certificate in a key vault. ## SYNTAX ``` -Get-AzureKeyVaultCertificatePolicy [-VaultName] [-Name] [] +Get-AzureKeyVaultCertificatePolicy [-VaultName] [-Name] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -46,6 +48,21 @@ This command gets the certificate policy for TestCert01 certificate in the Conto ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Specifies the name of a certificate. @@ -55,7 +72,7 @@ Parameter Sets: (All) Aliases: CertificateName Required: True -Position: 2 +Position: 1 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False @@ -70,7 +87,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 1 +Position: 0 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False diff --git a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureKeyVaultKey.md b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureKeyVaultKey.md index bb57f7b628c2..e5014fd60c48 100644 --- a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureKeyVaultKey.md +++ b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureKeyVaultKey.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml +Module Name: AzureRM.KeyVault ms.assetid: 2BE34AE1-06FA-4F66-8FDB-CED22C2E0978 online version: http://go.microsoft.com/fwlink/?LinkId=690297 schema: 2.0.0 @@ -14,22 +15,25 @@ Gets Key Vault keys. ### ByVaultName (Default) ``` -Get-AzureKeyVaultKey [-VaultName] [] +Get-AzureKeyVaultKey [-VaultName] [-DefaultProfile ] [] ``` ### ByKeyName ``` -Get-AzureKeyVaultKey [-VaultName] [-Name] [[-Version] ] [] +Get-AzureKeyVaultKey [-VaultName] [-Name] [[-Version] ] + [-DefaultProfile ] [] ``` ### ByKeyVersions ``` -Get-AzureKeyVaultKey [-VaultName] [-Name] [-IncludeVersions] [] +Get-AzureKeyVaultKey [-VaultName] [-Name] [-IncludeVersions] + [-DefaultProfile ] [] ``` ### ByDeletedKey ``` -Get-AzureKeyVaultKey [-VaultName] [[-Name] ] [-InRemovedState] [] +Get-AzureKeyVaultKey [-VaultName] [[-Name] ] [-InRemovedState] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -84,6 +88,21 @@ This command will return metadata such as the deletion date, and the scheduled p ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -IncludeVersions Indicates that this cmdlet gets all versions of a key. The current version of a key is the first one on the list. @@ -104,7 +123,9 @@ Accept wildcard characters: False ``` ### -InRemovedState -Specifies whether to show the previously deleted keys in the output.```yaml +Specifies whether to show the previously deleted keys in the output + +```yaml Type: SwitchParameter Parameter Sets: ByDeletedKey Aliases: @@ -125,7 +146,7 @@ Parameter Sets: ByKeyName, ByKeyVersions Aliases: KeyName Required: True -Position: 2 +Position: 1 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False @@ -137,7 +158,7 @@ Parameter Sets: ByDeletedKey Aliases: KeyName Required: False -Position: 2 +Position: 1 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False @@ -153,7 +174,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 1 +Position: 0 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False @@ -169,7 +190,7 @@ Parameter Sets: ByKeyName Aliases: KeyVersion Required: False -Position: 3 +Position: 2 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False diff --git a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureKeyVaultManagedStorageAccount.md b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureKeyVaultManagedStorageAccount.md index 924fa20402c1..794f32649d8e 100644 --- a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureKeyVaultManagedStorageAccount.md +++ b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureKeyVaultManagedStorageAccount.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml +Module Name: AzureRM.KeyVault online version: https://msdn.microsoft.com/en-us/library/dn868052.aspx schema: 2.0.0 --- @@ -13,12 +14,14 @@ Gets Key Vault managed Azure Storage Accounts. ### ByVaultName (Default) ``` -Get-AzureKeyVaultManagedStorageAccount [-VaultName] [] +Get-AzureKeyVaultManagedStorageAccount [-VaultName] [-DefaultProfile ] + [] ``` ### ByAccountName ``` -Get-AzureKeyVaultManagedStorageAccount [-VaultName] [-AccountName] [] +Get-AzureKeyVaultManagedStorageAccount [-VaultName] [-AccountName] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -57,6 +60,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -VaultName Vault name. Cmdlet constructs the FQDN of a vault based on the name and currently selected environment. diff --git a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureKeyVaultManagedStorageSasDefinition.md b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureKeyVaultManagedStorageSasDefinition.md index fa86f6d983c8..35a4ebb02a28 100644 --- a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureKeyVaultManagedStorageSasDefinition.md +++ b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureKeyVaultManagedStorageSasDefinition.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml +Module Name: AzureRM.KeyVault online version: https://msdn.microsoft.com/en-us/library/dn868052.aspx schema: 2.0.0 --- @@ -13,13 +14,14 @@ Gets Key Vault managed Storage SAS Definitions. ### ByAccountName (Default) ``` -Get-AzureKeyVaultManagedStorageSasDefinition [-VaultName] [-AccountName] [] +Get-AzureKeyVaultManagedStorageSasDefinition [-VaultName] [-AccountName] + [-DefaultProfile ] [] ``` ### ByDefinitionName ``` Get-AzureKeyVaultManagedStorageSasDefinition [-VaultName] [-AccountName] [-Name] - [] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -59,6 +61,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Storage sas definition name. Cmdlet constructs the FQDN of a storage sas definition from vault name, currently selected environment, storage account name and sas definition name. diff --git a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureKeyVaultSecret.md b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureKeyVaultSecret.md index 09f17f56e155..caaedd9d374a 100644 --- a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureKeyVaultSecret.md +++ b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureKeyVaultSecret.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml +Module Name: AzureRM.KeyVault ms.assetid: 8C9B33EE-10DE-4803-B76D-FE9FC2AC3372 online version: http://go.microsoft.com/fwlink/?LinkId=690298 schema: 2.0.0 @@ -14,22 +15,25 @@ Gets the secrets in a key vault. ### ByVaultName (Default) ``` -Get-AzureKeyVaultSecret [-VaultName] [] +Get-AzureKeyVaultSecret [-VaultName] [-DefaultProfile ] [] ``` ### BySecretName ``` -Get-AzureKeyVaultSecret [-VaultName] [-Name] [[-Version] ] [] +Get-AzureKeyVaultSecret [-VaultName] [-Name] [[-Version] ] + [-DefaultProfile ] [] ``` ### BySecretVersions ``` -Get-AzureKeyVaultSecret [-VaultName] [-Name] [-IncludeVersions] [] +Get-AzureKeyVaultSecret [-VaultName] [-Name] [-IncludeVersions] + [-DefaultProfile ] [] ``` ### ByDeletedSecrets ``` -Get-AzureKeyVaultSecret [-VaultName] [[-Name] ] [-InRemovedState] [] +Get-AzureKeyVaultSecret [-VaultName] [[-Name] ] [-InRemovedState] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -91,6 +95,21 @@ This command will return metadata such as the deletion date, and the scheduled p ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -IncludeVersions Indicates that this cmdlet gets all versions of a secret. The current version of a secret is the first one on the list. @@ -111,7 +130,9 @@ Accept wildcard characters: False ``` ### -InRemovedState -Specifies whether to show the previously deleted secrets in the output.```yaml +Specifies whether to show the previously deleted secrets in the output + +```yaml Type: SwitchParameter Parameter Sets: ByDeletedSecrets Aliases: @@ -132,7 +153,7 @@ Parameter Sets: BySecretName, BySecretVersions Aliases: SecretName Required: True -Position: 2 +Position: 1 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False @@ -144,7 +165,7 @@ Parameter Sets: ByDeletedSecrets Aliases: SecretName Required: False -Position: 2 +Position: 1 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False @@ -160,7 +181,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 1 +Position: 0 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False @@ -176,7 +197,7 @@ Parameter Sets: BySecretName Aliases: SecretVersion Required: False -Position: 3 +Position: 2 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False diff --git a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureRmKeyVault.md b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureRmKeyVault.md index 8ebd07afffa9..c22734b44d18 100644 --- a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureRmKeyVault.md +++ b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Get-AzureRmKeyVault.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml +Module Name: AzureRM.KeyVault ms.assetid: A7C287C4-E9FD-407A-91BD-EFA17C33FC8B online version: http://go.microsoft.com/fwlink/?LinkID=690161 schema: 2.0.0 @@ -14,27 +15,30 @@ Gets key vaults. ### GetVaultByName ``` -Get-AzureRmKeyVault [-VaultName] [[-ResourceGroupName] ] [] +Get-AzureRmKeyVault [-VaultName] [[-ResourceGroupName] ] + [-DefaultProfile ] [] ``` ### ByDeletedVault ``` -Get-AzureRmKeyVault [-VaultName] [-Location] [-InRemovedState] [] +Get-AzureRmKeyVault [-VaultName] [-Location] [-InRemovedState] + [-DefaultProfile ] [] ``` ### ListVaultsByResourceGroup ``` -Get-AzureRmKeyVault [-ResourceGroupName] [] +Get-AzureRmKeyVault [-ResourceGroupName] [-DefaultProfile ] + [] ``` ### ListAllDeletedVaultsInSubscription ``` -Get-AzureRmKeyVault [-InRemovedState] [] +Get-AzureRmKeyVault [-InRemovedState] [-DefaultProfile ] [] ``` ### ListAllVaultsInSubscription ``` -Get-AzureRmKeyVault [-Tag ] [] +Get-AzureRmKeyVault [-Tag ] [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -87,6 +91,21 @@ subscription and in eastus2 region. ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InRemovedState Specifies whether to show the previously deleted vaults in the output. @@ -126,7 +145,7 @@ Parameter Sets: GetVaultByName Aliases: Required: False -Position: 2 +Position: 1 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False @@ -138,7 +157,7 @@ Parameter Sets: ListVaultsByResourceGroup Aliases: Required: True -Position: 2 +Position: 1 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False @@ -170,7 +189,7 @@ Parameter Sets: GetVaultByName, ByDeletedVault Aliases: Name Required: True -Position: 1 +Position: 0 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False diff --git a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Import-AzureKeyVaultCertificate.md b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Import-AzureKeyVaultCertificate.md index b163020a1033..b940dd41807a 100644 --- a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Import-AzureKeyVaultCertificate.md +++ b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Import-AzureKeyVaultCertificate.md @@ -1,7 +1,8 @@ --- external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml +Module Name: AzureRM.KeyVault ms.assetid: D4188DC6-A8AB-4B45-9781-94B74C338C63 -online version: +online version: schema: 2.0.0 --- @@ -15,26 +16,28 @@ Imports a certificate to a key vault. ### ImportCertificateFromFile (Default) ``` Import-AzureKeyVaultCertificate [-VaultName] [-Name] -FilePath [-Tag ] - [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### ImportWithPrivateKeyFromFile ``` Import-AzureKeyVaultCertificate [-VaultName] [-Name] -FilePath - [-Password ] [-Tag ] [-WhatIf] [-Confirm] [] + [-Password ] [-Tag ] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ### ImportWithPrivateKeyFromString ``` Import-AzureKeyVaultCertificate [-VaultName] [-Name] -CertificateString - [-Password ] [-Tag ] [-WhatIf] [-Confirm] [] + [-Password ] [-Tag ] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ### ImportWithPrivateKeyFromCollection ``` Import-AzureKeyVaultCertificate [-VaultName] [-Name] - -CertificateCollection [-Tag ] [-WhatIf] [-Confirm] - [] + -CertificateCollection [-Tag ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -90,7 +93,7 @@ Specifies the certificate collection to add to a key vault. ```yaml Type: X509Certificate2Collection Parameter Sets: ImportWithPrivateKeyFromCollection -Aliases: +Aliases: Required: True Position: Named @@ -105,7 +108,7 @@ Specifies a certificate string. ```yaml Type: String Parameter Sets: ImportWithPrivateKeyFromString -Aliases: +Aliases: Required: True Position: Named @@ -114,13 +117,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure ```yaml -Type: SwitchParameter +Type: IAzureContextContainer Parameter Sets: (All) -Aliases: cf +Aliases: AzureRmContext, AzureCredential Required: False Position: Named @@ -135,7 +138,7 @@ Specifies the path of the certificate file that this cmdlet imports. ```yaml Type: String Parameter Sets: ImportCertificateFromFile, ImportWithPrivateKeyFromFile -Aliases: +Aliases: Required: True Position: Named @@ -154,7 +157,7 @@ Parameter Sets: (All) Aliases: CertificateName Required: True -Position: 2 +Position: 1 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False @@ -166,7 +169,7 @@ Specifies the password for a certificate file. ```yaml Type: SecureString Parameter Sets: ImportWithPrivateKeyFromFile, ImportWithPrivateKeyFromString -Aliases: +Aliases: Required: False Position: Named @@ -183,7 +186,7 @@ Key-value pairs in the form of a hash table. For example: ```yaml Type: Hashtable Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -199,15 +202,30 @@ This cmdlet constructs the fully qualified domain name (FQDN) of a key vault bas ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True -Position: 1 +Position: 0 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. diff --git a/src/ResourceManager/KeyVault/Commands.KeyVault/help/New-AzureKeyVaultCertificateAdministratorDetails.md b/src/ResourceManager/KeyVault/Commands.KeyVault/help/New-AzureKeyVaultCertificateAdministratorDetails.md index 58096dc14092..df201b66d410 100644 --- a/src/ResourceManager/KeyVault/Commands.KeyVault/help/New-AzureKeyVaultCertificateAdministratorDetails.md +++ b/src/ResourceManager/KeyVault/Commands.KeyVault/help/New-AzureKeyVaultCertificateAdministratorDetails.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml +Module Name: AzureRM.KeyVault ms.assetid: 775AB0E8-EC3C-4F96-8AF8-51C1DFEEF082 online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Creates an in-memory certificate administrator details object. ``` New-AzureKeyVaultCertificateAdministratorDetails [-FirstName ] [-LastName ] - [-EmailAddress ] [-PhoneNumber ] [-WhatIf] [-Confirm] [] + [-EmailAddress ] [-PhoneNumber ] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -31,6 +33,21 @@ This command creates an in-memory certificate administrator details object, and ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -EmailAddress Specifies the email address for the certificate administrator. diff --git a/src/ResourceManager/KeyVault/Commands.KeyVault/help/New-AzureKeyVaultCertificateOrganizationDetails.md b/src/ResourceManager/KeyVault/Commands.KeyVault/help/New-AzureKeyVaultCertificateOrganizationDetails.md index 646616e472bd..315a2c545704 100644 --- a/src/ResourceManager/KeyVault/Commands.KeyVault/help/New-AzureKeyVaultCertificateOrganizationDetails.md +++ b/src/ResourceManager/KeyVault/Commands.KeyVault/help/New-AzureKeyVaultCertificateOrganizationDetails.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml +Module Name: AzureRM.KeyVault ms.assetid: 0E1C05B0-8CF6-4C03-AA05-B13A4059A280 online version: schema: 2.0.0 @@ -15,7 +16,7 @@ Creates an in-memory certificate organization details object. ``` New-AzureKeyVaultCertificateOrganizationDetails [-Id ] [-AdministratorDetails ] - [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -50,6 +51,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Id Specifies the identifier for the organization. diff --git a/src/ResourceManager/KeyVault/Commands.KeyVault/help/New-AzureKeyVaultCertificatePolicy.md b/src/ResourceManager/KeyVault/Commands.KeyVault/help/New-AzureKeyVaultCertificatePolicy.md index 920aa7394646..ef12f6c44741 100644 --- a/src/ResourceManager/KeyVault/Commands.KeyVault/help/New-AzureKeyVaultCertificatePolicy.md +++ b/src/ResourceManager/KeyVault/Commands.KeyVault/help/New-AzureKeyVaultCertificatePolicy.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml +Module Name: AzureRM.KeyVault ms.assetid: 25E0F0E9-BF8C-49DF-87BA-31E2103A29A9 online version: schema: 2.0.0 @@ -19,7 +20,7 @@ New-AzureKeyVaultCertificatePolicy [-SecretContentType ] [-ReuseKeyOnRen [-Ekus ] [-ValidityInMonths ] -IssuerName [-CertificateType ] [-RenewAtNumberOfDaysBeforeExpiry ] [-RenewAtPercentageLifetime ] [-EmailAtNumberOfDaysBeforeExpiry ] [-EmailAtPercentageLifetime ] [-KeyType ] - [-KeyNotExportable] [-WhatIf] [-Confirm] [] + [-KeyNotExportable] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -51,6 +52,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Disabled Indicates that the certificate policy is disabled. diff --git a/src/ResourceManager/KeyVault/Commands.KeyVault/help/New-AzureRmKeyVault.md b/src/ResourceManager/KeyVault/Commands.KeyVault/help/New-AzureRmKeyVault.md index 759ee0182cd6..73ea2f8f9dec 100644 --- a/src/ResourceManager/KeyVault/Commands.KeyVault/help/New-AzureRmKeyVault.md +++ b/src/ResourceManager/KeyVault/Commands.KeyVault/help/New-AzureRmKeyVault.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml +Module Name: AzureRM.KeyVault ms.assetid: 4C40DAC9-5C0B-4AFD-9BDB-D407E0B9F701 online version: http://go.microsoft.com/fwlink/?LinkId=690160 schema: 2.0.0 @@ -15,7 +16,8 @@ Creates a key vault. ``` New-AzureRmKeyVault [-VaultName] [-ResourceGroupName] [-Location] [-EnabledForDeployment] [-EnabledForTemplateDeployment] [-EnabledForDiskEncryption] [-EnableSoftDelete] - [-Sku ] [-Tag ] [-WhatIf] [-Confirm] [] + [-Sku ] [-Tag ] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -49,6 +51,21 @@ Premium for the *SKU* parameter to create a Premium key vault. ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -EnabledForDeployment Enables the Microsoft.Compute resource provider to retrieve secrets from this key vault when this key vault is referenced in resource creation, for example when creating a virtual machine. @@ -121,7 +138,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 3 +Position: 2 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False @@ -136,7 +153,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 2 +Position: 1 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False @@ -186,7 +203,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 1 +Position: 0 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False diff --git a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureKeyVaultCertificate.md b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureKeyVaultCertificate.md index efcc60569a41..f7045fa999e2 100644 --- a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureKeyVaultCertificate.md +++ b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureKeyVaultCertificate.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml +Module Name: AzureRM.KeyVault ms.assetid: 34985F06-4D8D-463B-B113-972666D18485 online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Removes a certificate from a key vault. ``` Remove-AzureKeyVaultCertificate [-VaultName] [-Name] [-Force] [-InRemovedState] [-PassThru] - [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -48,6 +49,21 @@ Executing this cmdlet requires the 'purge' permission, which must have been prev ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Forces the command to run without asking for user confirmation. @@ -64,7 +80,9 @@ Accept wildcard characters: False ``` ### -InRemovedState -If present, removes the previously deleted certificate permanently.```yaml +If present, removes the previously deleted certificate permanently + +```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -86,7 +104,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 2 +Position: 1 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False @@ -118,7 +136,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 1 +Position: 0 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False diff --git a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureKeyVaultCertificateContact.md b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureKeyVaultCertificateContact.md index c998d1651e92..4d3eb3f5a5eb 100644 --- a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureKeyVaultCertificateContact.md +++ b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureKeyVaultCertificateContact.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml +Module Name: AzureRM.KeyVault ms.assetid: 35FAA57F-B2BD-4E43-8238-12F7A8269E4D online version: schema: 2.0.0 @@ -13,8 +14,8 @@ Deletes a contact that is registered for certificate notifications from a key va ## SYNTAX ``` -Remove-AzureKeyVaultCertificateContact [-VaultName] [-EmailAddress] [-PassThru] [-WhatIf] - [-Confirm] [] +Remove-AzureKeyVaultCertificateContact [-VaultName] [-EmailAddress] [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -31,6 +32,21 @@ This command removes Patti Fuller as a certificate contact for the Contoso01 key ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -EmailAddress Specifies the email address of the contact to remove. @@ -40,7 +56,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 2 +Position: 1 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False @@ -71,7 +87,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 1 +Position: 0 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False diff --git a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureKeyVaultCertificateIssuer.md b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureKeyVaultCertificateIssuer.md index 9781d8ae91f0..5810fdba117b 100644 --- a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureKeyVaultCertificateIssuer.md +++ b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureKeyVaultCertificateIssuer.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml +Module Name: AzureRM.KeyVault ms.assetid: FC14F6BF-BD8F-45E0-9CAA-A937E5E56288 online version: schema: 2.0.0 @@ -13,8 +14,8 @@ Deletes a certificate issuer from a key vault. ## SYNTAX ``` -Remove-AzureKeyVaultCertificateIssuer [-VaultName] [-Name] [-Force] [-PassThru] [-WhatIf] - [-Confirm] [] +Remove-AzureKeyVaultCertificateIssuer [-VaultName] [-Name] [-Force] [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -31,6 +32,21 @@ This command removes the certificate issuer named TestIssuer01 from the ContosoK ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Forces the command to run without asking for user confirmation. @@ -55,7 +71,7 @@ Parameter Sets: (All) Aliases: IssuerName Required: True -Position: 2 +Position: 1 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False @@ -86,7 +102,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 1 +Position: 0 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False diff --git a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureKeyVaultCertificateOperation.md b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureKeyVaultCertificateOperation.md index ab9f44a44549..f0d066c1330f 100644 --- a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureKeyVaultCertificateOperation.md +++ b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureKeyVaultCertificateOperation.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml +Module Name: AzureRM.KeyVault ms.assetid: 2659C06A-AE5B-4F7B-B9EF-069A74E12560 online version: schema: 2.0.0 @@ -13,8 +14,8 @@ Deletes a certificate operation from a key vault. ## SYNTAX ``` -Remove-AzureKeyVaultCertificateOperation [-VaultName] [-Name] [-Force] [-PassThru] [-WhatIf] - [-Confirm] [] +Remove-AzureKeyVaultCertificateOperation [-VaultName] [-Name] [-Force] [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -31,6 +32,21 @@ This command removes the certificate operation named TestCert01 from the Contoso ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Forces the command to run without asking for user confirmation. @@ -55,7 +71,7 @@ Parameter Sets: (All) Aliases: CertificateName Required: True -Position: 2 +Position: 1 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False @@ -86,7 +102,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 1 +Position: 0 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False diff --git a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureKeyVaultKey.md b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureKeyVaultKey.md index bfdc09b1c7d4..8e2a5af73a8d 100644 --- a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureKeyVaultKey.md +++ b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureKeyVaultKey.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml +Module Name: AzureRM.KeyVault ms.assetid: 817BF177-519F-47BA-86CF-4591FB402E2Dl online version: http://go.microsoft.com/fwlink/?LinkId=690299 schema: 2.0.0 @@ -13,8 +14,8 @@ Deletes a key in a key vault. ## SYNTAX ``` -Remove-AzureKeyVaultKey [-VaultName] [-Name] [-Force] [-PassThru] [-InRemovedState] [-WhatIf] - [-Confirm] [] +Remove-AzureKeyVaultKey [-VaultName] [-Name] [-Force] [-PassThru] [-InRemovedState] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -58,6 +59,21 @@ That cmdlet removes those keys. ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Forces the command to run without asking for user confirmation. @@ -98,7 +114,7 @@ Parameter Sets: (All) Aliases: KeyName Required: True -Position: 2 +Position: 1 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False @@ -130,7 +146,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 1 +Position: 0 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False diff --git a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureKeyVaultManagedStorageAccount.md b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureKeyVaultManagedStorageAccount.md index b6a9cbae2094..980eea721198 100644 --- a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureKeyVaultManagedStorageAccount.md +++ b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureKeyVaultManagedStorageAccount.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml +Module Name: AzureRM.KeyVault online version: https://msdn.microsoft.com/en-us/library/dn868052.aspx schema: 2.0.0 --- @@ -13,7 +14,7 @@ Removes a Key Vault managed Azure Storage Account and all associated SAS definit ``` Remove-AzureKeyVaultManagedStorageAccount [-VaultName] [-AccountName] [-Force] [-PassThru] - [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -52,6 +53,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Do not ask for confirmation. diff --git a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureKeyVaultManagedStorageSasDefinition.md b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureKeyVaultManagedStorageSasDefinition.md index 5927db1d7005..599cbdfae2d8 100644 --- a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureKeyVaultManagedStorageSasDefinition.md +++ b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureKeyVaultManagedStorageSasDefinition.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml +Module Name: AzureRM.KeyVault online version: https://msdn.microsoft.com/en-us/library/dn868052.aspx schema: 2.0.0 --- @@ -13,7 +14,7 @@ Removes a Key Vault managed Azure Storage SAS definitions. ``` Remove-AzureKeyVaultManagedStorageSasDefinition [-VaultName] [-AccountName] [-Name] - [-Force] [-PassThru] [-WhatIf] [-Confirm] [] + [-Force] [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -53,6 +54,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Do not ask for confirmation. diff --git a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureKeyVaultSecret.md b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureKeyVaultSecret.md index a2039f6dd6b3..857cbc8b3b17 100644 --- a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureKeyVaultSecret.md +++ b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureKeyVaultSecret.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml +Module Name: AzureRM.KeyVault online version: http://go.microsoft.com/fwlink/?LinkId=690300 schema: 2.0.0 --- @@ -13,7 +14,7 @@ Deletes a secret in a key vault. ``` Remove-AzureKeyVaultSecret [-VaultName] [-Name] [-Force] [-PassThru] [-InRemovedState] - [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -48,6 +49,21 @@ Executing this cmdlet requires the 'purge' permission, which must have been prev ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Forces the command to run without asking for user confirmation. @@ -88,7 +104,7 @@ Parameter Sets: (All) Aliases: SecretName Required: True -Position: 2 +Position: 1 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False @@ -120,7 +136,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 1 +Position: 0 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False diff --git a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureRmKeyVault.md b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureRmKeyVault.md index 724c50e3835a..802b88b33295 100644 --- a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureRmKeyVault.md +++ b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureRmKeyVault.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml +Module Name: AzureRM.KeyVault ms.assetid: 7A929BA8-02D9-4BBE-AFF3-B8781F8DDAD9 online version: http://go.microsoft.com/fwlink/?LinkId=690162 schema: 2.0.0 @@ -15,13 +16,13 @@ Deletes a key vault. ### ByAvailableVault ``` Remove-AzureRmKeyVault [-VaultName] [[-ResourceGroupName] ] [[-Location] ] [-Force] - [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### ByDeletedVault ``` -Remove-AzureRmKeyVault [-VaultName] [-Location] [-Force] [-InRemovedState] [-WhatIf] - [-Confirm] [] +Remove-AzureRmKeyVault [-VaultName] [-Location] [-Force] [-InRemovedState] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -49,6 +50,21 @@ If you do not specify the resource group name, the cmdlet searches for the named ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Indicates that the cmdlet does not prompt you for confirmation. By default, this cmdlet prompts you to confirm that you want to delete the key vault. @@ -116,7 +132,7 @@ Parameter Sets: ByAvailableVault Aliases: Required: False -Position: 2 +Position: 1 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False @@ -131,7 +147,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 1 +Position: 0 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False diff --git a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureRmKeyVaultAccessPolicy.md b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureRmKeyVaultAccessPolicy.md index b2bcee43beb5..61831c1d18bb 100644 --- a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureRmKeyVaultAccessPolicy.md +++ b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Remove-AzureRmKeyVaultAccessPolicy.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml +Module Name: AzureRM.KeyVault ms.assetid: AE7B103B-23ED-4A66-A0DC-14FB0DF38FA8 online version: http://go.microsoft.com/fwlink/?LinkId=690164 schema: 2.0.0 @@ -15,32 +16,35 @@ Removes all permissions for a user or application from a key vault. ### ByServicePrincipalName ``` Remove-AzureRmKeyVaultAccessPolicy [-VaultName] [[-ResourceGroupName] ] - -ServicePrincipalName [-PassThru] [-WhatIf] [-Confirm] [] + -ServicePrincipalName [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ### ByUserPrincipalName ``` Remove-AzureRmKeyVaultAccessPolicy [-VaultName] [[-ResourceGroupName] ] - -UserPrincipalName [-PassThru] [-WhatIf] [-Confirm] [] + -UserPrincipalName [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ### ByObjectId ``` Remove-AzureRmKeyVaultAccessPolicy [-VaultName] [[-ResourceGroupName] ] -ObjectId - [-ApplicationId ] [-PassThru] [-WhatIf] [-Confirm] [] + [-ApplicationId ] [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ### ByEmail ``` Remove-AzureRmKeyVaultAccessPolicy [-VaultName] [[-ResourceGroupName] ] -EmailAddress - [-PassThru] [-WhatIf] [-Confirm] [] + [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### ForVault ``` Remove-AzureRmKeyVaultAccessPolicy [-VaultName] [[-ResourceGroupName] ] - [-EnabledForDeployment] [-EnabledForTemplateDeployment] [-EnabledForDiskEncryption] [-PassThru] [-WhatIf] - [-Confirm] [] + [-EnabledForDeployment] [-EnabledForTemplateDeployment] [-EnabledForDiskEncryption] [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -98,6 +102,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -EmailAddress Specifies the user email address of the user whose access you want to remove. @@ -199,7 +218,7 @@ Parameter Sets: (All) Aliases: Required: False -Position: 2 +Position: 1 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False diff --git a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Restore-AzureKeyVaultKey.md b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Restore-AzureKeyVaultKey.md index e00def2ee643..e7c7bf6846bf 100644 --- a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Restore-AzureKeyVaultKey.md +++ b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Restore-AzureKeyVaultKey.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml +Module Name: AzureRM.KeyVault ms.assetid: C4E7ACDF-22FB-4D49-93B3-69E787B7E0CD online version: http://go.microsoft.com/fwlink/?LinkId=690301 schema: 2.0.0 @@ -13,7 +14,8 @@ Creates a key in a key vault from a backed-up key. ## SYNTAX ``` -Restore-AzureKeyVaultKey [-VaultName] [-InputFile] [-WhatIf] [-Confirm] [] +Restore-AzureKeyVaultKey [-VaultName] [-InputFile] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -37,6 +39,21 @@ This command restores a key, including all of its versions, from the backup file ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InputFile Specifies the input file that contains the backup of the key to restore. @@ -46,7 +63,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 2 +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -61,7 +78,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 1 +Position: 0 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False diff --git a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Restore-AzureKeyVaultSecret.md b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Restore-AzureKeyVaultSecret.md index 7e7c54f08544..144956b70f4a 100644 --- a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Restore-AzureKeyVaultSecret.md +++ b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Restore-AzureKeyVaultSecret.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml +Module Name: AzureRM.KeyVault ms.assetid: 70DB088D-4AF5-406B-8D66-118A0F766041 online version: http://go.microsoft.com/fwlink/?LinkId=690301 schema: 2.0.0 @@ -13,8 +14,8 @@ Creates a secret in a key vault from a backed-up secret. ## SYNTAX ``` -Restore-AzureKeyVaultSecret [-VaultName] [-InputFile] [-WhatIf] [-Confirm] - [] +Restore-AzureKeyVaultSecret [-VaultName] [-InputFile] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -38,6 +39,21 @@ This command restores a secret, including all of its versions, from the backup f ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InputFile Specifies the input file that contains the backup of the secret to restore. diff --git a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Set-AzureKeyVaultCertificateAttribute.md b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Set-AzureKeyVaultCertificateAttribute.md index 500d1a1d2b39..538ae535421c 100644 --- a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Set-AzureKeyVaultCertificateAttribute.md +++ b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Set-AzureKeyVaultCertificateAttribute.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml +Module Name: AzureRM.KeyVault ms.assetid: 3BD243C7-A40E-4061-93FF-DDE7DECAD0A7 online version: http://go.microsoft.com/fwlink/?LinkId=822861 schema: 2.0.0 @@ -14,7 +15,8 @@ Modifies editable attributes of a certificate. ``` Set-AzureKeyVaultCertificateAttribute [-VaultName] [-Name] [[-Version] ] - [-Enable ] [-Tag ] [-PassThru] [-WhatIf] [-Confirm] [] + [-Enable ] [-Tag ] [-PassThru] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -64,6 +66,21 @@ The final command displays the TestCert01 certificate by using the Get-AzureKeyV ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Enable Indicates whether to enable or disable a certificate. Specify $True to enable or $False to disable. @@ -91,7 +108,7 @@ Parameter Sets: (All) Aliases: CertificateName Required: True -Position: 2 +Position: 1 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False @@ -140,7 +157,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 1 +Position: 0 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False @@ -156,7 +173,7 @@ Parameter Sets: (All) Aliases: CertificateVersion Required: False -Position: 3 +Position: 2 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False diff --git a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Set-AzureKeyVaultCertificateIssuer.md b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Set-AzureKeyVaultCertificateIssuer.md index e83aee9670dd..b18f366fc3eb 100644 --- a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Set-AzureKeyVaultCertificateIssuer.md +++ b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Set-AzureKeyVaultCertificateIssuer.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml +Module Name: AzureRM.KeyVault ms.assetid: 4C2C77F7-ECE4-4106-8AF1-256A496A977B online version: schema: 2.0.0 @@ -16,13 +17,13 @@ Sets a certificate issuer in a key vault. ``` Set-AzureKeyVaultCertificateIssuer [-VaultName] [-Name] [-IssuerProvider ] [-AccountId ] [-ApiKey ] [-OrganizationDetails ] - [-PassThru] [-WhatIf] [-Confirm] [] + [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### ByValue ``` Set-AzureKeyVaultCertificateIssuer [-VaultName] [-Name] -Issuer - [-PassThru] [-WhatIf] [-Confirm] [] + [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -69,6 +70,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Issuer Specifies the certificate issuer to update. @@ -108,7 +124,7 @@ Parameter Sets: (All) Aliases: IssuerName Required: True -Position: 2 +Position: 1 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False @@ -154,7 +170,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 1 +Position: 0 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False diff --git a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Set-AzureKeyVaultCertificatePolicy.md b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Set-AzureKeyVaultCertificatePolicy.md index 70977fa03c82..cb945fdf9857 100644 --- a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Set-AzureKeyVaultCertificatePolicy.md +++ b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Set-AzureKeyVaultCertificatePolicy.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml +Module Name: AzureRM.KeyVault ms.assetid: 28BC1B99-946C-4A8D-9581-4D5CC0BCEF8B online version: schema: 2.0.0 @@ -21,14 +22,16 @@ Set-AzureKeyVaultCertificatePolicy [-VaultName] [-Name] [-Secr [-Ekus ] [-ValidityInMonths ] [-IssuerName ] [-CertificateType ] [-RenewAtNumberOfDaysBeforeExpiry ] [-RenewAtPercentageLifetime ] [-EmailAtNumberOfDaysBeforeExpiry ] [-EmailAtPercentageLifetime ] [-KeyType ] - [-KeyNotExportable] [-PassThru] [-WhatIf] [-Confirm] [] + [-KeyNotExportable] [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ### ByValue ``` Set-AzureKeyVaultCertificatePolicy [-VaultName] [-Name] [-EmailAtNumberOfDaysBeforeExpiry ] [-EmailAtPercentageLifetime ] [-KeyType ] - [[-CertificatePolicy] ] [-PassThru] [-WhatIf] [-Confirm] [] + [[-CertificatePolicy] ] [-PassThru] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -54,7 +57,7 @@ Parameter Sets: ByValue Aliases: Required: False -Position: 3 +Position: 2 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False @@ -75,6 +78,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Disabled Indicates that the certificate policy is disabled. @@ -224,7 +242,7 @@ Parameter Sets: (All) Aliases: CertificateName Required: True -Position: 2 +Position: 1 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False @@ -350,7 +368,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 1 +Position: 0 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False diff --git a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Set-AzureKeyVaultKeyAttribute.md b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Set-AzureKeyVaultKeyAttribute.md index ca4afffcf3a4..df86fa7b6f25 100644 --- a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Set-AzureKeyVaultKeyAttribute.md +++ b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Set-AzureKeyVaultKeyAttribute.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml +Module Name: AzureRM.KeyVault online version: http://go.microsoft.com/fwlink/?LinkId=690302 schema: 2.0.0 --- @@ -13,8 +14,8 @@ Updates the attributes of a key in a key vault. ``` Set-AzureKeyVaultKeyAttribute [-VaultName] [-Name] [[-Version] ] [-Enable ] - [-Expires ] [-NotBefore ] [-KeyOps ] [-Tag ] [-PassThru] [-WhatIf] - [-Confirm] [] + [-Expires ] [-NotBefore ] [-KeyOps ] [-Tag ] [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -47,13 +48,13 @@ This commands deletes all tags for a specific version of a key named ITSoftware. ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure ```yaml -Type: SwitchParameter +Type: IAzureContextContainer Parameter Sets: (All) -Aliases: cf +Aliases: AzureRmContext, AzureCredential Required: False Position: Named @@ -70,7 +71,7 @@ the key. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -87,7 +88,7 @@ parameter uses Coordinated Universal Time (UTC). To obtain a **DateTime** object ```yaml Type: DateTime Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -115,7 +116,7 @@ the JSON Web Key specification. These values (case-sensitive) are: ```yaml Type: String[] Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -135,7 +136,7 @@ Parameter Sets: (All) Aliases: KeyName Required: True -Position: 2 +Position: 1 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False @@ -149,7 +150,7 @@ To obtain a **DateTime** object, use the **Get-Date** cmdlet. ```yaml Type: DateTime Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -165,7 +166,7 @@ By default, this cmdlet does not generate any output. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -198,10 +199,10 @@ This cmdlet constructs the FQDN of a key vault based on the name that this param ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True -Position: 1 +Position: 0 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False @@ -217,12 +218,27 @@ Parameter Sets: (All) Aliases: KeyVersion Required: False -Position: 3 +Position: 2 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. diff --git a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Set-AzureKeyVaultManagedStorageSasDefinition.md b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Set-AzureKeyVaultManagedStorageSasDefinition.md index 4fd0b9d5c501..2fe1e6c38416 100644 --- a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Set-AzureKeyVaultManagedStorageSasDefinition.md +++ b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Set-AzureKeyVaultManagedStorageSasDefinition.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml +Module Name: AzureRM.KeyVault online version: https://msdn.microsoft.com/en-us/library/dn868052.aspx schema: 2.0.0 --- @@ -14,7 +15,8 @@ Sets a Shared Access Signature (SAS) definition with Key Vault for a given Key V ### RawSas (Default) ``` Set-AzureKeyVaultManagedStorageSasDefinition [-VaultName] [-AccountName] [-Name] - [-Parameter] [-Disable] [-Tag ] [-WhatIf] [-Confirm] [] + [-Parameter] [-Disable] [-Tag ] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] ``` ### AdhocAccountSas @@ -22,7 +24,8 @@ Set-AzureKeyVaultManagedStorageSasDefinition [-VaultName] [-AccountName Set-AzureKeyVaultManagedStorageSasDefinition -Service -ResourceType [-ApiVersion ] [-VaultName] [-AccountName] [-Name] [-Disable] [-Tag ] [-TargetStorageVersion ] [-Protocol ] [-IPAddressOrRange ] - -ValidityPeriod -Permission [-WhatIf] [-Confirm] [] + -ValidityPeriod -Permission [-DefaultProfile ] [-WhatIf] + [-Confirm] [] ``` ### AdhocServiceBlobSas @@ -30,7 +33,8 @@ Set-AzureKeyVaultManagedStorageSasDefinition -Service -ResourceType < Set-AzureKeyVaultManagedStorageSasDefinition [-VaultName] [-AccountName] [-Name] [-Disable] [-Tag ] [-TargetStorageVersion ] [-Protocol ] [-IPAddressOrRange ] -ValidityPeriod -Permission -Blob - -Container [-SharedAccessHeader ] [-WhatIf] [-Confirm] [] + -Container [-SharedAccessHeader ] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] ``` ### AdhocServiceContainerSas @@ -38,7 +42,8 @@ Set-AzureKeyVaultManagedStorageSasDefinition [-VaultName] [-AccountName Set-AzureKeyVaultManagedStorageSasDefinition [-VaultName] [-AccountName] [-Name] [-Disable] [-Tag ] [-TargetStorageVersion ] [-Protocol ] [-IPAddressOrRange ] -ValidityPeriod -Permission -Container - [-SharedAccessHeader ] [-WhatIf] [-Confirm] [] + [-SharedAccessHeader ] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ### AdhocServiceFileSas @@ -46,7 +51,8 @@ Set-AzureKeyVaultManagedStorageSasDefinition [-VaultName] [-AccountName Set-AzureKeyVaultManagedStorageSasDefinition [-VaultName] [-AccountName] [-Name] [-Disable] [-Tag ] [-TargetStorageVersion ] [-Protocol ] [-IPAddressOrRange ] -ValidityPeriod -Permission - [-SharedAccessHeader ] -Share -Path [-WhatIf] [-Confirm] [] + [-SharedAccessHeader ] -Share -Path [-DefaultProfile ] + [-WhatIf] [-Confirm] [] ``` ### AdhocServiceShareSas @@ -54,15 +60,16 @@ Set-AzureKeyVaultManagedStorageSasDefinition [-VaultName] [-AccountName Set-AzureKeyVaultManagedStorageSasDefinition [-VaultName] [-AccountName] [-Name] [-Disable] [-Tag ] [-TargetStorageVersion ] [-Protocol ] [-IPAddressOrRange ] -ValidityPeriod -Permission - [-SharedAccessHeader ] -Share [-WhatIf] [-Confirm] [] + [-SharedAccessHeader ] -Share [-DefaultProfile ] [-WhatIf] + [-Confirm] [] ``` ### AdhocServiceQueueSas ``` Set-AzureKeyVaultManagedStorageSasDefinition [-VaultName] [-AccountName] [-Name] [-Disable] [-Tag ] [-TargetStorageVersion ] [-Protocol ] - [-IPAddressOrRange ] -ValidityPeriod -Permission -Queue [-WhatIf] - [-Confirm] [] + [-IPAddressOrRange ] -ValidityPeriod -Permission -Queue + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### AdhocServiceTableSas @@ -71,7 +78,7 @@ Set-AzureKeyVaultManagedStorageSasDefinition [-VaultName] [-AccountName [-Disable] [-Tag ] [-TargetStorageVersion ] [-Protocol ] [-IPAddressOrRange ] -ValidityPeriod -Permission -Table [-StartPartitionKey ] [-StartRowKey ] [-EndPartitionKey ] [-EndRowKey ] - [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### StoredPolicyServiceBlobSas @@ -79,15 +86,16 @@ Set-AzureKeyVaultManagedStorageSasDefinition [-VaultName] [-AccountName Set-AzureKeyVaultManagedStorageSasDefinition [-VaultName] [-AccountName] [-Name] [-Disable] [-Tag ] [-TargetStorageVersion ] [-Protocol ] [-IPAddressOrRange ] -Blob -Container -Policy - [-SharedAccessHeader ] [-WhatIf] [-Confirm] [] + [-SharedAccessHeader ] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ### StoredPolicyServiceContainerSas ``` Set-AzureKeyVaultManagedStorageSasDefinition [-VaultName] [-AccountName] [-Name] [-Disable] [-Tag ] [-TargetStorageVersion ] [-Protocol ] - [-IPAddressOrRange ] -Container -Policy [-SharedAccessHeader ] [-WhatIf] - [-Confirm] [] + [-IPAddressOrRange ] -Container -Policy [-SharedAccessHeader ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### StoredPolicyServiceFileSas @@ -95,22 +103,23 @@ Set-AzureKeyVaultManagedStorageSasDefinition [-VaultName] [-AccountName Set-AzureKeyVaultManagedStorageSasDefinition [-VaultName] [-AccountName] [-Name] [-Disable] [-Tag ] [-TargetStorageVersion ] [-Protocol ] [-IPAddressOrRange ] -Policy [-SharedAccessHeader ] -Share -Path - [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### StoredPolicyServiceShareSas ``` Set-AzureKeyVaultManagedStorageSasDefinition [-VaultName] [-AccountName] [-Name] [-Disable] [-Tag ] [-TargetStorageVersion ] [-Protocol ] - [-IPAddressOrRange ] -Policy [-SharedAccessHeader ] -Share [-WhatIf] - [-Confirm] [] + [-IPAddressOrRange ] -Policy [-SharedAccessHeader ] -Share + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### StoredPolicyServiceQueueSas ``` Set-AzureKeyVaultManagedStorageSasDefinition [-VaultName] [-AccountName] [-Name] [-Disable] [-Tag ] [-TargetStorageVersion ] [-Protocol ] - [-IPAddressOrRange ] -Policy -Queue [-WhatIf] [-Confirm] [] + [-IPAddressOrRange ] -Policy -Queue [-DefaultProfile ] + [-WhatIf] [-Confirm] [] ``` ### StoredPolicyServiceTableSas @@ -118,8 +127,8 @@ Set-AzureKeyVaultManagedStorageSasDefinition [-VaultName] [-AccountName Set-AzureKeyVaultManagedStorageSasDefinition [-VaultName] [-AccountName] [-Name] [-Disable] [-Tag ] [-TargetStorageVersion ] [-Protocol ] [-IPAddressOrRange ] -Policy -Table [-StartPartitionKey ] - [-StartRowKey ] [-EndPartitionKey ] [-EndRowKey ] [-WhatIf] [-Confirm] - [] + [-StartRowKey ] [-EndPartitionKey ] [-EndRowKey ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -177,7 +186,7 @@ Specifies the storage service version to use to execute the request made using t ```yaml Type: String Parameter Sets: AdhocAccountSas -Aliases: +Aliases: Required: False Position: Named @@ -192,7 +201,7 @@ Blob Name ```yaml Type: String Parameter Sets: AdhocServiceBlobSas, StoredPolicyServiceBlobSas -Aliases: +Aliases: Required: True Position: Named @@ -201,30 +210,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -Container +Container Name ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf +Type: String +Parameter Sets: AdhocServiceBlobSas, AdhocServiceContainerSas, StoredPolicyServiceBlobSas, StoredPolicyServiceContainerSas +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Container -Container Name +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure ```yaml -Type: String -Parameter Sets: AdhocServiceBlobSas, AdhocServiceContainerSas, StoredPolicyServiceBlobSas, StoredPolicyServiceContainerSas -Aliases: +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -237,7 +246,7 @@ Disables the use of sas definition for generation of sas token. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -282,7 +291,7 @@ IP, or IP range ACL (access control list) of the request that would be accepted ```yaml Type: String Parameter Sets: AdhocAccountSas, AdhocServiceBlobSas, AdhocServiceContainerSas, AdhocServiceFileSas, AdhocServiceShareSas, AdhocServiceQueueSas, AdhocServiceTableSas, StoredPolicyServiceBlobSas, StoredPolicyServiceContainerSas, StoredPolicyServiceFileSas, StoredPolicyServiceShareSas, StoredPolicyServiceQueueSas, StoredPolicyServiceTableSas -Aliases: +Aliases: Required: False Position: Named @@ -313,7 +322,7 @@ Sas definition parameters that will be used to create the sas token. ```yaml Type: Hashtable Parameter Sets: RawSas -Aliases: +Aliases: Required: True Position: 3 @@ -328,7 +337,7 @@ Path to the cloud file to generate sas token against. ```yaml Type: String Parameter Sets: AdhocServiceFileSas, StoredPolicyServiceFileSas -Aliases: +Aliases: Required: True Position: Named @@ -343,7 +352,7 @@ Permission. Values include 'Query','Add','Update','Process' ```yaml Type: String[] Parameter Sets: AdhocAccountSas, AdhocServiceBlobSas, AdhocServiceContainerSas, AdhocServiceFileSas, AdhocServiceShareSas, AdhocServiceQueueSas, AdhocServiceTableSas -Aliases: +Aliases: Accepted values: Add, Create, Delete, List, Process, Read, Query, Update, Write Required: True @@ -359,7 +368,7 @@ Policy Identifier ```yaml Type: String Parameter Sets: StoredPolicyServiceBlobSas, StoredPolicyServiceContainerSas, StoredPolicyServiceFileSas, StoredPolicyServiceShareSas, StoredPolicyServiceQueueSas, StoredPolicyServiceTableSas -Aliases: +Aliases: Required: True Position: Named @@ -374,7 +383,7 @@ Protocol can be used in the request with the SAS token. ```yaml Type: String Parameter Sets: AdhocAccountSas, AdhocServiceBlobSas, AdhocServiceContainerSas, AdhocServiceFileSas, AdhocServiceShareSas, AdhocServiceQueueSas, AdhocServiceTableSas, StoredPolicyServiceBlobSas, StoredPolicyServiceContainerSas, StoredPolicyServiceFileSas, StoredPolicyServiceShareSas, StoredPolicyServiceQueueSas, StoredPolicyServiceTableSas -Aliases: +Aliases: Accepted values: HttpsOnly, HttpsOrHttp Required: False @@ -390,7 +399,7 @@ Queue Name ```yaml Type: String Parameter Sets: AdhocServiceQueueSas, StoredPolicyServiceQueueSas -Aliases: +Aliases: Required: True Position: Named @@ -405,7 +414,7 @@ Resource types that this SAS token applies to. Values include 'Service','Contain ```yaml Type: String[] Parameter Sets: AdhocAccountSas -Aliases: +Aliases: Accepted values: Service, Container, Object Required: True @@ -421,7 +430,7 @@ Service types that this SAS token applies to. Values include 'Blob','File','Queu ```yaml Type: String[] Parameter Sets: AdhocAccountSas -Aliases: +Aliases: Accepted values: Blob, File, Queue, Table Required: True @@ -437,7 +446,7 @@ Share Name ```yaml Type: String Parameter Sets: AdhocServiceFileSas, AdhocServiceShareSas, StoredPolicyServiceFileSas, StoredPolicyServiceShareSas -Aliases: +Aliases: Required: True Position: Named @@ -452,7 +461,7 @@ Specifies the query parameters to override response headers. ```yaml Type: String[] Parameter Sets: AdhocServiceBlobSas, AdhocServiceContainerSas, AdhocServiceFileSas, AdhocServiceShareSas, StoredPolicyServiceBlobSas, StoredPolicyServiceContainerSas, StoredPolicyServiceFileSas, StoredPolicyServiceShareSas -Aliases: +Aliases: Accepted values: CacheControl, ContentDisposition, ContentEncoding, ContentLanguage, ContentType Required: False @@ -498,7 +507,7 @@ Table Name ```yaml Type: String Parameter Sets: AdhocServiceTableSas, StoredPolicyServiceTableSas -Aliases: +Aliases: Required: True Position: Named @@ -530,7 +539,7 @@ Specifies the signed storage service version to use to authenticate requests mad ```yaml Type: String Parameter Sets: AdhocAccountSas, AdhocServiceBlobSas, AdhocServiceContainerSas, AdhocServiceFileSas, AdhocServiceShareSas, AdhocServiceQueueSas, AdhocServiceTableSas, StoredPolicyServiceBlobSas, StoredPolicyServiceContainerSas, StoredPolicyServiceFileSas, StoredPolicyServiceShareSas, StoredPolicyServiceQueueSas, StoredPolicyServiceTableSas -Aliases: +Aliases: Required: False Position: Named @@ -545,7 +554,7 @@ Validity period that will get used to set the expiry time of sas token from the ```yaml Type: TimeSpan Parameter Sets: AdhocAccountSas, AdhocServiceBlobSas, AdhocServiceContainerSas, AdhocServiceFileSas, AdhocServiceShareSas, AdhocServiceQueueSas, AdhocServiceTableSas -Aliases: +Aliases: Required: True Position: Named @@ -561,7 +570,7 @@ Cmdlet constructs the FQDN of a vault based on the name and currently selected e ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 @@ -570,6 +579,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. diff --git a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Set-AzureKeyVaultSecret.md b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Set-AzureKeyVaultSecret.md index 3ea9bccd8bee..ce3ac1048cbd 100644 --- a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Set-AzureKeyVaultSecret.md +++ b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Set-AzureKeyVaultSecret.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml +Module Name: AzureRM.KeyVault ms.assetid: 9FC72DE9-46BB-4CB5-9880-F53756DBE012 online version: http://go.microsoft.com/fwlink/?LinkId=690303 schema: 2.0.0 @@ -14,8 +15,8 @@ Creates or updates a secret in a key vault. ``` Set-AzureKeyVaultSecret [-VaultName] [-Name] [-SecretValue] [-Disable] - [-Expires ] [-NotBefore ] [-ContentType ] [-Tag ] [-WhatIf] [-Confirm] - [] + [-Expires ] [-NotBefore ] [-ContentType ] [-Tag ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -60,34 +61,34 @@ using the values specified previously as variables. ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -ContentType +Specifies the content type of a secret. +To delete the existing content type, specify an empty string. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -ContentType -Specifies the content type of a secret. -To delete the existing content type, specify an empty string. +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure ```yaml -Type: String +Type: IAzureContextContainer Parameter Sets: (All) -Aliases: +Aliases: AzureRmContext, AzureCredential Required: False Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` @@ -97,7 +98,7 @@ Indicates that this cmdlet disables a secret. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -114,7 +115,7 @@ This parameter uses Coordinated Universal Time (UTC). To obtain a **DateTime** o ```yaml Type: DateTime Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -134,7 +135,7 @@ Parameter Sets: (All) Aliases: SecretName Required: True -Position: 2 +Position: 1 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False @@ -147,7 +148,7 @@ parameter uses UTC. To obtain a **DateTime** object, use the **Get-Date** cmdlet ```yaml Type: DateTime Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -164,10 +165,10 @@ ConvertTo-SecureString`. ```yaml Type: SecureString Parameter Sets: (All) -Aliases: +Aliases: Required: True -Position: 3 +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -197,15 +198,30 @@ of a key vault based on the name that this parameter specifies and your current ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True -Position: 1 +Position: 0 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. diff --git a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Set-AzureKeyVaultSecretAttribute.md b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Set-AzureKeyVaultSecretAttribute.md index 07679917ce8e..0d19c21d9bf9 100644 --- a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Set-AzureKeyVaultSecretAttribute.md +++ b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Set-AzureKeyVaultSecretAttribute.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml +Module Name: AzureRM.KeyVault ms.assetid: E2A45461-6B41-42FF-A874-A4CEFC867A33 online version: http://go.microsoft.com/fwlink/?LinkId=690305 schema: 2.0.0 @@ -15,7 +16,7 @@ Updates attributes of a secret in a key vault. ``` Set-AzureKeyVaultSecretAttribute [-VaultName] [-Name] [[-Version] ] [-Enable ] [-Expires ] [-NotBefore ] [-ContentType ] [-Tag ] - [-PassThru] [-WhatIf] [-Confirm] [] + [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -77,34 +78,34 @@ content type to XML. ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -ContentType +Specifies the content type of a secret. If you do not specify this parameter, there is no change to +the current secret's content type. To remove the existing content type, specify an empty string. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -ContentType -Specifies the content type of a secret. If you do not specify this parameter, there is no change to -the current secret's content type. To remove the existing content type, specify an empty string. +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure ```yaml -Type: String +Type: IAzureContextContainer Parameter Sets: (All) -Aliases: +Aliases: AzureRmContext, AzureCredential Required: False Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` @@ -116,7 +117,7 @@ disabled state. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -131,7 +132,7 @@ Specifies the date and time that a secret expires. ```yaml Type: DateTime Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -151,7 +152,7 @@ Parameter Sets: (All) Aliases: SecretName Required: True -Position: 2 +Position: 1 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False @@ -164,7 +165,7 @@ If you do not specify this parameter, there is no change to the current secret's ```yaml Type: DateTime Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -180,7 +181,7 @@ By default, this cmdlet does not generate any output. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -213,10 +214,10 @@ This cmdlet constructs the FQDN of a key vault based on the name that this param ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True -Position: 1 +Position: 0 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False @@ -232,12 +233,27 @@ Parameter Sets: (All) Aliases: SecretVersion Required: False -Position: 3 +Position: 2 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -262,7 +278,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### Microsoft.Azure.Commands.KeyVault.Models.Secret - Returns Microsoft.Azure.Commands.KeyVault.Models.Secret object if PassThru is specified. Otherwise, returns nothing. ## NOTES diff --git a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Set-AzureRmKeyVaultAccessPolicy.md b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Set-AzureRmKeyVaultAccessPolicy.md index 66efbf6654fa..43bb56e060f8 100644 --- a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Set-AzureRmKeyVaultAccessPolicy.md +++ b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Set-AzureRmKeyVaultAccessPolicy.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml +Module Name: AzureRM.KeyVault ms.assetid: 636FAD5B-8C39-4E5C-8978-6845C6B89BC0 online version: http://go.microsoft.com/fwlink/?LinkId=690163 schema: 2.0.0 @@ -16,16 +17,16 @@ Grants or modifies existing permissions for a user, application, or security gro ``` Set-AzureRmKeyVaultAccessPolicy [-VaultName] [[-ResourceGroupName] ] -ServicePrincipalName [-PermissionsToKeys ] [-PermissionsToSecrets ] - [-PermissionsToCertificates ] [-PermissionsToStorage ] [-PassThru] [-WhatIf] [-Confirm] - [] + [-PermissionsToCertificates ] [-PermissionsToStorage ] [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### ByUserPrincipalName ``` Set-AzureRmKeyVaultAccessPolicy [-VaultName] [[-ResourceGroupName] ] -UserPrincipalName [-PermissionsToKeys ] [-PermissionsToSecrets ] - [-PermissionsToCertificates ] [-PermissionsToStorage ] [-PassThru] [-WhatIf] [-Confirm] - [] + [-PermissionsToCertificates ] [-PermissionsToStorage ] [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### ByObjectId @@ -33,21 +34,22 @@ Set-AzureRmKeyVaultAccessPolicy [-VaultName] [[-ResourceGroupName] [[-ResourceGroupName] ] -ObjectId [-ApplicationId ] [-PermissionsToKeys ] [-PermissionsToSecrets ] [-PermissionsToCertificates ] [-PermissionsToStorage ] [-BypassObjectIdValidation] - [-PassThru] [-WhatIf] [-Confirm] [] + [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### ByEmailAddress ``` Set-AzureRmKeyVaultAccessPolicy [-VaultName] [[-ResourceGroupName] ] -EmailAddress [-PermissionsToKeys ] [-PermissionsToSecrets ] [-PermissionsToCertificates ] - [-PermissionsToStorage ] [-PassThru] [-WhatIf] [-Confirm] [] + [-PermissionsToStorage ] [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ### ForVault ``` Set-AzureRmKeyVaultAccessPolicy [-VaultName] [[-ResourceGroupName] ] [-EnabledForDeployment] - [-EnabledForTemplateDeployment] [-EnabledForDiskEncryption] [-PassThru] [-WhatIf] [-Confirm] - [] + [-EnabledForTemplateDeployment] [-EnabledForDiskEncryption] [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -179,6 +181,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -EmailAddress Specifies the user email address of the user to whom to grant permissions. @@ -295,7 +312,7 @@ The acceptable values for this parameter: Type: String[] Parameter Sets: ByServicePrincipalName, ByUserPrincipalName, ByObjectId, ByEmailAddress Aliases: -Accepted values: get, list, delete, create, import, update, managecontacts, getissuers, listissuers, setissuers, deleteissuers, manageissuers, all +Accepted values: get, list, delete, create, import, update, managecontacts, getissuers, listissuers, setissuers, deleteissuers, manageissuers, recover, purge, all Required: False Position: Named @@ -391,7 +408,7 @@ Parameter Sets: (All) Aliases: Required: False -Position: 2 +Position: 1 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False diff --git a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Stop-AzureKeyVaultCertificateOperation.md b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Stop-AzureKeyVaultCertificateOperation.md index 73b30218de42..123211fbb4a3 100644 --- a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Stop-AzureKeyVaultCertificateOperation.md +++ b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Stop-AzureKeyVaultCertificateOperation.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml +Module Name: AzureRM.KeyVault ms.assetid: 3B042D79-658F-41F0-BD4D-9955F2E71CA1 online version: schema: 2.0.0 @@ -13,8 +14,8 @@ Cancels a certificate operation in key vault. ## SYNTAX ``` -Stop-AzureKeyVaultCertificateOperation [-VaultName] [-Name] [-Force] [-WhatIf] [-Confirm] - [] +Stop-AzureKeyVaultCertificateOperation [-VaultName] [-Name] [-Force] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -41,6 +42,21 @@ This command cancels the TestCert02 certificate operation. ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Forces the command to run without asking for user confirmation. @@ -65,7 +81,7 @@ Parameter Sets: (All) Aliases: CertificateName Required: True -Position: 2 +Position: 1 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False @@ -80,7 +96,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 1 +Position: 0 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False diff --git a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Undo-AzureKeyVaultCertificateRemoval.md b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Undo-AzureKeyVaultCertificateRemoval.md index d68de1bc3ad0..6d9410be431d 100644 --- a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Undo-AzureKeyVaultCertificateRemoval.md +++ b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Undo-AzureKeyVaultCertificateRemoval.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml +Module Name: AzureRM.KeyVault online version: https://msdn.microsoft.com/en-us/library/dn868052.aspx schema: 2.0.0 --- @@ -12,8 +13,8 @@ Recovers a deleted certificate in a key vault into an active state. ## SYNTAX ``` -Undo-AzureKeyVaultCertificateRemoval [-VaultName] [-Name] [-WhatIf] [-Confirm] - [] +Undo-AzureKeyVaultCertificateRemoval [-VaultName] [-Name] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -32,6 +33,21 @@ This command will recover the certificate 'MyCertificate' that was previously de ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Certificate name. Cmdlet constructs the FQDN of a certificate from vault name, currently selected environment and certificate name. diff --git a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Undo-AzureKeyVaultKeyRemoval.md b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Undo-AzureKeyVaultKeyRemoval.md index 519aa6aa6264..ffb05f6bc88b 100644 --- a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Undo-AzureKeyVaultKeyRemoval.md +++ b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Undo-AzureKeyVaultKeyRemoval.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml +Module Name: AzureRM.KeyVault online version: https://msdn.microsoft.com/en-us/library/dn868052.aspx schema: 2.0.0 --- @@ -12,7 +13,8 @@ Recovers a deleted key in a key vault into an active state. ## SYNTAX ``` -Undo-AzureKeyVaultKeyRemoval [-VaultName] [-Name] [-WhatIf] [-Confirm] [] +Undo-AzureKeyVaultKeyRemoval [-VaultName] [-Name] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -31,6 +33,21 @@ This command will recover the key 'MyKey' that was previously deleted, into an a ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Key name. Cmdlet constructs the FQDN of a key from vault name, currently selected environment and key name. diff --git a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Undo-AzureKeyVaultSecretRemoval.md b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Undo-AzureKeyVaultSecretRemoval.md index cbeae9a7ea2b..e5b79884b50f 100644 --- a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Undo-AzureKeyVaultSecretRemoval.md +++ b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Undo-AzureKeyVaultSecretRemoval.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml +Module Name: AzureRM.KeyVault online version: https://msdn.microsoft.com/en-us/library/dn868052.aspx schema: 2.0.0 --- @@ -12,8 +13,8 @@ Recovers a deleted secret in a key vault into an active state. ## SYNTAX ``` -Undo-AzureKeyVaultSecretRemoval [-VaultName] [-Name] [-WhatIf] [-Confirm] - [] +Undo-AzureKeyVaultSecretRemoval [-VaultName] [-Name] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -32,6 +33,21 @@ This command will recover the secret 'MySecret' that was previously deleted, int ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Secret name. Cmdlet constructs the FQDN of a secret from vault name, currently selected environment and secret name. diff --git a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Undo-AzureRmKeyVaultRemoval.md b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Undo-AzureRmKeyVaultRemoval.md index 2806fe581726..b2aa32f58305 100644 --- a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Undo-AzureRmKeyVaultRemoval.md +++ b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Undo-AzureRmKeyVaultRemoval.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml +Module Name: AzureRM.KeyVault online version: https://msdn.microsoft.com/en-us/library/dn868052.aspx schema: 2.0.0 --- @@ -13,7 +14,7 @@ Recovers a deleted key vault into an active state. ``` Undo-AzureRmKeyVaultRemoval [-VaultName] [-ResourceGroupName] [-Location] - [-Tag ] [-WhatIf] [-Confirm] [] + [-Tag ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -33,6 +34,21 @@ tags with new tag. ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Location Specifies the deleted vault original Azure region. diff --git a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Update-AzureKeyVaultManagedStorageAccount.md b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Update-AzureKeyVaultManagedStorageAccount.md index 9b6589b13d30..ae5598c5ddbc 100644 --- a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Update-AzureKeyVaultManagedStorageAccount.md +++ b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Update-AzureKeyVaultManagedStorageAccount.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml +Module Name: AzureRM.KeyVault online version: https://msdn.microsoft.com/en-us/library/dn868052.aspx schema: 2.0.0 --- @@ -14,7 +15,8 @@ Update editable attributes of a Key Vault managed Azure Storage Account. ``` Update-AzureKeyVaultManagedStorageAccount [-VaultName] [-AccountName] [-ActiveKeyName ] [-AutoRegenerateKey ] [-RegenerationPeriod ] [-Enable ] - [-Tag ] [-PassThru] [-WhatIf] [-Confirm] [] + [-Tag ] [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -55,7 +57,7 @@ If not specified, the existing value of managed storage account's active key nam ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -71,7 +73,7 @@ If not specified, the existing value of auto regenerate key of managed storage a ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -80,13 +82,13 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure ```yaml -Type: SwitchParameter +Type: IAzureContextContainer Parameter Sets: (All) -Aliases: cf +Aliases: AzureRmContext, AzureCredential Required: False Position: Named @@ -104,7 +106,7 @@ unchanged. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -120,7 +122,7 @@ account object. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -138,7 +140,7 @@ unchanged ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -171,7 +173,7 @@ Cmdlet constructs the FQDN of a vault based on the name and currently selected e ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: Required: True Position: 0 @@ -180,6 +182,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. diff --git a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Update-AzureKeyVaultManagedStorageAccountKey.md b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Update-AzureKeyVaultManagedStorageAccountKey.md index 6adad3e2634e..d846208c072a 100644 --- a/src/ResourceManager/KeyVault/Commands.KeyVault/help/Update-AzureKeyVaultManagedStorageAccountKey.md +++ b/src/ResourceManager/KeyVault/Commands.KeyVault/help/Update-AzureKeyVaultManagedStorageAccountKey.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.KeyVault.dll-Help.xml +Module Name: AzureRM.KeyVault online version: https://msdn.microsoft.com/en-us/library/dn868052.aspx schema: 2.0.0 --- @@ -13,7 +14,7 @@ Regenerates the specified key of Key Vault managed Azure Storage Account. ``` Update-AzureKeyVaultManagedStorageAccountKey [-VaultName] [-AccountName] [-KeyName] - [-Force] [-PassThru] [-WhatIf] [-Confirm] [] + [-Force] [-PassThru] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -45,6 +46,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Do not ask for confirmation. diff --git a/src/ResourceManager/LogicApp/Commands.LogicApp/help/AzureRM.LogicApp.md b/src/ResourceManager/LogicApp/Commands.LogicApp/help/AzureRM.LogicApp.md index eb0b0729a97e..7b73fdbde4aa 100644 --- a/src/ResourceManager/LogicApp/Commands.LogicApp/help/AzureRM.LogicApp.md +++ b/src/ResourceManager/LogicApp/Commands.LogicApp/help/AzureRM.LogicApp.md @@ -24,7 +24,7 @@ Gets an integration account callback URL. Gets integration account certificates from a resource group. ### [Get-AzureRmIntegrationAccountGeneratedIcn](Get-AzureRmIntegrationAccountGeneratedIcn.md) -Gets integration account generated X12 interchange control number per agreement. +This cmdlet retrieves the current value of the generated interchange control number per agreement. ### [Get-AzureRmIntegrationAccountMap](Get-AzureRmIntegrationAccountMap.md) Gets an integration account map. @@ -33,7 +33,7 @@ Gets an integration account map. Gets integration account partners. ### [Get-AzureRmIntegrationAccountReceivedIcn](Get-AzureRmIntegrationAccountReceivedIcn.md) -Gets integration account received X12 interchange control number per agreement. +This cmdlet retrieves a specific received interchange control number per agreement and control number value. ### [Get-AzureRmIntegrationAccountSchema](Get-AzureRmIntegrationAccountSchema.md) Gets integration account schemas. @@ -96,7 +96,7 @@ Removes an integration account map. Removes an integration account partner. ### [Remove-AzureRmIntegrationAccountReceivedIcn](Remove-AzureRmIntegrationAccountReceivedIcn.md) -Removes an integration account received X12 interchange control number. +This cmdlet removes a specific received interchange control number per agreement and control number value. ### [Remove-AzureRmIntegrationAccountSchema](Remove-AzureRmIntegrationAccountSchema.md) Removes an integration account schema. @@ -114,7 +114,7 @@ Modifies an integration account agreement. Modifies an integration account certificate. ### [Set-AzureRmIntegrationAccountGeneratedIcn](Set-AzureRmIntegrationAccountGeneratedIcn.md) -Modifies an integration account generated X12 interchange control number. +Updates the integration account generated interchange control number (ICN) in the Azure resource group. ### [Set-AzureRmIntegrationAccountMap](Set-AzureRmIntegrationAccountMap.md) Modifies an integration account map. @@ -123,7 +123,7 @@ Modifies an integration account map. Modifies an integration account partner. ### [Set-AzureRmIntegrationAccountReceivedIcn](Set-AzureRmIntegrationAccountReceivedIcn.md) -Modifies an integration account received X12 interchange control number. +Updates the integration account received interchange control number (ICN) in the Azure resource group. ### [Set-AzureRmIntegrationAccountSchema](Set-AzureRmIntegrationAccountSchema.md) Modifies an integration account schema. diff --git a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmIntegrationAccount.md b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmIntegrationAccount.md index 650fda3d307b..c0a21f5632ff 100644 --- a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmIntegrationAccount.md +++ b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmIntegrationAccount.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml +Module Name: AzureRM.LogicApp ms.assetid: 7BCF2086-05FA-43FB-9D19-7277374CB03E online version: schema: 2.0.0 @@ -13,7 +14,8 @@ Gets integration accounts. ## SYNTAX ``` -Get-AzureRmIntegrationAccount [-ResourceGroupName ] [-Name ] [] +Get-AzureRmIntegrationAccount [-ResourceGroupName ] [-Name ] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -71,6 +73,21 @@ This command gets all the integration accounts in your Azure subscription. ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Specifies the name of an integration account. diff --git a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmIntegrationAccountAgreement.md b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmIntegrationAccountAgreement.md index e2199ee8a9e4..3526ac41b148 100644 --- a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmIntegrationAccountAgreement.md +++ b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmIntegrationAccountAgreement.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml +Module Name: AzureRM.LogicApp ms.assetid: 70C96DFC-F265-4792-AE62-DD224A4EE237 online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Gets an integration account agreement. ``` Get-AzureRmIntegrationAccountAgreement [-ResourceGroupName ] [-Name ] [-AgreementName ] - [] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -89,6 +90,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Specifies the name of an integration account. diff --git a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmIntegrationAccountCallbackUrl.md b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmIntegrationAccountCallbackUrl.md index fd8f1cfc7616..62583a9da610 100644 --- a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmIntegrationAccountCallbackUrl.md +++ b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmIntegrationAccountCallbackUrl.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml +Module Name: AzureRM.LogicApp ms.assetid: 4813EE2B-16C4-4716-B6DD-9447A0B46F3D online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Gets an integration account callback URL. ``` Get-AzureRmIntegrationAccountCallbackUrl -ResourceGroupName -Name [-NotAfter ] - [] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -40,6 +41,21 @@ This command gets an integration account callback URL. ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Specifies the name of an integration account. diff --git a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmIntegrationAccountCertificate.md b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmIntegrationAccountCertificate.md index 065047b027ed..6bb7cfb4dc63 100644 --- a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmIntegrationAccountCertificate.md +++ b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmIntegrationAccountCertificate.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml +Module Name: AzureRM.LogicApp ms.assetid: C0086E73-CCB1-4B75-B367-C79E17738122 online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Gets integration account certificates from a resource group. ``` Get-AzureRmIntegrationAccountCertificate [-ResourceGroupName ] [-Name ] - [-CertificateName ] [] + [-CertificateName ] [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -83,6 +84,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Specifies the name of an integration account. diff --git a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmIntegrationAccountGeneratedIcn.md b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmIntegrationAccountGeneratedIcn.md index 98f5ec71cdd8..ff253943a596 100644 --- a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmIntegrationAccountGeneratedIcn.md +++ b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmIntegrationAccountGeneratedIcn.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml +Module Name: AzureRM.LogicApp online version: schema: 2.0.0 --- @@ -13,7 +14,7 @@ This cmdlet retrieves the current value of the generated interchange control num ``` Get-AzureRmIntegrationAccountGeneratedIcn -ResourceGroupName -Name [-AgreementName ] - [-AgreementType ] [] + [-AgreementType ] [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -81,48 +82,64 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The integration account name. +### -AgreementType +The integration account agreement type. ```yaml Type: String Parameter Sets: (All) -Aliases: ResourceName +Aliases: MessageType +Accepted values: X12, Edifact -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ResourceGroupName -The integration account resource group name. +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The integration account name. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: ResourceName Required: True Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` -### -AgreementType -The integration account agreement type. +### -ResourceGroupName +The integration account resource group name. ```yaml Type: String Parameter Sets: (All) -Aliases: MessageType +Aliases: -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` diff --git a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmIntegrationAccountMap.md b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmIntegrationAccountMap.md index 06cf14c002fd..f2733804ea56 100644 --- a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmIntegrationAccountMap.md +++ b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmIntegrationAccountMap.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml +Module Name: AzureRM.LogicApp ms.assetid: 4F65A8B3-A250-41C1-9AA5-DBEB3193C401 online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Gets an integration account map. ``` Get-AzureRmIntegrationAccountMap [-ResourceGroupName ] [-Name ] [-MapName ] - [] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -66,6 +67,21 @@ This command gets the integration account maps by integration account name. ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -MapName Specifies the name of an integration account map. diff --git a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmIntegrationAccountPartner.md b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmIntegrationAccountPartner.md index b0cae6da9820..c90f12f951c2 100644 --- a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmIntegrationAccountPartner.md +++ b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmIntegrationAccountPartner.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml +Module Name: AzureRM.LogicApp ms.assetid: 6E84E26F-8150-41F8-8823-CEED05619A75 online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Gets integration account partners. ``` Get-AzureRmIntegrationAccountPartner [-ResourceGroupName ] [-Name ] [-PartnerName ] - [] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -60,6 +61,21 @@ This command gets the integration account partners for the integration account n ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Specifies the name of an integration account. diff --git a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmIntegrationAccountReceivedIcn.md b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmIntegrationAccountReceivedIcn.md index 4d7f358e0b27..653769783bb3 100644 --- a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmIntegrationAccountReceivedIcn.md +++ b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmIntegrationAccountReceivedIcn.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml +Module Name: AzureRM.LogicApp online version: schema: 2.0.0 --- @@ -13,7 +14,8 @@ This cmdlet retrieves a specific received interchange control number per agreeme ``` Get-AzureRmIntegrationAccountReceivedIcn -ResourceGroupName -Name -AgreementName - -ControlNumberValue [-AgreementType ] [] + -ControlNumberValue [-AgreementType ] [-DefaultProfile ] + [] ``` ## DESCRIPTION @@ -59,6 +61,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AgreementType +The integration account agreement type. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: MessageType +Accepted values: X12, Edifact + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ControlNumberValue The integration account control number value. @@ -74,48 +92,48 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The integration account name. +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure ```yaml -Type: String +Type: IAzureContextContainer Parameter Sets: (All) -Aliases: ResourceName +Aliases: AzureRmContext, AzureCredential -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ResourceGroupName -The integration account resource group name. +### -Name +The integration account name. ```yaml Type: String Parameter Sets: (All) -Aliases: +Aliases: ResourceName Required: True Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` -### -AgreementType -The integration account agreement type. +### -ResourceGroupName +The integration account resource group name. ```yaml Type: String Parameter Sets: (All) -Aliases: MessageType +Aliases: -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` diff --git a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmIntegrationAccountSchema.md b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmIntegrationAccountSchema.md index de9fcf3a24f2..6a406bab2e1f 100644 --- a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmIntegrationAccountSchema.md +++ b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmIntegrationAccountSchema.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml +Module Name: AzureRM.LogicApp ms.assetid: 6C16B04B-459A-4B2C-B7DF-AC4D16FF7281 online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Gets integration account schemas. ``` Get-AzureRmIntegrationAccountSchema [-ResourceGroupName ] [-Name ] [-SchemaName ] - [] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -66,6 +67,21 @@ This command gets the integration account schemas for the resource group named R ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Specifies the name of an integration account. diff --git a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmLogicApp.md b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmLogicApp.md index 556f6a1a8aa6..40ba60d6188c 100644 --- a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmLogicApp.md +++ b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmLogicApp.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml +Module Name: AzureRM.LogicApp ms.assetid: 7BFCD982-EC80-418B-BB52-C9941D028F76 online version: schema: 2.0.0 @@ -13,7 +14,8 @@ Gets a logic app from a resource group. ## SYNTAX ``` -Get-AzureRmLogicApp -ResourceGroupName -Name [-Version ] [] +Get-AzureRmLogicApp -ResourceGroupName -Name [-Version ] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -55,6 +57,21 @@ This command gets a logic app from the resource group named ResourceGroup11. ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Specifies the name of the logic app that this cmdlet gets. diff --git a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmLogicAppRunAction.md b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmLogicAppRunAction.md index d5cdff1c34ab..d4066085d2dd 100644 --- a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmLogicAppRunAction.md +++ b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmLogicAppRunAction.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml +Module Name: AzureRM.LogicApp ms.assetid: 2EA28B90-4BAE-45DF-BD2E-60C74F53FB7B online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Gets an action from a logic app run. ``` Get-AzureRmLogicAppRunAction -ResourceGroupName -Name -RunName - [-ActionName ] [] + [-ActionName ] [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -81,6 +82,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Specifies the name of a logic app for which this cmdlet gets an action. diff --git a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmLogicAppRunHistory.md b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmLogicAppRunHistory.md index 01ed61e5913c..22a389eeb19e 100644 --- a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmLogicAppRunHistory.md +++ b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmLogicAppRunHistory.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml +Module Name: AzureRM.LogicApp ms.assetid: F271BCB1-6D43-48E5-BB51-00288F57BFFB online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Gets the run history of a logic app. ``` Get-AzureRmLogicAppRunHistory -ResourceGroupName -Name [-RunName ] - [] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -76,6 +77,21 @@ This command gets a specific logic app run for the logic app named LogicApp03. ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Specifies the name of the logic app for which this cmdlet gets run history. diff --git a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmLogicAppTrigger.md b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmLogicAppTrigger.md index 60b573b6b9ae..3b4f1a26d97f 100644 --- a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmLogicAppTrigger.md +++ b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmLogicAppTrigger.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml +Module Name: AzureRM.LogicApp ms.assetid: 5307F1F1-E84C-4949-A557-99EF0012C3DF online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Gets the triggers of a logic app. ``` Get-AzureRmLogicAppTrigger -ResourceGroupName -Name [-TriggerName ] - [] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -67,6 +68,21 @@ This command gets the triggers of the logic app named LogicApp07. ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Specifies the name of the logic app from which this cmdlet gets a trigger. diff --git a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmLogicAppTriggerCallbackUrl.md b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmLogicAppTriggerCallbackUrl.md index d3ff6147141c..9e6f5dab53dc 100644 --- a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmLogicAppTriggerCallbackUrl.md +++ b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmLogicAppTriggerCallbackUrl.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml +Module Name: AzureRM.LogicApp ms.assetid: F523CFA0-427B-41AF-9C2D-EB54EC96C04B online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Gets a Logic App trigger callback URL. ``` Get-AzureRmLogicAppTriggerCallbackUrl -ResourceGroupName -Name -TriggerName - [] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -41,6 +42,21 @@ This command gets a Logic App trigger callback URL. ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Specifies the name of a logic app. diff --git a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmLogicAppTriggerHistory.md b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmLogicAppTriggerHistory.md index 7616ddc492fb..c5dbe92fdb19 100644 --- a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmLogicAppTriggerHistory.md +++ b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmLogicAppTriggerHistory.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml +Module Name: AzureRM.LogicApp ms.assetid: C1F6BBF9-0DB5-46FD-B8A8-9029B0AB6166 online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Gets the history of triggers in a logic app. ``` Get-AzureRmLogicAppTriggerHistory -ResourceGroupName -Name -TriggerName - [-HistoryName ] [] + [-HistoryName ] [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -85,6 +86,21 @@ This command gets the workflow trigger histories for a trigger in the logic app ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -HistoryName Specifies the name of the history that this cmdlet gets. diff --git a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmLogicAppUpgradedDefinition.md b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmLogicAppUpgradedDefinition.md index 109cbbc48a53..443885a26497 100644 --- a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmLogicAppUpgradedDefinition.md +++ b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Get-AzureRmLogicAppUpgradedDefinition.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml +Module Name: AzureRM.LogicApp ms.assetid: B7FED447-C398-47D7-AF1B-A3E4FDAD0B41 online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Gets the upgraded definition for a logic app. ``` Get-AzureRmLogicAppUpgradedDefinition -ResourceGroupName -Name -TargetSchemaVersion - [] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -183,6 +184,21 @@ The second command displays the contents of $UpgradedDefinition as a string. ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Specifies the name of a logic app. diff --git a/src/ResourceManager/LogicApp/Commands.LogicApp/help/New-AzureRmIntegrationAccount.md b/src/ResourceManager/LogicApp/Commands.LogicApp/help/New-AzureRmIntegrationAccount.md index 681cf0905df2..07980cb52602 100644 --- a/src/ResourceManager/LogicApp/Commands.LogicApp/help/New-AzureRmIntegrationAccount.md +++ b/src/ResourceManager/LogicApp/Commands.LogicApp/help/New-AzureRmIntegrationAccount.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml +Module Name: AzureRM.LogicApp ms.assetid: 5F1A4FE0-CB57-45D3-9F08-879469A61E1E online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Creates an integration account. ``` New-AzureRmIntegrationAccount -ResourceGroupName -Name -Location [-Sku ] - [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -46,6 +47,21 @@ This command creates an integration account named IntegrationAccount31 in the sp ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Location Specifies a location for the integration account. diff --git a/src/ResourceManager/LogicApp/Commands.LogicApp/help/New-AzureRmIntegrationAccountAgreement.md b/src/ResourceManager/LogicApp/Commands.LogicApp/help/New-AzureRmIntegrationAccountAgreement.md index 16b6703ca4e6..81432622c49b 100644 --- a/src/ResourceManager/LogicApp/Commands.LogicApp/help/New-AzureRmIntegrationAccountAgreement.md +++ b/src/ResourceManager/LogicApp/Commands.LogicApp/help/New-AzureRmIntegrationAccountAgreement.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml +Module Name: AzureRM.LogicApp ms.assetid: B8998AAA-05FC-4029-A284-B64E23326B22 online version: schema: 2.0.0 @@ -16,8 +17,8 @@ Creates an integration account agreement. New-AzureRmIntegrationAccountAgreement -ResourceGroupName -Name -AgreementName -AgreementType -GuestPartner -HostPartner -GuestIdentityQualifier -GuestIdentityQualifierValue -HostIdentityQualifier -HostIdentityQualifierValue - [-AgreementContent ] [-AgreementContentFilePath ] [-Metadata ] [-WhatIf] [-Confirm] - [] + [-AgreementContent ] [-AgreementContentFilePath ] [-Metadata ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -127,6 +128,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -GuestIdentityQualifier Specifies a name business identity qualifier for the guest partner. diff --git a/src/ResourceManager/LogicApp/Commands.LogicApp/help/New-AzureRmIntegrationAccountCertificate.md b/src/ResourceManager/LogicApp/Commands.LogicApp/help/New-AzureRmIntegrationAccountCertificate.md index c77e1043026f..67a45408bef0 100644 --- a/src/ResourceManager/LogicApp/Commands.LogicApp/help/New-AzureRmIntegrationAccountCertificate.md +++ b/src/ResourceManager/LogicApp/Commands.LogicApp/help/New-AzureRmIntegrationAccountCertificate.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml +Module Name: AzureRM.LogicApp ms.assetid: BB1B49CD-B42F-4222-B0BA-0AA4CE3C95E0 online version: schema: 2.0.0 @@ -16,21 +17,21 @@ Creates an integration account certificate. ``` New-AzureRmIntegrationAccountCertificate -ResourceGroupName -Name -CertificateName -KeyName -KeyVersion -KeyVaultId [-PublicCertificateFilePath ] - [-Metadata ] [-WhatIf] [-Confirm] [] + [-Metadata ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### PublicKey ``` New-AzureRmIntegrationAccountCertificate -ResourceGroupName -Name -CertificateName [-KeyName ] [-KeyVersion ] [-KeyVaultId ] -PublicCertificateFilePath - [-Metadata ] [-WhatIf] [-Confirm] [] + [-Metadata ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### Both ``` New-AzureRmIntegrationAccountCertificate -ResourceGroupName -Name -CertificateName -KeyName -KeyVersion -KeyVaultId -PublicCertificateFilePath - [-Metadata ] [-WhatIf] [-Confirm] [] + [-Metadata ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -82,6 +83,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -KeyName Specifies the name of the certificate key in the key vault. diff --git a/src/ResourceManager/LogicApp/Commands.LogicApp/help/New-AzureRmIntegrationAccountMap.md b/src/ResourceManager/LogicApp/Commands.LogicApp/help/New-AzureRmIntegrationAccountMap.md index b7e15aeb1c8e..b47010281b15 100644 --- a/src/ResourceManager/LogicApp/Commands.LogicApp/help/New-AzureRmIntegrationAccountMap.md +++ b/src/ResourceManager/LogicApp/Commands.LogicApp/help/New-AzureRmIntegrationAccountMap.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml +Module Name: AzureRM.LogicApp ms.assetid: DF71430C-F33F-409B-A550-CC7285252E91 online version: schema: 2.0.0 @@ -15,7 +16,7 @@ Creates an integration account map. ``` New-AzureRmIntegrationAccountMap -ResourceGroupName -Name -MapName [-MapFilePath ] [-MapDefinition ] [-MapType ] [-ContentType ] - [-Metadata ] [-WhatIf] [-Confirm] [] + [-Metadata ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -68,6 +69,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -MapDefinition Specifies a definition object for integration account map. Specify either this parameter or the *MapFilePath* parameter. diff --git a/src/ResourceManager/LogicApp/Commands.LogicApp/help/New-AzureRmIntegrationAccountPartner.md b/src/ResourceManager/LogicApp/Commands.LogicApp/help/New-AzureRmIntegrationAccountPartner.md index 728a694dc7ef..7d27514c6772 100644 --- a/src/ResourceManager/LogicApp/Commands.LogicApp/help/New-AzureRmIntegrationAccountPartner.md +++ b/src/ResourceManager/LogicApp/Commands.LogicApp/help/New-AzureRmIntegrationAccountPartner.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml +Module Name: AzureRM.LogicApp ms.assetid: 2B5FC268-4888-4AEB-B125-7263CF2E4DCD online version: schema: 2.0.0 @@ -14,8 +15,8 @@ Creates an integration account partner. ``` New-AzureRmIntegrationAccountPartner -ResourceGroupName -Name -PartnerName - [-PartnerType ] -BusinessIdentities [-Metadata ] [-WhatIf] [-Confirm] - [] + [-PartnerType ] -BusinessIdentities [-Metadata ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -65,6 +66,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Metadata Specifies a metadata object for the partner. diff --git a/src/ResourceManager/LogicApp/Commands.LogicApp/help/New-AzureRmIntegrationAccountSchema.md b/src/ResourceManager/LogicApp/Commands.LogicApp/help/New-AzureRmIntegrationAccountSchema.md index 29eccdbf2645..3d731e9334fc 100644 --- a/src/ResourceManager/LogicApp/Commands.LogicApp/help/New-AzureRmIntegrationAccountSchema.md +++ b/src/ResourceManager/LogicApp/Commands.LogicApp/help/New-AzureRmIntegrationAccountSchema.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml +Module Name: AzureRM.LogicApp ms.assetid: 91FFBEE9-A488-49ED-8C6C-2DE891CE0749 online version: schema: 2.0.0 @@ -15,7 +16,7 @@ Creates an integration account schema. ``` New-AzureRmIntegrationAccountSchema -ResourceGroupName -Name -SchemaName [-SchemaFilePath ] [-SchemaDefinition ] [-SchemaType ] [-ContentType ] - [-Metadata ] [-WhatIf] [-Confirm] [] + [-Metadata ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -66,6 +67,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Metadata Specifies a metadata object for the schema. diff --git a/src/ResourceManager/LogicApp/Commands.LogicApp/help/New-AzureRmLogicApp.md b/src/ResourceManager/LogicApp/Commands.LogicApp/help/New-AzureRmLogicApp.md index 6742f7608128..1ef69b125750 100644 --- a/src/ResourceManager/LogicApp/Commands.LogicApp/help/New-AzureRmLogicApp.md +++ b/src/ResourceManager/LogicApp/Commands.LogicApp/help/New-AzureRmLogicApp.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml +Module Name: AzureRM.LogicApp ms.assetid: 8679240C-EA47-41C5-B8C1-A3C99547F42B online version: schema: 2.0.0 @@ -16,14 +17,15 @@ Creates a logic app in a resource group. ``` New-AzureRmLogicApp -ResourceGroupName -Name -Location [-State ] [-Definition ] [-IntegrationAccountId ] [-Parameters ] [-ParameterFilePath ] - [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### LogicAppWithDefinitionFileParameterSet ``` New-AzureRmLogicApp -ResourceGroupName -Name -Location [-State ] [-DefinitionFilePath ] [-IntegrationAccountId ] [-Parameters ] - [-ParameterFilePath ] [-WhatIf] [-Confirm] [] + [-ParameterFilePath ] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -157,6 +159,21 @@ The second command creates a new logic app that uses the definition and paramete ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Definition Specifies the definition for your logic app as an object or a string in JavaScript Object Notataion (JSON) format. diff --git a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Remove-AzureRmIntegrationAccount.md b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Remove-AzureRmIntegrationAccount.md index 7027c59703bc..c390793e7429 100644 --- a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Remove-AzureRmIntegrationAccount.md +++ b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Remove-AzureRmIntegrationAccount.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml +Module Name: AzureRM.LogicApp ms.assetid: 607FBE75-727D-4388-9504-94AD31BCDBBF online version: schema: 2.0.0 @@ -13,8 +14,8 @@ Removes an integration account. ## SYNTAX ``` -Remove-AzureRmIntegrationAccount -ResourceGroupName -Name [-Force] [-WhatIf] [-Confirm] - [] +Remove-AzureRmIntegrationAccount -ResourceGroupName -Name [-Force] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -37,6 +38,21 @@ This command removes an integration account named IntegrationAccount31. ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Forces the command to run without asking for user confirmation. diff --git a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Remove-AzureRmIntegrationAccountAgreement.md b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Remove-AzureRmIntegrationAccountAgreement.md index 1da426a3d2f5..e8d0c62e0165 100644 --- a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Remove-AzureRmIntegrationAccountAgreement.md +++ b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Remove-AzureRmIntegrationAccountAgreement.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml +Module Name: AzureRM.LogicApp ms.assetid: EBDBB9F0-CA2E-4E4F-9034-3D0FAB88E442 online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Removes an integration account agreement. ``` Remove-AzureRmIntegrationAccountAgreement -ResourceGroupName -Name -AgreementName - [-Force] [-WhatIf] [-Confirm] [] + [-Force] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -53,6 +54,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Forces the command to run without asking for user confirmation. diff --git a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Remove-AzureRmIntegrationAccountCertificate.md b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Remove-AzureRmIntegrationAccountCertificate.md index 4bbf9cae7c75..f173b74b6db2 100644 --- a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Remove-AzureRmIntegrationAccountCertificate.md +++ b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Remove-AzureRmIntegrationAccountCertificate.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml +Module Name: AzureRM.LogicApp ms.assetid: F9871519-F470-470C-8CCE-A674B6B5A3EE online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Removes an integration account certificate from a resource group. ``` Remove-AzureRmIntegrationAccountCertificate -ResourceGroupName -Name - -CertificateName [-Force] [-WhatIf] [-Confirm] [] + -CertificateName [-Force] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -52,6 +54,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Forces the command to run without asking for user confirmation. diff --git a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Remove-AzureRmIntegrationAccountMap.md b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Remove-AzureRmIntegrationAccountMap.md index 56de1e3460ce..3b5695e53b9e 100644 --- a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Remove-AzureRmIntegrationAccountMap.md +++ b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Remove-AzureRmIntegrationAccountMap.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml +Module Name: AzureRM.LogicApp ms.assetid: 7AAF2ACC-84ED-449C-B1E8-F074463F44EB online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Removes an integration account map. ``` Remove-AzureRmIntegrationAccountMap -ResourceGroupName -Name -MapName [-Force] - [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -37,6 +38,21 @@ This command removes the integration account map named IntegrationAccountMap47. ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Forces the command to run without asking for user confirmation. diff --git a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Remove-AzureRmIntegrationAccountPartner.md b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Remove-AzureRmIntegrationAccountPartner.md index 66c3b5e993da..e30c3f68721c 100644 --- a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Remove-AzureRmIntegrationAccountPartner.md +++ b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Remove-AzureRmIntegrationAccountPartner.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml +Module Name: AzureRM.LogicApp ms.assetid: E8A557EA-FE3F-4433-BFDE-B4D73DF8467C online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Removes an integration account partner. ``` Remove-AzureRmIntegrationAccountPartner -ResourceGroupName -Name -PartnerName - [-Force] [-WhatIf] [-Confirm] [] + [-Force] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -37,6 +38,21 @@ This command removes the integration account partner named IntegrationAccountPar ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Forces the command to run without asking for user confirmation. diff --git a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Remove-AzureRmIntegrationAccountReceivedIcn.md b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Remove-AzureRmIntegrationAccountReceivedIcn.md index 3d41088f6a78..dd2445cba37d 100644 --- a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Remove-AzureRmIntegrationAccountReceivedIcn.md +++ b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Remove-AzureRmIntegrationAccountReceivedIcn.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml +Module Name: AzureRM.LogicApp online version: schema: 2.0.0 --- @@ -13,7 +14,8 @@ This cmdlet removes a specific received interchange control number per agreement ``` Remove-AzureRmIntegrationAccountReceivedIcn -ResourceGroupName -Name -AgreementName - -ControlNumberValue [-AgreementType ] [-WhatIf] [-Confirm] [] + -ControlNumberValue [-AgreementType ] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -89,6 +91,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AgreementType +The integration account agreement type. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: MessageType +Accepted values: X12, Edifact + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ControlNumberValue The integration account control number value. @@ -104,6 +122,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name The integration account name. @@ -165,21 +198,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AgreementType -The integration account agreement type. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: MessageType - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Remove-AzureRmIntegrationAccountSchema.md b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Remove-AzureRmIntegrationAccountSchema.md index 7ae9ccf47762..d5b1cfe949a3 100644 --- a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Remove-AzureRmIntegrationAccountSchema.md +++ b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Remove-AzureRmIntegrationAccountSchema.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml +Module Name: AzureRM.LogicApp ms.assetid: 56550997-21D9-4F85-B23A-677625482547 online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Removes an integration account schema. ``` Remove-AzureRmIntegrationAccountSchema -ResourceGroupName -Name -SchemaName [-Force] - [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -37,6 +38,21 @@ This command removes an integration account schema named IntegrationAccountSchem ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Forces the command to run without asking for user confirmation. diff --git a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Remove-AzureRmLogicApp.md b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Remove-AzureRmLogicApp.md index a1869232433b..2630cafe6744 100644 --- a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Remove-AzureRmLogicApp.md +++ b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Remove-AzureRmLogicApp.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml +Module Name: AzureRM.LogicApp ms.assetid: 39D1576D-7042-4A62-AB41-0B5131C150D5 online version: schema: 2.0.0 @@ -13,8 +14,8 @@ Removes a logic app from a resource group. ## SYNTAX ``` -Remove-AzureRmLogicApp -ResourceGroupName -Name [-Force] [-WhatIf] [-Confirm] - [] +Remove-AzureRmLogicApp -ResourceGroupName -Name [-Force] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -38,6 +39,21 @@ The command includes the *Force* parameter, which prevents the command from prom ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Forces the command to run without asking for user confirmation. diff --git a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Set-AzureRmIntegrationAccount.md b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Set-AzureRmIntegrationAccount.md index cf9c21cc20b1..e8323cb4b039 100644 --- a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Set-AzureRmIntegrationAccount.md +++ b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Set-AzureRmIntegrationAccount.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml +Module Name: AzureRM.LogicApp ms.assetid: F6D9EA59-BA61-4117-8771-9B190424BFF8 online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Modifies an integration account. ``` Set-AzureRmIntegrationAccount -ResourceGroupName -Name [-Location ] [-Sku ] - [-Force] [-WhatIf] [-Confirm] [] + [-Force] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -44,6 +45,21 @@ This command modifies an integration account named IntegrationAccount31 in the s ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Forces the command to run without asking for user confirmation. diff --git a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Set-AzureRmIntegrationAccountAgreement.md b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Set-AzureRmIntegrationAccountAgreement.md index 09d5188b7d9d..6fb0c5b96170 100644 --- a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Set-AzureRmIntegrationAccountAgreement.md +++ b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Set-AzureRmIntegrationAccountAgreement.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml +Module Name: AzureRM.LogicApp ms.assetid: 5FDD6C6A-9F6A-44C3-B332-B528F648DFDB online version: schema: 2.0.0 @@ -17,7 +18,8 @@ Set-AzureRmIntegrationAccountAgreement -ResourceGroupName -Name ] [-GuestPartner ] [-HostPartner ] [-GuestIdentityQualifier ] [-GuestIdentityQualifierValue ] [-HostIdentityQualifier ] [-HostIdentityQualifierValue ] [-AgreementContent ] [-AgreementContentFilePath ] - [-Metadata ] [-Force] [-WhatIf] [-Confirm] [] + [-Metadata ] [-Force] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -124,6 +126,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Forces the command to run without asking for user confirmation. diff --git a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Set-AzureRmIntegrationAccountCertificate.md b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Set-AzureRmIntegrationAccountCertificate.md index c40558540835..3a9a787c4717 100644 --- a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Set-AzureRmIntegrationAccountCertificate.md +++ b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Set-AzureRmIntegrationAccountCertificate.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml +Module Name: AzureRM.LogicApp ms.assetid: D9CA9515-5C19-4D63-8D4D-0B288E9309E9 online version: schema: 2.0.0 @@ -15,7 +16,8 @@ Modifies an integration account certificate. ``` Set-AzureRmIntegrationAccountCertificate -ResourceGroupName -Name -CertificateName [-KeyName ] [-KeyVersion ] [-KeyVaultId ] [-PublicCertificateFilePath ] - [-Metadata ] [-Force] [-WhatIf] [-Confirm] [] + [-Metadata ] [-Force] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -66,6 +68,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Forces the command to run without asking for user confirmation. diff --git a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Set-AzureRmIntegrationAccountGeneratedIcn.md b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Set-AzureRmIntegrationAccountGeneratedIcn.md index 05544db11e95..574823e8e42f 100644 --- a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Set-AzureRmIntegrationAccountGeneratedIcn.md +++ b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Set-AzureRmIntegrationAccountGeneratedIcn.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml +Module Name: AzureRM.LogicApp online version: schema: 2.0.0 --- @@ -13,7 +14,8 @@ Updates the integration account generated interchange control number (ICN) in th ``` Set-AzureRmIntegrationAccountGeneratedIcn -ResourceGroupName -Name -AgreementName - -ControlNumber [-AgreementType ] [-WhatIf] [-Confirm] [] + -ControlNumber [-AgreementType ] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -75,6 +77,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AgreementType +The integration account agreement type. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: MessageType +Accepted values: X12, Edifact + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ControlNumber The generated control number new value. @@ -90,6 +108,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name The integration account name. @@ -151,21 +184,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AgreementType -The integration account agreement type. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: MessageType - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Set-AzureRmIntegrationAccountMap.md b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Set-AzureRmIntegrationAccountMap.md index a0599d5a71ac..c88cefb0b81c 100644 --- a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Set-AzureRmIntegrationAccountMap.md +++ b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Set-AzureRmIntegrationAccountMap.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml +Module Name: AzureRM.LogicApp ms.assetid: 7EF87BE5-FB10-4E5D-A12F-7F50EE6DAD57 online version: schema: 2.0.0 @@ -15,7 +16,8 @@ Modifies an integration account map. ``` Set-AzureRmIntegrationAccountMap -ResourceGroupName -Name -MapName [-MapFilePath ] [-MapDefinition ] [-MapType ] [-ContentType ] - [-Metadata ] [-Force] [-WhatIf] [-Confirm] [] + [-Metadata ] [-Force] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -66,6 +68,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Forces the command to run without asking for user confirmation. diff --git a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Set-AzureRmIntegrationAccountPartner.md b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Set-AzureRmIntegrationAccountPartner.md index f0fbc8c113ad..10101b81c0c1 100644 --- a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Set-AzureRmIntegrationAccountPartner.md +++ b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Set-AzureRmIntegrationAccountPartner.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml +Module Name: AzureRM.LogicApp ms.assetid: 9B3B6AD4-C37C-4877-9864-9FB2E3B0BDAB online version: schema: 2.0.0 @@ -14,8 +15,8 @@ Modifies an integration account partner. ``` Set-AzureRmIntegrationAccountPartner -ResourceGroupName -Name -PartnerName - [-PartnerType ] [-BusinessIdentities ] [-Metadata ] [-Force] [-WhatIf] [-Confirm] - [] + [-PartnerType ] [-BusinessIdentities ] [-Metadata ] [-Force] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -63,6 +64,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Forces the command to run without asking for user confirmation. diff --git a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Set-AzureRmIntegrationAccountReceivedIcn.md b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Set-AzureRmIntegrationAccountReceivedIcn.md index 13351e4361c3..7047732fa8c2 100644 --- a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Set-AzureRmIntegrationAccountReceivedIcn.md +++ b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Set-AzureRmIntegrationAccountReceivedIcn.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml +Module Name: AzureRM.LogicApp online version: schema: 2.0.0 --- @@ -13,8 +14,8 @@ Updates the integration account received interchange control number (ICN) in the ``` Set-AzureRmIntegrationAccountReceivedIcn -ResourceGroupName -Name -AgreementName - -ControlNumberValue -IsMessageProcessingFailed [-AgreementType ] [-WhatIf] - [-Confirm] [] + -ControlNumberValue -IsMessageProcessingFailed [-AgreementType ] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -66,6 +67,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -AgreementType +The integration account agreement type (X12 or Edifact). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: MessageType +Accepted values: X12, Edifact + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ControlNumberValue The integration account control number value. @@ -81,6 +98,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -IsMessageProcessingFailed The received message processing status. @@ -157,21 +189,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AgreementType -The integration account agreement type (X12 or Edifact). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: MessageType - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Set-AzureRmIntegrationAccountSchema.md b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Set-AzureRmIntegrationAccountSchema.md index cc45aa30ccdd..6e08677e2cfc 100644 --- a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Set-AzureRmIntegrationAccountSchema.md +++ b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Set-AzureRmIntegrationAccountSchema.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml +Module Name: AzureRM.LogicApp ms.assetid: 3D4E44E3-0B55-4699-944F-412EE80CEEEF online version: schema: 2.0.0 @@ -15,7 +16,8 @@ Modifies an integration account schema. ``` Set-AzureRmIntegrationAccountSchema -ResourceGroupName -Name -SchemaName [-SchemaFilePath ] [-SchemaDefinition ] [-SchemaType ] [-ContentType ] - [-Metadata ] [-Force] [-WhatIf] [-Confirm] [] + [-Metadata ] [-Force] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -66,6 +68,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Forces the command to run without asking for user confirmation. diff --git a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Set-AzureRmLogicApp.md b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Set-AzureRmLogicApp.md index a1ee2379afa1..4c69367a7009 100644 --- a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Set-AzureRmLogicApp.md +++ b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Set-AzureRmLogicApp.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml +Module Name: AzureRM.LogicApp ms.assetid: AEDA89D3-EF80-4E56-9B97-677EC8F3959D online version: schema: 2.0.0 @@ -16,14 +17,16 @@ Modifies a logic app in a resource group. ``` Set-AzureRmLogicApp -ResourceGroupName -Name [-UseConsumptionModel] [-State ] [-Definition ] [-DefinitionFilePath ] [-IntegrationAccountId ] [-Parameters ] - [-ParameterFilePath ] [-Force] [-WhatIf] [-Confirm] [] + [-ParameterFilePath ] [-Force] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ### HostingPlan ``` Set-AzureRmLogicApp -ResourceGroupName -Name [-AppServicePlan ] [-State ] [-Definition ] [-DefinitionFilePath ] [-IntegrationAccountId ] [-Parameters ] - [-ParameterFilePath ] [-Force] [-WhatIf] [-Confirm] [] + [-ParameterFilePath ] [-Force] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -86,6 +89,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Definition Specifies the definition of a logic app as an object or a string in JavaScript Object Notation (JSON) format. diff --git a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Start-AzureRmLogicApp.md b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Start-AzureRmLogicApp.md index 076ca023bef9..eaba1299850d 100644 --- a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Start-AzureRmLogicApp.md +++ b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Start-AzureRmLogicApp.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml +Module Name: AzureRM.LogicApp ms.assetid: 50C359FC-D98C-4C2C-87EE-BE9A25C3EDC6 online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Runs a logic app in a resource group. ``` Start-AzureRmLogicApp -ResourceGroupName -Name [-Parameters ] -TriggerName - [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -37,6 +38,21 @@ This command runs the logic app in the resource group named ResourceGroup11. ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Specifies the name of the logic app that this cmdlet starts. diff --git a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Stop-AzureRmLogicAppRun.md b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Stop-AzureRmLogicAppRun.md index 8a3043666d15..d14ec0c751b0 100644 --- a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Stop-AzureRmLogicAppRun.md +++ b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Stop-AzureRmLogicAppRun.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml +Module Name: AzureRM.LogicApp ms.assetid: 3308F901-4C9F-424D-8BEB-877A6038B246 online version: schema: 2.0.0 @@ -13,8 +14,8 @@ Cancels a run of a logic app. ## SYNTAX ``` -Stop-AzureRmLogicAppRun -ResourceGroupName -Name -RunName [-Force] [-WhatIf] - [-Confirm] [] +Stop-AzureRmLogicAppRun -ResourceGroupName -Name -RunName [-Force] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -37,6 +38,21 @@ This command cancels a run of the logic app named LogicApp03. ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Forces the command to run without asking for user confirmation. diff --git a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Test-AzureRmLogicApp.md b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Test-AzureRmLogicApp.md index 63630f6e9eca..a29aace021e9 100644 --- a/src/ResourceManager/LogicApp/Commands.LogicApp/help/Test-AzureRmLogicApp.md +++ b/src/ResourceManager/LogicApp/Commands.LogicApp/help/Test-AzureRmLogicApp.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.LogicApp.dll-Help.xml +Module Name: AzureRM.LogicApp ms.assetid: 929F4593-2A71-49B9-87F8-F24FA9F6E314 online version: schema: 2.0.0 @@ -16,14 +17,14 @@ Validates a logic app definition. ``` Test-AzureRmLogicApp -ResourceGroupName -Name -Location [-State ] [-Definition ] [-IntegrationAccountId ] [-Parameters ] [-ParameterFilePath ] - [] + [-DefaultProfile ] [] ``` ### LogicAppWithDefinitionFileParameterSet ``` Test-AzureRmLogicApp -ResourceGroupName -Name -Location [-State ] [-DefinitionFilePath ] [-IntegrationAccountId ] [-Parameters ] - [-ParameterFilePath ] [] + [-ParameterFilePath ] [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -55,6 +56,21 @@ The command specifies definition and parameter objects. ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Definition Specifies the definition of a logic app as an object or a string in JavaScript Object Notation (JSON) format. diff --git a/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Add-AzureRmMlWebServiceRegionalProperty.md b/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Add-AzureRmMlWebServiceRegionalProperty.md index 956ff57dec44..4b44b46b1b1e 100644 --- a/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Add-AzureRmMlWebServiceRegionalProperty.md +++ b/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Add-AzureRmMlWebServiceRegionalProperty.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.MachineLearning.dll-Help.xml +Module Name: AzureRM.MachineLearning online version: schema: 2.0.0 --- @@ -12,7 +13,8 @@ Creates regional web service properties. ## SYNTAX ``` -Add-AzureRmMlWebServiceRegionalProperty -ResourceGroupName -Name -Region [-Force] [-WhatIf] [-Confirm] +Add-AzureRmMlWebServiceRegionalProperty -ResourceGroupName -Name -Region [-Force] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -21,7 +23,6 @@ Creates Azure Machine Learning regional properties for an existing web service. ## EXAMPLES ### -------------------------- Example 1: Add new regional properties for West Central US -------------------------- - @{paragraph=PS C:\\\>} ``` @@ -32,6 +33,21 @@ This example command creates regional property for a web service in the "West C ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Do not ask for confirmation. @@ -58,7 +74,7 @@ Aliases: Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` @@ -88,7 +104,7 @@ Aliases: Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` @@ -123,6 +139,9 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). + ## INPUTS ## OUTPUTS diff --git a/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/AzureRM.MachineLearning.md b/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/AzureRM.MachineLearning.md index b9c51f0499c5..d5e39d155812 100644 --- a/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/AzureRM.MachineLearning.md +++ b/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/AzureRM.MachineLearning.md @@ -11,6 +11,9 @@ Locale: en-US {{Manually Enter Description Here}} ## AzureRM.MachineLearning Cmdlets +### [Add-AzureRmMlWebServiceRegionalProperty](Add-AzureRmMlWebServiceRegionalProperty.md) +Creates regional web service properties. + ### [Export-AzureRmMlWebService](Export-AzureRmMlWebService.md) Exports the web service definition object as a JSON formatted string. @@ -39,11 +42,7 @@ Moves a commitment association from one commitment plan to another. Creates a new commitment plan. ### [New-AzureRmMlWebService](New-AzureRmMlWebService.md) - -Creates a new Azure Machine Learning web service. - -### [Add-AzureRmMlWebServiceRegionalProperty](Add-AzureRmMlWebServiceRegionalProperty.md) -Creates regional web service properties. +Creates a new web service. ### [Remove-AzureRmMlCommitmentPlan](Remove-AzureRmMlCommitmentPlan.md) Deletes a commitment plan. diff --git a/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Export-AzureRmMlWebService.md b/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Export-AzureRmMlWebService.md index e84dc38d1479..964c6b9ac23d 100644 --- a/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Export-AzureRmMlWebService.md +++ b/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Export-AzureRmMlWebService.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.MachineLearning.dll-Help.xml +Module Name: AzureRM.MachineLearning online version: schema: 2.0.0 --- @@ -13,14 +14,14 @@ Exports the web service definition object as a JSON formatted string. ### Export to file. ``` -Export-AzureRmMlWebService -WebService -OutputFile [-Force] [-WhatIf] [-Confirm] - [] +Export-AzureRmMlWebService -WebService -OutputFile [-Force] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### Export to JSON string. ``` -Export-AzureRmMlWebService -WebService [-ToJsonString] [-Force] [-WhatIf] [-Confirm] - [] +Export-AzureRmMlWebService -WebService [-ToJsonString] [-Force] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -49,6 +50,21 @@ Export-AzureRmMlWebService -WebService $svc -OutputFile "C:\mlservice.json" ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Do not ask for confirmation. @@ -146,7 +162,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### WebService - Parameter 'WebService' accepts value of type 'WebService' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Get-AzureRmMlCommitmentAssociation.md b/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Get-AzureRmMlCommitmentAssociation.md index 7d926f49a984..0463de05c390 100644 --- a/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Get-AzureRmMlCommitmentAssociation.md +++ b/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Get-AzureRmMlCommitmentAssociation.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.MachineLearning.dll-Help.xml +Module Name: AzureRM.MachineLearning online version: schema: 2.0.0 --- @@ -13,7 +14,7 @@ Retrieves the summary information for one or more commitment associations. ``` Get-AzureRmMlCommitmentAssociation -ResourceGroupName -CommitmentPlanName [-Name ] - [] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -57,6 +58,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name The name of the Azure ML commitment association. diff --git a/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Get-AzureRmMlCommitmentPlan.md b/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Get-AzureRmMlCommitmentPlan.md index 1a7682005fc2..afb51f922983 100644 --- a/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Get-AzureRmMlCommitmentPlan.md +++ b/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Get-AzureRmMlCommitmentPlan.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.MachineLearning.dll-Help.xml +Module Name: AzureRM.MachineLearning online version: schema: 2.0.0 --- @@ -12,7 +13,8 @@ Retrieves the summary information for one or more commitment plans. ## SYNTAX ``` -Get-AzureRmMlCommitmentPlan [-ResourceGroupName ] [-Name ] [] +Get-AzureRmMlCommitmentPlan [-ResourceGroupName ] [-Name ] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -50,6 +52,21 @@ Get-AzureRmMlCommitmentPlan -ResourceGroupName "MyResourceGroup" ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name The name of the commitment plan. diff --git a/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Get-AzureRmMlCommitmentPlanUsageHistory.md b/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Get-AzureRmMlCommitmentPlanUsageHistory.md index 92473edf71d7..d034786101e8 100644 --- a/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Get-AzureRmMlCommitmentPlanUsageHistory.md +++ b/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Get-AzureRmMlCommitmentPlanUsageHistory.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.MachineLearning.dll-Help.xml +Module Name: AzureRM.MachineLearning online version: schema: 2.0.0 --- @@ -12,7 +13,8 @@ Retrieves usage history information for a specified commitment plan. ## SYNTAX ``` -Get-AzureRmMlCommitmentPlanUsageHistory -ResourceGroupName -Name [] +Get-AzureRmMlCommitmentPlanUsageHistory -ResourceGroupName -Name + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -31,6 +33,21 @@ Get-AzureRmMlCommitmentPlanUsageHistory -ResourceGroupName "MyResourceGroup" -Na ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name The name of the Azure ML commitment plan. diff --git a/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Get-AzureRmMlWebService.md b/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Get-AzureRmMlWebService.md index e5ad754c4098..908012839680 100644 --- a/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Get-AzureRmMlWebService.md +++ b/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Get-AzureRmMlWebService.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.MachineLearning.dll-Help.xml +Module Name: AzureRM.MachineLearning online version: schema: 2.0.0 --- @@ -12,7 +13,8 @@ Retrieves the summary information for one or more web services. ## SYNTAX ``` -Get-AzureRmMlWebService [-ResourceGroupName ] [-Name ] [] +Get-AzureRmMlWebService [-ResourceGroupName ] [-Name ] [-Region ] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -50,6 +52,21 @@ Get-AzureRmMlWebService -ResourceGroupName "myresourcegroup" ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name The name of the web service for which the details are retrieved. @@ -65,6 +82,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Region +The name of regio + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName The resource group from which the details for the web service are retrieved. diff --git a/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Get-AzureRmMlWebServiceKeys.md b/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Get-AzureRmMlWebServiceKeys.md index e8169d2a92a0..0e988976b891 100644 --- a/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Get-AzureRmMlWebServiceKeys.md +++ b/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Get-AzureRmMlWebServiceKeys.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.MachineLearning.dll-Help.xml +Module Name: AzureRM.MachineLearning online version: schema: 2.0.0 --- @@ -13,12 +14,14 @@ Retrieves the web service's keys. ### Get an Azure ML web service's access keys given its name and resource group. ``` -Get-AzureRmMlWebServiceKeys -ResourceGroupName -Name [] +Get-AzureRmMlWebServiceKeys -ResourceGroupName -Name + [-DefaultProfile ] [] ``` ### Get the access kesy for the given web service instance. ``` -Get-AzureRmMlWebServiceKeys -MlWebService [] +Get-AzureRmMlWebServiceKeys -MlWebService [-DefaultProfile ] + [] ``` ## DESCRIPTION @@ -48,6 +51,21 @@ $mlService is an object of type Microsoft.Azure.Management.MachineLearning.WebSe ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -MlWebService The name of the web service for which the access keys are retrieved. @@ -99,7 +117,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### WebService - Parameter 'MlWebService' accepts value of type 'WebService' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Import-AzureRmMlWebService.md b/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Import-AzureRmMlWebService.md index 8173e2e2f667..9bc79a6ca6bf 100644 --- a/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Import-AzureRmMlWebService.md +++ b/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Import-AzureRmMlWebService.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.MachineLearning.dll-Help.xml +Module Name: AzureRM.MachineLearning online version: schema: 2.0.0 --- @@ -13,12 +14,12 @@ Imports a JSON object into a web service definition. ### Import from JSON file. ``` -Import-AzureRmMlWebService -InputFile [] +Import-AzureRmMlWebService -InputFile [-DefaultProfile ] [] ``` ### Import from JSON string. ``` -Import-AzureRmMlWebService -JsonString [] +Import-AzureRmMlWebService -JsonString [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -39,13 +40,27 @@ Import-AzureRmMlWebService -JsonString $jsonDefinition @{paragraph=PS C:\\\>} - ``` Import-AzureRmMlWebService -InputFile "C:\mlservice.json" ``` ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InputFile The path to the file containing the web service definition to import. diff --git a/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Move-AzureRmMlCommitmentAssociation.md b/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Move-AzureRmMlCommitmentAssociation.md index d24b68f1791e..b25be83c68f1 100644 --- a/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Move-AzureRmMlCommitmentAssociation.md +++ b/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Move-AzureRmMlCommitmentAssociation.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.MachineLearning.dll-Help.xml +Module Name: AzureRM.MachineLearning online version: schema: 2.0.0 --- @@ -13,7 +14,8 @@ Moves a commitment association from one commitment plan to another. ``` Move-AzureRmMlCommitmentAssociation -ResourceGroupName -CommitmentPlanName -Name - -DestinationPlanId [-WhatIf] [-Confirm] [] + -DestinationPlanId [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -47,6 +49,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DestinationPlanId The Azure resource ID of the destination Azure ML commitment plan. diff --git a/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/New-AzureRmMlCommitmentPlan.md b/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/New-AzureRmMlCommitmentPlan.md index fa7222346fca..72440b8d0fcf 100644 --- a/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/New-AzureRmMlCommitmentPlan.md +++ b/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/New-AzureRmMlCommitmentPlan.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.MachineLearning.dll-Help.xml +Module Name: AzureRM.MachineLearning online version: schema: 2.0.0 --- @@ -13,7 +14,8 @@ Creates a new commitment plan. ``` New-AzureRmMlCommitmentPlan -ResourceGroupName -Location -Name -SkuName - -SkuTier [-SkuCapacity ] [-Force] [-WhatIf] [-Confirm] [] + -SkuTier [-SkuCapacity ] [-Force] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -35,6 +37,21 @@ Creates a new Azure Machine Learning commitment plan named "MyCommitmentPlanName ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Do not ask for confirmation. diff --git a/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/New-AzureRmMlWebService.md b/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/New-AzureRmMlWebService.md index 9c6d3aac994b..38e93cbcf65e 100644 --- a/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/New-AzureRmMlWebService.md +++ b/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/New-AzureRmMlWebService.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.MachineLearning.dll-Help.xml +Module Name: AzureRM.MachineLearning online version: schema: 2.0.0 --- @@ -14,13 +15,14 @@ Creates a new web service. ### Create a new Azure ML webservice from a JSON definiton file. ``` New-AzureRmMlWebService -ResourceGroupName -Location -Name -DefinitionFile - [-Force] [-WhatIf] [-Confirm] [] + [-Force] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### Create a new Azure ML webservice from a WebService instance definition. ``` New-AzureRmMlWebService -ResourceGroupName -Location -Name - -NewWebServiceDefinition [-Force] [-WhatIf] [-Confirm] [] + -NewWebServiceDefinition [-Force] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -53,6 +55,21 @@ You can obtain a web service object instance to customize before publishing as a ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DefinitionFile Specifes the path to the file containing the JSON format definition of the web service. You can find the latest specification for the web service definition in the swagger spec under https://github.com/Azure/azure-rest-api-specs/tree/master/arm-machinelearning. @@ -194,7 +211,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### WebService - Parameter 'NewWebServiceDefinition' accepts value of type 'WebService' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Remove-AzureRmMlCommitmentPlan.md b/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Remove-AzureRmMlCommitmentPlan.md index 7e123c93c6cb..9b1e9b8fc0f0 100644 --- a/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Remove-AzureRmMlCommitmentPlan.md +++ b/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Remove-AzureRmMlCommitmentPlan.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.MachineLearning.dll-Help.xml +Module Name: AzureRM.MachineLearning online version: schema: 2.0.0 --- @@ -13,14 +14,14 @@ Deletes a commitment plan. ### Remove an Azure ML commitment plan specified by name and resource group. ``` -Remove-AzureRmMlCommitmentPlan -ResourceGroupName -Name [-Force] [-WhatIf] [-Confirm] - [] +Remove-AzureRmMlCommitmentPlan -ResourceGroupName -Name [-Force] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### Remove an Azure ML commitment plan specified as an object. ``` -Remove-AzureRmMlCommitmentPlan -MlCommitmentPlan [-Force] [-WhatIf] [-Confirm] - [] +Remove-AzureRmMlCommitmentPlan -MlCommitmentPlan [-Force] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -39,6 +40,21 @@ Remove-AzureRmMlCommitmentPlan -ResourceGroupName "MyResourceGroup" -Name "MyCom ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Do not ask for confirmation. diff --git a/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Remove-AzureRmMlWebService.md b/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Remove-AzureRmMlWebService.md index 5f55bff9e8da..3e05f9c2f434 100644 --- a/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Remove-AzureRmMlWebService.md +++ b/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Remove-AzureRmMlWebService.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.MachineLearning.dll-Help.xml +Module Name: AzureRM.MachineLearning online version: schema: 2.0.0 --- @@ -13,13 +14,14 @@ Deletes a web service. ### Remove an Azure ML web service resouce by name and resource group. ``` -Remove-AzureRmMlWebService -ResourceGroupName -Name [-Force] [-WhatIf] [-Confirm] - [] +Remove-AzureRmMlWebService -ResourceGroupName -Name [-Force] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### Remove an Azure ML web service specified as an object. ``` -Remove-AzureRmMlWebService -MlWebService [-Force] [-WhatIf] [-Confirm] [] +Remove-AzureRmMlWebService -MlWebService [-Force] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -38,6 +40,21 @@ Remove-AzureRmMlWebService -ResourceGroupName "myresourcegroup" -Name "mywebserv ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Do not ask for confirmation. @@ -135,7 +152,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### WebService - Parameter 'MlWebService' accepts value of type 'WebService' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Update-AzureRmMlCommitmentPlan.md b/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Update-AzureRmMlCommitmentPlan.md index d52998dc98ae..4f0568a65241 100644 --- a/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Update-AzureRmMlCommitmentPlan.md +++ b/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Update-AzureRmMlCommitmentPlan.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.MachineLearning.dll-Help.xml +Module Name: AzureRM.MachineLearning online version: schema: 2.0.0 --- @@ -13,7 +14,8 @@ Updates properties of an existing commitment plan resource. ``` Update-AzureRmMlCommitmentPlan -ResourceGroupName -Name -SkuName -SkuTier - [-SkuCapacity ] [-Tags ] [-Force] [-WhatIf] [-Confirm] [] + [-SkuCapacity ] [-Tags ] [-Force] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -32,6 +34,21 @@ Update-AzureRmMlCommitmentPlan -ResourceGroupName "MyResourceGroup" -Name "MyCom ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Do not ask for confirmation. diff --git a/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Update-AzureRmMlWebService.md b/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Update-AzureRmMlWebService.md index f6e253da0294..f4db10692ba4 100644 --- a/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Update-AzureRmMlWebService.md +++ b/src/ResourceManager/MachineLearning/Commands.MachineLearning/help/Update-AzureRmMlWebService.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.MachineLearning.dll-Help.xml +Module Name: AzureRM.MachineLearning online version: schema: 2.0.0 --- @@ -17,13 +18,14 @@ Update-AzureRmMlWebService -ResourceGroupName -Name [-Title ] [-StorageAccountKey ] [-Diagnostics ] [-RealtimeConfiguration ] [-Assets ] [-Input ] [-Output ] - [-Parameters ] [-Package ] [-Force] [-WhatIf] [-Confirm] [] + [-Parameters ] [-Package ] [-Force] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] ``` ### Create a new Azure ML webservice from a WebService instance definition. ``` Update-AzureRmMlWebService -ResourceGroupName -Name -ServiceUpdates [-Force] - [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -74,6 +76,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Description The new value for the web service's description. This is visible in the service's Swagger API schema. @@ -341,7 +358,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### WebService - Parameter 'ServiceUpdates' accepts value of type 'WebService' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/MarketplaceOrdering/Commands.MarketplaceOrdering/help/AzureRM.MarketplaceOrdering.md b/src/ResourceManager/MarketplaceOrdering/Commands.MarketplaceOrdering/help/AzureRM.MarketplaceOrdering.md index a57ce8311cd6..546497f3de84 100644 --- a/src/ResourceManager/MarketplaceOrdering/Commands.MarketplaceOrdering/help/AzureRM.MarketplaceOrdering.md +++ b/src/ResourceManager/MarketplaceOrdering/Commands.MarketplaceOrdering/help/AzureRM.MarketplaceOrdering.md @@ -15,5 +15,5 @@ The topics in this section document the Azure PowerShell cmdlets for Azure Marke Get the agreement terms for a given publisher id(Publisher), offer id(Product) and plan id(Name). The terms object which is returned by this command should be passed to Set-AzureRmMarketplaceTerms to accept the legal terms. ### [Set-AzureRmMarketplaceTerms](Set-AzureRmMarketplaceTerms.md) -Accept or reject the legal terms for a given publisher id(Publisher), offer id(Product) and plan id(Name). Please use Get-AzureRmMarketplaceTerms to get the agreement terms. +Accept or reject terms for a given publisher id(Publisher), offer id(Product) and plan id(Name). Please use Get-AzureRmMarketplaceTerms to get the agreement terms. diff --git a/src/ResourceManager/Media/Commands.Media/help/Get-AzureRmMediaService.md b/src/ResourceManager/Media/Commands.Media/help/Get-AzureRmMediaService.md index e4510e80f7f5..a958fd3e759d 100644 --- a/src/ResourceManager/Media/Commands.Media/help/Get-AzureRmMediaService.md +++ b/src/ResourceManager/Media/Commands.Media/help/Get-AzureRmMediaService.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Media.dll-Help.xml +Module Name: AzureRM.Media ms.assetid: 9843D191-CBC4-481A-BD36-D7B2D7917BD9 online version: schema: 2.0.0 @@ -14,12 +15,14 @@ Gets information about a media service. ### ResourceGroupParameterSet ``` -Get-AzureRmMediaService [-ResourceGroupName] [] +Get-AzureRmMediaService [-ResourceGroupName] [-DefaultProfile ] + [] ``` ### AccountNameParameterSet ``` -Get-AzureRmMediaService [-ResourceGroupName] [-AccountName] [] +Get-AzureRmMediaService [-ResourceGroupName] [-AccountName] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -58,6 +61,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of the resource group that contains the media service. diff --git a/src/ResourceManager/Media/Commands.Media/help/Get-AzureRmMediaServiceKeys.md b/src/ResourceManager/Media/Commands.Media/help/Get-AzureRmMediaServiceKeys.md index 73bf4fcf75f7..c6901438de95 100644 --- a/src/ResourceManager/Media/Commands.Media/help/Get-AzureRmMediaServiceKeys.md +++ b/src/ResourceManager/Media/Commands.Media/help/Get-AzureRmMediaServiceKeys.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Media.dll-Help.xml +Module Name: AzureRM.Media ms.assetid: 2099938F-5325-416C-AE10-6813546A1055 online version: schema: 2.0.0 @@ -13,7 +14,8 @@ Gets key information for accessing the REST endpoint associated with the media s ## SYNTAX ``` -Get-AzureRmMediaServiceKeys [-ResourceGroupName] [-AccountName] [] +Get-AzureRmMediaServiceKeys [-ResourceGroupName] [-AccountName] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -45,6 +47,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of the resource group that contains the media service. diff --git a/src/ResourceManager/Media/Commands.Media/help/Get-AzureRmMediaServiceNameAvailability.md b/src/ResourceManager/Media/Commands.Media/help/Get-AzureRmMediaServiceNameAvailability.md index ed035e32d48d..6a879171aa2d 100644 --- a/src/ResourceManager/Media/Commands.Media/help/Get-AzureRmMediaServiceNameAvailability.md +++ b/src/ResourceManager/Media/Commands.Media/help/Get-AzureRmMediaServiceNameAvailability.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Media.dll-Help.xml +Module Name: AzureRM.Media ms.assetid: 23C6C9D3-A745-46C8-AB2C-B874223FBFFF online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Media service names are globally unique. ## SYNTAX ``` -Get-AzureRmMediaServiceNameAvailability [-AccountName] [] +Get-AzureRmMediaServiceNameAvailability [-DefaultProfile ] [-AccountName] + [] ``` ## DESCRIPTION @@ -47,6 +49,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/src/ResourceManager/Media/Commands.Media/help/New-AzureRmMediaService.md b/src/ResourceManager/Media/Commands.Media/help/New-AzureRmMediaService.md index e09a967cbbb0..a9a2b99ebc01 100644 --- a/src/ResourceManager/Media/Commands.Media/help/New-AzureRmMediaService.md +++ b/src/ResourceManager/Media/Commands.Media/help/New-AzureRmMediaService.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Media.dll-Help.xml +Module Name: AzureRM.Media ms.assetid: 5CEA7323-4CF7-42B2-BA94-BB3C8F73D2E9 online version: schema: 2.0.0 @@ -15,13 +16,15 @@ Creates a media service if the media service already exists, all its properties ### StorageAccountIdParamSet ``` New-AzureRmMediaService [-ResourceGroupName] [-AccountName] [-Location] - [-StorageAccountId] [-Tags ] [-WhatIf] [-Confirm] [] + [-StorageAccountId] [-Tags ] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] ``` ### StorageAccountsParamSet ``` New-AzureRmMediaService [-ResourceGroupName] [-AccountName] [-Location] - [-StorageAccounts] [-Tags ] [-WhatIf] [-Confirm] [] + [-StorageAccounts] [-Tags ] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -114,6 +117,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Location Specifies the region that this cmdlet creates the media service in. diff --git a/src/ResourceManager/Media/Commands.Media/help/New-AzureRmMediaServiceStorageConfig.md b/src/ResourceManager/Media/Commands.Media/help/New-AzureRmMediaServiceStorageConfig.md index b20983919845..d0726c13bdbf 100644 --- a/src/ResourceManager/Media/Commands.Media/help/New-AzureRmMediaServiceStorageConfig.md +++ b/src/ResourceManager/Media/Commands.Media/help/New-AzureRmMediaServiceStorageConfig.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Media.dll-Help.xml +Module Name: AzureRM.Media ms.assetid: 4D64CA4D-1066-4D3E-9317-60D37D9DE2BB online version: schema: 2.0.0 @@ -13,8 +14,8 @@ Create a storage account configuration for the media service cmdlets. ## SYNTAX ``` -New-AzureRmMediaServiceStorageConfig [-StorageAccountId] [-IsPrimary] [-WhatIf] [-Confirm] - [] +New-AzureRmMediaServiceStorageConfig [-DefaultProfile ] [-StorageAccountId] + [-IsPrimary] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -37,6 +38,21 @@ The second command creates a storage configuration object as the primary storage ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -IsPrimary Indicates that the cmdlet creates the storage account as the primary storage for the media service. diff --git a/src/ResourceManager/Media/Commands.Media/help/Remove-AzureRmMediaService.md b/src/ResourceManager/Media/Commands.Media/help/Remove-AzureRmMediaService.md index 6e21f43e38e2..323a2c32e688 100644 --- a/src/ResourceManager/Media/Commands.Media/help/Remove-AzureRmMediaService.md +++ b/src/ResourceManager/Media/Commands.Media/help/Remove-AzureRmMediaService.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Media.dll-Help.xml +Module Name: AzureRM.Media ms.assetid: 6AB6C366-4925-4370-A33E-EDAF4BE1E230 online version: schema: 2.0.0 @@ -13,8 +14,8 @@ Removes a media service. ## SYNTAX ``` -Remove-AzureRmMediaService [-ResourceGroupName] [-AccountName] [-Force] [-WhatIf] [-Confirm] - [] +Remove-AzureRmMediaService [-ResourceGroupName] [-AccountName] [-Force] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -46,6 +47,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Forces the command to run without asking for user confirmation. diff --git a/src/ResourceManager/Media/Commands.Media/help/Set-AzureRmMediaService.md b/src/ResourceManager/Media/Commands.Media/help/Set-AzureRmMediaService.md index 2dcc200524a9..8f453b4ae3a0 100644 --- a/src/ResourceManager/Media/Commands.Media/help/Set-AzureRmMediaService.md +++ b/src/ResourceManager/Media/Commands.Media/help/Set-AzureRmMediaService.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Media.dll-Help.xml +Module Name: AzureRM.Media ms.assetid: 0FA49058-F3A7-4ED9-93F2-0C84BC130FB7 online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Modifies specified properties of an existing media service. ``` Set-AzureRmMediaService [-ResourceGroupName] [-AccountName] [-Tags ] - [-StorageAccounts ] [-WhatIf] [-Confirm] [] + [-StorageAccounts ] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -50,6 +52,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of the resource group that contains the media service. diff --git a/src/ResourceManager/Media/Commands.Media/help/Set-AzureRmMediaServiceKey.md b/src/ResourceManager/Media/Commands.Media/help/Set-AzureRmMediaServiceKey.md index 8a7392f9ad0c..db68cbb8e40e 100644 --- a/src/ResourceManager/Media/Commands.Media/help/Set-AzureRmMediaServiceKey.md +++ b/src/ResourceManager/Media/Commands.Media/help/Set-AzureRmMediaServiceKey.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Media.dll-Help.xml +Module Name: AzureRM.Media ms.assetid: D28EB28D-DBC6-48D5-AB0A-C56F56CD0104 online version: schema: 2.0.0 @@ -13,8 +14,8 @@ Regenerates a key used for accessing the REST endpoint associated with the media ## SYNTAX ``` -Set-AzureRmMediaServiceKey [-ResourceGroupName] [-AccountName] [-KeyType] [-WhatIf] - [-Confirm] [] +Set-AzureRmMediaServiceKey [-ResourceGroupName] [-AccountName] [-KeyType] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -53,6 +54,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -KeyType Specifies the key type of the media service. The acceptable values for this parameter are: Primary or Secondary. diff --git a/src/ResourceManager/Media/Commands.Media/help/Sync-AzureRmMediaServiceStorageKeys.md b/src/ResourceManager/Media/Commands.Media/help/Sync-AzureRmMediaServiceStorageKeys.md index 4a578a4e6ba6..0f74112e3081 100644 --- a/src/ResourceManager/Media/Commands.Media/help/Sync-AzureRmMediaServiceStorageKeys.md +++ b/src/ResourceManager/Media/Commands.Media/help/Sync-AzureRmMediaServiceStorageKeys.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Media.dll-Help.xml +Module Name: AzureRM.Media ms.assetid: F395E192-80FA-421D-A389-8C5C0C2267E4 online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Synchronizes storage account keys for a storage account associated with the medi ``` Sync-AzureRmMediaServiceStorageKeys [-ResourceGroupName] [-AccountName] - [-StorageAccountId] [-WhatIf] [-Confirm] [] + [-StorageAccountId] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -49,6 +51,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of the resource group that contains the media service. diff --git a/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Get-AzureRmNotificationHub.md b/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Get-AzureRmNotificationHub.md index fcfadc35f5b1..90b39c50a69c 100644 --- a/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Get-AzureRmNotificationHub.md +++ b/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Get-AzureRmNotificationHub.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.NotificationHubs.dll-Help.xml +Module Name: AzureRM.NotificationHubs ms.assetid: 796396B4-1F9D-4D53-AD2E-4CE83B563E93 online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Gets information about your notification hubs. ``` Get-AzureRmNotificationHub [-ResourceGroup] [-Namespace] [[-NotificationHub] ] - [] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -40,6 +41,21 @@ This command gets information for all the notification hubs in the namespace nam ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Namespace Specifies the namespace to which the notification hub is assigned. diff --git a/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Get-AzureRmNotificationHubAuthorizationRules.md b/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Get-AzureRmNotificationHubAuthorizationRules.md index 49e11488e5fa..52d01ebb60f8 100644 --- a/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Get-AzureRmNotificationHubAuthorizationRules.md +++ b/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Get-AzureRmNotificationHubAuthorizationRules.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.NotificationHubs.dll-Help.xml +Module Name: AzureRM.NotificationHubs ms.assetid: 7A9D8F5A-6035-411B-8FDB-96ABFEED05A2 online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Gets information about the authorization rules associated with a notification hu ``` Get-AzureRmNotificationHubAuthorizationRules [-ResourceGroup] [-Namespace] - [-NotificationHub] [[-AuthorizationRule] ] [] + [-NotificationHub] [[-AuthorizationRule] ] [-DefaultProfile ] + [] ``` ## DESCRIPTION @@ -65,6 +67,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Namespace Specifies the namespace to which the notification hub is assigned. Namespaces provide a way to group and categorize notification hubs. diff --git a/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Get-AzureRmNotificationHubListKeys.md b/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Get-AzureRmNotificationHubListKeys.md index cb5410be4dbc..35e5007766b0 100644 --- a/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Get-AzureRmNotificationHubListKeys.md +++ b/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Get-AzureRmNotificationHubListKeys.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.NotificationHubs.dll-Help.xml +Module Name: AzureRM.NotificationHubs ms.assetid: 326C87EB-EC3B-4B04-B593-EAC56FFA854A online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Gets the primary and secondary connection strings associated with a notification ``` Get-AzureRmNotificationHubListKeys [-ResourceGroup] [-Namespace] [-NotificationHub] - [-AuthorizationRule] [] + [-AuthorizationRule] [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -57,6 +58,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Namespace Specifies the namespace to which the notification hub is assigned. diff --git a/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Get-AzureRmNotificationHubPNSCredentials.md b/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Get-AzureRmNotificationHubPNSCredentials.md index dc62c3b61ccc..f6e03d6121ec 100644 --- a/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Get-AzureRmNotificationHubPNSCredentials.md +++ b/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Get-AzureRmNotificationHubPNSCredentials.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.NotificationHubs.dll-Help.xml +Module Name: AzureRM.NotificationHubs ms.assetid: 2CCDF339-9D6E-4B0C-9201-BE641C8827F6 online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Gets the PNS credentials for a notification hub. ``` Get-AzureRmNotificationHubPNSCredentials [-ResourceGroup] [-Namespace] - [-NotificationHub] [] + [-NotificationHub] [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -33,6 +34,21 @@ This command gets the PNS credentials for the notification hub named ContosoInte ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Namespace Specifies the namespace to which the notification hub is assigned. diff --git a/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Get-AzureRmNotificationHubsNamespace.md b/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Get-AzureRmNotificationHubsNamespace.md index fb6fad591010..cb3a384beebe 100644 --- a/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Get-AzureRmNotificationHubsNamespace.md +++ b/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Get-AzureRmNotificationHubsNamespace.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.NotificationHubs.dll-Help.xml +Module Name: AzureRM.NotificationHubs ms.assetid: 9805B3F1-C6BB-4A0F-A7C3-1DD1ACB75CDA online version: schema: 2.0.0 @@ -13,7 +14,8 @@ Gets information about a notification hub namespace. ## SYNTAX ``` -Get-AzureRmNotificationHubsNamespace [[-ResourceGroup] ] [[-Namespace] ] [] +Get-AzureRmNotificationHubsNamespace [[-ResourceGroup] ] [[-Namespace] ] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -53,6 +55,21 @@ This command gets information for all notification hub namespaces assigned to th ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Namespace Specifies a unique name for the namespace. diff --git a/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Get-AzureRmNotificationHubsNamespaceAuthorizationRules.md b/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Get-AzureRmNotificationHubsNamespaceAuthorizationRules.md index df8f960e5b56..90e946be76c3 100644 --- a/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Get-AzureRmNotificationHubsNamespaceAuthorizationRules.md +++ b/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Get-AzureRmNotificationHubsNamespaceAuthorizationRules.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.NotificationHubs.dll-Help.xml +Module Name: AzureRM.NotificationHubs ms.assetid: 08D03498-D18D-47FE-8916-702FA2E7D719 online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Gets information about the authorization rules associated with a notification hu ``` Get-AzureRmNotificationHubsNamespaceAuthorizationRules [-ResourceGroup] [-Namespace] - [[-AuthorizationRule] ] [] + [[-AuthorizationRule] ] [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -71,6 +72,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Namespace Specifies the namespace to which the authorization rules are assigned. Namespaces provide a way to group and categorize notification hubs. diff --git a/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Get-AzureRmNotificationHubsNamespaceListKeys.md b/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Get-AzureRmNotificationHubsNamespaceListKeys.md index 9651b3dabb54..1d1b21a935f7 100644 --- a/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Get-AzureRmNotificationHubsNamespaceListKeys.md +++ b/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Get-AzureRmNotificationHubsNamespaceListKeys.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.NotificationHubs.dll-Help.xml +Module Name: AzureRM.NotificationHubs ms.assetid: F769A8AB-E025-49EE-AEA4-0D27EAEE341F online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Gets the primary and secondary connection strings associated with a notification ``` Get-AzureRmNotificationHubsNamespaceListKeys [-ResourceGroup] [-Namespace] - [-AuthorizationRule] [] + [-AuthorizationRule] [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -51,6 +52,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Namespace Specifies the namespace containing the connection strings that this cmdlet gets. diff --git a/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/New-AzureRmNotificationHub.md b/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/New-AzureRmNotificationHub.md index 30971a66a410..68715ebd5fb4 100644 --- a/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/New-AzureRmNotificationHub.md +++ b/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/New-AzureRmNotificationHub.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.NotificationHubs.dll-Help.xml +Module Name: AzureRM.NotificationHubs ms.assetid: 8EDDA991-55B6-4151-8619-E13E14599ECD online version: schema: 2.0.0 @@ -14,14 +15,15 @@ Creates a notification hub. ### InputFileParameterSet ``` -New-AzureRmNotificationHub [-ResourceGroup] [-Namespace] [-InputFile] [-WhatIf] - [-Confirm] [] +New-AzureRmNotificationHub [-ResourceGroup] [-Namespace] [-InputFile] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### NotificationHubParameterSet ``` New-AzureRmNotificationHub [-ResourceGroup] [-Namespace] - [-NotificationHubObj] [-WhatIf] [-Confirm] [] + [-NotificationHubObj] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -50,6 +52,21 @@ You do not need to specify a name or any other configuration information for the ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InputFile Specifies the path to a JSON file containing configuration values for the new notification hub. diff --git a/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/New-AzureRmNotificationHubAuthorizationRules.md b/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/New-AzureRmNotificationHubAuthorizationRules.md index 4f7fd312e5b7..34e2fa10fdfc 100644 --- a/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/New-AzureRmNotificationHubAuthorizationRules.md +++ b/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/New-AzureRmNotificationHubAuthorizationRules.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.NotificationHubs.dll-Help.xml +Module Name: AzureRM.NotificationHubs ms.assetid: 7E9CBEE9-DD5F-4552-9187-ECBBEF6174B0 online version: schema: 2.0.0 @@ -15,14 +16,15 @@ Creates an authorization rule and assigns the rule to a notification hub. ### InputFileParameterSet ``` New-AzureRmNotificationHubAuthorizationRules [-ResourceGroup] [-Namespace] - [-NotificationHub] [-InputFile] [-WhatIf] [-Confirm] [] + [-NotificationHub] [-InputFile] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] ``` ### SASRuleParameterSet ``` New-AzureRmNotificationHubAuthorizationRules [-ResourceGroup] [-Namespace] - [-NotificationHub] [-SASRule] [-WhatIf] [-Confirm] - [] + [-NotificationHub] [-SASRule] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -46,6 +48,21 @@ Note that all the configuration information for the rule, including the rule nam ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InputFile Specifies the input file for the authorization rule that this cmdlet creates. diff --git a/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/New-AzureRmNotificationHubKey.md b/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/New-AzureRmNotificationHubKey.md index 2938851f98f6..d0a9765cd59e 100644 --- a/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/New-AzureRmNotificationHubKey.md +++ b/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/New-AzureRmNotificationHubKey.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.NotificationHubs.dll-Help.xml +Module Name: AzureRM.NotificationHubs ms.assetid: A03F32C3-BB01-46A5-86C5-B7A4DDC42351 online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Regenerate the Authorization Rule Key for a NotificationHub . ``` New-AzureRmNotificationHubKey [-ResourceGroup] [-Namespace] [-NotificationHub] - [[-AuthorizationRule] ] [-PolicyKey] [-Force] [-WhatIf] [-Confirm] [] + [[-AuthorizationRule] ] [-PolicyKey] [-Force] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -44,6 +46,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Do not ask for confirmation. diff --git a/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/New-AzureRmNotificationHubsNamespace.md b/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/New-AzureRmNotificationHubsNamespace.md index 81e02e2d3ed9..605208735b99 100644 --- a/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/New-AzureRmNotificationHubsNamespace.md +++ b/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/New-AzureRmNotificationHubsNamespace.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.NotificationHubs.dll-Help.xml +Module Name: AzureRM.NotificationHubs ms.assetid: 3BA94976-DE88-4F07-9C06-41FEEDE1B829 online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Creates a notification hub namespace. ``` New-AzureRmNotificationHubsNamespace [-ResourceGroup] [-Namespace] [-Location] - [[-Tags] ] [[-SkuTier] ] [-WhatIf] [-Confirm] [] + [[-Tags] ] [[-SkuTier] ] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -51,6 +53,21 @@ This ensures that the namespace will be displayed any time you filter for items ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Location Specifies the display name of the datacenter that will host the Namespace. Although you can set this parameter to any valid location, for optimal performance you might want to use a datacenter located near the majority of your users. diff --git a/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/New-AzureRmNotificationHubsNamespaceAuthorizationRules.md b/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/New-AzureRmNotificationHubsNamespaceAuthorizationRules.md index 858eed2feb24..c1a3f96859cc 100644 --- a/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/New-AzureRmNotificationHubsNamespaceAuthorizationRules.md +++ b/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/New-AzureRmNotificationHubsNamespaceAuthorizationRules.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.NotificationHubs.dll-Help.xml +Module Name: AzureRM.NotificationHubs ms.assetid: 3F59F7E8-CD32-40CB-9DE0-3FB044439DD0 online version: schema: 2.0.0 @@ -15,13 +16,14 @@ Creates an authorization rule and assigns that rule to a notification hub namesp ### InputFileParameterSet ``` New-AzureRmNotificationHubsNamespaceAuthorizationRules [-ResourceGroup] [-Namespace] - [-InputFile] [-WhatIf] [-Confirm] [] + [-InputFile] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### SASRuleParameterSet ``` New-AzureRmNotificationHubsNamespaceAuthorizationRules [-ResourceGroup] [-Namespace] - [-SASRule] [-WhatIf] [-Confirm] [] + [-SASRule] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -63,6 +65,21 @@ However, you do not need to specify any information about the rule itself: rule ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InputFile Specifies the path to a JSON file containing configuration information for the new authorization rule. diff --git a/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/New-AzureRmNotificationHubsNamespaceKey.md b/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/New-AzureRmNotificationHubsNamespaceKey.md index abb77faf52ca..fd9418c37879 100644 --- a/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/New-AzureRmNotificationHubsNamespaceKey.md +++ b/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/New-AzureRmNotificationHubsNamespaceKey.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.NotificationHubs.dll-Help.xml +Module Name: AzureRM.NotificationHubs ms.assetid: 1EC19069-B64C-4F0F-99A3-07C16E46C0A0 online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Regenerate the Authorization Rule Key for a Namespace. ``` New-AzureRmNotificationHubsNamespaceKey [-ResourceGroup] [-Namespace] - [[-AuthorizationRule] ] [-PolicyKey] [-Force] [-WhatIf] [-Confirm] [] + [[-AuthorizationRule] ] [-PolicyKey] [-Force] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -44,6 +46,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Do not ask for confirmation. diff --git a/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Remove-AzureRmNotificationHub.md b/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Remove-AzureRmNotificationHub.md index db573746eb5a..7627edb7865d 100644 --- a/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Remove-AzureRmNotificationHub.md +++ b/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Remove-AzureRmNotificationHub.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.NotificationHubs.dll-Help.xml +Module Name: AzureRM.NotificationHubs ms.assetid: 62631E1C-FB43-4E87-82C2-159A9D1D4221 online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Removes an existing notification hub. ``` Remove-AzureRmNotificationHub [-ResourceGroup] [-Namespace] [-NotificationHub] - [-Force] [-WhatIf] [-Confirm] [] + [-Force] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -38,6 +39,21 @@ In order to remove the hub, you must specify the namespace where the hub is loca ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Do not ask for confirmation. diff --git a/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Remove-AzureRmNotificationHubAuthorizationRules.md b/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Remove-AzureRmNotificationHubAuthorizationRules.md index cbfa446107c7..2d64699766af 100644 --- a/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Remove-AzureRmNotificationHubAuthorizationRules.md +++ b/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Remove-AzureRmNotificationHubAuthorizationRules.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.NotificationHubs.dll-Help.xml +Module Name: AzureRM.NotificationHubs ms.assetid: 715F8821-BBD1-440A-AD54-E960939E288A online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Removes an authorization rule from a notification hub. ``` Remove-AzureRmNotificationHubAuthorizationRules [-ResourceGroup] [-Namespace] - [-NotificationHub] [-AuthorizationRule] [-Force] [-WhatIf] [-Confirm] [] + [-NotificationHub] [-AuthorizationRule] [-Force] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -59,6 +61,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Do not ask for confirmation. diff --git a/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Remove-AzureRmNotificationHubsNamespace.md b/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Remove-AzureRmNotificationHubsNamespace.md index e75994fd7e26..407ca1144dff 100644 --- a/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Remove-AzureRmNotificationHubsNamespace.md +++ b/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Remove-AzureRmNotificationHubsNamespace.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.NotificationHubs.dll-Help.xml +Module Name: AzureRM.NotificationHubs ms.assetid: 5EDFBF19-928F-4F95-BD93-CF8BAEA11C52 online version: schema: 2.0.0 @@ -13,8 +14,8 @@ Removes a notification hub namespace. ## SYNTAX ``` -Remove-AzureRmNotificationHubsNamespace [-ResourceGroup] [-Namespace] [-Force] [-WhatIf] - [-Confirm] [] +Remove-AzureRmNotificationHubsNamespace [-ResourceGroup] [-Namespace] [-Force] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -36,6 +37,21 @@ You must specify the resource group the namespace is assigned to. ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Do not ask for confirmation. diff --git a/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Remove-AzureRmNotificationHubsNamespaceAuthorizationRules.md b/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Remove-AzureRmNotificationHubsNamespaceAuthorizationRules.md index 0423ede7883a..96f8dcc32e6e 100644 --- a/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Remove-AzureRmNotificationHubsNamespaceAuthorizationRules.md +++ b/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Remove-AzureRmNotificationHubsNamespaceAuthorizationRules.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.NotificationHubs.dll-Help.xml +Module Name: AzureRM.NotificationHubs ms.assetid: 860AB403-3F99-45FA-8E6A-8C9872C121E8 online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Removes an authorization rule from a notification hub namespace. ``` Remove-AzureRmNotificationHubsNamespaceAuthorizationRules [-ResourceGroup] [-Namespace] - [-AuthorizationRule] [-Force] [-WhatIf] [-Confirm] [] + [-AuthorizationRule] [-Force] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -60,6 +62,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Do not ask for confirmation. diff --git a/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Set-AzureRmNotificationHub.md b/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Set-AzureRmNotificationHub.md index 5786fe8379dd..538538418b39 100644 --- a/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Set-AzureRmNotificationHub.md +++ b/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Set-AzureRmNotificationHub.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.NotificationHubs.dll-Help.xml +Module Name: AzureRM.NotificationHubs ms.assetid: F7BBEF57-0DC2-4EFF-9AA2-119B3BD19AE6 online version: schema: 2.0.0 @@ -15,13 +16,14 @@ Sets property values for a notification hub. ### InputFileParameterSet ``` Set-AzureRmNotificationHub [-ResourceGroup] [-Namespace] [-InputFile] [-Force] - [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### NotificationHubParameterSet ``` Set-AzureRmNotificationHub [-ResourceGroup] [-Namespace] - [-NotificationHubObj] [-Force] [-WhatIf] [-Confirm] [] + [-NotificationHubObj] [-Force] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -55,6 +57,21 @@ Instead, that information is contained in the input file C:\Configuration\Hubs.j ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Do not ask for confirmation. diff --git a/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Set-AzureRmNotificationHubAuthorizationRules.md b/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Set-AzureRmNotificationHubAuthorizationRules.md index 1d48bdccafa6..1147005c5ca6 100644 --- a/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Set-AzureRmNotificationHubAuthorizationRules.md +++ b/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Set-AzureRmNotificationHubAuthorizationRules.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.NotificationHubs.dll-Help.xml +Module Name: AzureRM.NotificationHubs ms.assetid: BD311CEF-378B-463E-8998-CC3E9A5B3A7B online version: schema: 2.0.0 @@ -15,14 +16,15 @@ Sets authorization rules for a notification hub. ### InputFileParameterSet ``` Set-AzureRmNotificationHubAuthorizationRules [-ResourceGroup] [-Namespace] - [-NotificationHub] [-InputFile] [-Force] [-WhatIf] [-Confirm] [] + [-NotificationHub] [-InputFile] [-Force] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] ``` ### SASRuleParameterSet ``` Set-AzureRmNotificationHubAuthorizationRules [-ResourceGroup] [-Namespace] - [-NotificationHub] [-SASRule] [-Force] [-WhatIf] [-Confirm] - [] + [-NotificationHub] [-SASRule] [-Force] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -70,6 +72,21 @@ Instead, that information is found in the input file C:\Configuration\Authorizat ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Do not ask for confirmation. diff --git a/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Set-AzureRmNotificationHubsNamespace.md b/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Set-AzureRmNotificationHubsNamespace.md index 1aa2569d0876..8993e697128c 100644 --- a/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Set-AzureRmNotificationHubsNamespace.md +++ b/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Set-AzureRmNotificationHubsNamespace.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.NotificationHubs.dll-Help.xml +Module Name: AzureRM.NotificationHubs ms.assetid: 1B2AA717-ECD6-4CC0-AB6D-A199AF21A4A5 online version: schema: 2.0.0 @@ -15,7 +16,7 @@ Sets property values for a notification hub namespace. ``` Set-AzureRmNotificationHubsNamespace [-ResourceGroup] [-Namespace] [-Location] [[-State] ] [[-Critical] ] [[-Tags] ] [[-SkuTier] ] [-Force] - [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -68,6 +69,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Do not ask for confirmation. diff --git a/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Set-AzureRmNotificationHubsNamespaceAuthorizationRules.md b/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Set-AzureRmNotificationHubsNamespaceAuthorizationRules.md index 8f41982af038..5e9e812b225e 100644 --- a/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Set-AzureRmNotificationHubsNamespaceAuthorizationRules.md +++ b/src/ResourceManager/NotificationHubs/Commands.NotificationHubs/help/Set-AzureRmNotificationHubsNamespaceAuthorizationRules.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.NotificationHubs.dll-Help.xml +Module Name: AzureRM.NotificationHubs ms.assetid: F0981A7A-1B17-4141-A267-927E5B78BE5F online version: schema: 2.0.0 @@ -15,13 +16,15 @@ Sets authorization rules for a notification hub namespace. ### InputFileParameterSet ``` Set-AzureRmNotificationHubsNamespaceAuthorizationRules [-ResourceGroup] [-Namespace] - [-InputFile] [-Force] [-WhatIf] [-Confirm] [] + [-InputFile] [-Force] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ### SASRuleParameterSet ``` Set-AzureRmNotificationHubsNamespaceAuthorizationRules [-ResourceGroup] [-Namespace] - [-SASRule] [-Force] [-WhatIf] [-Confirm] [] + [-SASRule] [-Force] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -61,6 +64,21 @@ Instead, that information is obtained from the input file C:\Configuration\Autho ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Do not ask for confirmation. diff --git a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Disable-AzureRmOperationalInsightsIISLogCollection.md b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Disable-AzureRmOperationalInsightsIISLogCollection.md index 60e0a57121dd..014b57985e8e 100644 --- a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Disable-AzureRmOperationalInsightsIISLogCollection.md +++ b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Disable-AzureRmOperationalInsightsIISLogCollection.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml +Module Name: AzureRM.OperationalInsights ms.assetid: 95B54065-B6CC-4D10-A747-28CE3F412ABF online version: schema: 2.0.0 @@ -15,13 +16,13 @@ Stops collection of IIS logs from computers. ### ByWorkspaceName (Default) ``` Disable-AzureRmOperationalInsightsIISLogCollection [-ResourceGroupName] [-WorkspaceName] - [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### ByWorkspaceObject ``` -Disable-AzureRmOperationalInsightsIISLogCollection [-Workspace] [-WhatIf] [-Confirm] - [] +Disable-AzureRmOperationalInsightsIISLogCollection [-Workspace] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -36,6 +37,21 @@ The **Disable-AzureRmOperationalInsightsIISLogCollection** cmdlet stops collecti ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of a resource group that contains computers. @@ -118,7 +134,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### PSWorkspace - Parameter 'Workspace' accepts value of type 'PSWorkspace' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Disable-AzureRmOperationalInsightsLinuxCustomLogCollection.md b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Disable-AzureRmOperationalInsightsLinuxCustomLogCollection.md index dceaf747f897..84baf05d86cb 100644 --- a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Disable-AzureRmOperationalInsightsLinuxCustomLogCollection.md +++ b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Disable-AzureRmOperationalInsightsLinuxCustomLogCollection.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml +Module Name: AzureRM.OperationalInsights ms.assetid: EF3FE3F1-1C8F-41EB-990E-F2B30BD9D082 online version: schema: 2.0.0 @@ -15,13 +16,13 @@ Stops collection of custom logs from Linux computers. ### ByWorkspaceName (Default) ``` Disable-AzureRmOperationalInsightsLinuxCustomLogCollection [-ResourceGroupName] - [-WorkspaceName] [-WhatIf] [-Confirm] [] + [-WorkspaceName] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### ByWorkspaceObject ``` -Disable-AzureRmOperationalInsightsLinuxCustomLogCollection [-Workspace] [-WhatIf] [-Confirm] - [] +Disable-AzureRmOperationalInsightsLinuxCustomLogCollection [-Workspace] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -36,6 +37,21 @@ The **Disable-AzureRmOperationalInsightsLinuxCustomLogCollection** cmdlet stops ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of a resource group that contains Linux computers. @@ -118,7 +134,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### PSWorkspace - Parameter 'Workspace' accepts value of type 'PSWorkspace' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Disable-AzureRmOperationalInsightsLinuxPerformanceCollection.md b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Disable-AzureRmOperationalInsightsLinuxPerformanceCollection.md index dc4c0e448a81..671c25d14255 100644 --- a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Disable-AzureRmOperationalInsightsLinuxPerformanceCollection.md +++ b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Disable-AzureRmOperationalInsightsLinuxPerformanceCollection.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml +Module Name: AzureRM.OperationalInsights ms.assetid: 47AFBAC7-8818-4788-B685-7AB4DCD6C2DE online version: schema: 2.0.0 @@ -15,13 +16,13 @@ Stops collection of performance counters from Linux computers. ### ByWorkspaceName (Default) ``` Disable-AzureRmOperationalInsightsLinuxPerformanceCollection [-ResourceGroupName] - [-WorkspaceName] [-WhatIf] [-Confirm] [] + [-WorkspaceName] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### ByWorkspaceObject ``` -Disable-AzureRmOperationalInsightsLinuxPerformanceCollection [-Workspace] [-WhatIf] [-Confirm] - [] +Disable-AzureRmOperationalInsightsLinuxPerformanceCollection [-Workspace] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -36,6 +37,21 @@ The **Disable-AzureRmOperationalInsightsLinuxPerformanceCollection** cmdlet stop ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of a resource group that contains Linux computers. @@ -118,7 +134,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### PSWorkspace - Parameter 'Workspace' accepts value of type 'PSWorkspace' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Disable-AzureRmOperationalInsightsLinuxSyslogCollection.md b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Disable-AzureRmOperationalInsightsLinuxSyslogCollection.md index fec596eaef9c..283807a47a51 100644 --- a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Disable-AzureRmOperationalInsightsLinuxSyslogCollection.md +++ b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Disable-AzureRmOperationalInsightsLinuxSyslogCollection.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml +Module Name: AzureRM.OperationalInsights ms.assetid: 4A91EEDA-D8F0-4109-A32E-B83694952C06 online version: schema: 2.0.0 @@ -15,13 +16,13 @@ Stops collection of syslog data from Linux computers. ### ByWorkspaceName (Default) ``` Disable-AzureRmOperationalInsightsLinuxSyslogCollection [-ResourceGroupName] [-WorkspaceName] - [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### ByWorkspaceObject ``` -Disable-AzureRmOperationalInsightsLinuxSyslogCollection [-Workspace] [-WhatIf] [-Confirm] - [] +Disable-AzureRmOperationalInsightsLinuxSyslogCollection [-Workspace] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -36,6 +37,21 @@ The **Disable-AzureRmOperationalInsightsLinuxSyslogCollection** cmdlet stops col ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of a resource group that contains Linux computers. @@ -118,7 +134,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### PSWorkspace - Parameter 'Workspace' accepts value of type 'PSWorkspace' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Enable-AzureRmOperationalInsightsIISLogCollection.md b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Enable-AzureRmOperationalInsightsIISLogCollection.md index c1aaa9eabca7..3429a5567c22 100644 --- a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Enable-AzureRmOperationalInsightsIISLogCollection.md +++ b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Enable-AzureRmOperationalInsightsIISLogCollection.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml +Module Name: AzureRM.OperationalInsights ms.assetid: 26B1921E-6052-471B-B5B6-F2853536A425 online version: schema: 2.0.0 @@ -15,13 +16,13 @@ Starts collection of IIS logs from computers in a workspace. ### ByWorkspaceName (Default) ``` Enable-AzureRmOperationalInsightsIISLogCollection [-ResourceGroupName] [-WorkspaceName] - [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### ByWorkspaceObject ``` -Enable-AzureRmOperationalInsightsIISLogCollection [-Workspace] [-WhatIf] [-Confirm] - [] +Enable-AzureRmOperationalInsightsIISLogCollection [-Workspace] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -36,6 +37,21 @@ The **Enable-AzureRmOperationalInsightsIISLogCollection** cmdlet starts collecti ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of a resource group that contains computers. @@ -118,7 +134,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### PSWorkspace - Parameter 'Workspace' accepts value of type 'PSWorkspace' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Enable-AzureRmOperationalInsightsLinuxCustomLogCollection.md b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Enable-AzureRmOperationalInsightsLinuxCustomLogCollection.md index ccde0c5bf73c..1d80736a6fd1 100644 --- a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Enable-AzureRmOperationalInsightsLinuxCustomLogCollection.md +++ b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Enable-AzureRmOperationalInsightsLinuxCustomLogCollection.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml +Module Name: AzureRM.OperationalInsights ms.assetid: 99865242-6623-425E-92F2-0B229FC4EDAC online version: schema: 2.0.0 @@ -15,13 +16,13 @@ Starts collection of custom logs from Linux computers. ### ByWorkspaceName (Default) ``` Enable-AzureRmOperationalInsightsLinuxCustomLogCollection [-ResourceGroupName] - [-WorkspaceName] [-WhatIf] [-Confirm] [] + [-WorkspaceName] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### ByWorkspaceObject ``` -Enable-AzureRmOperationalInsightsLinuxCustomLogCollection [-Workspace] [-WhatIf] [-Confirm] - [] +Enable-AzureRmOperationalInsightsLinuxCustomLogCollection [-Workspace] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -36,6 +37,21 @@ The **Enable-AzureRmOperationalInsightsLinuxCustomLogCollection** cmdlet starts ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of a resource group that contains Linux computers. @@ -118,7 +134,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### PSWorkspace - Parameter 'Workspace' accepts value of type 'PSWorkspace' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Enable-AzureRmOperationalInsightsLinuxPerformanceCollection.md b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Enable-AzureRmOperationalInsightsLinuxPerformanceCollection.md index 0be443c777b9..3b32fa8a4d43 100644 --- a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Enable-AzureRmOperationalInsightsLinuxPerformanceCollection.md +++ b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Enable-AzureRmOperationalInsightsLinuxPerformanceCollection.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml +Module Name: AzureRM.OperationalInsights ms.assetid: 10141D75-B58D-42B0-B0A6-92FF630E534C online version: schema: 2.0.0 @@ -15,13 +16,13 @@ Starts collection of performance counters from Linux computers. ### ByWorkspaceName (Default) ``` Enable-AzureRmOperationalInsightsLinuxPerformanceCollection [-ResourceGroupName] - [-WorkspaceName] [-WhatIf] [-Confirm] [] + [-WorkspaceName] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### ByWorkspaceObject ``` -Enable-AzureRmOperationalInsightsLinuxPerformanceCollection [-Workspace] [-WhatIf] [-Confirm] - [] +Enable-AzureRmOperationalInsightsLinuxPerformanceCollection [-Workspace] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -36,6 +37,21 @@ The **Enable-AzureRmOperationalInsightsLinuxPerformanceCollection** cmdlet start ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of a resource group that contains Linux computers. @@ -118,7 +134,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### PSWorkspace - Parameter 'Workspace' accepts value of type 'PSWorkspace' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Enable-AzureRmOperationalInsightsLinuxSyslogCollection.md b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Enable-AzureRmOperationalInsightsLinuxSyslogCollection.md index 35a25518c4c1..d163048e63a3 100644 --- a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Enable-AzureRmOperationalInsightsLinuxSyslogCollection.md +++ b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Enable-AzureRmOperationalInsightsLinuxSyslogCollection.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml +Module Name: AzureRM.OperationalInsights ms.assetid: 66DD5919-B6B7-4FE5-B45B-937013549882 online version: schema: 2.0.0 @@ -15,13 +16,13 @@ Starts collection of syslog data from Linux computers. ### ByWorkspaceName (Default) ``` Enable-AzureRmOperationalInsightsLinuxSyslogCollection [-ResourceGroupName] [-WorkspaceName] - [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### ByWorkspaceObject ``` -Enable-AzureRmOperationalInsightsLinuxSyslogCollection [-Workspace] [-WhatIf] [-Confirm] - [] +Enable-AzureRmOperationalInsightsLinuxSyslogCollection [-Workspace] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -36,6 +37,21 @@ The **Enable-AzureRmOperationalInsightsLinuxSyslogCollection** cmdlet starts col ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of a resource group that contains Linux computers. @@ -118,7 +134,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### PSWorkspace - Parameter 'Workspace' accepts value of type 'PSWorkspace' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsDataSource.md b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsDataSource.md index 6a637f4bbc48..2fe7bb957e62 100644 --- a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsDataSource.md +++ b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsDataSource.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml +Module Name: AzureRM.OperationalInsights ms.assetid: 1F094EBA-E4AE-4B3E-BA20-858818C6FD12 online version: schema: 2.0.0 @@ -14,29 +15,31 @@ Get datasources under Azure Log Analytics workspace. ### ByWorkspaceName (Default) ``` -Get-AzureRmOperationalInsightsDataSource [] +Get-AzureRmOperationalInsightsDataSource [-DefaultProfile ] [] ``` ### ByWorkspaceObjectByName ``` -Get-AzureRmOperationalInsightsDataSource [-Workspace] [[-Name] ] [] +Get-AzureRmOperationalInsightsDataSource [-Workspace] [[-Name] ] + [-DefaultProfile ] [] ``` ### ByWorkspaceObjectByKind ``` -Get-AzureRmOperationalInsightsDataSource [[-Workspace] ] [[-Kind] ] [] +Get-AzureRmOperationalInsightsDataSource [[-Workspace] ] [[-Kind] ] + [-DefaultProfile ] [] ``` ### ByWorkspaceNameByName ``` Get-AzureRmOperationalInsightsDataSource [-ResourceGroupName] [-WorkspaceName] - [-Name] [] + [-Name] [-DefaultProfile ] [] ``` ### ByWorkspaceNameByKind ``` Get-AzureRmOperationalInsightsDataSource [[-ResourceGroupName] ] [[-WorkspaceName] ] - [-Kind] [] + [-Kind] [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -53,6 +56,21 @@ You can filter the results based on the kind of data source. ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Kind Specifies the kind of data sources to get. The acceptable values for this parameter are: @@ -204,11 +222,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### PSWorkspace - Parameter 'Workspace' accepts value of type 'PSWorkspace' from the pipeline ### PSWorkspace - Parameter 'Workspace' accepts value of type 'PSWorkspace' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsIntelligencePacks.md b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsIntelligencePacks.md index f99a6f362a92..e547c1b8650a 100644 --- a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsIntelligencePacks.md +++ b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsIntelligencePacks.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml +Module Name: AzureRM.OperationalInsights ms.assetid: 0F9D72C1-2E42-4A67-9FDE-6344F5DE6C30 online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Gets the available Intelligence Packs. ``` Get-AzureRmOperationalInsightsIntelligencePacks [-ResourceGroupName] [-WorkspaceName] - [] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -31,6 +32,21 @@ This command gets the available Intelligence Packs. ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of an Azure resource group that contains a workspace. diff --git a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsLinkTargets.md b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsLinkTargets.md index 11a6aa15749a..d81c5db0cd02 100644 --- a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsLinkTargets.md +++ b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsLinkTargets.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml +Module Name: AzureRM.OperationalInsights ms.assetid: 35C6E85B-E5E1-44E8-86E8-F18E197F69DC online version: schema: 2.0.0 @@ -13,7 +14,7 @@ Gets accounts that are not associated with a subscription. ## SYNTAX ``` -Get-AzureRmOperationalInsightsLinkTargets [] +Get-AzureRmOperationalInsightsLinkTargets [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -31,6 +32,21 @@ This command gets unlinked accounts that are owned by the caller's ID. ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsSavedSearch.md b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsSavedSearch.md index acfa2ed1bcc6..45f162f69603 100644 --- a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsSavedSearch.md +++ b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsSavedSearch.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml +Module Name: AzureRM.OperationalInsights ms.assetid: FB2C47AD-E103-409E-A23B-BC316FA32E8C online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Returns all of the saved searches for a specified workspace. ``` Get-AzureRmOperationalInsightsSavedSearch [-ResourceGroupName] [-WorkspaceName] - [[-SavedSearchId] ] [] + [[-SavedSearchId] ] [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -39,6 +40,21 @@ This command gets a specific saved search by its ID. ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of an Azure resource group that contains a workspace. diff --git a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsSavedSearchResults.md b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsSavedSearchResults.md index 2772e9d46afd..745696a172cb 100644 --- a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsSavedSearchResults.md +++ b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsSavedSearchResults.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml +Module Name: AzureRM.OperationalInsights ms.assetid: AA3EF369-C724-4D32-A56E-503CBE191320 online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Returns the results from a query. ``` Get-AzureRmOperationalInsightsSavedSearchResults [-ResourceGroupName] [-WorkspaceName] - [-SavedSearchId] [] + [-SavedSearchId] [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -31,6 +32,21 @@ This command gets all of the search results for a saved search. ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of an Azure resource group that contains a workspace. diff --git a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsSchema.md b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsSchema.md index 75c5ef67df2a..69d95aa7cc73 100644 --- a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsSchema.md +++ b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsSchema.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml +Module Name: AzureRM.OperationalInsights ms.assetid: 6A834F26-C3D1-46DA-A4A6-1BB5B69291D0 online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Returns the schema associated with a workspace. ``` Get-AzureRmOperationalInsightsSchema [-ResourceGroupName] [-WorkspaceName] - [] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -31,6 +32,21 @@ This command gets the schemas associated with a workspace. ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of an Azure resource group that contains a workspace. diff --git a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsSearchResults.md b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsSearchResults.md index 9b903922e2be..b617ef746183 100644 --- a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsSearchResults.md +++ b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsSearchResults.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml +Module Name: AzureRM.OperationalInsights ms.assetid: 438F549D-1AF6-49FE-83AC-B45BAB701AB6 online version: schema: 2.0.0 @@ -15,7 +16,8 @@ Returns search results based on the specified parameters. ``` Get-AzureRmOperationalInsightsSearchResults [-ResourceGroupName] [-WorkspaceName] [[-Top] ] [[-PreHighlight] ] [[-PostHighlight] ] [[-Query] ] - [[-Start] ] [[-End] ] [[-Id] ] [] + [[-Start] ] [[-End] ] [[-Id] ] [-DefaultProfile ] + [] ``` ## DESCRIPTION @@ -78,6 +80,21 @@ This script starts a search and waits until it completes before displaying the r ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -End End of the queried time range. diff --git a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsStorageInsight.md b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsStorageInsight.md index 6c11882f2914..11a00216fea2 100644 --- a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsStorageInsight.md +++ b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsStorageInsight.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml +Module Name: AzureRM.OperationalInsights ms.assetid: 29ABCC1B-8590-4243-A629-709F207927B4 online version: schema: 2.0.0 @@ -15,12 +16,13 @@ Gets information about a Storage Insight. ### ByWorkspaceName (Default) ``` Get-AzureRmOperationalInsightsStorageInsight [-ResourceGroupName] [-WorkspaceName] - [[-Name] ] [] + [[-Name] ] [-DefaultProfile ] [] ``` ### ByWorkspaceObject ``` -Get-AzureRmOperationalInsightsStorageInsight [-Workspace] [[-Name] ] [] +Get-AzureRmOperationalInsightsStorageInsight [-Workspace] [[-Name] ] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -49,6 +51,21 @@ The second command gets the storage insight named MyStorageInsight for the works ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Specifies the Storage Insight name. @@ -115,7 +132,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### PSWorkspace - Parameter 'Workspace' accepts value of type 'PSWorkspace' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsWorkspace.md b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsWorkspace.md index b851a824a3dd..7c7617c88f5e 100644 --- a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsWorkspace.md +++ b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsWorkspace.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml +Module Name: AzureRM.OperationalInsights ms.assetid: F94415DA-1A4A-4D37-A626-1EDF5D1EFE74 online version: schema: 2.0.0 @@ -13,7 +14,8 @@ Gets information about a workspace. ## SYNTAX ``` -Get-AzureRmOperationalInsightsWorkspace [[-ResourceGroupName] ] [[-Name] ] [] +Get-AzureRmOperationalInsightsWorkspace [[-ResourceGroupName] ] [[-Name] ] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -33,6 +35,21 @@ This command gets a workspace named MyWorkspace in the resource group named Cont ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Specifies the workspace name. diff --git a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsWorkspaceManagementGroups.md b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsWorkspaceManagementGroups.md index b7849f14037b..51cb997f24b9 100644 --- a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsWorkspaceManagementGroups.md +++ b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsWorkspaceManagementGroups.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml +Module Name: AzureRM.OperationalInsights ms.assetid: F29E0B9C-2479-44FB-B196-EAF97B69E6A6 online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Gets details of management groups connected to a workspace. ``` Get-AzureRmOperationalInsightsWorkspaceManagementGroups [-ResourceGroupName] [-Name] - [] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -38,6 +39,21 @@ This command uses the Get-AzureRmOperationalInsightsWorkspace cmdlet to get the ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Specifies the workspace name. diff --git a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsWorkspaceSharedKeys.md b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsWorkspaceSharedKeys.md index 18f1bf5a95cc..550341352fc6 100644 --- a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsWorkspaceSharedKeys.md +++ b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsWorkspaceSharedKeys.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml +Module Name: AzureRM.OperationalInsights ms.assetid: 112D5C69-3F4F-4BB6-9DA4-52757146B0EF online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Gets the shared keys for a workspace. ``` Get-AzureRmOperationalInsightsWorkspaceSharedKeys [-ResourceGroupName] [-Name] - [] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -40,6 +41,21 @@ The command gets the shared keys for that workspace. ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Specifies the workspace name. diff --git a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsWorkspaceUsage.md b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsWorkspaceUsage.md index 16bff65d5d1f..e7c9d7699a44 100644 --- a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsWorkspaceUsage.md +++ b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Get-AzureRmOperationalInsightsWorkspaceUsage.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml +Module Name: AzureRM.OperationalInsights ms.assetid: 818A048F-7CBE-4845-BBC2-6420CE48199A online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Gets the usage data for a workspace. ``` Get-AzureRmOperationalInsightsWorkspaceUsage [-ResourceGroupName] [-Name] - [] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -40,6 +41,21 @@ The command gets the usage details for that workspace. ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Specifies the workspace name. diff --git a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsAzureActivityLogDataSource.md b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsAzureActivityLogDataSource.md index a861c5e61305..3b448c4149f3 100644 --- a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsAzureActivityLogDataSource.md +++ b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsAzureActivityLogDataSource.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml +Module Name: AzureRM.OperationalInsights ms.assetid: B4EC9132-8DB9-498D-8B3F-2AB51D8EA03A online version: schema: 2.0.0 @@ -16,14 +17,14 @@ Collect Azure Activity log from given subscription. ``` New-AzureRmOperationalInsightsAzureActivityLogDataSource [-ResourceGroupName] [-WorkspaceName] [-Name] [-SubscriptionId] [-BackfillStartTime ] - [-Force] [-WhatIf] [-Confirm] [] + [-Force] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### ByWorkspaceObject ``` New-AzureRmOperationalInsightsAzureActivityLogDataSource [-Workspace] [-Name] - [-SubscriptionId] [-BackfillStartTime ] [-Force] [-WhatIf] [-Confirm] - [] + [-SubscriptionId] [-BackfillStartTime ] [-Force] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -55,6 +56,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force ```yaml Type: SwitchParameter @@ -167,7 +183,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### PSWorkspace - Parameter 'Workspace' accepts value of type 'PSWorkspace' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsComputerGroup.md b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsComputerGroup.md index 74676600814c..04c702d62b6f 100644 --- a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsComputerGroup.md +++ b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsComputerGroup.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml +Module Name: AzureRM.OperationalInsights ms.assetid: E68E90B3-0B6A-49E9-83CD-E73826571B04 online version: schema: 2.0.0 @@ -15,7 +16,7 @@ Creates a computer group. ``` New-AzureRmOperationalInsightsComputerGroup [-ResourceGroupName] [-WorkspaceName] [-SavedSearchId] [-DisplayName] [-Category] [-Query] [[-Version] ] - [-Force] [-WhatIf] [-Confirm] [] + [-Force] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -45,6 +46,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DisplayName Specifies the display name of the computer group. diff --git a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsCustomLogDataSource.md b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsCustomLogDataSource.md index 5d0168954b76..8c9587826e51 100644 --- a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsCustomLogDataSource.md +++ b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsCustomLogDataSource.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml +Module Name: AzureRM.OperationalInsights ms.assetid: 6A08AF7C-1E18-40A1-B21E-12F94823D304 online version: schema: 2.0.0 @@ -15,13 +16,15 @@ Defines a custom log collection policy. ### ByWorkspaceName (Default) ``` New-AzureRmOperationalInsightsCustomLogDataSource [-ResourceGroupName] [-WorkspaceName] - [-Name] [-CustomLogRawJson] [-Force] [-WhatIf] [-Confirm] [] + [-Name] [-CustomLogRawJson] [-Force] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] ``` ### ByWorkspaceObject ``` New-AzureRmOperationalInsightsCustomLogDataSource [-Workspace] [-Name] - [-CustomLogRawJson] [-Force] [-WhatIf] [-Confirm] [] + [-CustomLogRawJson] [-Force] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -51,6 +54,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Forces the command to run without asking for user confirmation. @@ -163,7 +181,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### PSWorkspace - Parameter 'Workspace' accepts value of type 'PSWorkspace' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsLinuxPerformanceObjectDataSource.md b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsLinuxPerformanceObjectDataSource.md index aae47abd8bdb..3ef5afdb4cca 100644 --- a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsLinuxPerformanceObjectDataSource.md +++ b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsLinuxPerformanceObjectDataSource.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml +Module Name: AzureRM.OperationalInsights ms.assetid: F94F3FA8-08FD-4B25-B634-8E2EEBDDE36E online version: schema: 2.0.0 @@ -16,14 +17,15 @@ Adds performance counters to all Linux computers in a workspace. ``` New-AzureRmOperationalInsightsLinuxPerformanceObjectDataSource [-ResourceGroupName] [-WorkspaceName] [-Name] [-ObjectName] [-CounterNames] - [-InstanceName ] [-IntervalSeconds ] [-Force] [-WhatIf] [-Confirm] [] + [-InstanceName ] [-IntervalSeconds ] [-Force] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] ``` ### ByWorkspaceObject ``` New-AzureRmOperationalInsightsLinuxPerformanceObjectDataSource [-Workspace] [-Name] [-ObjectName] [-CounterNames] [-InstanceName ] [-IntervalSeconds ] [-Force] - [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -53,6 +55,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Forces the command to run without asking for user confirmation. @@ -210,7 +227,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### PSWorkspace - Parameter 'Workspace' accepts value of type 'PSWorkspace' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsLinuxSyslogDataSource.md b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsLinuxSyslogDataSource.md index eb2370ba4ce0..4b929a2269d6 100644 --- a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsLinuxSyslogDataSource.md +++ b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsLinuxSyslogDataSource.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml +Module Name: AzureRM.OperationalInsights ms.assetid: D6CBDF09-E243-425B-8677-256163A6DFBF online version: schema: 2.0.0 @@ -16,15 +17,16 @@ Adds a data source to Linux computers. ``` New-AzureRmOperationalInsightsLinuxSyslogDataSource [-ResourceGroupName] [-WorkspaceName] [-Name] [-Facility] [-CollectEmergency] [-CollectAlert] [-CollectCritical] [-CollectError] - [-CollectWarning] [-CollectNotice] [-CollectDebug] [-CollectInformational] [-Force] [-WhatIf] [-Confirm] - [] + [-CollectWarning] [-CollectNotice] [-CollectDebug] [-CollectInformational] [-Force] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### ByWorkspaceObject ``` New-AzureRmOperationalInsightsLinuxSyslogDataSource [-Workspace] [-Name] [-Facility] [-CollectEmergency] [-CollectAlert] [-CollectCritical] [-CollectError] [-CollectWarning] - [-CollectNotice] [-CollectDebug] [-CollectInformational] [-Force] [-WhatIf] [-Confirm] [] + [-CollectNotice] [-CollectDebug] [-CollectInformational] [-Force] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -160,6 +162,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Facility Specifies a facility code. @@ -287,7 +304,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### PSWorkspace - Parameter 'Workspace' accepts value of type 'PSWorkspace' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsSavedSearch.md b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsSavedSearch.md index 806537f4d617..9d6c451bcbc3 100644 --- a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsSavedSearch.md +++ b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsSavedSearch.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml +Module Name: AzureRM.OperationalInsights ms.assetid: DFEB9EA3-574A-463B-8B70-46D76ABCA84D online version: schema: 2.0.0 @@ -15,7 +16,8 @@ Creates a new saved search with the specified parameters. ``` New-AzureRmOperationalInsightsSavedSearch [-ResourceGroupName] [-WorkspaceName] [-SavedSearchId] [-DisplayName] [-Category] [-Query] [[-Tags] ] - [[-Version] ] [-Force] [-WhatIf] [-Confirm] [] + [[-Version] ] [-Force] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -47,6 +49,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DisplayName Specifies the saved search display name. diff --git a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsStorageInsight.md b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsStorageInsight.md index f426a8223df0..4f40b8561c1c 100644 --- a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsStorageInsight.md +++ b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsStorageInsight.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml +Module Name: AzureRM.OperationalInsights ms.assetid: 7660F1A2-604D-4488-93F1-CB7C502F135E online version: schema: 2.0.0 @@ -16,14 +17,16 @@ Creates a Storage Insight inside a workspace. ``` New-AzureRmOperationalInsightsStorageInsight [-ResourceGroupName] [-WorkspaceName] [-Name] [-StorageAccountResourceId] [-StorageAccountKey] [[-Tables] ] - [[-Containers] ] [-Force] [-WhatIf] [-Confirm] [] + [[-Containers] ] [-Force] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ### ByWorkspaceObject ``` New-AzureRmOperationalInsightsStorageInsight [-Workspace] [-Name] [-StorageAccountResourceId] [-StorageAccountKey] [[-Tables] ] - [[-Containers] ] [-Force] [-WhatIf] [-Confirm] [] + [[-Containers] ] [-Force] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -84,6 +87,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Forces the command to run without asking for user confirmation. @@ -242,7 +260,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### PSWorkspace - Parameter 'Workspace' accepts value of type 'PSWorkspace' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsWindowsEventDataSource.md b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsWindowsEventDataSource.md index 96a6d6edce94..62ff48be7923 100644 --- a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsWindowsEventDataSource.md +++ b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsWindowsEventDataSource.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml +Module Name: AzureRM.OperationalInsights ms.assetid: 36B3B1AC-6E7F-4607-A024-91583D952B62 online version: schema: 2.0.0 @@ -16,14 +17,14 @@ Collects event logs from computers that run the Windows operating system. ``` New-AzureRmOperationalInsightsWindowsEventDataSource [-ResourceGroupName] [-WorkspaceName] [-Name] [-EventLogName] [-CollectErrors] [-CollectWarnings] [-CollectInformation] [-Force] - [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### ByWorkspaceObject ``` New-AzureRmOperationalInsightsWindowsEventDataSource [-Workspace] [-Name] - [-EventLogName] [-CollectErrors] [-CollectWarnings] [-CollectInformation] [-Force] [-WhatIf] - [-Confirm] [] + [-EventLogName] [-CollectErrors] [-CollectWarnings] [-CollectInformation] [-Force] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -83,6 +84,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -EventLogName Specifies the name of the event log. @@ -210,7 +226,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### PSWorkspace - Parameter 'Workspace' accepts value of type 'PSWorkspace' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsWindowsPerformanceCounterDataSource.md b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsWindowsPerformanceCounterDataSource.md index 2e5db8c9d6a5..5b95fe646bea 100644 --- a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsWindowsPerformanceCounterDataSource.md +++ b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsWindowsPerformanceCounterDataSource.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml +Module Name: AzureRM.OperationalInsights ms.assetid: 09CC097E-0210-4443-BCDB-5CF6C8300288 online version: schema: 2.0.0 @@ -16,15 +17,16 @@ Adds Windows performance counter data source for connected computers that run th ``` New-AzureRmOperationalInsightsWindowsPerformanceCounterDataSource [-ResourceGroupName] [-WorkspaceName] [-Name] [-ObjectName] [-CounterName] - [-InstanceName ] [-IntervalSeconds ] [-UseLegacyCollector] [-Force] [-WhatIf] [-Confirm] - [] + [-InstanceName ] [-IntervalSeconds ] [-UseLegacyCollector] [-Force] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### ByWorkspaceObject ``` New-AzureRmOperationalInsightsWindowsPerformanceCounterDataSource [-Workspace] [-Name] [-ObjectName] [-CounterName] [-InstanceName ] [-IntervalSeconds ] - [-UseLegacyCollector] [-Force] [-WhatIf] [-Confirm] [] + [-UseLegacyCollector] [-Force] [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -54,6 +56,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Forces the command to run without asking for user confirmation. @@ -226,7 +243,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### PSWorkspace - Parameter 'Workspace' accepts value of type 'PSWorkspace' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsWorkspace.md b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsWorkspace.md index d15ac7d72477..4c4389ea9614 100644 --- a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsWorkspace.md +++ b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/New-AzureRmOperationalInsightsWorkspace.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml +Module Name: AzureRM.OperationalInsights ms.assetid: 4682807D-34E8-4057-8894-36820447067B online version: schema: 2.0.0 @@ -14,8 +15,8 @@ Creates a workspace. ``` New-AzureRmOperationalInsightsWorkspace [-ResourceGroupName] [-Name] [-Location] - [[-Sku] ] [[-CustomerId] ] [[-Tags] ] [-Force] [-WhatIf] [-Confirm] - [] + [[-Sku] ] [[-CustomerId] ] [[-Tags] ] [[-RetentionInDays] ] [-Force] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -60,6 +61,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Forces the command to run without asking for user confirmation. @@ -121,6 +137,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -RetentionInDays +The workspace data retention in days. 730 days is the maximum allowed for all other Skus + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + ### -Sku Specifies the service tier of the workspace. Valid values are: @@ -133,7 +164,7 @@ Valid values are: Type: String Parameter Sets: (All) Aliases: -Accepted values: free, standard, premium +Accepted values: free, standard, premium, pernode, standalone Required: False Position: 3 diff --git a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Remove-AzureRmOperationalInsightsDataSource.md b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Remove-AzureRmOperationalInsightsDataSource.md index 4e8f9573c313..d779713c2bf3 100644 --- a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Remove-AzureRmOperationalInsightsDataSource.md +++ b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Remove-AzureRmOperationalInsightsDataSource.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml +Module Name: AzureRM.OperationalInsights ms.assetid: 5C1C51FE-747F-4176-84ED-A28AA3475581 online version: schema: 2.0.0 @@ -15,13 +16,13 @@ Deletes a data source. ### ByWorkspaceName (Default) ``` Remove-AzureRmOperationalInsightsDataSource [-ResourceGroupName] [-WorkspaceName] - [-Name] [-Force] [-WhatIf] [-Confirm] [] + [-Name] [-Force] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### ByWorkspaceObject ``` -Remove-AzureRmOperationalInsightsDataSource [-Workspace] [-Name] [-Force] [-WhatIf] - [-Confirm] [] +Remove-AzureRmOperationalInsightsDataSource [-Workspace] [-Name] [-Force] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -36,6 +37,21 @@ The **Remove-AzureRmOperationalInsightsDataSource** cmdlet deletes a data source ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Forces the command to run without asking for user confirmation. @@ -148,7 +164,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### PSWorkspace - Parameter 'Workspace' accepts value of type 'PSWorkspace' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Remove-AzureRmOperationalInsightsSavedSearch.md b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Remove-AzureRmOperationalInsightsSavedSearch.md index bae447efa51b..c05f5febe467 100644 --- a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Remove-AzureRmOperationalInsightsSavedSearch.md +++ b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Remove-AzureRmOperationalInsightsSavedSearch.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml +Module Name: AzureRM.OperationalInsights ms.assetid: D4A40E83-2969-40A2-AED0-A6073142CAF1 online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Removes a saved search from the workspace. ``` Remove-AzureRmOperationalInsightsSavedSearch [-ResourceGroupName] [-WorkspaceName] - [-SavedSearchId] [-WhatIf] [-Confirm] [] + [-SavedSearchId] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -31,6 +32,21 @@ This command removes a saved search from the workspace. ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the workspace name. diff --git a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Remove-AzureRmOperationalInsightsStorageInsight.md b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Remove-AzureRmOperationalInsightsStorageInsight.md index b87bdb51b987..dfe94edaa1c4 100644 --- a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Remove-AzureRmOperationalInsightsStorageInsight.md +++ b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Remove-AzureRmOperationalInsightsStorageInsight.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml +Module Name: AzureRM.OperationalInsights ms.assetid: 92261663-CF50-4EBD-85D2-C2E254F39B41 online version: schema: 2.0.0 @@ -15,13 +16,13 @@ Removes a Storage Insight. ### ByWorkspaceName (Default) ``` Remove-AzureRmOperationalInsightsStorageInsight [-ResourceGroupName] [-WorkspaceName] - [-Name] [-Force] [-WhatIf] [-Confirm] [] + [-Name] [-Force] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### ByWorkspaceObject ``` -Remove-AzureRmOperationalInsightsStorageInsight [-Workspace] [-Name] [-Force] [-WhatIf] - [-Confirm] [] +Remove-AzureRmOperationalInsightsStorageInsight [-Workspace] [-Name] [-Force] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -48,6 +49,21 @@ The first command uses the Get-AzureRmOperationalInsightsWorkspace cmdlet to get ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Forces the command to run without asking for user confirmation. @@ -160,7 +176,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### PSWorkspace - Parameter 'Workspace' accepts value of type 'PSWorkspace' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Remove-AzureRmOperationalInsightsWorkspace.md b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Remove-AzureRmOperationalInsightsWorkspace.md index d9fbe38f9724..6a57f64724de 100644 --- a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Remove-AzureRmOperationalInsightsWorkspace.md +++ b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Remove-AzureRmOperationalInsightsWorkspace.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml +Module Name: AzureRM.OperationalInsights ms.assetid: 0C35E679-B991-49A8-890F-C8DAB68A8240 online version: schema: 2.0.0 @@ -13,8 +14,8 @@ Removes a workspace. ## SYNTAX ``` -Remove-AzureRmOperationalInsightsWorkspace [-ResourceGroupName] [-Name] [-Force] [-WhatIf] - [-Confirm] [] +Remove-AzureRmOperationalInsightsWorkspace [-ResourceGroupName] [-Name] [-Force] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -40,6 +41,21 @@ Since the *Force* parameter is specified, the command does not prompt you before ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force Forces the command to run without asking for user confirmation. diff --git a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Set-AzureRmOperationalInsightsDataSource.md b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Set-AzureRmOperationalInsightsDataSource.md index 773bffd38bad..b25ab1c998fc 100644 --- a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Set-AzureRmOperationalInsightsDataSource.md +++ b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Set-AzureRmOperationalInsightsDataSource.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml +Module Name: AzureRM.OperationalInsights ms.assetid: 3992E6B5-F794-4C7A-BB59-C8D60E2CD7BC online version: schema: 2.0.0 @@ -13,7 +14,8 @@ Updates a data source. ## SYNTAX ``` -Set-AzureRmOperationalInsightsDataSource [-DataSource] [] +Set-AzureRmOperationalInsightsDataSource [-DataSource] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -43,13 +45,27 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### PSDataSource - Parameter 'DataSource' accepts value of type 'PSDataSource' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Set-AzureRmOperationalInsightsIntelligencePack.md b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Set-AzureRmOperationalInsightsIntelligencePack.md index b480ea86d8aa..a4b6cab4f1f6 100644 --- a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Set-AzureRmOperationalInsightsIntelligencePack.md +++ b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Set-AzureRmOperationalInsightsIntelligencePack.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml +Module Name: AzureRM.OperationalInsights ms.assetid: 23ED4D24-66BD-46E9-BB57-6E0DA679B733 online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Enables or disables the specified Intelligence Pack. ``` Set-AzureRmOperationalInsightsIntelligencePack [-ResourceGroupName] [-WorkspaceName] - [-IntelligencePackName] [-Enabled] [] + [-IntelligencePackName] [-Enabled] [-DefaultProfile ] + [] ``` ## DESCRIPTION @@ -31,6 +33,21 @@ This command enables the specified Intelligence Pack. ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Enabled ```yaml Type: Boolean diff --git a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Set-AzureRmOperationalInsightsSavedSearch.md b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Set-AzureRmOperationalInsightsSavedSearch.md index e0966b5e0b0d..73573c0f7ebe 100644 --- a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Set-AzureRmOperationalInsightsSavedSearch.md +++ b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Set-AzureRmOperationalInsightsSavedSearch.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml +Module Name: AzureRM.OperationalInsights ms.assetid: A333A60D-CA76-4E4E-9C8B-72AAEF464F0A online version: schema: 2.0.0 @@ -15,7 +16,7 @@ Updates a saved search that already exists. ``` Set-AzureRmOperationalInsightsSavedSearch [-ResourceGroupName] [-WorkspaceName] [-SavedSearchId] [-DisplayName] [-Category] [-Query] [[-Tags] ] - [[-Version] ] [[-ETag] ] [] + [[-Version] ] [[-ETag] ] [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -47,6 +48,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DisplayName Specifies the display name. diff --git a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Set-AzureRmOperationalInsightsStorageInsight.md b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Set-AzureRmOperationalInsightsStorageInsight.md index 88a9f7573da8..43b87c08a650 100644 --- a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Set-AzureRmOperationalInsightsStorageInsight.md +++ b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Set-AzureRmOperationalInsightsStorageInsight.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml +Module Name: AzureRM.OperationalInsights ms.assetid: 010328F9-C878-4F16-AFD7-2135465A1968 online version: schema: 2.0.0 @@ -16,13 +17,14 @@ Updates a Storage Insight. ``` Set-AzureRmOperationalInsightsStorageInsight [-ResourceGroupName] [-WorkspaceName] [-Name] [[-StorageAccountKey] ] [[-Tables] ] [[-Containers] ] - [] + [-DefaultProfile ] [] ``` ### ByWorkspaceObject ``` Set-AzureRmOperationalInsightsStorageInsight [-Workspace] [-Name] - [[-StorageAccountKey] ] [[-Tables] ] [[-Containers] ] [] + [[-StorageAccountKey] ] [[-Tables] ] [[-Containers] ] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -65,6 +67,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Specifies the name of a Storage Insight. @@ -161,7 +178,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### PSWorkspace - Parameter 'Workspace' accepts value of type 'PSWorkspace' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Set-AzureRmOperationalInsightsWorkspace.md b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Set-AzureRmOperationalInsightsWorkspace.md index 0e3710de78e3..9a6263369b8c 100644 --- a/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Set-AzureRmOperationalInsightsWorkspace.md +++ b/src/ResourceManager/OperationalInsights/Commands.OperationalInsights/help/Set-AzureRmOperationalInsightsWorkspace.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.OperationalInsights.dll-Help.xml +Module Name: AzureRM.OperationalInsights ms.assetid: 54DFBB63-AE8C-4918-870F-19FAD6CC5E4A online version: schema: 2.0.0 @@ -15,13 +16,14 @@ Updates a workspace. ### ByName (Default) ``` Set-AzureRmOperationalInsightsWorkspace [-ResourceGroupName] [-Name] [[-Sku] ] - [[-Tags] ] [] + [[-Tags] ] [-RetentionInDays ] [-DefaultProfile ] + [] ``` ### ByObject ``` Set-AzureRmOperationalInsightsWorkspace [-Workspace] [[-Sku] ] [[-Tags] ] - [] + [-RetentionInDays ] [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -45,6 +47,21 @@ This command uses the Get-AzureRmOperationalInsightsWorkspace cmdlet to get the ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name Specifies the workspace name. @@ -75,6 +92,21 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -RetentionInDays +The workspace data retention in days. 730 days is the maximum allowed for all other Skus + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + ### -Sku Specifies the service tier of the workspace. Valid values are: @@ -87,7 +119,7 @@ Valid values are: Type: String Parameter Sets: (All) Aliases: -Accepted values: free, standard, premium +Accepted values: free, standard, premium, pernode, standalone Required: False Position: 3 @@ -132,7 +164,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### PSWorkspace - Parameter 'Workspace' accepts value of type 'PSWorkspace' from the pipeline ## OUTPUTS diff --git a/src/ResourceManager/PowerBIEmbedded/Commands.Management.PowerBIEmbedded/help/Get-AzureRmPowerBIWorkspace.md b/src/ResourceManager/PowerBIEmbedded/Commands.Management.PowerBIEmbedded/help/Get-AzureRmPowerBIWorkspace.md index cc1ef5183221..70eb63e999f2 100644 --- a/src/ResourceManager/PowerBIEmbedded/Commands.Management.PowerBIEmbedded/help/Get-AzureRmPowerBIWorkspace.md +++ b/src/ResourceManager/PowerBIEmbedded/Commands.Management.PowerBIEmbedded/help/Get-AzureRmPowerBIWorkspace.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Management.PowerBIEmbedded.dll-Help.xml +Module Name: AzureRM.PowerBIEmbedded ms.assetid: 5321FC62-3585-4493-A3D2-22CD82503CA7 online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Gets the workspaces in a Power BI workspace collection. ``` Get-AzureRmPowerBIWorkspace [-ResourceGroupName] [-WorkspaceCollectionName] - [] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -31,6 +32,21 @@ This command gets the workspaces that belong to the workspace collection named W ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of the resource group to which the workspace collection belongs. diff --git a/src/ResourceManager/PowerBIEmbedded/Commands.Management.PowerBIEmbedded/help/Get-AzureRmPowerBIWorkspaceCollection.md b/src/ResourceManager/PowerBIEmbedded/Commands.Management.PowerBIEmbedded/help/Get-AzureRmPowerBIWorkspaceCollection.md index 7dc73a34a4e1..ac7b0b5e0813 100644 --- a/src/ResourceManager/PowerBIEmbedded/Commands.Management.PowerBIEmbedded/help/Get-AzureRmPowerBIWorkspaceCollection.md +++ b/src/ResourceManager/PowerBIEmbedded/Commands.Management.PowerBIEmbedded/help/Get-AzureRmPowerBIWorkspaceCollection.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Management.PowerBIEmbedded.dll-Help.xml +Module Name: AzureRM.PowerBIEmbedded ms.assetid: EEF32F48-00F6-4C57-B4F1-B58B566EAFEF online version: schema: 2.0.0 @@ -14,13 +15,14 @@ Gets Power BI workspace collections. ### ResourceGroupParameterSet ``` -Get-AzureRmPowerBIWorkspaceCollection [[-ResourceGroupName] ] [] +Get-AzureRmPowerBIWorkspaceCollection [[-ResourceGroupName] ] + [-DefaultProfile ] [] ``` ### WorkspaceCollectionNameParameterSet ``` Get-AzureRmPowerBIWorkspaceCollection [-ResourceGroupName] [-WorkspaceCollectionName] - [] + [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -44,6 +46,21 @@ This command gets the workspace collection named WCN11 in the specified resource ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of the resource group from which this cmdlet gets workspace collections. diff --git a/src/ResourceManager/PowerBIEmbedded/Commands.Management.PowerBIEmbedded/help/Get-AzureRmPowerBIWorkspaceCollectionAccessKeys.md b/src/ResourceManager/PowerBIEmbedded/Commands.Management.PowerBIEmbedded/help/Get-AzureRmPowerBIWorkspaceCollectionAccessKeys.md index acd3b53f587f..021a460ee937 100644 --- a/src/ResourceManager/PowerBIEmbedded/Commands.Management.PowerBIEmbedded/help/Get-AzureRmPowerBIWorkspaceCollectionAccessKeys.md +++ b/src/ResourceManager/PowerBIEmbedded/Commands.Management.PowerBIEmbedded/help/Get-AzureRmPowerBIWorkspaceCollectionAccessKeys.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Management.PowerBIEmbedded.dll-Help.xml +Module Name: AzureRM.PowerBIEmbedded ms.assetid: 3FED0088-47DA-4565-B9F0-DACF9B2DC0C7 online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Gets the current access keys associated with a Power BI workspace collection. ``` Get-AzureRmPowerBIWorkspaceCollectionAccessKeys [-ResourceGroupName] - [-WorkspaceCollectionName] [] + [-WorkspaceCollectionName] [-DefaultProfile ] [] ``` ## DESCRIPTION @@ -31,6 +32,21 @@ This command gets access keys for the workspace collection named WCN11 in the sp ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of the resource group of the collection. diff --git a/src/ResourceManager/PowerBIEmbedded/Commands.Management.PowerBIEmbedded/help/New-AzureRmPowerBIWorkspaceCollection.md b/src/ResourceManager/PowerBIEmbedded/Commands.Management.PowerBIEmbedded/help/New-AzureRmPowerBIWorkspaceCollection.md index fa564a65f9ea..6129721fcbf0 100644 --- a/src/ResourceManager/PowerBIEmbedded/Commands.Management.PowerBIEmbedded/help/New-AzureRmPowerBIWorkspaceCollection.md +++ b/src/ResourceManager/PowerBIEmbedded/Commands.Management.PowerBIEmbedded/help/New-AzureRmPowerBIWorkspaceCollection.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Management.PowerBIEmbedded.dll-Help.xml +Module Name: AzureRM.PowerBIEmbedded ms.assetid: 9F9E4273-6747-4963-AF1F-C0AEB46770A4 online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Creates a Power BI workspace collection. ``` New-AzureRmPowerBIWorkspaceCollection [-ResourceGroupName] [-WorkspaceCollectionName] - [-Location] [-WhatIf] [-Confirm] [] + [-Location] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -31,6 +32,21 @@ This command creates a workspace collection named WCN11 in the specified resourc ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Location Specifies the Azure location in which this cmdlet creates a workspace collection. diff --git a/src/ResourceManager/PowerBIEmbedded/Commands.Management.PowerBIEmbedded/help/Remove-AzureRmPowerBIWorkspaceCollection.md b/src/ResourceManager/PowerBIEmbedded/Commands.Management.PowerBIEmbedded/help/Remove-AzureRmPowerBIWorkspaceCollection.md index d8ece3cb418e..d63b837df5dd 100644 --- a/src/ResourceManager/PowerBIEmbedded/Commands.Management.PowerBIEmbedded/help/Remove-AzureRmPowerBIWorkspaceCollection.md +++ b/src/ResourceManager/PowerBIEmbedded/Commands.Management.PowerBIEmbedded/help/Remove-AzureRmPowerBIWorkspaceCollection.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Management.PowerBIEmbedded.dll-Help.xml +Module Name: AzureRM.PowerBIEmbedded ms.assetid: 2D63CC6D-AB02-4299-A922-4057D6F595D7 online version: schema: 2.0.0 @@ -14,7 +15,7 @@ Removes a Power BI workspace collection. ``` Remove-AzureRmPowerBIWorkspaceCollection [-ResourceGroupName] [-WorkspaceCollectionName] - [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -31,6 +32,21 @@ This command removes the workspace collection named WCN11 in the specified resou ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ResourceGroupName Specifies the name of the resource group from which this cmdlet removes a workspace collection. diff --git a/src/ResourceManager/PowerBIEmbedded/Commands.Management.PowerBIEmbedded/help/Reset-AzureRmPowerBIWorkspaceCollectionAccessKeys.md b/src/ResourceManager/PowerBIEmbedded/Commands.Management.PowerBIEmbedded/help/Reset-AzureRmPowerBIWorkspaceCollectionAccessKeys.md index dd87b5b1c90d..e17afe8639c3 100644 --- a/src/ResourceManager/PowerBIEmbedded/Commands.Management.PowerBIEmbedded/help/Reset-AzureRmPowerBIWorkspaceCollectionAccessKeys.md +++ b/src/ResourceManager/PowerBIEmbedded/Commands.Management.PowerBIEmbedded/help/Reset-AzureRmPowerBIWorkspaceCollectionAccessKeys.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Management.PowerBIEmbedded.dll-Help.xml +Module Name: AzureRM.PowerBIEmbedded ms.assetid: 8FB2D9A0-BF7A-482D-B3A2-566FCA8C62A1 online version: schema: 2.0.0 @@ -14,7 +15,8 @@ Resets the specified access key. ``` Reset-AzureRmPowerBIWorkspaceCollectionAccessKeys [-ResourceGroupName] - [-WorkspaceCollectionName] [-Key1] [-Key2] [-WhatIf] [-Confirm] [] + [-WorkspaceCollectionName] [-Key1] [-Key2] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] ``` ## DESCRIPTION @@ -31,6 +33,21 @@ This command resets the primary access key for the workspace collection named WC ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Key1 Indicates that this cmdlet resets the primary access key. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Add-AzureRmSqlServerKeyVaultKey.md b/src/ResourceManager/Sql/Commands.Sql/help/Add-AzureRmSqlServerKeyVaultKey.md index 88a0e9f3506f..301ba49b682f 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Add-AzureRmSqlServerKeyVaultKey.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Add-AzureRmSqlServerKeyVaultKey.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql online version: schema: 2.0.0 --- @@ -13,7 +14,7 @@ Adds a Key Vault key to a SQL server. ``` Add-AzureRmSqlServerKeyVaultKey [-KeyId] [-ServerName] [-ResourceGroupName] - [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -39,6 +40,21 @@ CreationDate : 1/1/2017 12:00:00 AM ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -KeyId The Azure Key Vault KeyId. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerKeyVaultKey.md b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerKeyVaultKey.md index 338782c0fd0e..1d911f51d362 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerKeyVaultKey.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Get-AzureRmSqlServerKeyVaultKey.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql online version: schema: 2.0.0 --- @@ -13,7 +14,7 @@ Gets a SQL server's Key Vault keys. ``` Get-AzureRmSqlServerKeyVaultKey [[-KeyId] ] [-ServerName] [-ResourceGroupName] - [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -55,6 +56,21 @@ You can inspect the properties of $MyServerKeyVaultKey to get details about the ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -KeyId The Azure Key Vault KeyId. diff --git a/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServerKeyVaultKey.md b/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServerKeyVaultKey.md index f91ef36528b4..5669cf7167dd 100644 --- a/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServerKeyVaultKey.md +++ b/src/ResourceManager/Sql/Commands.Sql/help/Remove-AzureRmSqlServerKeyVaultKey.md @@ -1,5 +1,6 @@ --- external help file: Microsoft.Azure.Commands.Sql.dll-Help.xml +Module Name: AzureRM.Sql online version: schema: 2.0.0 --- @@ -13,7 +14,7 @@ Removes a Key Vault key from a SQL server. ``` Remove-AzureRmSqlServerKeyVaultKey [-KeyId] [-ServerName] [-ResourceGroupName] - [-WhatIf] [-Confirm] [] + [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -44,6 +45,21 @@ CreationDate : 1/1/2017 12:00:00 AM ## PARAMETERS +### -DefaultProfile +The credentials, account, tenant, and subscription used for communication with azure + +```yaml +Type: IAzureContextContainer +Parameter Sets: (All) +Aliases: AzureRmContext, AzureCredential + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -KeyId The Azure Key Vault KeyId.