Skip to content

Commit 492b424

Browse files
author
APEX_CI
committed
Sync docs from source code repo to content repo.
1 parent e374b1a commit 492b424

File tree

2,573 files changed

+517421
-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.

2,573 files changed

+517421
-0
lines changed

‎Az/Az.Accounts/Add-AzEnvironment.md

Lines changed: 574 additions & 0 deletions
Large diffs are not rendered by default.

‎Az/Az.Accounts/Az.Accounts.md

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
---
2+
Module Name: Az.Accounts
3+
Module Guid: 342714fc-4009-4863-8afb-a9067e3db04b
4+
Download Help Link: https://docs.microsoft.com/en-us/powershell/module/az.accounts
5+
Help Version: 4.6.0.0
6+
Locale: en-US
7+
content_git_url: https://github.com/Azure/azure-powershell/blob/master/src/Accounts/Accounts/help/Az.Accounts.md
8+
original_content_git_url: https://github.com/Azure/azure-powershell/blob/master/src/Accounts/Accounts/help/Az.Accounts.md
9+
---
10+
11+
# Az.Accounts Module
12+
## Description
13+
Manages credentials and common configuration for all Azure modules.
14+
15+
## Az.Accounts Cmdlets
16+
### [Add-AzEnvironment](Add-AzEnvironment.md)
17+
Adds endpoints and metadata for an instance of Azure Resource Manager.
18+
19+
### [Clear-AzContext](Clear-AzContext.md)
20+
Remove all Azure credentials, account, and subscription information.
21+
22+
### [Clear-AzDefault](Clear-AzDefault.md)
23+
Clears the defaults set by the user in the current context.
24+
25+
### [Connect-AzAccount](Connect-AzAccount.md)
26+
Connect to Azure with an authenticated account for use with Azure Resource Manager cmdlet requests.
27+
28+
### [Disable-AzContextAutosave](Disable-AzContextAutosave.md)
29+
Turn off autosaving Azure credentials. Your login information will be forgotten the next time you open a PowerShell window
30+
31+
### [Disable-AzDataCollection](Disable-AzDataCollection.md)
32+
Opts out of collecting data to improve the AzurePowerShell cmdlets.
33+
Data is not collected unless you explicitly opt in.
34+
35+
### [Disable-AzureRmAlias](Disable-AzureRmAlias.md)
36+
Disables AzureRm prefix aliases for Az modules.
37+
38+
### [Disconnect-AzAccount](Disconnect-AzAccount.md)
39+
Disconnects a connected Azure account and removes all credentials and contexts associated with that account.
40+
41+
### [Enable-AzContextAutosave](Enable-AzContextAutosave.md)
42+
Allow the azure credential, account and subscription information to be saved and automatically loaded when you open a PowerShell window.
43+
44+
### [Enable-AzDataCollection](Enable-AzDataCollection.md)
45+
Enables Azure PowerShell to collect data to improve the user experience with AzurePowerShell cmdlets.
46+
Executing this cmdlet opts in to data collection for the current user on the current machine.
47+
No data is collected unless you explicitly opt in.
48+
49+
### [Enable-AzureRmAlias](Enable-AzureRmAlias.md)
50+
Enables AzureRm prefix aliases for Az modules.
51+
52+
### [Get-AzContext](Get-AzContext.md)
53+
Gets the metadata used to authenticate Azure Resource Manager requests.
54+
55+
### [Get-AzContextAutosaveSetting](Get-AzContextAutosaveSetting.md)
56+
Display metadata about the context autosave feature, including whether the context is
57+
automatically saved, and where saved context and credential information can be found.
58+
59+
### [Get-AzDefault](Get-AzDefault.md)
60+
Get the defaults set by the user in the current context.
61+
62+
### [Get-AzEnvironment](Get-AzEnvironment.md)
63+
Get endpoints and metadata for an instance of Azure services.
64+
65+
### [Get-AzSubscription](Get-AzSubscription.md)
66+
Get subscriptions that the current account can access.
67+
68+
### [Get-AzTenant](Get-AzTenant.md)
69+
Gets tenants that are authorized for the current user.
70+
71+
### [Import-AzContext](Import-AzContext.md)
72+
Loads Azure authentication information from a file.
73+
74+
### [Register-AzModule](Register-AzModule.md)
75+
Internal-only cmdlet that provides runtime support for AUtoRest generated cmdlets.
76+
77+
### [Remove-AzContext](Remove-AzContext.md)
78+
Remove a context from the set of available contexts
79+
80+
### [Remove-AzEnvironment](Remove-AzEnvironment.md)
81+
Removes endpoints and metadata for connecting to a given Azure instance.
82+
83+
### [Rename-AzContext](Rename-AzContext.md)
84+
Rename an Azure context. By default contexts are named by user account and subscription.
85+
86+
### [Resolve-AzError](Resolve-AzError.md)
87+
Display detailed information about PowerShell errors, with extended details for Azure PowerShell errors.
88+
89+
### [Save-AzContext](Save-AzContext.md)
90+
Saves the current authentication information for use in other PowerShell sessions.
91+
92+
### [Select-AzContext](Select-AzContext.md)
93+
Select a subscription and account to target in Azure PowerShell cmdlets
94+
95+
### [Send-Feedback](Send-Feedback.md)
96+
Sends feedback to the Azure PowerShell team via a set of guided prompts.
97+
98+
### [Set-AzContext](Set-AzContext.md)
99+
Sets the tenant, subscription, and environment for cmdlets to use in the current session.
100+
101+
### [Set-AzDefault](Set-AzDefault.md)
102+
Sets a default in the current context
103+
104+
### [Set-AzEnvironment](Set-AzEnvironment.md)
105+
Sets properties for an Azure environment.
106+
107+
### [Uninstall-AzureRm](Uninstall-AzureRm.md)
108+
Removes all AzureRm modules from a machine.
109+

