Skip to content

Commit

Permalink
Merge pull request #5 from Azure/master
Browse files Browse the repository at this point in the history
Sync
  • Loading branch information
bashahee committed Aug 13, 2019
2 parents 7b02beb + 374f33e commit 8f1119e
Show file tree
Hide file tree
Showing 1,842 changed files with 478,883 additions and 376,914 deletions.
109 changes: 109 additions & 0 deletions ChangeLog.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,112 @@
## 2.5.0 - July 2019
#### Az.Accounts
* Update common code to use latest version of ClientRuntime

#### Az.ApplicationInsights
* Fix example typo in 'Remove-AzApplicationInsightsApiKey' documentation

#### Az.Automation
* Fix typo in resource string

#### Az.CognitiveServices
* Added NetworkRuleSet support.

#### Az.Compute
* Add missing properties (ComputerName, OsName, OsVersion and HyperVGeneration) of VM instance view object.

#### Az.ContainerRegistry
* Fix typo in Remove-AzContainerRegistryReplication for Replication parameter
- More information here https://github.com/Azure/azure-powershell/issues/9633

#### Az.DataFactory
* Updated ADF .Net SDK version to 4.1.0
* Fix typo in documentation for 'Get-AzDataFactoryV2PipelineRun'

#### Az.EventHub
* Added new cmmdlet added for generating SAS token : New-AzEventHubAuthorizationRuleSASToken
* added verification and error message for authorizationrules rights if only 'Manage' is assigned

#### Az.KeyVault
* Added support to specify the KeySize for Certificate Policies

#### Az.LogicApp
* Fix for Get-AzIntegrationAccountMap to list all map types
- Added new MapType parameter for filtering

#### Az.ManagedServices
* Added support for api version 2019-06-01 (GA)

#### Az.Network
* Add support for private endpoint and private link service
- New cmdlets
- Set-AzPrivateEndpoint
- Set-AzPrivateLinkService
- Approve-AzPrivateEndpointConnection
- Deny-AzPrivateEndpointConnection
- Get-AzPrivateEndpointConnection
- Remove-AzPrivateEndpointConnection
- Test-AzPrivateLinkServiceVisibility
- Get-AzAutoApprovedPrivateLinkService
* Updated below commands for feature: PrivateEndpointNetworkPolicies/PrivateLinkServiceNetworkPolicies flag on Subnet in Virtualnetwork
- Updated New-AzVirtualNetworkSubnetConfig/Set-AzVirtualNetworkSubnetConfig/Add-AzVirtualNetworkSubnetConfig
- Added optional parameter -PrivateEndpointNetworkPoliciesFlag to indicate that enable or disable apply network policies on pivate endpoint in this subnet.
- Added optional parameter -PrivateLinkServiceNetworkPoliciesFlag to indicate that enable or disable apply network policies on private link service in this subnet.
* AzPrivateLinkService's cmdlet parameter 'ServiceName' was renamed to 'Name' with an alias 'ServiceName' for backward compatibility
* Enable ICMP protocol for network security rule configurations
- Updated cmdlets
- Add-AzNetworkSecurityRuleConfig
- New-AzNetworkSecurityRuleConfig
- Set-AzNetworkSecurityRuleConfig
* Add ConnectionProtocolType (Ikev1/Ikev2) as a configurable parameter for New-AzVirtualNetworkGatewayConnection
* Add PrivateIpAddressVersion in LoadBalancerFrontendIpConfiguration
- Updated cmdlet:
- New-AzLoadBalancerFrontendIpConfig
- Add-AzLoadBalancerFrontendIpConfig
- Set-AzLoadBalancerFrontendIpConfig
* Application Gateway New-AzApplicationGatewayProbeConfig command update for supporting custom port in Probe
- Updated New-AzApplicationGatewayProbeConfig: Added optional parameter Port which is used for probing backend server. This parameter is applicable for Standard_V2 and WAF_V2 SKU.

#### Az.OperationalInsights
* Updated default version for saved searches to be 1.
* Fixed custom log null regex handling

