@autorest/powershell 4.0.661 → 4.0.662
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.rush/temp/operation/build/state.json +1 -1
- package/.rush/temp/package-deps_build.json +79 -80
- package/package.json +1 -1
- package/resources/modules/Az.Accounts/2.13.1/Accounts.format.ps1xml +554 -0
- package/resources/modules/Az.Accounts/2.13.1/Accounts.generated.format.ps1xml +471 -0
- package/resources/modules/Az.Accounts/2.13.1/Accounts.types.ps1xml +306 -0
- package/resources/modules/Az.Accounts/{2.7.5 → 2.13.1}/Az.Accounts.nuspec +4 -5
- package/resources/modules/Az.Accounts/2.13.1/Az.Accounts.psd1 +389 -0
- package/resources/modules/Az.Accounts/2.13.1/Az.Accounts.psm1 +365 -0
- package/resources/modules/Az.Accounts/2.13.1/FuzzySharp.dll +0 -0
- package/resources/modules/Az.Accounts/2.13.1/Microsoft.ApplicationInsights.dll +0 -0
- package/resources/modules/Az.Accounts/2.13.1/Microsoft.Azure.PowerShell.AssemblyLoading.dll +0 -0
- package/resources/modules/Az.Accounts/2.13.1/Microsoft.Azure.PowerShell.Authentication.Abstractions.dll +0 -0
- package/resources/modules/Az.Accounts/2.13.1/Microsoft.Azure.PowerShell.Authentication.ResourceManager.dll +0 -0
- package/resources/modules/Az.Accounts/2.13.1/Microsoft.Azure.PowerShell.Authentication.dll +0 -0
- package/resources/modules/Az.Accounts/2.13.1/Microsoft.Azure.PowerShell.AuthenticationAssemblyLoadContext.dll +0 -0
- package/resources/modules/Az.Accounts/2.13.1/Microsoft.Azure.PowerShell.Authenticators.dll +0 -0
- package/resources/modules/Az.Accounts/2.13.1/Microsoft.Azure.PowerShell.Clients.Aks.dll +0 -0
- package/resources/modules/Az.Accounts/{2.7.5 → 2.13.1}/Microsoft.Azure.PowerShell.Clients.Authorization.dll +0 -0
- package/resources/modules/Az.Accounts/{2.7.5 → 2.13.1}/Microsoft.Azure.PowerShell.Clients.Compute.dll +0 -0
- package/resources/modules/Az.Accounts/2.13.1/Microsoft.Azure.PowerShell.Clients.Graph.Rbac.dll +0 -0
- package/resources/modules/Az.Accounts/{2.7.5 → 2.13.1}/Microsoft.Azure.PowerShell.Clients.KeyVault.dll +0 -0
- package/resources/modules/Az.Accounts/{2.7.5 → 2.13.1}/Microsoft.Azure.PowerShell.Clients.Monitor.dll +0 -0
- package/resources/modules/Az.Accounts/{2.7.5 → 2.13.1}/Microsoft.Azure.PowerShell.Clients.Network.dll +0 -0
- package/resources/modules/Az.Accounts/{2.7.5 → 2.13.1}/Microsoft.Azure.PowerShell.Clients.PolicyInsights.dll +0 -0
- package/resources/modules/Az.Accounts/2.13.1/Microsoft.Azure.PowerShell.Clients.ResourceManager.dll +0 -0
- package/resources/modules/Az.Accounts/{2.7.5 → 2.13.1}/Microsoft.Azure.PowerShell.Clients.Storage.Management.dll +0 -0
- package/resources/modules/Az.Accounts/{2.7.5 → 2.13.1}/Microsoft.Azure.PowerShell.Clients.Websites.dll +0 -0
- package/resources/modules/Az.Accounts/2.13.1/Microsoft.Azure.PowerShell.Cmdlets.Accounts.dll +0 -0
- package/resources/modules/Az.Accounts/{2.7.5 → 2.13.1}/Microsoft.Azure.PowerShell.Cmdlets.Accounts.dll-Help.xml +2510 -779
- package/resources/modules/Az.Accounts/2.13.1/Microsoft.Azure.PowerShell.Common.Share.dll +0 -0
- package/resources/modules/Az.Accounts/2.13.1/Microsoft.Azure.PowerShell.Common.dll +0 -0
- package/resources/modules/Az.Accounts/{2.7.5 → 2.13.1}/Microsoft.Azure.PowerShell.Storage.dll +0 -0
- package/resources/modules/Az.Accounts/{2.7.5 → 2.13.1}/Microsoft.Azure.PowerShell.Strategies.dll +0 -0
- package/resources/modules/Az.Accounts/2.13.1/Microsoft.Rest.ClientRuntime.dll +0 -0
- package/resources/modules/Az.Accounts/2.13.1/PostImportScripts/LoadAuthenticators.ps1 +222 -0
- package/resources/modules/Az.Accounts/2.13.1/StartupScripts/AzError.ps1 +281 -0
- package/resources/modules/Az.Accounts/2.13.1/StartupScripts/InitializeAssemblyResolver.ps1 +242 -0
- package/resources/modules/Az.Accounts/{2.7.5 → 2.13.1}/[Content_Types].xml +2 -3
- package/resources/modules/Az.Accounts/{2.7.5 → 2.13.1}/_rels/.rels +2 -2
- package/resources/modules/Az.Accounts/2.13.1/lib/netcoreapp2.1/Azure.Core.dll +0 -0
- package/resources/modules/Az.Accounts/2.13.1/lib/netcoreapp2.1/Microsoft.Identity.Client.dll +0 -0
- package/resources/modules/Az.Accounts/2.13.1/lib/netcoreapp3.1/Microsoft.Identity.Client.Extensions.Msal.dll +0 -0
- package/resources/modules/Az.Accounts/2.13.1/lib/netfx/Azure.Core.dll +0 -0
- package/resources/modules/Az.Accounts/2.13.1/lib/netfx/Microsoft.Identity.Client.Extensions.Msal.dll +0 -0
- package/resources/modules/Az.Accounts/2.13.1/lib/netfx/Microsoft.Identity.Client.dll +0 -0
- package/resources/modules/Az.Accounts/2.13.1/lib/netfx/Newtonsoft.Json.dll +0 -0
- package/resources/modules/Az.Accounts/2.13.1/lib/netfx/System.Diagnostics.DiagnosticSource.dll +0 -0
- package/resources/modules/Az.Accounts/2.13.1/lib/netfx/System.Reflection.DispatchProxy.dll +0 -0
- package/resources/modules/Az.Accounts/2.13.1/lib/netfx/System.Runtime.CompilerServices.Unsafe.dll +0 -0
- package/resources/modules/Az.Accounts/2.13.1/lib/netstandard2.0/Azure.Identity.BrokeredAuthentication.dll +0 -0
- package/resources/modules/Az.Accounts/2.13.1/lib/netstandard2.0/Azure.Identity.dll +0 -0
- package/resources/modules/Az.Accounts/2.13.1/lib/netstandard2.0/Microsoft.Identity.Client.Broker.dll +0 -0
- package/resources/modules/Az.Accounts/2.13.1/lib/netstandard2.0/Microsoft.Identity.Client.NativeInterop.dll +0 -0
- package/resources/modules/Az.Accounts/2.13.1/lib/netstandard2.0/Microsoft.IdentityModel.Abstractions.dll +0 -0
- package/resources/modules/Az.Accounts/2.13.1/lib/netstandard2.0/System.Security.AccessControl.dll +0 -0
- package/resources/modules/Az.Accounts/2.13.1/lib/netstandard2.0/System.Security.Permissions.dll +0 -0
- package/resources/modules/Az.Accounts/2.13.1/lib/netstandard2.0/System.Security.Principal.Windows.dll +0 -0
- package/resources/modules/Az.Accounts/2.13.1/lib/netstandard2.0/msalruntime.dll +0 -0
- package/resources/modules/Az.Accounts/2.13.1/lib/netstandard2.0/msalruntime_arm64.dll +0 -0
- package/resources/modules/Az.Accounts/2.13.1/lib/netstandard2.0/msalruntime_x86.dll +0 -0
- package/resources/modules/Az.Accounts/2.13.1/package/services/metadata/core-properties/f9ac9c2e40914e78a646a7b0b997403b.psmdcp +11 -0
- package/resources/modules/Az.Accounts/2.7.5/Accounts.format.ps1xml +0 -496
- package/resources/modules/Az.Accounts/2.7.5/Accounts.generated.format.ps1xml +0 -468
- package/resources/modules/Az.Accounts/2.7.5/Accounts.types.ps1xml +0 -303
- package/resources/modules/Az.Accounts/2.7.5/Az.Accounts.psd1 +0 -387
- package/resources/modules/Az.Accounts/2.7.5/Az.Accounts.psm1 +0 -375
- package/resources/modules/Az.Accounts/2.7.5/AzSharedAlcAssemblies/Azure.Core.dll +0 -0
- package/resources/modules/Az.Accounts/2.7.5/AzSharedAlcAssemblies/Azure.Identity.dll +0 -0
- package/resources/modules/Az.Accounts/2.7.5/AzSharedAlcAssemblies/Microsoft.Identity.Client.Extensions.Msal.dll +0 -0
- package/resources/modules/Az.Accounts/2.7.5/AzSharedAlcAssemblies/Microsoft.Identity.Client.dll +0 -0
- package/resources/modules/Az.Accounts/2.7.5/Microsoft.ApplicationInsights.dll +0 -0
- package/resources/modules/Az.Accounts/2.7.5/Microsoft.Azure.PowerShell.Authentication.Abstractions.dll +0 -0
- package/resources/modules/Az.Accounts/2.7.5/Microsoft.Azure.PowerShell.Authentication.ResourceManager.deps.json +0 -2309
- package/resources/modules/Az.Accounts/2.7.5/Microsoft.Azure.PowerShell.Authentication.ResourceManager.dll +0 -0
- package/resources/modules/Az.Accounts/2.7.5/Microsoft.Azure.PowerShell.Authentication.deps.json +0 -2273
- package/resources/modules/Az.Accounts/2.7.5/Microsoft.Azure.PowerShell.Authentication.dll +0 -0
- package/resources/modules/Az.Accounts/2.7.5/Microsoft.Azure.PowerShell.AuthenticationAssemblyLoadContext.deps.json +0 -1316
- package/resources/modules/Az.Accounts/2.7.5/Microsoft.Azure.PowerShell.AuthenticationAssemblyLoadContext.dll +0 -0
- package/resources/modules/Az.Accounts/2.7.5/Microsoft.Azure.PowerShell.Authenticators.dll +0 -0
- package/resources/modules/Az.Accounts/2.7.5/Microsoft.Azure.PowerShell.Clients.Aks.dll +0 -0
- package/resources/modules/Az.Accounts/2.7.5/Microsoft.Azure.PowerShell.Clients.Graph.Rbac.dll +0 -0
- package/resources/modules/Az.Accounts/2.7.5/Microsoft.Azure.PowerShell.Clients.ResourceManager.dll +0 -0
- package/resources/modules/Az.Accounts/2.7.5/Microsoft.Azure.PowerShell.Cmdlets.Accounts.deps.json +0 -2413
- package/resources/modules/Az.Accounts/2.7.5/Microsoft.Azure.PowerShell.Cmdlets.Accounts.dll +0 -0
- package/resources/modules/Az.Accounts/2.7.5/Microsoft.Azure.PowerShell.Common.Share.dll +0 -0
- package/resources/modules/Az.Accounts/2.7.5/Microsoft.Azure.PowerShell.Common.dll +0 -0
- package/resources/modules/Az.Accounts/2.7.5/Microsoft.Rest.ClientRuntime.dll +0 -0
- package/resources/modules/Az.Accounts/2.7.5/PostImportScripts/LoadAuthenticators.ps1 +0 -219
- package/resources/modules/Az.Accounts/2.7.5/PreloadAssemblies/Azure.Core.dll +0 -0
- package/resources/modules/Az.Accounts/2.7.5/PreloadAssemblies/Azure.Identity.dll +0 -0
- package/resources/modules/Az.Accounts/2.7.5/PreloadAssemblies/Microsoft.Azure.PowerShell.Authenticators.dll +0 -0
- package/resources/modules/Az.Accounts/2.7.5/PreloadAssemblies/Microsoft.Bcl.AsyncInterfaces.dll +0 -0
- package/resources/modules/Az.Accounts/2.7.5/PreloadAssemblies/Microsoft.Identity.Client.Extensions.Msal.dll +0 -0
- package/resources/modules/Az.Accounts/2.7.5/PreloadAssemblies/Microsoft.Identity.Client.dll +0 -0
- package/resources/modules/Az.Accounts/2.7.5/PreloadAssemblies/Newtonsoft.Json.12.0.3.dll +0 -0
- package/resources/modules/Az.Accounts/2.7.5/PreloadAssemblies/Newtonsoft.Json.dll +0 -0
- package/resources/modules/Az.Accounts/2.7.5/PreloadAssemblies/System.Diagnostics.DiagnosticSource.dll +0 -0
- package/resources/modules/Az.Accounts/2.7.5/PreloadAssemblies/System.Memory.Data.dll +0 -0
- package/resources/modules/Az.Accounts/2.7.5/PreloadAssemblies/System.Reflection.DispatchProxy.dll +0 -0
- package/resources/modules/Az.Accounts/2.7.5/PreloadAssemblies/System.Runtime.CompilerServices.Unsafe.dll +0 -0
- package/resources/modules/Az.Accounts/2.7.5/PreloadAssemblies/System.Security.AccessControl.dll +0 -0
- package/resources/modules/Az.Accounts/2.7.5/PreloadAssemblies/System.Security.Permissions.dll +0 -0
- package/resources/modules/Az.Accounts/2.7.5/PreloadAssemblies/System.Security.Principal.Windows.dll +0 -0
- package/resources/modules/Az.Accounts/2.7.5/PreloadAssemblies/System.Text.Json.dll +0 -0
- package/resources/modules/Az.Accounts/2.7.5/StartupScripts/AzError.ps1 +0 -278
- package/resources/modules/Az.Accounts/2.7.5/StartupScripts/InitializeAssemblyResolver.ps1 +0 -234
- package/resources/modules/Az.Accounts/2.7.5/package/services/metadata/core-properties/1aa0749a068a4238881858013f1a5b7f.psmdcp +0 -11
- /package/resources/modules/Az.Accounts/{2.7.5 → 2.13.1}/Hyak.Common.dll +0 -0
- /package/resources/modules/Az.Accounts/{2.7.5 → 2.13.1}/Microsoft.Azure.Common.dll +0 -0
- /package/resources/modules/Az.Accounts/{2.7.5 → 2.13.1}/Microsoft.Rest.ClientRuntime.Azure.dll +0 -0
- /package/resources/modules/Az.Accounts/{2.7.5 → 2.13.1}/Microsoft.WindowsAzure.Storage.DataMovement.dll +0 -0
- /package/resources/modules/Az.Accounts/{2.7.5 → 2.13.1}/Microsoft.WindowsAzure.Storage.dll +0 -0
- /package/resources/modules/Az.Accounts/{2.7.5 → 2.13.1}/en-US/about_az.help.txt +0 -0
- /package/resources/modules/Az.Accounts/{2.7.5/PreloadAssemblies → 2.13.1/lib/netfx}/System.Numerics.Vectors.dll +0 -0
- /package/resources/modules/Az.Accounts/{2.7.5/PreloadAssemblies → 2.13.1/lib/netfx}/System.Security.Cryptography.Cng.dll +0 -0
- /package/resources/modules/Az.Accounts/{2.7.5/PreloadAssemblies → 2.13.1/lib/netfx}/System.Text.Encodings.Web.dll +0 -0
- /package/resources/modules/Az.Accounts/{2.7.5/PreloadAssemblies → 2.13.1/lib/netfx}/System.Xml.ReaderWriter.dll +0 -0
- /package/resources/modules/Az.Accounts/{2.7.5/AzSharedAlcAssemblies → 2.13.1/lib/netstandard2.0}/Microsoft.Bcl.AsyncInterfaces.dll +0 -0
- /package/resources/modules/Az.Accounts/{2.7.5/PreloadAssemblies → 2.13.1/lib/netstandard2.0}/System.Buffers.dll +0 -0
- /package/resources/modules/Az.Accounts/{2.7.5/AzSharedAlcAssemblies → 2.13.1/lib/netstandard2.0}/System.Memory.Data.dll +0 -0
- /package/resources/modules/Az.Accounts/{2.7.5/PreloadAssemblies → 2.13.1/lib/netstandard2.0}/System.Memory.dll +0 -0
- /package/resources/modules/Az.Accounts/{2.7.5/PreloadAssemblies → 2.13.1/lib/netstandard2.0}/System.Net.Http.WinHttpHandler.dll +0 -0
- /package/resources/modules/Az.Accounts/{2.7.5/PreloadAssemblies → 2.13.1/lib/netstandard2.0}/System.Private.ServiceModel.dll +0 -0
- /package/resources/modules/Az.Accounts/{2.7.5/PreloadAssemblies → 2.13.1/lib/netstandard2.0}/System.ServiceModel.Primitives.dll +0 -0
- /package/resources/modules/Az.Accounts/{2.7.5/AzSharedAlcAssemblies → 2.13.1/lib/netstandard2.0}/System.Text.Json.dll +0 -0
- /package/resources/modules/Az.Accounts/{2.7.5/PreloadAssemblies → 2.13.1/lib/netstandard2.0}/System.Threading.Tasks.Extensions.dll +0 -0
|
@@ -257,7 +257,7 @@
|
|
|
257
257
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="7" aliases="Gallery, GalleryUrl">
|
|
258
258
|
<maml:name>GalleryEndpoint</maml:name>
|
|
259
259
|
<maml:description>
|
|
260
|
-
<maml:para>Specifies the endpoint for the Azure Resource Manager gallery of deployment templates.</maml:para>
|
|
260
|
+
<maml:para>Specifies the endpoint for the Azure Resource Manager gallery of deployment templates. The parameter is to set the value to `GalleryUrl` of `PSAzureEnvironment`. As `GalleryUrl` is removed from ArmMetadata, Azure PowerShell will no longer provide for the value and so it is not recommended to set `GalleryEndpoint` anymore.</maml:para>
|
|
261
261
|
</maml:description>
|
|
262
262
|
<command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
|
|
263
263
|
<dev:type>
|
|
@@ -1039,7 +1039,7 @@
|
|
|
1039
1039
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="7" aliases="Gallery, GalleryUrl">
|
|
1040
1040
|
<maml:name>GalleryEndpoint</maml:name>
|
|
1041
1041
|
<maml:description>
|
|
1042
|
-
<maml:para>Specifies the endpoint for the Azure Resource Manager gallery of deployment templates.</maml:para>
|
|
1042
|
+
<maml:para>Specifies the endpoint for the Azure Resource Manager gallery of deployment templates. The parameter is to set the value to `GalleryUrl` of `PSAzureEnvironment`. As `GalleryUrl` is removed from ArmMetadata, Azure PowerShell will no longer provide for the value and so it is not recommended to set `GalleryEndpoint` anymore.</maml:para>
|
|
1043
1043
|
</maml:description>
|
|
1044
1044
|
<command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
|
|
1045
1045
|
<dev:type>
|
|
@@ -1402,23 +1402,48 @@ TestEnvironment TestRMEndpoint TestADEndpoint/</dev:code>
|
|
|
1402
1402
|
</command:command>
|
|
1403
1403
|
<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">
|
|
1404
1404
|
<command:details>
|
|
1405
|
-
<command:name>Clear-
|
|
1405
|
+
<command:name>Clear-AzConfig</command:name>
|
|
1406
1406
|
<command:verb>Clear</command:verb>
|
|
1407
|
-
<command:noun>
|
|
1407
|
+
<command:noun>AzConfig</command:noun>
|
|
1408
1408
|
<maml:description>
|
|
1409
|
-
<maml:para>
|
|
1409
|
+
<maml:para>Clears the values of configs that are set by the user.</maml:para>
|
|
1410
1410
|
</maml:description>
|
|
1411
1411
|
</command:details>
|
|
1412
1412
|
<maml:description>
|
|
1413
|
-
<maml:para>
|
|
1413
|
+
<maml:para>Clears the values of configs that are set by the user. By default all the configs will be cleared. You can also specify keys of configs to clear.</maml:para>
|
|
1414
1414
|
</maml:description>
|
|
1415
1415
|
<command:syntax>
|
|
1416
1416
|
<command:syntaxItem>
|
|
1417
|
-
<maml:name>Clear-
|
|
1417
|
+
<maml:name>Clear-AzConfig</maml:name>
|
|
1418
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
1419
|
+
<maml:name>AppliesTo</maml:name>
|
|
1420
|
+
<maml:description>
|
|
1421
|
+
<maml:para>Specifies what part of Azure PowerShell the config applies to. Possible values are: - "Az": the config applies to all modules and cmdlets of Azure PowerShell.</maml:para>
|
|
1422
|
+
<maml:para>- Module name: the config applies to a certain module of Azure PowerShell.</maml:para>
|
|
1423
|
+
<maml:para>For example, "Az.Storage". - Cmdlet name: the config applies to a certain cmdlet of Azure PowerShell. For example, "Get-AzKeyVault". If not specified, when getting or clearing configs, it defaults to all the above; when updating, it defaults to "Az".</maml:para>
|
|
1424
|
+
</maml:description>
|
|
1425
|
+
<command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
|
|
1426
|
+
<dev:type>
|
|
1427
|
+
<maml:name>System.String</maml:name>
|
|
1428
|
+
<maml:uri />
|
|
1429
|
+
</dev:type>
|
|
1430
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
1431
|
+
</command:parameter>
|
|
1432
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
1433
|
+
<maml:name>CheckForUpgrade</maml:name>
|
|
1434
|
+
<maml:description>
|
|
1435
|
+
<maml:para>When enabled, Azure PowerShell will check for updates automatically and display a hint message when an update is available. The default value will be changed from false to true in Az version 11.0.0.</maml:para>
|
|
1436
|
+
</maml:description>
|
|
1437
|
+
<dev:type>
|
|
1438
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
1439
|
+
<maml:uri />
|
|
1440
|
+
</dev:type>
|
|
1441
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
1442
|
+
</command:parameter>
|
|
1418
1443
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzContext, AzureRmContext, AzureCredential">
|
|
1419
1444
|
<maml:name>DefaultProfile</maml:name>
|
|
1420
1445
|
<maml:description>
|
|
1421
|
-
<maml:para>The credentials, tenant and subscription used for communication with
|
|
1446
|
+
<maml:para>The credentials, account, tenant, and subscription used for communication with Azure.</maml:para>
|
|
1422
1447
|
</maml:description>
|
|
1423
1448
|
<command:parameterValue required="true" variableLength="false">Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer</command:parameterValue>
|
|
1424
1449
|
<dev:type>
|
|
@@ -1428,9 +1453,75 @@ TestEnvironment TestRMEndpoint TestADEndpoint/</dev:code>
|
|
|
1428
1453
|
<dev:defaultValue>None</dev:defaultValue>
|
|
1429
1454
|
</command:parameter>
|
|
1430
1455
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
1431
|
-
<maml:name>
|
|
1456
|
+
<maml:name>DefaultSubscriptionForLogin</maml:name>
|
|
1432
1457
|
<maml:description>
|
|
1433
|
-
<maml:para>
|
|
1458
|
+
<maml:para>Subscription name or GUID. Sets the default context for Azure PowerShell when logging in without specifying a subscription.</maml:para>
|
|
1459
|
+
</maml:description>
|
|
1460
|
+
<dev:type>
|
|
1461
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
1462
|
+
<maml:uri />
|
|
1463
|
+
</dev:type>
|
|
1464
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
1465
|
+
</command:parameter>
|
|
1466
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
1467
|
+
<maml:name>DisableErrorRecordsPersistence</maml:name>
|
|
1468
|
+
<maml:description>
|
|
1469
|
+
<maml:para>When disabled, error records will not be written to ~/.Azure/ErrorRecords. This config will be replaced by "EnableErrorRecordsPersistence" as opt-in in the next major release of Az around November 2023.</maml:para>
|
|
1470
|
+
</maml:description>
|
|
1471
|
+
<dev:type>
|
|
1472
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
1473
|
+
<maml:uri />
|
|
1474
|
+
</dev:type>
|
|
1475
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
1476
|
+
</command:parameter>
|
|
1477
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
1478
|
+
<maml:name>DisplayBreakingChangeWarning</maml:name>
|
|
1479
|
+
<maml:description>
|
|
1480
|
+
<maml:para>Controls if warning messages for breaking changes are displayed or suppressed. When enabled, a breaking change warning is displayed when executing cmdlets with breaking changes in a future release.</maml:para>
|
|
1481
|
+
</maml:description>
|
|
1482
|
+
<dev:type>
|
|
1483
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
1484
|
+
<maml:uri />
|
|
1485
|
+
</dev:type>
|
|
1486
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
1487
|
+
</command:parameter>
|
|
1488
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
1489
|
+
<maml:name>DisplayRegionIdentified</maml:name>
|
|
1490
|
+
<maml:description>
|
|
1491
|
+
<maml:para>When enabled, Azure PowerShell displays recommendations on regions which may reduce your costs.</maml:para>
|
|
1492
|
+
</maml:description>
|
|
1493
|
+
<dev:type>
|
|
1494
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
1495
|
+
<maml:uri />
|
|
1496
|
+
</dev:type>
|
|
1497
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
1498
|
+
</command:parameter>
|
|
1499
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
1500
|
+
<maml:name>DisplaySurveyMessage</maml:name>
|
|
1501
|
+
<maml:description>
|
|
1502
|
+
<maml:para>When enabled, you are prompted infrequently to participate in user experience surveys for Azure PowerShell.</maml:para>
|
|
1503
|
+
</maml:description>
|
|
1504
|
+
<dev:type>
|
|
1505
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
1506
|
+
<maml:uri />
|
|
1507
|
+
</dev:type>
|
|
1508
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
1509
|
+
</command:parameter>
|
|
1510
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
1511
|
+
<maml:name>EnableDataCollection</maml:name>
|
|
1512
|
+
<maml:description>
|
|
1513
|
+
<maml:para>When enabled, Azure PowerShell cmdlets send telemetry data to Microsoft to improve the customer experience. For more information, see our privacy statement: https://aka.ms/privacy</maml:para>
|
|
1514
|
+
</maml:description>
|
|
1515
|
+
<dev:type>
|
|
1516
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
1517
|
+
<maml:uri />
|
|
1518
|
+
</dev:type>
|
|
1519
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
1520
|
+
</command:parameter>
|
|
1521
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
1522
|
+
<maml:name>EnableLoginByWam</maml:name>
|
|
1523
|
+
<maml:description>
|
|
1524
|
+
<maml:para>[Preview] When enabled, Web Account Manager (WAM) will be the default interactive login experience. It will fall back to using the browser if the platform does not support WAM. Note that this feature is under preview. Microsoft Account (MSA) is currently not supported. Feel free to reach out to Azure PowerShell team if you have any feedbacks: https://aka.ms/azpsissue</maml:para>
|
|
1434
1525
|
</maml:description>
|
|
1435
1526
|
<dev:type>
|
|
1436
1527
|
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
@@ -1441,7 +1532,7 @@ TestEnvironment TestRMEndpoint TestADEndpoint/</dev:code>
|
|
|
1441
1532
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
1442
1533
|
<maml:name>PassThru</maml:name>
|
|
1443
1534
|
<maml:description>
|
|
1444
|
-
<maml:para>
|
|
1535
|
+
<maml:para>Returns true if cmdlet executes correctly.</maml:para>
|
|
1445
1536
|
</maml:description>
|
|
1446
1537
|
<dev:type>
|
|
1447
1538
|
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
@@ -1452,15 +1543,17 @@ TestEnvironment TestRMEndpoint TestADEndpoint/</dev:code>
|
|
|
1452
1543
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
1453
1544
|
<maml:name>Scope</maml:name>
|
|
1454
1545
|
<maml:description>
|
|
1455
|
-
<maml:para>
|
|
1546
|
+
<maml:para>Determines the scope of config changes, for example, whether changes apply only to the current process, or to all sessions started by this user. By default it is CurrentUser.</maml:para>
|
|
1456
1547
|
</maml:description>
|
|
1457
1548
|
<command:parameterValueGroup>
|
|
1458
|
-
<command:parameterValue required="false" command:variableLength="false">Process</command:parameterValue>
|
|
1459
1549
|
<command:parameterValue required="false" command:variableLength="false">CurrentUser</command:parameterValue>
|
|
1550
|
+
<command:parameterValue required="false" command:variableLength="false">Process</command:parameterValue>
|
|
1551
|
+
<command:parameterValue required="false" command:variableLength="false">Default</command:parameterValue>
|
|
1552
|
+
<command:parameterValue required="false" command:variableLength="false">Environment</command:parameterValue>
|
|
1460
1553
|
</command:parameterValueGroup>
|
|
1461
|
-
<command:parameterValue required="true" variableLength="false">Microsoft.Azure.
|
|
1554
|
+
<command:parameterValue required="true" variableLength="false">Microsoft.Azure.PowerShell.Common.Config.ConfigScope</command:parameterValue>
|
|
1462
1555
|
<dev:type>
|
|
1463
|
-
<maml:name>Microsoft.Azure.
|
|
1556
|
+
<maml:name>Microsoft.Azure.PowerShell.Common.Config.ConfigScope</maml:name>
|
|
1464
1557
|
<maml:uri />
|
|
1465
1558
|
</dev:type>
|
|
1466
1559
|
<dev:defaultValue>None</dev:defaultValue>
|
|
@@ -1488,143 +1581,26 @@ TestEnvironment TestRMEndpoint TestADEndpoint/</dev:code>
|
|
|
1488
1581
|
<dev:defaultValue>False</dev:defaultValue>
|
|
1489
1582
|
</command:parameter>
|
|
1490
1583
|
</command:syntaxItem>
|
|
1491
|
-
</command:syntax>
|
|
1492
|
-
<command:parameters>
|
|
1493
|
-
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzContext, AzureRmContext, AzureCredential">
|
|
1494
|
-
<maml:name>DefaultProfile</maml:name>
|
|
1495
|
-
<maml:description>
|
|
1496
|
-
<maml:para>The credentials, tenant and subscription used for communication with azure</maml:para>
|
|
1497
|
-
</maml:description>
|
|
1498
|
-
<command:parameterValue required="true" variableLength="false">Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer</command:parameterValue>
|
|
1499
|
-
<dev:type>
|
|
1500
|
-
<maml:name>Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer</maml:name>
|
|
1501
|
-
<maml:uri />
|
|
1502
|
-
</dev:type>
|
|
1503
|
-
<dev:defaultValue>None</dev:defaultValue>
|
|
1504
|
-
</command:parameter>
|
|
1505
|
-
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
1506
|
-
<maml:name>Force</maml:name>
|
|
1507
|
-
<maml:description>
|
|
1508
|
-
<maml:para>Delete all users and groups from the global scope without prompting</maml:para>
|
|
1509
|
-
</maml:description>
|
|
1510
|
-
<command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue>
|
|
1511
|
-
<dev:type>
|
|
1512
|
-
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
1513
|
-
<maml:uri />
|
|
1514
|
-
</dev:type>
|
|
1515
|
-
<dev:defaultValue>False</dev:defaultValue>
|
|
1516
|
-
</command:parameter>
|
|
1517
|
-
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
1518
|
-
<maml:name>PassThru</maml:name>
|
|
1519
|
-
<maml:description>
|
|
1520
|
-
<maml:para>Return a value indicating success or failure</maml:para>
|
|
1521
|
-
</maml:description>
|
|
1522
|
-
<command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue>
|
|
1523
|
-
<dev:type>
|
|
1524
|
-
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
1525
|
-
<maml:uri />
|
|
1526
|
-
</dev:type>
|
|
1527
|
-
<dev:defaultValue>False</dev:defaultValue>
|
|
1528
|
-
</command:parameter>
|
|
1529
|
-
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
1530
|
-
<maml:name>Scope</maml:name>
|
|
1531
|
-
<maml:description>
|
|
1532
|
-
<maml:para>Clear the context only for the current PowerShell session, or for all sessions.</maml:para>
|
|
1533
|
-
</maml:description>
|
|
1534
|
-
<command:parameterValue required="true" variableLength="false">Microsoft.Azure.Commands.Profile.Common.ContextModificationScope</command:parameterValue>
|
|
1535
|
-
<dev:type>
|
|
1536
|
-
<maml:name>Microsoft.Azure.Commands.Profile.Common.ContextModificationScope</maml:name>
|
|
1537
|
-
<maml:uri />
|
|
1538
|
-
</dev:type>
|
|
1539
|
-
<dev:defaultValue>None</dev:defaultValue>
|
|
1540
|
-
</command:parameter>
|
|
1541
|
-
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf">
|
|
1542
|
-
<maml:name>Confirm</maml:name>
|
|
1543
|
-
<maml:description>
|
|
1544
|
-
<maml:para>Prompts you for confirmation before running the cmdlet.</maml:para>
|
|
1545
|
-
</maml:description>
|
|
1546
|
-
<command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue>
|
|
1547
|
-
<dev:type>
|
|
1548
|
-
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
1549
|
-
<maml:uri />
|
|
1550
|
-
</dev:type>
|
|
1551
|
-
<dev:defaultValue>False</dev:defaultValue>
|
|
1552
|
-
</command:parameter>
|
|
1553
|
-
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi">
|
|
1554
|
-
<maml:name>WhatIf</maml:name>
|
|
1555
|
-
<maml:description>
|
|
1556
|
-
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
|
|
1557
|
-
</maml:description>
|
|
1558
|
-
<command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue>
|
|
1559
|
-
<dev:type>
|
|
1560
|
-
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
1561
|
-
<maml:uri />
|
|
1562
|
-
</dev:type>
|
|
1563
|
-
<dev:defaultValue>False</dev:defaultValue>
|
|
1564
|
-
</command:parameter>
|
|
1565
|
-
</command:parameters>
|
|
1566
|
-
<command:inputTypes>
|
|
1567
|
-
<command:inputType>
|
|
1568
|
-
<dev:type>
|
|
1569
|
-
<maml:name>None</maml:name>
|
|
1570
|
-
</dev:type>
|
|
1571
|
-
<maml:description>
|
|
1572
|
-
<maml:para></maml:para>
|
|
1573
|
-
</maml:description>
|
|
1574
|
-
</command:inputType>
|
|
1575
|
-
</command:inputTypes>
|
|
1576
|
-
<command:returnValues>
|
|
1577
|
-
<command:returnValue>
|
|
1578
|
-
<dev:type>
|
|
1579
|
-
<maml:name>System.Boolean</maml:name>
|
|
1580
|
-
</dev:type>
|
|
1581
|
-
<maml:description>
|
|
1582
|
-
<maml:para></maml:para>
|
|
1583
|
-
</maml:description>
|
|
1584
|
-
</command:returnValue>
|
|
1585
|
-
</command:returnValues>
|
|
1586
|
-
<maml:alertSet>
|
|
1587
|
-
<maml:alert>
|
|
1588
|
-
<maml:para></maml:para>
|
|
1589
|
-
</maml:alert>
|
|
1590
|
-
</maml:alertSet>
|
|
1591
|
-
<command:examples>
|
|
1592
|
-
<command:example>
|
|
1593
|
-
<maml:title>--------------- Example 1: Clear global context ---------------</maml:title>
|
|
1594
|
-
<dev:code>Clear-AzContext -Scope CurrentUser</dev:code>
|
|
1595
|
-
<dev:remarks>
|
|
1596
|
-
<maml:para>Remove all account, subscription, and credential information for any powershell session.</maml:para>
|
|
1597
|
-
<maml:para></maml:para>
|
|
1598
|
-
<maml:para></maml:para>
|
|
1599
|
-
</dev:remarks>
|
|
1600
|
-
</command:example>
|
|
1601
|
-
</command:examples>
|
|
1602
|
-
<command:relatedLinks>
|
|
1603
|
-
<maml:navigationLink>
|
|
1604
|
-
<maml:linkText>Online Version:</maml:linkText>
|
|
1605
|
-
<maml:uri>https://learn.microsoft.com/powershell/module/az.accounts/clear-azcontext</maml:uri>
|
|
1606
|
-
</maml:navigationLink>
|
|
1607
|
-
</command:relatedLinks>
|
|
1608
|
-
</command:command>
|
|
1609
|
-
<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">
|
|
1610
|
-
<command:details>
|
|
1611
|
-
<command:name>Clear-AzDefault</command:name>
|
|
1612
|
-
<command:verb>Clear</command:verb>
|
|
1613
|
-
<command:noun>AzDefault</command:noun>
|
|
1614
|
-
<maml:description>
|
|
1615
|
-
<maml:para>Clears the defaults set by the user in the current context.</maml:para>
|
|
1616
|
-
</maml:description>
|
|
1617
|
-
</command:details>
|
|
1618
|
-
<maml:description>
|
|
1619
|
-
<maml:para>The Clear-AzDefault cmdlet removes the defaults set by the user depending on the switch parameters specified by the user.</maml:para>
|
|
1620
|
-
</maml:description>
|
|
1621
|
-
<command:syntax>
|
|
1622
1584
|
<command:syntaxItem>
|
|
1623
|
-
<maml:name>Clear-
|
|
1585
|
+
<maml:name>Clear-AzConfig</maml:name>
|
|
1586
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
1587
|
+
<maml:name>AppliesTo</maml:name>
|
|
1588
|
+
<maml:description>
|
|
1589
|
+
<maml:para>Specifies what part of Azure PowerShell the config applies to. Possible values are: - "Az": the config applies to all modules and cmdlets of Azure PowerShell.</maml:para>
|
|
1590
|
+
<maml:para>- Module name: the config applies to a certain module of Azure PowerShell.</maml:para>
|
|
1591
|
+
<maml:para>For example, "Az.Storage". - Cmdlet name: the config applies to a certain cmdlet of Azure PowerShell. For example, "Get-AzKeyVault". If not specified, when getting or clearing configs, it defaults to all the above; when updating, it defaults to "Az".</maml:para>
|
|
1592
|
+
</maml:description>
|
|
1593
|
+
<command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
|
|
1594
|
+
<dev:type>
|
|
1595
|
+
<maml:name>System.String</maml:name>
|
|
1596
|
+
<maml:uri />
|
|
1597
|
+
</dev:type>
|
|
1598
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
1599
|
+
</command:parameter>
|
|
1624
1600
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzContext, AzureRmContext, AzureCredential">
|
|
1625
1601
|
<maml:name>DefaultProfile</maml:name>
|
|
1626
1602
|
<maml:description>
|
|
1627
|
-
<maml:para>The credentials, account, tenant, and subscription used for communication with
|
|
1603
|
+
<maml:para>The credentials, account, tenant, and subscription used for communication with Azure.</maml:para>
|
|
1628
1604
|
</maml:description>
|
|
1629
1605
|
<command:parameterValue required="true" variableLength="false">Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer</command:parameterValue>
|
|
1630
1606
|
<dev:type>
|
|
@@ -1636,7 +1612,7 @@ TestEnvironment TestRMEndpoint TestADEndpoint/</dev:code>
|
|
|
1636
1612
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
1637
1613
|
<maml:name>Force</maml:name>
|
|
1638
1614
|
<maml:description>
|
|
1639
|
-
<maml:para>
|
|
1615
|
+
<maml:para>Do not ask for confirmation when clearing all configs.</maml:para>
|
|
1640
1616
|
</maml:description>
|
|
1641
1617
|
<dev:type>
|
|
1642
1618
|
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
@@ -1647,18 +1623,7 @@ TestEnvironment TestRMEndpoint TestADEndpoint/</dev:code>
|
|
|
1647
1623
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
1648
1624
|
<maml:name>PassThru</maml:name>
|
|
1649
1625
|
<maml:description>
|
|
1650
|
-
<maml:para>
|
|
1651
|
-
</maml:description>
|
|
1652
|
-
<dev:type>
|
|
1653
|
-
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
1654
|
-
<maml:uri />
|
|
1655
|
-
</dev:type>
|
|
1656
|
-
<dev:defaultValue>False</dev:defaultValue>
|
|
1657
|
-
</command:parameter>
|
|
1658
|
-
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
|
|
1659
|
-
<maml:name>ResourceGroup</maml:name>
|
|
1660
|
-
<maml:description>
|
|
1661
|
-
<maml:para>Clear Default Resource Group</maml:para>
|
|
1626
|
+
<maml:para>Returns true if cmdlet executes correctly.</maml:para>
|
|
1662
1627
|
</maml:description>
|
|
1663
1628
|
<dev:type>
|
|
1664
1629
|
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
@@ -1669,15 +1634,17 @@ TestEnvironment TestRMEndpoint TestADEndpoint/</dev:code>
|
|
|
1669
1634
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
1670
1635
|
<maml:name>Scope</maml:name>
|
|
1671
1636
|
<maml:description>
|
|
1672
|
-
<maml:para>Determines the scope of
|
|
1637
|
+
<maml:para>Determines the scope of config changes, for example, whether changes apply only to the current process, or to all sessions started by this user. By default it is CurrentUser.</maml:para>
|
|
1673
1638
|
</maml:description>
|
|
1674
1639
|
<command:parameterValueGroup>
|
|
1675
|
-
<command:parameterValue required="false" command:variableLength="false">Process</command:parameterValue>
|
|
1676
1640
|
<command:parameterValue required="false" command:variableLength="false">CurrentUser</command:parameterValue>
|
|
1641
|
+
<command:parameterValue required="false" command:variableLength="false">Process</command:parameterValue>
|
|
1642
|
+
<command:parameterValue required="false" command:variableLength="false">Default</command:parameterValue>
|
|
1643
|
+
<command:parameterValue required="false" command:variableLength="false">Environment</command:parameterValue>
|
|
1677
1644
|
</command:parameterValueGroup>
|
|
1678
|
-
<command:parameterValue required="true" variableLength="false">Microsoft.Azure.
|
|
1645
|
+
<command:parameterValue required="true" variableLength="false">Microsoft.Azure.PowerShell.Common.Config.ConfigScope</command:parameterValue>
|
|
1679
1646
|
<dev:type>
|
|
1680
|
-
<maml:name>Microsoft.Azure.
|
|
1647
|
+
<maml:name>Microsoft.Azure.PowerShell.Common.Config.ConfigScope</maml:name>
|
|
1681
1648
|
<maml:uri />
|
|
1682
1649
|
</dev:type>
|
|
1683
1650
|
<dev:defaultValue>None</dev:defaultValue>
|
|
@@ -1707,12 +1674,38 @@ TestEnvironment TestRMEndpoint TestADEndpoint/</dev:code>
|
|
|
1707
1674
|
</command:syntaxItem>
|
|
1708
1675
|
</command:syntax>
|
|
1709
1676
|
<command:parameters>
|
|
1710
|
-
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="
|
|
1711
|
-
<maml:name>
|
|
1677
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
1678
|
+
<maml:name>AppliesTo</maml:name>
|
|
1712
1679
|
<maml:description>
|
|
1713
|
-
<maml:para>
|
|
1680
|
+
<maml:para>Specifies what part of Azure PowerShell the config applies to. Possible values are: - "Az": the config applies to all modules and cmdlets of Azure PowerShell.</maml:para>
|
|
1681
|
+
<maml:para>- Module name: the config applies to a certain module of Azure PowerShell.</maml:para>
|
|
1682
|
+
<maml:para>For example, "Az.Storage". - Cmdlet name: the config applies to a certain cmdlet of Azure PowerShell. For example, "Get-AzKeyVault". If not specified, when getting or clearing configs, it defaults to all the above; when updating, it defaults to "Az".</maml:para>
|
|
1714
1683
|
</maml:description>
|
|
1715
|
-
<command:parameterValue required="true" variableLength="false">
|
|
1684
|
+
<command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
|
|
1685
|
+
<dev:type>
|
|
1686
|
+
<maml:name>System.String</maml:name>
|
|
1687
|
+
<maml:uri />
|
|
1688
|
+
</dev:type>
|
|
1689
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
1690
|
+
</command:parameter>
|
|
1691
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
1692
|
+
<maml:name>CheckForUpgrade</maml:name>
|
|
1693
|
+
<maml:description>
|
|
1694
|
+
<maml:para>When enabled, Azure PowerShell will check for updates automatically and display a hint message when an update is available. The default value will be changed from false to true in Az version 11.0.0.</maml:para>
|
|
1695
|
+
</maml:description>
|
|
1696
|
+
<command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue>
|
|
1697
|
+
<dev:type>
|
|
1698
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
1699
|
+
<maml:uri />
|
|
1700
|
+
</dev:type>
|
|
1701
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
1702
|
+
</command:parameter>
|
|
1703
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzContext, AzureRmContext, AzureCredential">
|
|
1704
|
+
<maml:name>DefaultProfile</maml:name>
|
|
1705
|
+
<maml:description>
|
|
1706
|
+
<maml:para>The credentials, account, tenant, and subscription used for communication with Azure.</maml:para>
|
|
1707
|
+
</maml:description>
|
|
1708
|
+
<command:parameterValue required="true" variableLength="false">Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer</command:parameterValue>
|
|
1716
1709
|
<dev:type>
|
|
1717
1710
|
<maml:name>Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer</maml:name>
|
|
1718
1711
|
<maml:uri />
|
|
@@ -1720,9 +1713,9 @@ TestEnvironment TestRMEndpoint TestADEndpoint/</dev:code>
|
|
|
1720
1713
|
<dev:defaultValue>None</dev:defaultValue>
|
|
1721
1714
|
</command:parameter>
|
|
1722
1715
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
1723
|
-
<maml:name>
|
|
1716
|
+
<maml:name>DefaultSubscriptionForLogin</maml:name>
|
|
1724
1717
|
<maml:description>
|
|
1725
|
-
<maml:para>
|
|
1718
|
+
<maml:para>Subscription name or GUID. Sets the default context for Azure PowerShell when logging in without specifying a subscription.</maml:para>
|
|
1726
1719
|
</maml:description>
|
|
1727
1720
|
<command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue>
|
|
1728
1721
|
<dev:type>
|
|
@@ -1732,9 +1725,9 @@ TestEnvironment TestRMEndpoint TestADEndpoint/</dev:code>
|
|
|
1732
1725
|
<dev:defaultValue>False</dev:defaultValue>
|
|
1733
1726
|
</command:parameter>
|
|
1734
1727
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
1735
|
-
<maml:name>
|
|
1728
|
+
<maml:name>DisableErrorRecordsPersistence</maml:name>
|
|
1736
1729
|
<maml:description>
|
|
1737
|
-
<maml:para>
|
|
1730
|
+
<maml:para>When disabled, error records will not be written to ~/.Azure/ErrorRecords. This config will be replaced by "EnableErrorRecordsPersistence" as opt-in in the next major release of Az around November 2023.</maml:para>
|
|
1738
1731
|
</maml:description>
|
|
1739
1732
|
<command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue>
|
|
1740
1733
|
<dev:type>
|
|
@@ -1743,10 +1736,82 @@ TestEnvironment TestRMEndpoint TestADEndpoint/</dev:code>
|
|
|
1743
1736
|
</dev:type>
|
|
1744
1737
|
<dev:defaultValue>False</dev:defaultValue>
|
|
1745
1738
|
</command:parameter>
|
|
1746
|
-
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="
|
|
1747
|
-
<maml:name>
|
|
1739
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
1740
|
+
<maml:name>DisplayBreakingChangeWarning</maml:name>
|
|
1748
1741
|
<maml:description>
|
|
1749
|
-
<maml:para>
|
|
1742
|
+
<maml:para>Controls if warning messages for breaking changes are displayed or suppressed. When enabled, a breaking change warning is displayed when executing cmdlets with breaking changes in a future release.</maml:para>
|
|
1743
|
+
</maml:description>
|
|
1744
|
+
<command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue>
|
|
1745
|
+
<dev:type>
|
|
1746
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
1747
|
+
<maml:uri />
|
|
1748
|
+
</dev:type>
|
|
1749
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
1750
|
+
</command:parameter>
|
|
1751
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
1752
|
+
<maml:name>DisplayRegionIdentified</maml:name>
|
|
1753
|
+
<maml:description>
|
|
1754
|
+
<maml:para>When enabled, Azure PowerShell displays recommendations on regions which may reduce your costs.</maml:para>
|
|
1755
|
+
</maml:description>
|
|
1756
|
+
<command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue>
|
|
1757
|
+
<dev:type>
|
|
1758
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
1759
|
+
<maml:uri />
|
|
1760
|
+
</dev:type>
|
|
1761
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
1762
|
+
</command:parameter>
|
|
1763
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
1764
|
+
<maml:name>DisplaySurveyMessage</maml:name>
|
|
1765
|
+
<maml:description>
|
|
1766
|
+
<maml:para>When enabled, you are prompted infrequently to participate in user experience surveys for Azure PowerShell.</maml:para>
|
|
1767
|
+
</maml:description>
|
|
1768
|
+
<command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue>
|
|
1769
|
+
<dev:type>
|
|
1770
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
1771
|
+
<maml:uri />
|
|
1772
|
+
</dev:type>
|
|
1773
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
1774
|
+
</command:parameter>
|
|
1775
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
1776
|
+
<maml:name>EnableDataCollection</maml:name>
|
|
1777
|
+
<maml:description>
|
|
1778
|
+
<maml:para>When enabled, Azure PowerShell cmdlets send telemetry data to Microsoft to improve the customer experience. For more information, see our privacy statement: https://aka.ms/privacy</maml:para>
|
|
1779
|
+
</maml:description>
|
|
1780
|
+
<command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue>
|
|
1781
|
+
<dev:type>
|
|
1782
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
1783
|
+
<maml:uri />
|
|
1784
|
+
</dev:type>
|
|
1785
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
1786
|
+
</command:parameter>
|
|
1787
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
1788
|
+
<maml:name>EnableLoginByWam</maml:name>
|
|
1789
|
+
<maml:description>
|
|
1790
|
+
<maml:para>[Preview] When enabled, Web Account Manager (WAM) will be the default interactive login experience. It will fall back to using the browser if the platform does not support WAM. Note that this feature is under preview. Microsoft Account (MSA) is currently not supported. Feel free to reach out to Azure PowerShell team if you have any feedbacks: https://aka.ms/azpsissue</maml:para>
|
|
1791
|
+
</maml:description>
|
|
1792
|
+
<command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue>
|
|
1793
|
+
<dev:type>
|
|
1794
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
1795
|
+
<maml:uri />
|
|
1796
|
+
</dev:type>
|
|
1797
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
1798
|
+
</command:parameter>
|
|
1799
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
1800
|
+
<maml:name>Force</maml:name>
|
|
1801
|
+
<maml:description>
|
|
1802
|
+
<maml:para>Do not ask for confirmation when clearing all configs.</maml:para>
|
|
1803
|
+
</maml:description>
|
|
1804
|
+
<command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue>
|
|
1805
|
+
<dev:type>
|
|
1806
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
1807
|
+
<maml:uri />
|
|
1808
|
+
</dev:type>
|
|
1809
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
1810
|
+
</command:parameter>
|
|
1811
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
1812
|
+
<maml:name>PassThru</maml:name>
|
|
1813
|
+
<maml:description>
|
|
1814
|
+
<maml:para>Returns true if cmdlet executes correctly.</maml:para>
|
|
1750
1815
|
</maml:description>
|
|
1751
1816
|
<command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue>
|
|
1752
1817
|
<dev:type>
|
|
@@ -1758,11 +1823,11 @@ TestEnvironment TestRMEndpoint TestADEndpoint/</dev:code>
|
|
|
1758
1823
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
1759
1824
|
<maml:name>Scope</maml:name>
|
|
1760
1825
|
<maml:description>
|
|
1761
|
-
<maml:para>Determines the scope of
|
|
1826
|
+
<maml:para>Determines the scope of config changes, for example, whether changes apply only to the current process, or to all sessions started by this user. By default it is CurrentUser.</maml:para>
|
|
1762
1827
|
</maml:description>
|
|
1763
|
-
<command:parameterValue required="true" variableLength="false">Microsoft.Azure.
|
|
1828
|
+
<command:parameterValue required="true" variableLength="false">Microsoft.Azure.PowerShell.Common.Config.ConfigScope</command:parameterValue>
|
|
1764
1829
|
<dev:type>
|
|
1765
|
-
<maml:name>Microsoft.Azure.
|
|
1830
|
+
<maml:name>Microsoft.Azure.PowerShell.Common.Config.ConfigScope</maml:name>
|
|
1766
1831
|
<maml:uri />
|
|
1767
1832
|
</dev:type>
|
|
1768
1833
|
<dev:defaultValue>None</dev:defaultValue>
|
|
@@ -1795,7 +1860,7 @@ TestEnvironment TestRMEndpoint TestADEndpoint/</dev:code>
|
|
|
1795
1860
|
<command:inputTypes>
|
|
1796
1861
|
<command:inputType>
|
|
1797
1862
|
<dev:type>
|
|
1798
|
-
<maml:name>
|
|
1863
|
+
<maml:name>None</maml:name>
|
|
1799
1864
|
</dev:type>
|
|
1800
1865
|
<maml:description>
|
|
1801
1866
|
<maml:para></maml:para>
|
|
@@ -1820,18 +1885,18 @@ TestEnvironment TestRMEndpoint TestADEndpoint/</dev:code>
|
|
|
1820
1885
|
<command:examples>
|
|
1821
1886
|
<command:example>
|
|
1822
1887
|
<maml:title>-------------------------- Example 1 --------------------------</maml:title>
|
|
1823
|
-
<dev:code>Clear-
|
|
1888
|
+
<dev:code>Clear-AzConfig -Force</dev:code>
|
|
1824
1889
|
<dev:remarks>
|
|
1825
|
-
<maml:para>
|
|
1890
|
+
<maml:para>Clear all the configs. `-Force` suppresses the prompt for confirmation.</maml:para>
|
|
1826
1891
|
<maml:para></maml:para>
|
|
1827
1892
|
<maml:para></maml:para>
|
|
1828
1893
|
</dev:remarks>
|
|
1829
1894
|
</command:example>
|
|
1830
1895
|
<command:example>
|
|
1831
1896
|
<maml:title>-------------------------- Example 2 --------------------------</maml:title>
|
|
1832
|
-
<dev:code>Clear-
|
|
1897
|
+
<dev:code>Clear-AzConfig -EnableDataCollection</dev:code>
|
|
1833
1898
|
<dev:remarks>
|
|
1834
|
-
<maml:para>
|
|
1899
|
+
<maml:para>Clear the "EnableDataCollection" config.</maml:para>
|
|
1835
1900
|
<maml:para></maml:para>
|
|
1836
1901
|
<maml:para></maml:para>
|
|
1837
1902
|
</dev:remarks>
|
|
@@ -1840,66 +1905,29 @@ TestEnvironment TestRMEndpoint TestADEndpoint/</dev:code>
|
|
|
1840
1905
|
<command:relatedLinks>
|
|
1841
1906
|
<maml:navigationLink>
|
|
1842
1907
|
<maml:linkText>Online Version:</maml:linkText>
|
|
1843
|
-
<maml:uri>https://learn.microsoft.com/powershell/module/az.accounts/clear-
|
|
1908
|
+
<maml:uri>https://learn.microsoft.com/powershell/module/az.accounts/clear-azconfig</maml:uri>
|
|
1844
1909
|
</maml:navigationLink>
|
|
1845
1910
|
</command:relatedLinks>
|
|
1846
1911
|
</command:command>
|
|
1847
1912
|
<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">
|
|
1848
1913
|
<command:details>
|
|
1849
|
-
<command:name>
|
|
1850
|
-
<command:verb>
|
|
1851
|
-
<command:noun>
|
|
1914
|
+
<command:name>Clear-AzContext</command:name>
|
|
1915
|
+
<command:verb>Clear</command:verb>
|
|
1916
|
+
<command:noun>AzContext</command:noun>
|
|
1852
1917
|
<maml:description>
|
|
1853
|
-
<maml:para>
|
|
1918
|
+
<maml:para>Remove all Azure credentials, account, and subscription information.</maml:para>
|
|
1854
1919
|
</maml:description>
|
|
1855
1920
|
</command:details>
|
|
1856
1921
|
<maml:description>
|
|
1857
|
-
<maml:para>
|
|
1922
|
+
<maml:para>Remove all Azure Credentials, account, and subscription information.</maml:para>
|
|
1858
1923
|
</maml:description>
|
|
1859
1924
|
<command:syntax>
|
|
1860
1925
|
<command:syntaxItem>
|
|
1861
|
-
<maml:name>
|
|
1862
|
-
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
1863
|
-
<maml:name>AccessToken</maml:name>
|
|
1864
|
-
<maml:description>
|
|
1865
|
-
<maml:para>Specifies an access token.</maml:para>
|
|
1866
|
-
<maml:para>> [!CAUTION] > Access tokens are a type of credential. You should take the appropriate security precautions to > keep them confidential. Access tokens also timeout and may prevent long running tasks from > completing.</maml:para>
|
|
1867
|
-
</maml:description>
|
|
1868
|
-
<command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
|
|
1869
|
-
<dev:type>
|
|
1870
|
-
<maml:name>System.String</maml:name>
|
|
1871
|
-
<maml:uri />
|
|
1872
|
-
</dev:type>
|
|
1873
|
-
<dev:defaultValue>None</dev:defaultValue>
|
|
1874
|
-
</command:parameter>
|
|
1875
|
-
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
1876
|
-
<maml:name>AccountId</maml:name>
|
|
1877
|
-
<maml:description>
|
|
1878
|
-
<maml:para>Account Id / User Id / User Name to login with in Default (UserWithSubscriptionId) parameter set; Account ID for access token in AccessToken parameter set; Account ID for managed service in ManagedService parameter set. Can be a managed service resource ID, or the associated client ID. To use the system assigned identity, leave this field blank.</maml:para>
|
|
1879
|
-
</maml:description>
|
|
1880
|
-
<command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
|
|
1881
|
-
<dev:type>
|
|
1882
|
-
<maml:name>System.String</maml:name>
|
|
1883
|
-
<maml:uri />
|
|
1884
|
-
</dev:type>
|
|
1885
|
-
<dev:defaultValue>None</dev:defaultValue>
|
|
1886
|
-
</command:parameter>
|
|
1887
|
-
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
1888
|
-
<maml:name>ContextName</maml:name>
|
|
1889
|
-
<maml:description>
|
|
1890
|
-
<maml:para>Name of the default Azure context for this login. For more information about Azure contexts, see Azure PowerShell context objects (/powershell/azure/context-persistence).</maml:para>
|
|
1891
|
-
</maml:description>
|
|
1892
|
-
<command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
|
|
1893
|
-
<dev:type>
|
|
1894
|
-
<maml:name>System.String</maml:name>
|
|
1895
|
-
<maml:uri />
|
|
1896
|
-
</dev:type>
|
|
1897
|
-
<dev:defaultValue>None</dev:defaultValue>
|
|
1898
|
-
</command:parameter>
|
|
1926
|
+
<maml:name>Clear-AzContext</maml:name>
|
|
1899
1927
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzContext, AzureRmContext, AzureCredential">
|
|
1900
1928
|
<maml:name>DefaultProfile</maml:name>
|
|
1901
1929
|
<maml:description>
|
|
1902
|
-
<maml:para>The credentials,
|
|
1930
|
+
<maml:para>The credentials, tenant and subscription used for communication with azure</maml:para>
|
|
1903
1931
|
</maml:description>
|
|
1904
1932
|
<command:parameterValue required="true" variableLength="false">Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer</command:parameterValue>
|
|
1905
1933
|
<dev:type>
|
|
@@ -1908,22 +1936,10 @@ TestEnvironment TestRMEndpoint TestADEndpoint/</dev:code>
|
|
|
1908
1936
|
</dev:type>
|
|
1909
1937
|
<dev:defaultValue>None</dev:defaultValue>
|
|
1910
1938
|
</command:parameter>
|
|
1911
|
-
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="EnvironmentName">
|
|
1912
|
-
<maml:name>Environment</maml:name>
|
|
1913
|
-
<maml:description>
|
|
1914
|
-
<maml:para>Environment containing the Azure account.</maml:para>
|
|
1915
|
-
</maml:description>
|
|
1916
|
-
<command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
|
|
1917
|
-
<dev:type>
|
|
1918
|
-
<maml:name>System.String</maml:name>
|
|
1919
|
-
<maml:uri />
|
|
1920
|
-
</dev:type>
|
|
1921
|
-
<dev:defaultValue>None</dev:defaultValue>
|
|
1922
|
-
</command:parameter>
|
|
1923
1939
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
1924
1940
|
<maml:name>Force</maml:name>
|
|
1925
1941
|
<maml:description>
|
|
1926
|
-
<maml:para>
|
|
1942
|
+
<maml:para>Delete all users and groups from the global scope without prompting</maml:para>
|
|
1927
1943
|
</maml:description>
|
|
1928
1944
|
<dev:type>
|
|
1929
1945
|
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
@@ -1932,57 +1948,20 @@ TestEnvironment TestRMEndpoint TestADEndpoint/</dev:code>
|
|
|
1932
1948
|
<dev:defaultValue>False</dev:defaultValue>
|
|
1933
1949
|
</command:parameter>
|
|
1934
1950
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
1935
|
-
<maml:name>
|
|
1936
|
-
<maml:description>
|
|
1937
|
-
<maml:para>AccessToken for Graph Service.</maml:para>
|
|
1938
|
-
</maml:description>
|
|
1939
|
-
<command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
|
|
1940
|
-
<dev:type>
|
|
1941
|
-
<maml:name>System.String</maml:name>
|
|
1942
|
-
<maml:uri />
|
|
1943
|
-
</dev:type>
|
|
1944
|
-
<dev:defaultValue>None</dev:defaultValue>
|
|
1945
|
-
</command:parameter>
|
|
1946
|
-
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
1947
|
-
<maml:name>KeyVaultAccessToken</maml:name>
|
|
1948
|
-
<maml:description>
|
|
1949
|
-
<maml:para>AccessToken for KeyVault Service.</maml:para>
|
|
1950
|
-
</maml:description>
|
|
1951
|
-
<command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
|
|
1952
|
-
<dev:type>
|
|
1953
|
-
<maml:name>System.String</maml:name>
|
|
1954
|
-
<maml:uri />
|
|
1955
|
-
</dev:type>
|
|
1956
|
-
<dev:defaultValue>None</dev:defaultValue>
|
|
1957
|
-
</command:parameter>
|
|
1958
|
-
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
1959
|
-
<maml:name>MaxContextPopulation</maml:name>
|
|
1960
|
-
<maml:description>
|
|
1961
|
-
<maml:para>Max subscription number to populate contexts after login. Default is 25. To populate all subscriptions to contexts, set to -1.</maml:para>
|
|
1962
|
-
</maml:description>
|
|
1963
|
-
<command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue>
|
|
1964
|
-
<dev:type>
|
|
1965
|
-
<maml:name>System.Int32</maml:name>
|
|
1966
|
-
<maml:uri />
|
|
1967
|
-
</dev:type>
|
|
1968
|
-
<dev:defaultValue>None</dev:defaultValue>
|
|
1969
|
-
</command:parameter>
|
|
1970
|
-
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
1971
|
-
<maml:name>MicrosoftGraphAccessToken</maml:name>
|
|
1951
|
+
<maml:name>PassThru</maml:name>
|
|
1972
1952
|
<maml:description>
|
|
1973
|
-
<maml:para>
|
|
1953
|
+
<maml:para>Return a value indicating success or failure</maml:para>
|
|
1974
1954
|
</maml:description>
|
|
1975
|
-
<command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
|
|
1976
1955
|
<dev:type>
|
|
1977
|
-
<maml:name>System.
|
|
1956
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
1978
1957
|
<maml:uri />
|
|
1979
1958
|
</dev:type>
|
|
1980
|
-
<dev:defaultValue>
|
|
1959
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
1981
1960
|
</command:parameter>
|
|
1982
1961
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
1983
1962
|
<maml:name>Scope</maml:name>
|
|
1984
1963
|
<maml:description>
|
|
1985
|
-
<maml:para>
|
|
1964
|
+
<maml:para>Clear the context only for the current PowerShell session, or for all sessions.</maml:para>
|
|
1986
1965
|
</maml:description>
|
|
1987
1966
|
<command:parameterValueGroup>
|
|
1988
1967
|
<command:parameterValue required="false" command:variableLength="false">Process</command:parameterValue>
|
|
@@ -1995,10 +1974,10 @@ TestEnvironment TestRMEndpoint TestADEndpoint/</dev:code>
|
|
|
1995
1974
|
</dev:type>
|
|
1996
1975
|
<dev:defaultValue>None</dev:defaultValue>
|
|
1997
1976
|
</command:parameter>
|
|
1998
|
-
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="
|
|
1999
|
-
<maml:name>
|
|
1977
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf">
|
|
1978
|
+
<maml:name>Confirm</maml:name>
|
|
2000
1979
|
<maml:description>
|
|
2001
|
-
<maml:para>
|
|
1980
|
+
<maml:para>Prompts you for confirmation before running the cmdlet.</maml:para>
|
|
2002
1981
|
</maml:description>
|
|
2003
1982
|
<dev:type>
|
|
2004
1983
|
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
@@ -2006,10 +1985,10 @@ TestEnvironment TestRMEndpoint TestADEndpoint/</dev:code>
|
|
|
2006
1985
|
</dev:type>
|
|
2007
1986
|
<dev:defaultValue>False</dev:defaultValue>
|
|
2008
1987
|
</command:parameter>
|
|
2009
|
-
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="
|
|
2010
|
-
<maml:name>
|
|
1988
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi">
|
|
1989
|
+
<maml:name>WhatIf</maml:name>
|
|
2011
1990
|
<maml:description>
|
|
2012
|
-
<maml:para>
|
|
1991
|
+
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
|
|
2013
1992
|
</maml:description>
|
|
2014
1993
|
<dev:type>
|
|
2015
1994
|
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
@@ -2017,36 +1996,566 @@ TestEnvironment TestRMEndpoint TestADEndpoint/</dev:code>
|
|
|
2017
1996
|
</dev:type>
|
|
2018
1997
|
<dev:defaultValue>False</dev:defaultValue>
|
|
2019
1998
|
</command:parameter>
|
|
2020
|
-
|
|
2021
|
-
|
|
2022
|
-
|
|
2023
|
-
|
|
2024
|
-
|
|
2025
|
-
|
|
2026
|
-
<
|
|
2027
|
-
|
|
2028
|
-
|
|
2029
|
-
|
|
2030
|
-
<
|
|
2031
|
-
|
|
2032
|
-
|
|
2033
|
-
|
|
2034
|
-
|
|
2035
|
-
|
|
2036
|
-
|
|
2037
|
-
|
|
2038
|
-
<
|
|
2039
|
-
|
|
2040
|
-
|
|
2041
|
-
|
|
2042
|
-
</
|
|
2043
|
-
<
|
|
2044
|
-
</
|
|
2045
|
-
<
|
|
2046
|
-
|
|
2047
|
-
|
|
2048
|
-
|
|
2049
|
-
|
|
1999
|
+
</command:syntaxItem>
|
|
2000
|
+
</command:syntax>
|
|
2001
|
+
<command:parameters>
|
|
2002
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzContext, AzureRmContext, AzureCredential">
|
|
2003
|
+
<maml:name>DefaultProfile</maml:name>
|
|
2004
|
+
<maml:description>
|
|
2005
|
+
<maml:para>The credentials, tenant and subscription used for communication with azure</maml:para>
|
|
2006
|
+
</maml:description>
|
|
2007
|
+
<command:parameterValue required="true" variableLength="false">Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer</command:parameterValue>
|
|
2008
|
+
<dev:type>
|
|
2009
|
+
<maml:name>Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer</maml:name>
|
|
2010
|
+
<maml:uri />
|
|
2011
|
+
</dev:type>
|
|
2012
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
2013
|
+
</command:parameter>
|
|
2014
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
2015
|
+
<maml:name>Force</maml:name>
|
|
2016
|
+
<maml:description>
|
|
2017
|
+
<maml:para>Delete all users and groups from the global scope without prompting</maml:para>
|
|
2018
|
+
</maml:description>
|
|
2019
|
+
<command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue>
|
|
2020
|
+
<dev:type>
|
|
2021
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
2022
|
+
<maml:uri />
|
|
2023
|
+
</dev:type>
|
|
2024
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
2025
|
+
</command:parameter>
|
|
2026
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
2027
|
+
<maml:name>PassThru</maml:name>
|
|
2028
|
+
<maml:description>
|
|
2029
|
+
<maml:para>Return a value indicating success or failure</maml:para>
|
|
2030
|
+
</maml:description>
|
|
2031
|
+
<command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue>
|
|
2032
|
+
<dev:type>
|
|
2033
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
2034
|
+
<maml:uri />
|
|
2035
|
+
</dev:type>
|
|
2036
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
2037
|
+
</command:parameter>
|
|
2038
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
2039
|
+
<maml:name>Scope</maml:name>
|
|
2040
|
+
<maml:description>
|
|
2041
|
+
<maml:para>Clear the context only for the current PowerShell session, or for all sessions.</maml:para>
|
|
2042
|
+
</maml:description>
|
|
2043
|
+
<command:parameterValue required="true" variableLength="false">Microsoft.Azure.Commands.Profile.Common.ContextModificationScope</command:parameterValue>
|
|
2044
|
+
<dev:type>
|
|
2045
|
+
<maml:name>Microsoft.Azure.Commands.Profile.Common.ContextModificationScope</maml:name>
|
|
2046
|
+
<maml:uri />
|
|
2047
|
+
</dev:type>
|
|
2048
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
2049
|
+
</command:parameter>
|
|
2050
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf">
|
|
2051
|
+
<maml:name>Confirm</maml:name>
|
|
2052
|
+
<maml:description>
|
|
2053
|
+
<maml:para>Prompts you for confirmation before running the cmdlet.</maml:para>
|
|
2054
|
+
</maml:description>
|
|
2055
|
+
<command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue>
|
|
2056
|
+
<dev:type>
|
|
2057
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
2058
|
+
<maml:uri />
|
|
2059
|
+
</dev:type>
|
|
2060
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
2061
|
+
</command:parameter>
|
|
2062
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi">
|
|
2063
|
+
<maml:name>WhatIf</maml:name>
|
|
2064
|
+
<maml:description>
|
|
2065
|
+
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
|
|
2066
|
+
</maml:description>
|
|
2067
|
+
<command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue>
|
|
2068
|
+
<dev:type>
|
|
2069
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
2070
|
+
<maml:uri />
|
|
2071
|
+
</dev:type>
|
|
2072
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
2073
|
+
</command:parameter>
|
|
2074
|
+
</command:parameters>
|
|
2075
|
+
<command:inputTypes>
|
|
2076
|
+
<command:inputType>
|
|
2077
|
+
<dev:type>
|
|
2078
|
+
<maml:name>None</maml:name>
|
|
2079
|
+
</dev:type>
|
|
2080
|
+
<maml:description>
|
|
2081
|
+
<maml:para></maml:para>
|
|
2082
|
+
</maml:description>
|
|
2083
|
+
</command:inputType>
|
|
2084
|
+
</command:inputTypes>
|
|
2085
|
+
<command:returnValues>
|
|
2086
|
+
<command:returnValue>
|
|
2087
|
+
<dev:type>
|
|
2088
|
+
<maml:name>System.Boolean</maml:name>
|
|
2089
|
+
</dev:type>
|
|
2090
|
+
<maml:description>
|
|
2091
|
+
<maml:para></maml:para>
|
|
2092
|
+
</maml:description>
|
|
2093
|
+
</command:returnValue>
|
|
2094
|
+
</command:returnValues>
|
|
2095
|
+
<maml:alertSet>
|
|
2096
|
+
<maml:alert>
|
|
2097
|
+
<maml:para></maml:para>
|
|
2098
|
+
</maml:alert>
|
|
2099
|
+
</maml:alertSet>
|
|
2100
|
+
<command:examples>
|
|
2101
|
+
<command:example>
|
|
2102
|
+
<maml:title>--------------- Example 1: Clear global context ---------------</maml:title>
|
|
2103
|
+
<dev:code>Clear-AzContext -Scope CurrentUser</dev:code>
|
|
2104
|
+
<dev:remarks>
|
|
2105
|
+
<maml:para>Remove all account, subscription, and credential information for any powershell session.</maml:para>
|
|
2106
|
+
<maml:para></maml:para>
|
|
2107
|
+
<maml:para></maml:para>
|
|
2108
|
+
</dev:remarks>
|
|
2109
|
+
</command:example>
|
|
2110
|
+
</command:examples>
|
|
2111
|
+
<command:relatedLinks>
|
|
2112
|
+
<maml:navigationLink>
|
|
2113
|
+
<maml:linkText>Online Version:</maml:linkText>
|
|
2114
|
+
<maml:uri>https://learn.microsoft.com/powershell/module/az.accounts/clear-azcontext</maml:uri>
|
|
2115
|
+
</maml:navigationLink>
|
|
2116
|
+
</command:relatedLinks>
|
|
2117
|
+
</command:command>
|
|
2118
|
+
<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">
|
|
2119
|
+
<command:details>
|
|
2120
|
+
<command:name>Clear-AzDefault</command:name>
|
|
2121
|
+
<command:verb>Clear</command:verb>
|
|
2122
|
+
<command:noun>AzDefault</command:noun>
|
|
2123
|
+
<maml:description>
|
|
2124
|
+
<maml:para>Clears the defaults set by the user in the current context.</maml:para>
|
|
2125
|
+
</maml:description>
|
|
2126
|
+
</command:details>
|
|
2127
|
+
<maml:description>
|
|
2128
|
+
<maml:para>The Clear-AzDefault cmdlet removes the defaults set by the user depending on the switch parameters specified by the user.</maml:para>
|
|
2129
|
+
</maml:description>
|
|
2130
|
+
<command:syntax>
|
|
2131
|
+
<command:syntaxItem>
|
|
2132
|
+
<maml:name>Clear-AzDefault</maml:name>
|
|
2133
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzContext, AzureRmContext, AzureCredential">
|
|
2134
|
+
<maml:name>DefaultProfile</maml:name>
|
|
2135
|
+
<maml:description>
|
|
2136
|
+
<maml:para>The credentials, account, tenant, and subscription used for communication with azure.</maml:para>
|
|
2137
|
+
</maml:description>
|
|
2138
|
+
<command:parameterValue required="true" variableLength="false">Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer</command:parameterValue>
|
|
2139
|
+
<dev:type>
|
|
2140
|
+
<maml:name>Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer</maml:name>
|
|
2141
|
+
<maml:uri />
|
|
2142
|
+
</dev:type>
|
|
2143
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
2144
|
+
</command:parameter>
|
|
2145
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
2146
|
+
<maml:name>Force</maml:name>
|
|
2147
|
+
<maml:description>
|
|
2148
|
+
<maml:para>Remove all defaults if no default is specified</maml:para>
|
|
2149
|
+
</maml:description>
|
|
2150
|
+
<dev:type>
|
|
2151
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
2152
|
+
<maml:uri />
|
|
2153
|
+
</dev:type>
|
|
2154
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
2155
|
+
</command:parameter>
|
|
2156
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
2157
|
+
<maml:name>PassThru</maml:name>
|
|
2158
|
+
<maml:description>
|
|
2159
|
+
<maml:para>{{Fill PassThru Description}}</maml:para>
|
|
2160
|
+
</maml:description>
|
|
2161
|
+
<dev:type>
|
|
2162
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
2163
|
+
<maml:uri />
|
|
2164
|
+
</dev:type>
|
|
2165
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
2166
|
+
</command:parameter>
|
|
2167
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
|
|
2168
|
+
<maml:name>ResourceGroup</maml:name>
|
|
2169
|
+
<maml:description>
|
|
2170
|
+
<maml:para>Clear Default Resource Group</maml:para>
|
|
2171
|
+
</maml:description>
|
|
2172
|
+
<dev:type>
|
|
2173
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
2174
|
+
<maml:uri />
|
|
2175
|
+
</dev:type>
|
|
2176
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
2177
|
+
</command:parameter>
|
|
2178
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
2179
|
+
<maml:name>Scope</maml:name>
|
|
2180
|
+
<maml:description>
|
|
2181
|
+
<maml:para>Determines the scope of context changes, for example, whether changes apply only to the current process, or to all sessions started by this user.</maml:para>
|
|
2182
|
+
</maml:description>
|
|
2183
|
+
<command:parameterValueGroup>
|
|
2184
|
+
<command:parameterValue required="false" command:variableLength="false">Process</command:parameterValue>
|
|
2185
|
+
<command:parameterValue required="false" command:variableLength="false">CurrentUser</command:parameterValue>
|
|
2186
|
+
</command:parameterValueGroup>
|
|
2187
|
+
<command:parameterValue required="true" variableLength="false">Microsoft.Azure.Commands.Profile.Common.ContextModificationScope</command:parameterValue>
|
|
2188
|
+
<dev:type>
|
|
2189
|
+
<maml:name>Microsoft.Azure.Commands.Profile.Common.ContextModificationScope</maml:name>
|
|
2190
|
+
<maml:uri />
|
|
2191
|
+
</dev:type>
|
|
2192
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
2193
|
+
</command:parameter>
|
|
2194
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf">
|
|
2195
|
+
<maml:name>Confirm</maml:name>
|
|
2196
|
+
<maml:description>
|
|
2197
|
+
<maml:para>Prompts you for confirmation before running the cmdlet.</maml:para>
|
|
2198
|
+
</maml:description>
|
|
2199
|
+
<dev:type>
|
|
2200
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
2201
|
+
<maml:uri />
|
|
2202
|
+
</dev:type>
|
|
2203
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
2204
|
+
</command:parameter>
|
|
2205
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi">
|
|
2206
|
+
<maml:name>WhatIf</maml:name>
|
|
2207
|
+
<maml:description>
|
|
2208
|
+
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
|
|
2209
|
+
</maml:description>
|
|
2210
|
+
<dev:type>
|
|
2211
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
2212
|
+
<maml:uri />
|
|
2213
|
+
</dev:type>
|
|
2214
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
2215
|
+
</command:parameter>
|
|
2216
|
+
</command:syntaxItem>
|
|
2217
|
+
</command:syntax>
|
|
2218
|
+
<command:parameters>
|
|
2219
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzContext, AzureRmContext, AzureCredential">
|
|
2220
|
+
<maml:name>DefaultProfile</maml:name>
|
|
2221
|
+
<maml:description>
|
|
2222
|
+
<maml:para>The credentials, account, tenant, and subscription used for communication with azure.</maml:para>
|
|
2223
|
+
</maml:description>
|
|
2224
|
+
<command:parameterValue required="true" variableLength="false">Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer</command:parameterValue>
|
|
2225
|
+
<dev:type>
|
|
2226
|
+
<maml:name>Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer</maml:name>
|
|
2227
|
+
<maml:uri />
|
|
2228
|
+
</dev:type>
|
|
2229
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
2230
|
+
</command:parameter>
|
|
2231
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
2232
|
+
<maml:name>Force</maml:name>
|
|
2233
|
+
<maml:description>
|
|
2234
|
+
<maml:para>Remove all defaults if no default is specified</maml:para>
|
|
2235
|
+
</maml:description>
|
|
2236
|
+
<command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue>
|
|
2237
|
+
<dev:type>
|
|
2238
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
2239
|
+
<maml:uri />
|
|
2240
|
+
</dev:type>
|
|
2241
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
2242
|
+
</command:parameter>
|
|
2243
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
2244
|
+
<maml:name>PassThru</maml:name>
|
|
2245
|
+
<maml:description>
|
|
2246
|
+
<maml:para>{{Fill PassThru Description}}</maml:para>
|
|
2247
|
+
</maml:description>
|
|
2248
|
+
<command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue>
|
|
2249
|
+
<dev:type>
|
|
2250
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
2251
|
+
<maml:uri />
|
|
2252
|
+
</dev:type>
|
|
2253
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
2254
|
+
</command:parameter>
|
|
2255
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
|
|
2256
|
+
<maml:name>ResourceGroup</maml:name>
|
|
2257
|
+
<maml:description>
|
|
2258
|
+
<maml:para>Clear Default Resource Group</maml:para>
|
|
2259
|
+
</maml:description>
|
|
2260
|
+
<command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue>
|
|
2261
|
+
<dev:type>
|
|
2262
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
2263
|
+
<maml:uri />
|
|
2264
|
+
</dev:type>
|
|
2265
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
2266
|
+
</command:parameter>
|
|
2267
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
2268
|
+
<maml:name>Scope</maml:name>
|
|
2269
|
+
<maml:description>
|
|
2270
|
+
<maml:para>Determines the scope of context changes, for example, whether changes apply only to the current process, or to all sessions started by this user.</maml:para>
|
|
2271
|
+
</maml:description>
|
|
2272
|
+
<command:parameterValue required="true" variableLength="false">Microsoft.Azure.Commands.Profile.Common.ContextModificationScope</command:parameterValue>
|
|
2273
|
+
<dev:type>
|
|
2274
|
+
<maml:name>Microsoft.Azure.Commands.Profile.Common.ContextModificationScope</maml:name>
|
|
2275
|
+
<maml:uri />
|
|
2276
|
+
</dev:type>
|
|
2277
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
2278
|
+
</command:parameter>
|
|
2279
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf">
|
|
2280
|
+
<maml:name>Confirm</maml:name>
|
|
2281
|
+
<maml:description>
|
|
2282
|
+
<maml:para>Prompts you for confirmation before running the cmdlet.</maml:para>
|
|
2283
|
+
</maml:description>
|
|
2284
|
+
<command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue>
|
|
2285
|
+
<dev:type>
|
|
2286
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
2287
|
+
<maml:uri />
|
|
2288
|
+
</dev:type>
|
|
2289
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
2290
|
+
</command:parameter>
|
|
2291
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi">
|
|
2292
|
+
<maml:name>WhatIf</maml:name>
|
|
2293
|
+
<maml:description>
|
|
2294
|
+
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
|
|
2295
|
+
</maml:description>
|
|
2296
|
+
<command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue>
|
|
2297
|
+
<dev:type>
|
|
2298
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
2299
|
+
<maml:uri />
|
|
2300
|
+
</dev:type>
|
|
2301
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
2302
|
+
</command:parameter>
|
|
2303
|
+
</command:parameters>
|
|
2304
|
+
<command:inputTypes>
|
|
2305
|
+
<command:inputType>
|
|
2306
|
+
<dev:type>
|
|
2307
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
2308
|
+
</dev:type>
|
|
2309
|
+
<maml:description>
|
|
2310
|
+
<maml:para></maml:para>
|
|
2311
|
+
</maml:description>
|
|
2312
|
+
</command:inputType>
|
|
2313
|
+
</command:inputTypes>
|
|
2314
|
+
<command:returnValues>
|
|
2315
|
+
<command:returnValue>
|
|
2316
|
+
<dev:type>
|
|
2317
|
+
<maml:name>System.Boolean</maml:name>
|
|
2318
|
+
</dev:type>
|
|
2319
|
+
<maml:description>
|
|
2320
|
+
<maml:para></maml:para>
|
|
2321
|
+
</maml:description>
|
|
2322
|
+
</command:returnValue>
|
|
2323
|
+
</command:returnValues>
|
|
2324
|
+
<maml:alertSet>
|
|
2325
|
+
<maml:alert>
|
|
2326
|
+
<maml:para></maml:para>
|
|
2327
|
+
</maml:alert>
|
|
2328
|
+
</maml:alertSet>
|
|
2329
|
+
<command:examples>
|
|
2330
|
+
<command:example>
|
|
2331
|
+
<maml:title>-------------------------- Example 1 --------------------------</maml:title>
|
|
2332
|
+
<dev:code>Clear-AzDefault</dev:code>
|
|
2333
|
+
<dev:remarks>
|
|
2334
|
+
<maml:para>This command removes all the defaults set by the user in the current context.</maml:para>
|
|
2335
|
+
<maml:para></maml:para>
|
|
2336
|
+
<maml:para></maml:para>
|
|
2337
|
+
</dev:remarks>
|
|
2338
|
+
</command:example>
|
|
2339
|
+
<command:example>
|
|
2340
|
+
<maml:title>-------------------------- Example 2 --------------------------</maml:title>
|
|
2341
|
+
<dev:code>Clear-AzDefault -ResourceGroup</dev:code>
|
|
2342
|
+
<dev:remarks>
|
|
2343
|
+
<maml:para>This command removes the default resource group set by the user in the current context.</maml:para>
|
|
2344
|
+
<maml:para></maml:para>
|
|
2345
|
+
<maml:para></maml:para>
|
|
2346
|
+
</dev:remarks>
|
|
2347
|
+
</command:example>
|
|
2348
|
+
</command:examples>
|
|
2349
|
+
<command:relatedLinks>
|
|
2350
|
+
<maml:navigationLink>
|
|
2351
|
+
<maml:linkText>Online Version:</maml:linkText>
|
|
2352
|
+
<maml:uri>https://learn.microsoft.com/powershell/module/az.accounts/clear-azdefault</maml:uri>
|
|
2353
|
+
</maml:navigationLink>
|
|
2354
|
+
</command:relatedLinks>
|
|
2355
|
+
</command:command>
|
|
2356
|
+
<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">
|
|
2357
|
+
<command:details>
|
|
2358
|
+
<command:name>Connect-AzAccount</command:name>
|
|
2359
|
+
<command:verb>Connect</command:verb>
|
|
2360
|
+
<command:noun>AzAccount</command:noun>
|
|
2361
|
+
<maml:description>
|
|
2362
|
+
<maml:para>Connect to Azure with an authenticated account for use with cmdlets from the Az PowerShell modules.</maml:para>
|
|
2363
|
+
</maml:description>
|
|
2364
|
+
</command:details>
|
|
2365
|
+
<maml:description>
|
|
2366
|
+
<maml:para>The `Connect-AzAccount` cmdlet connects to Azure with an authenticated account for use with cmdlets from the Az PowerShell modules. You can use this authenticated account only with Azure Resource Manager requests. To add an authenticated account for use with Service Management, use the `Add-AzureAccount` cmdlet from the Azure PowerShell module. If no context is found for the current user, the user's context list is populated with a context for each of their first 25 subscriptions. The list of contexts created for the user can be found by running `Get-AzContext -ListAvailable`. To skip this context population, specify the SkipContextPopulation switch parameter. After executing this cmdlet, you can disconnect from an Azure account using `Disconnect-AzAccount`.</maml:para>
|
|
2367
|
+
</maml:description>
|
|
2368
|
+
<command:syntax>
|
|
2369
|
+
<command:syntaxItem>
|
|
2370
|
+
<maml:name>Connect-AzAccount</maml:name>
|
|
2371
|
+
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
2372
|
+
<maml:name>AccessToken</maml:name>
|
|
2373
|
+
<maml:description>
|
|
2374
|
+
<maml:para>Specifies an access token.</maml:para>
|
|
2375
|
+
<maml:para>> [!CAUTION] > Access tokens are a type of credential. You should take the appropriate security precautions to > keep them confidential. Access tokens also timeout and may prevent long running tasks from > completing.</maml:para>
|
|
2376
|
+
</maml:description>
|
|
2377
|
+
<command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
|
|
2378
|
+
<dev:type>
|
|
2379
|
+
<maml:name>System.String</maml:name>
|
|
2380
|
+
<maml:uri />
|
|
2381
|
+
</dev:type>
|
|
2382
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
2383
|
+
</command:parameter>
|
|
2384
|
+
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
2385
|
+
<maml:name>AccountId</maml:name>
|
|
2386
|
+
<maml:description>
|
|
2387
|
+
<maml:para>Account Id / User Id / User Name to login with in Default (UserWithSubscriptionId) parameter set; Account ID for access token in AccessToken parameter set; Account ID for managed service in ManagedService parameter set. Can be a managed service resource ID, or the associated client ID. To use the system assigned identity, leave this field blank.</maml:para>
|
|
2388
|
+
</maml:description>
|
|
2389
|
+
<command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
|
|
2390
|
+
<dev:type>
|
|
2391
|
+
<maml:name>System.String</maml:name>
|
|
2392
|
+
<maml:uri />
|
|
2393
|
+
</dev:type>
|
|
2394
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
2395
|
+
</command:parameter>
|
|
2396
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
2397
|
+
<maml:name>ContextName</maml:name>
|
|
2398
|
+
<maml:description>
|
|
2399
|
+
<maml:para>Name of the default Azure context for this login. For more information about Azure contexts, see Azure PowerShell context objects (/powershell/azure/context-persistence).</maml:para>
|
|
2400
|
+
</maml:description>
|
|
2401
|
+
<command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
|
|
2402
|
+
<dev:type>
|
|
2403
|
+
<maml:name>System.String</maml:name>
|
|
2404
|
+
<maml:uri />
|
|
2405
|
+
</dev:type>
|
|
2406
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
2407
|
+
</command:parameter>
|
|
2408
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzContext, AzureRmContext, AzureCredential">
|
|
2409
|
+
<maml:name>DefaultProfile</maml:name>
|
|
2410
|
+
<maml:description>
|
|
2411
|
+
<maml:para>The credentials, account, tenant, and subscription used for communication with Azure.</maml:para>
|
|
2412
|
+
</maml:description>
|
|
2413
|
+
<command:parameterValue required="true" variableLength="false">Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer</command:parameterValue>
|
|
2414
|
+
<dev:type>
|
|
2415
|
+
<maml:name>Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer</maml:name>
|
|
2416
|
+
<maml:uri />
|
|
2417
|
+
</dev:type>
|
|
2418
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
2419
|
+
</command:parameter>
|
|
2420
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="EnvironmentName">
|
|
2421
|
+
<maml:name>Environment</maml:name>
|
|
2422
|
+
<maml:description>
|
|
2423
|
+
<maml:para>Environment containing the Azure account.</maml:para>
|
|
2424
|
+
</maml:description>
|
|
2425
|
+
<command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
|
|
2426
|
+
<dev:type>
|
|
2427
|
+
<maml:name>System.String</maml:name>
|
|
2428
|
+
<maml:uri />
|
|
2429
|
+
</dev:type>
|
|
2430
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
2431
|
+
</command:parameter>
|
|
2432
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
2433
|
+
<maml:name>Force</maml:name>
|
|
2434
|
+
<maml:description>
|
|
2435
|
+
<maml:para>Overwrite the existing context with the same name without prompting.</maml:para>
|
|
2436
|
+
</maml:description>
|
|
2437
|
+
<dev:type>
|
|
2438
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
2439
|
+
<maml:uri />
|
|
2440
|
+
</dev:type>
|
|
2441
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
2442
|
+
</command:parameter>
|
|
2443
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
2444
|
+
<maml:name>GraphAccessToken</maml:name>
|
|
2445
|
+
<maml:description>
|
|
2446
|
+
<maml:para>AccessToken for Graph Service.</maml:para>
|
|
2447
|
+
</maml:description>
|
|
2448
|
+
<command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
|
|
2449
|
+
<dev:type>
|
|
2450
|
+
<maml:name>System.String</maml:name>
|
|
2451
|
+
<maml:uri />
|
|
2452
|
+
</dev:type>
|
|
2453
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
2454
|
+
</command:parameter>
|
|
2455
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
2456
|
+
<maml:name>KeyVaultAccessToken</maml:name>
|
|
2457
|
+
<maml:description>
|
|
2458
|
+
<maml:para>AccessToken for KeyVault Service.</maml:para>
|
|
2459
|
+
</maml:description>
|
|
2460
|
+
<command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
|
|
2461
|
+
<dev:type>
|
|
2462
|
+
<maml:name>System.String</maml:name>
|
|
2463
|
+
<maml:uri />
|
|
2464
|
+
</dev:type>
|
|
2465
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
2466
|
+
</command:parameter>
|
|
2467
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
2468
|
+
<maml:name>MaxContextPopulation</maml:name>
|
|
2469
|
+
<maml:description>
|
|
2470
|
+
<maml:para>Max subscription number to populate contexts after login. Default is 25. To populate all subscriptions to contexts, set to -1.</maml:para>
|
|
2471
|
+
</maml:description>
|
|
2472
|
+
<command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue>
|
|
2473
|
+
<dev:type>
|
|
2474
|
+
<maml:name>System.Int32</maml:name>
|
|
2475
|
+
<maml:uri />
|
|
2476
|
+
</dev:type>
|
|
2477
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
2478
|
+
</command:parameter>
|
|
2479
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
2480
|
+
<maml:name>MicrosoftGraphAccessToken</maml:name>
|
|
2481
|
+
<maml:description>
|
|
2482
|
+
<maml:para>Access token to Microsoft Graph</maml:para>
|
|
2483
|
+
</maml:description>
|
|
2484
|
+
<command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
|
|
2485
|
+
<dev:type>
|
|
2486
|
+
<maml:name>System.String</maml:name>
|
|
2487
|
+
<maml:uri />
|
|
2488
|
+
</dev:type>
|
|
2489
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
2490
|
+
</command:parameter>
|
|
2491
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
2492
|
+
<maml:name>Scope</maml:name>
|
|
2493
|
+
<maml:description>
|
|
2494
|
+
<maml:para>Determines the scope of context changes, for example, whether changes apply only to the current process, or to all sessions started by this user.</maml:para>
|
|
2495
|
+
</maml:description>
|
|
2496
|
+
<command:parameterValueGroup>
|
|
2497
|
+
<command:parameterValue required="false" command:variableLength="false">Process</command:parameterValue>
|
|
2498
|
+
<command:parameterValue required="false" command:variableLength="false">CurrentUser</command:parameterValue>
|
|
2499
|
+
</command:parameterValueGroup>
|
|
2500
|
+
<command:parameterValue required="true" variableLength="false">Microsoft.Azure.Commands.Profile.Common.ContextModificationScope</command:parameterValue>
|
|
2501
|
+
<dev:type>
|
|
2502
|
+
<maml:name>Microsoft.Azure.Commands.Profile.Common.ContextModificationScope</maml:name>
|
|
2503
|
+
<maml:uri />
|
|
2504
|
+
</dev:type>
|
|
2505
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
2506
|
+
</command:parameter>
|
|
2507
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
2508
|
+
<maml:name>SkipContextPopulation</maml:name>
|
|
2509
|
+
<maml:description>
|
|
2510
|
+
<maml:para>Skips context population if no contexts are found.</maml:para>
|
|
2511
|
+
</maml:description>
|
|
2512
|
+
<dev:type>
|
|
2513
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
2514
|
+
<maml:uri />
|
|
2515
|
+
</dev:type>
|
|
2516
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
2517
|
+
</command:parameter>
|
|
2518
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
2519
|
+
<maml:name>SkipValidation</maml:name>
|
|
2520
|
+
<maml:description>
|
|
2521
|
+
<maml:para>Skip validation for access token.</maml:para>
|
|
2522
|
+
</maml:description>
|
|
2523
|
+
<dev:type>
|
|
2524
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
2525
|
+
<maml:uri />
|
|
2526
|
+
</dev:type>
|
|
2527
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
2528
|
+
</command:parameter>
|
|
2529
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="SubscriptionName, SubscriptionId">
|
|
2530
|
+
<maml:name>Subscription</maml:name>
|
|
2531
|
+
<maml:description>
|
|
2532
|
+
<maml:para>Subscription Name or ID.</maml:para>
|
|
2533
|
+
</maml:description>
|
|
2534
|
+
<command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
|
|
2535
|
+
<dev:type>
|
|
2536
|
+
<maml:name>System.String</maml:name>
|
|
2537
|
+
<maml:uri />
|
|
2538
|
+
</dev:type>
|
|
2539
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
2540
|
+
</command:parameter>
|
|
2541
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Domain, TenantId">
|
|
2542
|
+
<maml:name>Tenant</maml:name>
|
|
2543
|
+
<maml:description>
|
|
2544
|
+
<maml:para>Optional tenant name or ID.</maml:para>
|
|
2545
|
+
<maml:para>> [!NOTE] > Due to limitations of the current API, you must use a tenant ID instead of a tenant name when > connecting with a business-to-business (B2B) account.</maml:para>
|
|
2546
|
+
</maml:description>
|
|
2547
|
+
<command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
|
|
2548
|
+
<dev:type>
|
|
2549
|
+
<maml:name>System.String</maml:name>
|
|
2550
|
+
<maml:uri />
|
|
2551
|
+
</dev:type>
|
|
2552
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
2553
|
+
</command:parameter>
|
|
2554
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf">
|
|
2555
|
+
<maml:name>Confirm</maml:name>
|
|
2556
|
+
<maml:description>
|
|
2557
|
+
<maml:para>Prompts you for confirmation before running the cmdlet.</maml:para>
|
|
2558
|
+
</maml:description>
|
|
2050
2559
|
<dev:type>
|
|
2051
2560
|
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
2052
2561
|
<maml:uri />
|
|
@@ -3695,7 +4204,10 @@ azureuser@contoso.com Subscription1 xxxx-xxxx-xxxx-xxxx AzureCloud</dev:
|
|
|
3695
4204
|
</command:example>
|
|
3696
4205
|
<command:example>
|
|
3697
4206
|
<maml:title> Example 3: Connect to Azure using a service principal account </maml:title>
|
|
3698
|
-
<dev:code>$
|
|
4207
|
+
<dev:code>$SecurePassword = ConvertTo-SecureString -String "Password123!" -AsPlainText -Force
|
|
4208
|
+
$TenantId = 'yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyy'
|
|
4209
|
+
$ApplicationId = 'zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzz'
|
|
4210
|
+
$Credential = New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $ApplicationId, $SecurePassword
|
|
3699
4211
|
Connect-AzAccount -ServicePrincipal -TenantId $TenantId -Credential $Credential
|
|
3700
4212
|
|
|
3701
4213
|
Account SubscriptionName TenantId Environment
|
|
@@ -3723,6 +4235,7 @@ azureuser@contoso.com Subscription1 xxxx-xxxx-xxxx-xxxx AzureCloud</dev:
|
|
|
3723
4235
|
<command:example>
|
|
3724
4236
|
<maml:title>----- Example 5: Connect using a Managed Service Identity -----</maml:title>
|
|
3725
4237
|
<dev:code>Connect-AzAccount -Identity
|
|
4238
|
+
Set-AzContext -Subscription Subscription1
|
|
3726
4239
|
|
|
3727
4240
|
Account SubscriptionName TenantId Environment
|
|
3728
4241
|
------- ---------------- -------- -----------
|
|
@@ -3785,11 +4298,25 @@ yyyy-yyyy-yyyy-yyyy Subscription1 xxxx-xxxx-xxxx-xxxx AzureCloud</dev:
|
|
|
3785
4298
|
</command:example>
|
|
3786
4299
|
<command:example>
|
|
3787
4300
|
<maml:title>---------- Example 9: Connect using certificate file ----------</maml:title>
|
|
3788
|
-
<dev:code>$
|
|
4301
|
+
<dev:code>$SecurePassword = ConvertTo-SecureString -String "Password123!" -AsPlainText -Force
|
|
3789
4302
|
$TenantId = 'yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyy'
|
|
3790
4303
|
$ApplicationId = 'zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzz'
|
|
3791
4304
|
Connect-AzAccount -ServicePrincipal -ApplicationId $ApplicationId -TenantId $TenantId -CertificatePath './certificatefortest.pfx' -CertificatePassword $securePassword
|
|
3792
4305
|
|
|
4306
|
+
Account SubscriptionName TenantId Environment
|
|
4307
|
+
------- ---------------- -------- -----------
|
|
4308
|
+
xxxxxxxx-xxxx-xxxx-xxxxxxxx Subscription1 yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyy AzureCloud</dev:code>
|
|
4309
|
+
<dev:remarks>
|
|
4310
|
+
<maml:para></maml:para>
|
|
4311
|
+
<maml:para></maml:para>
|
|
4312
|
+
<maml:para></maml:para>
|
|
4313
|
+
</dev:remarks>
|
|
4314
|
+
</command:example>
|
|
4315
|
+
<command:example>
|
|
4316
|
+
<maml:title>--------- Example 10: Connect interactively using WAM ---------</maml:title>
|
|
4317
|
+
<dev:code>Update-AzConfig -EnableLoginByWam $true
|
|
4318
|
+
Connect-AzAccount
|
|
4319
|
+
|
|
3793
4320
|
Account SubscriptionName TenantId Environment
|
|
3794
4321
|
------- ---------------- -------- -----------
|
|
3795
4322
|
xxxxxxxx-xxxx-xxxx-xxxxxxxx Subscription1 yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyy AzureCloud</dev:code>
|
|
@@ -3961,8 +4488,7 @@ xxxxxxxx-xxxx-xxxx-xxxxxxxx Subscription1 yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyy Azu
|
|
|
3961
4488
|
</command:example>
|
|
3962
4489
|
<command:example>
|
|
3963
4490
|
<maml:title>-------------------------- Example 2 --------------------------</maml:title>
|
|
3964
|
-
<dev:code
|
|
3965
|
-
Disable-AzContextAutosave -Scope Process</dev:code>
|
|
4491
|
+
<dev:code>Disable-AzContextAutosave -Scope Process</dev:code>
|
|
3966
4492
|
<dev:remarks>
|
|
3967
4493
|
<maml:para></maml:para>
|
|
3968
4494
|
<maml:para></maml:para>
|
|
@@ -4345,14 +4871,91 @@ Disable-AzContextAutosave -Scope Process</dev:code>
|
|
|
4345
4871
|
<command:syntax>
|
|
4346
4872
|
<command:syntaxItem>
|
|
4347
4873
|
<maml:name>Disconnect-AzAccount</maml:name>
|
|
4348
|
-
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="SPN, ServicePrincipal">
|
|
4349
|
-
<maml:name>ApplicationId</maml:name>
|
|
4874
|
+
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="SPN, ServicePrincipal">
|
|
4875
|
+
<maml:name>ApplicationId</maml:name>
|
|
4876
|
+
<maml:description>
|
|
4877
|
+
<maml:para>ServicePrincipal id (globally unique id)</maml:para>
|
|
4878
|
+
</maml:description>
|
|
4879
|
+
<command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
|
|
4880
|
+
<dev:type>
|
|
4881
|
+
<maml:name>System.String</maml:name>
|
|
4882
|
+
<maml:uri />
|
|
4883
|
+
</dev:type>
|
|
4884
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
4885
|
+
</command:parameter>
|
|
4886
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzContext, AzureRmContext, AzureCredential">
|
|
4887
|
+
<maml:name>DefaultProfile</maml:name>
|
|
4888
|
+
<maml:description>
|
|
4889
|
+
<maml:para>The credentials, tenant and subscription used for communication with azure</maml:para>
|
|
4890
|
+
</maml:description>
|
|
4891
|
+
<command:parameterValue required="true" variableLength="false">Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer</command:parameterValue>
|
|
4892
|
+
<dev:type>
|
|
4893
|
+
<maml:name>Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer</maml:name>
|
|
4894
|
+
<maml:uri />
|
|
4895
|
+
</dev:type>
|
|
4896
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
4897
|
+
</command:parameter>
|
|
4898
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
4899
|
+
<maml:name>Scope</maml:name>
|
|
4900
|
+
<maml:description>
|
|
4901
|
+
<maml:para>Determines the scope of context changes, for example, whether changes apply only to the current process, or to all sessions started by this user.</maml:para>
|
|
4902
|
+
</maml:description>
|
|
4903
|
+
<command:parameterValueGroup>
|
|
4904
|
+
<command:parameterValue required="false" command:variableLength="false">Process</command:parameterValue>
|
|
4905
|
+
<command:parameterValue required="false" command:variableLength="false">CurrentUser</command:parameterValue>
|
|
4906
|
+
</command:parameterValueGroup>
|
|
4907
|
+
<command:parameterValue required="true" variableLength="false">Microsoft.Azure.Commands.Profile.Common.ContextModificationScope</command:parameterValue>
|
|
4908
|
+
<dev:type>
|
|
4909
|
+
<maml:name>Microsoft.Azure.Commands.Profile.Common.ContextModificationScope</maml:name>
|
|
4910
|
+
<maml:uri />
|
|
4911
|
+
</dev:type>
|
|
4912
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
4913
|
+
</command:parameter>
|
|
4914
|
+
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
4915
|
+
<maml:name>TenantId</maml:name>
|
|
4916
|
+
<maml:description>
|
|
4917
|
+
<maml:para>Tenant id (globally unique id)</maml:para>
|
|
4918
|
+
</maml:description>
|
|
4919
|
+
<command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
|
|
4920
|
+
<dev:type>
|
|
4921
|
+
<maml:name>System.String</maml:name>
|
|
4922
|
+
<maml:uri />
|
|
4923
|
+
</dev:type>
|
|
4924
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
4925
|
+
</command:parameter>
|
|
4926
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf">
|
|
4927
|
+
<maml:name>Confirm</maml:name>
|
|
4928
|
+
<maml:description>
|
|
4929
|
+
<maml:para>Prompts you for confirmation before running the cmdlet.</maml:para>
|
|
4930
|
+
</maml:description>
|
|
4931
|
+
<dev:type>
|
|
4932
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
4933
|
+
<maml:uri />
|
|
4934
|
+
</dev:type>
|
|
4935
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
4936
|
+
</command:parameter>
|
|
4937
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi">
|
|
4938
|
+
<maml:name>WhatIf</maml:name>
|
|
4939
|
+
<maml:description>
|
|
4940
|
+
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not executed.</maml:para>
|
|
4941
|
+
</maml:description>
|
|
4942
|
+
<dev:type>
|
|
4943
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
4944
|
+
<maml:uri />
|
|
4945
|
+
</dev:type>
|
|
4946
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
4947
|
+
</command:parameter>
|
|
4948
|
+
</command:syntaxItem>
|
|
4949
|
+
<command:syntaxItem>
|
|
4950
|
+
<maml:name>Disconnect-AzAccount</maml:name>
|
|
4951
|
+
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none">
|
|
4952
|
+
<maml:name>AzureContext</maml:name>
|
|
4350
4953
|
<maml:description>
|
|
4351
|
-
<maml:para>
|
|
4954
|
+
<maml:para>Context</maml:para>
|
|
4352
4955
|
</maml:description>
|
|
4353
|
-
<command:parameterValue required="true" variableLength="false">
|
|
4956
|
+
<command:parameterValue required="true" variableLength="false">Microsoft.Azure.Commands.Profile.Models.Core.PSAzureContext</command:parameterValue>
|
|
4354
4957
|
<dev:type>
|
|
4355
|
-
<maml:name>
|
|
4958
|
+
<maml:name>Microsoft.Azure.Commands.Profile.Models.Core.PSAzureContext</maml:name>
|
|
4356
4959
|
<maml:uri />
|
|
4357
4960
|
</dev:type>
|
|
4358
4961
|
<dev:defaultValue>None</dev:defaultValue>
|
|
@@ -4385,10 +4988,35 @@ Disable-AzContextAutosave -Scope Process</dev:code>
|
|
|
4385
4988
|
</dev:type>
|
|
4386
4989
|
<dev:defaultValue>None</dev:defaultValue>
|
|
4387
4990
|
</command:parameter>
|
|
4388
|
-
<command:parameter required="
|
|
4389
|
-
<maml:name>
|
|
4991
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf">
|
|
4992
|
+
<maml:name>Confirm</maml:name>
|
|
4390
4993
|
<maml:description>
|
|
4391
|
-
<maml:para>
|
|
4994
|
+
<maml:para>Prompts you for confirmation before running the cmdlet.</maml:para>
|
|
4995
|
+
</maml:description>
|
|
4996
|
+
<dev:type>
|
|
4997
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
4998
|
+
<maml:uri />
|
|
4999
|
+
</dev:type>
|
|
5000
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
5001
|
+
</command:parameter>
|
|
5002
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi">
|
|
5003
|
+
<maml:name>WhatIf</maml:name>
|
|
5004
|
+
<maml:description>
|
|
5005
|
+
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not executed.</maml:para>
|
|
5006
|
+
</maml:description>
|
|
5007
|
+
<dev:type>
|
|
5008
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
5009
|
+
<maml:uri />
|
|
5010
|
+
</dev:type>
|
|
5011
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
5012
|
+
</command:parameter>
|
|
5013
|
+
</command:syntaxItem>
|
|
5014
|
+
<command:syntaxItem>
|
|
5015
|
+
<maml:name>Disconnect-AzAccount</maml:name>
|
|
5016
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
5017
|
+
<maml:name>ContextName</maml:name>
|
|
5018
|
+
<maml:description>
|
|
5019
|
+
<maml:para>Name of the context to log out of</maml:para>
|
|
4392
5020
|
</maml:description>
|
|
4393
5021
|
<command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
|
|
4394
5022
|
<dev:type>
|
|
@@ -4397,6 +5025,34 @@ Disable-AzContextAutosave -Scope Process</dev:code>
|
|
|
4397
5025
|
</dev:type>
|
|
4398
5026
|
<dev:defaultValue>None</dev:defaultValue>
|
|
4399
5027
|
</command:parameter>
|
|
5028
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzContext, AzureRmContext, AzureCredential">
|
|
5029
|
+
<maml:name>DefaultProfile</maml:name>
|
|
5030
|
+
<maml:description>
|
|
5031
|
+
<maml:para>The credentials, tenant and subscription used for communication with azure</maml:para>
|
|
5032
|
+
</maml:description>
|
|
5033
|
+
<command:parameterValue required="true" variableLength="false">Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer</command:parameterValue>
|
|
5034
|
+
<dev:type>
|
|
5035
|
+
<maml:name>Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer</maml:name>
|
|
5036
|
+
<maml:uri />
|
|
5037
|
+
</dev:type>
|
|
5038
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
5039
|
+
</command:parameter>
|
|
5040
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
5041
|
+
<maml:name>Scope</maml:name>
|
|
5042
|
+
<maml:description>
|
|
5043
|
+
<maml:para>Determines the scope of context changes, for example, whether changes apply only to the current process, or to all sessions started by this user.</maml:para>
|
|
5044
|
+
</maml:description>
|
|
5045
|
+
<command:parameterValueGroup>
|
|
5046
|
+
<command:parameterValue required="false" command:variableLength="false">Process</command:parameterValue>
|
|
5047
|
+
<command:parameterValue required="false" command:variableLength="false">CurrentUser</command:parameterValue>
|
|
5048
|
+
</command:parameterValueGroup>
|
|
5049
|
+
<command:parameterValue required="true" variableLength="false">Microsoft.Azure.Commands.Profile.Common.ContextModificationScope</command:parameterValue>
|
|
5050
|
+
<dev:type>
|
|
5051
|
+
<maml:name>Microsoft.Azure.Commands.Profile.Common.ContextModificationScope</maml:name>
|
|
5052
|
+
<maml:uri />
|
|
5053
|
+
</dev:type>
|
|
5054
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
5055
|
+
</command:parameter>
|
|
4400
5056
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf">
|
|
4401
5057
|
<maml:name>Confirm</maml:name>
|
|
4402
5058
|
<maml:description>
|
|
@@ -4423,13 +5079,13 @@ Disable-AzContextAutosave -Scope Process</dev:code>
|
|
|
4423
5079
|
<command:syntaxItem>
|
|
4424
5080
|
<maml:name>Disconnect-AzAccount</maml:name>
|
|
4425
5081
|
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none">
|
|
4426
|
-
<maml:name>
|
|
5082
|
+
<maml:name>InputObject</maml:name>
|
|
4427
5083
|
<maml:description>
|
|
4428
|
-
<maml:para>
|
|
5084
|
+
<maml:para>The account object to remove</maml:para>
|
|
4429
5085
|
</maml:description>
|
|
4430
|
-
<command:parameterValue required="true" variableLength="false">Microsoft.Azure.Commands.Profile.Models.
|
|
5086
|
+
<command:parameterValue required="true" variableLength="false">Microsoft.Azure.Commands.Profile.Models.PSAzureRmAccount</command:parameterValue>
|
|
4431
5087
|
<dev:type>
|
|
4432
|
-
<maml:name>Microsoft.Azure.Commands.Profile.Models.
|
|
5088
|
+
<maml:name>Microsoft.Azure.Commands.Profile.Models.PSAzureRmAccount</maml:name>
|
|
4433
5089
|
<maml:uri />
|
|
4434
5090
|
</dev:type>
|
|
4435
5091
|
<dev:defaultValue>None</dev:defaultValue>
|
|
@@ -4487,10 +5143,10 @@ Disable-AzContextAutosave -Scope Process</dev:code>
|
|
|
4487
5143
|
</command:syntaxItem>
|
|
4488
5144
|
<command:syntaxItem>
|
|
4489
5145
|
<maml:name>Disconnect-AzAccount</maml:name>
|
|
4490
|
-
<command:parameter required="
|
|
4491
|
-
<maml:name>
|
|
5146
|
+
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="Id, UserId">
|
|
5147
|
+
<maml:name>Username</maml:name>
|
|
4492
5148
|
<maml:description>
|
|
4493
|
-
<maml:para>
|
|
5149
|
+
<maml:para>User name of the form 'user@contoso.org'</maml:para>
|
|
4494
5150
|
</maml:description>
|
|
4495
5151
|
<command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
|
|
4496
5152
|
<dev:type>
|
|
@@ -4550,24 +5206,218 @@ Disable-AzContextAutosave -Scope Process</dev:code>
|
|
|
4550
5206
|
<dev:defaultValue>False</dev:defaultValue>
|
|
4551
5207
|
</command:parameter>
|
|
4552
5208
|
</command:syntaxItem>
|
|
5209
|
+
</command:syntax>
|
|
5210
|
+
<command:parameters>
|
|
5211
|
+
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="SPN, ServicePrincipal">
|
|
5212
|
+
<maml:name>ApplicationId</maml:name>
|
|
5213
|
+
<maml:description>
|
|
5214
|
+
<maml:para>ServicePrincipal id (globally unique id)</maml:para>
|
|
5215
|
+
</maml:description>
|
|
5216
|
+
<command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
|
|
5217
|
+
<dev:type>
|
|
5218
|
+
<maml:name>System.String</maml:name>
|
|
5219
|
+
<maml:uri />
|
|
5220
|
+
</dev:type>
|
|
5221
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
5222
|
+
</command:parameter>
|
|
5223
|
+
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none">
|
|
5224
|
+
<maml:name>AzureContext</maml:name>
|
|
5225
|
+
<maml:description>
|
|
5226
|
+
<maml:para>Context</maml:para>
|
|
5227
|
+
</maml:description>
|
|
5228
|
+
<command:parameterValue required="true" variableLength="false">Microsoft.Azure.Commands.Profile.Models.Core.PSAzureContext</command:parameterValue>
|
|
5229
|
+
<dev:type>
|
|
5230
|
+
<maml:name>Microsoft.Azure.Commands.Profile.Models.Core.PSAzureContext</maml:name>
|
|
5231
|
+
<maml:uri />
|
|
5232
|
+
</dev:type>
|
|
5233
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
5234
|
+
</command:parameter>
|
|
5235
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
5236
|
+
<maml:name>ContextName</maml:name>
|
|
5237
|
+
<maml:description>
|
|
5238
|
+
<maml:para>Name of the context to log out of</maml:para>
|
|
5239
|
+
</maml:description>
|
|
5240
|
+
<command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
|
|
5241
|
+
<dev:type>
|
|
5242
|
+
<maml:name>System.String</maml:name>
|
|
5243
|
+
<maml:uri />
|
|
5244
|
+
</dev:type>
|
|
5245
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
5246
|
+
</command:parameter>
|
|
5247
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzContext, AzureRmContext, AzureCredential">
|
|
5248
|
+
<maml:name>DefaultProfile</maml:name>
|
|
5249
|
+
<maml:description>
|
|
5250
|
+
<maml:para>The credentials, tenant and subscription used for communication with azure</maml:para>
|
|
5251
|
+
</maml:description>
|
|
5252
|
+
<command:parameterValue required="true" variableLength="false">Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer</command:parameterValue>
|
|
5253
|
+
<dev:type>
|
|
5254
|
+
<maml:name>Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer</maml:name>
|
|
5255
|
+
<maml:uri />
|
|
5256
|
+
</dev:type>
|
|
5257
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
5258
|
+
</command:parameter>
|
|
5259
|
+
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none">
|
|
5260
|
+
<maml:name>InputObject</maml:name>
|
|
5261
|
+
<maml:description>
|
|
5262
|
+
<maml:para>The account object to remove</maml:para>
|
|
5263
|
+
</maml:description>
|
|
5264
|
+
<command:parameterValue required="true" variableLength="false">Microsoft.Azure.Commands.Profile.Models.PSAzureRmAccount</command:parameterValue>
|
|
5265
|
+
<dev:type>
|
|
5266
|
+
<maml:name>Microsoft.Azure.Commands.Profile.Models.PSAzureRmAccount</maml:name>
|
|
5267
|
+
<maml:uri />
|
|
5268
|
+
</dev:type>
|
|
5269
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
5270
|
+
</command:parameter>
|
|
5271
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
5272
|
+
<maml:name>Scope</maml:name>
|
|
5273
|
+
<maml:description>
|
|
5274
|
+
<maml:para>Determines the scope of context changes, for example, whether changes apply only to the current process, or to all sessions started by this user.</maml:para>
|
|
5275
|
+
</maml:description>
|
|
5276
|
+
<command:parameterValue required="true" variableLength="false">Microsoft.Azure.Commands.Profile.Common.ContextModificationScope</command:parameterValue>
|
|
5277
|
+
<dev:type>
|
|
5278
|
+
<maml:name>Microsoft.Azure.Commands.Profile.Common.ContextModificationScope</maml:name>
|
|
5279
|
+
<maml:uri />
|
|
5280
|
+
</dev:type>
|
|
5281
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
5282
|
+
</command:parameter>
|
|
5283
|
+
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
5284
|
+
<maml:name>TenantId</maml:name>
|
|
5285
|
+
<maml:description>
|
|
5286
|
+
<maml:para>Tenant id (globally unique id)</maml:para>
|
|
5287
|
+
</maml:description>
|
|
5288
|
+
<command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
|
|
5289
|
+
<dev:type>
|
|
5290
|
+
<maml:name>System.String</maml:name>
|
|
5291
|
+
<maml:uri />
|
|
5292
|
+
</dev:type>
|
|
5293
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
5294
|
+
</command:parameter>
|
|
5295
|
+
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="Id, UserId">
|
|
5296
|
+
<maml:name>Username</maml:name>
|
|
5297
|
+
<maml:description>
|
|
5298
|
+
<maml:para>User name of the form 'user@contoso.org'</maml:para>
|
|
5299
|
+
</maml:description>
|
|
5300
|
+
<command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
|
|
5301
|
+
<dev:type>
|
|
5302
|
+
<maml:name>System.String</maml:name>
|
|
5303
|
+
<maml:uri />
|
|
5304
|
+
</dev:type>
|
|
5305
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
5306
|
+
</command:parameter>
|
|
5307
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf">
|
|
5308
|
+
<maml:name>Confirm</maml:name>
|
|
5309
|
+
<maml:description>
|
|
5310
|
+
<maml:para>Prompts you for confirmation before running the cmdlet.</maml:para>
|
|
5311
|
+
</maml:description>
|
|
5312
|
+
<command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue>
|
|
5313
|
+
<dev:type>
|
|
5314
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
5315
|
+
<maml:uri />
|
|
5316
|
+
</dev:type>
|
|
5317
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
5318
|
+
</command:parameter>
|
|
5319
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi">
|
|
5320
|
+
<maml:name>WhatIf</maml:name>
|
|
5321
|
+
<maml:description>
|
|
5322
|
+
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not executed.</maml:para>
|
|
5323
|
+
</maml:description>
|
|
5324
|
+
<command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue>
|
|
5325
|
+
<dev:type>
|
|
5326
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
5327
|
+
<maml:uri />
|
|
5328
|
+
</dev:type>
|
|
5329
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
5330
|
+
</command:parameter>
|
|
5331
|
+
</command:parameters>
|
|
5332
|
+
<command:inputTypes>
|
|
5333
|
+
<command:inputType>
|
|
5334
|
+
<dev:type>
|
|
5335
|
+
<maml:name>Microsoft.Azure.Commands.Profile.Models.PSAzureRmAccount</maml:name>
|
|
5336
|
+
</dev:type>
|
|
5337
|
+
<maml:description>
|
|
5338
|
+
<maml:para></maml:para>
|
|
5339
|
+
</maml:description>
|
|
5340
|
+
</command:inputType>
|
|
5341
|
+
<command:inputType>
|
|
5342
|
+
<dev:type>
|
|
5343
|
+
<maml:name>Microsoft.Azure.Commands.Profile.Models.Core.PSAzureContext</maml:name>
|
|
5344
|
+
</dev:type>
|
|
5345
|
+
<maml:description>
|
|
5346
|
+
<maml:para></maml:para>
|
|
5347
|
+
</maml:description>
|
|
5348
|
+
</command:inputType>
|
|
5349
|
+
</command:inputTypes>
|
|
5350
|
+
<command:returnValues>
|
|
5351
|
+
<command:returnValue>
|
|
5352
|
+
<dev:type>
|
|
5353
|
+
<maml:name>Microsoft.Azure.Commands.Profile.Models.PSAzureRmAccount</maml:name>
|
|
5354
|
+
</dev:type>
|
|
5355
|
+
<maml:description>
|
|
5356
|
+
<maml:para></maml:para>
|
|
5357
|
+
</maml:description>
|
|
5358
|
+
</command:returnValue>
|
|
5359
|
+
</command:returnValues>
|
|
5360
|
+
<maml:alertSet>
|
|
5361
|
+
<maml:alert>
|
|
5362
|
+
<maml:para></maml:para>
|
|
5363
|
+
</maml:alert>
|
|
5364
|
+
</maml:alertSet>
|
|
5365
|
+
<command:examples>
|
|
5366
|
+
<command:example>
|
|
5367
|
+
<maml:title>----------- Example 1: Logout of the current account -----------</maml:title>
|
|
5368
|
+
<dev:code>Disconnect-AzAccount</dev:code>
|
|
5369
|
+
<dev:remarks>
|
|
5370
|
+
<maml:para>Logs out of the Azure account associated with the current context.</maml:para>
|
|
5371
|
+
<maml:para></maml:para>
|
|
5372
|
+
<maml:para></maml:para>
|
|
5373
|
+
</dev:remarks>
|
|
5374
|
+
</command:example>
|
|
5375
|
+
<command:example>
|
|
5376
|
+
<maml:title>Example 2: Logout of the account associated with a particular context</maml:title>
|
|
5377
|
+
<dev:code>Get-AzContext "Work" | Disconnect-AzAccount -Scope CurrentUser</dev:code>
|
|
5378
|
+
<dev:remarks>
|
|
5379
|
+
<maml:para>Logs out the account associated with the given context (named 'Work'). Because this uses the 'CurrentUser' scope, all credentials and contexts will be permanently deleted.</maml:para>
|
|
5380
|
+
<maml:para></maml:para>
|
|
5381
|
+
<maml:para></maml:para>
|
|
5382
|
+
</dev:remarks>
|
|
5383
|
+
</command:example>
|
|
5384
|
+
<command:example>
|
|
5385
|
+
<maml:title>------------- Example 3: Log out a particular user -------------</maml:title>
|
|
5386
|
+
<dev:code>Disconnect-AzAccount -Username 'user1@contoso.org'</dev:code>
|
|
5387
|
+
<dev:remarks>
|
|
5388
|
+
<maml:para>Logs out the 'user1@contoso.org' user - all credentials and all contexts associated with this user will be removed.</maml:para>
|
|
5389
|
+
<maml:para></maml:para>
|
|
5390
|
+
<maml:para></maml:para>
|
|
5391
|
+
</dev:remarks>
|
|
5392
|
+
</command:example>
|
|
5393
|
+
</command:examples>
|
|
5394
|
+
<command:relatedLinks>
|
|
5395
|
+
<maml:navigationLink>
|
|
5396
|
+
<maml:linkText>Online Version:</maml:linkText>
|
|
5397
|
+
<maml:uri>https://learn.microsoft.com/powershell/module/az.accounts/disconnect-azaccount</maml:uri>
|
|
5398
|
+
</maml:navigationLink>
|
|
5399
|
+
</command:relatedLinks>
|
|
5400
|
+
</command:command>
|
|
5401
|
+
<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">
|
|
5402
|
+
<command:details>
|
|
5403
|
+
<command:name>Enable-AzContextAutosave</command:name>
|
|
5404
|
+
<command:verb>Enable</command:verb>
|
|
5405
|
+
<command:noun>AzContextAutosave</command:noun>
|
|
5406
|
+
<maml:description>
|
|
5407
|
+
<maml:para>Azure contexts are PowerShell objects representing your active subscription to run commands against, and the authentication information needed to connect to an Azure cloud. With Azure contexts, Azure PowerShell doesn't need to reauthenticate your account each time you switch subscriptions. For more information, see Azure PowerShell context objects (https://learn.microsoft.com/powershell/azure/context-persistence).</maml:para>
|
|
5408
|
+
<maml:para>This cmdlet allows the Azure context information to be saved and automatically loaded when you start a PowerShell process. For example, when opening a new window.</maml:para>
|
|
5409
|
+
</maml:description>
|
|
5410
|
+
</command:details>
|
|
5411
|
+
<maml:description>
|
|
5412
|
+
<maml:para>Allows the Azure context information to be saved and automatically loaded when a PowerShell process starts. The context is saved at the end of the execution of any cmdlet that affects the context. For example, any profile cmdlet. If you're using user authentication, then tokens can be updated during the course of running any cmdlet.</maml:para>
|
|
5413
|
+
</maml:description>
|
|
5414
|
+
<command:syntax>
|
|
4553
5415
|
<command:syntaxItem>
|
|
4554
|
-
<maml:name>
|
|
4555
|
-
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none">
|
|
4556
|
-
<maml:name>InputObject</maml:name>
|
|
4557
|
-
<maml:description>
|
|
4558
|
-
<maml:para>The account object to remove</maml:para>
|
|
4559
|
-
</maml:description>
|
|
4560
|
-
<command:parameterValue required="true" variableLength="false">Microsoft.Azure.Commands.Profile.Models.PSAzureRmAccount</command:parameterValue>
|
|
4561
|
-
<dev:type>
|
|
4562
|
-
<maml:name>Microsoft.Azure.Commands.Profile.Models.PSAzureRmAccount</maml:name>
|
|
4563
|
-
<maml:uri />
|
|
4564
|
-
</dev:type>
|
|
4565
|
-
<dev:defaultValue>None</dev:defaultValue>
|
|
4566
|
-
</command:parameter>
|
|
5416
|
+
<maml:name>Enable-AzContextAutosave</maml:name>
|
|
4567
5417
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzContext, AzureRmContext, AzureCredential">
|
|
4568
5418
|
<maml:name>DefaultProfile</maml:name>
|
|
4569
5419
|
<maml:description>
|
|
4570
|
-
<maml:para>The credentials, tenant and subscription used for communication with
|
|
5420
|
+
<maml:para>The credentials, tenant, and subscription used for communication with Azure</maml:para>
|
|
4571
5421
|
</maml:description>
|
|
4572
5422
|
<command:parameterValue required="true" variableLength="false">Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer</command:parameterValue>
|
|
4573
5423
|
<dev:type>
|
|
@@ -4579,7 +5429,7 @@ Disable-AzContextAutosave -Scope Process</dev:code>
|
|
|
4579
5429
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
4580
5430
|
<maml:name>Scope</maml:name>
|
|
4581
5431
|
<maml:description>
|
|
4582
|
-
<maml:para>Determines the scope of context changes
|
|
5432
|
+
<maml:para>Determines the scope of context changes. For example, whether changes apply only to the current process, or to all sessions started by this user. Changes made with the scope `CurrentUser` will affect all PowerShell sessions started by the user. If a particular session needs to have different settings, use the scope `Process`.</maml:para>
|
|
4583
5433
|
</maml:description>
|
|
4584
5434
|
<command:parameterValueGroup>
|
|
4585
5435
|
<command:parameterValue required="false" command:variableLength="false">Process</command:parameterValue>
|
|
@@ -4590,7 +5440,7 @@ Disable-AzContextAutosave -Scope Process</dev:code>
|
|
|
4590
5440
|
<maml:name>Microsoft.Azure.Commands.Profile.Common.ContextModificationScope</maml:name>
|
|
4591
5441
|
<maml:uri />
|
|
4592
5442
|
</dev:type>
|
|
4593
|
-
<dev:defaultValue>
|
|
5443
|
+
<dev:defaultValue>CurrentUser</dev:defaultValue>
|
|
4594
5444
|
</command:parameter>
|
|
4595
5445
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf">
|
|
4596
5446
|
<maml:name>Confirm</maml:name>
|
|
@@ -4606,7 +5456,7 @@ Disable-AzContextAutosave -Scope Process</dev:code>
|
|
|
4606
5456
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi">
|
|
4607
5457
|
<maml:name>WhatIf</maml:name>
|
|
4608
5458
|
<maml:description>
|
|
4609
|
-
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet
|
|
5459
|
+
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet isn't run.</maml:para>
|
|
4610
5460
|
</maml:description>
|
|
4611
5461
|
<dev:type>
|
|
4612
5462
|
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
@@ -4615,24 +5465,128 @@ Disable-AzContextAutosave -Scope Process</dev:code>
|
|
|
4615
5465
|
<dev:defaultValue>False</dev:defaultValue>
|
|
4616
5466
|
</command:parameter>
|
|
4617
5467
|
</command:syntaxItem>
|
|
5468
|
+
</command:syntax>
|
|
5469
|
+
<command:parameters>
|
|
5470
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzContext, AzureRmContext, AzureCredential">
|
|
5471
|
+
<maml:name>DefaultProfile</maml:name>
|
|
5472
|
+
<maml:description>
|
|
5473
|
+
<maml:para>The credentials, tenant, and subscription used for communication with Azure</maml:para>
|
|
5474
|
+
</maml:description>
|
|
5475
|
+
<command:parameterValue required="true" variableLength="false">Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer</command:parameterValue>
|
|
5476
|
+
<dev:type>
|
|
5477
|
+
<maml:name>Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer</maml:name>
|
|
5478
|
+
<maml:uri />
|
|
5479
|
+
</dev:type>
|
|
5480
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
5481
|
+
</command:parameter>
|
|
5482
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
5483
|
+
<maml:name>Scope</maml:name>
|
|
5484
|
+
<maml:description>
|
|
5485
|
+
<maml:para>Determines the scope of context changes. For example, whether changes apply only to the current process, or to all sessions started by this user. Changes made with the scope `CurrentUser` will affect all PowerShell sessions started by the user. If a particular session needs to have different settings, use the scope `Process`.</maml:para>
|
|
5486
|
+
</maml:description>
|
|
5487
|
+
<command:parameterValue required="true" variableLength="false">Microsoft.Azure.Commands.Profile.Common.ContextModificationScope</command:parameterValue>
|
|
5488
|
+
<dev:type>
|
|
5489
|
+
<maml:name>Microsoft.Azure.Commands.Profile.Common.ContextModificationScope</maml:name>
|
|
5490
|
+
<maml:uri />
|
|
5491
|
+
</dev:type>
|
|
5492
|
+
<dev:defaultValue>CurrentUser</dev:defaultValue>
|
|
5493
|
+
</command:parameter>
|
|
5494
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf">
|
|
5495
|
+
<maml:name>Confirm</maml:name>
|
|
5496
|
+
<maml:description>
|
|
5497
|
+
<maml:para>Prompts you for confirmation before running the cmdlet.</maml:para>
|
|
5498
|
+
</maml:description>
|
|
5499
|
+
<command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue>
|
|
5500
|
+
<dev:type>
|
|
5501
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
5502
|
+
<maml:uri />
|
|
5503
|
+
</dev:type>
|
|
5504
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
5505
|
+
</command:parameter>
|
|
5506
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi">
|
|
5507
|
+
<maml:name>WhatIf</maml:name>
|
|
5508
|
+
<maml:description>
|
|
5509
|
+
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet isn't run.</maml:para>
|
|
5510
|
+
</maml:description>
|
|
5511
|
+
<command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue>
|
|
5512
|
+
<dev:type>
|
|
5513
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
5514
|
+
<maml:uri />
|
|
5515
|
+
</dev:type>
|
|
5516
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
5517
|
+
</command:parameter>
|
|
5518
|
+
</command:parameters>
|
|
5519
|
+
<command:inputTypes>
|
|
5520
|
+
<command:inputType>
|
|
5521
|
+
<dev:type>
|
|
5522
|
+
<maml:name>None</maml:name>
|
|
5523
|
+
</dev:type>
|
|
5524
|
+
<maml:description>
|
|
5525
|
+
<maml:para></maml:para>
|
|
5526
|
+
</maml:description>
|
|
5527
|
+
</command:inputType>
|
|
5528
|
+
</command:inputTypes>
|
|
5529
|
+
<command:returnValues>
|
|
5530
|
+
<command:returnValue>
|
|
5531
|
+
<dev:type>
|
|
5532
|
+
<maml:name>Microsoft.Azure.Commands.Common.Authentication.ContextAutosaveSettings</maml:name>
|
|
5533
|
+
</dev:type>
|
|
5534
|
+
<maml:description>
|
|
5535
|
+
<maml:para></maml:para>
|
|
5536
|
+
</maml:description>
|
|
5537
|
+
</command:returnValue>
|
|
5538
|
+
</command:returnValues>
|
|
5539
|
+
<maml:alertSet>
|
|
5540
|
+
<maml:alert>
|
|
5541
|
+
<maml:para></maml:para>
|
|
5542
|
+
</maml:alert>
|
|
5543
|
+
</maml:alertSet>
|
|
5544
|
+
<command:examples>
|
|
5545
|
+
<command:example>
|
|
5546
|
+
<maml:title> Example 1: Enable autosaving credentials for the current user </maml:title>
|
|
5547
|
+
<dev:code>Enable-AzContextAutosave</dev:code>
|
|
5548
|
+
<dev:remarks>
|
|
5549
|
+
<maml:para></maml:para>
|
|
5550
|
+
<maml:para></maml:para>
|
|
5551
|
+
<maml:para></maml:para>
|
|
5552
|
+
</dev:remarks>
|
|
5553
|
+
</command:example>
|
|
5554
|
+
<command:example>
|
|
5555
|
+
<maml:title>-------------------------- Example 2 --------------------------</maml:title>
|
|
5556
|
+
<dev:code>Enable-AzContextAutosave -Scope Process</dev:code>
|
|
5557
|
+
<dev:remarks>
|
|
5558
|
+
<maml:para></maml:para>
|
|
5559
|
+
<maml:para></maml:para>
|
|
5560
|
+
<maml:para></maml:para>
|
|
5561
|
+
</dev:remarks>
|
|
5562
|
+
</command:example>
|
|
5563
|
+
</command:examples>
|
|
5564
|
+
<command:relatedLinks>
|
|
5565
|
+
<maml:navigationLink>
|
|
5566
|
+
<maml:linkText>Online Version:</maml:linkText>
|
|
5567
|
+
<maml:uri>https://learn.microsoft.com/powershell/module/az.accounts/enable-azcontextautosave</maml:uri>
|
|
5568
|
+
</maml:navigationLink>
|
|
5569
|
+
</command:relatedLinks>
|
|
5570
|
+
</command:command>
|
|
5571
|
+
<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">
|
|
5572
|
+
<command:details>
|
|
5573
|
+
<command:name>Enable-AzDataCollection</command:name>
|
|
5574
|
+
<command:verb>Enable</command:verb>
|
|
5575
|
+
<command:noun>AzDataCollection</command:noun>
|
|
5576
|
+
<maml:description>
|
|
5577
|
+
<maml:para>Enables Azure PowerShell to collect data to improve the user experience with the Azure PowerShell cmdlets. Executing this cmdlet opts in to data collection for the current user on the current machine. Data is collected by default unless you explicitly opt out.</maml:para>
|
|
5578
|
+
</maml:description>
|
|
5579
|
+
</command:details>
|
|
5580
|
+
<maml:description>
|
|
5581
|
+
<maml:para>The `Enable-AzDataCollection` cmdlet is used to opt in to data collection. Azure PowerShell automatically collects telemetry data by default. Microsoft aggregates collected data to identify patterns of usage, to identify common issues, and to improve the experience of Azure PowerShell. Microsoft Azure PowerShell doesn't collect any private or personal data. To disable data collection, you must explicitly opt out by executing `Disable-AzDataCollection`.</maml:para>
|
|
5582
|
+
</maml:description>
|
|
5583
|
+
<command:syntax>
|
|
4618
5584
|
<command:syntaxItem>
|
|
4619
|
-
<maml:name>
|
|
4620
|
-
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="Id, UserId">
|
|
4621
|
-
<maml:name>Username</maml:name>
|
|
4622
|
-
<maml:description>
|
|
4623
|
-
<maml:para>User name of the form 'user@contoso.org'</maml:para>
|
|
4624
|
-
</maml:description>
|
|
4625
|
-
<command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
|
|
4626
|
-
<dev:type>
|
|
4627
|
-
<maml:name>System.String</maml:name>
|
|
4628
|
-
<maml:uri />
|
|
4629
|
-
</dev:type>
|
|
4630
|
-
<dev:defaultValue>None</dev:defaultValue>
|
|
4631
|
-
</command:parameter>
|
|
5585
|
+
<maml:name>Enable-AzDataCollection</maml:name>
|
|
4632
5586
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzContext, AzureRmContext, AzureCredential">
|
|
4633
5587
|
<maml:name>DefaultProfile</maml:name>
|
|
4634
5588
|
<maml:description>
|
|
4635
|
-
<maml:para>The credentials, tenant and subscription used for communication with
|
|
5589
|
+
<maml:para>The credentials, account, tenant, and subscription used for communication with Azure.</maml:para>
|
|
4636
5590
|
</maml:description>
|
|
4637
5591
|
<command:parameterValue required="true" variableLength="false">Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer</command:parameterValue>
|
|
4638
5592
|
<dev:type>
|
|
@@ -4641,22 +5595,6 @@ Disable-AzContextAutosave -Scope Process</dev:code>
|
|
|
4641
5595
|
</dev:type>
|
|
4642
5596
|
<dev:defaultValue>None</dev:defaultValue>
|
|
4643
5597
|
</command:parameter>
|
|
4644
|
-
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
4645
|
-
<maml:name>Scope</maml:name>
|
|
4646
|
-
<maml:description>
|
|
4647
|
-
<maml:para>Determines the scope of context changes, for example, whether changes apply only to the current process, or to all sessions started by this user.</maml:para>
|
|
4648
|
-
</maml:description>
|
|
4649
|
-
<command:parameterValueGroup>
|
|
4650
|
-
<command:parameterValue required="false" command:variableLength="false">Process</command:parameterValue>
|
|
4651
|
-
<command:parameterValue required="false" command:variableLength="false">CurrentUser</command:parameterValue>
|
|
4652
|
-
</command:parameterValueGroup>
|
|
4653
|
-
<command:parameterValue required="true" variableLength="false">Microsoft.Azure.Commands.Profile.Common.ContextModificationScope</command:parameterValue>
|
|
4654
|
-
<dev:type>
|
|
4655
|
-
<maml:name>Microsoft.Azure.Commands.Profile.Common.ContextModificationScope</maml:name>
|
|
4656
|
-
<maml:uri />
|
|
4657
|
-
</dev:type>
|
|
4658
|
-
<dev:defaultValue>None</dev:defaultValue>
|
|
4659
|
-
</command:parameter>
|
|
4660
5598
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf">
|
|
4661
5599
|
<maml:name>Confirm</maml:name>
|
|
4662
5600
|
<maml:description>
|
|
@@ -4671,7 +5609,7 @@ Disable-AzContextAutosave -Scope Process</dev:code>
|
|
|
4671
5609
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi">
|
|
4672
5610
|
<maml:name>WhatIf</maml:name>
|
|
4673
5611
|
<maml:description>
|
|
4674
|
-
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not
|
|
5612
|
+
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
|
|
4675
5613
|
</maml:description>
|
|
4676
5614
|
<dev:type>
|
|
4677
5615
|
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
@@ -4682,46 +5620,10 @@ Disable-AzContextAutosave -Scope Process</dev:code>
|
|
|
4682
5620
|
</command:syntaxItem>
|
|
4683
5621
|
</command:syntax>
|
|
4684
5622
|
<command:parameters>
|
|
4685
|
-
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="SPN, ServicePrincipal">
|
|
4686
|
-
<maml:name>ApplicationId</maml:name>
|
|
4687
|
-
<maml:description>
|
|
4688
|
-
<maml:para>ServicePrincipal id (globally unique id)</maml:para>
|
|
4689
|
-
</maml:description>
|
|
4690
|
-
<command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
|
|
4691
|
-
<dev:type>
|
|
4692
|
-
<maml:name>System.String</maml:name>
|
|
4693
|
-
<maml:uri />
|
|
4694
|
-
</dev:type>
|
|
4695
|
-
<dev:defaultValue>None</dev:defaultValue>
|
|
4696
|
-
</command:parameter>
|
|
4697
|
-
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none">
|
|
4698
|
-
<maml:name>AzureContext</maml:name>
|
|
4699
|
-
<maml:description>
|
|
4700
|
-
<maml:para>Context</maml:para>
|
|
4701
|
-
</maml:description>
|
|
4702
|
-
<command:parameterValue required="true" variableLength="false">Microsoft.Azure.Commands.Profile.Models.Core.PSAzureContext</command:parameterValue>
|
|
4703
|
-
<dev:type>
|
|
4704
|
-
<maml:name>Microsoft.Azure.Commands.Profile.Models.Core.PSAzureContext</maml:name>
|
|
4705
|
-
<maml:uri />
|
|
4706
|
-
</dev:type>
|
|
4707
|
-
<dev:defaultValue>None</dev:defaultValue>
|
|
4708
|
-
</command:parameter>
|
|
4709
|
-
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
4710
|
-
<maml:name>ContextName</maml:name>
|
|
4711
|
-
<maml:description>
|
|
4712
|
-
<maml:para>Name of the context to log out of</maml:para>
|
|
4713
|
-
</maml:description>
|
|
4714
|
-
<command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
|
|
4715
|
-
<dev:type>
|
|
4716
|
-
<maml:name>System.String</maml:name>
|
|
4717
|
-
<maml:uri />
|
|
4718
|
-
</dev:type>
|
|
4719
|
-
<dev:defaultValue>None</dev:defaultValue>
|
|
4720
|
-
</command:parameter>
|
|
4721
5623
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzContext, AzureRmContext, AzureCredential">
|
|
4722
5624
|
<maml:name>DefaultProfile</maml:name>
|
|
4723
5625
|
<maml:description>
|
|
4724
|
-
<maml:para>The credentials, tenant and subscription used for communication with
|
|
5626
|
+
<maml:para>The credentials, account, tenant, and subscription used for communication with Azure.</maml:para>
|
|
4725
5627
|
</maml:description>
|
|
4726
5628
|
<command:parameterValue required="true" variableLength="false">Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer</command:parameterValue>
|
|
4727
5629
|
<dev:type>
|
|
@@ -4730,54 +5632,6 @@ Disable-AzContextAutosave -Scope Process</dev:code>
|
|
|
4730
5632
|
</dev:type>
|
|
4731
5633
|
<dev:defaultValue>None</dev:defaultValue>
|
|
4732
5634
|
</command:parameter>
|
|
4733
|
-
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none">
|
|
4734
|
-
<maml:name>InputObject</maml:name>
|
|
4735
|
-
<maml:description>
|
|
4736
|
-
<maml:para>The account object to remove</maml:para>
|
|
4737
|
-
</maml:description>
|
|
4738
|
-
<command:parameterValue required="true" variableLength="false">Microsoft.Azure.Commands.Profile.Models.PSAzureRmAccount</command:parameterValue>
|
|
4739
|
-
<dev:type>
|
|
4740
|
-
<maml:name>Microsoft.Azure.Commands.Profile.Models.PSAzureRmAccount</maml:name>
|
|
4741
|
-
<maml:uri />
|
|
4742
|
-
</dev:type>
|
|
4743
|
-
<dev:defaultValue>None</dev:defaultValue>
|
|
4744
|
-
</command:parameter>
|
|
4745
|
-
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
4746
|
-
<maml:name>Scope</maml:name>
|
|
4747
|
-
<maml:description>
|
|
4748
|
-
<maml:para>Determines the scope of context changes, for example, whether changes apply only to the current process, or to all sessions started by this user.</maml:para>
|
|
4749
|
-
</maml:description>
|
|
4750
|
-
<command:parameterValue required="true" variableLength="false">Microsoft.Azure.Commands.Profile.Common.ContextModificationScope</command:parameterValue>
|
|
4751
|
-
<dev:type>
|
|
4752
|
-
<maml:name>Microsoft.Azure.Commands.Profile.Common.ContextModificationScope</maml:name>
|
|
4753
|
-
<maml:uri />
|
|
4754
|
-
</dev:type>
|
|
4755
|
-
<dev:defaultValue>None</dev:defaultValue>
|
|
4756
|
-
</command:parameter>
|
|
4757
|
-
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
4758
|
-
<maml:name>TenantId</maml:name>
|
|
4759
|
-
<maml:description>
|
|
4760
|
-
<maml:para>Tenant id (globally unique id)</maml:para>
|
|
4761
|
-
</maml:description>
|
|
4762
|
-
<command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
|
|
4763
|
-
<dev:type>
|
|
4764
|
-
<maml:name>System.String</maml:name>
|
|
4765
|
-
<maml:uri />
|
|
4766
|
-
</dev:type>
|
|
4767
|
-
<dev:defaultValue>None</dev:defaultValue>
|
|
4768
|
-
</command:parameter>
|
|
4769
|
-
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="Id, UserId">
|
|
4770
|
-
<maml:name>Username</maml:name>
|
|
4771
|
-
<maml:description>
|
|
4772
|
-
<maml:para>User name of the form 'user@contoso.org'</maml:para>
|
|
4773
|
-
</maml:description>
|
|
4774
|
-
<command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
|
|
4775
|
-
<dev:type>
|
|
4776
|
-
<maml:name>System.String</maml:name>
|
|
4777
|
-
<maml:uri />
|
|
4778
|
-
</dev:type>
|
|
4779
|
-
<dev:defaultValue>None</dev:defaultValue>
|
|
4780
|
-
</command:parameter>
|
|
4781
5635
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf">
|
|
4782
5636
|
<maml:name>Confirm</maml:name>
|
|
4783
5637
|
<maml:description>
|
|
@@ -4793,7 +5647,7 @@ Disable-AzContextAutosave -Scope Process</dev:code>
|
|
|
4793
5647
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi">
|
|
4794
5648
|
<maml:name>WhatIf</maml:name>
|
|
4795
5649
|
<maml:description>
|
|
4796
|
-
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not
|
|
5650
|
+
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
|
|
4797
5651
|
</maml:description>
|
|
4798
5652
|
<command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue>
|
|
4799
5653
|
<dev:type>
|
|
@@ -4806,15 +5660,7 @@ Disable-AzContextAutosave -Scope Process</dev:code>
|
|
|
4806
5660
|
<command:inputTypes>
|
|
4807
5661
|
<command:inputType>
|
|
4808
5662
|
<dev:type>
|
|
4809
|
-
<maml:name>
|
|
4810
|
-
</dev:type>
|
|
4811
|
-
<maml:description>
|
|
4812
|
-
<maml:para></maml:para>
|
|
4813
|
-
</maml:description>
|
|
4814
|
-
</command:inputType>
|
|
4815
|
-
<command:inputType>
|
|
4816
|
-
<dev:type>
|
|
4817
|
-
<maml:name>Microsoft.Azure.Commands.Profile.Models.Core.PSAzureContext</maml:name>
|
|
5663
|
+
<maml:name>None</maml:name>
|
|
4818
5664
|
</dev:type>
|
|
4819
5665
|
<maml:description>
|
|
4820
5666
|
<maml:para></maml:para>
|
|
@@ -4824,7 +5670,7 @@ Disable-AzContextAutosave -Scope Process</dev:code>
|
|
|
4824
5670
|
<command:returnValues>
|
|
4825
5671
|
<command:returnValue>
|
|
4826
5672
|
<dev:type>
|
|
4827
|
-
<maml:name>
|
|
5673
|
+
<maml:name>System.Void</maml:name>
|
|
4828
5674
|
</dev:type>
|
|
4829
5675
|
<maml:description>
|
|
4830
5676
|
<maml:para></maml:para>
|
|
@@ -4838,28 +5684,10 @@ Disable-AzContextAutosave -Scope Process</dev:code>
|
|
|
4838
5684
|
</maml:alertSet>
|
|
4839
5685
|
<command:examples>
|
|
4840
5686
|
<command:example>
|
|
4841
|
-
<maml:title
|
|
4842
|
-
<dev:code>
|
|
4843
|
-
<dev:remarks>
|
|
4844
|
-
<maml:para>Logs out of the Azure account associated with the current context.</maml:para>
|
|
4845
|
-
<maml:para></maml:para>
|
|
4846
|
-
<maml:para></maml:para>
|
|
4847
|
-
</dev:remarks>
|
|
4848
|
-
</command:example>
|
|
4849
|
-
<command:example>
|
|
4850
|
-
<maml:title>Example 2: Logout of the account associated with a particular context</maml:title>
|
|
4851
|
-
<dev:code>Get-AzContext "Work" | Disconnect-AzAccount -Scope CurrentUser</dev:code>
|
|
4852
|
-
<dev:remarks>
|
|
4853
|
-
<maml:para>Logs out the account associated with the given context (named 'Work'). Because this uses the 'CurrentUser' scope, all credentials and contexts will be permanently deleted.</maml:para>
|
|
4854
|
-
<maml:para></maml:para>
|
|
4855
|
-
<maml:para></maml:para>
|
|
4856
|
-
</dev:remarks>
|
|
4857
|
-
</command:example>
|
|
4858
|
-
<command:example>
|
|
4859
|
-
<maml:title>------------- Example 3: Log out a particular user -------------</maml:title>
|
|
4860
|
-
<dev:code>Disconnect-AzAccount -Username 'user1@contoso.org'</dev:code>
|
|
5687
|
+
<maml:title>--- Example 1: Enabling data collection for the current user ---</maml:title>
|
|
5688
|
+
<dev:code>Enable-AzDataCollection</dev:code>
|
|
4861
5689
|
<dev:remarks>
|
|
4862
|
-
<maml:para
|
|
5690
|
+
<maml:para></maml:para>
|
|
4863
5691
|
<maml:para></maml:para>
|
|
4864
5692
|
<maml:para></maml:para>
|
|
4865
5693
|
</dev:remarks>
|
|
@@ -4868,30 +5696,33 @@ Disable-AzContextAutosave -Scope Process</dev:code>
|
|
|
4868
5696
|
<command:relatedLinks>
|
|
4869
5697
|
<maml:navigationLink>
|
|
4870
5698
|
<maml:linkText>Online Version:</maml:linkText>
|
|
4871
|
-
<maml:uri>https://learn.microsoft.com/powershell/module/az.accounts/
|
|
5699
|
+
<maml:uri>https://learn.microsoft.com/powershell/module/az.accounts/enable-azdatacollection</maml:uri>
|
|
5700
|
+
</maml:navigationLink>
|
|
5701
|
+
<maml:navigationLink>
|
|
5702
|
+
<maml:linkText>Disable-AzDataCollection</maml:linkText>
|
|
5703
|
+
<maml:uri></maml:uri>
|
|
4872
5704
|
</maml:navigationLink>
|
|
4873
5705
|
</command:relatedLinks>
|
|
4874
5706
|
</command:command>
|
|
4875
5707
|
<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">
|
|
4876
5708
|
<command:details>
|
|
4877
|
-
<command:name>Enable-
|
|
5709
|
+
<command:name>Enable-AzureRmAlias</command:name>
|
|
4878
5710
|
<command:verb>Enable</command:verb>
|
|
4879
|
-
<command:noun>
|
|
5711
|
+
<command:noun>AzureRmAlias</command:noun>
|
|
4880
5712
|
<maml:description>
|
|
4881
|
-
<maml:para>
|
|
4882
|
-
<maml:para>This cmdlet allows the Azure context information to be saved and automatically loaded when you start a PowerShell process. For example, when opening a new window.</maml:para>
|
|
5713
|
+
<maml:para>Enables AzureRm prefix aliases for Az modules.</maml:para>
|
|
4883
5714
|
</maml:description>
|
|
4884
5715
|
</command:details>
|
|
4885
5716
|
<maml:description>
|
|
4886
|
-
<maml:para>
|
|
5717
|
+
<maml:para>Enables AzureRm prefix aliases for Az modules. If -Module is specified, only modules listed will have aliases enabled. Otherwise all AzureRm aliases are enabled.</maml:para>
|
|
4887
5718
|
</maml:description>
|
|
4888
5719
|
<command:syntax>
|
|
4889
5720
|
<command:syntaxItem>
|
|
4890
|
-
<maml:name>Enable-
|
|
5721
|
+
<maml:name>Enable-AzureRmAlias</maml:name>
|
|
4891
5722
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzContext, AzureRmContext, AzureCredential">
|
|
4892
5723
|
<maml:name>DefaultProfile</maml:name>
|
|
4893
5724
|
<maml:description>
|
|
4894
|
-
<maml:para>The credentials, tenant, and subscription used for communication with Azure
|
|
5725
|
+
<maml:para>The credentials, account, tenant, and subscription used for communication with Azure.</maml:para>
|
|
4895
5726
|
</maml:description>
|
|
4896
5727
|
<command:parameterValue required="true" variableLength="false">Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer</command:parameterValue>
|
|
4897
5728
|
<dev:type>
|
|
@@ -4900,21 +5731,46 @@ Disable-AzContextAutosave -Scope Process</dev:code>
|
|
|
4900
5731
|
</dev:type>
|
|
4901
5732
|
<dev:defaultValue>None</dev:defaultValue>
|
|
4902
5733
|
</command:parameter>
|
|
5734
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
5735
|
+
<maml:name>Module</maml:name>
|
|
5736
|
+
<maml:description>
|
|
5737
|
+
<maml:para>Indicates which modules to enable aliases for. If none are specified, default is all modules.</maml:para>
|
|
5738
|
+
</maml:description>
|
|
5739
|
+
<command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue>
|
|
5740
|
+
<dev:type>
|
|
5741
|
+
<maml:name>System.String[]</maml:name>
|
|
5742
|
+
<maml:uri />
|
|
5743
|
+
</dev:type>
|
|
5744
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
5745
|
+
</command:parameter>
|
|
5746
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
5747
|
+
<maml:name>PassThru</maml:name>
|
|
5748
|
+
<maml:description>
|
|
5749
|
+
<maml:para>If specified, cmdlet will return all aliases enabled</maml:para>
|
|
5750
|
+
</maml:description>
|
|
5751
|
+
<dev:type>
|
|
5752
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
5753
|
+
<maml:uri />
|
|
5754
|
+
</dev:type>
|
|
5755
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
5756
|
+
</command:parameter>
|
|
4903
5757
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
4904
5758
|
<maml:name>Scope</maml:name>
|
|
4905
5759
|
<maml:description>
|
|
4906
|
-
<maml:para>
|
|
5760
|
+
<maml:para>Indicates what scope aliases should be enabled for. Default is 'Local'</maml:para>
|
|
4907
5761
|
</maml:description>
|
|
4908
5762
|
<command:parameterValueGroup>
|
|
5763
|
+
<command:parameterValue required="false" command:variableLength="false">Local</command:parameterValue>
|
|
4909
5764
|
<command:parameterValue required="false" command:variableLength="false">Process</command:parameterValue>
|
|
4910
5765
|
<command:parameterValue required="false" command:variableLength="false">CurrentUser</command:parameterValue>
|
|
5766
|
+
<command:parameterValue required="false" command:variableLength="false">LocalMachine</command:parameterValue>
|
|
4911
5767
|
</command:parameterValueGroup>
|
|
4912
|
-
<command:parameterValue required="true" variableLength="false">
|
|
5768
|
+
<command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
|
|
4913
5769
|
<dev:type>
|
|
4914
|
-
<maml:name>
|
|
5770
|
+
<maml:name>System.String</maml:name>
|
|
4915
5771
|
<maml:uri />
|
|
4916
5772
|
</dev:type>
|
|
4917
|
-
<dev:defaultValue>
|
|
5773
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
4918
5774
|
</command:parameter>
|
|
4919
5775
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf">
|
|
4920
5776
|
<maml:name>Confirm</maml:name>
|
|
@@ -4930,7 +5786,7 @@ Disable-AzContextAutosave -Scope Process</dev:code>
|
|
|
4930
5786
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi">
|
|
4931
5787
|
<maml:name>WhatIf</maml:name>
|
|
4932
5788
|
<maml:description>
|
|
4933
|
-
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet
|
|
5789
|
+
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
|
|
4934
5790
|
</maml:description>
|
|
4935
5791
|
<dev:type>
|
|
4936
5792
|
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
@@ -4944,7 +5800,7 @@ Disable-AzContextAutosave -Scope Process</dev:code>
|
|
|
4944
5800
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzContext, AzureRmContext, AzureCredential">
|
|
4945
5801
|
<maml:name>DefaultProfile</maml:name>
|
|
4946
5802
|
<maml:description>
|
|
4947
|
-
<maml:para>The credentials, tenant, and subscription used for communication with Azure
|
|
5803
|
+
<maml:para>The credentials, account, tenant, and subscription used for communication with Azure.</maml:para>
|
|
4948
5804
|
</maml:description>
|
|
4949
5805
|
<command:parameterValue required="true" variableLength="false">Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer</command:parameterValue>
|
|
4950
5806
|
<dev:type>
|
|
@@ -4953,17 +5809,41 @@ Disable-AzContextAutosave -Scope Process</dev:code>
|
|
|
4953
5809
|
</dev:type>
|
|
4954
5810
|
<dev:defaultValue>None</dev:defaultValue>
|
|
4955
5811
|
</command:parameter>
|
|
5812
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
5813
|
+
<maml:name>Module</maml:name>
|
|
5814
|
+
<maml:description>
|
|
5815
|
+
<maml:para>Indicates which modules to enable aliases for. If none are specified, default is all modules.</maml:para>
|
|
5816
|
+
</maml:description>
|
|
5817
|
+
<command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue>
|
|
5818
|
+
<dev:type>
|
|
5819
|
+
<maml:name>System.String[]</maml:name>
|
|
5820
|
+
<maml:uri />
|
|
5821
|
+
</dev:type>
|
|
5822
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
5823
|
+
</command:parameter>
|
|
5824
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
5825
|
+
<maml:name>PassThru</maml:name>
|
|
5826
|
+
<maml:description>
|
|
5827
|
+
<maml:para>If specified, cmdlet will return all aliases enabled</maml:para>
|
|
5828
|
+
</maml:description>
|
|
5829
|
+
<command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue>
|
|
5830
|
+
<dev:type>
|
|
5831
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
5832
|
+
<maml:uri />
|
|
5833
|
+
</dev:type>
|
|
5834
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
5835
|
+
</command:parameter>
|
|
4956
5836
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
4957
5837
|
<maml:name>Scope</maml:name>
|
|
4958
5838
|
<maml:description>
|
|
4959
|
-
<maml:para>
|
|
5839
|
+
<maml:para>Indicates what scope aliases should be enabled for. Default is 'Local'</maml:para>
|
|
4960
5840
|
</maml:description>
|
|
4961
|
-
<command:parameterValue required="true" variableLength="false">
|
|
5841
|
+
<command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
|
|
4962
5842
|
<dev:type>
|
|
4963
|
-
<maml:name>
|
|
5843
|
+
<maml:name>System.String</maml:name>
|
|
4964
5844
|
<maml:uri />
|
|
4965
5845
|
</dev:type>
|
|
4966
|
-
<dev:defaultValue>
|
|
5846
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
4967
5847
|
</command:parameter>
|
|
4968
5848
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf">
|
|
4969
5849
|
<maml:name>Confirm</maml:name>
|
|
@@ -4980,7 +5860,7 @@ Disable-AzContextAutosave -Scope Process</dev:code>
|
|
|
4980
5860
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi">
|
|
4981
5861
|
<maml:name>WhatIf</maml:name>
|
|
4982
5862
|
<maml:description>
|
|
4983
|
-
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet
|
|
5863
|
+
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
|
|
4984
5864
|
</maml:description>
|
|
4985
5865
|
<command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue>
|
|
4986
5866
|
<dev:type>
|
|
@@ -5003,7 +5883,7 @@ Disable-AzContextAutosave -Scope Process</dev:code>
|
|
|
5003
5883
|
<command:returnValues>
|
|
5004
5884
|
<command:returnValue>
|
|
5005
5885
|
<dev:type>
|
|
5006
|
-
<maml:name>
|
|
5886
|
+
<maml:name>System.String</maml:name>
|
|
5007
5887
|
</dev:type>
|
|
5008
5888
|
<maml:description>
|
|
5009
5889
|
<maml:para></maml:para>
|
|
@@ -5017,20 +5897,19 @@ Disable-AzContextAutosave -Scope Process</dev:code>
|
|
|
5017
5897
|
</maml:alertSet>
|
|
5018
5898
|
<command:examples>
|
|
5019
5899
|
<command:example>
|
|
5020
|
-
<maml:title
|
|
5021
|
-
<dev:code>Enable-
|
|
5900
|
+
<maml:title>-------------------------- Example 1 --------------------------</maml:title>
|
|
5901
|
+
<dev:code>Enable-AzureRmAlias</dev:code>
|
|
5022
5902
|
<dev:remarks>
|
|
5023
|
-
<maml:para
|
|
5903
|
+
<maml:para>Enables all AzureRm prefixes for the current PowerShell session.</maml:para>
|
|
5024
5904
|
<maml:para></maml:para>
|
|
5025
5905
|
<maml:para></maml:para>
|
|
5026
5906
|
</dev:remarks>
|
|
5027
5907
|
</command:example>
|
|
5028
5908
|
<command:example>
|
|
5029
5909
|
<maml:title>-------------------------- Example 2 --------------------------</maml:title>
|
|
5030
|
-
<dev:code
|
|
5031
|
-
Enable-AzContextAutosave -Scope Process</dev:code>
|
|
5910
|
+
<dev:code>Enable-AzureRmAlias -Module Az.Accounts -Scope CurrentUser</dev:code>
|
|
5032
5911
|
<dev:remarks>
|
|
5033
|
-
<maml:para
|
|
5912
|
+
<maml:para>Enables AzureRm aliases for the Az.Accounts module for both the current process and for the current user.</maml:para>
|
|
5034
5913
|
<maml:para></maml:para>
|
|
5035
5914
|
<maml:para></maml:para>
|
|
5036
5915
|
</dev:remarks>
|
|
@@ -5039,25 +5918,37 @@ Enable-AzContextAutosave -Scope Process</dev:code>
|
|
|
5039
5918
|
<command:relatedLinks>
|
|
5040
5919
|
<maml:navigationLink>
|
|
5041
5920
|
<maml:linkText>Online Version:</maml:linkText>
|
|
5042
|
-
<maml:uri>https://learn.microsoft.com/powershell/module/az.accounts/enable-
|
|
5921
|
+
<maml:uri>https://learn.microsoft.com/powershell/module/az.accounts/enable-azurermalias</maml:uri>
|
|
5043
5922
|
</maml:navigationLink>
|
|
5044
5923
|
</command:relatedLinks>
|
|
5045
5924
|
</command:command>
|
|
5046
5925
|
<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">
|
|
5047
5926
|
<command:details>
|
|
5048
|
-
<command:name>
|
|
5049
|
-
<command:verb>
|
|
5050
|
-
<command:noun>
|
|
5927
|
+
<command:name>Export-AzConfig</command:name>
|
|
5928
|
+
<command:verb>Export</command:verb>
|
|
5929
|
+
<command:noun>AzConfig</command:noun>
|
|
5051
5930
|
<maml:description>
|
|
5052
|
-
<maml:para>
|
|
5931
|
+
<maml:para>Exports all the configs into a file so that it can be imported on another machine.</maml:para>
|
|
5053
5932
|
</maml:description>
|
|
5054
5933
|
</command:details>
|
|
5055
5934
|
<maml:description>
|
|
5056
|
-
<maml:para>The `
|
|
5935
|
+
<maml:para>The `Export-AzConfig` cmdlet exports all the configs that are set at the "CurrentUser" scope into a file at given path in JSON format. The file can then be imported by `Import-AzConfig` for example on another machine.</maml:para>
|
|
5057
5936
|
</maml:description>
|
|
5058
5937
|
<command:syntax>
|
|
5059
5938
|
<command:syntaxItem>
|
|
5060
|
-
<maml:name>
|
|
5939
|
+
<maml:name>Export-AzConfig</maml:name>
|
|
5940
|
+
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none">
|
|
5941
|
+
<maml:name>Path</maml:name>
|
|
5942
|
+
<maml:description>
|
|
5943
|
+
<maml:para>Specifies the path of the file to which to save the configs.</maml:para>
|
|
5944
|
+
</maml:description>
|
|
5945
|
+
<command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
|
|
5946
|
+
<dev:type>
|
|
5947
|
+
<maml:name>System.String</maml:name>
|
|
5948
|
+
<maml:uri />
|
|
5949
|
+
</dev:type>
|
|
5950
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
5951
|
+
</command:parameter>
|
|
5061
5952
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzContext, AzureRmContext, AzureCredential">
|
|
5062
5953
|
<maml:name>DefaultProfile</maml:name>
|
|
5063
5954
|
<maml:description>
|
|
@@ -5070,6 +5961,28 @@ Enable-AzContextAutosave -Scope Process</dev:code>
|
|
|
5070
5961
|
</dev:type>
|
|
5071
5962
|
<dev:defaultValue>None</dev:defaultValue>
|
|
5072
5963
|
</command:parameter>
|
|
5964
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
5965
|
+
<maml:name>Force</maml:name>
|
|
5966
|
+
<maml:description>
|
|
5967
|
+
<maml:para>Overwrites the given file if it exists.</maml:para>
|
|
5968
|
+
</maml:description>
|
|
5969
|
+
<dev:type>
|
|
5970
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
5971
|
+
<maml:uri />
|
|
5972
|
+
</dev:type>
|
|
5973
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
5974
|
+
</command:parameter>
|
|
5975
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
5976
|
+
<maml:name>PassThru</maml:name>
|
|
5977
|
+
<maml:description>
|
|
5978
|
+
<maml:para>Returns a boolean value indicating success or failure.</maml:para>
|
|
5979
|
+
</maml:description>
|
|
5980
|
+
<dev:type>
|
|
5981
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
5982
|
+
<maml:uri />
|
|
5983
|
+
</dev:type>
|
|
5984
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
5985
|
+
</command:parameter>
|
|
5073
5986
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf">
|
|
5074
5987
|
<maml:name>Confirm</maml:name>
|
|
5075
5988
|
<maml:description>
|
|
@@ -5098,11 +6011,47 @@ Enable-AzContextAutosave -Scope Process</dev:code>
|
|
|
5098
6011
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzContext, AzureRmContext, AzureCredential">
|
|
5099
6012
|
<maml:name>DefaultProfile</maml:name>
|
|
5100
6013
|
<maml:description>
|
|
5101
|
-
<maml:para>The credentials, account, tenant, and subscription used for communication with Azure.</maml:para>
|
|
6014
|
+
<maml:para>The credentials, account, tenant, and subscription used for communication with Azure.</maml:para>
|
|
6015
|
+
</maml:description>
|
|
6016
|
+
<command:parameterValue required="true" variableLength="false">Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer</command:parameterValue>
|
|
6017
|
+
<dev:type>
|
|
6018
|
+
<maml:name>Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer</maml:name>
|
|
6019
|
+
<maml:uri />
|
|
6020
|
+
</dev:type>
|
|
6021
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
6022
|
+
</command:parameter>
|
|
6023
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
6024
|
+
<maml:name>Force</maml:name>
|
|
6025
|
+
<maml:description>
|
|
6026
|
+
<maml:para>Overwrites the given file if it exists.</maml:para>
|
|
6027
|
+
</maml:description>
|
|
6028
|
+
<command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue>
|
|
6029
|
+
<dev:type>
|
|
6030
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
6031
|
+
<maml:uri />
|
|
6032
|
+
</dev:type>
|
|
6033
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
6034
|
+
</command:parameter>
|
|
6035
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
6036
|
+
<maml:name>PassThru</maml:name>
|
|
6037
|
+
<maml:description>
|
|
6038
|
+
<maml:para>Returns a boolean value indicating success or failure.</maml:para>
|
|
6039
|
+
</maml:description>
|
|
6040
|
+
<command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue>
|
|
6041
|
+
<dev:type>
|
|
6042
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
6043
|
+
<maml:uri />
|
|
6044
|
+
</dev:type>
|
|
6045
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
6046
|
+
</command:parameter>
|
|
6047
|
+
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none">
|
|
6048
|
+
<maml:name>Path</maml:name>
|
|
6049
|
+
<maml:description>
|
|
6050
|
+
<maml:para>Specifies the path of the file to which to save the configs.</maml:para>
|
|
5102
6051
|
</maml:description>
|
|
5103
|
-
<command:parameterValue required="true" variableLength="false">
|
|
6052
|
+
<command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
|
|
5104
6053
|
<dev:type>
|
|
5105
|
-
<maml:name>
|
|
6054
|
+
<maml:name>System.String</maml:name>
|
|
5106
6055
|
<maml:uri />
|
|
5107
6056
|
</dev:type>
|
|
5108
6057
|
<dev:defaultValue>None</dev:defaultValue>
|
|
@@ -5145,7 +6094,7 @@ Enable-AzContextAutosave -Scope Process</dev:code>
|
|
|
5145
6094
|
<command:returnValues>
|
|
5146
6095
|
<command:returnValue>
|
|
5147
6096
|
<dev:type>
|
|
5148
|
-
<maml:name>System.
|
|
6097
|
+
<maml:name>System.Boolean</maml:name>
|
|
5149
6098
|
</dev:type>
|
|
5150
6099
|
<maml:description>
|
|
5151
6100
|
<maml:para></maml:para>
|
|
@@ -5159,10 +6108,10 @@ Enable-AzContextAutosave -Scope Process</dev:code>
|
|
|
5159
6108
|
</maml:alertSet>
|
|
5160
6109
|
<command:examples>
|
|
5161
6110
|
<command:example>
|
|
5162
|
-
<maml:title
|
|
5163
|
-
<dev:code>
|
|
6111
|
+
<maml:title>-------------------------- Example 1 --------------------------</maml:title>
|
|
6112
|
+
<dev:code>Export-AzConfig -Path ./config.json</dev:code>
|
|
5164
6113
|
<dev:remarks>
|
|
5165
|
-
<maml:para
|
|
6114
|
+
<maml:para>This example exports the configs to `./config.json` file which can later be imported via `Import-AzConfig`.</maml:para>
|
|
5166
6115
|
<maml:para></maml:para>
|
|
5167
6116
|
<maml:para></maml:para>
|
|
5168
6117
|
</dev:remarks>
|
|
@@ -5171,103 +6120,103 @@ Enable-AzContextAutosave -Scope Process</dev:code>
|
|
|
5171
6120
|
<command:relatedLinks>
|
|
5172
6121
|
<maml:navigationLink>
|
|
5173
6122
|
<maml:linkText>Online Version:</maml:linkText>
|
|
5174
|
-
<maml:uri>https://learn.microsoft.com/powershell/module/az.accounts/
|
|
6123
|
+
<maml:uri>https://learn.microsoft.com/powershell/module/az.accounts/export-azconfig</maml:uri>
|
|
5175
6124
|
</maml:navigationLink>
|
|
5176
6125
|
<maml:navigationLink>
|
|
5177
|
-
<maml:linkText>
|
|
6126
|
+
<maml:linkText>Import-AzConfig</maml:linkText>
|
|
5178
6127
|
<maml:uri></maml:uri>
|
|
5179
6128
|
</maml:navigationLink>
|
|
5180
6129
|
</command:relatedLinks>
|
|
5181
6130
|
</command:command>
|
|
5182
6131
|
<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">
|
|
5183
6132
|
<command:details>
|
|
5184
|
-
<command:name>
|
|
5185
|
-
<command:verb>
|
|
5186
|
-
<command:noun>
|
|
6133
|
+
<command:name>Get-AzAccessToken</command:name>
|
|
6134
|
+
<command:verb>Get</command:verb>
|
|
6135
|
+
<command:noun>AzAccessToken</command:noun>
|
|
5187
6136
|
<maml:description>
|
|
5188
|
-
<maml:para>
|
|
6137
|
+
<maml:para>Get raw access token. When using -ResourceUrl, please make sure the value does match current Azure environment. You may refer to the value of `(Get-AzContext).Environment`.</maml:para>
|
|
5189
6138
|
</maml:description>
|
|
5190
6139
|
</command:details>
|
|
5191
6140
|
<maml:description>
|
|
5192
|
-
<maml:para>
|
|
6141
|
+
<maml:para>Get access token</maml:para>
|
|
5193
6142
|
</maml:description>
|
|
5194
6143
|
<command:syntax>
|
|
5195
6144
|
<command:syntaxItem>
|
|
5196
|
-
<maml:name>
|
|
6145
|
+
<maml:name>Get-AzAccessToken</maml:name>
|
|
5197
6146
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzContext, AzureRmContext, AzureCredential">
|
|
5198
6147
|
<maml:name>DefaultProfile</maml:name>
|
|
5199
6148
|
<maml:description>
|
|
5200
6149
|
<maml:para>The credentials, account, tenant, and subscription used for communication with Azure.</maml:para>
|
|
5201
6150
|
</maml:description>
|
|
5202
|
-
<command:parameterValue required="true" variableLength="false">
|
|
6151
|
+
<command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue>
|
|
5203
6152
|
<dev:type>
|
|
5204
|
-
<maml:name>
|
|
6153
|
+
<maml:name>IAzureContextContainer</maml:name>
|
|
5205
6154
|
<maml:uri />
|
|
5206
6155
|
</dev:type>
|
|
5207
6156
|
<dev:defaultValue>None</dev:defaultValue>
|
|
5208
6157
|
</command:parameter>
|
|
5209
6158
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
5210
|
-
<maml:name>
|
|
6159
|
+
<maml:name>ResourceTypeName</maml:name>
|
|
5211
6160
|
<maml:description>
|
|
5212
|
-
<maml:para>
|
|
6161
|
+
<maml:para>Optional resource type name, supported values: AadGraph, AnalysisServices, AppConfiguration, Arm, Attestation, Batch, DataLake, KeyVault, MSGraph, OperationalInsights, ResourceManager, Storage, Synapse. Default value is Arm if not specified.</maml:para>
|
|
5213
6162
|
</maml:description>
|
|
5214
|
-
<command:parameterValue required="true" variableLength="false">
|
|
6163
|
+
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
|
|
5215
6164
|
<dev:type>
|
|
5216
|
-
<maml:name>
|
|
6165
|
+
<maml:name>String</maml:name>
|
|
5217
6166
|
<maml:uri />
|
|
5218
6167
|
</dev:type>
|
|
5219
6168
|
<dev:defaultValue>None</dev:defaultValue>
|
|
5220
6169
|
</command:parameter>
|
|
5221
6170
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
5222
|
-
<maml:name>
|
|
6171
|
+
<maml:name>TenantId</maml:name>
|
|
5223
6172
|
<maml:description>
|
|
5224
|
-
<maml:para>
|
|
6173
|
+
<maml:para>Optional Tenant Id. Use tenant id of default context if not specified.</maml:para>
|
|
5225
6174
|
</maml:description>
|
|
6175
|
+
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
|
|
5226
6176
|
<dev:type>
|
|
5227
|
-
<maml:name>
|
|
6177
|
+
<maml:name>String</maml:name>
|
|
5228
6178
|
<maml:uri />
|
|
5229
6179
|
</dev:type>
|
|
5230
|
-
<dev:defaultValue>
|
|
6180
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
5231
6181
|
</command:parameter>
|
|
5232
|
-
|
|
5233
|
-
|
|
6182
|
+
</command:syntaxItem>
|
|
6183
|
+
<command:syntaxItem>
|
|
6184
|
+
<maml:name>Get-AzAccessToken</maml:name>
|
|
6185
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzContext, AzureRmContext, AzureCredential">
|
|
6186
|
+
<maml:name>DefaultProfile</maml:name>
|
|
5234
6187
|
<maml:description>
|
|
5235
|
-
<maml:para>
|
|
6188
|
+
<maml:para>The credentials, account, tenant, and subscription used for communication with Azure.</maml:para>
|
|
5236
6189
|
</maml:description>
|
|
5237
|
-
<command:
|
|
5238
|
-
<command:parameterValue required="false" command:variableLength="false">Local</command:parameterValue>
|
|
5239
|
-
<command:parameterValue required="false" command:variableLength="false">Process</command:parameterValue>
|
|
5240
|
-
<command:parameterValue required="false" command:variableLength="false">CurrentUser</command:parameterValue>
|
|
5241
|
-
<command:parameterValue required="false" command:variableLength="false">LocalMachine</command:parameterValue>
|
|
5242
|
-
</command:parameterValueGroup>
|
|
5243
|
-
<command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
|
|
6190
|
+
<command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue>
|
|
5244
6191
|
<dev:type>
|
|
5245
|
-
<maml:name>
|
|
6192
|
+
<maml:name>IAzureContextContainer</maml:name>
|
|
5246
6193
|
<maml:uri />
|
|
5247
6194
|
</dev:type>
|
|
5248
6195
|
<dev:defaultValue>None</dev:defaultValue>
|
|
5249
6196
|
</command:parameter>
|
|
5250
|
-
<command:parameter required="
|
|
5251
|
-
<maml:name>
|
|
6197
|
+
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Resource, ResourceUri">
|
|
6198
|
+
<maml:name>ResourceUrl</maml:name>
|
|
5252
6199
|
<maml:description>
|
|
5253
|
-
<maml:para>
|
|
6200
|
+
<maml:para>Resource url for that you're requesting token, e.g. 'https://graph.microsoft.com/'.</maml:para>
|
|
5254
6201
|
</maml:description>
|
|
6202
|
+
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
|
|
5255
6203
|
<dev:type>
|
|
5256
|
-
<maml:name>
|
|
6204
|
+
<maml:name>String</maml:name>
|
|
5257
6205
|
<maml:uri />
|
|
5258
6206
|
</dev:type>
|
|
5259
|
-
<dev:defaultValue>
|
|
6207
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
5260
6208
|
</command:parameter>
|
|
5261
|
-
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="
|
|
5262
|
-
<maml:name>
|
|
6209
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
6210
|
+
<maml:name>TenantId</maml:name>
|
|
5263
6211
|
<maml:description>
|
|
5264
|
-
<maml:para>
|
|
6212
|
+
<maml:para>Optional Tenant Id. Use tenant id of default context if not specified.</maml:para>
|
|
5265
6213
|
</maml:description>
|
|
6214
|
+
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
|
|
5266
6215
|
<dev:type>
|
|
5267
|
-
<maml:name>
|
|
6216
|
+
<maml:name>String</maml:name>
|
|
5268
6217
|
<maml:uri />
|
|
5269
6218
|
</dev:type>
|
|
5270
|
-
<dev:defaultValue>
|
|
6219
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
5271
6220
|
</command:parameter>
|
|
5272
6221
|
</command:syntaxItem>
|
|
5273
6222
|
</command:syntax>
|
|
@@ -5277,73 +6226,49 @@ Enable-AzContextAutosave -Scope Process</dev:code>
|
|
|
5277
6226
|
<maml:description>
|
|
5278
6227
|
<maml:para>The credentials, account, tenant, and subscription used for communication with Azure.</maml:para>
|
|
5279
6228
|
</maml:description>
|
|
5280
|
-
<command:parameterValue required="true" variableLength="false">
|
|
6229
|
+
<command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue>
|
|
5281
6230
|
<dev:type>
|
|
5282
|
-
<maml:name>
|
|
6231
|
+
<maml:name>IAzureContextContainer</maml:name>
|
|
5283
6232
|
<maml:uri />
|
|
5284
6233
|
</dev:type>
|
|
5285
6234
|
<dev:defaultValue>None</dev:defaultValue>
|
|
5286
6235
|
</command:parameter>
|
|
5287
6236
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
5288
|
-
<maml:name>
|
|
6237
|
+
<maml:name>ResourceTypeName</maml:name>
|
|
5289
6238
|
<maml:description>
|
|
5290
|
-
<maml:para>
|
|
6239
|
+
<maml:para>Optional resource type name, supported values: AadGraph, AnalysisServices, AppConfiguration, Arm, Attestation, Batch, DataLake, KeyVault, MSGraph, OperationalInsights, ResourceManager, Storage, Synapse. Default value is Arm if not specified.</maml:para>
|
|
5291
6240
|
</maml:description>
|
|
5292
|
-
<command:parameterValue required="true" variableLength="false">
|
|
6241
|
+
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
|
|
5293
6242
|
<dev:type>
|
|
5294
|
-
<maml:name>
|
|
6243
|
+
<maml:name>String</maml:name>
|
|
5295
6244
|
<maml:uri />
|
|
5296
6245
|
</dev:type>
|
|
5297
6246
|
<dev:defaultValue>None</dev:defaultValue>
|
|
5298
6247
|
</command:parameter>
|
|
5299
|
-
<command:parameter required="
|
|
5300
|
-
<maml:name>
|
|
6248
|
+
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="Resource, ResourceUri">
|
|
6249
|
+
<maml:name>ResourceUrl</maml:name>
|
|
5301
6250
|
<maml:description>
|
|
5302
|
-
<maml:para>
|
|
6251
|
+
<maml:para>Resource url for that you're requesting token, e.g. 'https://graph.microsoft.com/'.</maml:para>
|
|
5303
6252
|
</maml:description>
|
|
5304
|
-
<command:parameterValue required="true" variableLength="false">
|
|
6253
|
+
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
|
|
5305
6254
|
<dev:type>
|
|
5306
|
-
<maml:name>
|
|
6255
|
+
<maml:name>String</maml:name>
|
|
5307
6256
|
<maml:uri />
|
|
5308
6257
|
</dev:type>
|
|
5309
|
-
<dev:defaultValue>
|
|
6258
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
5310
6259
|
</command:parameter>
|
|
5311
6260
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
5312
|
-
<maml:name>
|
|
6261
|
+
<maml:name>TenantId</maml:name>
|
|
5313
6262
|
<maml:description>
|
|
5314
|
-
<maml:para>
|
|
6263
|
+
<maml:para>Optional Tenant Id. Use tenant id of default context if not specified.</maml:para>
|
|
5315
6264
|
</maml:description>
|
|
5316
|
-
<command:parameterValue required="true" variableLength="false">
|
|
6265
|
+
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
|
|
5317
6266
|
<dev:type>
|
|
5318
|
-
<maml:name>
|
|
6267
|
+
<maml:name>String</maml:name>
|
|
5319
6268
|
<maml:uri />
|
|
5320
6269
|
</dev:type>
|
|
5321
6270
|
<dev:defaultValue>None</dev:defaultValue>
|
|
5322
6271
|
</command:parameter>
|
|
5323
|
-
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf">
|
|
5324
|
-
<maml:name>Confirm</maml:name>
|
|
5325
|
-
<maml:description>
|
|
5326
|
-
<maml:para>Prompts you for confirmation before running the cmdlet.</maml:para>
|
|
5327
|
-
</maml:description>
|
|
5328
|
-
<command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue>
|
|
5329
|
-
<dev:type>
|
|
5330
|
-
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
5331
|
-
<maml:uri />
|
|
5332
|
-
</dev:type>
|
|
5333
|
-
<dev:defaultValue>False</dev:defaultValue>
|
|
5334
|
-
</command:parameter>
|
|
5335
|
-
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi">
|
|
5336
|
-
<maml:name>WhatIf</maml:name>
|
|
5337
|
-
<maml:description>
|
|
5338
|
-
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
|
|
5339
|
-
</maml:description>
|
|
5340
|
-
<command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue>
|
|
5341
|
-
<dev:type>
|
|
5342
|
-
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
5343
|
-
<maml:uri />
|
|
5344
|
-
</dev:type>
|
|
5345
|
-
<dev:defaultValue>False</dev:defaultValue>
|
|
5346
|
-
</command:parameter>
|
|
5347
6272
|
</command:parameters>
|
|
5348
6273
|
<command:inputTypes>
|
|
5349
6274
|
<command:inputType>
|
|
@@ -5358,7 +6283,7 @@ Enable-AzContextAutosave -Scope Process</dev:code>
|
|
|
5358
6283
|
<command:returnValues>
|
|
5359
6284
|
<command:returnValue>
|
|
5360
6285
|
<dev:type>
|
|
5361
|
-
<maml:name>
|
|
6286
|
+
<maml:name>Microsoft.Azure.Commands.Profile.Models.PSAccessToken</maml:name>
|
|
5362
6287
|
</dev:type>
|
|
5363
6288
|
<maml:description>
|
|
5364
6289
|
<maml:para></maml:para>
|
|
@@ -5372,19 +6297,28 @@ Enable-AzContextAutosave -Scope Process</dev:code>
|
|
|
5372
6297
|
</maml:alertSet>
|
|
5373
6298
|
<command:examples>
|
|
5374
6299
|
<command:example>
|
|
5375
|
-
<maml:title
|
|
5376
|
-
<dev:code>
|
|
6300
|
+
<maml:title>------- Example 1 Get the access token for ARM endpoint -------</maml:title>
|
|
6301
|
+
<dev:code>Get-AzAccessToken</dev:code>
|
|
5377
6302
|
<dev:remarks>
|
|
5378
|
-
<maml:para>
|
|
6303
|
+
<maml:para>Get access token of current account for ResourceManager endpoint</maml:para>
|
|
5379
6304
|
<maml:para></maml:para>
|
|
5380
6305
|
<maml:para></maml:para>
|
|
5381
6306
|
</dev:remarks>
|
|
5382
6307
|
</command:example>
|
|
5383
6308
|
<command:example>
|
|
5384
|
-
<maml:title
|
|
5385
|
-
<dev:code>
|
|
6309
|
+
<maml:title>- Example 2 Get the access token for Microsoft Graph endpoint -</maml:title>
|
|
6310
|
+
<dev:code>Get-AzAccessToken -ResourceTypeName MSGraph</dev:code>
|
|
5386
6311
|
<dev:remarks>
|
|
5387
|
-
<maml:para>
|
|
6312
|
+
<maml:para>Get access token of Microsoft Graph endpoint for current account</maml:para>
|
|
6313
|
+
<maml:para></maml:para>
|
|
6314
|
+
<maml:para></maml:para>
|
|
6315
|
+
</dev:remarks>
|
|
6316
|
+
</command:example>
|
|
6317
|
+
<command:example>
|
|
6318
|
+
<maml:title>- Example 3 Get the access token for Microsoft Graph endpoint -</maml:title>
|
|
6319
|
+
<dev:code>Get-AzAccessToken -ResourceUrl "https://graph.microsoft.com/"</dev:code>
|
|
6320
|
+
<dev:remarks>
|
|
6321
|
+
<maml:para>Get access token of Microsoft Graph endpoint for current account</maml:para>
|
|
5388
6322
|
<maml:para></maml:para>
|
|
5389
6323
|
<maml:para></maml:para>
|
|
5390
6324
|
</dev:remarks>
|
|
@@ -5393,25 +6327,51 @@ Enable-AzContextAutosave -Scope Process</dev:code>
|
|
|
5393
6327
|
<command:relatedLinks>
|
|
5394
6328
|
<maml:navigationLink>
|
|
5395
6329
|
<maml:linkText>Online Version:</maml:linkText>
|
|
5396
|
-
<maml:uri>https://learn.microsoft.com/powershell/module/az.accounts/
|
|
6330
|
+
<maml:uri>https://learn.microsoft.com/powershell/module/az.accounts/get-azaccesstoken</maml:uri>
|
|
5397
6331
|
</maml:navigationLink>
|
|
5398
6332
|
</command:relatedLinks>
|
|
5399
6333
|
</command:command>
|
|
5400
6334
|
<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">
|
|
5401
6335
|
<command:details>
|
|
5402
|
-
<command:name>Get-
|
|
6336
|
+
<command:name>Get-AzConfig</command:name>
|
|
5403
6337
|
<command:verb>Get</command:verb>
|
|
5404
|
-
<command:noun>
|
|
6338
|
+
<command:noun>AzConfig</command:noun>
|
|
5405
6339
|
<maml:description>
|
|
5406
|
-
<maml:para>
|
|
6340
|
+
<maml:para>Gets the configs of Azure PowerShell.</maml:para>
|
|
5407
6341
|
</maml:description>
|
|
5408
6342
|
</command:details>
|
|
5409
6343
|
<maml:description>
|
|
5410
|
-
<maml:para>
|
|
6344
|
+
<maml:para>Gets the configs of Azure PowerShell. By default it lists all the configs. You can filter the result using various parameters.</maml:para>
|
|
6345
|
+
<maml:para>> [!NOTE] > Configs have priorities. Generally speaking, Process scope has higher priority than CurrentUser scope; a config that applies to a certain cmdlet has higher priority than that applies to a module, again higher than Az. > To reduce confusion, the result of `Get-AzConfig` shows those configs that are taking effect. It is a combination of all the configs, but not literally all the configs. However, you could always view them by applying different filter parameters, such as `-Scope`.</maml:para>
|
|
5411
6346
|
</maml:description>
|
|
5412
6347
|
<command:syntax>
|
|
5413
6348
|
<command:syntaxItem>
|
|
5414
|
-
<maml:name>Get-
|
|
6349
|
+
<maml:name>Get-AzConfig</maml:name>
|
|
6350
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
6351
|
+
<maml:name>AppliesTo</maml:name>
|
|
6352
|
+
<maml:description>
|
|
6353
|
+
<maml:para>Specifies what part of Azure PowerShell the config applies to. Possible values are: - "Az": the config applies to all modules and cmdlets of Azure PowerShell.</maml:para>
|
|
6354
|
+
<maml:para>- Module name: the config applies to a certain module of Azure PowerShell.</maml:para>
|
|
6355
|
+
<maml:para>For example, "Az.Storage". - Cmdlet name: the config applies to a certain cmdlet of Azure PowerShell. For example, "Get-AzKeyVault". If not specified, when getting or clearing configs, it defaults to all the above; when updating, it defaults to "Az".</maml:para>
|
|
6356
|
+
</maml:description>
|
|
6357
|
+
<command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
|
|
6358
|
+
<dev:type>
|
|
6359
|
+
<maml:name>System.String</maml:name>
|
|
6360
|
+
<maml:uri />
|
|
6361
|
+
</dev:type>
|
|
6362
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
6363
|
+
</command:parameter>
|
|
6364
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
6365
|
+
<maml:name>CheckForUpgrade</maml:name>
|
|
6366
|
+
<maml:description>
|
|
6367
|
+
<maml:para>When enabled, Azure PowerShell will check for updates automatically and display a hint message when an update is available. The default value will be changed from false to true in Az version 11.0.0.</maml:para>
|
|
6368
|
+
</maml:description>
|
|
6369
|
+
<dev:type>
|
|
6370
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
6371
|
+
<maml:uri />
|
|
6372
|
+
</dev:type>
|
|
6373
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
6374
|
+
</command:parameter>
|
|
5415
6375
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzContext, AzureRmContext, AzureCredential">
|
|
5416
6376
|
<maml:name>DefaultProfile</maml:name>
|
|
5417
6377
|
<maml:description>
|
|
@@ -5425,64 +6385,96 @@ Enable-AzContextAutosave -Scope Process</dev:code>
|
|
|
5425
6385
|
<dev:defaultValue>None</dev:defaultValue>
|
|
5426
6386
|
</command:parameter>
|
|
5427
6387
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
5428
|
-
<maml:name>
|
|
6388
|
+
<maml:name>DefaultSubscriptionForLogin</maml:name>
|
|
5429
6389
|
<maml:description>
|
|
5430
|
-
<maml:para>
|
|
6390
|
+
<maml:para>Subscription name or GUID. Sets the default context for Azure PowerShell when logging in without specifying a subscription.</maml:para>
|
|
5431
6391
|
</maml:description>
|
|
5432
|
-
<command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
|
|
5433
6392
|
<dev:type>
|
|
5434
|
-
<maml:name>System.
|
|
6393
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
5435
6394
|
<maml:uri />
|
|
5436
6395
|
</dev:type>
|
|
5437
|
-
<dev:defaultValue>
|
|
6396
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
5438
6397
|
</command:parameter>
|
|
5439
6398
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
5440
|
-
<maml:name>
|
|
6399
|
+
<maml:name>DisableErrorRecordsPersistence</maml:name>
|
|
5441
6400
|
<maml:description>
|
|
5442
|
-
<maml:para>
|
|
6401
|
+
<maml:para>When disabled, error records will not be written to ~/.Azure/ErrorRecords. This config will be replaced by "EnableErrorRecordsPersistence" as opt-in in the next major release of Az around November 2023.</maml:para>
|
|
5443
6402
|
</maml:description>
|
|
5444
|
-
<command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
|
|
5445
6403
|
<dev:type>
|
|
5446
|
-
<maml:name>System.
|
|
6404
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
5447
6405
|
<maml:uri />
|
|
5448
6406
|
</dev:type>
|
|
5449
|
-
<dev:defaultValue>
|
|
6407
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
5450
6408
|
</command:parameter>
|
|
5451
|
-
|
|
5452
|
-
|
|
5453
|
-
<maml:name>Get-AzAccessToken</maml:name>
|
|
5454
|
-
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzContext, AzureRmContext, AzureCredential">
|
|
5455
|
-
<maml:name>DefaultProfile</maml:name>
|
|
6409
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
6410
|
+
<maml:name>DisplayBreakingChangeWarning</maml:name>
|
|
5456
6411
|
<maml:description>
|
|
5457
|
-
<maml:para>
|
|
6412
|
+
<maml:para>Controls if warning messages for breaking changes are displayed or suppressed. When enabled, a breaking change warning is displayed when executing cmdlets with breaking changes in a future release.</maml:para>
|
|
5458
6413
|
</maml:description>
|
|
5459
|
-
<command:parameterValue required="true" variableLength="false">Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer</command:parameterValue>
|
|
5460
6414
|
<dev:type>
|
|
5461
|
-
<maml:name>
|
|
6415
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
5462
6416
|
<maml:uri />
|
|
5463
6417
|
</dev:type>
|
|
5464
|
-
<dev:defaultValue>
|
|
6418
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
5465
6419
|
</command:parameter>
|
|
5466
|
-
<command:parameter required="
|
|
5467
|
-
<maml:name>
|
|
6420
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
6421
|
+
<maml:name>DisplayRegionIdentified</maml:name>
|
|
5468
6422
|
<maml:description>
|
|
5469
|
-
<maml:para>
|
|
6423
|
+
<maml:para>When enabled, Azure PowerShell displays recommendations on regions which may reduce your costs.</maml:para>
|
|
5470
6424
|
</maml:description>
|
|
5471
|
-
<command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
|
|
5472
6425
|
<dev:type>
|
|
5473
|
-
<maml:name>System.
|
|
6426
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
5474
6427
|
<maml:uri />
|
|
5475
6428
|
</dev:type>
|
|
5476
|
-
<dev:defaultValue>
|
|
6429
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
5477
6430
|
</command:parameter>
|
|
5478
6431
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
5479
|
-
<maml:name>
|
|
6432
|
+
<maml:name>DisplaySurveyMessage</maml:name>
|
|
5480
6433
|
<maml:description>
|
|
5481
|
-
<maml:para>
|
|
6434
|
+
<maml:para>When enabled, you are prompted infrequently to participate in user experience surveys for Azure PowerShell.</maml:para>
|
|
5482
6435
|
</maml:description>
|
|
5483
|
-
<command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
|
|
5484
6436
|
<dev:type>
|
|
5485
|
-
<maml:name>System.
|
|
6437
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
6438
|
+
<maml:uri />
|
|
6439
|
+
</dev:type>
|
|
6440
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
6441
|
+
</command:parameter>
|
|
6442
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
6443
|
+
<maml:name>EnableDataCollection</maml:name>
|
|
6444
|
+
<maml:description>
|
|
6445
|
+
<maml:para>When enabled, Azure PowerShell cmdlets send telemetry data to Microsoft to improve the customer experience. For more information, see our privacy statement: https://aka.ms/privacy</maml:para>
|
|
6446
|
+
</maml:description>
|
|
6447
|
+
<dev:type>
|
|
6448
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
6449
|
+
<maml:uri />
|
|
6450
|
+
</dev:type>
|
|
6451
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
6452
|
+
</command:parameter>
|
|
6453
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
6454
|
+
<maml:name>EnableLoginByWam</maml:name>
|
|
6455
|
+
<maml:description>
|
|
6456
|
+
<maml:para>[Preview] When enabled, Web Account Manager (WAM) will be the default interactive login experience. It will fall back to using the browser if the platform does not support WAM. Note that this feature is under preview. Microsoft Account (MSA) is currently not supported. Feel free to reach out to Azure PowerShell team if you have any feedbacks: https://aka.ms/azpsissue</maml:para>
|
|
6457
|
+
</maml:description>
|
|
6458
|
+
<dev:type>
|
|
6459
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
6460
|
+
<maml:uri />
|
|
6461
|
+
</dev:type>
|
|
6462
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
6463
|
+
</command:parameter>
|
|
6464
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
6465
|
+
<maml:name>Scope</maml:name>
|
|
6466
|
+
<maml:description>
|
|
6467
|
+
<maml:para>Determines the scope of config changes, for example, whether changes apply only to the current process, or to all sessions started by this user. By default it is CurrentUser.</maml:para>
|
|
6468
|
+
</maml:description>
|
|
6469
|
+
<command:parameterValueGroup>
|
|
6470
|
+
<command:parameterValue required="false" command:variableLength="false">CurrentUser</command:parameterValue>
|
|
6471
|
+
<command:parameterValue required="false" command:variableLength="false">Process</command:parameterValue>
|
|
6472
|
+
<command:parameterValue required="false" command:variableLength="false">Default</command:parameterValue>
|
|
6473
|
+
<command:parameterValue required="false" command:variableLength="false">Environment</command:parameterValue>
|
|
6474
|
+
</command:parameterValueGroup>
|
|
6475
|
+
<command:parameterValue required="true" variableLength="false">Microsoft.Azure.PowerShell.Common.Config.ConfigScope</command:parameterValue>
|
|
6476
|
+
<dev:type>
|
|
6477
|
+
<maml:name>Microsoft.Azure.PowerShell.Common.Config.ConfigScope</maml:name>
|
|
5486
6478
|
<maml:uri />
|
|
5487
6479
|
</dev:type>
|
|
5488
6480
|
<dev:defaultValue>None</dev:defaultValue>
|
|
@@ -5490,6 +6482,32 @@ Enable-AzContextAutosave -Scope Process</dev:code>
|
|
|
5490
6482
|
</command:syntaxItem>
|
|
5491
6483
|
</command:syntax>
|
|
5492
6484
|
<command:parameters>
|
|
6485
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
6486
|
+
<maml:name>AppliesTo</maml:name>
|
|
6487
|
+
<maml:description>
|
|
6488
|
+
<maml:para>Specifies what part of Azure PowerShell the config applies to. Possible values are: - "Az": the config applies to all modules and cmdlets of Azure PowerShell.</maml:para>
|
|
6489
|
+
<maml:para>- Module name: the config applies to a certain module of Azure PowerShell.</maml:para>
|
|
6490
|
+
<maml:para>For example, "Az.Storage". - Cmdlet name: the config applies to a certain cmdlet of Azure PowerShell. For example, "Get-AzKeyVault". If not specified, when getting or clearing configs, it defaults to all the above; when updating, it defaults to "Az".</maml:para>
|
|
6491
|
+
</maml:description>
|
|
6492
|
+
<command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
|
|
6493
|
+
<dev:type>
|
|
6494
|
+
<maml:name>System.String</maml:name>
|
|
6495
|
+
<maml:uri />
|
|
6496
|
+
</dev:type>
|
|
6497
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
6498
|
+
</command:parameter>
|
|
6499
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
6500
|
+
<maml:name>CheckForUpgrade</maml:name>
|
|
6501
|
+
<maml:description>
|
|
6502
|
+
<maml:para>When enabled, Azure PowerShell will check for updates automatically and display a hint message when an update is available. The default value will be changed from false to true in Az version 11.0.0.</maml:para>
|
|
6503
|
+
</maml:description>
|
|
6504
|
+
<command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue>
|
|
6505
|
+
<dev:type>
|
|
6506
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
6507
|
+
<maml:uri />
|
|
6508
|
+
</dev:type>
|
|
6509
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
6510
|
+
</command:parameter>
|
|
5493
6511
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzContext, AzureRmContext, AzureCredential">
|
|
5494
6512
|
<maml:name>DefaultProfile</maml:name>
|
|
5495
6513
|
<maml:description>
|
|
@@ -5503,37 +6521,97 @@ Enable-AzContextAutosave -Scope Process</dev:code>
|
|
|
5503
6521
|
<dev:defaultValue>None</dev:defaultValue>
|
|
5504
6522
|
</command:parameter>
|
|
5505
6523
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
5506
|
-
<maml:name>
|
|
6524
|
+
<maml:name>DefaultSubscriptionForLogin</maml:name>
|
|
5507
6525
|
<maml:description>
|
|
5508
|
-
<maml:para>
|
|
6526
|
+
<maml:para>Subscription name or GUID. Sets the default context for Azure PowerShell when logging in without specifying a subscription.</maml:para>
|
|
5509
6527
|
</maml:description>
|
|
5510
|
-
<command:parameterValue required="true" variableLength="false">System.
|
|
6528
|
+
<command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue>
|
|
5511
6529
|
<dev:type>
|
|
5512
|
-
<maml:name>System.
|
|
6530
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
5513
6531
|
<maml:uri />
|
|
5514
6532
|
</dev:type>
|
|
5515
|
-
<dev:defaultValue>
|
|
6533
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
5516
6534
|
</command:parameter>
|
|
5517
|
-
<command:parameter required="
|
|
5518
|
-
<maml:name>
|
|
6535
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
6536
|
+
<maml:name>DisableErrorRecordsPersistence</maml:name>
|
|
5519
6537
|
<maml:description>
|
|
5520
|
-
<maml:para>
|
|
6538
|
+
<maml:para>When disabled, error records will not be written to ~/.Azure/ErrorRecords. This config will be replaced by "EnableErrorRecordsPersistence" as opt-in in the next major release of Az around November 2023.</maml:para>
|
|
5521
6539
|
</maml:description>
|
|
5522
|
-
<command:parameterValue required="true" variableLength="false">System.
|
|
6540
|
+
<command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue>
|
|
5523
6541
|
<dev:type>
|
|
5524
|
-
<maml:name>System.
|
|
6542
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
5525
6543
|
<maml:uri />
|
|
5526
6544
|
</dev:type>
|
|
5527
|
-
<dev:defaultValue>
|
|
6545
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
5528
6546
|
</command:parameter>
|
|
5529
6547
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
5530
|
-
<maml:name>
|
|
6548
|
+
<maml:name>DisplayBreakingChangeWarning</maml:name>
|
|
5531
6549
|
<maml:description>
|
|
5532
|
-
<maml:para>
|
|
6550
|
+
<maml:para>Controls if warning messages for breaking changes are displayed or suppressed. When enabled, a breaking change warning is displayed when executing cmdlets with breaking changes in a future release.</maml:para>
|
|
5533
6551
|
</maml:description>
|
|
5534
|
-
<command:parameterValue required="true" variableLength="false">System.
|
|
6552
|
+
<command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue>
|
|
5535
6553
|
<dev:type>
|
|
5536
|
-
<maml:name>System.
|
|
6554
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
6555
|
+
<maml:uri />
|
|
6556
|
+
</dev:type>
|
|
6557
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
6558
|
+
</command:parameter>
|
|
6559
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
6560
|
+
<maml:name>DisplayRegionIdentified</maml:name>
|
|
6561
|
+
<maml:description>
|
|
6562
|
+
<maml:para>When enabled, Azure PowerShell displays recommendations on regions which may reduce your costs.</maml:para>
|
|
6563
|
+
</maml:description>
|
|
6564
|
+
<command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue>
|
|
6565
|
+
<dev:type>
|
|
6566
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
6567
|
+
<maml:uri />
|
|
6568
|
+
</dev:type>
|
|
6569
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
6570
|
+
</command:parameter>
|
|
6571
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
6572
|
+
<maml:name>DisplaySurveyMessage</maml:name>
|
|
6573
|
+
<maml:description>
|
|
6574
|
+
<maml:para>When enabled, you are prompted infrequently to participate in user experience surveys for Azure PowerShell.</maml:para>
|
|
6575
|
+
</maml:description>
|
|
6576
|
+
<command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue>
|
|
6577
|
+
<dev:type>
|
|
6578
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
6579
|
+
<maml:uri />
|
|
6580
|
+
</dev:type>
|
|
6581
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
6582
|
+
</command:parameter>
|
|
6583
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
6584
|
+
<maml:name>EnableDataCollection</maml:name>
|
|
6585
|
+
<maml:description>
|
|
6586
|
+
<maml:para>When enabled, Azure PowerShell cmdlets send telemetry data to Microsoft to improve the customer experience. For more information, see our privacy statement: https://aka.ms/privacy</maml:para>
|
|
6587
|
+
</maml:description>
|
|
6588
|
+
<command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue>
|
|
6589
|
+
<dev:type>
|
|
6590
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
6591
|
+
<maml:uri />
|
|
6592
|
+
</dev:type>
|
|
6593
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
6594
|
+
</command:parameter>
|
|
6595
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
6596
|
+
<maml:name>EnableLoginByWam</maml:name>
|
|
6597
|
+
<maml:description>
|
|
6598
|
+
<maml:para>[Preview] When enabled, Web Account Manager (WAM) will be the default interactive login experience. It will fall back to using the browser if the platform does not support WAM. Note that this feature is under preview. Microsoft Account (MSA) is currently not supported. Feel free to reach out to Azure PowerShell team if you have any feedbacks: https://aka.ms/azpsissue</maml:para>
|
|
6599
|
+
</maml:description>
|
|
6600
|
+
<command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue>
|
|
6601
|
+
<dev:type>
|
|
6602
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
6603
|
+
<maml:uri />
|
|
6604
|
+
</dev:type>
|
|
6605
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
6606
|
+
</command:parameter>
|
|
6607
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
6608
|
+
<maml:name>Scope</maml:name>
|
|
6609
|
+
<maml:description>
|
|
6610
|
+
<maml:para>Determines the scope of config changes, for example, whether changes apply only to the current process, or to all sessions started by this user. By default it is CurrentUser.</maml:para>
|
|
6611
|
+
</maml:description>
|
|
6612
|
+
<command:parameterValue required="true" variableLength="false">Microsoft.Azure.PowerShell.Common.Config.ConfigScope</command:parameterValue>
|
|
6613
|
+
<dev:type>
|
|
6614
|
+
<maml:name>Microsoft.Azure.PowerShell.Common.Config.ConfigScope</maml:name>
|
|
5537
6615
|
<maml:uri />
|
|
5538
6616
|
</dev:type>
|
|
5539
6617
|
<dev:defaultValue>None</dev:defaultValue>
|
|
@@ -5552,7 +6630,7 @@ Enable-AzContextAutosave -Scope Process</dev:code>
|
|
|
5552
6630
|
<command:returnValues>
|
|
5553
6631
|
<command:returnValue>
|
|
5554
6632
|
<dev:type>
|
|
5555
|
-
<maml:name>Microsoft.Azure.Commands.Profile.Models.
|
|
6633
|
+
<maml:name>Microsoft.Azure.Commands.Profile.Models.PSConfig</maml:name>
|
|
5556
6634
|
</dev:type>
|
|
5557
6635
|
<maml:description>
|
|
5558
6636
|
<maml:para></maml:para>
|
|
@@ -5566,28 +6644,29 @@ Enable-AzContextAutosave -Scope Process</dev:code>
|
|
|
5566
6644
|
</maml:alertSet>
|
|
5567
6645
|
<command:examples>
|
|
5568
6646
|
<command:example>
|
|
5569
|
-
<maml:title
|
|
5570
|
-
<dev:code>Get-
|
|
5571
|
-
|
|
5572
|
-
|
|
5573
|
-
|
|
5574
|
-
|
|
5575
|
-
|
|
5576
|
-
|
|
5577
|
-
<command:example>
|
|
5578
|
-
<maml:title>- Example 2 Get the access token for Microsoft Graph endpoint -</maml:title>
|
|
5579
|
-
<dev:code>Get-AzAccessToken -ResourceTypeName MSGraph</dev:code>
|
|
6647
|
+
<maml:title>-------------------------- Example 1 --------------------------</maml:title>
|
|
6648
|
+
<dev:code>Get-AzConfig
|
|
6649
|
+
|
|
6650
|
+
Key Value Applies To Scope Help Message
|
|
6651
|
+
--- ----- ---------- ----- ------------
|
|
6652
|
+
EnableDataCollection False Az CurrentUser When enabled, Azure PowerShell cmdlets send telemetry data to Microsoft to improve the custom…
|
|
6653
|
+
DefaultSubscriptionForLogin Az Default Subscription name or GUID. Sets the default context for Azure PowerShell when logging in with…
|
|
6654
|
+
DisplayBreakingChangeWarning True Az Default Controls if warning messages for breaking changes are displayed or suppressed. When enabled, …</dev:code>
|
|
5580
6655
|
<dev:remarks>
|
|
5581
|
-
<maml:para>
|
|
6656
|
+
<maml:para>Gets all the configs.</maml:para>
|
|
5582
6657
|
<maml:para></maml:para>
|
|
5583
6658
|
<maml:para></maml:para>
|
|
5584
6659
|
</dev:remarks>
|
|
5585
6660
|
</command:example>
|
|
5586
6661
|
<command:example>
|
|
5587
|
-
<maml:title
|
|
5588
|
-
<dev:code>Get-
|
|
6662
|
+
<maml:title>-------------------------- Example 2 --------------------------</maml:title>
|
|
6663
|
+
<dev:code>Get-AzConfig -EnableDataCollection
|
|
6664
|
+
|
|
6665
|
+
Key Value Applies To Scope Help Message
|
|
6666
|
+
--- ----- ---------- ----- ------------
|
|
6667
|
+
EnableDataCollection False Az CurrentUser When enabled, Azure PowerShell cmdlets send telemetry data to Microsoft to improve the custom…</dev:code>
|
|
5589
6668
|
<dev:remarks>
|
|
5590
|
-
<maml:para>
|
|
6669
|
+
<maml:para>Gets the "EnableDataCollection" config.</maml:para>
|
|
5591
6670
|
<maml:para></maml:para>
|
|
5592
6671
|
<maml:para></maml:para>
|
|
5593
6672
|
</dev:remarks>
|
|
@@ -5596,7 +6675,7 @@ Enable-AzContextAutosave -Scope Process</dev:code>
|
|
|
5596
6675
|
<command:relatedLinks>
|
|
5597
6676
|
<maml:navigationLink>
|
|
5598
6677
|
<maml:linkText>Online Version:</maml:linkText>
|
|
5599
|
-
<maml:uri>https://learn.microsoft.com/powershell/module/az.accounts/get-
|
|
6678
|
+
<maml:uri>https://learn.microsoft.com/powershell/module/az.accounts/get-azconfig</maml:uri>
|
|
5600
6679
|
</maml:navigationLink>
|
|
5601
6680
|
</command:relatedLinks>
|
|
5602
6681
|
</command:command>
|
|
@@ -6074,7 +7153,7 @@ Tags :</dev:code>
|
|
|
6074
7153
|
<command:verb>Get</command:verb>
|
|
6075
7154
|
<command:noun>AzEnvironment</command:noun>
|
|
6076
7155
|
<maml:description>
|
|
6077
|
-
<maml:para>Get endpoints and metadata for an instance of Azure services.</maml:para>
|
|
7156
|
+
<maml:para>Get endpoints and metadata for an instance of Azure services. `GalleryUrl` will be removed from ArmMetadata and so Azure PowerShell will no longer provide for its value in `PSAzureEnvironment`. Currently `GalleryUrl` is not used in Azure PowerShell products. Please do not reply on `GalleryUrl` anymore.</maml:para>
|
|
6078
7157
|
</maml:description>
|
|
6079
7158
|
</command:details>
|
|
6080
7159
|
<maml:description>
|
|
@@ -6168,7 +7247,6 @@ Tags :</dev:code>
|
|
|
6168
7247
|
Name Resource Manager Url ActiveDirectory Authority Type
|
|
6169
7248
|
---- -------------------- ------------------------- ----
|
|
6170
7249
|
AzureUSGovernment https://management.usgovcloudapi.net/ https://login.microsoftonline.us/ Built-in
|
|
6171
|
-
AzureGermanCloud https://management.microsoftazure.de/ https://login.microsoftonline.de/ Built-in
|
|
6172
7250
|
AzureCloud https://management.azure.com/ https://login.microsoftonline.com/ Built-in
|
|
6173
7251
|
AzureChinaCloud https://management.chinacloudapi.cn/ https://login.chinacloudapi.cn/ Built-in</dev:code>
|
|
6174
7252
|
<dev:remarks>
|
|
@@ -6497,7 +7575,7 @@ Subscription2 xxxx-xxxx-xxxx-xxxx aaaa-aaaa-aaaa-aaaa
|
|
|
6497
7575
|
</command:example>
|
|
6498
7576
|
<command:example>
|
|
6499
7577
|
<maml:title>---- Example 3: Get all subscriptions in the current tenant ----</maml:title>
|
|
6500
|
-
<dev:code>Get-AzSubscription
|
|
7578
|
+
<dev:code>Get-AzSubscription -TenantId (Get-AzContext).Tenant
|
|
6501
7579
|
|
|
6502
7580
|
Name Id TenantId State
|
|
6503
7581
|
---- -- -------- -----
|
|
@@ -6548,26 +7626,190 @@ Subscription1 (xxxx-xxxx-xxxx-xxxx) azureuser@micros... Subscription1
|
|
|
6548
7626
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="Domain, Tenant">
|
|
6549
7627
|
<maml:name>TenantId</maml:name>
|
|
6550
7628
|
<maml:description>
|
|
6551
|
-
<maml:para>Specifies the ID of the tenant that this cmdlet gets.</maml:para>
|
|
7629
|
+
<maml:para>Specifies the ID of the tenant that this cmdlet gets.</maml:para>
|
|
7630
|
+
</maml:description>
|
|
7631
|
+
<command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
|
|
7632
|
+
<dev:type>
|
|
7633
|
+
<maml:name>System.String</maml:name>
|
|
7634
|
+
<maml:uri />
|
|
7635
|
+
</dev:type>
|
|
7636
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
7637
|
+
</command:parameter>
|
|
7638
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzContext, AzureRmContext, AzureCredential">
|
|
7639
|
+
<maml:name>DefaultProfile</maml:name>
|
|
7640
|
+
<maml:description>
|
|
7641
|
+
<maml:para>The credentials, tenant and subscription used for communication with azure</maml:para>
|
|
7642
|
+
</maml:description>
|
|
7643
|
+
<command:parameterValue required="true" variableLength="false">Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer</command:parameterValue>
|
|
7644
|
+
<dev:type>
|
|
7645
|
+
<maml:name>Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer</maml:name>
|
|
7646
|
+
<maml:uri />
|
|
7647
|
+
</dev:type>
|
|
7648
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
7649
|
+
</command:parameter>
|
|
7650
|
+
</command:syntaxItem>
|
|
7651
|
+
</command:syntax>
|
|
7652
|
+
<command:parameters>
|
|
7653
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzContext, AzureRmContext, AzureCredential">
|
|
7654
|
+
<maml:name>DefaultProfile</maml:name>
|
|
7655
|
+
<maml:description>
|
|
7656
|
+
<maml:para>The credentials, tenant and subscription used for communication with azure</maml:para>
|
|
7657
|
+
</maml:description>
|
|
7658
|
+
<command:parameterValue required="true" variableLength="false">Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer</command:parameterValue>
|
|
7659
|
+
<dev:type>
|
|
7660
|
+
<maml:name>Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer</maml:name>
|
|
7661
|
+
<maml:uri />
|
|
7662
|
+
</dev:type>
|
|
7663
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
7664
|
+
</command:parameter>
|
|
7665
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="Domain, Tenant">
|
|
7666
|
+
<maml:name>TenantId</maml:name>
|
|
7667
|
+
<maml:description>
|
|
7668
|
+
<maml:para>Specifies the ID of the tenant that this cmdlet gets.</maml:para>
|
|
7669
|
+
</maml:description>
|
|
7670
|
+
<command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
|
|
7671
|
+
<dev:type>
|
|
7672
|
+
<maml:name>System.String</maml:name>
|
|
7673
|
+
<maml:uri />
|
|
7674
|
+
</dev:type>
|
|
7675
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
7676
|
+
</command:parameter>
|
|
7677
|
+
</command:parameters>
|
|
7678
|
+
<command:inputTypes>
|
|
7679
|
+
<command:inputType>
|
|
7680
|
+
<dev:type>
|
|
7681
|
+
<maml:name>System.String</maml:name>
|
|
7682
|
+
</dev:type>
|
|
7683
|
+
<maml:description>
|
|
7684
|
+
<maml:para></maml:para>
|
|
7685
|
+
</maml:description>
|
|
7686
|
+
</command:inputType>
|
|
7687
|
+
</command:inputTypes>
|
|
7688
|
+
<command:returnValues>
|
|
7689
|
+
<command:returnValue>
|
|
7690
|
+
<dev:type>
|
|
7691
|
+
<maml:name>Microsoft.Azure.Commands.Profile.Models.PSAzureTenant</maml:name>
|
|
7692
|
+
</dev:type>
|
|
7693
|
+
<maml:description>
|
|
7694
|
+
<maml:para></maml:para>
|
|
7695
|
+
</maml:description>
|
|
7696
|
+
</command:returnValue>
|
|
7697
|
+
</command:returnValues>
|
|
7698
|
+
<maml:alertSet>
|
|
7699
|
+
<maml:alert>
|
|
7700
|
+
<maml:para></maml:para>
|
|
7701
|
+
</maml:alert>
|
|
7702
|
+
</maml:alertSet>
|
|
7703
|
+
<command:examples>
|
|
7704
|
+
<command:example>
|
|
7705
|
+
<maml:title>---------------- Example 1: Getting all tenants ----------------</maml:title>
|
|
7706
|
+
<dev:code>Connect-AzAccount
|
|
7707
|
+
Get-AzTenant
|
|
7708
|
+
|
|
7709
|
+
Id Name Category Domains
|
|
7710
|
+
-- ----------- -------- -------
|
|
7711
|
+
xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Microsoft Home {test0.com, test1.com, test2.microsoft.com, test3.microsoft.com...}
|
|
7712
|
+
yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy Testhost Home testhost.onmicrosoft.com</dev:code>
|
|
7713
|
+
<dev:remarks>
|
|
7714
|
+
<maml:para>This example shows how to get all of the authorized tenants of an Azure account.</maml:para>
|
|
7715
|
+
<maml:para></maml:para>
|
|
7716
|
+
<maml:para></maml:para>
|
|
7717
|
+
</dev:remarks>
|
|
7718
|
+
</command:example>
|
|
7719
|
+
<command:example>
|
|
7720
|
+
<maml:title>------------- Example 2: Getting a specific tenant -------------</maml:title>
|
|
7721
|
+
<dev:code>Connect-AzAccount
|
|
7722
|
+
Get-AzTenant -TenantId xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
|
|
7723
|
+
|
|
7724
|
+
Id Name Category Domains
|
|
7725
|
+
-- ----------- -------- -------
|
|
7726
|
+
xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Microsoft Home {test0.com, test1.com, test2.microsoft.com, test3.microsoft.com...}</dev:code>
|
|
7727
|
+
<dev:remarks>
|
|
7728
|
+
<maml:para>This example shows how to get a specific authorized tenant of an Azure account.</maml:para>
|
|
7729
|
+
<maml:para></maml:para>
|
|
7730
|
+
<maml:para></maml:para>
|
|
7731
|
+
</dev:remarks>
|
|
7732
|
+
</command:example>
|
|
7733
|
+
</command:examples>
|
|
7734
|
+
<command:relatedLinks>
|
|
7735
|
+
<maml:navigationLink>
|
|
7736
|
+
<maml:linkText>Online Version:</maml:linkText>
|
|
7737
|
+
<maml:uri>https://learn.microsoft.com/powershell/module/az.accounts/get-aztenant</maml:uri>
|
|
7738
|
+
</maml:navigationLink>
|
|
7739
|
+
</command:relatedLinks>
|
|
7740
|
+
</command:command>
|
|
7741
|
+
<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">
|
|
7742
|
+
<command:details>
|
|
7743
|
+
<command:name>Import-AzConfig</command:name>
|
|
7744
|
+
<command:verb>Import</command:verb>
|
|
7745
|
+
<command:noun>AzConfig</command:noun>
|
|
7746
|
+
<maml:description>
|
|
7747
|
+
<maml:para>Imports configs from a file that was previously exported by `Export-AzConfig`.</maml:para>
|
|
7748
|
+
</maml:description>
|
|
7749
|
+
</command:details>
|
|
7750
|
+
<maml:description>
|
|
7751
|
+
<maml:para>The `Import-AzConfig` cmdlet imports all the configs from a file that was previously exported by `Export-AzConfig`. The imported configs will be set at the "CurrentUser" scope, so they are consistent across PowerShell sessions.</maml:para>
|
|
7752
|
+
<maml:para>During importing, if a config that is to be imported has already been set, its value will be overwritten.</maml:para>
|
|
7753
|
+
</maml:description>
|
|
7754
|
+
<command:syntax>
|
|
7755
|
+
<command:syntaxItem>
|
|
7756
|
+
<maml:name>Import-AzConfig</maml:name>
|
|
7757
|
+
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none">
|
|
7758
|
+
<maml:name>Path</maml:name>
|
|
7759
|
+
<maml:description>
|
|
7760
|
+
<maml:para>Specifies the path to configuration saved by using Export-AzConfig.</maml:para>
|
|
7761
|
+
</maml:description>
|
|
7762
|
+
<command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
|
|
7763
|
+
<dev:type>
|
|
7764
|
+
<maml:name>System.String</maml:name>
|
|
7765
|
+
<maml:uri />
|
|
7766
|
+
</dev:type>
|
|
7767
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
7768
|
+
</command:parameter>
|
|
7769
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzContext, AzureRmContext, AzureCredential">
|
|
7770
|
+
<maml:name>DefaultProfile</maml:name>
|
|
7771
|
+
<maml:description>
|
|
7772
|
+
<maml:para>The credentials, account, tenant, and subscription used for communication with Azure.</maml:para>
|
|
7773
|
+
</maml:description>
|
|
7774
|
+
<command:parameterValue required="true" variableLength="false">Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer</command:parameterValue>
|
|
7775
|
+
<dev:type>
|
|
7776
|
+
<maml:name>Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer</maml:name>
|
|
7777
|
+
<maml:uri />
|
|
7778
|
+
</dev:type>
|
|
7779
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
7780
|
+
</command:parameter>
|
|
7781
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
7782
|
+
<maml:name>PassThru</maml:name>
|
|
7783
|
+
<maml:description>
|
|
7784
|
+
<maml:para>Returns a boolean value indicating success or failure.</maml:para>
|
|
7785
|
+
</maml:description>
|
|
7786
|
+
<dev:type>
|
|
7787
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
7788
|
+
<maml:uri />
|
|
7789
|
+
</dev:type>
|
|
7790
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
7791
|
+
</command:parameter>
|
|
7792
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf">
|
|
7793
|
+
<maml:name>Confirm</maml:name>
|
|
7794
|
+
<maml:description>
|
|
7795
|
+
<maml:para>Prompts you for confirmation before running the cmdlet.</maml:para>
|
|
6552
7796
|
</maml:description>
|
|
6553
|
-
<command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
|
|
6554
7797
|
<dev:type>
|
|
6555
|
-
<maml:name>System.
|
|
7798
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
6556
7799
|
<maml:uri />
|
|
6557
7800
|
</dev:type>
|
|
6558
|
-
<dev:defaultValue>
|
|
7801
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
6559
7802
|
</command:parameter>
|
|
6560
|
-
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="
|
|
6561
|
-
<maml:name>
|
|
7803
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi">
|
|
7804
|
+
<maml:name>WhatIf</maml:name>
|
|
6562
7805
|
<maml:description>
|
|
6563
|
-
<maml:para>
|
|
7806
|
+
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
|
|
6564
7807
|
</maml:description>
|
|
6565
|
-
<command:parameterValue required="true" variableLength="false">Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer</command:parameterValue>
|
|
6566
7808
|
<dev:type>
|
|
6567
|
-
<maml:name>
|
|
7809
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
6568
7810
|
<maml:uri />
|
|
6569
7811
|
</dev:type>
|
|
6570
|
-
<dev:defaultValue>
|
|
7812
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
6571
7813
|
</command:parameter>
|
|
6572
7814
|
</command:syntaxItem>
|
|
6573
7815
|
</command:syntax>
|
|
@@ -6575,7 +7817,7 @@ Subscription1 (xxxx-xxxx-xxxx-xxxx) azureuser@micros... Subscription1
|
|
|
6575
7817
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzContext, AzureRmContext, AzureCredential">
|
|
6576
7818
|
<maml:name>DefaultProfile</maml:name>
|
|
6577
7819
|
<maml:description>
|
|
6578
|
-
<maml:para>The credentials, tenant and subscription used for communication with
|
|
7820
|
+
<maml:para>The credentials, account, tenant, and subscription used for communication with Azure.</maml:para>
|
|
6579
7821
|
</maml:description>
|
|
6580
7822
|
<command:parameterValue required="true" variableLength="false">Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer</command:parameterValue>
|
|
6581
7823
|
<dev:type>
|
|
@@ -6584,10 +7826,22 @@ Subscription1 (xxxx-xxxx-xxxx-xxxx) azureuser@micros... Subscription1
|
|
|
6584
7826
|
</dev:type>
|
|
6585
7827
|
<dev:defaultValue>None</dev:defaultValue>
|
|
6586
7828
|
</command:parameter>
|
|
6587
|
-
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="
|
|
6588
|
-
<maml:name>
|
|
7829
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
7830
|
+
<maml:name>PassThru</maml:name>
|
|
6589
7831
|
<maml:description>
|
|
6590
|
-
<maml:para>
|
|
7832
|
+
<maml:para>Returns a boolean value indicating success or failure.</maml:para>
|
|
7833
|
+
</maml:description>
|
|
7834
|
+
<command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue>
|
|
7835
|
+
<dev:type>
|
|
7836
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
7837
|
+
<maml:uri />
|
|
7838
|
+
</dev:type>
|
|
7839
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
7840
|
+
</command:parameter>
|
|
7841
|
+
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none">
|
|
7842
|
+
<maml:name>Path</maml:name>
|
|
7843
|
+
<maml:description>
|
|
7844
|
+
<maml:para>Specifies the path to configuration saved by using Export-AzConfig.</maml:para>
|
|
6591
7845
|
</maml:description>
|
|
6592
7846
|
<command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
|
|
6593
7847
|
<dev:type>
|
|
@@ -6596,11 +7850,35 @@ Subscription1 (xxxx-xxxx-xxxx-xxxx) azureuser@micros... Subscription1
|
|
|
6596
7850
|
</dev:type>
|
|
6597
7851
|
<dev:defaultValue>None</dev:defaultValue>
|
|
6598
7852
|
</command:parameter>
|
|
7853
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf">
|
|
7854
|
+
<maml:name>Confirm</maml:name>
|
|
7855
|
+
<maml:description>
|
|
7856
|
+
<maml:para>Prompts you for confirmation before running the cmdlet.</maml:para>
|
|
7857
|
+
</maml:description>
|
|
7858
|
+
<command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue>
|
|
7859
|
+
<dev:type>
|
|
7860
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
7861
|
+
<maml:uri />
|
|
7862
|
+
</dev:type>
|
|
7863
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
7864
|
+
</command:parameter>
|
|
7865
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi">
|
|
7866
|
+
<maml:name>WhatIf</maml:name>
|
|
7867
|
+
<maml:description>
|
|
7868
|
+
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
|
|
7869
|
+
</maml:description>
|
|
7870
|
+
<command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue>
|
|
7871
|
+
<dev:type>
|
|
7872
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
7873
|
+
<maml:uri />
|
|
7874
|
+
</dev:type>
|
|
7875
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
7876
|
+
</command:parameter>
|
|
6599
7877
|
</command:parameters>
|
|
6600
7878
|
<command:inputTypes>
|
|
6601
7879
|
<command:inputType>
|
|
6602
7880
|
<dev:type>
|
|
6603
|
-
<maml:name>
|
|
7881
|
+
<maml:name>None</maml:name>
|
|
6604
7882
|
</dev:type>
|
|
6605
7883
|
<maml:description>
|
|
6606
7884
|
<maml:para></maml:para>
|
|
@@ -6610,7 +7888,7 @@ Subscription1 (xxxx-xxxx-xxxx-xxxx) azureuser@micros... Subscription1
|
|
|
6610
7888
|
<command:returnValues>
|
|
6611
7889
|
<command:returnValue>
|
|
6612
7890
|
<dev:type>
|
|
6613
|
-
<maml:name>
|
|
7891
|
+
<maml:name>System.Boolean</maml:name>
|
|
6614
7892
|
</dev:type>
|
|
6615
7893
|
<maml:description>
|
|
6616
7894
|
<maml:para></maml:para>
|
|
@@ -6624,30 +7902,10 @@ Subscription1 (xxxx-xxxx-xxxx-xxxx) azureuser@micros... Subscription1
|
|
|
6624
7902
|
</maml:alertSet>
|
|
6625
7903
|
<command:examples>
|
|
6626
7904
|
<command:example>
|
|
6627
|
-
<maml:title
|
|
6628
|
-
<dev:code>
|
|
6629
|
-
Get-AzTenant
|
|
6630
|
-
|
|
6631
|
-
Id Name Category Domains
|
|
6632
|
-
-- ----------- -------- -------
|
|
6633
|
-
xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Microsoft Home {test0.com, test1.com, test2.microsoft.com, test3.microsoft.com...}
|
|
6634
|
-
yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy Testhost Home testhost.onmicrosoft.com</dev:code>
|
|
6635
|
-
<dev:remarks>
|
|
6636
|
-
<maml:para>This example shows how to get all of the authorized tenants of an Azure account.</maml:para>
|
|
6637
|
-
<maml:para></maml:para>
|
|
6638
|
-
<maml:para></maml:para>
|
|
6639
|
-
</dev:remarks>
|
|
6640
|
-
</command:example>
|
|
6641
|
-
<command:example>
|
|
6642
|
-
<maml:title>------------- Example 2: Getting a specific tenant -------------</maml:title>
|
|
6643
|
-
<dev:code>Connect-AzAccount
|
|
6644
|
-
Get-AzTenant -TenantId xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
|
|
6645
|
-
|
|
6646
|
-
Id Name Category Domains
|
|
6647
|
-
-- ----------- -------- -------
|
|
6648
|
-
xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Microsoft Home {test0.com, test1.com, test2.microsoft.com, test3.microsoft.com...}</dev:code>
|
|
7905
|
+
<maml:title>-------------------------- Example 1 --------------------------</maml:title>
|
|
7906
|
+
<dev:code>Import-AzConfig -Path ./config.json</dev:code>
|
|
6649
7907
|
<dev:remarks>
|
|
6650
|
-
<maml:para>This example
|
|
7908
|
+
<maml:para>This example imports configs from file `./config.json`.</maml:para>
|
|
6651
7909
|
<maml:para></maml:para>
|
|
6652
7910
|
<maml:para></maml:para>
|
|
6653
7911
|
</dev:remarks>
|
|
@@ -6656,7 +7914,11 @@ xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx Microsoft Home {test0.com, test1.com,
|
|
|
6656
7914
|
<command:relatedLinks>
|
|
6657
7915
|
<maml:navigationLink>
|
|
6658
7916
|
<maml:linkText>Online Version:</maml:linkText>
|
|
6659
|
-
<maml:uri>https://learn.microsoft.com/powershell/module/az.accounts/
|
|
7917
|
+
<maml:uri>https://learn.microsoft.com/powershell/module/az.accounts/import-azconfig</maml:uri>
|
|
7918
|
+
</maml:navigationLink>
|
|
7919
|
+
<maml:navigationLink>
|
|
7920
|
+
<maml:linkText>Export-AzConfig</maml:linkText>
|
|
7921
|
+
<maml:uri></maml:uri>
|
|
6660
7922
|
</maml:navigationLink>
|
|
6661
7923
|
</command:relatedLinks>
|
|
6662
7924
|
</command:command>
|
|
@@ -7573,6 +8835,55 @@ Content : {"@odata.context":"https://graph.microsoft.com/v1.0/$metadata#users
|
|
|
7573
8835
|
<dev:remarks>
|
|
7574
8836
|
<maml:para>Get current signed in user via MicrosoftGraph API. This example is equivalent to `Get-AzADUser -SignedIn`.</maml:para>
|
|
7575
8837
|
<maml:para></maml:para>
|
|
8838
|
+
<maml:para></maml:para>
|
|
8839
|
+
</dev:remarks>
|
|
8840
|
+
</command:example>
|
|
8841
|
+
<command:example>
|
|
8842
|
+
<maml:title>-------------------------- Example 3 --------------------------</maml:title>
|
|
8843
|
+
<dev:code>$subscriptionId = (Get-AzContext).Subscription.ID
|
|
8844
|
+
Invoke-AzRestMethod -SubscriptionId $subscriptionId -ResourceGroupName "test-group" -ResourceProviderName Microsoft.AppPlatform -ResourceType Spring,apps -Name "test-spring-service" -ApiVersion 2020-07-01 -Method GET
|
|
8845
|
+
|
|
8846
|
+
Headers : {[Cache-Control, System.String[]], [Pragma, System.String[]], [Vary, System.String[]], [x-ms-request-id,
|
|
8847
|
+
System.String[]]…}
|
|
8848
|
+
Version : 1.1
|
|
8849
|
+
StatusCode : 200
|
|
8850
|
+
Method : GET
|
|
8851
|
+
Content : {"value":[{"properties":{"public":true,"url":"https://test-spring-service-demo.azuremicroservices.io","provisioni
|
|
8852
|
+
ngState":"Succeeded","activeDeploymentName":"default","fqdn":"test-spring-service.azuremicroservices.io","httpsOn
|
|
8853
|
+
ly":false,"createdTime":"2022-06-22T02:57:13.272Z","temporaryDisk":{"sizeInGB":5,"mountPath":"/tmp"},"pers
|
|
8854
|
+
istentDisk":{"sizeInGB":0,"mountPath":"/persistent"}},"type":"Microsoft.AppPlatform/Spring/apps","identity
|
|
8855
|
+
":null,"location":"eastus","id":"/subscriptions/$subscriptionId/resourceGroups/test-group/providers/Microsoft.AppPlatform/Spring/test-spring-service/apps/demo","name":"demo"},{"properties":{"publ
|
|
8856
|
+
ic":false,"provisioningState":"Succeeded","activeDeploymentName":"deploy01","fqdn":"test-spring-service.azuremicr
|
|
8857
|
+
oservices.io","httpsOnly":false,"createdTime":"2022-06-22T07:46:54.9Z","temporaryDisk":{"sizeInGB":5,"moun
|
|
8858
|
+
tPath":"/tmp"},"persistentDisk":{"sizeInGB":0,"mountPath":"/persistent"}},"type":"Microsoft.AppPlatform/Sp
|
|
8859
|
+
ring/apps","identity":null,"location":"eastus","id":"/subscriptions/$subscriptionId/r
|
|
8860
|
+
esourceGroups/test-group/providers/Microsoft.AppPlatform/Spring/test-spring-service/apps/pwsh01","name":"pwsh0
|
|
8861
|
+
1"}]}</dev:code>
|
|
8862
|
+
<dev:remarks>
|
|
8863
|
+
<maml:para>List apps under spring service "test-spring-service"</maml:para>
|
|
8864
|
+
<maml:para></maml:para>
|
|
8865
|
+
<maml:para></maml:para>
|
|
8866
|
+
</dev:remarks>
|
|
8867
|
+
</command:example>
|
|
8868
|
+
<command:example>
|
|
8869
|
+
<maml:title>-------------------------- Example 4 --------------------------</maml:title>
|
|
8870
|
+
<dev:code>$subscriptionId = (Get-AzContext).Subscription.ID
|
|
8871
|
+
Invoke-AzRestMethod -SubscriptionId $subscriptionId -ResourceGroupName "test-group" -ResourceProviderName Microsoft.AppPlatform -ResourceType Spring -Name "test-spring-service","demo" -ApiVersion 2020-07-01 -Method GET
|
|
8872
|
+
|
|
8873
|
+
Headers : {[Cache-Control, System.String[]], [Pragma, System.String[]], [Vary, System.String[]], [x-ms-request-id,
|
|
8874
|
+
System.String[]]…}
|
|
8875
|
+
Version : 1.1
|
|
8876
|
+
StatusCode : 200
|
|
8877
|
+
Method : GET
|
|
8878
|
+
Content : {"properties":{"public":true,"url":"https://test-spring-service-demo.azuremicroservices.io","provisioningState":"
|
|
8879
|
+
Succeeded","activeDeploymentName":"default","fqdn":"test-spring-service.azuremicroservices.io","httpsOnly":false,
|
|
8880
|
+
"createdTime":"2022-06-22T02:57:13.272Z","temporaryDisk":{"sizeInGB":5,"mountPath":"/tmp"},"persistentDisk
|
|
8881
|
+
":{"sizeInGB":0,"mountPath":"/persistent"}},"type":"Microsoft.AppPlatform/Spring/apps","identity":null,"lo
|
|
8882
|
+
cation":"eastus","id":"/subscriptions/$subscriptionId/resourceGroups/test-group/pr
|
|
8883
|
+
oviders/Microsoft.AppPlatform/Spring/test-spring-service/apps/demo","name":"demo"}</dev:code>
|
|
8884
|
+
<dev:remarks>
|
|
8885
|
+
<maml:para>Get app "demo" under Spring cloud service "test-spring-service"</maml:para>
|
|
8886
|
+
<maml:para></maml:para>
|
|
7576
8887
|
<maml:para></maml:para>
|
|
7577
8888
|
</dev:remarks>
|
|
7578
8889
|
</command:example>
|
|
@@ -9178,7 +10489,7 @@ Save-AzContext -Path C:\test.json</dev:code>
|
|
|
9178
10489
|
</maml:description>
|
|
9179
10490
|
</command:details>
|
|
9180
10491
|
<maml:description>
|
|
9181
|
-
<maml:para>Select a subscription to target (or account or tenant) in Azure PowerShell cmdlets. After this cmdlet, future cmdlets will target the
|
|
10492
|
+
<maml:para>Select a subscription to target (or account or tenant) in Azure PowerShell cmdlets. After this cmdlet, future cmdlets will target the selected context.</maml:para>
|
|
9182
10493
|
</maml:description>
|
|
9183
10494
|
<command:syntax>
|
|
9184
10495
|
<command:syntaxItem>
|
|
@@ -9427,8 +10738,7 @@ Work test@outlook.com Subscription1 AzureCloud xxxxxxxx-x..
|
|
|
9427
10738
|
</command:example>
|
|
9428
10739
|
<command:example>
|
|
9429
10740
|
<maml:title>-------------------------- Example 2 --------------------------</maml:title>
|
|
9430
|
-
<dev:code
|
|
9431
|
-
Select-AzContext -Name TestEnvironment -Scope Process</dev:code>
|
|
10741
|
+
<dev:code>Select-AzContext -Name TestEnvironment -Scope Process</dev:code>
|
|
9432
10742
|
<dev:remarks>
|
|
9433
10743
|
<maml:para></maml:para>
|
|
9434
10744
|
<maml:para></maml:para>
|
|
@@ -10755,7 +12065,7 @@ Tags :</dev:code>
|
|
|
10755
12065
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="7" aliases="Gallery, GalleryUrl">
|
|
10756
12066
|
<maml:name>GalleryEndpoint</maml:name>
|
|
10757
12067
|
<maml:description>
|
|
10758
|
-
<maml:para>Specifies the endpoint for the Azure Resource Manager gallery of deployment templates.</maml:para>
|
|
12068
|
+
<maml:para>Specifies the endpoint for the Azure Resource Manager gallery of deployment templates. The parameter is to set the value to `GalleryUrl` of `PSAzureEnvironment`. As `GalleryUrl` is removed from ArmMetadata, Azure PowerShell will no longer provide for the value and so it is not recommended to set `GalleryEndpoint` anymore.</maml:para>
|
|
10759
12069
|
</maml:description>
|
|
10760
12070
|
<command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
|
|
10761
12071
|
<dev:type>
|
|
@@ -11449,7 +12759,7 @@ Tags :</dev:code>
|
|
|
11449
12759
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="7" aliases="Gallery, GalleryUrl">
|
|
11450
12760
|
<maml:name>GalleryEndpoint</maml:name>
|
|
11451
12761
|
<maml:description>
|
|
11452
|
-
<maml:para>Specifies the endpoint for the Azure Resource Manager gallery of deployment templates.</maml:para>
|
|
12762
|
+
<maml:para>Specifies the endpoint for the Azure Resource Manager gallery of deployment templates. The parameter is to set the value to `GalleryUrl` of `PSAzureEnvironment`. As `GalleryUrl` is removed from ArmMetadata, Azure PowerShell will no longer provide for the value and so it is not recommended to set `GalleryEndpoint` anymore.</maml:para>
|
|
11453
12763
|
</maml:description>
|
|
11454
12764
|
<command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
|
|
11455
12765
|
<dev:type>
|
|
@@ -11717,7 +13027,174 @@ AzureAttestationServiceEndpointResourceId :
|
|
|
11717
13027
|
AzureSynapseAnalyticsEndpointSuffix :
|
|
11718
13028
|
AzureSynapseAnalyticsEndpointResourceId :</dev:code>
|
|
11719
13029
|
<dev:remarks>
|
|
11720
|
-
<maml:para>In this example we are creating a new Azure environment with sample endpoints using Add-AzEnvironment, and then we are changing the value of the ActiveDirectoryEndpoint and GraphEndpoint attributes of the created environment using the cmdlet Set-AzEnvironment.</maml:para>
|
|
13030
|
+
<maml:para>In this example we are creating a new Azure environment with sample endpoints using Add-AzEnvironment, and then we are changing the value of the ActiveDirectoryEndpoint and GraphEndpoint attributes of the created environment using the cmdlet Set-AzEnvironment.</maml:para>
|
|
13031
|
+
<maml:para></maml:para>
|
|
13032
|
+
<maml:para></maml:para>
|
|
13033
|
+
</dev:remarks>
|
|
13034
|
+
</command:example>
|
|
13035
|
+
</command:examples>
|
|
13036
|
+
<command:relatedLinks>
|
|
13037
|
+
<maml:navigationLink>
|
|
13038
|
+
<maml:linkText>Online Version:</maml:linkText>
|
|
13039
|
+
<maml:uri>https://learn.microsoft.com/powershell/module/az.accounts/set-azenvironment</maml:uri>
|
|
13040
|
+
</maml:navigationLink>
|
|
13041
|
+
<maml:navigationLink>
|
|
13042
|
+
<maml:linkText>Add-AzEnvironment</maml:linkText>
|
|
13043
|
+
<maml:uri></maml:uri>
|
|
13044
|
+
</maml:navigationLink>
|
|
13045
|
+
<maml:navigationLink>
|
|
13046
|
+
<maml:linkText>Get-AzEnvironment</maml:linkText>
|
|
13047
|
+
<maml:uri></maml:uri>
|
|
13048
|
+
</maml:navigationLink>
|
|
13049
|
+
<maml:navigationLink>
|
|
13050
|
+
<maml:linkText>Remove-AzEnvironment</maml:linkText>
|
|
13051
|
+
<maml:uri></maml:uri>
|
|
13052
|
+
</maml:navigationLink>
|
|
13053
|
+
</command:relatedLinks>
|
|
13054
|
+
</command:command>
|
|
13055
|
+
<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">
|
|
13056
|
+
<command:details>
|
|
13057
|
+
<command:name>Uninstall-AzureRm</command:name>
|
|
13058
|
+
<command:verb>Uninstall</command:verb>
|
|
13059
|
+
<command:noun>AzureRm</command:noun>
|
|
13060
|
+
<maml:description>
|
|
13061
|
+
<maml:para>Removes all AzureRm modules from a machine.</maml:para>
|
|
13062
|
+
</maml:description>
|
|
13063
|
+
</command:details>
|
|
13064
|
+
<maml:description>
|
|
13065
|
+
<maml:para>Removes all AzureRm modules from a machine.</maml:para>
|
|
13066
|
+
</maml:description>
|
|
13067
|
+
<command:syntax>
|
|
13068
|
+
<command:syntaxItem>
|
|
13069
|
+
<maml:name>Uninstall-AzureRm</maml:name>
|
|
13070
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzContext, AzureRmContext, AzureCredential">
|
|
13071
|
+
<maml:name>DefaultProfile</maml:name>
|
|
13072
|
+
<maml:description>
|
|
13073
|
+
<maml:para>The credentials, account, tenant, and subscription used for communication with Azure.</maml:para>
|
|
13074
|
+
</maml:description>
|
|
13075
|
+
<command:parameterValue required="true" variableLength="false">Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer</command:parameterValue>
|
|
13076
|
+
<dev:type>
|
|
13077
|
+
<maml:name>Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer</maml:name>
|
|
13078
|
+
<maml:uri />
|
|
13079
|
+
</dev:type>
|
|
13080
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
13081
|
+
</command:parameter>
|
|
13082
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
13083
|
+
<maml:name>PassThru</maml:name>
|
|
13084
|
+
<maml:description>
|
|
13085
|
+
<maml:para>Return list of Modules removed if specified.</maml:para>
|
|
13086
|
+
</maml:description>
|
|
13087
|
+
<dev:type>
|
|
13088
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
13089
|
+
<maml:uri />
|
|
13090
|
+
</dev:type>
|
|
13091
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
13092
|
+
</command:parameter>
|
|
13093
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf">
|
|
13094
|
+
<maml:name>Confirm</maml:name>
|
|
13095
|
+
<maml:description>
|
|
13096
|
+
<maml:para>Prompts you for confirmation before running the cmdlet.</maml:para>
|
|
13097
|
+
</maml:description>
|
|
13098
|
+
<dev:type>
|
|
13099
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
13100
|
+
<maml:uri />
|
|
13101
|
+
</dev:type>
|
|
13102
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
13103
|
+
</command:parameter>
|
|
13104
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi">
|
|
13105
|
+
<maml:name>WhatIf</maml:name>
|
|
13106
|
+
<maml:description>
|
|
13107
|
+
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
|
|
13108
|
+
</maml:description>
|
|
13109
|
+
<dev:type>
|
|
13110
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
13111
|
+
<maml:uri />
|
|
13112
|
+
</dev:type>
|
|
13113
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
13114
|
+
</command:parameter>
|
|
13115
|
+
</command:syntaxItem>
|
|
13116
|
+
</command:syntax>
|
|
13117
|
+
<command:parameters>
|
|
13118
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzContext, AzureRmContext, AzureCredential">
|
|
13119
|
+
<maml:name>DefaultProfile</maml:name>
|
|
13120
|
+
<maml:description>
|
|
13121
|
+
<maml:para>The credentials, account, tenant, and subscription used for communication with Azure.</maml:para>
|
|
13122
|
+
</maml:description>
|
|
13123
|
+
<command:parameterValue required="true" variableLength="false">Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer</command:parameterValue>
|
|
13124
|
+
<dev:type>
|
|
13125
|
+
<maml:name>Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer</maml:name>
|
|
13126
|
+
<maml:uri />
|
|
13127
|
+
</dev:type>
|
|
13128
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
13129
|
+
</command:parameter>
|
|
13130
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
13131
|
+
<maml:name>PassThru</maml:name>
|
|
13132
|
+
<maml:description>
|
|
13133
|
+
<maml:para>Return list of Modules removed if specified.</maml:para>
|
|
13134
|
+
</maml:description>
|
|
13135
|
+
<command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue>
|
|
13136
|
+
<dev:type>
|
|
13137
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
13138
|
+
<maml:uri />
|
|
13139
|
+
</dev:type>
|
|
13140
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
13141
|
+
</command:parameter>
|
|
13142
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf">
|
|
13143
|
+
<maml:name>Confirm</maml:name>
|
|
13144
|
+
<maml:description>
|
|
13145
|
+
<maml:para>Prompts you for confirmation before running the cmdlet.</maml:para>
|
|
13146
|
+
</maml:description>
|
|
13147
|
+
<command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue>
|
|
13148
|
+
<dev:type>
|
|
13149
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
13150
|
+
<maml:uri />
|
|
13151
|
+
</dev:type>
|
|
13152
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
13153
|
+
</command:parameter>
|
|
13154
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi">
|
|
13155
|
+
<maml:name>WhatIf</maml:name>
|
|
13156
|
+
<maml:description>
|
|
13157
|
+
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
|
|
13158
|
+
</maml:description>
|
|
13159
|
+
<command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue>
|
|
13160
|
+
<dev:type>
|
|
13161
|
+
<maml:name>System.Management.Automation.SwitchParameter</maml:name>
|
|
13162
|
+
<maml:uri />
|
|
13163
|
+
</dev:type>
|
|
13164
|
+
<dev:defaultValue>False</dev:defaultValue>
|
|
13165
|
+
</command:parameter>
|
|
13166
|
+
</command:parameters>
|
|
13167
|
+
<command:inputTypes>
|
|
13168
|
+
<command:inputType>
|
|
13169
|
+
<dev:type>
|
|
13170
|
+
<maml:name>None</maml:name>
|
|
13171
|
+
</dev:type>
|
|
13172
|
+
<maml:description>
|
|
13173
|
+
<maml:para></maml:para>
|
|
13174
|
+
</maml:description>
|
|
13175
|
+
</command:inputType>
|
|
13176
|
+
</command:inputTypes>
|
|
13177
|
+
<command:returnValues>
|
|
13178
|
+
<command:returnValue>
|
|
13179
|
+
<dev:type>
|
|
13180
|
+
<maml:name>System.String</maml:name>
|
|
13181
|
+
</dev:type>
|
|
13182
|
+
<maml:description>
|
|
13183
|
+
<maml:para></maml:para>
|
|
13184
|
+
</maml:description>
|
|
13185
|
+
</command:returnValue>
|
|
13186
|
+
</command:returnValues>
|
|
13187
|
+
<maml:alertSet>
|
|
13188
|
+
<maml:alert>
|
|
13189
|
+
<maml:para></maml:para>
|
|
13190
|
+
</maml:alert>
|
|
13191
|
+
</maml:alertSet>
|
|
13192
|
+
<command:examples>
|
|
13193
|
+
<command:example>
|
|
13194
|
+
<maml:title>-------------------------- Example 1 --------------------------</maml:title>
|
|
13195
|
+
<dev:code>Uninstall-AzureRm</dev:code>
|
|
13196
|
+
<dev:remarks>
|
|
13197
|
+
<maml:para>Running this command will remove all AzureRm modules from the machine for the version of PowerShell in which the cmdlet is run.</maml:para>
|
|
11721
13198
|
<maml:para></maml:para>
|
|
11722
13199
|
<maml:para></maml:para>
|
|
11723
13200
|
</dev:remarks>
|
|
@@ -11726,37 +13203,52 @@ AzureSynapseAnalyticsEndpointResourceId :</dev:code>
|
|
|
11726
13203
|
<command:relatedLinks>
|
|
11727
13204
|
<maml:navigationLink>
|
|
11728
13205
|
<maml:linkText>Online Version:</maml:linkText>
|
|
11729
|
-
<maml:uri>https://learn.microsoft.com/powershell/module/az.accounts/
|
|
11730
|
-
</maml:navigationLink>
|
|
11731
|
-
<maml:navigationLink>
|
|
11732
|
-
<maml:linkText>Add-AzEnvironment</maml:linkText>
|
|
11733
|
-
<maml:uri></maml:uri>
|
|
11734
|
-
</maml:navigationLink>
|
|
11735
|
-
<maml:navigationLink>
|
|
11736
|
-
<maml:linkText>Get-AzEnvironment</maml:linkText>
|
|
11737
|
-
<maml:uri></maml:uri>
|
|
11738
|
-
</maml:navigationLink>
|
|
11739
|
-
<maml:navigationLink>
|
|
11740
|
-
<maml:linkText>Remove-AzEnvironment</maml:linkText>
|
|
11741
|
-
<maml:uri></maml:uri>
|
|
13206
|
+
<maml:uri>https://learn.microsoft.com/powershell/module/az.accounts/uninstall-azurerm</maml:uri>
|
|
11742
13207
|
</maml:navigationLink>
|
|
11743
13208
|
</command:relatedLinks>
|
|
11744
13209
|
</command:command>
|
|
11745
13210
|
<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">
|
|
11746
13211
|
<command:details>
|
|
11747
|
-
<command:name>
|
|
11748
|
-
<command:verb>
|
|
11749
|
-
<command:noun>
|
|
13212
|
+
<command:name>Update-AzConfig</command:name>
|
|
13213
|
+
<command:verb>Update</command:verb>
|
|
13214
|
+
<command:noun>AzConfig</command:noun>
|
|
11750
13215
|
<maml:description>
|
|
11751
|
-
<maml:para>
|
|
13216
|
+
<maml:para>Updates the configs of Azure PowerShell.</maml:para>
|
|
11752
13217
|
</maml:description>
|
|
11753
13218
|
</command:details>
|
|
11754
13219
|
<maml:description>
|
|
11755
|
-
<maml:para>
|
|
13220
|
+
<maml:para>Updates the configs of Azure PowerShell. Depending on which config to update, you may specify the scope where the config is persisted and to which module or cmdlet it applies to.</maml:para>
|
|
13221
|
+
<maml:para>> [!NOTE] > It is discouraged to update configs in multiple PowerShell processes. Either do it in one process, or make sure the updates are at Process scope (`-Scope Process`) to avoid unexpected side-effects.</maml:para>
|
|
11756
13222
|
</maml:description>
|
|
11757
13223
|
<command:syntax>
|
|
11758
13224
|
<command:syntaxItem>
|
|
11759
|
-
<maml:name>
|
|
13225
|
+
<maml:name>Update-AzConfig</maml:name>
|
|
13226
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
13227
|
+
<maml:name>AppliesTo</maml:name>
|
|
13228
|
+
<maml:description>
|
|
13229
|
+
<maml:para>Specifies what part of Azure PowerShell the config applies to. Possible values are: - "Az": the config applies to all modules and cmdlets of Azure PowerShell.</maml:para>
|
|
13230
|
+
<maml:para>- Module name: the config applies to a certain module of Azure PowerShell.</maml:para>
|
|
13231
|
+
<maml:para>For example, "Az.Storage". - Cmdlet name: the config applies to a certain cmdlet of Azure PowerShell. For example, "Get-AzKeyVault". If not specified, when getting or clearing configs, it defaults to all the above; when updating, it defaults to "Az".</maml:para>
|
|
13232
|
+
</maml:description>
|
|
13233
|
+
<command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
|
|
13234
|
+
<dev:type>
|
|
13235
|
+
<maml:name>System.String</maml:name>
|
|
13236
|
+
<maml:uri />
|
|
13237
|
+
</dev:type>
|
|
13238
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
13239
|
+
</command:parameter>
|
|
13240
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
|
|
13241
|
+
<maml:name>CheckForUpgrade</maml:name>
|
|
13242
|
+
<maml:description>
|
|
13243
|
+
<maml:para>When enabled, Azure PowerShell will check for updates automatically and display a hint message when an update is available. The default value will be changed from false to true in Az version 11.0.0.</maml:para>
|
|
13244
|
+
</maml:description>
|
|
13245
|
+
<command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue>
|
|
13246
|
+
<dev:type>
|
|
13247
|
+
<maml:name>System.Boolean</maml:name>
|
|
13248
|
+
<maml:uri />
|
|
13249
|
+
</dev:type>
|
|
13250
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
13251
|
+
</command:parameter>
|
|
11760
13252
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzContext, AzureRmContext, AzureCredential">
|
|
11761
13253
|
<maml:name>DefaultProfile</maml:name>
|
|
11762
13254
|
<maml:description>
|
|
@@ -11769,16 +13261,107 @@ AzureSynapseAnalyticsEndpointResourceId :</dev:code>
|
|
|
11769
13261
|
</dev:type>
|
|
11770
13262
|
<dev:defaultValue>None</dev:defaultValue>
|
|
11771
13263
|
</command:parameter>
|
|
13264
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
|
|
13265
|
+
<maml:name>DefaultSubscriptionForLogin</maml:name>
|
|
13266
|
+
<maml:description>
|
|
13267
|
+
<maml:para>Subscription name or GUID. Sets the default context for Azure PowerShell when logging in without specifying a subscription.</maml:para>
|
|
13268
|
+
</maml:description>
|
|
13269
|
+
<command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
|
|
13270
|
+
<dev:type>
|
|
13271
|
+
<maml:name>System.String</maml:name>
|
|
13272
|
+
<maml:uri />
|
|
13273
|
+
</dev:type>
|
|
13274
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
13275
|
+
</command:parameter>
|
|
13276
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
|
|
13277
|
+
<maml:name>DisableErrorRecordsPersistence</maml:name>
|
|
13278
|
+
<maml:description>
|
|
13279
|
+
<maml:para>When disabled, error records will not be written to ~/.Azure/ErrorRecords. This config will be replaced by "EnableErrorRecordsPersistence" as opt-in in the next major release of Az around November 2023.</maml:para>
|
|
13280
|
+
</maml:description>
|
|
13281
|
+
<command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue>
|
|
13282
|
+
<dev:type>
|
|
13283
|
+
<maml:name>System.Boolean</maml:name>
|
|
13284
|
+
<maml:uri />
|
|
13285
|
+
</dev:type>
|
|
13286
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
13287
|
+
</command:parameter>
|
|
13288
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
|
|
13289
|
+
<maml:name>DisplayBreakingChangeWarning</maml:name>
|
|
13290
|
+
<maml:description>
|
|
13291
|
+
<maml:para>Controls if warning messages for breaking changes are displayed or suppressed. When enabled, a breaking change warning is displayed when executing cmdlets with breaking changes in a future release.</maml:para>
|
|
13292
|
+
</maml:description>
|
|
13293
|
+
<command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue>
|
|
13294
|
+
<dev:type>
|
|
13295
|
+
<maml:name>System.Boolean</maml:name>
|
|
13296
|
+
<maml:uri />
|
|
13297
|
+
</dev:type>
|
|
13298
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
13299
|
+
</command:parameter>
|
|
13300
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
|
|
13301
|
+
<maml:name>DisplayRegionIdentified</maml:name>
|
|
13302
|
+
<maml:description>
|
|
13303
|
+
<maml:para>When enabled, Azure PowerShell displays recommendations on regions which may reduce your costs.</maml:para>
|
|
13304
|
+
</maml:description>
|
|
13305
|
+
<command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue>
|
|
13306
|
+
<dev:type>
|
|
13307
|
+
<maml:name>System.Boolean</maml:name>
|
|
13308
|
+
<maml:uri />
|
|
13309
|
+
</dev:type>
|
|
13310
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
13311
|
+
</command:parameter>
|
|
13312
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
|
|
13313
|
+
<maml:name>DisplaySurveyMessage</maml:name>
|
|
13314
|
+
<maml:description>
|
|
13315
|
+
<maml:para>When enabled, you are prompted infrequently to participate in user experience surveys for Azure PowerShell.</maml:para>
|
|
13316
|
+
</maml:description>
|
|
13317
|
+
<command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue>
|
|
13318
|
+
<dev:type>
|
|
13319
|
+
<maml:name>System.Boolean</maml:name>
|
|
13320
|
+
<maml:uri />
|
|
13321
|
+
</dev:type>
|
|
13322
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
13323
|
+
</command:parameter>
|
|
13324
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
|
|
13325
|
+
<maml:name>EnableDataCollection</maml:name>
|
|
13326
|
+
<maml:description>
|
|
13327
|
+
<maml:para>When enabled, Azure PowerShell cmdlets send telemetry data to Microsoft to improve the customer experience. For more information, see our privacy statement: https://aka.ms/privacy</maml:para>
|
|
13328
|
+
</maml:description>
|
|
13329
|
+
<command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue>
|
|
13330
|
+
<dev:type>
|
|
13331
|
+
<maml:name>System.Boolean</maml:name>
|
|
13332
|
+
<maml:uri />
|
|
13333
|
+
</dev:type>
|
|
13334
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
13335
|
+
</command:parameter>
|
|
13336
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
|
|
13337
|
+
<maml:name>EnableLoginByWam</maml:name>
|
|
13338
|
+
<maml:description>
|
|
13339
|
+
<maml:para>[Preview] When enabled, Web Account Manager (WAM) will be the default interactive login experience. It will fall back to using the browser if the platform does not support WAM. Note that this feature is under preview. Microsoft Account (MSA) is currently not supported. Feel free to reach out to Azure PowerShell team if you have any feedbacks: https://aka.ms/azpsissue</maml:para>
|
|
13340
|
+
</maml:description>
|
|
13341
|
+
<command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue>
|
|
13342
|
+
<dev:type>
|
|
13343
|
+
<maml:name>System.Boolean</maml:name>
|
|
13344
|
+
<maml:uri />
|
|
13345
|
+
</dev:type>
|
|
13346
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
13347
|
+
</command:parameter>
|
|
11772
13348
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
11773
|
-
<maml:name>
|
|
13349
|
+
<maml:name>Scope</maml:name>
|
|
11774
13350
|
<maml:description>
|
|
11775
|
-
<maml:para>
|
|
13351
|
+
<maml:para>Determines the scope of config changes, for example, whether changes apply only to the current process, or to all sessions started by this user. By default it is CurrentUser.</maml:para>
|
|
11776
13352
|
</maml:description>
|
|
13353
|
+
<command:parameterValueGroup>
|
|
13354
|
+
<command:parameterValue required="false" command:variableLength="false">CurrentUser</command:parameterValue>
|
|
13355
|
+
<command:parameterValue required="false" command:variableLength="false">Process</command:parameterValue>
|
|
13356
|
+
<command:parameterValue required="false" command:variableLength="false">Default</command:parameterValue>
|
|
13357
|
+
<command:parameterValue required="false" command:variableLength="false">Environment</command:parameterValue>
|
|
13358
|
+
</command:parameterValueGroup>
|
|
13359
|
+
<command:parameterValue required="true" variableLength="false">Microsoft.Azure.PowerShell.Common.Config.ConfigScope</command:parameterValue>
|
|
11777
13360
|
<dev:type>
|
|
11778
|
-
<maml:name>
|
|
13361
|
+
<maml:name>Microsoft.Azure.PowerShell.Common.Config.ConfigScope</maml:name>
|
|
11779
13362
|
<maml:uri />
|
|
11780
13363
|
</dev:type>
|
|
11781
|
-
<dev:defaultValue>
|
|
13364
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
11782
13365
|
</command:parameter>
|
|
11783
13366
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf">
|
|
11784
13367
|
<maml:name>Confirm</maml:name>
|
|
@@ -11805,6 +13388,32 @@ AzureSynapseAnalyticsEndpointResourceId :</dev:code>
|
|
|
11805
13388
|
</command:syntaxItem>
|
|
11806
13389
|
</command:syntax>
|
|
11807
13390
|
<command:parameters>
|
|
13391
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
13392
|
+
<maml:name>AppliesTo</maml:name>
|
|
13393
|
+
<maml:description>
|
|
13394
|
+
<maml:para>Specifies what part of Azure PowerShell the config applies to. Possible values are: - "Az": the config applies to all modules and cmdlets of Azure PowerShell.</maml:para>
|
|
13395
|
+
<maml:para>- Module name: the config applies to a certain module of Azure PowerShell.</maml:para>
|
|
13396
|
+
<maml:para>For example, "Az.Storage". - Cmdlet name: the config applies to a certain cmdlet of Azure PowerShell. For example, "Get-AzKeyVault". If not specified, when getting or clearing configs, it defaults to all the above; when updating, it defaults to "Az".</maml:para>
|
|
13397
|
+
</maml:description>
|
|
13398
|
+
<command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
|
|
13399
|
+
<dev:type>
|
|
13400
|
+
<maml:name>System.String</maml:name>
|
|
13401
|
+
<maml:uri />
|
|
13402
|
+
</dev:type>
|
|
13403
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
13404
|
+
</command:parameter>
|
|
13405
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
|
|
13406
|
+
<maml:name>CheckForUpgrade</maml:name>
|
|
13407
|
+
<maml:description>
|
|
13408
|
+
<maml:para>When enabled, Azure PowerShell will check for updates automatically and display a hint message when an update is available. The default value will be changed from false to true in Az version 11.0.0.</maml:para>
|
|
13409
|
+
</maml:description>
|
|
13410
|
+
<command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue>
|
|
13411
|
+
<dev:type>
|
|
13412
|
+
<maml:name>System.Boolean</maml:name>
|
|
13413
|
+
<maml:uri />
|
|
13414
|
+
</dev:type>
|
|
13415
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
13416
|
+
</command:parameter>
|
|
11808
13417
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzContext, AzureRmContext, AzureCredential">
|
|
11809
13418
|
<maml:name>DefaultProfile</maml:name>
|
|
11810
13419
|
<maml:description>
|
|
@@ -11817,17 +13426,101 @@ AzureSynapseAnalyticsEndpointResourceId :</dev:code>
|
|
|
11817
13426
|
</dev:type>
|
|
11818
13427
|
<dev:defaultValue>None</dev:defaultValue>
|
|
11819
13428
|
</command:parameter>
|
|
13429
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
|
|
13430
|
+
<maml:name>DefaultSubscriptionForLogin</maml:name>
|
|
13431
|
+
<maml:description>
|
|
13432
|
+
<maml:para>Subscription name or GUID. Sets the default context for Azure PowerShell when logging in without specifying a subscription.</maml:para>
|
|
13433
|
+
</maml:description>
|
|
13434
|
+
<command:parameterValue required="true" variableLength="false">System.String</command:parameterValue>
|
|
13435
|
+
<dev:type>
|
|
13436
|
+
<maml:name>System.String</maml:name>
|
|
13437
|
+
<maml:uri />
|
|
13438
|
+
</dev:type>
|
|
13439
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
13440
|
+
</command:parameter>
|
|
13441
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
|
|
13442
|
+
<maml:name>DisableErrorRecordsPersistence</maml:name>
|
|
13443
|
+
<maml:description>
|
|
13444
|
+
<maml:para>When disabled, error records will not be written to ~/.Azure/ErrorRecords. This config will be replaced by "EnableErrorRecordsPersistence" as opt-in in the next major release of Az around November 2023.</maml:para>
|
|
13445
|
+
</maml:description>
|
|
13446
|
+
<command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue>
|
|
13447
|
+
<dev:type>
|
|
13448
|
+
<maml:name>System.Boolean</maml:name>
|
|
13449
|
+
<maml:uri />
|
|
13450
|
+
</dev:type>
|
|
13451
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
13452
|
+
</command:parameter>
|
|
13453
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
|
|
13454
|
+
<maml:name>DisplayBreakingChangeWarning</maml:name>
|
|
13455
|
+
<maml:description>
|
|
13456
|
+
<maml:para>Controls if warning messages for breaking changes are displayed or suppressed. When enabled, a breaking change warning is displayed when executing cmdlets with breaking changes in a future release.</maml:para>
|
|
13457
|
+
</maml:description>
|
|
13458
|
+
<command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue>
|
|
13459
|
+
<dev:type>
|
|
13460
|
+
<maml:name>System.Boolean</maml:name>
|
|
13461
|
+
<maml:uri />
|
|
13462
|
+
</dev:type>
|
|
13463
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
13464
|
+
</command:parameter>
|
|
13465
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
|
|
13466
|
+
<maml:name>DisplayRegionIdentified</maml:name>
|
|
13467
|
+
<maml:description>
|
|
13468
|
+
<maml:para>When enabled, Azure PowerShell displays recommendations on regions which may reduce your costs.</maml:para>
|
|
13469
|
+
</maml:description>
|
|
13470
|
+
<command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue>
|
|
13471
|
+
<dev:type>
|
|
13472
|
+
<maml:name>System.Boolean</maml:name>
|
|
13473
|
+
<maml:uri />
|
|
13474
|
+
</dev:type>
|
|
13475
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
13476
|
+
</command:parameter>
|
|
13477
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
|
|
13478
|
+
<maml:name>DisplaySurveyMessage</maml:name>
|
|
13479
|
+
<maml:description>
|
|
13480
|
+
<maml:para>When enabled, you are prompted infrequently to participate in user experience surveys for Azure PowerShell.</maml:para>
|
|
13481
|
+
</maml:description>
|
|
13482
|
+
<command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue>
|
|
13483
|
+
<dev:type>
|
|
13484
|
+
<maml:name>System.Boolean</maml:name>
|
|
13485
|
+
<maml:uri />
|
|
13486
|
+
</dev:type>
|
|
13487
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
13488
|
+
</command:parameter>
|
|
13489
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
|
|
13490
|
+
<maml:name>EnableDataCollection</maml:name>
|
|
13491
|
+
<maml:description>
|
|
13492
|
+
<maml:para>When enabled, Azure PowerShell cmdlets send telemetry data to Microsoft to improve the customer experience. For more information, see our privacy statement: https://aka.ms/privacy</maml:para>
|
|
13493
|
+
</maml:description>
|
|
13494
|
+
<command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue>
|
|
13495
|
+
<dev:type>
|
|
13496
|
+
<maml:name>System.Boolean</maml:name>
|
|
13497
|
+
<maml:uri />
|
|
13498
|
+
</dev:type>
|
|
13499
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
13500
|
+
</command:parameter>
|
|
13501
|
+
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none">
|
|
13502
|
+
<maml:name>EnableLoginByWam</maml:name>
|
|
13503
|
+
<maml:description>
|
|
13504
|
+
<maml:para>[Preview] When enabled, Web Account Manager (WAM) will be the default interactive login experience. It will fall back to using the browser if the platform does not support WAM. Note that this feature is under preview. Microsoft Account (MSA) is currently not supported. Feel free to reach out to Azure PowerShell team if you have any feedbacks: https://aka.ms/azpsissue</maml:para>
|
|
13505
|
+
</maml:description>
|
|
13506
|
+
<command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue>
|
|
13507
|
+
<dev:type>
|
|
13508
|
+
<maml:name>System.Boolean</maml:name>
|
|
13509
|
+
<maml:uri />
|
|
13510
|
+
</dev:type>
|
|
13511
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
13512
|
+
</command:parameter>
|
|
11820
13513
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
|
|
11821
|
-
<maml:name>
|
|
13514
|
+
<maml:name>Scope</maml:name>
|
|
11822
13515
|
<maml:description>
|
|
11823
|
-
<maml:para>
|
|
13516
|
+
<maml:para>Determines the scope of config changes, for example, whether changes apply only to the current process, or to all sessions started by this user. By default it is CurrentUser.</maml:para>
|
|
11824
13517
|
</maml:description>
|
|
11825
|
-
<command:parameterValue required="true" variableLength="false">
|
|
13518
|
+
<command:parameterValue required="true" variableLength="false">Microsoft.Azure.PowerShell.Common.Config.ConfigScope</command:parameterValue>
|
|
11826
13519
|
<dev:type>
|
|
11827
|
-
<maml:name>
|
|
13520
|
+
<maml:name>Microsoft.Azure.PowerShell.Common.Config.ConfigScope</maml:name>
|
|
11828
13521
|
<maml:uri />
|
|
11829
13522
|
</dev:type>
|
|
11830
|
-
<dev:defaultValue>
|
|
13523
|
+
<dev:defaultValue>None</dev:defaultValue>
|
|
11831
13524
|
</command:parameter>
|
|
11832
13525
|
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf">
|
|
11833
13526
|
<maml:name>Confirm</maml:name>
|
|
@@ -11857,7 +13550,15 @@ AzureSynapseAnalyticsEndpointResourceId :</dev:code>
|
|
|
11857
13550
|
<command:inputTypes>
|
|
11858
13551
|
<command:inputType>
|
|
11859
13552
|
<dev:type>
|
|
11860
|
-
<maml:name>
|
|
13553
|
+
<maml:name>System.String</maml:name>
|
|
13554
|
+
</dev:type>
|
|
13555
|
+
<maml:description>
|
|
13556
|
+
<maml:para></maml:para>
|
|
13557
|
+
</maml:description>
|
|
13558
|
+
</command:inputType>
|
|
13559
|
+
<command:inputType>
|
|
13560
|
+
<dev:type>
|
|
13561
|
+
<maml:name>System.Boolean</maml:name>
|
|
11861
13562
|
</dev:type>
|
|
11862
13563
|
<maml:description>
|
|
11863
13564
|
<maml:para></maml:para>
|
|
@@ -11867,7 +13568,7 @@ AzureSynapseAnalyticsEndpointResourceId :</dev:code>
|
|
|
11867
13568
|
<command:returnValues>
|
|
11868
13569
|
<command:returnValue>
|
|
11869
13570
|
<dev:type>
|
|
11870
|
-
<maml:name>
|
|
13571
|
+
<maml:name>Microsoft.Azure.Commands.Profile.Models.PSConfig</maml:name>
|
|
11871
13572
|
</dev:type>
|
|
11872
13573
|
<maml:description>
|
|
11873
13574
|
<maml:para></maml:para>
|
|
@@ -11882,9 +13583,39 @@ AzureSynapseAnalyticsEndpointResourceId :</dev:code>
|
|
|
11882
13583
|
<command:examples>
|
|
11883
13584
|
<command:example>
|
|
11884
13585
|
<maml:title>-------------------------- Example 1 --------------------------</maml:title>
|
|
11885
|
-
<dev:code>
|
|
13586
|
+
<dev:code>Update-AzConfig -DefaultSubscriptionForLogin "Name of subscription"
|
|
13587
|
+
|
|
13588
|
+
Key Value Applies To Scope Help Message
|
|
13589
|
+
--- ----- ---------- ----- ------------
|
|
13590
|
+
DefaultSubscriptionForLogin Name of subscription Az CurrentUser Subscription name or GUID. Sets the default context for Azure PowerShell when lo…</dev:code>
|
|
11886
13591
|
<dev:remarks>
|
|
11887
|
-
<maml:para>
|
|
13592
|
+
<maml:para>Sets the "DefaultSubscriptionForLogin" config as "Name of subscription". When `Connect-AzAccount` the specified subscription will be selected as the default subscription.</maml:para>
|
|
13593
|
+
<maml:para></maml:para>
|
|
13594
|
+
<maml:para></maml:para>
|
|
13595
|
+
</dev:remarks>
|
|
13596
|
+
</command:example>
|
|
13597
|
+
<command:example>
|
|
13598
|
+
<maml:title>-------------------------- Example 2 --------------------------</maml:title>
|
|
13599
|
+
<dev:code>Update-AzConfig -DisplayBreakingChangeWarning $false -AppliesTo "Az.KeyVault"
|
|
13600
|
+
|
|
13601
|
+
Key Value Applies To Scope Help Message
|
|
13602
|
+
--- ----- ---------- ----- ------------
|
|
13603
|
+
DisplayBreakingChangeWarning False Az.KeyVault CurrentUser Controls if warning messages for breaking changes are displayed or suppressed. When enabled,…</dev:code>
|
|
13604
|
+
<dev:remarks>
|
|
13605
|
+
<maml:para>Sets the "DisplayBreakingChangeWarnings" config as "$false" for "Az.KeyVault" module. This prevents all the warning messages for upcoming breaking changes in Az.KeyVault module from prompting.</maml:para>
|
|
13606
|
+
<maml:para></maml:para>
|
|
13607
|
+
<maml:para></maml:para>
|
|
13608
|
+
</dev:remarks>
|
|
13609
|
+
</command:example>
|
|
13610
|
+
<command:example>
|
|
13611
|
+
<maml:title>-------------------------- Example 3 --------------------------</maml:title>
|
|
13612
|
+
<dev:code>Update-AzConfig -EnableDataCollection $true
|
|
13613
|
+
|
|
13614
|
+
Key Value Applies To Scope Help Message
|
|
13615
|
+
--- ----- ---------- ----- ------------
|
|
13616
|
+
EnableDataCollection True Az CurrentUser When enabled, Azure PowerShell cmdlets send telemetry data to Microsoft to improve the customer experi…</dev:code>
|
|
13617
|
+
<dev:remarks>
|
|
13618
|
+
<maml:para>Sets the "EnableDataCollection" config as "$true". This enables sending the telemetry data. Setting this config is equivalent to `Enable-AzDataCollection` and `Disable-AzDataCollection`.</maml:para>
|
|
11888
13619
|
<maml:para></maml:para>
|
|
11889
13620
|
<maml:para></maml:para>
|
|
11890
13621
|
</dev:remarks>
|
|
@@ -11893,7 +13624,7 @@ AzureSynapseAnalyticsEndpointResourceId :</dev:code>
|
|
|
11893
13624
|
<command:relatedLinks>
|
|
11894
13625
|
<maml:navigationLink>
|
|
11895
13626
|
<maml:linkText>Online Version:</maml:linkText>
|
|
11896
|
-
<maml:uri>https://learn.microsoft.com/powershell/module/az.accounts/
|
|
13627
|
+
<maml:uri>https://learn.microsoft.com/powershell/module/az.accounts/update-azconfig</maml:uri>
|
|
11897
13628
|
</maml:navigationLink>
|
|
11898
13629
|
</command:relatedLinks>
|
|
11899
13630
|
</command:command>
|