Skip to content

Commit 25369e2

Browse files
author
VSC
committed
Sync docs from source code repo to content repo.
1 parent b2b4371 commit 25369e2

File tree

1,953 files changed

+355273
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,953 files changed

+355273
-0
lines changed

‎latest_release_of_ResourceManager/AzureRM.AnalysisServices/Add-AzureAnalysisServicesAccount.md

Lines changed: 224 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,224 @@
1+
---
2+
external help file: Microsoft.Azure.Commands.AnalysisServices.Dataplane.dll-Help.xml
3+
Module Name: Azure.AnalysisServices
4+
online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.analysisservices/add-azureanalysisservicesaccount
5+
schema: 2.0.0
6+
content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AnalysisServices/Commands.AnalysisServices.Dataplane/help/Add-AzureAnalysisServicesAccount.md
7+
original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AnalysisServices/Commands.AnalysisServices.Dataplane/help/Add-AzureAnalysisServicesAccount.md
8+
---
9+
10+
# Add-AzureAnalysisServicesAccount
11+
12+
## SYNOPSIS
13+
Adds an authenticated account to use for Azure Analysis Services server cmdlet requests.
14+
15+
## SYNTAX
16+
17+
### UserParameterSetName (Default)
18+
```
19+
Add-AzureAnalysisServicesAccount [[-RolloutEnvironment] <String>] [[-Credential] <PSCredential>] [-WhatIf]
20+
[-Confirm] [<CommonParameters>]
21+
```
22+
23+
### ServicePrincipalWithPasswordParameterSetName
24+
```
25+
Add-AzureAnalysisServicesAccount [-RolloutEnvironment] <String> [-Credential] <PSCredential>
26+
[-ServicePrincipal] -TenantId <String> [-WhatIf] [-Confirm] [<CommonParameters>]
27+
```
28+
29+
### ServicePrincipalWithCertificateParameterSetName
30+
```
31+
Add-AzureAnalysisServicesAccount [-RolloutEnvironment] <String> [-ServicePrincipal] -TenantId <String>
32+
-ApplicationId <String> -CertificateThumbprint <String> [-WhatIf] [-Confirm] [<CommonParameters>]
33+
```
34+
35+
## DESCRIPTION
36+
The Add-AzureAnalysisServicesAccount cmdlet is used to login to an instance of Azure Analysis Services server
37+
38+
## EXAMPLES
39+
40+
### Example 1
41+
```
42+
PS C:\>Add-AzureAnalysisServicesAccount
43+
RolloutEnvironment: westcentralus.asazure.windows.net
44+
Credential: $UserCredential
45+
```
46+
47+
This example will add the account specified by the $UserCredential variable to the westcentralus.asazure.windows.net Analysis Services environment.
48+
49+
### Example 2
50+
```
51+
PS C:\>$ApplicationCredential = Get-Credential
52+
PS C:\>Add-AzureAnalysisServicesAccount -RolloutEnvironment 'westcentralus.asazure.windows.net' -ServicePrincipal -Credential $ApplicationCredential -TenantId "xxxx-xxxx-xxxx-xxxx"
53+
```
54+
55+
The first command gets the application service principal credentials, and then stores them in the $ApplicationCredential variable.
56+
The second command add the application service principal account specified by the $ApplicationCredential variable and TenantId to the westcentralus.asazure.windows.net Analysis Services environment.
57+
58+
### Example 3
59+
```
60+
PS C:\>Add-AzureAnalysisServicesAccount -RolloutEnvironment 'westcentralus.asazure.windows.net' -ServicePrincipal -ApplicationId "yyyy-yyyy-yyyy-yyyy" -CertificateThumbprint 'zzzzzzzzzzzzzzzz' -TenantId "xxxx-xxxx-xxxx-xxxx"
61+
```
62+
63+
This example will add the application service principal account specified by the ApplicationId, TenantId and CertificateThumbprint to the westcentralus.asazure.windows.net Analysis Services environment.
64+
65+
## PARAMETERS
66+
67+
### -ApplicationId
68+
The application ID.
69+
70+
```yaml
71+
Type: System.String
72+
Parameter Sets: ServicePrincipalWithCertificateParameterSetName
73+
Aliases:
74+
75+
Required: True
76+
Position: Named
77+
Default value: None
78+
Accept pipeline input: False
79+
Accept wildcard characters: False
80+
```
81+
82+
### -CertificateThumbprint
83+
Certificate Hash (Thumbprint)
84+
85+
```yaml
86+
Type: System.String
87+
Parameter Sets: ServicePrincipalWithCertificateParameterSetName
88+
Aliases:
89+
90+
Required: True
91+
Position: Named
92+
Default value: None
93+
Accept pipeline input: False
94+
Accept wildcard characters: False
95+
```
96+
97+
### -Credential
98+
Login credentials
99+
100+
```yaml
101+
Type: System.Management.Automation.PSCredential
102+
Parameter Sets: UserParameterSetName
103+
Aliases:
104+
105+
Required: False
106+
Position: 1
107+
Default value: None
108+
Accept pipeline input: False
109+
Accept wildcard characters: False
110+
```
111+
112+
```yaml
113+
Type: System.Management.Automation.PSCredential
114+
Parameter Sets: ServicePrincipalWithPasswordParameterSetName
115+
Aliases:
116+
117+
Required: True
118+
Position: 1
119+
Default value: None
120+
Accept pipeline input: False
121+
Accept wildcard characters: False
122+
```
123+
124+
### -RolloutEnvironment
125+
Name of the Azure Analysis Services environment to which to logon to. Given the full name of the server for example asazure://westcentralus.asazure.windows.net/testserver , the correct value for this variable will be westcentralus.asazure.windows.net
126+
127+
```yaml
128+
Type: System.String
129+
Parameter Sets: UserParameterSetName
130+
Aliases:
131+
132+
Required: False
133+
Position: 0
134+
Default value: None
135+
Accept pipeline input: False
136+
Accept wildcard characters: False
137+
```
138+
139+
```yaml
140+
Type: System.String
141+
Parameter Sets: ServicePrincipalWithPasswordParameterSetName, ServicePrincipalWithCertificateParameterSetName
142+
Aliases:
143+
144+
Required: True
145+
Position: 0
146+
Default value: None
147+
Accept pipeline input: False
148+
Accept wildcard characters: False
149+
```
150+
151+
### -ServicePrincipal
152+
Indicates that this account authenticates by providing service principal credentials.
153+
154+
```yaml
155+
Type: System.Management.Automation.SwitchParameter
156+
Parameter Sets: ServicePrincipalWithPasswordParameterSetName, ServicePrincipalWithCertificateParameterSetName
157+
Aliases:
158+
159+
Required: True
160+
Position: Named
161+
Default value: None
162+
Accept pipeline input: False
163+
Accept wildcard characters: False
164+
```
165+
166+
### -TenantId
167+
Tenant name or ID
168+
169+
```yaml
170+
Type: System.String
171+
Parameter Sets: ServicePrincipalWithPasswordParameterSetName, ServicePrincipalWithCertificateParameterSetName
172+
Aliases:
173+
174+
Required: True
175+
Position: Named
176+
Default value: None
177+
Accept pipeline input: False
178+
Accept wildcard characters: False
179+
```
180+
181+
### -Confirm
182+
Prompts you for confirmation before running the cmdlet.
183+
184+
```yaml
185+
Type: System.Management.Automation.SwitchParameter
186+
Parameter Sets: (All)
187+
Aliases: cf
188+
189+
Required: False
190+
Position: Named
191+
Default value: None
192+
Accept pipeline input: False
193+
Accept wildcard characters: False
194+
```
195+
196+
### -WhatIf
197+
Shows what would happen if the cmdlet runs.
198+
The cmdlet is not run.
199+
200+
```yaml
201+
Type: System.Management.Automation.SwitchParameter
202+
Parameter Sets: (All)
203+
Aliases: wi
204+
205+
Required: False
206+
Position: Named
207+
Default value: None
208+
Accept pipeline input: False
209+
Accept wildcard characters: False
210+
```
211+
212+
### CommonParameters
213+
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).
214+
215+
## INPUTS
216+
217+
## OUTPUTS
218+
219+
### Microsoft.Azure.Commands.AnalysisServices.Dataplane.AsAzureProfile
220+
221+
## NOTES
222+
Alias: Login-AzureAsAccount
223+
224+
## RELATED LINKS

