Skip to content

Commit 6623bf3

Browse files
author
VSC
committed
Sync docs from source code repo to content repo.
1 parent a1d4033 commit 6623bf3

File tree

1,997 files changed

+378578
-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,997 files changed

+378578
-0
lines changed

‎azurermps-6.0.0/Azure.AnalysisServices/Add-AzureAnalysisServicesAccount.md

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

‎azurermps-6.0.0/Azure.AnalysisServices/Azure.AnalysisServices.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
Module_Name: Azure.AnalysisServices
3+
Module_Guid: c717b5a4-1f1b-4a2f-8aa1-bfd09934626e
4+
Download_Help_Link: https://docs.microsoft.com/en-us/powershell/module/azure.analysisservices
5+
Help_Version: 0.5.0.0
6+
Locale: en-US
7+
content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AnalysisServices/Commands.AnalysisServices.Dataplane/help/Azure.AnalysisServices.md
8+
original_content_git_url: https://github.com/Azure/azure-powershell/blob/preview/src/ResourceManager/AnalysisServices/Commands.AnalysisServices.Dataplane/help/Azure.AnalysisServices.md
9+
---
10+
11+
# Azure.AnalysisServices Module
12+
## Description
13+
This module contains commands for performing operations on a given Azure Analysis Services environment
14+
15+
## Azure.AnalysisServices Cmdlets
16+
### [Add-AzureAnalysisServicesAccount](Add-AzureAnalysisServicesAccount.md)
17+
Adds an authenticated account to use for Azure Analysis Services server cmdlet requests.
18+
19+
### [Restart-AzureAnalysisServicesInstance](Restart-AzureAnalysisServicesInstance.md)
20+
Restarts a specified Azure Analysis Services server.
21+

‎azurermps-6.0.0/Azure.AnalysisServices/Export-AzureAnalysisServicesInstanceLog.md

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

0 commit comments

Comments
 (0)