#### Az.RecoveryServices
* Update 'Get-AzRecoveryServicesBackupJob.md'
* Update 'Get-AzRecoveryServicesBackupContainer.md'
* Update 'Get-AzRecoveryServicesVault.md'
* Update 'Wait-AzRecoveryServicesBackupJob.md'
* Update 'Set-AzRecoveryServicesVaultContext.md'
* Update 'Get-AzRecoveryServicesBackupItem.md'
* Update 'Get-AzRecoveryServicesBackupRecoveryPoint.md'
* Update 'Restore-AzRecoveryServicesBackupItem.md'
* Updated service call for Unregistering container for Azure File Share
* Update 'Set-AzRecoveryServicesAsrAlertSetting.md'

#### Az.Resources
- Remove missing cmdlet referenced in 'New-AzResourceGroupDeployment' documentation
- Updated policy cmdlets to use new api version 2019-01-01

#### Az.ServiceBus
* Added new cmmdlet added for generating SAS token : New-AzServiceBusAuthorizationRuleSASToken
* added verification and error message for authorizationrules rights if only 'Manage' is assigned

#### Az.Sql
* Fix missing examples for Set-AzSqlDatabaseSecondary cmdlet
* Fix set Vulnerability Assessment recurring scans without providing any email addresses
* Fix a small typo in a warining message.

#### Az.Storage
* Update example in reference documentation for 'Get-AzStorageAccount' to use correct parameter name

#### Az.StorageSync
* Adding Invoke-AzStorageSyncChangeDetection cmdlet.
* Fix Issue 9551 for honoring TierFilesOlderThanDays

#### Az.Websites
* Fixing a bug where some SiteConfig properties were not returned by Get-AzWebApp and Set-AzWebApp
* Adds a new Location parameter to Get-AzDeletedWebApp and Restore-AzDeletedWebApp
* Fixes a bug with cloning web app slots using New-AzWebApp -IncludeSourceWebAppSlots

## 2.4.0 - July 2019
#### Az.Accounts
* Add support for profile cmdlets
Expand Down
2 changes: 1 addition & 1 deletion build.proj
Original file line number Diff line number Diff line change
Expand Up @@ -263,7 +263,7 @@
</Target>

<Target Name="TestFailureErrorMessage">
<Error Text="Test failures occured, check the files in artifacts/TestResults" />
<Error Text="Test failures occurred, check the files in artifacts/TestResults" />
</Target>

<Target Name="CodeSignBinaries" AfterTargets="Build" Condition="'$(CodeSign)' == 'true'">
Expand Down
8 changes: 4 additions & 4 deletions documentation/announcing-az-module.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,11 @@ Az is a new module, and reorganizing and simplifying cmdlet names involves break
| Date | Feature |
-------|----------
| **August 2018** | Initial Release |
| **November 2018** | Functional arity with AzureRM |
| **November 2018** | Functional parity with AzureRM |
| **December 2018** | Az 1.0 Release |
| **January 2019** | New Authentication mechanisms for Windows PowerShell
| | - Username + password authentication
| | - Web broswer control authentication |
| | - Web browser control authentication |



