Microsoft.Azure.Commands.Management.PowerBIEmbedded.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems xmlns="http://msh" schema="maml"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-AzureRmPowerBIWorkspace</command:name> <command:verb>Get</command:verb> <command:noun>AzureRmPowerBIWorkspace</command:noun> <maml:description><maml:para>Gets the workspaces in a Power BI workspace collection. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Get-AzureRmPowerBIWorkspace cmdlet gets the workspaces in a Power BI workspace collection. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-AzureRmPowerBIWorkspace</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group to which the workspace collection belongs. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="Name, ResourceName"><maml:name>WorkspaceCollectionName</maml:name> <maml:Description><maml:para>Specifies the name of the workspace collection for which this cmdlet gets workspaces. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group to which the workspace collection belongs. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="Name, ResourceName"><maml:name>WorkspaceCollectionName</maml:name> <maml:Description><maml:para>Specifies the name of the workspace collection for which this cmdlet gets workspaces. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.Management.PowerBIEmbedded.Models.PSWorkspace</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Get workspaces of a workspace collection</maml:title> <dev:code>PS C:\>Get-AzureRmPowerBIWorkspace -ResourceGroupName "ResourceGroup17" -WorkspaceCollectionName "WCN11"</dev:code> <dev:remarks><maml:para>This command gets the workspaces that belong to the workspace collection named WCN11 in the specified resource group. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.powerbiembedded/get-azurermpowerbiworkspace</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmPowerBIWorkspaceCollection</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-AzureRmPowerBIWorkspaceCollection</command:name> <command:verb>Get</command:verb> <command:noun>AzureRmPowerBIWorkspaceCollection</command:noun> <maml:description><maml:para>Gets Power BI workspace collections. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Get-AzureRmPowerBIWorkspaceCollection cmdlet gets Power BI workspace collections in your Azure subscription and resource group, or by collection name. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-AzureRmPowerBIWorkspaceCollection</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group from which this cmdlet gets workspace collections. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>Get-AzureRmPowerBIWorkspaceCollection</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group from which this cmdlet gets workspace collections. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="Name, ResourceName"><maml:name>WorkspaceCollectionName</maml:name> <maml:Description><maml:para>Specifies the name of the Power BI workspace collection that this cmdlet gets. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group from which this cmdlet gets workspace collections. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="Name, ResourceName"><maml:name>WorkspaceCollectionName</maml:name> <maml:Description><maml:para>Specifies the name of the Power BI workspace collection that this cmdlet gets. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.Management.PowerBIEmbedded.Models.PSWorkspaceCollection</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Get all workspace collections in a resource group</maml:title> <dev:code>PS C:\>Get-AzureRmPowerBIWorkspaceCollection -ResourceGroupName "ResourceGroup17"</dev:code> <dev:remarks><maml:para>This command gets the workspace collections that belong to the resource group named ResourceGroup17. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 2: Get a workspace collection by using its name</maml:title> <dev:code>PS C:\>Get-AzureRmPowerBIWorkspaceCollection -ResourceGroupName "ResourceGroup17" -WorkspaceCollectionName "WCN11"</dev:code> <dev:remarks><maml:para>This command gets the workspace collection named WCN11 in the specified resource group. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.powerbiembedded/get-azurermpowerbiworkspacecollection</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmPowerBIWorkspaceCollection</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRmPowerBIWorkspaceCollection</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-AzureRmPowerBIWorkspaceCollectionAccessKeys</command:name> <command:verb>Get</command:verb> <command:noun>AzureRmPowerBIWorkspaceCollectionAccessKeys</command:noun> <maml:description><maml:para>Gets the current access keys associated with a Power BI workspace collection. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Get-AzureRmPowerBIWorkspaceCollectionAccessKeys cmdlet gets the current access keys associated with a Power BI workspace collection. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-AzureRmPowerBIWorkspaceCollectionAccessKeys</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group of the collection. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="Name, ResourceName"><maml:name>WorkspaceCollectionName</maml:name> <maml:Description><maml:para>Specifies the name of the Power BI workspace collection on which this cmdlet operates. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group of the collection. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="Name, ResourceName"><maml:name>WorkspaceCollectionName</maml:name> <maml:Description><maml:para>Specifies the name of the Power BI workspace collection on which this cmdlet operates. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.Management.PowerBIEmbedded.Models.PSWorkspaceCollectionAccessKey</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Get access keys</maml:title> <dev:code>PS C:\>Get-AzureRmPowerBIWorkspaceCollectionAccessKeys -ResourceGroupName "ResourceGroup17" -WorkspaceCollectionName "WCN11"</dev:code> <dev:remarks><maml:para>This command gets access keys for the workspace collection named WCN11 in the specified resource group. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.powerbiembedded/get-azurermpowerbiworkspacecollectionaccesskeys</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Reset-AzureRmPowerBIWorkspaceCollectionAccessKeys</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>New-AzureRmPowerBIWorkspaceCollection</command:name> <command:verb>New</command:verb> <command:noun>AzureRmPowerBIWorkspaceCollection</command:noun> <maml:description><maml:para>Creates a Power BI workspace collection. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The New-AzureRmPowerBIWorkspaceCollection cmdlet creates a Power BI workspace collection for your Azure subscription in the specified resource group and location. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>New-AzureRmPowerBIWorkspaceCollection</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group in which this cmdlet creates a workspace collection. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="Name, ResourceName"><maml:name>WorkspaceCollectionName</maml:name> <maml:Description><maml:para>Specifies a name for the Power BI workspace collection. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"><maml:name>Location</maml:name> <maml:Description><maml:para>Specifies the Azure location in which this cmdlet creates a workspace collection. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"><maml:name>Location</maml:name> <maml:Description><maml:para>Specifies the Azure location in which this cmdlet creates a workspace collection. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group in which this cmdlet creates a workspace collection. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="Name, ResourceName"><maml:name>WorkspaceCollectionName</maml:name> <maml:Description><maml:para>Specifies a name for the Power BI workspace collection. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.Management.PowerBIEmbedded.Models.PSWorkspaceCollection</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Create a workspace collection</maml:title> <dev:code>PS C:\>New-AzureRmPowerBIWorkspaceCollection -ResourceGroupName "ResourceGroup17" -WorkspaceCollectionName "WCN11" -Location "Japan West"</dev:code> <dev:remarks><maml:para>This command creates a workspace collection named WCN11 in the specified resource group in the specified location. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.powerbiembedded/new-azurermpowerbiworkspacecollection</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmPowerBIWorkspaceCollection</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRmPowerBIWorkspaceCollection</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Remove-AzureRmPowerBIWorkspaceCollection</command:name> <command:verb>Remove</command:verb> <command:noun>AzureRmPowerBIWorkspaceCollection</command:noun> <maml:description><maml:para>Removes a Power BI workspace collection. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Remove-AzureRmPowerBIWorkspaceCollection cmdlet removes a Power BI workspace collection from your Azure subscription and resource group. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Remove-AzureRmPowerBIWorkspaceCollection</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group from which this cmdlet removes a workspace collection. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="Name, ResourceName"><maml:name>WorkspaceCollectionName</maml:name> <maml:Description><maml:para>Specifies the name of the Power BI workspace collection that this cmdlet removes. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group from which this cmdlet removes a workspace collection. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="Name, ResourceName"><maml:name>WorkspaceCollectionName</maml:name> <maml:Description><maml:para>Specifies the name of the Power BI workspace collection that this cmdlet removes. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues></command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Remove a workspace collection</maml:title> <dev:code>PS C:\>Remove-AzureRmPowerBIWorkspaceCollection -ResourceGroupName "ResourceGroup17" -WorkspaceCollectionName "WCN11"</dev:code> <dev:remarks><maml:para>This command removes the workspace collection named WCN11 in the specified resource group. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.powerbiembedded/remove-azurermpowerbiworkspacecollection</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmPowerBIWorkspaceCollection</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmPowerBIWorkspaceCollection</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Reset-AzureRmPowerBIWorkspaceCollectionAccessKeys</command:name> <command:verb>Reset</command:verb> <command:noun>AzureRmPowerBIWorkspaceCollectionAccessKeys</command:noun> <maml:description><maml:para>Resets the specified access key. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Reset-AzureRmPowerBIWorkspaceCollectionAccessKeys cmdlet resets the specified access key in your Power BI workspace collection. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Reset-AzureRmPowerBIWorkspaceCollectionAccessKeys</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group of the collection. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="Name, ResourceName"><maml:name>WorkspaceCollectionName</maml:name> <maml:Description><maml:para>Specifies the name of the Power BI workspace collection on which this cmdlet operates. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Key1</maml:name> <maml:Description><maml:para>Indicates that this cmdlet resets the primary access key. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Key2</maml:name> <maml:Description><maml:para>Indicates that this cmdlet resets the secondary access key. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Key1</maml:name> <maml:Description><maml:para>Indicates that this cmdlet resets the primary access key. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Key2</maml:name> <maml:Description><maml:para>Indicates that this cmdlet resets the secondary access key. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group of the collection. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="Name, ResourceName"><maml:name>WorkspaceCollectionName</maml:name> <maml:Description><maml:para>Specifies the name of the Power BI workspace collection on which this cmdlet operates. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.Management.PowerBIEmbedded.Models.PSWorkspaceCollectionAccessKey</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Reset the primary access key</maml:title> <dev:code>PS C:\>Reset-AzureRmPowerBIWorkspaceCollectionAccessKeys -ResourceGroupName "ResourceGroup17" -WorkspaceCollectionName "WCN11" -Key1</dev:code> <dev:remarks><maml:para>This command resets the primary access key for the workspace collection named WCN11 in the specified resource group. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.powerbiembedded/reset-azurermpowerbiworkspacecollectionaccesskeys</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmPowerBIWorkspaceCollectionAccessKeys</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |