Any way to get rid of an obsolete parameter in Azure PowerShell script (AzureRM to Az changing) - azure

As you may know, MSFT is getting rid of AzureRM cmdlets in favor of Az.
There are a lot of issues regarding this since the proposed native aliases "Enable-AzureRmAlias" seems to stop being updated.
I have a script based on AzureRM in one repo, that triggers by Azure DevOps release pipeline step function (Azure PowerShell based),
that has the following piece of code:
$var = (Get-AzureKeyVaultSecret -VaultName $vaultName-Name $Key).SecretValueText
"Enable-AzureRmAlias" command activated as well..., that converts the code like this:
$var = (Get-AzKeyVaultSecret -VaultName $vaultName-Name $Key).SecretValueText
The problem is, that ".SecretValueText" was deprecated a while ago. Instead of it, a new parameter has been added to the Get-AzKeyVaultSecret cmdlet - "-AsPlainText"
so... theoretically the final construction has to be like this:
$var = Get-AzKeyVaultSecret -VaultName $vaultName-Name $Key -AsPlainText
Challenges!
I can't upgrade the original script in the repo to Az due to the necessity of back-compatibility.
The only way to solve it - is to create some kind of alias in Azure PowerShell inline script (that triggers the main script in the repo)
I stuck with this ".SecretValueText"
My original idea to put the following into the inline script doesn't seem to be working:
function Get-AzKeyVaultSecretNew {
Param(
$vaultName,
$Key
)
$var = Get-AzKeyVaultSecret -VaultName $vaultName -Name $Key -AsPlainText
return $var
}
Set-Alias -Name Get-AzKeyVaultSecret -Value Get-AzKeyVaultSecretNew
Any ideas on how to accomplish this?

This should theoretically help your situation. You can run this code at the beginning of the PowerShell session that will be calling your scripts. You will need to make sure any necessary modules are loaded so that the secret object types are loaded.
$Script = { Get-AzKeyVaultSecret -VaultName $this.VaultName -Name $this.Name -AsPlainText }
Update-TypeData -TypeName 'Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultSecretIdentityItem' -MemberName 'SecretValueText' -MemberType ScriptProperty -Value $Script
The idea is to add the SecretValueText property back to the Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultSecretIdentityItem objects.

You can try using below workaround to replace below piece of code:
(Get-AzureKeyVaultSecret -VaultName $vaultName-Name $Key).SecretValueText
with Get-AzKeyVaultSecret -VaultName $vaultName -Name $Key -AsPlainText via using RegEx Find & Replace task. Check below steps:
1, Add task RegEx Find & Replace to replace the orginal code with the converted code. See below:
FindRegex: '\(Get-AzureKeyVaultSecret -VaultName \$vaultName -Name \$Key\)\.SecretValueText'
ReplaceRegex: 'Get-AzKeyVaultSecret -VaultName $vaultName -Name $Key -AsPlainText'
2, -AsPlainText parameter is only available in the latest az 5.3.0 version. Since the version installed in cloud agent is 4.7.0. You need to install the az 5.3.0 version before executing your script. See below. Use a powershell task to install az 5.3.0 version.
New-Item -Path "C:\Modules" -Name "az_5.3.0" -ItemType "directory"
Save-Module -Name AZ -RequiredVersion 5.3.0 -Path "C:\Modules\az_5.3.0"
3, Then you can invoke your script in the azure powershell task directly.

Related

Utilizing Azure Custom Script Extensions to maintain a custom PowerShell module across multiple servers