Expand Down Expand Up @@ -139,7 +139,7 @@ For scripts that import modules directly, or use ```#Requires``` statements to s
| AzureRM.Media | Az.Media |
| AzureRM.Network | Az.Network |
| AzureRM.NotificationHubs | Az.NotificationHubs |
| AzureRM.OperationalInsights | Az.OperationalIsights |
| AzureRM.OperationalInsights | Az.OperationalInsights |
| AzureRM.PolicyInsights | Az.PolicyInsights |
| AzureRM.PowerBIEmbedded | Az.PowerBIEmbedded* |
| **AzureRM.Profile** | **Az.Accounts** |
Expand Down Expand Up @@ -187,7 +187,7 @@ If you need to have both modules installed:
```

##### Interactive Usage
You cannot load Az and AzureRM modules in the same PowerShell session, but they can be used in seperate sessions as follows
You cannot load Az and AzureRM modules in the same PowerShell session, but they can be used in separate sessions as follows
- In AzureRM session: ```Import-Module AzureRM```
- In Az session: Begin the session with ```Enable-AzureRmAlias```, which will prevent inadvertently loading AzureRM modules. Alternately, you can use cmdlets with Az noun prefix, and avoid using cmdlets with Azure or AzureRm noun

Expand Down
28 changes: 14 additions & 14 deletions documentation/breaking-changes/breaking-changes-attribute-help.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Breaking Changes Attribute Help

Below is description of the various types of Breaking Change Attributes (custom attributes) that can be used to decorate the cmdlet or its paramters to call out various [types of breaking changes](https://github.com/praries880/azure-powershell/blob/breakingchangeattribute/documentation/breaking-changes/breaking-changes-definition.md).
Below is description of the various types of Breaking Change Attributes (custom attributes) that can be used to decorate the cmdlet or its parameters to call out various [types of breaking changes](https://github.com/praries880/azure-powershell/blob/breakingchangeattribute/documentation/breaking-changes/breaking-changes-definition.md).

## The different types of attributes

Expand All @@ -11,7 +11,7 @@ Below is description of the various types of Breaking Change Attributes (custom

## Common aspects and properties
### GenericBreakingChangeAttribute
The base attibute which provides the core functionality is called "GenericBreakingChange" All the remaining attrbutes derive from it and provide functionality that makes sense for the scenarios they handle.
The base attribute which provides the core functionality is called "GenericBreakingChange" All the remaining attributes derive from it and provide functionality that makes sense for the scenarios they handle.

The generic attribute is the most free form of them all and can be used to call out breaking changes that do not fall into the more specialized categories.

Expand All @@ -23,20 +23,20 @@ All of the attributes have the following common traits:

### Common Properties
#### Constructor arguments
- Each attribute has two additional constructors thet take the following params in addition to the ones the attribute mentions:
- Each attribute has two additional constructors that take the following params in addition to the ones the attribute mentions:
- The "deprecatedByVersion" is the version number the breaking change is going to be done in.
- The "changeInEfectByDate" is the date the breaking change is goind to go in effet on. The string formati is "mm/dd/yyyy", as an example : "02/25/2018"
- The "changeInEffectByDate" is the date the breaking change is going to go in effect on. The string format is "mm/dd/yyyy", as an example : "02/25/2018"
#### Properties by name
- Each attribute accepts the following properties by name (all of them are optional) :
- "ChangeDescription" : This is a free form text field that can be used to describe the breaking change.
- Usage changes (you cant have one or the other, you need to speciffy both for the usage message to be generated) :
- Usage changes (you cant have one or the other, you need to specify both for the usage message to be generated) :
- "OldWay" : The way to call the cmdlet before the breaking change takes effect
- "NewWay" : If there is a workaround to the breaking change, or if the same functionality can be achieved in another manner

The properties "deprecatedByVersion" and "changeInEfectByDate" are infotmation only (for the end user) as of now.
The properties "deprecatedByVersion" and "changeInEffectByDate" are information only (for the end user) as of now.

#### Supress the breaking change messages at runtime
- If the user desires to not see the warning messages generated by the attirbutes at runtime, they can set the env variable "SuppressAzurePowerShellBreakingChangeWarnings" to "true".
#### Suppress the breaking change messages at runtime
- If the user desires to not see the warning messages generated by the attributes at runtime, they can set the env variable "SuppressAzurePowerShellBreakingChangeWarnings" to "true".

NOTE :
- The only time you will see the output (at runtime) of an attribute applied to a parameter (property or field) is if the parameter is actually invoked on the cmdline. The breaking change attributes to all parameters that are not invoked are ignored.
Expand Down Expand Up @@ -79,7 +79,7 @@ Breaking changes in the cmdlet : Get-SomeObjectA
The change is expected to take effect from the version : 5.0.0.0
```

#### With "deprecatedByVersion" and "changeInEfectByDate"
#### With "deprecatedByVersion" and "changeInEffectByDate"
```cs
[GenericBreakingChange("Message2", "5.0.0.0", "02/13/2018")]
[Cmdlet(VerbsCommon.Get, "SomeObjectB"), OutputType(typeof(Foo))]
Expand Down Expand Up @@ -202,10 +202,10 @@ The cmdlet is being deprecated. There will be no replacement for it.
```

## CmdletOutputBreakingChangeAttribute
This attribute is used to call out the breakigng changes with the output of a cmdlet. A few examples are :
This attribute is used to call out the breaking changes with the output of a cmdlet. A few examples are :
- The type of the output is changing
- The Output type is being deprecated
- Some internal properties in the putput type are being deprecated
- Some internal properties in the output type are being deprecated
- New properties are being introduced to the output type

