Skip to content

Commit 1ff83a8

Browse files
[BULK] DocuTune - Updates to Azure AD rebranding guidance and DocuTune configuration (part 6) (#22894)
* [BULK] DocuTune - Updates to Azure AD rebranding g * Update src/Ssh/Ssh/help/Enter-AzVM.md * Update src/Ssh/Ssh/help/Enter-AzVM.md * Update src/Ssh/Ssh/help/Export-AzSshConfig.md * Update src/Ssh/Ssh/help/Enter-AzVM.md * Update src/Storage/Storage.Management/help/New-AzStorageAccount.md * Update src/Storage/Storage.Management/help/Set-AzStorageAccount.md * Update src/Ssh/Ssh/help/Export-AzSshConfig.md * Update Disable-AzSynapseActiveDirectoryOnlyAuthentication.md --------- Co-authored-by: Beisi Zhou <[email protected]>
1 parent 2b8cc00 commit 1ff83a8

19 files changed

+77
-83
lines changed

src/Ssh/Ssh/help/Enter-AzVM.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ schema: 2.0.0
99

1010
## SYNOPSIS
1111
Starts an interactive SSH session to an Azure Resource (such as Azure VMs or Arc Servers).
12-
Users can login using AAD accounts, or local user accounts via standard SSH authentication. Use AAD account login for the best security and convenience.
12+
Users can login using Microsoft Entra accounts, or local user accounts via standard SSH authentication. Use Microsoft Entra account login for the best security and convenience.
1313

1414
## SYNTAX
1515

@@ -37,17 +37,17 @@ Enter-AzVM -ResourceId <String> [-PublicKeyFile <String>] [-PrivateKeyFile <Stri
3737

3838
## DESCRIPTION
3939
Start interactive SSH session to an Azure Resource (currently supports Azure VMs and Arc Servers).
40-
Users can login using AAD issued certificates or using local user credentials. We recommend login using AAD issued certificates when possible.
40+
Users can login using Microsoft Entra issued certificates or using local user credentials. We recommend login using Microsoft Entra issued certificates when possible.
4141
Important note: When connecting to Azure Arc resources, this cmdlet requires the Az.Ssh.ArcProxy module to also be installed in the client machine. The cmdlet will attempt to install the module from the PowerShell Gallery, but the user also has the option to install it themselves. It is important that the user also has permission to execute the Proxy files in the Az.Ssh.ArcProxy module, or the connection will fail. You can find the Az.Ssh.ArcServer module in the PowerShell Gallery: https://aka.ms/PowerShellGallery-Az.Ssh.ArcProxy.
4242

4343
## EXAMPLES
4444

45-
### Example 1: Connect to Azure Resource using AAD issued certificates
45+
### Example 1: Connect to Azure Resource using Microsoft Entra issued certificates
4646
```powershell
4747
Enter-AzVM -ResourceGroupName myRg -Name myMachine
4848
```
4949

50-
When a -LocalUser is not supplied, the cmdlet will attempt to login using Azure AD. This is currently only supported for resources running Linux OS.
50+
When a -LocalUser is not supplied, the cmdlet will attempt to login using Microsoft Entra ID. This is currently only supported for resources running Linux OS.
5151

5252
### Example 2: Connect to Local User on Azure Resource using SSH certificates for authentication
5353
```powershell
@@ -66,7 +66,7 @@ Enter-AzVM -ResourceGroupName myRg -Name myMachine -LocalUser azureuser -Private
6666
Enter-AzVM -ResourceGroupName myRg -Name myMachine -LocalUser azureuser
6767
```
6868

69-
### Example 5: Connect to the Public Ip of an Azure Virtual Machine using AAD issued certificates
69+
### Example 5: Connect to the Public Ip of an Azure Virtual Machine using Microsoft Entra issued certificates
7070
```powershell
7171
Enter-AzVM -Ip 1.2.3.4
7272
```
@@ -78,7 +78,7 @@ Enter-AzVM -ResourceGroupName myRg -Name myMachine -ResourceType Microsoft.Hybri
7878

7979
This parameter is useful when there is more than one supported resource with the same name in the Resource Group.
8080

81-
### Example 7: Connect to Azure Resource using AAD certificate issued certificates and custom key files
81+
### Example 7: Connect to Azure Resource using Microsoft Entra certificate issued certificates and custom key files
8282
```powershell
8383
Enter-AzVM -ResourceGroupName myRg -Name myMachine -PrivateKeyFile ./id_rsa -PublicKeyFile ./id_rsa.pub
8484
```
@@ -354,5 +354,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
354354
355355
[SSH Access to Arzure Arc-enabled servers](https://learn.microsoft.com/en-us/azure/azure-arc/servers/ssh-arc-overview?tabs=azure-cli)
356356
[Troubleshoot SSH access to Azure Arc Enabled Servers](https://learn.microsoft.com/en-us/azure/azure-arc/servers/ssh-arc-troubleshoot)
357-
[Login to a Linux VM by using Azure AD](https://learn.microsoft.com/en-us/azure/active-directory/devices/howto-vm-sign-in-azure-ad-linux)
357+
[Login to a Linux VM by using Microsoft Entra ID](https://learn.microsoft.com/en-us/azure/active-directory/devices/howto-vm-sign-in-azure-ad-linux)
358358
[Install OpenSSH for Windows](https://learn.microsoft.com/en-us/windows-server/administration/openssh/openssh_install_firstuse?tabs=gui)

src/Ssh/Ssh/help/Export-AzSshConfig.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ schema: 2.0.0
88
# Export-AzSshConfig
99

1010
## SYNOPSIS
11-
This cmdlet exports an SSH configuration file that can be used to connect to Azure Resources through client applications that support OpenSSH config and certificates. SSH config files can be created that use AAD issued certificates or local user credentials.
11+
This cmdlet exports an SSH configuration file that can be used to connect to Azure Resources through client applications that support OpenSSH config and certificates. SSH config files can be created that use Microsoft Entra ID issued certificates or local user credentials.
1212

1313
## SYNTAX
1414

@@ -39,20 +39,20 @@ Export-AzSshConfig -ResourceId <String> -ConfigFilePath <String> [-PublicKeyFile
3939
The exported SSH configuration file can be used to connect to Azure Resources by client applications that support OpenSSH config and certificates. Applications such as git and rsync can use configuration file by setting the command to 'ssh -F /path/to/config'.
4040
For example:
4141
rsync -e 'ssh -F /path/to/config'.
42-
Users can create ssh config files that use AAD issued certificates or local user credentials.
42+
Users can create ssh config files that use Microsoft Entra ID issued certificates or local user credentials.
4343
Important note: When connecting to Azure Arc resources, this cmdlet requires the Az.Ssh.ArcProxy module to also be installed in the client machine. The cmdlet will attempt to install the module from the PowerShell Gallery, but the user also has the option to install it themselves. It is important that the user also has permission to execute the Proxy files in the Az.Ssh.ArcProxy module, or the connection will fail. You can find the Az.Ssh.ArcServer module in the PowerShell Gallery: https://aka.ms/PowerShellGallery-Az.Ssh.ArcProxy.
4444

4545
## EXAMPLES
4646

47-
### Example 1: Export a SSH configuration file for connecting to a resource using AAD issued certificates for authentication.
47+
### Example 1: Export a SSH configuration file for connecting to a resource using Microsoft Entra ID issued certificates for authentication.
4848
```powershell
4949
Export-AzSshConfig -ResourceGroupName myRg -Name myMachine -ConfigFilePath ./sshconfig.config
5050
```
5151

52-
When a -LocalUser is not supplied, the cmdlet will attempt to create a certificate to login using Azure AD. This is currently only supported for resources running Linux OS.
53-
When using Azure AD to login to resource, the Host name in the configuration entry will be "{resource group name}-{resource name}", or "{ip address}" for Azure VMs.
52+
When a -LocalUser is not supplied, the cmdlet will attempt to create a certificate to login using Microsoft Entra ID. This is currently only supported for resources running Linux OS.
53+
When using Microsoft Entra ID to login to resource, the Host name in the configuration entry will be "{resource group name}-{resource name}", or "{ip address}" for Azure VMs.
5454

55-
### Example 2: Export a SSH configuration file for connecting to the Public Ip of an Azure Virtual Machine using AAD issued certificates.
55+
### Example 2: Export a SSH configuration file for connecting to the Public Ip of an Azure Virtual Machine using Microsoft Entra ID issued certificates.
5656
```powershell
5757
Export-AzSshConfig -Ip 1.2.3.4 -ConfigFilePath ./sshconfig.config
5858
```
@@ -355,5 +355,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
355355
356356
[SSH Access to Arzure Arc-enabled servers](https://learn.microsoft.com/en-us/azure/azure-arc/servers/ssh-arc-overview?tabs=azure-cli)
357357
[Troubleshoot SSH access to Azure Arc Enabled Servers](https://learn.microsoft.com/en-us/azure/azure-arc/servers/ssh-arc-troubleshoot)
358-
[Login to a Linux VM by using Azure AD](https://learn.microsoft.com/en-us/azure/active-directory/devices/howto-vm-sign-in-azure-ad-linux)
358+
[Login to a Linux VM by using Microsoft Entra ID](https://learn.microsoft.com/en-us/azure/active-directory/devices/howto-vm-sign-in-azure-ad-linux)
359359
[Install OpenSSH for Windows](https://learn.microsoft.com/en-us/windows-server/administration/openssh/openssh_install_firstuse?tabs=gui)

src/StackHCI/help/Register-AzStackHCI.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -262,7 +262,7 @@ Accept wildcard characters: False
262262
263263
### -RepairRegistration
264264
Repair the current Azure Stack HCI registration with the cloud.
265-
This cmdlet deletes the local certificates on the clustered nodes and the remote certificates in the Azure AD application in the cloud and generates new replacement certificates for both.
265+
This cmdlet deletes the local certificates on the clustered nodes and the remote certificates in the Microsoft Entra application in the cloud and generates new replacement certificates for both.
266266
The resource group, resource name, and other registration choices are preserved.
267267
268268
```yaml
@@ -419,4 +419,3 @@ PortalResourceURL: Azure Portal Resource URL.
419419
ALIASES
420420
421421
## RELATED LINKS
422-

src/Storage/Storage.Management/help/Get-AzDataLakeGen2ChildItem.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@ Accept wildcard characters: False
190190
```
191191
192192
### -OutputUserPrincipalName
193-
If speicify this parameter, the user identity values returned in the owner and group fields of each list entry will be transformed from Azure Active Directory Object IDs to User Principal Names. If not speicify this parameter, the values will be returned as Azure Active Directory Object IDs. Note that group and application Object IDs are not translated because they do not have unique friendly names.
193+
If speicify this parameter, the user identity values returned in the owner and group fields of each list entry will be transformed from Microsoft Entra Object IDs to User Principal Names. If not speicify this parameter, the values will be returned as Microsoft Entra Object IDs. Note that group and application Object IDs are not translated because they do not have unique friendly names.
194194
195195
```yaml
196196
Type: System.Management.Automation.SwitchParameter

src/Storage/Storage.Management/help/Get-AzStorageAccountKey.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ Accept wildcard characters: False
7272
7373
### -ListKerbKey
7474
Lists the Kerberos keys (if active directory enabled) for the specified storage account.
75-
Kerberos key is generated per storage account for Azure Files identity based authentication either with Azure Active Directory Domain Service (Azure AD DS) or Active Directory Domain Service (AD DS).
75+
Kerberos key is generated per storage account for Azure Files identity based authentication either with Microsoft Entra Domain Service (Microsoft Entra Domain Services) or Active Directory Domain Service (AD DS).
7676
It is used as the password of the identity registered in the domain service that represents the storage account.
7777
Kerberos key does not provide access permission to perform any control or data plane read or write operations against the storage account.
7878
@@ -134,5 +134,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
134134
## RELATED LINKS
135135
136136
[New-AzStorageAccountKey](./New-AzStorageAccountKey.md)
137-
138-

src/Storage/Storage.Management/help/New-AzStorageAccount.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -120,12 +120,12 @@ New-AzStorageAccount -ResourceGroupName "MyResourceGroup" -AccountName "mystorag
120120

121121
This command creates a Storage account with Hierarchical Namespace enabled, Sftp enabled, and localuser enabled.
122122

123-
### Example 6: Create a Storage account with Azure Files AAD DS Authentication, and enable large file share.
123+
### Example 6: Create a Storage account with Azure Files Microsoft Entra Domain Services Authentication, and enable large file share.
124124
```powershell
125125
New-AzStorageAccount -ResourceGroupName "MyResourceGroup" -Name "mystorageaccount" -Location "eastus2euap" -SkuName "Standard_LRS" -Kind StorageV2 -EnableAzureActiveDirectoryDomainServicesForFile $true -EnableLargeFileShare
126126
```
127127

128-
This command creates a Storage account with Azure Files AAD DS Authentication, and enable large file share.
128+
This command creates a Storage account with Azure Files Microsoft Entra Domain Services Authentication, and enable large file share.
129129

130130
### Example 7: Create a Storage account with enable Files Active Directory Domain Service Authentication and DefaultSharePermission.
131131
```powershell
@@ -539,7 +539,7 @@ Accept wildcard characters: False
539539
```
540540
541541
### -AllowCrossTenantReplication
542-
Gets or sets allow or disallow cross AAD tenant object replication. The default interpretation is true for this property.
542+
Gets or sets allow or disallow cross Microsoft Entra tenant object replication. The default interpretation is true for this property.
543543
544544
```yaml
545545
Type: System.Boolean
@@ -554,7 +554,7 @@ Accept wildcard characters: False
554554
```
555555
556556
### -AllowedCopyScope
557-
Set restrict copy to and from Storage Accounts within an AAD tenant or with Private Links to the same VNet. Possible values include: 'PrivateLink', 'AAD'
557+
Set restrict copy to and from Storage Accounts within a Microsoft Entra tenant or with Private Links to the same VNet. Possible values include: 'PrivateLink', 'AAD'
558558
559559
```yaml
560560
Type: System.String
@@ -569,7 +569,7 @@ Accept wildcard characters: False
569569
```
570570
571571
### -AllowSharedKeyAccess
572-
Indicates whether the storage account permits requests to be authorized with the account access key via Shared Key. If false, then all requests, including shared access signatures, must be authorized with Azure Active Directory (Azure AD). The default value is null, which is equivalent to true.
572+
Indicates whether the storage account permits requests to be authorized with the account access key via Shared Key. If false, then all requests, including shared access signatures, must be authorized with Microsoft Entra ID. The default value is null, which is equivalent to true.
573573
574574
```yaml
575575
Type: System.Boolean
@@ -721,7 +721,7 @@ Accept wildcard characters: False
721721
```
722722
723723
### -EnableAzureActiveDirectoryDomainServicesForFile
724-
Enable Azure Files Azure Active Directory Domain Service Authentication for the storage account.
724+
Enable Azure Files Microsoft Entra Domain Service Authentication for the storage account.
725725
726726
```yaml
727727
Type: System.Boolean

src/Storage/Storage.Management/help/New-AzStorageContext.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ New-AzStorageContext [-UseConnectedAccount] [-BlobEndpoint <String>] [-FileEndpo
9797

9898
## DESCRIPTION
9999
The **New-AzStorageContext** cmdlet creates an Azure Storage context.
100-
The default Authentication of a Storage Context is OAuth (Azure AD), if only input Storage account name.
100+
The default Authentication of a Storage Context is OAuth (Microsoft Entra ID), if only input Storage account name.
101101
See details of authentication of the Storage Service in https://learn.microsoft.com/rest/api/storageservices/authorization-for-the-azure-storage-services.
102102

103103
## EXAMPLES
@@ -185,7 +185,7 @@ Connect-AzAccount
185185
$Context = New-AzStorageContext -StorageAccountName "myaccountname" -UseConnectedAccount
186186
```
187187

188-
This command creates a context by using the OAuth (Azure AD) Authentication.
188+
This command creates a context by using the OAuth (Microsoft Entra ID) Authentication.
189189

190190
### Example 11: Create a context by specifying a storage account name, storage account key and custom blob endpoint
191191
```powershell
@@ -222,8 +222,8 @@ This command creates a context by using the OAuth authentication with a specifie
222222
New-AzStorageContext -StorageAccountName "myaccountname" -UseConnectedAccount -EnableFileBackupRequestIntent
223223
```
224224

225-
This command creates a context to use the OAuth (Azure AD) authentication on File service.
226-
Parameter '-EnableFileBackupRequestIntent' is required to use OAuth (Azure AD) Authentication for File service. This will bypass any file/directory level permission checks and allow access, based on the allowed data actions, even if there are ACLs in place for those files/directories.
225+
This command creates a context to use the OAuth (Microsoft Entra ID) authentication on File service.
226+
Parameter '-EnableFileBackupRequestIntent' is required to use OAuth (Microsoft Entra ID) Authentication for File service. This will bypass any file/directory level permission checks and allow access, based on the allowed data actions, even if there are ACLs in place for those files/directories.
227227

228228
## PARAMETERS
229229

@@ -285,7 +285,7 @@ Accept wildcard characters: False
285285
```
286286
287287
### -EnableFileBackupRequestIntent
288-
Required parameter to use with OAuth (Azure AD) Authentication for Files. This will bypass any file/directory level permission checks and allow access, based on the allowed data actions, even if there are ACLs in place for those files/directories.
288+
Required parameter to use with OAuth (Microsoft Entra ID) Authentication for Files. This will bypass any file/directory level permission checks and allow access, based on the allowed data actions, even if there are ACLs in place for those files/directories.
289289
290290
```yaml
291291
Type: System.Management.Automation.SwitchParameter
@@ -467,7 +467,7 @@ Accept wildcard characters: False
467467
```
468468

469469
### -UseConnectedAccount
470-
Indicates that this cmdlet creates an Azure Storage context with OAuth (Azure AD) Authentication.
470+
Indicates that this cmdlet creates an Azure Storage context with OAuth (Microsoft Entra ID) Authentication.
471471
The cmdlet will use OAuth Authentication by default, when other authentication not specified.
472472

473473
```yaml
@@ -500,5 +500,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
500500
[Get-AzStorageBlob](./Get-AzStorageBlob.md)
501501

502502
[New-AzStorageContainerSASToken](./New-AzStorageContainerSASToken.md)
503-
504-

src/Storage/Storage.Management/help/Set-AzStorageAccount.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ Set-AzStorageAccount -ResourceGroupName "MyResourceGroup" -Name "mystorageaccoun
172172

173173
The command upgrade a Storage account with Kind "Storage" or "BlobStorage" to "StorageV2" kind Storage account.
174174

175-
### Example 10: Update a Storage account by enable Azure Files AAD DS Authentication and set DefaultSharePermission.
175+
### Example 10: Update a Storage account by enable Azure Files Microsoft Entra Domain Services Authentication and set DefaultSharePermission.
176176
```powershell
177177
$account = Set-AzStorageAccount -ResourceGroupName "MyResourceGroup" -Name "mystorageaccount" -EnableAzureActiveDirectoryDomainServicesForFile $true -DefaultSharePermission StorageFileDataSmbShareContributor
178178
@@ -185,7 +185,7 @@ DirectoryServiceOptions ActiveDirectoryProperties
185185
AADDS Microsoft.Azure.Commands.Management.Storage.Models.PSActiveDirectoryProperties StorageFileDataSmbShareContributor
186186
```
187187

188-
The command update a Storage account by enable Azure Files AAD DS Authentication.
188+
The command update a Storage account by enable Azure Files Microsoft Entra Domain Services Authentication.
189189

190190
### Example 11: Update a Storage account by enable Files Active Directory Domain Service Authentication, and then show the File Identity Based authentication setting
191191
<!-- Skip: Output cannot be splitted from code -->
@@ -605,7 +605,7 @@ Accept wildcard characters: False
605605
```
606606
607607
### -AllowCrossTenantReplication
608-
Gets or sets allow or disallow cross AAD tenant object replication. The default interpretation is true for this property.
608+
Gets or sets allow or disallow cross Microsoft Entra tenant object replication. The default interpretation is true for this property.
609609
610610
```yaml
611611
Type: System.Boolean
@@ -620,7 +620,7 @@ Accept wildcard characters: False
620620
```
621621
622622
### -AllowedCopyScope
623-
Set restrict copy to and from Storage Accounts within an AAD tenant or with Private Links to the same VNet. Possible values include: 'PrivateLink', 'AAD'
623+
Set restrict copy to and from Storage Accounts within a Microsoft Entra tenant or with Private Links to the same VNet. Possible values include: 'PrivateLink', 'AAD'
624624
625625
```yaml
626626
Type: System.String
@@ -635,7 +635,7 @@ Accept wildcard characters: False
635635
```
636636
637637
### -AllowSharedKeyAccess
638-
Indicates whether the storage account permits requests to be authorized with the account access key via Shared Key. If false, then all requests, including shared access signatures, must be authorized with Azure Active Directory (Azure AD). The default value is null, which is equivalent to true.
638+
Indicates whether the storage account permits requests to be authorized with the account access key via Shared Key. If false, then all requests, including shared access signatures, must be authorized with Microsoft Entra ID. The default value is null, which is equivalent to true.
639639
640640
```yaml
641641
Type: System.Boolean

0 commit comments

Comments
 (0)