Skip to content

Spelling Fixes #27953

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Jun 13, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Generally, this change will not cause a breaking change for users. In modules ge

### Removal of PassThru for Certain Cmdlets

`-PassThru` is a switch parameter that we add to cmdlets that don't have outputs to enable the pipline functionality. In AutoRest.PowerShell v3, `-PassThru` was incorrectly added to some cmdlets that do have outputs. This is fixed in v4 and those extra `-PassThru` parameters are removed.
`-PassThru` is a switch parameter that we add to cmdlets that don't have outputs to enable the pipeline functionality. In AutoRest.PowerShell v3, `-PassThru` was incorrectly added to some cmdlets that do have outputs. This is fixed in v4 and those extra `-PassThru` parameters are removed.

#### How to Mitigate the Impact of Breaking Changes

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@ To import modules automatically when debug has started, follow the below steps:
- Please refer to [Debug Page, Project Designer](https://learn.microsoft.com/visualstudio/ide/reference/debug-page-project-designer?view=vs-2022) for how to access the Debug page
- Create a **Excutable** new Debug profile
- For Azure PowerShell, please setup debug profile in the following way
- Set **Excutable** to the path of the excutable file of PowerShell core, for example,`C:\Program Files\PowerShell\7\pwsh.exe`
- Set **Excutable** to the path of the executable file of PowerShell core, for example,`C:\Program Files\PowerShell\7\pwsh.exe`
- Import the Profile module, along with the module you are testing, by pasting the following in the **Command line arguments** box (_note_: you have to update the <PATH_TO_REPO> and <SERVICE> values provided below):
- `-NoExit -Command "Import-Module <PATH_TO_REPO>/artifacts/Debug/Az.Accounts/Az.Accounts.psd1;Import-Module <PATH_TO_REPO>/artifacts/Debug/Az.<SERVICE>/Az.<SERVICE>.psd1;$DebugPreference='Continue'"`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -116,9 +116,9 @@ Breaking changes and preview messages for auto gen cmdlets are added through dir

To add breaking changes or preview messages for a customized cmdlets, you will need to add related attributes in code directly. And following are some common cases.

You must provide expected breaking change az version and moudle verision otherwise it won't compile. The first version is expected az version while the second one is expected moudle verision.
You must provide expected breaking change az version and module version otherwise it won't compile. The first version is expected az version while the second one is expected module version.

**Note: these examples are based on the Az.Databricks module. Please double check the namesapce. You will most likely need to replace "Databricks" with your module's name.**
**Note: these examples are based on the Az.Databricks module. Please double check the namespace. You will most likely need to replace "Databricks" with your module's name.**

## Case 1 — Generic Breaking change for a cmdlet

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Azure PowerShell defines most commonly used exceptions, all of which inherit fro
| AzPSInvalidOperationException | Internal | | This exception should be thrown when a method call is invalid for the object's current state. |
| AzPSIOException | User | | This exception should be thrown when an I/O error occurs. |
| AzPSKeyNotFoundException | Internal | MapKeyName | This exception should be thrown when the key specified for accessing an element in a collection does not match any key in the collection. |
| AzPSApplicationException | Internal | | This exception is representive of ApplicationException in Azure PowerShell. |
| AzPSApplicationException | Internal | | This exception is representative of ApplicationException in Azure PowerShell. |
| AzPSFileNotFoundException | User | FileName (Not full path) | This exception should be thrown when accessing a file that does not exist. |

There are three types of errors in Azure PowerShell.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ If the module is under pre-GA status, we can let the syntax break directly due t
If the module is GAed, we need to disable the transform (See guideline at [here](https://github.com/Azure/autorest.powershell/blob/main/docs/migration-from-v3-to-v4.md#how-to-mitigate-the-breaking-changes-of-managed-identity-best-practice-alignment).) but preannounce breaking change) and plan to break it (add upcoming breaking changes for them and take the effects on a major release).

### What should I do if Autorest reports _"Parameter IdentityType in operation '{operationId}' can not be transformed as the best practice design"_?
This error indicates that autorest is trying to replace PATCH operation by GET+PUT operation to let IdentityType transformed as best practice desgin but failed due to certain reasons. One of common reasons is GET operation contains query parameter and autorest has not supported such a combined GET+PUT operation. To mitigate this issue,
This error indicates that autorest is trying to replace PATCH operation by GET+PUT operation to let IdentityType transformed as best practice design but failed due to certain reasons. One of common reasons is GET operation contains query parameter and autorest has not supported such a combined GET+PUT operation. To mitigate this issue,

- Include a customization script to transform the parameter IdentityType to EnableSystemAssignedIdentity by `get` + `patch` update for this type of operation. The following are the detailed steps on how to accomplish this.
- disable transformation for the operation which reported error in README.md by
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ namespace Microsoft.Azure.Commands.Profile.Models
// code omitted for brevity
```

PowerShell uses these properties for the cmdlet table formated output:
PowerShell uses these properties for the cmdlet table formatted output:

```PowerShell
PS C:\> Get-AzSubscription | Format-Table
Expand Down
4 changes: 2 additions & 2 deletions documentation/development-docs/sdkbased-vs-autogen.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Description

The document is for those, who are familiar with SDK-based modules and want to give a try with auto-gen modules. The content will contain the comparation between these two kinds of modules from architecture, cmdlets differences, and onboard process, etc.
The document is for those, who are familiar with SDK-based modules and want to give a try with auto-gen modules. The content will contain the comparison between these two kinds of modules from architecture, cmdlets differences, and onboard process, etc.

# Architecture

Expand Down Expand Up @@ -65,7 +65,7 @@ Customization could be done through three ways.

### SDK-based Module

If your module relies on some other modules, you will need to rely on dotnet SDK of these modules, which could put in your module if only your module depends on them or in Az.Accouts they are some common modules required by several modules.
If your module relies on some other modules, you will need to rely on dotnet SDK of these modules, which could put in your module if only your module depends on them or in Az.Accounts they are some common modules required by several modules.

### Auto-gen Module

Expand Down
4 changes: 2 additions & 2 deletions documentation/internal/authinrdfe.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,15 @@ To acquire management certificate credentials, you must download a PublishingPr
The Add-AzureAccount command can be used to acquire a token based on user credentials, and if the associated user is authorized for RDFE access to a subscription (they must be a classic administrator or co-admin of the subscription), they will have access to those subscriptions authorized to their account for classic administrator access

## General Notes
- Managemnt certificate authentication lasts for an entire TCP session. User authentication is self-renewing, just as it is in ARM.
- Management certificate authentication lasts for an entire TCP session. User authentication is self-renewing, just as it is in ARM.

## Programmatic Authentication for PowerShell clients
- Clients are still authenticated using an IAuthenticationFactory, and the following overload:

```c#
SubscriptionCloudCredentials GetSubscriptionCloudCredentials(IAzureContext context)
```
Note that, the ARM token audience is different than the token audience used for RDFE, although the RDFE tolken audience is accepted by both endpoints.
Note that, the ARM token audience is different than the token audience used for RDFE, although the RDFE token audience is accepted by both endpoints.

Similarly, RDFE clients can be created using the IClientFactory interface:

Expand Down
4 changes: 2 additions & 2 deletions documentation/internal/pull-request-review-knowledge-share.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
## PR Review Knowledge Share

### Dependency Assemlby Version Confliction
### Dependency Assembly Version Confliction
If one assembly has been referenced by more than one module, we should let Az.Accounts to handle the dependency.

**RED** flag
- Update assembly version for common Microsoft.Extensions.*
- Add new dependency assemlby for one module, the assembly may be referenced by other module already.
- Add new dependency assembly for one module, the assembly may be referenced by other module already.
- Contains version update for dependency assembly in module other than Az.Accounts

### Resource ID **MUST** start with a slash
Expand Down
6 changes: 3 additions & 3 deletions documentation/migration-guides/Az.11.0.0-migration-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -682,8 +682,8 @@ The cmdlet 'Reset-AzPowerBIWorkspaceCollectionAccessKey' has been removed as Wor

## AZ.Storage

### `Get-AzStorageQueueStoredAcessPolicy`
Permissions in the ouput access policy is changed to a string like "raup"
### `Get-AzStorageQueueStoredAccessPolicy`
Permissions in the output access policy is changed to a string like "raup"

### `New-AzStorageAccountSasToken`
The leading question mark '?' of the created SAS token is removed
Expand All @@ -707,5 +707,5 @@ The leading question mark '?' of the created SAS token is removed
The leading question mark '?' of the created SAS token is removed

### `Set-AzStorageQueueStoredAccessPolicy`
Permissions in the ouput access policy is changed to a string like "raup"
Permissions in the output access policy is changed to a string like "raup"

8 changes: 4 additions & 4 deletions documentation/migration-guides/Az.12.0.0-migration-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Clear-AzConfig -DisableErrorRecordsPersistence
```
#### After
```powershell
error record will be disabled by default. New parameter 'EnableErrorRecordsPersistence' added to enable erro record.
error record will be disabled by default. New parameter 'EnableErrorRecordsPersistence' added to enable error record.
```


Expand All @@ -30,7 +30,7 @@ Get-AzConfig -DisableErrorRecordsPersistence
```
#### After
```powershell
error record will be disabled by default. New parameter 'EnableErrorRecordsPersistence' added to enable erro record.
error record will be disabled by default. New parameter 'EnableErrorRecordsPersistence' added to enable error record.
```


Expand All @@ -46,7 +46,7 @@ Update-AzConfig -DisableErrorRecordsPersistence
```
#### After
```powershell
error record will be disabled by default. New parameter 'EnableErrorRecordsPersistence' added to enable erro record.
error record will be disabled by default. New parameter 'EnableErrorRecordsPersistence' added to enable error record.
```


Expand Down Expand Up @@ -1668,7 +1668,7 @@ $exemptionCategory = $policyExemption.Properties.ExemptionCategory
$policyExemption = Update-AzPolicyExemption -Name MyExemption -ExemptionCategory Waiver
$exemptionCategory = $policyExemption.ExemptionCategory

Compatbile option:
Compatible option:
$policyExemption = Update-AzPolicyExemption -Name MyExemption -ExemptionCategory Waiver -BackwardCompatible
$exemptionCategory = $policyExemption.Properties.ExemptionCategory

Expand Down
4 changes: 2 additions & 2 deletions documentation/migration-guides/Az.13.0.0-migration-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -1143,7 +1143,7 @@ $file.CloudFile | Close-AzStorageFileHandle -CloseAll
$share = Get-AzStorageShare -ShareName $sharename -Context $ctx
$share.ShareClient | Close-AzStorageFileHandle -CloseAll -PassThru

# Pipe in ShareDirectoryClient to close file handles rescursively
# Pipe in ShareDirectoryClient to close file handles recursively
$dir = Get-AzStorageFile -ShareName $shareName -Path $dirpath -Context $ctx
$dir.ShareDirectoryClient | Close-AzStorageFileHandle -Recursive -CloseAll

Expand Down Expand Up @@ -1464,7 +1464,7 @@ Remove-AzStorageDirectory -Directory $dir.CloudFileDirectory
#### After
```powershell
$share = Get-AzStorageShare -Name $sharename -Context $ctx
Remove-AzStorageDirectory -ShareClient $share.ShareClient -Path $dirpath -Conetxt $ctx
Remove-AzStorageDirectory -ShareClient $share.ShareClient -Path $dirpath -Context $ctx

$dir = Get-AzStorageFile -ShareName $sharename -Path $dirpath -Context $ctx
Remove-AzStorageDirectory -ShareDirectoryClient.ShareDirectoryClient -Context $ctx
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1168,7 +1168,7 @@ Set-AzResource -ResourceGroupName <resource group> -Name <resource> -ResourceTyp
### `Set-AzStorageFileContent`

- Cmdlet breaking-change will happen to all parameter sets
- The ContentHash properties will be removed from the uploaded Azure file when file size > 1TB, or upload with Oauth credencial, or with -DisAllowTrailingDot.
- The ContentHash properties will be removed from the uploaded Azure file when file size > 1TB, or upload with Oauth credential, or with -DisAllowTrailingDot.
- This change is expected to take effect from Az.Storage version: 9.0.0 and Az version: 14.0.0


Expand Down
2 changes: 1 addition & 1 deletion documentation/migration-guides/Az.3.0.0-migration-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -417,7 +417,7 @@ Set-AzSqlDatabaseAudit -ResourceGroupName "ResourceGroup01" -ServerName "Server0

### `Get-AzSqlServerAuditing`
- The cmdlet `Get-AzSqlServerAudit` is replacing this cmdlet.
- The output type is changing from the existing type :'Microsoft.Azure.Commands.Sql.Auditing.Model.DatabaseBlobAuditingSettingsModel' to the new type :'Microsoft.Azure.Commands.Sql.Auditing.Model.ServerAuditingSettingsModel'. Properties `AuditState`, `StorageAccountName`, and `StorageAccountSubscriptionId` are removed. Scripts that use `StorageAccountName` and `StorageAccountSubscriptionId` proeprties can retrieve this information from the new `StorageAccountResourceId` property.
- The output type is changing from the existing type :'Microsoft.Azure.Commands.Sql.Auditing.Model.DatabaseBlobAuditingSettingsModel' to the new type :'Microsoft.Azure.Commands.Sql.Auditing.Model.ServerAuditingSettingsModel'. Properties `AuditState`, `StorageAccountName`, and `StorageAccountSubscriptionId` are removed. Scripts that use `StorageAccountName` and `StorageAccountSubscriptionId` properties can retrieve this information from the new `StorageAccountResourceId` property.

#### Before
```powershell
Expand Down
4 changes: 2 additions & 2 deletions documentation/migration-guides/Az.6.0.0-migration-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -319,7 +319,7 @@ Remove-AzRmStorageShare -ResourceGroupName $resourceGroupName -StorageAccountNam
## Az.ServiceFabric

### `Add-AzServiceFabricClusterCertificate`
this cmdlet has been removed completly. please follow instructions here to add cluster certificates: https://learn.microsoft.com/en-us/azure/service-fabric/service-fabric-cluster-security-update-certs-azure#add-a-secondary-certificate-using-azure-resource-manager
this cmdlet has been removed completely. please follow instructions here to add cluster certificates: https://learn.microsoft.com/en-us/azure/service-fabric/service-fabric-cluster-security-update-certs-azure#add-a-secondary-certificate-using-azure-resource-manager

### `Get-AzServiceFabricManagedClusterService`
Change PSManagedService model to avoid using the properties parameter directly from sdk. Now all the properties are in the first level of the object.
Expand Down Expand Up @@ -357,7 +357,7 @@ $statelessService.ProvisioningState


### `Remove-AzServiceFabricClusterCertificate`
this cmdlet has been removed completly. please follow instructions here to add cluster certificates: https://learn.microsoft.com/en-us/azure/service-fabric/service-fabric-cluster-security-update-certs-azure#remove-a-cluster-certificate-using-the-portal
this cmdlet has been removed completely. please follow instructions here to add cluster certificates: https://learn.microsoft.com/en-us/azure/service-fabric/service-fabric-cluster-security-update-certs-azure#remove-a-cluster-certificate-using-the-portal

### `Remove-AzServiceFabricManagedClusterService`
Change PSManagedService model to avoid using the properties parameter directly from sdk. Now all the properties are in the first level of the object.
Expand Down
2 changes: 1 addition & 1 deletion documentation/migration-guides/Az.8.0.0-migration-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ Update-AzCdnEndpoint -Name $endpointName -ProfileName $cdnProfileName -ResourceG

//Update DeliveryPolicyDescription or DeliveryPolicyRule
Update-AzCdnEndpoint -Name $endpointName -ProfileName $cdnProfileName -ResourceGroupName $resourceGroupName `
-DeliveryPolicyDescription $descprption -DeliveryPolicyRule $rule
-DeliveryPolicyDescription $description -DeliveryPolicyRule $rule
```

### `Set-AzCdnOriginGroup`
Expand Down
8 changes: 4 additions & 4 deletions documentation/testing-docs/test-matrix-for-az-accounts.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Each test scenario is marked with one priority P0, P1, P2 based on two factors:

|Scenario\AuthN Method|Interactive|Device Code (`-DeviceCode`)|User Name+Password (`-Credential`)|Access Token (`-AccessToken`)|SP Secret (`-ServicePrincipal -Credential`)|SP Cert (`-ServicePrincipal -CertificateThumbprint`)|System MSI (`-Identity`)|User MSI (`-Identity -AccountId`)|User MSI-Func App published by VS Code (`-Identity -AccountId`)|
|----|----|----|----|----|----|----|----|----|----|
|`No Subscrption/Tenant`|P0 (SemiAuto)|P0|P0 (Auto-No)|P0 (SemiAuto-No)|NA|NA|P0|P0|P0|
|`No Subscription/Tenant`|P0 (SemiAuto)|P0|P0 (Auto-No)|P0 (SemiAuto-No)|NA|NA|P0|P0|P0|
|`-Subscription sub-id`|P0 (SemiAuto)|P1|P1 (Auto-No)|P1 (SemiAuto-No)|NA|NA|P1|P1|P1|
|`-Subscription sub-name`|P1 (SemiAuto)|P2|P2 (Auto-No)|P2 (SemiAuto-No)|NA|NA|P2|P2|P2|
|`-Subscription sub-id-in-2nd-tenant`|P0 (SemiAuto-No)|P2|P2 (Auto-No)|NA|NA|NA|NA|NA|NA|
Expand All @@ -22,7 +22,7 @@ Each test scenario is marked with one priority P0, P1, P2 based on two factors:
|`-Tenant tenant-id -Subscription sub-id`|P0 (SemiAuto)|P1|P1 (Auto-No)|P1 (SemiAuto-No)|P1 (Auto-No)|P1 (SemiAuto-No)|P1|P1|P1|
|`-Tenant 2nd-tenant-id -Subscription sub-id-in-2nd-tenant`|P1 (SemiAuto-No)|P2|P2 (Auto-No)|NA|P2 (Auto-No)|P2 (SemiAuto-No)|NA|NA|NA|
|`No Parameter` Click back button before inputing password(Negative)|P2|P2|NA|NA|NA|NA|NA|NA|NA|
|`-Subscripiton -sub-id-no-permission`(Negative)|P2|P2|P2|P2|P2|P2|P2|P2|P2|
|`-Subscription -sub-id-no-permission`(Negative)|P2|P2|P2|P2|P2|P2|P2|P2|P2|
|`-Tenant -tenant-id-no-permission`(Negative)|P2|P2|P2|P2|P2|P2|P2|P2|P2|
|`-Tenant 1st-tenant-id -Subscription sub-id-in-2nd-tenant`(Negative)|P2|P2|P2|P2|P2|P2|P2|P2|P2|

Expand Down Expand Up @@ -192,7 +192,7 @@ You may save json content below as template file, make sure the value of `parame
b. Restart Windows PowerShell and run `Connect-AzAccount`
c. You should see http request in Fiddler like `https://login.microsoftonline.com/organizations/oauth2/v2.0/token`

3. How to Test compatability with az
3. How to Test compatibility with az

Expect no error happens:
a. az login
Expand All @@ -212,7 +212,7 @@ You may save json content below as template file, make sure the value of `parame
Connect-AzAccount -Credential $cred
```

c. Although failed to login, but the http reqeust `https://msft.sts.microsoft.com/adfs/services/trust/2005/usernamemixed` should be successful.
c. Although failed to login, but the http request `https://msft.sts.microsoft.com/adfs/services/trust/2005/usernamemixed` should be successful.

5. How to Test in Constrained Language Mode

Expand Down
2 changes: 1 addition & 1 deletion documentation/testing-docs/using-azure-test-framework.md
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@ The `HttpRecorderMode` key in the `TEST_CSM_ORGID_AUTHENTICATION` environment va
AADTokenAudienceUri = "https://management.core.windows.net"
GraphTokenAudienceUri = "https://graph.ppe.windows.net/"
DataLakeStoreServiceUri = "https://caboaccountdogfood.net"
DataLakeAnalyticsJoAbndCatalogServiceUri = "https://konaaccountdogfood.net"
DataLakeAnalyticsJobAndCatalogServiceUri = "https://konaaccountdogfood.net"

##### Environment = Custom

Expand Down
Loading