I'm trying to automate some tasks at work and someone gave me an idea that we could utilize Azure Custom Script Extensions to maintain a custom PowerShell module across multiple servers.
The script is located on our Azure DevOps, but I assume I could create a Pipeline that moves it to storage account after a pull request is completed.
However, my question is - how does Custom Script Extension work in the first place and would it be suitable for my needs, which are having an up-to-date PowerShell module available on multiple servers?
Were you able to find the answer on your question?
As I know, after the Custom Script Extension is installed the script will be executed once.
Below code snippet shows how you could deploy Custom Script Extension on Multiple VMs:
$CustomerScriptExtension = "yourCSEName"
$AllVMs = Get-AzureRMVM #get all VMs
$CntOfVMs = 0;
foreach($vm in $AllVMs)
{
try
{
$CntOfVMs = $CntOfVMs + 1
Write-Host "VMCount:" $CntOfVMs
#Get the VM details of that instance
$vmDetails = Get-AzureRmVM -ResourceGroupName $vm.ResourceGroupName -Name vm.Name
#Check if already an extension exists of type Custome Script Extension
$cseExtension = $vmDetails.Extensions | where { $_.Publisher -eq
"Microsoft.Compute" -and $_.VirtualMachineExtensionType -eq "CustomScriptExtension" }
# If Extension already exists remove the extension
if ($cseExtension)
{
#Remove the extension
Write-Host "Removing existing extension on VirtualMachine:" $vm.Name
Remove-AzureRmVMCustomScriptExtension -ResourceGroupName
$vm.ResourceGroupName -VMName $vm.Name -Name $cseExtension.Name
Write-Host "Completed Removal of existing extension on VirtualMachine:"
$vm.Name
}
try
{
Write-Host "Installing extenstion on VirtualMachine :" $vm.Name
Set-AzureRmVMCustomScriptExtension -ResourceGroupName
$vm.ResourceGroupName -VMName $vm.Name -Location $vm.Location -FileUri
PathToyourPowerShellCodeToUpdateVMGoesThere.ps1 -Run "InstalluptodatePowerShell.ps1" -name
$CustomerScriptExtension
Write-Host "completed Extension installation on VirtualMachine :"
$vm.Name
}
catch
{
Write-Host "Error installing extension on VirtualMachine :" $vm.Name
}
}
catch
{
Write-Host "Error in setting extension on VM:" $vm.Name
}
}

Assistance needed with powershell script