Note :
Expand Down Expand Up @@ -279,7 +279,7 @@ Breaking changes in the cmdlet : Get-SomeObjectB
'Prop1' 'Prop2'
```

#### A few new properties are bing added to the output type
#### A few new properties are being added to the output type
```cs
[CmdletOutputBreakingChange(typeof(Foo), NewOutputProperties = new String[] {"Prop1", "Prop2"})]
[Cmdlet(VerbsCommon.Get, "SomeObjectC"), OutputType(typeof(Foo))]
Expand Down Expand Up @@ -330,7 +330,7 @@ Breaking changes in the cmdlet : Get-SomeObjectD
```

## CmdletParameterBreakingChangeAttribute
This attribute is used to call out the breakigng changes relating to a parameter of a cmdlet. A few examples are :
This attribute is used to call out the breaking changes relating to a parameter of a cmdlet. A few examples are :
- A parameter is being deprecated
- A parameter is being replaced
- A parameter is becoming mandatory
Expand Down Expand Up @@ -470,7 +470,7 @@ Breaking changes in the cmdlet : Get-SomeObjectB
[Cmdlet(VerbsCommon.Get, "SomeObjectA"), OutputType(typeof(Foo))]
public class GetSomeObjectA : AzureRMCmdlet
{
[CmdletParameterBreakingChange("Param1", IsBecomingMandatory=truec)]
[CmdletParameterBreakingChange("Param1", IsBecomingMandatory=true)]
[Parameter(Mandatory = false)]
public String Param1;
protected override void BeginProcessing()
Expand Down
14 changes: 7 additions & 7 deletions documentation/breaking-changes/breaking-changes-definition.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ Breaking changes in cmdlets are defined as follows:

# Cmdlets
- Removing a cmdlet
- Use the breaking change attribute ["CmdletDeprecationAttribute"](./breaking-changes-attribute-help.md#cmdletdeprecationattribute), more specificallly the ["cmdlet deprecation without replacement"](./breaking-changes-attribute-help.md#when-there-is-no-replacement-cmdlet) option
- Use the breaking change attribute ["CmdletDeprecationAttribute"](./breaking-changes-attribute-help.md#cmdletdeprecationattribute), more specifically the ["cmdlet deprecation without replacement"](./breaking-changes-attribute-help.md#when-there-is-no-replacement-cmdlet) option
- Changing a cmdlet name without an alias to the original name
- Use the breaking change attribute ["CmdletDeprecationAttribute"](./breaking-changes-attribute-help.md#cmdletdeprecationattribute), more specificallly the ["cmdlet deprecation with replacement"](./breaking-changes-attribute-help.md#when-there-is-a-replacement-cmdlet) option
- Use the breaking change attribute ["CmdletDeprecationAttribute"](./breaking-changes-attribute-help.md#cmdletdeprecationattribute), more specifically the ["cmdlet deprecation with replacement"](./breaking-changes-attribute-help.md#when-there-is-a-replacement-cmdlet) option
- Removing or changing a cmdlet alias
- Use the generic breaking change attribute ["GenericBreakingChangeAttribute"](./breaking-changes-attribute-help.md#genericbreakingchangeattribute) with a [simple message](./breaking-changes-attribute-help.md#with-a-simple-message) calling out the alias that is being deprecated
- Removing a cmdlet attribute option (`SupportShouldProcess`, `SupportsPaging`)
Expand All @@ -25,11 +25,11 @@ Breaking changes in cmdlets are defined as follows:
- Use the parameter breaking change attribute ["CmdletParameterBreakingChangeAttribute"](./breaking-changes-attribute-help.md#cmdletparameterbreakingchangeattribute) as [described here](./breaking-changes-attribute-help.md#a-parameter-is-being-replaced) to call out a parameter name change.
- Breaking change in parameter type
- Use the parameter breaking change attribute ["CmdletParameterBreakingChangeAttribute"](./breaking-changes-attribute-help.md#cmdletparameterbreakingchangeattribute) as [described here](./breaking-changes-attribute-help.md#a-parameter-is-changing-its-type) to call out a parameter name change.
- Adding a required parameter to an existing parametrer set (adding new parameter sets or adding additional optional parameters is not a breaking change)
- An existing parameter becomes mandatry :
- Adding a required parameter to an existing parameter set (adding new parameter sets or adding additional optional parameters is not a breaking change)
- An existing parameter becomes mandatory :
- Use the parameter breaking change attribute ["CmdletParameterBreakingChangeAttribute"](./breaking-changes-attribute-help.md#cmdletparameterbreakingchangeattribute) as [described here](./breaking-changes-attribute-help.md#a-parameter-is-becoming-mandatory) to call out a parameter becoming mandatory.
- Adding a new mandatory parameter to a parameter set:
- Use the generic breaking change attribute ["GenericBreakingChangeAttribute"](./breaking-changes-attribute-help.md#genericbreakingchangeattribute) with a [custom message](./breaking-changes-attribute-help.md#with-a-simple-message) calling out the new mandatiry parameter that is going to be added to the parameter set.
- Use the generic breaking change attribute ["GenericBreakingChangeAttribute"](./breaking-changes-attribute-help.md#genericbreakingchangeattribute) with a [custom message](./breaking-changes-attribute-help.md#with-a-simple-message) calling out the new mandatory parameter that is going to be added to the parameter set.
- Changing parameter order for parameter sets with ordered parameters
- Use the generic breaking change attribute ["GenericBreakingChangeAttribute"](./breaking-changes-attribute-help.md#genericbreakingchangeattribute) with a [custom message](./breaking-changes-attribute-help.md#with-a-simple-message) calling out the new order in the parameter set.
- Removing or changing a parameter alias
Expand All @@ -47,12 +47,12 @@ Breaking changes in cmdlets are defined as follows:
- Use the parameter breaking change attribute ["CmdletParameterBreakingChangeAttribute"](./breaking-changes-attribute-help.md#cmdletparameterbreakingchangeattribute) as [described here](./breaking-changes-attribute-help.md#generic-change-in-a-parameter) to call out the change.
- Removing properties
- In the output type
- Use the cmdlet output type breaking change attribute ["CmdletOutputBreakingChangeAttribute"](./breaking-changes-attribute-help.md#cmdletoutputbreakingchangeattribute) [as follows](./breaking-changes-attribute-help.md#a-few-properties-in-the-output-type-are-being-deprecated) to call out derecated properties.
- Use the cmdlet output type breaking change attribute ["CmdletOutputBreakingChangeAttribute"](./breaking-changes-attribute-help.md#cmdletoutputbreakingchangeattribute) [as follows](./breaking-changes-attribute-help.md#a-few-properties-in-the-output-type-are-being-deprecated) to call out deprecated properties.
- In a parameter
- Use the parameter breaking change attribute ["CmdletParameterBreakingChangeAttribute"](./breaking-changes-attribute-help.md#cmdletparameterbreakingchangeattribute) as [described here](./breaking-changes-attribute-help.md#generic-change-in-a-parameter) to call out the change.
- Adding additional required properties
- In the output type
- Use the cmdlet output type breaking change attribute ["CmdletOutputBreakingChangeAttribute"](./breaking-changes-attribute-help.md#cmdletoutputbreakingchangeattribute) [as follows](./breaking-changes-attribute-help.md#a-few-new-properties-are-bing-added-to-the-output-type) to call out derecated properties.
- Use the cmdlet output type breaking change attribute ["CmdletOutputBreakingChangeAttribute"](./breaking-changes-attribute-help.md#cmdletoutputbreakingchangeattribute) [as follows](./breaking-changes-attribute-help.md#a-few-new-properties-are-being-added-to-the-output-type) to call out deprecated properties.
- In a parameter
- Use the parameter breaking change attribute ["CmdletParameterBreakingChangeAttribute"](./breaking-changes-attribute-help.md#cmdletparameterbreakingchangeattribute) as [described here](./breaking-changes-attribute-help.md#generic-change-in-a-parameter) to call out the change.
- Adding required parameters, changing parameter names, or parameter types for methods or constructors
Expand Down
Loading

0 comments on commit 8f1119e

Please sign in to comment.