‎latest_release_of_ResourceManager/AzureRM.AnalysisServices/Azure.AnalysisServices.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
Module Name: Azure.AnalysisServices
3+
Module Guid: c717b5a4-1f1b-4a2f-8aa1-bfd09934626e
4+
Download Help Link: {{Please enter FwLink manually}}
5+
Help Version: {{Please enter version of help manually (X.X.X.X) format}}
6+
Locale: en-US
7+
---
8+
9+
# Azure.AnalysisServices Module
10+
## Description
11+
This module contains commands for performing operations on a given Azure Analysis Services environment
12+
13+
## Azure.AnalysisServices Cmdlets
14+
### [Add-AzureAnalysisServicesAccount](Add-AzureAnalysisServicesAccount.md)
15+
Adds an authenticated account to use for Azure Analysis Services server cmdlet requests.
16+
17+
### [Restart-AzureAnalysisServicesInstance](Restart-AzureAnalysisServicesInstance.md)
18+
Restarts a specified Azure Analysis Services server.
19+

‎latest_release_of_ResourceManager/AzureRM.AnalysisServices/AzureRM.AnalysisServices.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
Module Name: AzureRM.AnalysisServices
3+
Module Guid: acace26c-1775-4100-85c0-20c4d71eaa21
4+
Download Help Link: None_Azure
5+
Help Version: 0.0.1.0
6+
Locale: en-US
7+
---
8+
9+
# AzureRM.AnalysisServices Module
10+
## Description
11+
This topic displays help topics for the Azure AnalysisServices cmdlets.
12+
13+
## AzureRM.AnalysisServices Cmdlets
14+
### [Get-AzureRmAnalysisServicesServer](Get-AzureRmAnalysisServicesServer.md)
15+
Gets the details of an Analysis Services server.
16+
17+
### [New-AzureRmAnalysisServicesServer](New-AzureRmAnalysisServicesServer.md)
18+
Creates a new Analysis Services server
19+
20+
### [Remove-AzureRmAnalysisServicesServer](Remove-AzureRmAnalysisServicesServer.md)
21+
Deletes an instance of Analysis Services server
22+
23+
### [Resume-AzureRmAnalysisServicesServer](Resume-AzureRmAnalysisServicesServer.md)
24+
Resumes an instance of Analysis Services server
25+
26+
### [Set-AzureRmAnalysisServicesServer](Set-AzureRmAnalysisServicesServer.md)
27+
Modifies an instance of Analysis Services server
28+
29+
### [Suspend-AzureRmAnalysisServicesServer](Suspend-AzureRmAnalysisServicesServer.md)
30+
Suspends an instance of Analysis Services server
31+
32+
### [Test-AzureRmAnalysisServicesServer](Test-AzureRmAnalysisServicesServer.md)
33+
Tests the existence of an instance of Analysis Services server
34+