I am trying the execute the powershell script found at :
https://github.com/amanbedi18/Azure-KeyVault-Automation/tree/master/UploadSecrets
https://github.com/amanbedi18/Azure-KeyVault-Automation
This script is used to automate upload of secrets to azure key-vault.
I have created the below json file and named it /user/kv/AzureSecretsMetaData.json
[
{
"key": "test1",
"value": "1"
},
{
"key": "test2",
"value": "2"
}
]
I then copied contents of setKeyVaultSecrets.ps1 to /user/kv/setKeyVaultSecrets.ps1
I have tried the below commands that were mentioned in the readme and powershell script files and get the below errors, could someone please help me execute this script correctly and point out what I am doing wrong here.
./setkeyVaultSecret.ps1 -KeyVaultName 'avkv01'
setkeyVaultSecret.ps1: Parameter set cannot be resolved using the specified named parameters. One or more parameters issued cannot be used together or an insufficient number of parameters were provided.
./setkeyVaultSecret.ps1 -KeyVaultName 'avkv01' -KVSecretMetadataFilePath '/home/aditya/kv/AzureSecretsMetaData.json'
setkeyVaultSecret.ps1: Parameter set cannot be resolved using the specified named parameters. One or more parameters issued cannot be used together or an insufficient number of parameters were provided.
Any help is greatly appreciated. Thank You
If these are scripts you found, they are very poorly written and I would advise not using them. I would suggest installing the az powershell module and using those scripts as a reference in writing your own script. You can install the az powershell module with powershellget:
Install-module az -force -allowclobber
The way the script that you are trying to call is written very strangely. It defines two different parameter sets, but each of the two parameters are mandatory for BOTH parameter sets?! That doesn't make a lot of sense. If you must run them, you will probably need to modify them a bit. They don't really seem finished.. Why not modify the script and get rid of the parameter sets altogether? Also, the example in the script indicates that the "$KVSecretMetadataFilePath" parameter is not mandatory, since it is not being called, but is defined as being mandatory when defining your parameter. You need to make clear if this parameter is required or not. If it is required Make it look more like this:
<#
.PREREQUISITE
1. An Azure key vault and its name as parameter.
2. Json template should be properly populated with valid json schema in sampleSecretValues.json in KeyVaultjson directory.
.PARAMETER vaultName
The name of the key vault.
.EXAMPLE
. setKeyVaultSecret.ps1 -KeyVaultName 'somekeyvault'
#>
# provision keys and secrets to a key vault
Param(
[Parameter(Mandatory=$true)]
[String]
$KeyVaultName,
[Parameter(Mandatory=$true)]
[String]
$KVSecretMetadataFilePath
)
Install-Module -Name AzureADPreview -ErrorAction SilentlyContinue -Force
Import-Module Azure -ErrorAction SilentlyContinue
Import-Module AzureRM.Resources
Set-StrictMode -Version 3
$json = Get-Content $KVSecretMetadataFilePath | Out-String | ConvertFrom-Json
$json | ForEach {
$secretToSearch = Get-AzureKeyVaultSecret -VaultName $KeyVaultName -Name $_.key -ErrorAction SilentlyContinue
if($secretToSearch -ne $null)
{
echo "The secret $_.key already exists !"
}
Else
{
$NewSecret = Set-AzureKeyVaultSecret -VaultName $KeyVaultName -Name $_.key -SecretValue (ConvertTo-SecureString $_.value -AsPlainText -Force ) -Verbose
Write-Host
Write-Host "Source Vault Resource Id: "$(Get-AzureRmKeyVault -VaultName $KeyVaultName).ResourceId
}
}
If it is not required, remove the line "[Parameter(Mandatory=$true)]" above the $KVSecretMetadataFilePath declaration.

Azure: New-AzRoleAssignment Input string was not in a correct format - error with double parsing... without any number

I have a strange problem with my PowerShell script to create Azure user accounts.
Executing command
New-AzRoleAssignment -RoleDefinitionName 'Contributor' -ObjectId "$Usr.Id" -ResourceGroupName "$rgname"
Results in exception:
New-AzRoleAssignment : Input string was not in a correct format.
At myscript.ps1:151 char:5
+ New-AzRoleAssignment -RoleDefinitionName 'Contributor' -ObjectId ...
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ CategoryInfo : CloseError: (:) [New-AzRoleAssignment], FormatException
+ FullyQualifiedErrorId : Microsoft.Azure.Commands.Resources.NewAzureRoleAssignmentCommand
I've extracted stacktrace for this exception, and it looks like this:
at System.Number.ParseDouble(String value, NumberStyles options, NumberFormatInfo numfmt)
at Microsoft.Azure.Commands.Resources.NewAzureRoleAssignmentCommand.ExecuteCmdlet()
at Microsoft.WindowsAzure.Commands.Utilities.Common.AzurePSCmdlet.ProcessRecord()
Which is super strange - I'm not using any double number here. I've dig into source code for NewAzureRoleAssignmentCommand - but there is no System.Number.ParseDouble call there.
Only thing related to double is -ConditionVersion, but I don't want to use any Coditions.
What I should check next? I'm not an advanced Azure/Powershell user, so any suggestions are welcomed!
edit:
I've tried running command manually using same parameter values, with and without quotation marks - every time I get same error
New-AzRoleAssignment -RoleDefinitionName 'Contributor' -ObjectId f01b4003-8a47-4a9d-8935-cd000c8cd9c5 -ResourceGroupName myValidResourceGrupName
Try using Azure Cloud Shell to check whether the problem might be local to your machine.
Remove the double quotes that are around $usr.id
If you'd only have a string like:
$usr = <GUID goes here>
then you could pass "$usr". But in this case, you're trying to access the Id property of the $usr object.
I would try getting your with Get-AzRoleDefinition. I tend to get the objects for everything and use the IDs. This works for me.
$Role = Get-AzRoleDefinition -Name Contributor
$ResourceGroup = Get-AzResourceGroup -Name "ResourceGroupName"
$User = Get-AzADUser -UserPrincipalName "User-UPN-Here"
New-AzRoleAssignment -ObjectId $User.Id -RoleDefinitionId $Role.Id -Scope $ResourceGroup.ResourceId
I had the same problem. This script used to work:
$qa = get-azadgroup -displayname qa;
New-AzRoleAssignment -ObjectId $qa.Id -RoleDefinitionName Owner -ResourceGroupName RG-QA
Started getting this error on one computer but not the other. When I checked the modules version for az.resources, I had 2.1.0, 2.4.0 and 2.5.0. After removing versions 2.4.0 and 2.5.0, the script worked. I have the language of Powershell set to French.
https://github.com/Azure/azure-powershell/issues/13096 it's this issue if anyone else runs into this issue. Workaround as above is to use 2.1.0 of Az.resources but should be fixed soon.

