Skip to content

[Don't Merge!][SecureString] [Autorest-based][Az.App] Final Change #27126

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.

Sign up for GitHub

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

Draft
wants to merge 5 commits into
base: archive/generation
Choose a base branch
from
Draft

[Don't Merge!][SecureString] [Autorest-based][Az.App] Final Change #27126

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0b18fb6
add a new SecureString parameter AzureFileAccountKeySecure
YanaXu Feb 13, 2025
ff8f23b
update docs
YanaXu Feb 13, 2025
b33452e
duplicate the property too
YanaXu Feb 14, 2025
aed3d15
add -AllowClobber to install Az.Accounts
YanaXu Feb 14, 2025
ed4f3a8
remove the old String property and parameter
YanaXu Feb 14, 2025
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
5 changes: 5 additions & 0 deletions src/App/App.Autorest/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,11 @@ flatten-userassignedidentity: false
disable-transform-identity-type: true

directive:
- from: swagger-document
where: $.definitions.AzureFileProperties.properties.accountKey
transform: >
$["x-ms-client-name"] = "accountKeySecure";
$["format"] = "password";
- from: swagger-document
where: $.definitions.Certificate.properties.properties.properties.password
transform: >-
Expand Down
14 changes: 7 additions & 7 deletions src/App/App.Autorest/docs/New-AzContainerAppConnectedEnvStorage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,29 +8,29 @@ schema: 2.0.0
# New-AzContainerAppConnectedEnvStorage

## SYNOPSIS
Create storage for a connectedEnvironment.
create storage for a connectedEnvironment.

## SYNTAX

### CreateExpanded (Default)
```
New-AzContainerAppConnectedEnvStorage -ConnectedEnvironmentName <String> -Name <String>
-ResourceGroupName <String> [-SubscriptionId <String>] [-AzureFileAccessMode <String>]
[-AzureFileAccountKey <String>] [-AzureFileAccountName <String>] [-AzureFileShareName <String>]
[-AzureFileAccountKeySecure <SecureString>] [-AzureFileAccountName <String>] [-AzureFileShareName <String>]
[-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>]
```

### CreateViaIdentityConnectedEnvironmentExpanded
```
New-AzContainerAppConnectedEnvStorage -ConnectedEnvironmentInputObject <IAppIdentity> -Name <String>
[-AzureFileAccessMode <String>] [-AzureFileAccountKey <String>] [-AzureFileAccountName <String>]
[-AzureFileAccessMode <String>] [-AzureFileAccountKeySecure <SecureString>] [-AzureFileAccountName <String>]
[-AzureFileShareName <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>]
```

### CreateViaIdentityExpanded
```
New-AzContainerAppConnectedEnvStorage -InputObject <IAppIdentity> [-AzureFileAccessMode <String>]
[-AzureFileAccountKey <String>] [-AzureFileAccountName <String>] [-AzureFileShareName <String>]
[-AzureFileAccountKeySecure <SecureString>] [-AzureFileAccountName <String>] [-AzureFileShareName <String>]
[-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>]
```

Expand All @@ -49,7 +49,7 @@ New-AzContainerAppConnectedEnvStorage -ConnectedEnvironmentName <String> -Name <
```

## DESCRIPTION
Create storage for a connectedEnvironment.
create storage for a connectedEnvironment.

## EXAMPLES

Expand Down Expand Up @@ -86,11 +86,11 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### -AzureFileAccountKey
### -AzureFileAccountKeySecure
Storage account key for azure file.

```yaml
Type: System.String
Type: System.Security.SecureString
Parameter Sets: CreateExpanded, CreateViaIdentityConnectedEnvironmentExpanded, CreateViaIdentityExpanded
Aliases:

Expand Down
14 changes: 7 additions & 7 deletions src/App/App.Autorest/docs/New-AzContainerAppManagedEnvStorage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,29 +8,29 @@ schema: 2.0.0
# New-AzContainerAppManagedEnvStorage

## SYNOPSIS
Create storage for a managedEnvironment.
create storage for a managedEnvironment.

## SYNTAX

### CreateExpanded (Default)
```
New-AzContainerAppManagedEnvStorage -EnvName <String> -Name <String> -ResourceGroupName <String>
[-SubscriptionId <String>] [-AzureFileAccessMode <String>] [-AzureFileAccountKey <String>]
[-SubscriptionId <String>] [-AzureFileAccessMode <String>] [-AzureFileAccountKeySecure <SecureString>]
[-AzureFileAccountName <String>] [-AzureFileShareName <String>] [-DefaultProfile <PSObject>] [-Confirm]
[-WhatIf] [<CommonParameters>]
```

### CreateViaIdentityExpanded
```
New-AzContainerAppManagedEnvStorage -InputObject <IAppIdentity> [-AzureFileAccessMode <String>]
[-AzureFileAccountKey <String>] [-AzureFileAccountName <String>] [-AzureFileShareName <String>]
[-AzureFileAccountKeySecure <SecureString>] [-AzureFileAccountName <String>] [-AzureFileShareName <String>]
[-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>]
```

### CreateViaIdentityManagedEnvironmentExpanded
```
New-AzContainerAppManagedEnvStorage -ManagedEnvironmentInputObject <IAppIdentity> -Name <String>
[-AzureFileAccessMode <String>] [-AzureFileAccountKey <String>] [-AzureFileAccountName <String>]
[-AzureFileAccessMode <String>] [-AzureFileAccountKeySecure <SecureString>] [-AzureFileAccountName <String>]
[-AzureFileShareName <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>]
```

Expand All @@ -49,7 +49,7 @@ New-AzContainerAppManagedEnvStorage -EnvName <String> -Name <String> -ResourceGr
```

## DESCRIPTION
Create storage for a managedEnvironment.
create storage for a managedEnvironment.

## EXAMPLES

Expand Down Expand Up @@ -86,11 +86,11 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### -AzureFileAccountKey
### -AzureFileAccountKeySecure
Storage account key for azure file.

```yaml
Type: System.String
Type: System.Security.SecureString
Parameter Sets: CreateExpanded, CreateViaIdentityExpanded, CreateViaIdentityManagedEnvironmentExpanded
Aliases:

Expand Down
14 changes: 7 additions & 7 deletions src/App/App.Autorest/docs/Update-AzContainerAppConnectedEnvStorage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,34 +8,34 @@ schema: 2.0.0
# Update-AzContainerAppConnectedEnvStorage

## SYNOPSIS
Update storage for a connectedEnvironment.
update storage for a connectedEnvironment.

## SYNTAX

### UpdateExpanded (Default)
```
Update-AzContainerAppConnectedEnvStorage -ConnectedEnvironmentName <String> -Name <String>
-ResourceGroupName <String> [-SubscriptionId <String>] [-AzureFileAccessMode <String>]
[-AzureFileAccountKey <String>] [-AzureFileAccountName <String>] [-AzureFileShareName <String>]
[-AzureFileAccountKeySecure <SecureString>] [-AzureFileAccountName <String>] [-AzureFileShareName <String>]
[-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>]
```

### UpdateViaIdentityConnectedEnvironmentExpanded
```
Update-AzContainerAppConnectedEnvStorage -ConnectedEnvironmentInputObject <IAppIdentity> -Name <String>
[-AzureFileAccessMode <String>] [-AzureFileAccountKey <String>] [-AzureFileAccountName <String>]
[-AzureFileAccessMode <String>] [-AzureFileAccountKeySecure <SecureString>] [-AzureFileAccountName <String>]
[-AzureFileShareName <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>]
```

### UpdateViaIdentityExpanded
```
Update-AzContainerAppConnectedEnvStorage -InputObject <IAppIdentity> [-AzureFileAccessMode <String>]
[-AzureFileAccountKey <String>] [-AzureFileAccountName <String>] [-AzureFileShareName <String>]
[-AzureFileAccountKeySecure <SecureString>] [-AzureFileAccountName <String>] [-AzureFileShareName <String>]
[-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>]
```

## DESCRIPTION
Update storage for a connectedEnvironment.
update storage for a connectedEnvironment.

## EXAMPLES

Expand Down Expand Up @@ -103,11 +103,11 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### -AzureFileAccountKey
### -AzureFileAccountKeySecure
Storage account key for azure file.

```yaml
Type: System.String
Type: System.Security.SecureString
Parameter Sets: (All)
Aliases:

Expand Down
14 changes: 7 additions & 7 deletions src/App/App.Autorest/docs/Update-AzContainerAppManagedEnvStorage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,34 +8,34 @@ schema: 2.0.0
# Update-AzContainerAppManagedEnvStorage

## SYNOPSIS
Update storage for a managedEnvironment.
update storage for a managedEnvironment.

## SYNTAX

### UpdateExpanded (Default)
```
Update-AzContainerAppManagedEnvStorage -EnvName <String> -Name <String> -ResourceGroupName <String>
[-SubscriptionId <String>] [-AzureFileAccessMode <String>] [-AzureFileAccountKey <String>]
[-SubscriptionId <String>] [-AzureFileAccessMode <String>] [-AzureFileAccountKeySecure <SecureString>]
[-AzureFileAccountName <String>] [-AzureFileShareName <String>] [-DefaultProfile <PSObject>] [-Confirm]
[-WhatIf] [<CommonParameters>]
```

### UpdateViaIdentityExpanded
```
Update-AzContainerAppManagedEnvStorage -InputObject <IAppIdentity> [-AzureFileAccessMode <String>]
[-AzureFileAccountKey <String>] [-AzureFileAccountName <String>] [-AzureFileShareName <String>]
[-AzureFileAccountKeySecure <SecureString>] [-AzureFileAccountName <String>] [-AzureFileShareName <String>]
[-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>]
```

### UpdateViaIdentityManagedEnvironmentExpanded
```
Update-AzContainerAppManagedEnvStorage -ManagedEnvironmentInputObject <IAppIdentity> -Name <String>
[-AzureFileAccessMode <String>] [-AzureFileAccountKey <String>] [-AzureFileAccountName <String>]
[-AzureFileAccessMode <String>] [-AzureFileAccountKeySecure <SecureString>] [-AzureFileAccountName <String>]
[-AzureFileShareName <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>]
```

## DESCRIPTION
Update storage for a managedEnvironment.
update storage for a managedEnvironment.

## EXAMPLES

Expand Down Expand Up @@ -103,11 +103,11 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### -AzureFileAccountKey
### -AzureFileAccountKeySecure
Storage account key for azure file.

```yaml
Type: System.String
Type: System.Security.SecureString
Parameter Sets: (All)
Aliases:

Expand Down
12 changes: 6 additions & 6 deletions src/App/App.Autorest/test/AzContainerAppConnectedEnvStorage.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ Describe 'AzContainerAppConnectedEnvStorage' {
It 'CreateExpanded' {
{
# $storageAccountKey = (Get-AzStorageAccountKey -ResourceGroupName $env.resourceGroupConnected -AccountName $env.storageAccount2).Value[0]
$storageAccountKey = "1234"
$storageAccountKeySecure = "1234" | ConvertTo-SecureString -AsPlainText

$config = New-AzContainerAppConnectedEnvStorage -ConnectedEnvironmentName $env.connectedEnv1 -ResourceGroupName $env.resourceGroupConnected -Name $env.connectedEnvStorage -AzureFileAccessMode 'ReadWrite' -AzureFileAccountKey $storageAccountKey -AzureFileAccountName azpstestsa -AzureFileShareName azps-rw-sharename
$config = New-AzContainerAppConnectedEnvStorage -ConnectedEnvironmentName $env.connectedEnv1 -ResourceGroupName $env.resourceGroupConnected -Name $env.connectedEnvStorage -AzureFileAccessMode 'ReadWrite' -AzureFileAccountKeySecure $storageAccountKeySecure -AzureFileAccountName azpstestsa -AzureFileShareName azps-rw-sharename
$config.AzureFileShareName | Should -Be "azps-rw-sharename"
} | Should -Not -Throw
}
Expand All @@ -45,9 +45,9 @@ Describe 'AzContainerAppConnectedEnvStorage' {
It 'UpdateExpanded' {
{
# $storageAccountKey = (Get-AzStorageAccountKey -ResourceGroupName $env.resourceGroupConnected -AccountName $env.storageAccount2).Value[0]
$storageAccountKey = "1234"
$storageAccountKeySecure = "1234" | ConvertTo-SecureString -AsPlainText

$config = Update-AzContainerAppConnectedEnvStorage -ConnectedEnvironmentName $env.connectedEnv1 -ResourceGroupName $env.resourceGroupConnected -Name $env.connectedEnvStorage -AzureFileAccessMode 'ReadWrite' -AzureFileAccountKey $storageAccountKey -AzureFileAccountName azpstestsa -AzureFileShareName azps-rw-sharename
$config = Update-AzContainerAppConnectedEnvStorage -ConnectedEnvironmentName $env.connectedEnv1 -ResourceGroupName $env.resourceGroupConnected -Name $env.connectedEnvStorage -AzureFileAccessMode 'ReadWrite' -AzureFileAccountKeySecure $storageAccountKeySecure -AzureFileAccountName azpstestsa -AzureFileShareName azps-rw-sharename
$config.AzureFileShareName | Should -Be "azps-rw-sharename"

} | Should -Not -Throw
Expand All @@ -56,10 +56,10 @@ Describe 'AzContainerAppConnectedEnvStorage' {
It 'UpdateViaIdentityExpanded' {
{
# $storageAccountKey = (Get-AzStorageAccountKey -ResourceGroupName $env.resourceGroupConnected -AccountName $env.storageAccount2).Value[0]
$storageAccountKey = "1234"
$storageAccountKeySecure = "1234" | ConvertTo-SecureString -AsPlainText
$config = Get-AzContainerAppConnectedEnvStorage -ConnectedEnvironmentName $env.connectedEnv1 -ResourceGroupName $env.resourceGroupConnected -Name $env.connectedEnvStorage

$config = Update-AzContainerAppConnectedEnvStorage -InputObject $config -AzureFileAccessMode 'ReadWrite' -AzureFileAccountKey $storageAccountKey -AzureFileAccountName azpstestsa -AzureFileShareName azps-rw-sharename
$config = Update-AzContainerAppConnectedEnvStorage -InputObject $config -AzureFileAccessMode 'ReadWrite' -AzureFileAccountKeySecure $storageAccountKeySecure -AzureFileAccountName azpstestsa -AzureFileShareName azps-rw-sharename
$config.AzureFileShareName | Should -Be "azps-rw-sharename"
} | Should -Not -Throw
}
Expand Down
14 changes: 7 additions & 7 deletions src/App/App.Autorest/test/AzContainerAppManagedEnvStorage.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ Describe 'AzContainerAppManagedEnvStorage' {
It 'CreateExpanded' {
{
# $storageAccountKey = (Get-AzStorageAccountKey -ResourceGroupName $env.resourceGroupManaged -AccountName $env.storageAccount1).Value[0]
$storageAccountKey = "1234"

$config = New-AzContainerAppManagedEnvStorage -EnvName $env.managedEnv1 -ResourceGroupName $env.resourceGroupManaged -Name $env.managedEnvStorage -AzureFileAccessMode 'ReadWrite' -AzureFileAccountKey $storageAccountKey -AzureFileAccountName $env.storageAccount1 -AzureFileShareName azps-rw-sharename
$storageAccountKeySecure = "1234" | ConvertTo-SecureString -AsPlainText
$config = New-AzContainerAppManagedEnvStorage -EnvName $env.managedEnv1 -ResourceGroupName $env.resourceGroupManaged -Name $env.managedEnvStorage -AzureFileAccessMode 'ReadWrite' -AzureFileAccountKeySecure $storageAccountKeySecure -AzureFileAccountName $env.storageAccount1 -AzureFileShareName azps-rw-sharename
$config.AzureFileShareName | Should -Be "azps-rw-sharename"
} | Should -Not -Throw
}
Expand All @@ -45,20 +45,20 @@ Describe 'AzContainerAppManagedEnvStorage' {
It 'UpdateExpanded' {
{
# $storageAccountKey = (Get-AzStorageAccountKey -ResourceGroupName $env.resourceGroupManaged -AccountName $env.storageAccount1).Value[0]
$storageAccountKey = "1234"
$storageAccountKeySecure = "1234" | ConvertTo-SecureString -AsPlainText

$config = Update-AzContainerAppManagedEnvStorage -EnvName $env.managedEnv1 -ResourceGroupName $env.resourceGroupManaged -Name $env.managedEnvStorage -AzureFileAccessMode 'ReadWrite' -AzureFileAccountKey $storageAccountKey -AzureFileAccountName $env.storageAccount1 -AzureFileShareName azps-rw-sharename
$config = Update-AzContainerAppManagedEnvStorage -EnvName $env.managedEnv1 -ResourceGroupName $env.resourceGroupManaged -Name $env.managedEnvStorage -AzureFileAccessMode 'ReadWrite' -AzureFileAccountKeySecure $storageAccountKeySecure -AzureFileAccountName $env.storageAccount1 -AzureFileShareName azps-rw-sharename
$config.AzureFileShareName | Should -Be "azps-rw-sharename"
} | Should -Not -Throw
}

It 'UpdateViaIdentityExpanded' {
{
# $storageAccountKey = (Get-AzStorageAccountKey -ResourceGroupName $env.resourceGroupManaged -AccountName $env.storageAccount1).Value[0]
$storageAccountKey = "1234"
$storageAccountKeySecure = "1234" | ConvertTo-SecureString -AsPlainText
$config = Get-AzContainerAppManagedEnvStorage -EnvName $env.managedEnv1 -ResourceGroupName $env.resourceGroupManaged -Name $env.managedEnvStorage

$config = Update-AzContainerAppManagedEnvStorage -InputObject $config -AzureFileAccessMode 'ReadWrite' -AzureFileAccountKey $storageAccountKey -AzureFileAccountName $env.storageAccount1 -AzureFileShareName azps-rw-sharename
$config = Update-AzContainerAppManagedEnvStorage -InputObject $config -AzureFileAccessMode 'ReadWrite' -AzureFileAccountKeySecure $storageAccountKeySecure -AzureFileAccountName $env.storageAccount1 -AzureFileShareName azps-rw-sharename
$config.AzureFileShareName | Should -Be "azps-rw-sharename"
} | Should -Not -Throw
}
Expand Down
2 changes: 1 addition & 1 deletion tools/PrepareAutorestModule.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ git pull origin main --depth=1
Copy-Item -Path "$TmpFolder\src\Accounts" -Destination "$TmpFolder\Accounts" -Force -Recurse
Copy-Item "$TmpFolder\Accounts" "$PSScriptRoot\..\src" -Recurse -Force
Copy-Item -Path "$TmpFolder\tools\Common*.targets" -Destination "$PSScriptRoot\..\tools" -Force
Install-Module Az.Accounts -Repository PSGallery -Force
Install-Module Az.Accounts -Repository PSGallery -Force -AllowClobber
Import-Module Az.Accounts
Copy-Item "$PSScriptRoot\..\src\*.props" $TmpFolder

Expand Down
Loading