‎Az/Az.Accounts/Clear-AzContext.md

Lines changed: 141 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,141 @@
1+
---
2+
external help file: Microsoft.Azure.PowerShell.Cmdlets.Accounts.dll-Help.xml
3+
Module Name: Az.Accounts
4+
online version: https://docs.microsoft.com/en-us/powershell/module/az.accounts/clear-azcontext
5+
schema: 2.0.0
6+
content_git_url: https://github.com/Azure/azure-powershell/blob/master/src/Accounts/Accounts/help/Clear-AzContext.md
7+
original_content_git_url: https://github.com/Azure/azure-powershell/blob/master/src/Accounts/Accounts/help/Clear-AzContext.md
8+
---
9+
10+
# Clear-AzContext
11+
12+
## SYNOPSIS
13+
Remove all Azure credentials, account, and subscription information.
14+
15+
## SYNTAX
16+
17+
```
18+
Clear-AzContext [-PassThru] [-Force] [-Scope <ContextModificationScope>]
19+
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
20+
```
21+
22+
## DESCRIPTION
23+
Remove all Azure Credentials, account, and subscription information.
24+
25+
## EXAMPLES
26+
27+
### Clear global context
28+
```
29+
PS C:\> Clear-AzContext -Scope CurrentUser
30+
```
31+
32+
Remove all account, subscription, and credential information for any powershell session.
33+
34+
## PARAMETERS
35+
36+
### -DefaultProfile
37+
The credentials, tenant and subscription used for communication with azure
38+
39+
```yaml
40+
Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
41+
Parameter Sets: (All)
42+
Aliases: AzContext, AzureRmContext, AzureCredential
43+
44+
Required: False
45+
Position: Named
46+
Default value: None
47+
Accept pipeline input: False
48+
Accept wildcard characters: False
49+
```
50+
51+
### -Force
52+
Delete all users and groups from the global scope without prompting
53+
54+
```yaml
55+
Type: System.Management.Automation.SwitchParameter
56+
Parameter Sets: (All)
57+
Aliases:
58+
59+
Required: False
60+
Position: Named
61+
Default value: None
62+
Accept pipeline input: False
63+
Accept wildcard characters: False
64+
```
65+
66+
### -PassThru
67+
Return a value indicating success or failure
68+
69+
```yaml
70+
Type: System.Management.Automation.SwitchParameter
71+
Parameter Sets: (All)
72+
Aliases:
73+
74+
Required: False
75+
Position: Named
76+
Default value: None
77+
Accept pipeline input: False
78+
Accept wildcard characters: False
79+
```
80+
81+
### -Scope
82+
Clear the context only for the current PowerShell session, or for all sessions.
83+
84+
```yaml
85+
Type: Microsoft.Azure.Commands.Profile.Common.ContextModificationScope
86+
Parameter Sets: (All)
87+
Aliases:
88+
Accepted values: Process, CurrentUser
89+
90+
Required: False
91+
Position: Named
92+
Default value: None
93+
Accept pipeline input: False
94+
Accept wildcard characters: False
95+
```
96+
97+
### -Confirm
98+
Prompts you for confirmation before running the cmdlet.
99+
100+
```yaml
101+
Type: System.Management.Automation.SwitchParameter
102+
Parameter Sets: (All)
103+
Aliases: cf
104+
105+
Required: False
106+
Position: Named
107+
Default value: None
108+
Accept pipeline input: False
109+
Accept wildcard characters: False
110+
```
111+
112+
### -WhatIf
113+
Shows what would happen if the cmdlet runs.
114+
The cmdlet is not run.
115+
116+
```yaml
117+
Type: System.Management.Automation.SwitchParameter
118+
Parameter Sets: (All)
119+
Aliases: wi
120+
121+
Required: False
122+
Position: Named
123+
Default value: None
124+
Accept pipeline input: False
125+
Accept wildcard characters: False
126+
```
127+
128+
### CommonParameters
129+
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).
130+
131+
## INPUTS
132+
133+
### None
134+
135+
## OUTPUTS
136+
137+
### System.Boolean
138+
139+
## NOTES
140+
141+
## RELATED LINKS

0 commit comments

Comments
 (0)