‎latest_release_of_ResourceManager/AzureRM.AnalysisServices/Export-AzureAnalysisServicesInstanceLog.md

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
---
2+
external help file: Microsoft.Azure.Commands.AnalysisServices.Dataplane.dll-Help.xml
3+
online version: https://docs.microsoft.com/en-us/powershell/module/azurerm.analysisservices/export-azureanalysisservicesinstancelog
4+
schema: 2.0.0
5+
---
6+
7+
# Export-AzureAnalysisServicesInstance
8+
9+
## SYNOPSIS
10+
Exports a log from an instance of Analysis Services server in the currently logged in Environment as specified in Add-AzureAnalysisServicesAccount command
11+
12+
## SYNTAX
13+
14+
```
15+
Export-AzureAnalysisServicesInstanceLog [-Instance] <String> [-OutputPath] <String> [-WhatIf] [-Force]
16+
```
17+
18+
## DESCRIPTION
19+
The Export-AzureAnalysisServicesInstance cmdlet exports log from an instance of Azure Analysis Services server to file
20+
21+
## EXAMPLES
22+
23+
### Example 1
24+
```
25+
PS C:\>Export-AzureAnalysisServicesInstanceLog -Instance testserver -OuptutPath C:\path\to\log\testserver.log
26+
```
27+
28+
This command will export log from the server 'testserver' in the environment specified in the Add-AzureAnalysisServicesAccount command
29+
and save it to file specified in OutputPath 'C:\path\to\log\testserver.log'
30+
31+
## PARAMETERS
32+
33+
### -Instance
34+
Name of the Analysis Services server instance
35+
36+
```yaml
37+
Type: String
38+
Parameter Sets: (All)
39+
Aliases:
40+
41+
Required: True
42+
Position: 0
43+
Default value: None
44+
Accept pipeline input: False
45+
Accept wildcard characters: False
46+
```
47+
48+
### -OutputPath
49+
Output path to file to export log
50+
51+
```yaml
52+
Type: String
53+
Parameter Sets: (All)
54+
Aliases:
55+
56+
Required: True
57+
Position: 0
58+
Default value: None
59+
Accept pipeline input: False
60+
Accept wildcard characters: False
61+
```
62+
63+
### -Force
64+
Overwrite file if exists without asking
65+
66+
```yaml
67+
Type: SwitchParameter
68+
Parameter Sets: (All)
69+
Aliases:
70+
71+
Required: False
72+
Position: Named
73+
Default value: None
74+
Accept pipeline input: False
75+
Accept wildcard characters: False
76+
```
77+
78+
## INPUTS
79+
80+
## OUTPUTS
81+
82+
## NOTES
83+
Alias: Export-AzureAsInstanceLog
84+
85+
## RELATED LINKS
86+

0 commit comments

Comments
 (0)