From 83ad20fc15636a544d44efdcaf287285e256a76d Mon Sep 17 00:00:00 2001 From: cormacpayne Date: Mon, 6 Nov 2017 13:17:01 -0800 Subject: [PATCH] Prepare migration guide for 5.0.0 release --- .../release-notes/migration-guide.5.0.0.md | 708 ++++++++++++++++++ .../documentation/current-breaking-changes.md | 39 +- .../upcoming-breaking-changes.md | 40 +- .../documentation/current-breaking-changes.md | 208 +++++ .../upcoming-breaking-changes.md | 211 +----- .../documentation/current-breaking-changes.md | 17 +- .../upcoming-breaking-changes.md | 18 +- .../documentation/current-breaking-changes.md | 111 ++- .../upcoming-breaking-changes.md | 125 +--- .../documentation/current-breaking-changes.md | 104 ++- .../upcoming-breaking-changes.md | 180 +---- .../documentation/current-breaking-changes.md | 39 +- .../upcoming-breaking-changes.md | 16 +- .../documentation/current-breaking-changes.md | 72 +- .../upcoming-breaking-changes.md | 76 +- .../documentation/current-breaking-changes.md | 146 +++- .../upcoming-breaking-changes.md | 158 +--- 17 files changed, 1428 insertions(+), 840 deletions(-) create mode 100644 documentation/release-notes/migration-guide.5.0.0.md diff --git a/documentation/release-notes/migration-guide.5.0.0.md b/documentation/release-notes/migration-guide.5.0.0.md new file mode 100644 index 000000000000..65cb82f66326 --- /dev/null +++ b/documentation/release-notes/migration-guide.5.0.0.md @@ -0,0 +1,708 @@ +# Breaking changes for Microsoft Azure PowerShell 5.0.0 + +This document serves as both a breaking change notification and migration guide for consumers of the Microsoft Azure PowerShell cmdlets. Each section describes both the impetus for the breaking change and the migration path of least resistance. For in-depth context, please refer to the pull request associated with each change. + +## Table of Contents + +- [Breaking changes to ApiManagement cmdlets](#breaking-changes-to-apimanagement-cmdlets) +- [Breaking changes to Batch cmdlets](#breaking-changes-to-batch-cmdlets) +- [Breaking changes to Compute cmdlets](#breaking-changes-to-compute-cmdlets) +- [Breaking changes to EventHub cmdlets](#breaking-changes-to-eventhub-cmdlets) +- [Breaking changes to Insights cmdlets](#breaking-changes-to-insights-cmdlets) +- [Breaking changes to Network cmdlets](#breaking-changes-to-network-cmdlets) +- [Breaking changes to Resources cmdlets](#breaking-changes-to-resources-cmdlets) +- [Breaking Changes to ServiceBus Cmdlets](#breaking-changes-to-servicebus-cmdlets) + +## Breaking changes to ApiManagement cmdlets + +### **New-AzureRmApiManagementBackendProxy** +- Parameters "UserName" and "Password" are being replaced in favor of a PSCredential + +```powershell +# Old +New-AzureRmApiManagementBackendProxy [other required parameters] -UserName "plain-text string" -Password "plain-text string" + +# New +New-AzureRmApiManagementBackendProxy [other required parameters] -Credential $PSCredentialVariable +``` + +### **New-AzureRmApiManagementUser** +- Parameter "Password" being replaced in favor of a SecureString + +```powershell +# Old +New-AzureRmApiManagementUser [other required parameters] -Password "plain-text string" + +# New +New-AzureRmApiManagementUser [other required parameters] -Password $SecureStringVariable +``` + +### **Set-AzureRmApiManagementUser** +- Parameter "Password" being replaced in favor of a SecureString + +```powershell +# Old +Set-AzureRmApiManagementUser [other required parameters] -Password "plain-text string" + +# New +Set-AzureRmApiManagementUser [other required parameters] -Password $SecureStringVariable +``` + +## Breaking changes to Batch cmdlets + +### **New-AzureBatchCertificate** +- Parameter `Password` being replaced in favor of a Secure string + +```powershell +# Old +New-AzureBatchCertificate [other required parameters] -Password "plain-text string" + +# New +New-AzureBatchCertificate [other required parameters] -Password $SecureStringVariable +``` + +### **New-AzureBatchComputeNodeUser** +- Parameter `Password` being replaced in favor of a Secure string + +```powershell +# Old +New-AzureBatchComputeNodeUser [other required parameters] -Password "plain-text string" + +# New +New-AzureBatchComputeNodeUser [other required parameters] -Password $SecureStringVariable +``` + +### **Set-AzureRmBatchComputeNodeUser** +- Parameter `Password` being replaced in favor of a Secure string + +```powershell +# Old +Set-AzureRmBatchComputeNodeUser [other required parameters] -Password "plain-text string" + +# New +Set-AzureRmBatchComputeNodeUser [other required parameters] -Password $SecureStringVariable +``` + +### **New-AzureBatchTask** + - Removed the `RunElevated` switch and replaced it with `UserIdentity`. + +```powershell +# Old +New-AzureBatchTask -Id $taskId1 -JobId $jobId -CommandLine "cmd /c echo hello" -RunElevated $TRUE + +# New +$autoUser = New-Object Microsoft.Azure.Commands.Batch.Models.PSAutoUserSpecification -ArgumentList @("Task", "Admin") +$userIdentity = New-Object Microsoft.Azure.Commands.Batch.Models.PSUserIdentity $autoUser +New-AzureBatchTask -Id $taskId1 -JobId $jobId -CommandLine "cmd /c echo hello" -UserIdentity $userIdentity +``` + +This additionally impacts the `RunElevated` property on `PSCloudTask`, `PSStartTask`, `PSJobManagerTask`, `PSJobPreparationTask`, and `PSJobReleaseTask`. + +### **PSMultiInstanceSettings** + +- `PSMultiInstanceSettings` constructor no longer takes a required `numberOfInstances` parameter, instead it takes a required `coordinationCommandLine` parameter. + +```powershell +# Old +$settings = New-Object Microsoft.Azure.Commands.Batch.Models.PSMultiInstanceSettings -ArgumentList @(2) +$settings.CoordinationCommandLine = "cmd /c echo hello" +New-AzureBatchTask [other parameters] -MultiInstanceSettings $settings + +# New +$settings = New-Object Microsoft.Azure.Commands.Batch.Models.PSMultiInstanceSettings -ArgumentList @("cmd /c echo hello", 2) +New-AzureBatchTask [other parameters] -MultiInstanceSettings $settings +``` + +### **Get-AzureBatchTask** + - Removed the `RunElevated` property on `PSCloudTask`. The `UserIdentity` property has been added to replace `RunElevated`. + +```powershell +# Old +$task = Get-AzureBatchTask [parameters] +$task.RunElevated + +# New +$task = Get-AzureBatchTask [parameters] +$task.UserIdentity.AutoUser.ElevationLevel +``` + +This additionally impacts the `RunElevated` property on `PSCloudTask`, `PSStartTask`, `PSJobManagerTask`, `PSJobPreparationTask`, and `PSJobReleaseTask`. + +### **Multiple types** + +- Renamed the `SchedulingError` property on `PSExitConditions` to `PreProcessingError`. + +```powershell +# Old +$task = Get-AzureBatchTask [parameters] +$task.ExitConditions.SchedulingError + +# New +$task = Get-AzureBatchTask [parameters] +$task.ExitConditions.PreProcessingError +``` + +### **Multiple types** + +- Renamed the `SchedulingError` property on `PSJobPreparationTaskExecutionInformation`, `PSJobReleaseTaskExecutionInformation`, `PSStartTaskInformation`, `PSSubtaskInformation`, and `PSTaskExecutionInformation` to `FailureInformation`. + - `FailureInformation` is returned any time there is a task failure. This includes all previous scheduling error cases, as well as nonzero task exit codes, and file upload failures from the new output files feature. + - This is structured the same as before, so no code change is needed when using this type. + +```powershell +# Old +$task = Get-AzureBatchTask [parameters] +$task.ExecutionInformation.SchedulingError + +# New +$task = Get-AzureBatchTask [parameters] +$task.ExecutionInformation.FailureInformation +``` + +This additionally impacts: Get-AzureBatchPool, Get-AzureBatchSubtask, and Get-AzureBatchJobPreparationAndReleaseTaskStatus + +### **New-AzureBatchPool** + - Removed `TargetDedicated` and replaced it with `TargetDedicatedComputeNodes` and `TargetLowPriorityComputeNodes`. + - `TargetDedicatedComputeNodes` has an alias `TargetDedicated`. + +```powershell +# Old +New-AzureBatchPool [other parameters] [-TargetDedicated ] + +# New +New-AzureBatchPool [other parameters] [-TargetDedicatedComputeNodes ] [-TargetLowPriorityComputeNodes ] +``` + +This also impacts: Start-AzureBatchPoolResize + +### **Get-AzureBatchPool** + - Renamed the `TargetDedicated` and `CurrentDedicated` properties on `PSCloudPool` to `TargetDedicatedComputeNodes` and `CurrentDedicatedComputeNodes`. + +```powershell +# Old +$pool = Get-AzureBatchPool [parameters] +$pool.TargetDedicated +$pool.CurrentDedicated + +# New +$pool = Get-AzureBatchPool [parameters] +$pool.TargetDedicatedComputeNodes +$pool.CurrentDedicatedComputeNodes +``` + +### **Type PSCloudPool** + +- Renamed `ResizeError` to `ResizeErrors` on `PSCloudPool`, and it is now a collection. + +```powershell +# Old +$pool = Get-AzureBatchPool [parameters] +$pool.ResizeError + +# New +$pool = Get-AzureBatchPool [parameters] +$pool.ResizeErrors[0] +``` + +### **New-AzureBatchJob** +- Renamed the `TargetDedicated` property on `PSPoolSpecification` to `TargetDedicatedComputeNodes`. + +```powershell +# Old +$poolInfo = New-Object Microsoft.Azure.Commands.Batch.Models.PSPoolInformation +$poolInfo.AutoPoolSpecification = New-Object Microsoft.Azure.Commands.Batch.Models.PSAutoPoolSpecification +$poolInfo.AutoPoolSpecification.PoolSpecification = New-Object Microsoft.Azure.Commands.Batch.Models.PSPoolSpecification +$poolInfo.AutoPoolSpecification.PoolSpecification.TargetDedicated = 5 +New-AzureBatchJob [other parameters] -PoolInformation $poolInfo + +# New +$poolInfo = New-Object Microsoft.Azure.Commands.Batch.Models.PSPoolInformation +$poolInfo.AutoPoolSpecification = New-Object Microsoft.Azure.Commands.Batch.Models.PSAutoPoolSpecification +$poolInfo.AutoPoolSpecification.PoolSpecification = New-Object Microsoft.Azure.Commands.Batch.Models.PSPoolSpecification +$poolInfo.AutoPoolSpecification.PoolSpecification.TargetDedicatedComputeNodes = 5 +New-AzureBatchJob [other parameters] -PoolInformation $poolInfo +``` + +### **Get-AzureBatchNodeFile** + - Removed `Name` and replaced it with `Path`. + - `Path` has an alias `Name`. + +```powershell +# Old +Get-AzureBatchNodeFile [other parameters] [[-Name] ] + +# New +Get-AzureBatchNodeFile [other parameters] [[-Path] ] +``` + +This also impacts: Get-AzureBatchNodeFileContent, Remove-AzureBatchNodeFile + +### Type **PSNodeFile** + + - Renamed the `Name` property on `PSNodeFile` to `Path`. + +```powershell +# Old +$file = Get-AzureBatchNodeFile [parameters] +$file.Name + +# New +$file = Get-AzureBatchNodeFile [parameters] +$file.Path +``` + +### **Get-AzureBatchSubtask** +- The `PreviousState` and `State` properties of `PSSubtaskInformation` are no longer of type `TaskState`, instead they are of type `SubtaskState`. + - Unlike `TaskState`, `SubtaskState` has no `Active` value, since it is not possible for subtasks to be in an `Active` state. + +```powershell +# Old +$subtask = Get-AzureBatchSubtask [parameters] +if ($subtask.State -eq Microsoft.Azure.Batch.Common.TaskState.Running) { } + +# New +$subtask = Get-AzureBatchSubtask [parameters] +if ($subtask.State -eq Microsoft.Azure.Batch.Common.SubtaskState.Running) { } +``` + +## Breaking changes to Compute cmdlets + +### **Set-AzureRmVMAccessExtension** +- Parameters "UserName" and "Password" are being replaced in favor of a PSCredential + +```powershell +# Old +Set-AzureRmVMAccessExtension [other required parameters] -UserName "plain-text string" -Password "plain-text string" + +# New +Set-AzureRmVMAccessExtension [other required parameters] -Credential $PSCredential +``` + +## Breaking changes to EventHub cmdlets + +### **New-AzureRmEventHubNamespaceAuthorizationRule** +- The 'New-AzureRmEventHubNamespaceAuthorizationRule' cmdlet has been removed. Please use the 'New-AzureRmEventHubAuthorizationRule' cmdlet + +### **Get-AzureRmEventHubNamespaceAuthorizationRule** +- The 'Get-AzureRmEventHubNamespaceAuthorizationRule' cmdlet has been removed. Please use the 'Get-AzureRmEventHubAuthorizationRule' cmdlet + +### **Set-AzureRmEventHubNamespaceAuthorizationRule** +- The 'Set-AzureRmEventHubNamespaceAuthorizationRule' cmdlet has been removed. Please use the 'Set-AzureRmEventHubAuthorizationRule' cmdlet + +### **Remove-AzureRmEventHubNamespaceAuthorizationRule** +- The 'Remove-AzureRmEventHubNamespaceAuthorizationRule' cmdlet has been removed. Please use the 'Remove-AzureRmEventHubAuthorizationRule' cmdlet + +### **New-AzureRmEventHubNamespaceKey** +- The 'New-AzureRmEventHubNamespaceKey' cmdlet has been removed. Please use the 'New-AzureRmEventHubKey' cmdlet + +### **Get-AzureRmEventHubNamespaceKey** +- The 'Get-AzureRmEventHubNamespaceKey' cmdlet has been removed. Please use the 'Get-AzureRmEventHubKey' cmdlet + +### **New-AzureRmEventHubNamespace** +- The property 'Status' and 'Enabled' from the NamespceAttributes will be removed. + +```powershell +# Old +# The $namespace has Status and Enabled property +$namespace = New-AzureRmEventHubNamespace +$namespace.Status +$namespace.Enabled + +# New +# The call remains the same, but the returned values NameSpace object will not have the Status and Enabled property +$namespace = Get-AzureRmEventHubNamespace +``` + +### **Get-AzureRmEventHubNamespace** +- The property 'Status' and 'Enabled' from the NamespceAttributes will be removed. + +```powershell +# Old +# The $namespace has Status and Enabled property +$namespace = Get-AzureRmEventHubNamespace +$namespace.Status +$namespace.Enabled + +# New +# The call remains the same, but the returned values NameSpace object will not have the Status and Enabled property +$namespace = Get-AzureRmEventHubNamespace +``` + +### **Set-AzureRmEventHubNamespace** +- The property 'Status' and 'Enabled' from the NamespceAttributes will be removed. + +```powershell +# Old +# The $namespace has Status and Enabled property +$namespace = Set-AzureRmEventHubNamespace +$namespace.Status +$namespace.Enabled + +# New +# The call remains the same, but the returned values NameSpace object will not have the Status and Enabled property +$namespace = Set-AzureRmEventHubNamespace +``` + +### **New-AzureRmEventHubConsumerGroup** +- The property 'EventHubPath' from the ConsumerGroupAttributes will be removed. + +```powershell +# Old +# The $consumergroup has EventHubPath property +$consumergroup = New-AzureRmEventHubConsumerGroup +$consumergroup.EventHubPath + +# New +# The call remains the same, but the returned values ConsumerGroup object will not have the EventHubPath property +$consumergroup = New-AzureRmEventHubConsumerGroup +``` + +### **Set-AzureRmEventHubConsumerGroup** +- The property 'EventHubPath' from the ConsumerGroupAttributes will be removed. + +```powershell +# Old +# The $consumergroup has EventHubPath property +$consumergroup = Set-AzureRmEventHubConsumerGroup +$consumergroup.EventHubPath + +# New +# The call remains the same, but the returned values ConsumerGroup object will not have the EventHubPath property +$consumergroup = Set-AzureRmEventHubConsumerGroup +``` + +### **Get-AzureRmEventHubConsumerGroup** +- The property 'EventHubPath' from the ConsumerGroupAttributes will be removed. + +```powershell +# Old +# The $consumergroup has EventHubPath property +$consumergroup = Get-AzureRmEventHubConsumerGroup +$consumergroup.EventHubPath + +# New +# The call remains the same, but the returned values ConsumerGroup object will not have the EventHubPath property +$consumergroup = Get-AzureRmEventHubConsumerGroup +``` + +## Breaking changes to Insights cmdlets + +### **Add-AzureRMLogAlertRule** +- The **Add-AzureRMLogAlertRule** cmdlet has been deprecated +- After October 1st using this cmdlet will no longer have any effect as this functionality is being transitioned to Activity Log Alerts. Please see https://aka.ms/migratemealerts for more information. + +### **Get-AzureRMUsage** +- The **Get-AzureRMUsage** cmdlet has been deprecated + +### **Get-AzureRmAlertHistory** / **Get-AzureRmAutoscaleHistory** / **Get-AzureRmLogs** +- Output change: The field EventChannels from the EventData object (returned by these cmdlets) is being deprecated since it now returns a constant value (Admin,Operation.) + +### **Get-AzureRmAlertRule** +- Output change: The output of this cmdlet will be flattened, i.e. elimination of the properties field, to improve the user experience. + +```powershell +# Old +$rules = Get-AzureRmAlertRule -ResourceGroup $resourceGroup +if ($rules -and $rules.count -ge 1) +{ + Write-Host -Foreground Red "Error updating alert rule" + Write-Host $rules[0].Id + Write-Host $rules[0].Properties.IsEnabled + Write-Host $rules[0].Properties.Condition +} + +# New +$rules = Get-AzureRmAlertRule -ResourceGroup $resourceGroup +if ($rules -and $rules.count -ge 1) +{ + Write-Host -Foreground red "Error updating alert rule" + Write-Host $rules[0].Id + + # Properties will remain for a while + Write-Host $rules[0].Properties.IsEnabled + + # But the properties will be at the top level too. Later Properties will be removed + Write-Host $rules[0].IsEnabled + Write-Host $rules[0].Condition +} +``` + +### **Get-AzureRmAutoscaleSetting** +- Output change: The AutoscaleSettingResourceName field will be deprecated since it always equals the Name field. + +```powershell +# Old +$s1 = Get-AzureRmAutoscaleSetting -ResourceGroup $resourceGroup -Name MySetting +if ($s1.AutoscaleSettingResourceName -ne $s1.Name) +{ + Write-Host "There is something wrong with the name" +} + +# New +$s1 = Get-AzureRmAutoscaleSetting -ResourceGroup $resourceGroup -Name MySetting + +# there won't be a AutoscaleSettingResourceName +Write-Host $s1.Name +``` + +### **Remove-AzureRmAlertRule** / **Remove-AzureRmLogProfile** +- Output change: The type of the output will change to return a single object containing the request Id and the status code. + +```powershell +# Old +$s1 = Remove-AzureRmAlertRule -ResourceGroup $resourceGroup -name $ruleName +if ($s1 -ne $null) +{ + $r = $s1[0].RequestId + $s = $s1[0].StatusCode +} + +# New +$s1 = Remove-AzureRmAlertRule -ResourceGroup $resourceGroup -name $ruleName +$r = $s1.RequestId +$s = $s1.StatusCode +``` + +## Breaking changes to Network cmdlets + +### **Add-AzureRmApplicationGatewaySslCertificate** +- Parameter "Password" being replaced in favor of a SecureString + +```powershell +# Old +Add-AzureRmApplicationGatewaySslCertificate [other required parameters] -Password "plain-text string" + +# New +Add-AzureRmApplicationGatewaySslCertificate [other required parameters] -Password $SecureStringVariable +``` + +### **New-AzureRmApplicationGatewaySslCertificate** +- Parameter "Password" being replaced in favor of a SecureString + +```powershell +# Old +New-AzureRmApplicationGatewaySslCertificate [other required parameters] -Password "plain-text string" + +# New +New-AzureRmApplicationGatewaySslCertificate [other required parameters] -Password $SecureStringVariable +``` + +### **Set-AzureRmApplicationGatewaySslCertificate** +- Parameter "Password" being replaced in favor of a SecureString + +```powershell +# Old +Set-AzureRmApplicationGatewaySslCertificate [other required parameters] -Password "plain-text string" + +# New +Set-AzureRmApplicationGatewaySslCertificate [other required parameters] -Password $SecureStringVariable +``` + +## Breaking changes to Resources cmdlets + +### **New-AzureRmADAppCredential** +- Parameter "Password" being replaced in favor of a SecureString + +```powershell +# Old +New-AzureRmADAppCredential [other required parameters] -Password "plain-text string" + +# New +New-AzureRmADAppCredential [other required parameters] -Password $SecureStringVariable +``` + +### **New-AzureRmADApplication** +- Parameter "Password" being replaced in favor of a SecureString + +```powershell +# Old +New-AzureRmADApplication [other required parameters] -Password "plain-text string" + +# New +New-AzureRmADApplication [other required parameters] -Password $SecureStringVariable +``` + +### **New-AzureRmADServicePrincipal** +- Parameter "Password" being replaced in favor of a SecureString + +```powershell +# Old +New-AzureRmADServicePrincipal [other required parameters] -Password "plain-text string" + +# New +New-AzureRmADServicePrincipal [other required parameters] -Password $SecureStringVariable +``` + +### **New-AzureRmADSpCredential** +- Parameter "Password" being replaced in favor of a SecureString + +```powershell +# Old +New-AzureRmADSpCredential [other required parameters] -Password "plain-text string" + +# New +New-AzureRmADSpCredential [other required parameters] -Password $SecureStringVariable +``` + +### **New-AzureRmADUser** +- Parameter "Password" being replaced in favor of a SecureString + +```powershell +# Old +New-AzureRmADUser [other required parameters] -Password "plain-text string" + +# New +New-AzureRmADUser [other required parameters] -Password $SecureStringVariable +``` + +### **Set-AzureRmADUser** +- Parameter "Password" being replaced in favor of a SecureString + +```powershell +# Old +Set-AzureRmADUser [other required parameters] -Password "plain-text string" + +# New +Set-AzureRmADUser [other required parameters] -Password $SecureStringVariable +``` + +## Breaking changes to ServiceBus cmdlets + +### **Get-AzureRmServiceBusTopicAuthorizationRule** +- The 'Get-AzureRmServiceBusTopicAuthorizationRule' cmdlet has been removed. Please use the 'Get-AzureRmServiceBusAuthorizationRule' cmdlet. + +### **Get-AzureRmServiceBusTopicKey** +- The 'Get-AzureRmServiceBusTopicKey' cmdlet has been removed. Please use the 'Get-AzureRmServiceBusKey' cmdlet. + +### **New-AzureRmServiceBusTopicAuthorizationRule** +- The 'New-AzureRmServiceBusTopicAuthorizationRule' cmdlet has been removed. Please use the 'New-AzureRmServiceBusAuthorizationRule' cmdlet. + +### **New-AzureRmServiceBusTopicKey** +- The 'New-AzureRmServiceBusTopicKey' cmdlet has been removed. Please use the 'New-AzureRmServiceBusKey' cmdlet. + +### **Remove-AzureRmServiceBusTopicAuthorizationRule** +- The 'Remove-AzureRmServiceBusTopicAuthorizationRule' cmdlet has been removed. Please use the 'Remove-AzureRmServiceBusAuthorizationRule' cmdlet. + +### **Set-AzureRmServiceBusTopicAuthorizationRule** +- The 'Set-AzureRmServiceBusTopicAuthorizationRule' cmdlet has been removed. Please use the 'Set-AzureRmServiceBusAuthorizationRule'cmdlet. + +### **New-AzureRmServiceBusNamespaceKey** +- The 'New-AzureRmServiceBusNamespaceKey' cmdlet has been removed. Please use the 'New-AzureRmServiceBusKey' cmdlet. + +### **Get-AzureRmServiceBusQueueAuthorizationRule** +- The 'Get-AzureRmServiceBusQueueAuthorizationRule' cmdlet has been removed. Please use the 'Get-AzureRmServiceBusAuthorizationRule' cmdlet. + +### **Get-AzureRmServiceBusQueueKey** +- The 'Get-AzureRmServiceBusQueueKey' cmdlet has been removed. Please use the 'Get-AzureRmServiceBusKey' cmdlet. + +### **New-AzureRmServiceBusQueueAuthorizationRule** +- The 'New-AzureRmServiceBusQueueAuthorizationRule' cmdlet has been removed. Please use the 'New-AzureRmServiceBusAuthorizationRule' cmdlet. + +### **New-AzureRmServiceBusQueueKey** +- The 'New-AzureRmServiceBusQueueKey' cmdlet has been removed. Please use the 'New-AzureRmServiceBusKey' cmdlet. + +### **Remove-AzureRmServiceBusQueueAuthorizationRule** +- The 'Remove-AzureRmServiceBusQueueAuthorizationRule' cmdlet has been removed. Please use the 'GRemove-AzureRmServiceBusAuthorizationRule' cmdlet. + +### **Set-AzureRmServiceBusQueueAuthorizationRule** +- The 'Set-AzureRmServiceBusQueueAuthorizationRule' cmdlet has been removed. Please use the 'Set-AzureRmServiceBusAuthorizationRule' cmdlet. + +### **Get-AzureRmServiceBusNamespaceAuthorizationRule** +- The 'Get-AzureRmServiceBusNamespaceAuthorizationRule' cmdlet has been removed. Please use the 'Get-AzureRmServiceBusAuthorizationRule' cmdlet. + +### **Get-AzureRmServiceBusNamespaceKey** +- The 'Get-AzureRmServiceBusNamespaceKey' cmdlet has been removed. Please use the 'Get-AzureRmServiceBusKey' cmdlet. + +### **New-AzureRmServiceBusNamespaceAuthorizationRule** +- The 'New-AzureRmServiceBusNamespaceAuthorizationRule' cmdlet has been removed. Please use the 'New-AzureRmServiceBusAuthorizationRule' cmdlet. + +### **Remove-AzureRmServiceBusNamespaceAuthorizationRule** +- The 'Remove-AzureRmServiceBusNamespaceAuthorizationRule' cmdlet has been removed. Please use the 'Remove-AzureRmServiceBusAuthorizationRule' cmdlet. + +### **Set-AzureRmServiceBusNamespaceAuthorizationRule** +- The 'Set-AzureRmServiceBusNamespaceAuthorizationRule' cmdlet has been removed. Please use the 'Set-AzureRmServiceBusAuthorizationRule' cmdlet. + +### **Type NamespaceAttributes** +- The following properties have been removed + - Enabled + - Status + +```powershell +# Old +# The $namespace has Status and Enabled property +$namespace = Get-AzureRmServiceBusNamespace +$namespace.Status +$namespace.Enabled + +# New +# The call remains the same, but the returned values NameSpace object will not have the Enabled and Status properties +$namespace = Get-AzureRmServiceBusNamespace +``` + +### **Type QueueAttribute** +- The following properties are marked as obsolete: + - EnableBatchedOperations + - EntityAvailabilityStatus + - IsAnonymousAccessible + - SupportOrdering + +```powershell +# Old +# The $queue has EntityAvailabilityStatus, EnableBatchedOperations, IsAnonymousAccessible and SupportOrdering properties +$queue = Get-AzureRmServiceBusQueue +$queue.EntityAvailabilityStatus +$queue.EnableBatchedOperations +$queue.IsAnonymousAccessible +$queue.SupportOrdering + +# New +# The call remains the same, but the returned values Queue object will not have the EntityAvailabilityStatus, EnableBatchedOperations, IsAnonymousAccessible and SupportOrdering properties +$queue = Get-AzureRmServiceBusQueue +``` + +### **Type TopicAttribute** +- The following properties are marked as obsolete: + - Location + - IsExpress + - IsAnonymousAccessible + - FilteringMessagesBeforePublishing + - EnableSubscriptionPartitioning + - EntityAvailabilityStatus + +```powershell +# Old +# The $topic has EntityAvailabilityStatus, EnableSubscriptionPartitioning, IsAnonymousAccessible, IsExpress, Location and FilteringMessagesBeforePublishing properties +$topic = Get-AzureRmServiceBusTopic +$topic.EntityAvailabilityStatus +$topic.EnableSubscriptionPartitioning +$topic.IsAnonymousAccessible +$topic.IsExpress +$topic.FilteringMessagesBeforePublishing +$topic.Location + +# New +# The call remains the same, but the returned values Topic object will not have the EntityAvailabilityStatus, EnableBatchedOperations, IsAnonymousAccessible and SupportOrdering properties +$topic = Get-AzureRmServiceBusTopic +``` + +### **Type SubscriptionAttribute** +- The following properties are marked as obsolete + - DeadLetteringOnFilterEvaluationExceptions + - EntityAvailabilityStatus + - IsReadOnly + - Location + +```powershell +# Old +# The $subscription has EntityAvailabilityStatus, EnableSubscriptionPartitioning, IsAnonymousAccessible, IsExpress, Location and FilteringMessagesBeforePublishing properties +$subscription = Get-AzureRmServiceBussubscription +$subscription.EntityAvailabilityStatus +$subscription.EnableSubscriptionPartitioning +$subscription.IsAnonymousAccessible +$subscription.IsExpress +$subscription.FilteringMessagesBeforePublishing +$subscription.Location + +# New +# The call remains the same, but the returned values Topic object will not have the EntityAvailabilityStatus, EnableBatchedOperations, IsAnonymousAccessible and SupportOrdering properties +$subscription = Get-AzureRmServiceBussubscription +``` \ No newline at end of file diff --git a/src/ResourceManager/ApiManagement/documentation/current-breaking-changes.md b/src/ResourceManager/ApiManagement/documentation/current-breaking-changes.md index 0f0cb267c941..c53cda5b5c43 100644 --- a/src/ResourceManager/ApiManagement/documentation/current-breaking-changes.md +++ b/src/ResourceManager/ApiManagement/documentation/current-breaking-changes.md @@ -38,4 +38,41 @@ https://github.com/Azure/azure-powershell/blob/dev/documentation/breaking-changes/breaking-change-template.md --> -## Current Breaking Changes \ No newline at end of file +## Current Breaking Changes + +### Release 5.0.0 - November 2017 + +The following cmdlets were affected this release: + +**New-AzureRmApiManagementBackendProxy** +- Parameters "UserName" and "Password" are being replaced in favor of a PSCredential + +```powershell +# Old +New-AzureRmApiManagementBackendProxy [other required parameters] -UserName "plain-text string" -Password "plain-text string" + +# New +New-AzureRmApiManagementBackendProxy [other required parameters] -Credential $PSCredentialVariable +``` + +**New-AzureRmApiManagementUser** +- Parameter "Password" being replaced in favor of a SecureString + +```powershell +# Old +New-AzureRmApiManagementUser [other required parameters] -Password "plain-text string" + +# New +New-AzureRmApiManagementUser [other required parameters] -Password $SecureStringVariable +``` + +**Set-AzureRmApiManagementUser** +- Parameter "Password" being replaced in favor of a SecureString + +```powershell +# Old +Set-AzureRmApiManagementUser [other required parameters] -Password "plain-text string" + +# New +Set-AzureRmApiManagementUser [other required parameters] -Password $SecureStringVariable +``` \ No newline at end of file diff --git a/src/ResourceManager/ApiManagement/documentation/upcoming-breaking-changes.md b/src/ResourceManager/ApiManagement/documentation/upcoming-breaking-changes.md index f819b9d0f9b5..e01c405de7a3 100644 --- a/src/ResourceManager/ApiManagement/documentation/upcoming-breaking-changes.md +++ b/src/ResourceManager/ApiManagement/documentation/upcoming-breaking-changes.md @@ -25,42 +25,4 @@ https://github.com/Azure/azure-powershell/blob/dev/documentation/breaking-changes/breaking-change-template.md --> -# Upcoming Breaking Changes - -The following cmdlets were affected this release: - -**New-AzureRmApiManagementBackendProxy** -- Parameters "UserName" and "Password" are being replaced in favor of a PSCredential - -```powershell - -# Old -# New-AzureRmApiManagementBackendProxy [other required parameters] -UserName "plain-text string" -Password "plain-text string" - -# New -# New-AzureRmApiManagementBackendProxy [other required parameters] -Credential $PSCredentialVariable -``` - -**New-AzureRmApiManagementUser** -- Parameter "Password" being replaced in favor of a SecureString - -```powershell - -# Old -# New-AzureRmApiManagementUser [other required parameters] -Password "plain-text string" - -# New -# New-AzureRmApiManagementUser [other required parameters] -Password $SecureStringVariable -``` - -**Set-AzureRmApiManagementUser** -- Parameter "Password" being replaced in favor of a SecureString - -```powershell - -# Old -# Set-AzureRmApiManagementUser [other required parameters] -Password "plain-text string" - -# New -# Set-AzureRmApiManagementUser [other required parameters] -Password $SecureStringVariable -``` \ No newline at end of file +# Upcoming Breaking Changes \ No newline at end of file diff --git a/src/ResourceManager/AzureBatch/documentation/current-breaking-changes.md b/src/ResourceManager/AzureBatch/documentation/current-breaking-changes.md index 296d9c35a10a..7b92aef820c5 100644 --- a/src/ResourceManager/AzureBatch/documentation/current-breaking-changes.md +++ b/src/ResourceManager/AzureBatch/documentation/current-breaking-changes.md @@ -39,3 +39,211 @@ --> ## Current Breaking Changes + +### Release 4.0.0 - November 2017 + +The following cmdlets were affected this release: + +**New-AzureBatchCertificate** +- Parameter `Password` being replaced in favor of a Secure string + +```powershell +# Old +New-AzureBatchCertificate [other required parameters] -Password "plain-text string" + +# New +New-AzureBatchCertificate [other required parameters] -Password $SecureStringVariable +``` + +**New-AzureBatchComputeNodeUser** +- Parameter `Password` being replaced in favor of a Secure string + +```powershell +# Old +New-AzureBatchComputeNodeUser [other required parameters] -Password "plain-text string" + +# New +New-AzureBatchComputeNodeUser [other required parameters] -Password $SecureStringVariable +``` + +**Set-AzureRmBatchComputeNodeUser** +- Parameter `Password` being replaced in favor of a Secure string + +```powershell +# Old +Set-AzureRmBatchComputeNodeUser [other required parameters] -Password "plain-text string" + +# New +Set-AzureRmBatchComputeNodeUser [other required parameters] -Password $SecureStringVariable +``` + +**New-AzureBatchTask** + - Removed the `RunElevated` switch and replaced it with `UserIdentity`. + +```powershell +# Old +New-AzureBatchTask -Id $taskId1 -JobId $jobId -CommandLine "cmd /c echo hello" -RunElevated $TRUE + +# New +$autoUser = New-Object Microsoft.Azure.Commands.Batch.Models.PSAutoUserSpecification -ArgumentList @("Task", "Admin") +$userIdentity = New-Object Microsoft.Azure.Commands.Batch.Models.PSUserIdentity $autoUser +New-AzureBatchTask -Id $taskId1 -JobId $jobId -CommandLine "cmd /c echo hello" -UserIdentity $userIdentity +``` + +This additionally impacts the `RunElevated` property on `PSCloudTask`, `PSStartTask`, `PSJobManagerTask`, `PSJobPreparationTask`, and `PSJobReleaseTask`. + +- `PSMultiInstanceSettings` constructor no longer takes a required `numberOfInstances` parameter, instead it takes a required `coordinationCommandLine` parameter. + +```powershell +# Old +$settings = New-Object Microsoft.Azure.Commands.Batch.Models.PSMultiInstanceSettings -ArgumentList @(2) +$settings.CoordinationCommandLine = "cmd /c echo hello" +New-AzureBatchTask [other parameters] -MultiInstanceSettings $settings + +# New +$settings = New-Object Microsoft.Azure.Commands.Batch.Models.PSMultiInstanceSettings -ArgumentList @("cmd /c echo hello", 2) +New-AzureBatchTask [other parameters] -MultiInstanceSettings $settings +``` + +**Get-AzureBatchTask** + - Removed the `RunElevated` property on `PSCloudTask`. The `UserIdentity` property has been added to replace `RunElevated`. + +```powershell +# Old +$task = Get-AzureBatchTask [parameters] +$task.RunElevated + +# New +$task = Get-AzureBatchTask [parameters] +$task.UserIdentity.AutoUser.ElevationLevel +``` + +This additionally impacts the `RunElevated` property on `PSCloudTask`, `PSStartTask`, `PSJobManagerTask`, `PSJobPreparationTask`, and `PSJobReleaseTask`. + +- Renamed the `SchedulingError` property on `PSExitConditions` to `PreProcessingError`. + +```powershell +# Old +$task = Get-AzureBatchTask [parameters] +$task.ExitConditions.SchedulingError + +# New +$task = Get-AzureBatchTask [parameters] +$task.ExitConditions.PreProcessingError +``` + +- Renamed the `SchedulingError` property on `PSJobPreparationTaskExecutionInformation`, `PSJobReleaseTaskExecutionInformation`, `PSStartTaskInformation`, `PSSubtaskInformation`, and `PSTaskExecutionInformation` to `FailureInformation`. + - `FailureInformation` is returned any time there is a task failure. This includes all previous scheduling error cases, as well as nonzero task exit codes, and file upload failures from the new output files feature. + - This is structured the same as before, so no code change is needed when using this type. + +```powershell +# Old +$task = Get-AzureBatchTask [parameters] +$task.ExecutionInformation.SchedulingError + +# New +$task = Get-AzureBatchTask [parameters] +$task.ExecutionInformation.FailureInformation +``` + +This additionally impacts: Get-AzureBatchPool, Get-AzureBatchSubtask, and Get-AzureBatchJobPreparationAndReleaseTaskStatus + +**New-AzureBatchPool** + - Removed `TargetDedicated` and replaced it with `TargetDedicatedComputeNodes` and `TargetLowPriorityComputeNodes`. + - `TargetDedicatedComputeNodes` has an alias `TargetDedicated`. + +```powershell +# Old +New-AzureBatchPool [other parameters] [-TargetDedicated ] + +# New +New-AzureBatchPool [other parameters] [-TargetDedicatedComputeNodes ] [-TargetLowPriorityComputeNodes ] +``` + +This also impacts: Start-AzureBatchPoolResize + +**Get-AzureBatchPool** + - Renamed the `TargetDedicated` and `CurrentDedicated` properties on `PSCloudPool` to `TargetDedicatedComputeNodes` and `CurrentDedicatedComputeNodes`. + +```powershell +# Old +$pool = Get-AzureBatchPool [parameters] +$pool.TargetDedicated +$pool.CurrentDedicated + +# New +$pool = Get-AzureBatchPool [parameters] +$pool.TargetDedicatedComputeNodes +$pool.CurrentDedicatedComputeNodes +``` + +- Renamed `ResizeError` to `ResizeErrors` on `PSCloudPool`, and it is now a collection. + +```powershell +# Old +$pool = Get-AzureBatchPool [parameters] +$pool.ResizeError + +# New +$pool = Get-AzureBatchPool [parameters] +$pool.ResizeErrors[0] +``` + +**New-AzureBatchJob** +- Renamed the `TargetDedicated` property on `PSPoolSpecification` to `TargetDedicatedComputeNodes`. + +```powershell +# Old +$poolInfo = New-Object Microsoft.Azure.Commands.Batch.Models.PSPoolInformation +$poolInfo.AutoPoolSpecification = New-Object Microsoft.Azure.Commands.Batch.Models.PSAutoPoolSpecification +$poolInfo.AutoPoolSpecification.PoolSpecification = New-Object Microsoft.Azure.Commands.Batch.Models.PSPoolSpecification +$poolInfo.AutoPoolSpecification.PoolSpecification.TargetDedicated = 5 +New-AzureBatchJob [other parameters] -PoolInformation $poolInfo + +# New +$poolInfo = New-Object Microsoft.Azure.Commands.Batch.Models.PSPoolInformation +$poolInfo.AutoPoolSpecification = New-Object Microsoft.Azure.Commands.Batch.Models.PSAutoPoolSpecification +$poolInfo.AutoPoolSpecification.PoolSpecification = New-Object Microsoft.Azure.Commands.Batch.Models.PSPoolSpecification +$poolInfo.AutoPoolSpecification.PoolSpecification.TargetDedicatedComputeNodes = 5 +New-AzureBatchJob [other parameters] -PoolInformation $poolInfo +``` + +**Get-AzureBatchNodeFile** + - Removed `Name` and replaced it with `Path`. + - `Path` has an alias `Name`. + +```powershell +# Old +Get-AzureBatchNodeFile [other parameters] [[-Name] ] + +# New +Get-AzureBatchNodeFile [other parameters] [[-Path] ] +``` + +This also impacts: Get-AzureBatchNodeFileContent, Remove-AzureBatchNodeFile + + - Renamed the `Name` property on `PSNodeFile` to `Path`. + +```powershell +# Old +$file = Get-AzureBatchNodeFile [parameters] +$file.Name + +# New +$file = Get-AzureBatchNodeFile [parameters] +$file.Path +``` + +**Get-AzureBatchSubtask** +- The `PreviousState` and `State` properties of `PSSubtaskInformation` are no longer of type `TaskState`, instead they are of type `SubtaskState`. + - Unlike `TaskState`, `SubtaskState` has no `Active` value, since it is not possible for subtasks to be in an `Active` state. + +```powershell +# Old +$subtask = Get-AzureBatchSubtask [parameters] +if ($subtask.State -eq Microsoft.Azure.Batch.Common.TaskState.Running) { } + +# New +$subtask = Get-AzureBatchSubtask [parameters] +if ($subtask.State -eq Microsoft.Azure.Batch.Common.SubtaskState.Running) { } +``` \ No newline at end of file diff --git a/src/ResourceManager/AzureBatch/documentation/upcoming-breaking-changes.md b/src/ResourceManager/AzureBatch/documentation/upcoming-breaking-changes.md index c4cd5300b823..e01c405de7a3 100644 --- a/src/ResourceManager/AzureBatch/documentation/upcoming-breaking-changes.md +++ b/src/ResourceManager/AzureBatch/documentation/upcoming-breaking-changes.md @@ -25,213 +25,4 @@ https://github.com/Azure/azure-powershell/blob/dev/documentation/breaking-changes/breaking-change-template.md --> -# Upcoming Breaking Changes - -The following cmdlets were affected this release: - -**New-AzureBatchCertificate** -- Parameter `Password` being replaced in favor of a Secure string - -```powershell - -# Old -New-AzureBatchCertificate [other required parameters] -Password "plain-text string" - -# New -New-AzureBatchCertificate [other required parameters] -Password $SecureStringVariable -``` - -**New-AzureBatchComputeNodeUser** -- Parameter `Password` being replaced in favor of a Secure string - -```powershell - -# Old -New-AzureBatchComputeNodeUser [other required parameters] -Password "plain-text string" - -# New -New-AzureBatchComputeNodeUser [other required parameters] -Password $SecureStringVariable -``` - -**Set-AzureRmBatchComputeNodeUser** -- Parameter `Password` being replaced in favor of a Secure string - -```powershell - -# Old -Set-AzureRmBatchComputeNodeUser [other required parameters] -Password "plain-text string" - -# New -Set-AzureRmBatchComputeNodeUser [other required parameters] -Password $SecureStringVariable -``` - -**New-AzureBatchTask** - - Removed the `RunElevated` switch and replaced it with `UserIdentity`. - -```powershell -# Old -New-AzureBatchTask -Id $taskId1 -JobId $jobId -CommandLine "cmd /c echo hello" -RunElevated $TRUE - -# New -$autoUser = New-Object Microsoft.Azure.Commands.Batch.Models.PSAutoUserSpecification -ArgumentList @("Task", "Admin") -$userIdentity = New-Object Microsoft.Azure.Commands.Batch.Models.PSUserIdentity $autoUser -New-AzureBatchTask -Id $taskId1 -JobId $jobId -CommandLine "cmd /c echo hello" -UserIdentity $userIdentity -``` - -This additionally impacts the `RunElevated` property on `PSCloudTask`, `PSStartTask`, `PSJobManagerTask`, `PSJobPreparationTask`, and `PSJobReleaseTask`. - -- `PSMultiInstanceSettings` constructor no longer takes a required `numberOfInstances` parameter, instead it takes a required `coordinationCommandLine` parameter. - -```powershell -# Old -$settings = New-Object Microsoft.Azure.Commands.Batch.Models.PSMultiInstanceSettings -ArgumentList @(2) -$settings.CoordinationCommandLine = "cmd /c echo hello" -New-AzureBatchTask [other parameters] -MultiInstanceSettings $settings - -# New -$settings = New-Object Microsoft.Azure.Commands.Batch.Models.PSMultiInstanceSettings -ArgumentList @("cmd /c echo hello", 2) -New-AzureBatchTask [other parameters] -MultiInstanceSettings $settings -``` - -**Get-AzureBatchTask** - - Removed the `RunElevated` property on `PSCloudTask`. The `UserIdentity` property has been added to replace `RunElevated`. - -```powershell -# Old -$task = Get-AzureBatchTask [parameters] -$task.RunElevated - -# New -$task = Get-AzureBatchTask [parameters] -$task.UserIdentity.AutoUser.ElevationLevel -``` - -This additionally impacts the `RunElevated` property on `PSCloudTask`, `PSStartTask`, `PSJobManagerTask`, `PSJobPreparationTask`, and `PSJobReleaseTask`. - -- Renamed the `SchedulingError` property on `PSExitConditions` to `PreProcessingError`. - -```powershell -# Old -$task = Get-AzureBatchTask [parameters] -$task.ExitConditions.SchedulingError - -# New -$task = Get-AzureBatchTask [parameters] -$task.ExitConditions.PreProcessingError -``` - -- Renamed the `SchedulingError` property on `PSJobPreparationTaskExecutionInformation`, `PSJobReleaseTaskExecutionInformation`, `PSStartTaskInformation`, `PSSubtaskInformation`, and `PSTaskExecutionInformation` to `FailureInformation`. - - `FailureInformation` is returned any time there is a task failure. This includes all previous scheduling error cases, as well as nonzero task exit codes, and file upload failures from the new output files feature. - - This is structured the same as before, so no code change is needed when using this type. - -```powershell -# Old -$task = Get-AzureBatchTask [parameters] -$task.ExecutionInformation.SchedulingError - -# New -$task = Get-AzureBatchTask [parameters] -$task.ExecutionInformation.FailureInformation -``` - -This additionally impacts: Get-AzureBatchPool, Get-AzureBatchSubtask, and Get-AzureBatchJobPreparationAndReleaseTaskStatus - -**New-AzureBatchPool** - - Removed `TargetDedicated` and replaced it with `TargetDedicatedComputeNodes` and `TargetLowPriorityComputeNodes`. - - `TargetDedicatedComputeNodes` has an alias `TargetDedicated`. - -```powershell -# Old -New-AzureBatchPool [other parameters] [-TargetDedicated ] - -# New -New-AzureBatchPool [other parameters] [-TargetDedicatedComputeNodes ] [-TargetLowPriorityComputeNodes ] -``` - -This also impacts: Start-AzureBatchPoolResize - -**Get-AzureBatchPool** - - Renamed the `TargetDedicated` and `CurrentDedicated` properties on `PSCloudPool` to `TargetDedicatedComputeNodes` and `CurrentDedicatedComputeNodes`. - -```powershell -# Old -$pool = Get-AzureBatchPool [parameters] -$pool.TargetDedicated -$pool.CurrentDedicated - -# New -$pool = Get-AzureBatchPool [parameters] -$pool.TargetDedicatedComputeNodes -$pool.CurrentDedicatedComputeNodes -``` - -- Renamed `ResizeError` to `ResizeErrors` on `PSCloudPool`, and it is now a collection. - -```powershell -# Old -$pool = Get-AzureBatchPool [parameters] -$pool.ResizeError - -# New -$pool = Get-AzureBatchPool [parameters] -$pool.ResizeErrors[0] -``` - -**New-AzureBatchJob** -- Renamed the `TargetDedicated` property on `PSPoolSpecification` to `TargetDedicatedComputeNodes`. - -```powershell -# Old -$poolInfo = New-Object Microsoft.Azure.Commands.Batch.Models.PSPoolInformation -$poolInfo.AutoPoolSpecification = New-Object Microsoft.Azure.Commands.Batch.Models.PSAutoPoolSpecification -$poolInfo.AutoPoolSpecification.PoolSpecification = New-Object Microsoft.Azure.Commands.Batch.Models.PSPoolSpecification -$poolInfo.AutoPoolSpecification.PoolSpecification.TargetDedicated = 5 -New-AzureBatchJob [other parameters] -PoolInformation $poolInfo - -# New -$poolInfo = New-Object Microsoft.Azure.Commands.Batch.Models.PSPoolInformation -$poolInfo.AutoPoolSpecification = New-Object Microsoft.Azure.Commands.Batch.Models.PSAutoPoolSpecification -$poolInfo.AutoPoolSpecification.PoolSpecification = New-Object Microsoft.Azure.Commands.Batch.Models.PSPoolSpecification -$poolInfo.AutoPoolSpecification.PoolSpecification.TargetDedicatedComputeNodes = 5 -New-AzureBatchJob [other parameters] -PoolInformation $poolInfo -``` - -**Get-AzureBatchNodeFile** - - Removed `Name` and replaced it with `Path`. - - `Path` has an alias `Name`. - -```powershell -# Old -Get-AzureBatchNodeFile [other parameters] [[-Name] ] - -# New -Get-AzureBatchNodeFile [other parameters] [[-Path] ] -``` - -This also impacts: Get-AzureBatchNodeFileContent, Remove-AzureBatchNodeFile - - - Renamed the `Name` property on `PSNodeFile` to `Path`. - -```powershell -# Old -$file = Get-AzureBatchNodeFile [parameters] -$file.Name - -# New -$file = Get-AzureBatchNodeFile [parameters] -$file.Path -``` - -**Get-AzureBatchSubtask** -- The `PreviousState` and `State` properties of `PSSubtaskInformation` are no longer of type `TaskState`, instead they are of type `SubtaskState`. - - Unlike `TaskState`, `SubtaskState` has no `Active` value, since it is not possible for subtasks to be in an `Active` state. - -```powershell -# Old -$subtask = Get-AzureBatchSubtask [parameters] -if ($subtask.State -eq Microsoft.Azure.Batch.Common.TaskState.Running) { } - -# New -$subtask = Get-AzureBatchSubtask [parameters] -if ($subtask.State -eq Microsoft.Azure.Batch.Common.SubtaskState.Running) { } -``` +# Upcoming Breaking Changes \ No newline at end of file diff --git a/src/ResourceManager/Compute/documentation/current-breaking-changes.md b/src/ResourceManager/Compute/documentation/current-breaking-changes.md index 0f0cb267c941..bab6cd8e671b 100644 --- a/src/ResourceManager/Compute/documentation/current-breaking-changes.md +++ b/src/ResourceManager/Compute/documentation/current-breaking-changes.md @@ -38,4 +38,19 @@ https://github.com/Azure/azure-powershell/blob/dev/documentation/breaking-changes/breaking-change-template.md --> -## Current Breaking Changes \ No newline at end of file +## Current Breaking Changes + +## Release 4.0.0 - November 2017 + +The following cmdlets were affected this release: + +**Set-AzureRmVMAccessExtension** +- Parameters "UserName" and "Password" are being replaced in favor of a PSCredential + +```powershell +# Old +Set-AzureRmVMAccessExtension [other required parameters] -UserName "plain-text string" -Password "plain-text string" + +# New +Set-AzureRmVMAccessExtension [other required parameters] -Credential $PSCredential +``` \ No newline at end of file diff --git a/src/ResourceManager/Compute/documentation/upcoming-breaking-changes.md b/src/ResourceManager/Compute/documentation/upcoming-breaking-changes.md index f33822af5fc2..e01c405de7a3 100644 --- a/src/ResourceManager/Compute/documentation/upcoming-breaking-changes.md +++ b/src/ResourceManager/Compute/documentation/upcoming-breaking-changes.md @@ -25,20 +25,4 @@ https://github.com/Azure/azure-powershell/blob/dev/documentation/breaking-changes/breaking-change-template.md --> -# Upcoming Breaking Changes - -## Release 5.0.0 - November 2017 - -The following cmdlets were affected this release: - -**Set-AzureRmVMAccessExtension** -- Parameters "UserName" and "Password" are being replaced in favor of a PSCredential - -```powershell - -# Old -# Set-AzureRmVMAccessExtension [other required parameters] -UserName "plain-text string" -Password "plain-text string" - -# New -# Set-AzureRmVMAccessExtension [other required parameters] -Credential $PSCredential -``` \ No newline at end of file +# Upcoming Breaking Changes \ No newline at end of file diff --git a/src/ResourceManager/EventHub/documentation/current-breaking-changes.md b/src/ResourceManager/EventHub/documentation/current-breaking-changes.md index 0f0cb267c941..08c81ecb4862 100644 --- a/src/ResourceManager/EventHub/documentation/current-breaking-changes.md +++ b/src/ResourceManager/EventHub/documentation/current-breaking-changes.md @@ -38,4 +38,113 @@ https://github.com/Azure/azure-powershell/blob/dev/documentation/breaking-changes/breaking-change-template.md --> -## Current Breaking Changes \ No newline at end of file +## Current Breaking Changes + +## Release 0.5.0 - November 2017 + +The following cmdlets were affected this release: + +**New-AzureRmEventHubNamespaceAuthorizationRule** +- The 'New-AzureRmEventHubNamespaceAuthorizationRule' cmdlet has been removed. Please use the 'New-AzureRmEventHubAuthorizationRule' cmdlet + +**Get-AzureRmEventHubNamespaceAuthorizationRule** +- The 'Get-AzureRmEventHubNamespaceAuthorizationRule' cmdlet has been removed. Please use the 'Get-AzureRmEventHubAuthorizationRule' cmdlet + +**Set-AzureRmEventHubNamespaceAuthorizationRule** +- The 'Set-AzureRmEventHubNamespaceAuthorizationRule' cmdlet has been removed. Please use the 'Set-AzureRmEventHubAuthorizationRule' cmdlet + +**Remove-AzureRmEventHubNamespaceAuthorizationRule** +- The 'Remove-AzureRmEventHubNamespaceAuthorizationRule' cmdlet has been removed. Please use the 'Remove-AzureRmEventHubAuthorizationRule' cmdlet + +**New-AzureRmEventHubNamespaceKey** +- The 'New-AzureRmEventHubNamespaceKey' cmdlet has been removed. Please use the 'New-AzureRmEventHubKey' cmdlet + +**Get-AzureRmEventHubNamespaceKey** +- The 'Get-AzureRmEventHubNamespaceKey' cmdlet has been removed. Please use the 'Get-AzureRmEventHubKey' cmdlet + +**New-AzureRmEventHubNamespace** +- The property 'Status' and 'Enabled' from the NamespceAttributes will be removed. + +```powershell +# Old +# The $namespace has Status and Enabled property +$namespace = New-AzureRmEventHubNamespace +$namespace.Status +$namespace.Enabled + +# New +# The call remains the same, but the returned values NameSpace object will not have the Status and Enabled property +$namespace = Get-AzureRmEventHubNamespace +``` + +**Get-AzureRmEventHubNamespace** +- The property 'Status' and 'Enabled' from the NamespceAttributes will be removed. + +```powershell +# Old +# The $namespace has Status and Enabled property +$namespace = Get-AzureRmEventHubNamespace +$namespace.Status +$namespace.Enabled + +# New +# The call remains the same, but the returned values NameSpace object will not have the Status and Enabled property +$namespace = Get-AzureRmEventHubNamespace +``` + +**Set-AzureRmEventHubNamespace** +- The property 'Status' and 'Enabled' from the NamespceAttributes will be removed. + +```powershell +# Old +# The $namespace has Status and Enabled property +$namespace = Set-AzureRmEventHubNamespace +$namespace.Status +$namespace.Enabled + +# New +# The call remains the same, but the returned values NameSpace object will not have the Status and Enabled property +$namespace = Set-AzureRmEventHubNamespace +``` + +**New-AzureRmEventHubConsumerGroup** +- The property 'EventHubPath' from the ConsumerGroupAttributes will be removed. + +```powershell +# Old +# The $consumergroup has EventHubPath property +$consumergroup = New-AzureRmEventHubConsumerGroup +$consumergroup.EventHubPath + +# New +# The call remains the same, but the returned values ConsumerGroup object will not have the EventHubPath property +$consumergroup = New-AzureRmEventHubConsumerGroup +``` + +**Set-AzureRmEventHubConsumerGroup** +- The property 'EventHubPath' from the ConsumerGroupAttributes will be removed. + +```powershell +# Old +# The $consumergroup has EventHubPath property +$consumergroup = Set-AzureRmEventHubConsumerGroup +$consumergroup.EventHubPath + +# New +# The call remains the same, but the returned values ConsumerGroup object will not have the EventHubPath property +$consumergroup = Set-AzureRmEventHubConsumerGroup +``` + +**Get-AzureRmEventHubConsumerGroup** +- The property 'EventHubPath' from the ConsumerGroupAttributes will be removed. + +```powershell +# Old +# The $consumergroup has EventHubPath property +$consumergroup = Get-AzureRmEventHubConsumerGroup +$consumergroup.EventHubPath + +# New +# The call remains the same, but the returned values ConsumerGroup object will not have the EventHubPath property +$consumergroup = Get-AzureRmEventHubConsumerGroup +``` \ No newline at end of file diff --git a/src/ResourceManager/EventHub/documentation/upcoming-breaking-changes.md b/src/ResourceManager/EventHub/documentation/upcoming-breaking-changes.md index 607bf43f402a..e01c405de7a3 100644 --- a/src/ResourceManager/EventHub/documentation/upcoming-breaking-changes.md +++ b/src/ResourceManager/EventHub/documentation/upcoming-breaking-changes.md @@ -25,127 +25,4 @@ https://github.com/Azure/azure-powershell/blob/dev/documentation/breaking-changes/breaking-change-template.md --> -# Upcoming Breaking Changes - -## Release 4.3.0 - - The following cmdlets were affected this release: - - **New-AzureRmEventHubNamespaceAuthorizationRule** - - 'New-AzureRmEventHubNamespaceAuthorizationRule' cmdlet is mark as obsolete and will be depricated in upcoming breaking changes build. Please use the New cmdlet 'New-AzureRmEventHubAuthorizationRule' - - **Get-AzureRmEventHubNamespaceAuthorizationRule** - - 'Get-AzureRmEventHubNamespaceAuthorizationRule' cmdlet is mark as obsolete and will be depricated in upcoming breaking changes build. Please use the New cmdlet 'Get-AzureRmEventHubAuthorizationRule' - - **Set-AzureRmEventHubNamespaceAuthorizationRule** - - 'Set-AzureRmEventHubNamespaceAuthorizationRule' cmdlet is mark as obsolete and will be depricated in upcoming breaking changes build. Please use the New cmdlet 'Set-AzureRmEventHubAuthorizationRule' - - **Remove-AzureRmEventHubNamespaceAuthorizationRule** - - 'Remove-AzureRmEventHubNamespaceAuthorizationRule' cmdlet is mark as obsolete and will be depricated in upcoming breaking changes build. Please use the New cmdlet 'Remove-AzureRmEventHubAuthorizationRule' - - **New-AzureRmEventHubNamespaceKey** - - 'New-AzureRmEventHubNamespaceKey' cmdlet is mark as obsolete and will be depricated in upcoming breaking changes build. Please use the New cmdlet 'New-AzureRmEventHubKey' - - **Get-AzureRmEventHubNamespaceKey** - - 'Get-AzureRmEventHubNamespaceKey' cmdlet is mark as obsolete and will be depricated in upcoming breaking changes build. Please use the New cmdlet 'Get-AzureRmEventHubKey' - - - **New-AzureRmEventHubNamespace** - - The property 'Status' and 'Enabled' from the NamespceAttributes will be removed. - - ```powershell - # Old - # The $namespace has Status and Enabled property - $namespace = New-AzureRmEventHubNamespace - $namespace.Status - $namespace.Enabled - - # New - - # The call remains the same, but the returned values NameSpace object will not have the Status and Enabled property - $namespace = Get-AzureRmEventHubNamespace - - ``` - - **Get-AzureRmEventHubNamespace** - - The property 'Status' and 'Enabled' from the NamespceAttributes will be removed. - - ```powershell - # Old - # The $namespace has Status and Enabled property - $namespace = Get-AzureRmEventHubNamespace - $namespace.Status - $namespace.Enabled - - # New - - # The call remains the same, but the returned values NameSpace object will not have the Status and Enabled property - $namespace = Get-AzureRmEventHubNamespace - - ``` - - **Set-AzureRmEventHubNamespace** - - The property 'Status' and 'Enabled' from the NamespceAttributes will be removed. - - ```powershell - # Old - # The $namespace has Status and Enabled property - $namespace = Set-AzureRmEventHubNamespace - $namespace.Status - $namespace.Enabled - - # New - - # The call remains the same, but the returned values NameSpace object will not have the Status and Enabled property - $namespace = Set-AzureRmEventHubNamespace - - ``` - - **New-AzureRmEventHubConsumerGroup** - - The property 'EventHubPath' from the ConsumerGroupAttributes will be removed. - - ```powershell - # Old - # The $consumergroup has EventHubPath property - $consumergroup = New-AzureRmEventHubConsumerGroup - $consumergroup.EventHubPath - - # New - - # The call remains the same, but the returned values ConsumerGroup object will not have the EventHubPath property - $consumergroup = New-AzureRmEventHubConsumerGroup - - ``` - - **Set-AzureRmEventHubConsumerGroup** - - The property 'EventHubPath' from the ConsumerGroupAttributes will be removed. - - ```powershell - # Old - # The $consumergroup has EventHubPath property - $consumergroup = Set-AzureRmEventHubConsumerGroup - $consumergroup.EventHubPath - - # New - - # The call remains the same, but the returned values ConsumerGroup object will not have the EventHubPath property - $consumergroup = Set-AzureRmEventHubConsumerGroup - - ``` - - **Get-AzureRmEventHubConsumerGroup** - - The property 'EventHubPath' from the ConsumerGroupAttributes will be removed. - - ```powershell - # Old - # The $consumergroup has EventHubPath property - $consumergroup = Get-AzureRmEventHubConsumerGroup - $consumergroup.EventHubPath - - # New - - # The call remains the same, but the returned values ConsumerGroup object will not have the EventHubPath property - $consumergroup = Get-AzureRmEventHubConsumerGroup - - ``` - \ No newline at end of file +# Upcoming Breaking Changes \ No newline at end of file diff --git a/src/ResourceManager/Insights/documentation/current-breaking-changes.md b/src/ResourceManager/Insights/documentation/current-breaking-changes.md index 287e16898ff3..fe07fa5449b3 100644 --- a/src/ResourceManager/Insights/documentation/current-breaking-changes.md +++ b/src/ResourceManager/Insights/documentation/current-breaking-changes.md @@ -27,28 +27,82 @@ ## Current Breaking Changes - ## Release 5.0.0 - November 2017 - - The following cmdlets were affected this release: - - **Add-AzureRMLogAlertRule** - - Deprecated as announced since April 2017 - - After October 1st using this cmdlet no longer had any effect as this functionality was transitioned to Activity Log Alerts. Please see https://aka.ms/migratemealerts for more information. - - **Get-AzureRMUsage** - - Deprecated as announced since April 2017 - - **Get-AzureRmAlertRule** - - Output changed as announced since April 2017. The output is now a list of PSAlertRule (descendant of AzureAlertRule) objects. The objects are flatten, i.e.: all attributes are in the root of the object, no Properties attribute in them. - - **Remove-AzureRmAlertRule** - **Remove-AzureRmLogProfile** - - Output changed as announced since April 2017. The output is now an AzureOperationResponse object including status code and request Id. - - **Get-AzureRmAutoscaleSetting** - - Output changed as announced since April 2017. The output is now a list of PSAutoscaleSetting (descendant of AutoscaleSettingResource.) The breaking change is the elimination of the AutoscaleSettingResourceName attribute from the output, since it is always the same as the Name property. - - **Get-AzureRmLog** - **Get-AzureRmAlertHistory** - **GetAzureRmAutoscaleHistory** - - Output changed as announced since April 2017. The output is now a list of PSEventData (a descendant of EventData) objects. The breaking change is the elimination of the EventChannels attribute from the PSEventData, in the previous version it was returning a fixed value. +### Release 4.0.0 - November 2017 + +The following cmdlets were affected this release: + +**Add-AzureRMLogAlertRule** +- The **Add-AzureRMLogAlertRule** cmdlet has been deprecated +- After October 1st using this cmdlet will no longer have any effect as this functionality is being transitioned to Activity Log Alerts. Please see https://aka.ms/migratemealerts for more information. + +**Get-AzureRMUsage** +- The **Get-AzureRMUsage** cmdlet has been deprecated + +**Get-AzureRmAlertHistory** / **Get-AzureRmAutoscaleHistory** / **Get-AzureRmLogs** +- Output change: The field EventChannels from the EventData object (returned by these cmdlets) is being deprecated since it now returns a constant value (Admin,Operation.) + +**Get-AzureRmAlertRule** +- Output change: The output of this cmdlet will be flattened, i.e. elimination of the properties field, to improve the user experience. + +```powershell +# Old +$rules = Get-AzureRmAlertRule -ResourceGroup $resourceGroup +if ($rules -and $rules.count -ge 1) +{ + Write-Host -Foreground Red "Error updating alert rule" + Write-Host $rules[0].Id + Write-Host $rules[0].Properties.IsEnabled + Write-Host $rules[0].Properties.Condition +} + +# New +$rules = Get-AzureRmAlertRule -ResourceGroup $resourceGroup +if ($rules -and $rules.count -ge 1) +{ + Write-Host -Foreground red "Error updating alert rule" + Write-Host $rules[0].Id + + # Properties will remain for a while + Write-Host $rules[0].Properties.IsEnabled + + # But the properties will be at the top level too. Later Properties will be removed + Write-Host $rules[0].IsEnabled + Write-Host $rules[0].Condition +} +``` + +**Get-AzureRmAutoscaleSetting** +- Output change: The AutoscaleSettingResourceName field will be deprecated since it always equals the Name field. + +```powershell +# Old +$s1 = Get-AzureRmAutoscaleSetting -ResourceGroup $resourceGroup -Name MySetting +if ($s1.AutoscaleSettingResourceName -ne $s1.Name) +{ + Write-Host "There is something wrong with the name" +} + +# New +$s1 = Get-AzureRmAutoscaleSetting -ResourceGroup $resourceGroup -Name MySetting + +# there won't be a AutoscaleSettingResourceName +Write-Host $s1.Name +``` + +**Remove-AzureRmAlertRule** / **Remove-AzureRmLogProfile** +- Output change: The type of the output will change to return a single object containing the request Id and the status code. + +```powershell +# Old +$s1 = Remove-AzureRmAlertRule -ResourceGroup $resourceGroup -name $ruleName +if ($s1 -ne $null) +{ + $r = $s1[0].RequestId + $s = $s1[0].StatusCode +} + +# New +$s1 = Remove-AzureRmAlertRule -ResourceGroup $resourceGroup -name $ruleName +$r = $s1.RequestId +$s = $s1.StatusCode +``` \ No newline at end of file diff --git a/src/ResourceManager/Insights/documentation/upcoming-breaking-changes.md b/src/ResourceManager/Insights/documentation/upcoming-breaking-changes.md index 254956304dde..e51cabbe0b0e 100644 --- a/src/ResourceManager/Insights/documentation/upcoming-breaking-changes.md +++ b/src/ResourceManager/Insights/documentation/upcoming-breaking-changes.md @@ -29,175 +29,11 @@ ## Release 0.0.0 - May 2018 - **Get-AzureRmAlertHistory** - **Get-AzureRmAlertRule** - **Get-AzureRmAutoscaleHistory** - **Get-AzureRmAutoscaleSetting** - **Get-AzureRmLog** - **Get-AzureRmMetric** - **Get-AzureRmMetricDefinition** - - Argument deprecation: The DetailedOutput argument will be deprecated. In the current version the cmdlet is already returning complete objects, but showing only some attributes for the "no details" option. - -## Release 5.0.0 - November 2017 - - The following cmdlets will be deprecated in this release - - **Add-AzureRMLogAlertRule** - - After October 1st using this cmdlet will no longer have any effect as this functionality is being transitioned to Activity Log Alerts. Please see https://aka.ms/migratemealerts for more information. - - **Get-AzureRMUsage** - - The following cmdlets will show some potentially breaking change, but will NOT be deprecated - - **Get-AzureRmAlertHistory** - **Get-AzureRmAutoscaleHistory** - **Get-AzureRmLogs** - - Output change: The field EventChannels from the EventData object (returned by these cmdlets) is being deprecated in the release 5.0.0 - November 2017 - since it now returns a constant value (Admin,Operation.) - - **Get-AzureRmAlertRule** - - Output change: The output of this cmdlet will be flattened, i.e. elimination of the properties field, to improve the user experience. - - **Get-AzureRmAutoscaleSetting** - - Output change: The AutoscaleSettingResourceName field will be deprecated since it always equals the Name field. - - **Remove-AzureRmAlertRule** - **Remove-AzureRmLogProfile** - - Output change: The type of the output will change to return a single object containing the request Id and the status code. - -## Release 3.0.0 - - The following cmdlets were affected this release: - - **Get-AzureRmLogs** - **Get-AzureRmAlertHistory** - **Get-AzureRmAutoscaleHistory** - - The field EventChannels from the EventData object is being deprecated since it is meaningless now. The value currently returned is constant. - - **Get-AzureRmUsage** - - This cmdlet will be deprecated. - - **Remove-AzureRmAlertRule** - - The output of these cmdlets will change from list with a single object to a single object, not a list, that includes the requestId, and status code. - - ```powershell - # Old - - $s1 = Remove-AzureRmAlertRule -res $resourceGroup -name chiricutin - if ($s1 -ne $null) - { - $r = $s1(0).RequestId - $s = $s1(0).StatusCode - } - - # New - $s1 = Remove-AzureRmAlertRule -res $resourceGroup -name chiricutin - $r = $s1.RequestId - $s = $s1.StatusCode - - ``` - - **Add-AzureRmLogAlertRule** - - This cmdlet will be deprecated. - - **Get-AzureRmAlertRule** - - Each element of the the output (a list of objects) of this cmdlet will be flattened, i.e. instead of returning objects with the following structure { Id, Location, Name, Tags, Properties } it will return objects with the structure { Id, Location, Name, Tags, Type, Description, IsEnabled, Condition, Actions, LastUpdatedTime, ...} so all the attributes of an Azure Resource plus all the attributes of an AlertRuleResource at the top level. - - ```powershell - # Old - - $rules = Get-AzureRmAlertRule -Res $resourceGroup - if ($rules -and $rules.count -ge 1) { - write-host -fore red "Error updating alert rule" - - Write-host $rules(0).Id - Write-host $rules(0).Properties.IsEnabled - Write-host $rules(0).Properties.Condition - } - - # New - $rules = Get-AzureRmAlertRule -Res $resourceGroup - if ($rules -and $rules.count -ge 1) { - write-host -fore red "Error updating alert rule" - - Write-host $rules(0).Id - - # Properties will remain for a while - Write-host $rules(0).Properties.IsEnabled - - # But the properties will be at the top level too. Later Properties will be removed - Write-host $rules(0).IsEnabled - Write-host $rules(0).Condition - } - - ``` - - **Get-AzureRMAutoscaleSetting** - - The AutoscaleSettingResourceName field will be deprecated in future versions since it always equals the Name field. In this version is optional. - - ```powershell - # Old - - $s1 = Get-AzureRmAutoscaleSetting -ResourceGroup $resourceGroup -Name MySetting - if ($s1.AutoscaleSettingResourceName -ne $s1.Name) - { - write-host "There is something wrong with the name" - } - - # New - $s1 = Get-AzureRmAutoscaleSetting -ResourceGroup $resourceGroup -Name MySetting - - # there won't be a AutoscaleSettingResourceName - write-host $s1.Name - - ``` - - **Remove-AzureRMLogProfile** - - The output of this cmdlet will change from Boolean to and object containing RequestId and StatusCode. - - ```powershell - # Old - - $s1 = Remove-AzureRMLogProfile --Name myLogProfile - if ($s1 eq $true) - { - write-host "Removed" - } - else - { - write-host "Failed" - } - - # New - $s1 = Remove-AzureRMLogProfile --Name myLogProfile - $r = $s1.RequestId - $s = $s1.StatusCode - - ``` - - **Add-LogProfile** - - The output of this cmdlet will change from an object that includes the requestId, status code, and the updated or newly created resource. - - ```powershell - # Old - - $s1 = Add-AzureRmLogProfile -Name default -StorageAccountId /subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/JohnKemTest/providers/Microsoft.Storage/storageAccounts/johnkemtest8162 -Locations Global -categ Delete, Write, Action -retention 3 - $r = $s1.ServiceBusRuleId - - # New - $s1 = Add-AzureRmLogProfile -Name default -StorageAccountId /subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/JohnKemTest/providers/Microsoft.Storage/storageAccounts/johnkemtest8162 -Locations Global -categ Delete, Write, Action -retention 3 - $r = $s1.RequestId - $s = $s1.StatusCode - $a = $s1.NewResource.ServiceBusRuleId - - ``` - - **Set-AzureRmDiagnosticSettings** - - The command is going to be renamed to Update-AzureRmDiagnsoticSettings - - ```powershell - # Old - # Set-AzureRmDiagnosticSettings - - # New - # Update-AzureRmDiagnosticSettings - ``` \ No newline at end of file +**Get-AzureRmAlertHistory** +**Get-AzureRmAlertRule** +**Get-AzureRmAutoscaleHistory** +**Get-AzureRmAutoscaleSetting** +**Get-AzureRmLog** +**Get-AzureRmMetric** +**Get-AzureRmMetricDefinition** +- Argument deprecation: The DetailedOutput argument will be deprecated. In the current version the cmdlet is already returning complete objects, but showing only some attributes for the "no details" option. \ No newline at end of file diff --git a/src/ResourceManager/Network/documentation/current-breaking-changes.md b/src/ResourceManager/Network/documentation/current-breaking-changes.md index 0f0cb267c941..81f7d5794ded 100644 --- a/src/ResourceManager/Network/documentation/current-breaking-changes.md +++ b/src/ResourceManager/Network/documentation/current-breaking-changes.md @@ -38,4 +38,41 @@ https://github.com/Azure/azure-powershell/blob/dev/documentation/breaking-changes/breaking-change-template.md --> -## Current Breaking Changes \ No newline at end of file +## Current Breaking Changes + +### Release 5.0.0 - November 2017 + +The following cmdlets were affected this release: + +**Add-AzureRmApplicationGatewaySslCertificate** +- Parameter "Password" being replaced in favor of a SecureString + +```powershell +# Old +Add-AzureRmApplicationGatewaySslCertificate [other required parameters] -Password "plain-text string" + +# New +Add-AzureRmApplicationGatewaySslCertificate [other required parameters] -Password $SecureStringVariable +``` + +**New-AzureRmApplicationGatewaySslCertificate** +- Parameter "Password" being replaced in favor of a SecureString + +```powershell +# Old +New-AzureRmApplicationGatewaySslCertificate [other required parameters] -Password "plain-text string" + +# New +New-AzureRmApplicationGatewaySslCertificate [other required parameters] -Password $SecureStringVariable +``` + +**Set-AzureRmApplicationGatewaySslCertificate** +- Parameter "Password" being replaced in favor of a SecureString + +```powershell +# Old +Set-AzureRmApplicationGatewaySslCertificate [other required parameters] -Password "plain-text string" + +# New +Set-AzureRmApplicationGatewaySslCertificate [other required parameters] -Password $SecureStringVariable +``` \ No newline at end of file diff --git a/src/ResourceManager/Network/documentation/upcoming-breaking-changes.md b/src/ResourceManager/Network/documentation/upcoming-breaking-changes.md index efd7a42c8c2f..e01c405de7a3 100644 --- a/src/ResourceManager/Network/documentation/upcoming-breaking-changes.md +++ b/src/ResourceManager/Network/documentation/upcoming-breaking-changes.md @@ -25,18 +25,4 @@ https://github.com/Azure/azure-powershell/blob/dev/documentation/breaking-changes/breaking-change-template.md --> -# Upcoming Breaking Changes - -The following cmdlets were affected this release: - -**(Get/Set/New)-AzureRmApplicationGatewaySslCertificate** -- Parameter "Password" being replaced in favor of a SecureString - -```powershell - -# Old -# (Get/Set/New)-AzureRmApplicationGatewaySslCertificate [other required parameters] -Password "plain-text string" - -# New -# (Get/Set/New)-AzureRmApplicationGatewaySslCertificate [other required parameters] -Password $SecureStringVariable -``` \ No newline at end of file +# Upcoming Breaking Changes \ No newline at end of file diff --git a/src/ResourceManager/Resources/documentation/current-breaking-changes.md b/src/ResourceManager/Resources/documentation/current-breaking-changes.md index 0f0cb267c941..41485101a717 100644 --- a/src/ResourceManager/Resources/documentation/current-breaking-changes.md +++ b/src/ResourceManager/Resources/documentation/current-breaking-changes.md @@ -38,4 +38,74 @@ https://github.com/Azure/azure-powershell/blob/dev/documentation/breaking-changes/breaking-change-template.md --> -## Current Breaking Changes \ No newline at end of file +## Current Breaking Changes + +### Release 5.0.0 - November 2017 + +The following cmdlets were affected this release: + +**New-AzureRmADAppCredential** +- Parameter "Password" being replaced in favor of a SecureString + +```powershell +# Old +New-AzureRmADAppCredential [other required parameters] -Password "plain-text string" + +# New +New-AzureRmADAppCredential [other required parameters] -Password $SecureStringVariable +``` + +**New-AzureRmADApplication** +- Parameter "Password" being replaced in favor of a SecureString + +```powershell +# Old +New-AzureRmADApplication [other required parameters] -Password "plain-text string" + +# New +New-AzureRmADApplication [other required parameters] -Password $SecureStringVariable +``` + +**New-AzureRmADServicePrincipal** +- Parameter "Password" being replaced in favor of a SecureString + +```powershell +# Old +New-AzureRmADServicePrincipal [other required parameters] -Password "plain-text string" + +# New +New-AzureRmADServicePrincipal [other required parameters] -Password $SecureStringVariable +``` + +**New-AzureRmADSpCredential** +- Parameter "Password" being replaced in favor of a SecureString + +```powershell +# Old +New-AzureRmADSpCredential [other required parameters] -Password "plain-text string" + +# New +New-AzureRmADSpCredential [other required parameters] -Password $SecureStringVariable +``` + +**New-AzureRmADUser** +- Parameter "Password" being replaced in favor of a SecureString + +```powershell +# Old +New-AzureRmADUser [other required parameters] -Password "plain-text string" + +# New +New-AzureRmADUser [other required parameters] -Password $SecureStringVariable +``` + +**Set-AzureRmADUser** +- Parameter "Password" being replaced in favor of a SecureString + +```powershell +# Old +Set-AzureRmADUser [other required parameters] -Password "plain-text string" + +# New +Set-AzureRmADUser [other required parameters] -Password $SecureStringVariable +``` \ No newline at end of file diff --git a/src/ResourceManager/Resources/documentation/upcoming-breaking-changes.md b/src/ResourceManager/Resources/documentation/upcoming-breaking-changes.md index ed20f0891dc2..e01c405de7a3 100644 --- a/src/ResourceManager/Resources/documentation/upcoming-breaking-changes.md +++ b/src/ResourceManager/Resources/documentation/upcoming-breaking-changes.md @@ -25,78 +25,4 @@ https://github.com/Azure/azure-powershell/blob/dev/documentation/breaking-changes/breaking-change-template.md --> -# Upcoming Breaking Changes - -The following cmdlets were affected this release: - -**New-AzureRmADAppCredential** -- Parameter "Password" being replaced in favor of a SecureString - -```powershell - -# Old -# New-AzureRmADAppCredential [other required parameters] -Password "plain-text string" - -# New -# New-AzureRmADAppCredential [other required parameters] -Password $SecureStringVariable -``` - -**New-AzureRmADApplication** -- Parameter "Password" being replaced in favor of a SecureString - -```powershell - -# Old -# New-AzureRmADApplication [other required parameters] -Password "plain-text string" - -# New -# New-AzureRmADApplication [other required parameters] -Password $SecureStringVariable -``` - -**New-AzureRmADServicePrincipal** -- Parameter "Password" being replaced in favor of a SecureString - -```powershell - -# Old -# New-AzureRmADServicePrincipal [other required parameters] -Password "plain-text string" - -# New -# New-AzureRmADServicePrincipal [other required parameters] -Password $SecureStringVariable -``` - -**New-AzureRmADSpCredential** -- Parameter "Password" being replaced in favor of a SecureString - -```powershell - -# Old -# New-AzureRmADSpCredential [other required parameters] -Password "plain-text string" - -# New -# New-AzureRmADSpCredential [other required parameters] -Password $SecureStringVariable -``` - -**New-AzureRmADUser** -- Parameter "Password" being replaced in favor of a SecureString - -```powershell - -# Old -# New-AzureRmADUser [other required parameters] -Password "plain-text string" - -# New -# New-AzureRmADUser [other required parameters] -Password $SecureStringVariable -``` - -**Set-AzureRmADUser** -- Parameter "Password" being replaced in favor of a SecureString - -```powershell - -# Old -# Set-AzureRmADUser [other required parameters] -Password "plain-text string" - -# New -# Set-AzureRmADUser [other required parameters] -Password $SecureStringVariable -``` \ No newline at end of file +# Upcoming Breaking Changes \ No newline at end of file diff --git a/src/ResourceManager/ServiceBus/documentation/current-breaking-changes.md b/src/ResourceManager/ServiceBus/documentation/current-breaking-changes.md index 0f0cb267c941..8459b40bba97 100644 --- a/src/ResourceManager/ServiceBus/documentation/current-breaking-changes.md +++ b/src/ResourceManager/ServiceBus/documentation/current-breaking-changes.md @@ -38,4 +38,148 @@ https://github.com/Azure/azure-powershell/blob/dev/documentation/breaking-changes/breaking-change-template.md --> -## Current Breaking Changes \ No newline at end of file +## Current Breaking Changes + +### Release 0.5.0 - November 2017 + +The following cmdlets were affected this release: + +**Get-AzureRmServiceBusTopicAuthorizationRule** +- The 'Get-AzureRmServiceBusTopicAuthorizationRule' cmdlet has been removed. Please use the 'Get-AzureRmServiceBusAuthorizationRule' cmdlet. + +**Get-AzureRmServiceBusTopicKey** +- The 'Get-AzureRmServiceBusTopicKey' cmdlet has been removed. Please use the 'Get-AzureRmServiceBusKey' cmdlet. + +**New-AzureRmServiceBusTopicAuthorizationRule** +- The 'New-AzureRmServiceBusTopicAuthorizationRule' cmdlet has been removed. Please use the 'New-AzureRmServiceBusAuthorizationRule' cmdlet. + +**New-AzureRmServiceBusTopicKey** +- The 'New-AzureRmServiceBusTopicKey' cmdlet has been removed. Please use the 'New-AzureRmServiceBusKey' cmdlet. + +**Remove-AzureRmServiceBusTopicAuthorizationRule** +- The 'Remove-AzureRmServiceBusTopicAuthorizationRule' cmdlet has been removed. Please use the 'Remove-AzureRmServiceBusAuthorizationRule' cmdlet. + +**Set-AzureRmServiceBusTopicAuthorizationRule** +- The 'Set-AzureRmServiceBusTopicAuthorizationRule' cmdlet has been removed. Please use the 'Set-AzureRmServiceBusAuthorizationRule'cmdlet. + +**New-AzureRmServiceBusNamespaceKey** +- The 'New-AzureRmServiceBusNamespaceKey' cmdlet has been removed. Please use the 'New-AzureRmServiceBusKey' cmdlet. + +**Get-AzureRmServiceBusQueueAuthorizationRule** +- The 'Get-AzureRmServiceBusQueueAuthorizationRule' cmdlet has been removed. Please use the 'Get-AzureRmServiceBusAuthorizationRule' cmdlet. + +**Get-AzureRmServiceBusQueueKey** +- The 'Get-AzureRmServiceBusQueueKey' cmdlet has been removed. Please use the 'Get-AzureRmServiceBusKey' cmdlet. + +**New-AzureRmServiceBusQueueAuthorizationRule** +- The 'New-AzureRmServiceBusQueueAuthorizationRule' cmdlet has been removed. Please use the 'New-AzureRmServiceBusAuthorizationRule' cmdlet. + +**New-AzureRmServiceBusQueueKey** +- The 'New-AzureRmServiceBusQueueKey' cmdlet has been removed. Please use the 'New-AzureRmServiceBusKey' cmdlet. + +**Remove-AzureRmServiceBusQueueAuthorizationRule** +- The 'Remove-AzureRmServiceBusQueueAuthorizationRule' cmdlet has been removed. Please use the 'GRemove-AzureRmServiceBusAuthorizationRule' cmdlet. + +**Set-AzureRmServiceBusQueueAuthorizationRule** +- The 'Set-AzureRmServiceBusQueueAuthorizationRule' cmdlet has been removed. Please use the 'Set-AzureRmServiceBusAuthorizationRule' cmdlet. + +**Get-AzureRmServiceBusNamespaceAuthorizationRule** +- The 'Get-AzureRmServiceBusNamespaceAuthorizationRule' cmdlet has been removed. Please use the 'Get-AzureRmServiceBusAuthorizationRule' cmdlet. + +**Get-AzureRmServiceBusNamespaceKey** +- The 'Get-AzureRmServiceBusNamespaceKey' cmdlet has been removed. Please use the 'Get-AzureRmServiceBusKey' cmdlet. + +**New-AzureRmServiceBusNamespaceAuthorizationRule** +- The 'New-AzureRmServiceBusNamespaceAuthorizationRule' cmdlet has been removed. Please use the 'New-AzureRmServiceBusAuthorizationRule' cmdlet. + +**Remove-AzureRmServiceBusNamespaceAuthorizationRule** +- The 'Remove-AzureRmServiceBusNamespaceAuthorizationRule' cmdlet has been removed. Please use the 'Remove-AzureRmServiceBusAuthorizationRule' cmdlet. + +**Set-AzureRmServiceBusNamespaceAuthorizationRule** +- The 'Set-AzureRmServiceBusNamespaceAuthorizationRule' cmdlet has been removed. Please use the 'Set-AzureRmServiceBusAuthorizationRule' cmdlet. + +**Type NamespaceAttributes** +- The following properties have been removed + - Enabled + - Status + +```powershell +# Old +# The $namespace has Status and Enabled property +$namespace = Get-AzureRmServiceBusNamespace +$namespace.Status +$namespace.Enabled + +# New +# The call remains the same, but the returned values NameSpace object will not have the Enabled and Status properties +$namespace = Get-AzureRmServiceBusNamespace +``` + +**Type QueueAttribute** +- The following properties are marked as obsolete: + - EnableBatchedOperations + - EntityAvailabilityStatus + - IsAnonymousAccessible + - SupportOrdering + +```powershell +# Old +# The $queue has EntityAvailabilityStatus, EnableBatchedOperations, IsAnonymousAccessible and SupportOrdering properties +$queue = Get-AzureRmServiceBusQueue +$queue.EntityAvailabilityStatus +$queue.EnableBatchedOperations +$queue.IsAnonymousAccessible +$queue.SupportOrdering + +# New +# The call remains the same, but the returned values Queue object will not have the EntityAvailabilityStatus, EnableBatchedOperations, IsAnonymousAccessible and SupportOrdering properties +$queue = Get-AzureRmServiceBusQueue +``` + +**Type TopicAttribute** +- The following properties are marked as obsolete: + - Location + - IsExpress + - IsAnonymousAccessible + - FilteringMessagesBeforePublishing + - EnableSubscriptionPartitioning + - EntityAvailabilityStatus + +```powershell +# Old +# The $topic has EntityAvailabilityStatus, EnableSubscriptionPartitioning, IsAnonymousAccessible, IsExpress, Location and FilteringMessagesBeforePublishing properties +$topic = Get-AzureRmServiceBusTopic +$topic.EntityAvailabilityStatus +$topic.EnableSubscriptionPartitioning +$topic.IsAnonymousAccessible +$topic.IsExpress +$topic.FilteringMessagesBeforePublishing +$topic.Location + +# New +# The call remains the same, but the returned values Topic object will not have the EntityAvailabilityStatus, EnableBatchedOperations, IsAnonymousAccessible and SupportOrdering properties +$topic = Get-AzureRmServiceBusTopic +``` + +**Type SubscriptionAttribute** +- The following properties are marked as obsolete + - DeadLetteringOnFilterEvaluationExceptions + - EntityAvailabilityStatus + - IsReadOnly + - Location + +```powershell +# Old +# The $subscription has EntityAvailabilityStatus, EnableSubscriptionPartitioning, IsAnonymousAccessible, IsExpress, Location and FilteringMessagesBeforePublishing properties +$subscription = Get-AzureRmServiceBussubscription +$subscription.EntityAvailabilityStatus +$subscription.EnableSubscriptionPartitioning +$subscription.IsAnonymousAccessible +$subscription.IsExpress +$subscription.FilteringMessagesBeforePublishing +$subscription.Location + +# New +# The call remains the same, but the returned values Topic object will not have the EntityAvailabilityStatus, EnableBatchedOperations, IsAnonymousAccessible and SupportOrdering properties +$subscription = Get-AzureRmServiceBussubscription +``` \ No newline at end of file diff --git a/src/ResourceManager/ServiceBus/documentation/upcoming-breaking-changes.md b/src/ResourceManager/ServiceBus/documentation/upcoming-breaking-changes.md index 03fd2e28e7f4..e01c405de7a3 100644 --- a/src/ResourceManager/ServiceBus/documentation/upcoming-breaking-changes.md +++ b/src/ResourceManager/ServiceBus/documentation/upcoming-breaking-changes.md @@ -25,160 +25,4 @@ https://github.com/Azure/azure-powershell/blob/dev/documentation/breaking-changes/breaking-change-template.md --> -# Upcoming Breaking Changes - -## Release 3.0.0 - - The following cmdlets were affected this release: - - **Get-AzureRmServiceBusTopicAuthorizationRule** - - 'Get-AzureRmServiceBusTopicAuthorizationRule' cmdlet is mark as obsolete and will be depricated in upcoming breaking changes build. Please use the New cmdlet 'Get-AzureRmServiceBusAuthorizationRule' - - **Get-AzureRmServiceBusTopicKey** - - 'Get-AzureRmServiceBusTopicKey' cmdlet is mark as obsolete and will be depricated in upcoming breaking changes build. Please use the New cmdlet 'Get-AzureRmServiceBusKey' - - **New-AzureRmServiceBusTopicAuthorizationRule**, - - 'New-AzureRmServiceBusTopicAuthorizationRule' cmdlet is mark as obsolete and will be depricated in upcoming breaking changes build. Please use the New cmdlet 'New-AzureRmServiceBusAuthorizationRule' - - **New-AzureRmServiceBusTopicKey**, - - 'New-AzureRmServiceBusTopicKey' cmdlet is mark as obsolete and will be depricated in upcoming breaking changes build. Please use the New cmdlet 'New-AzureRmServiceBusKey' - - **Remove-AzureRmServiceBusTopicAuthorizationRule**, - - 'Remove-AzureRmServiceBusTopicAuthorizationRule' cmdlet is mark as obsolete and will be depricated in upcoming breaking changes build. Please use the New cmdlet 'Remove-AzureRmServiceBusAuthorizationRule' - - **Set-AzureRmServiceBusTopicAuthorizationRule**, - - 'Set-AzureRmServiceBusTopicAuthorizationRule' cmdlet is mark as obsolete and will be depricated in upcoming breaking changes build. Please use the New cmdlet 'Set-AzureRmServiceBusAuthorizationRule' - - **New-AzureRmServiceBusNamespaceKey**, - - 'New-AzureRmServiceBusNamespaceKey' cmdlet is mark as obsolete and will be depricated in upcoming breaking changes build. Please use the New cmdlet 'New-AzureRmServiceBusKey' - - **Get-AzureRmServiceBusQueueAuthorizationRule**, - - 'Get-AzureRmServiceBusQueueAuthorizationRule' cmdlet is mark as obsolete and will be depricated in upcoming breaking changes build. Please use the New cmdlet 'Get-AzureRmServiceBusAuthorizationRule' - - **Get-AzureRmServiceBusQueueKey**, - - 'Get-AzureRmServiceBusQueueKey' cmdlet is mark as obsolete and will be depricated in upcoming breaking changes build. Please use the New cmdlet 'Get-AzureRmServiceBusKey' - - **New-AzureRmServiceBusQueueAuthorizationRule**, - - 'New-AzureRmServiceBusQueueAuthorizationRule' cmdlet is mark as obsolete and will be depricated in upcoming breaking changes build. Please use the New cmdlet 'New-AzureRmServiceBusAuthorizationRule' - - **New-AzureRmServiceBusQueueKey**, - - 'New-AzureRmServiceBusQueueKey' cmdlet is mark as obsolete and will be depricated in upcoming breaking changes build. Please use the New cmdlet 'New-AzureRmServiceBusKey' - - **Remove-AzureRmServiceBusQueueAuthorizationRule**, - - 'Remove-AzureRmServiceBusQueueAuthorizationRule' cmdlet is mark as obsolete and will be depricated in upcoming breaking changes build. Please use the New cmdlet 'GRemove-AzureRmServiceBusAuthorizationRule' - - **Set-AzureRmServiceBusQueueAuthorizationRule**, - - 'Set-AzureRmServiceBusQueueAuthorizationRule' cmdlet is mark as obsolete and will be depricated in upcoming breaking changes build. Please use the New cmdlet 'Set-AzureRmServiceBusAuthorizationRule' - - **Get-AzureRmServiceBusNamespaceAuthorizationRule**, - - 'Get-AzureRmServiceBusNamespaceAuthorizationRule' cmdlet is mark as obsolete and will be depricated in upcoming breaking changes build. Please use the New cmdlet 'Get-AzureRmServiceBusAuthorizationRule' - - **Get-AzureRmServiceBusNamespaceKey**, - - 'Get-AzureRmServiceBusNamespaceKey' cmdlet is mark as obsolete and will be depricated in upcoming breaking changes build. Please use the New cmdlet 'Get-AzureRmServiceBusKey' - - **New-AzureRmServiceBusNamespaceAuthorizationRule**, - - 'New-AzureRmServiceBusNamespaceAuthorizationRule' cmdlet is mark as obsolete and will be depricated in upcoming breaking changes build. Please use the New cmdlet 'New-AzureRmServiceBusAuthorizationRule' - - **Remove-AzureRmServiceBusNamespaceAuthorizationRule**, - - 'Remove-AzureRmServiceBusNamespaceAuthorizationRule' cmdlet is mark as obsolete and will be depricated in upcoming breaking changes build. Please use the New cmdlet 'Remove-AzureRmServiceBusAuthorizationRule' - - **Set-AzureRmServiceBusNamespaceAuthorizationRule** - - 'Set-AzureRmServiceBusNamespaceAuthorizationRule' cmdlet is mark as obsolete and will be depricated in upcoming breaking changes build. Please use the New cmdlet 'Set-AzureRmServiceBusAuthorizationRule' - - - The following properties are marked as obsolete in this release: - - ** NamespceAttributes ** - - Status - - Enabled - - ```powershell - # Old - # The $namespace has Status and Enabled property - $namespace = Get-AzureRmServiceBusNamespace - $namespace.Status - $namespace.Enabled - # New - - # The call remains the same, but the returned values NameSpace object will not have the ResourceGroupName property - $namespace = Get-AzureRmServiceBusNamespace - - ``` - - - ** Queue ** - - EntityAvailabilityStatus - - EnableBatchedOperations - - IsAnonymousAccessible - - SupportOrdering - - ```powershell - - # Old - # The $queue has EntityAvailabilityStatus, EnableBatchedOperations, IsAnonymousAccessible and SupportOrdering property - $queue = Get-AzureRmServiceBusQueue - $queue.EntityAvailabilityStatus - $queue.EnableBatchedOperations - $queue.IsAnonymousAccessible - $queue.SupportOrdering - - # New - - # The call remains the same, but the returned values Queue object will not have the EntityAvailabilityStatus, EnableBatchedOperations, IsAnonymousAccessible and SupportOrdering properties - $queue = Get-AzureRmServiceBusQueue - - ``` - - ** Topic ** - - Location - - IsExpress - - IsAnonymousAccessible - - FilteringMessagesBeforePublishing - - EnableSubscriptionPartitioning - - EntityAvailabilityStatus - - - ```powershell - - # Old - # The $topic has EntityAvailabilityStatus, EnableSubscriptionPartitioning, IsAnonymousAccessible, IsExpress, Location and FilteringMessagesBeforePublishing property - $topic = Get-AzureRmServiceBusTopic - $topic.EntityAvailabilityStatus - $topic.EnableSubscriptionPartitioning - $topic.IsAnonymousAccessible - $topic.IsExpress - $topic.FilteringMessagesBeforePublishing - $topic.Location - - # New - - # The call remains the same, but the returned values Topic object will not have the EntityAvailabilityStatus, EnableBatchedOperations, IsAnonymousAccessible and SupportOrdering properties - $topic = Get-AzureRmServiceBusTopic - - ``` - - ** Subscription ** - - EntityAvailabilityStatus - - DeadLetteringOnFilterEvaluationExceptions - - Location - - IsReadOnly - - ```powershell - - # Old - # The $subscription has EntityAvailabilityStatus, EnableSubscriptionPartitioning, IsAnonymousAccessible, IsExpress, Location and FilteringMessagesBeforePublishing property - $subscription = Get-AzureRmServiceBussubscription - $subscription.EntityAvailabilityStatus - $subscription.EnableSubscriptionPartitioning - $subscription.IsAnonymousAccessible - $subscription.IsExpress - $subscription.FilteringMessagesBeforePublishing - $subscription.Location - - # New - - # The call remains the same, but the returned values Topic object will not have the EntityAvailabilityStatus, EnableBatchedOperations, IsAnonymousAccessible and SupportOrdering properties - $subscription = Get-AzureRmServiceBussubscription - - ``` - \ No newline at end of file +# Upcoming Breaking Changes \ No newline at end of file