Azure - setting tags on VMs using Powershell

I'm using the following Powershell code to set tags on a bunch of Azure VMs but it doesn't seem to be working. It does not give me an error message, so it appears to run correctly, but it does not set the tags as expected. Any help would be great, perhaps it may be something easy I'm overlooking.
$group = Get-AzResourceGroup -Name my-rg
$resource = Get-AzResource -ResourceName myserver -ResourceGroupName my-rg
Set-AzResource -ResourceId $resource.ResourceId -Tag $group.Tags -Force
I'm only doing a few VMs which I'll probably put on a loop once this works. There are no tags on most of these VMs which may be overwritten.

Azure Powershell - iterate through a list (txt) with db names and set them as variables in script

I have the following challenge at the Moment:
With T-SQL I created a list of databases attached to our SQL instance and put this list in a txt file, so far no Problem.
Now with PowerShell I want to set up LongTermRetention backups in Azure with following cmdlet:
Set-AzSqlDatabaseBackupLongTermRetentionPolicy -ServerName $serverName -DatabaseName [name of database] -ResourceGroupName $resourceGroup -WeeklyRetention P53W -MonthlyRetention P48M -YearlyRetention P10Y -WeekOfYear 52
(I checked the Syntax of the cmdlet by inserting a database name manually and it works)
the variables given are set prior (ServerName, resourceGroup)
Where I am struggling now is, how I can get the names of the txt file one after another as parameter "DatabaseName" into my cmdlet, as I have never done something like this.
I would be very grateful for either a link on how to do this or maybe a solution posted here.
Thank you in advance and Kind regards
EDIT: I found a solution, Maybe not the most elegant, but working:
$files = Get-Content "C:\DEV\testfile.txt"
foreach ($file in $files){
Set-AzSqlDatabaseBackupLongTermRetentionPolicy -ServerName $serverName -DatabaseName $file -ResourceGroupName $resourceGroup -WeeklyRetention P53W -MonthlyRetention P48M -YearlyRetention P10Y -WeekOfYear 52
}
I haven't thought it might have been that easy.
If you have a flat text file where your database names are present like this:
server1
server2
server3
......
You can use the Get-Content cmdlet to read the file and iterate over each line using the ForEach-Object cmdlet. You can access the current item using $_ ($_ represents the current value in the pipeline):
Get-Content -Path 'pathToYourFile.txt' | ForEach-Object {
Set-AzSqlDatabaseBackupLongTermRetentionPolicy `
-ServerName $_ `
-DatabaseName [name of database] `
-ResourceGroupName $resourceGroup `
-WeeklyRetention P53W `
-MonthlyRetention P48M `
-YearlyRetention P10Y `
-WeekOfYear 52
}

Resources