Skip to content

Commit

Permalink
[EventHub/ServiceBus] Breaking change Alert for EventHub ServiceBus (#…
Browse files Browse the repository at this point in the history
…24354)

* Updates

* Updates

* Updates

* Updates

* Updates

* Updates

* Updates

* updates

* updates

* updates

* updates

* Updates

* Updates

* updates version number

* Update New-AzServiceBusIPRuleConfig.ps1
  • Loading branch information
schaudhari6254888 authored Mar 19, 2024
1 parent 87e6ad8 commit a9bd00b
Show file tree
Hide file tree
Showing 23 changed files with 116 additions and 8 deletions.
64 changes: 61 additions & 3 deletions src/EventHub/EventHub.Autorest/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@
This directory contains the PowerShell module for the EventHub service.

---
## Status
[![Az.EventHub](https://img.shields.io/powershellgallery/v/Az.EventHub.svg?style=flat-square&label=Az.EventHub "Az.EventHub")](https://www.powershellgallery.com/packages/Az.EventHub/)

## Info
- Modifiable: yes
- Generated: all
Expand Down Expand Up @@ -460,3 +457,64 @@ directive:

- model-cmdlet:
- KeyVaultProperties

- where:
parameter-name: IdentityType
set:
breaking-change:
old-parameter-type: CaptureIdentityType
new-parameter-type: String
deprecated-by-version: 5.0.0
deprecated-by-azversion: 12.0.0
change-effective-date: 2024/05/21

- where:
parameter-name: CleanupPolicy
set:
breaking-change:
old-parameter-type: CleanupPolicyRetentionDescription
new-parameter-type: String
deprecated-by-version: 5.0.0
deprecated-by-azversion: 12.0.0
change-effective-date: 2024/05/21

- where:
parameter-name: Status
set:
breaking-change:
old-parameter-type: EntityStatus
new-parameter-type: String
deprecated-by-version: 5.0.0
deprecated-by-azversion: 12.0.0
change-effective-date: 2024/05/21

- where:
parameter-name: Encoding
set:
breaking-change:
old-parameter-type: EncodingCaptureDescription
new-parameter-type: String
deprecated-by-version: 5.0.0
deprecated-by-azversion: 12.0.0
change-effective-date: 2024/05/21

- where:
parameter-name: SchemaCompatibility
set:
breaking-change:
old-parameter-type: SchemaCompatibility
new-parameter-type: String
deprecated-by-version: 5.0.0
deprecated-by-azversion: 12.0.0
change-effective-date: 2024/05/21

- where:
parameter-name: SchemaType
set:
breaking-change:
old-parameter-type: SchemaType
new-parameter-type: String
deprecated-by-version: 5.0.0
deprecated-by-azversion: 12.0.0
change-effective-date: 2024/05/21

Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ function New-AzEventHubAuthorizationRule{
[Microsoft.Azure.PowerShell.Cmdlets.EventHub.Category('Body')]
[Microsoft.Azure.PowerShell.Cmdlets.EventHub.Support.AccessRights[]]
# The rights associated with the rule.
[Microsoft.Azure.PowerShell.Cmdlets.EventHub.Runtime.ParameterBreakingChangeAttribute("Rights","12.0.0", "5.0.0","2024-05-21" )]
${Rights},

[Parameter(HelpMessage = "The credentials, account, tenant, and subscription used for communication with Azure.")]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ function New-AzEventHubIPRuleConfig{

[Parameter(HelpMessage = "The IP Filter Action")]
[Microsoft.Azure.PowerShell.Cmdlets.EventHub.Support.NetworkRuleIPAction]
[Microsoft.Azure.PowerShell.Cmdlets.EventHub.Runtime.ParameterBreakingChangeAttribute("Action","12.0.0", "5.0.0","2024-05-21" )]
# The IP Filter Action
${Action}
)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ function New-AzEventHubKey{
[Microsoft.Azure.PowerShell.Cmdlets.EventHub.Category('Body')]
[Microsoft.Azure.PowerShell.Cmdlets.EventHub.Support.KeyType]
# The access key to regenerate.
[Microsoft.Azure.PowerShell.Cmdlets.EventHub.Runtime.ParameterBreakingChangeAttribute("KeyType","12.0.0", "5.0.0","2024-05-21" )]
${KeyType},

[Parameter(HelpMessage = "Optional, if the key value provided, is set for KeyType or autogenerated Key value set for keyType")]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@ function New-AzEventHubNamespace{
[Parameter(HelpMessage = "Type of managed service identity.")]
[Microsoft.Azure.PowerShell.Cmdlets.EventHub.Category('Body')]
[Microsoft.Azure.PowerShell.Cmdlets.EventHub.Support.ManagedServiceIdentityType]
[Microsoft.Azure.PowerShell.Cmdlets.EventHub.Runtime.ParameterBreakingChangeAttribute("IdentityType","12.0.0", "5.0.0","2024-05-21" )]
${IdentityType},

[Parameter(HelpMessage = "Properties for User Assigned Identities")]
Expand All @@ -109,11 +110,13 @@ function New-AzEventHubNamespace{
[Parameter(HelpMessage = "The minimum TLS version for the cluster to support, e.g. '1.2'")]
[Microsoft.Azure.PowerShell.Cmdlets.EventHub.Category('Body')]
[Microsoft.Azure.PowerShell.Cmdlets.EventHub.Support.SkuName]
[Microsoft.Azure.PowerShell.Cmdlets.EventHub.Runtime.ParameterBreakingChangeAttribute("SkuName","12.0.0", "5.0.0","2024-05-21" )]
${SkuName},

[Parameter(HelpMessage = "This determines if traffic is allowed over public network. By default it is enabled.")]
[Microsoft.Azure.PowerShell.Cmdlets.EventHub.Category('Body')]
[Microsoft.Azure.PowerShell.Cmdlets.EventHub.Support.PublicNetworkAccess]
[Microsoft.Azure.PowerShell.Cmdlets.EventHub.Runtime.ParameterBreakingChangeAttribute("PublicNetworkAccess","12.0.0", "5.0.0","2024-05-21" )]
${PublicNetworkAccess},

[Parameter(HelpMessage = "The Event Hubs throughput units for Basic or Standard tiers, where value should be 0 to 20 throughput units. The Event Hubs premium units for Premium tier, where value should be 0 to 10 premium units.")]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,8 @@ function New-AzEventHubThrottlingPolicyConfig{
[Parameter(Mandatory, HelpMessage = "Metric Id on which the throttle limit should be set, MetricId can be discovered by hovering over Metric in the Metrics section of Event Hub Namespace inside Azure Portal")]
[Microsoft.Azure.PowerShell.Cmdlets.EventHub.Support.MetricId]
# Metric Id on which the throttle limit should be set, MetricId can be discovered by hovering over Metric in the Metrics section of Event Hub Namespace inside Azure Portal.
${MetricId}
[Microsoft.Azure.PowerShell.Cmdlets.EventHub.Runtime.ParameterBreakingChangeAttribute("MetricId","12.0.0", "5.0.0","2024-05-21" )]
${MetricId}
)

process{
Expand Down
3 changes: 3 additions & 0 deletions src/EventHub/EventHub.Autorest/custom/Set-AzEventHub.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ function Set-AzEventHub{
[Microsoft.Azure.PowerShell.Cmdlets.EventHub.Category('Body')]
[Microsoft.Azure.PowerShell.Cmdlets.EventHub.Support.EncodingCaptureDescription]
#Enumerates the possible values for the encoding format of capture description. Note: 'AvroDeflate' will be deprecated in New API Version
[Microsoft.Azure.PowerShell.Cmdlets.EventHub.Runtime.ParameterBreakingChangeAttribute("Encoding","12.0.0", "5.0.0","2024-05-21" )]
${Encoding},

[Parameter(HelpMessage = "The time window allows you to set the frequency with which the capture to Azure Blobs will happen, value should between 60 to 900 seconds")]
Expand Down Expand Up @@ -103,6 +104,7 @@ function Set-AzEventHub{
[Microsoft.Azure.PowerShell.Cmdlets.EventHub.Category('Body')]
[Microsoft.Azure.PowerShell.Cmdlets.EventHub.Support.EntityStatus]
# Enumerates the possible values for the status of the Event Hub.
[Microsoft.Azure.PowerShell.Cmdlets.EventHub.Runtime.ParameterBreakingChangeAttribute("Status","12.0.0", "5.0.0","2024-05-21" )]
${Status},

[Parameter(HelpMessage = "Name for capture destination")]
Expand All @@ -113,6 +115,7 @@ function Set-AzEventHub{
[Parameter(HelpMessage = "Type of managed service identity.")]
[Microsoft.Azure.PowerShell.Cmdlets.EventHub.Category('Body')]
[Microsoft.Azure.PowerShell.Cmdlets.EventHub.Support.ManagedServiceIdentityType]
[Microsoft.Azure.PowerShell.Cmdlets.EventHub.Runtime.ParameterBreakingChangeAttribute("IdentityType","12.0.0", "5.0.0","2024-05-21" )]
${IdentityType},

[Parameter(HelpMessage = "Properties for User Assigned Identities")]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ Sets an EventHub Authorization Rule

function Set-AzEventHubAuthorizationRule{
[OutputType([Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.Api202301Preview.IAuthorizationRule])]

[CmdletBinding(DefaultParameterSetName = 'SetExpandedNamespace', PositionalBinding = $false, SupportsShouldProcess, ConfirmImpact = 'Medium')]
param(
[Parameter(ParameterSetName = 'SetExpandedEntity', HelpMessage = "The name of the Authorization Rule")]
Expand Down Expand Up @@ -71,6 +72,7 @@ function Set-AzEventHubAuthorizationRule{
[Microsoft.Azure.PowerShell.Cmdlets.EventHub.Category('Body')]
[Microsoft.Azure.PowerShell.Cmdlets.EventHub.Support.AccessRights[]]
# The rights associated with the rule.
[Microsoft.Azure.PowerShell.Cmdlets.EventHub.Runtime.ParameterBreakingChangeAttribute("Rights","12.0.0", "5.0.0","2024-05-21" )]
${Rights},

[Parameter(HelpMessage = "The credentials, account, tenant, and subscription used for communication with Azure.")]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ function Set-AzEventHubNamespace{
[Parameter(HelpMessage = "Type of managed service identity.")]
[Microsoft.Azure.PowerShell.Cmdlets.EventHub.Category('Body')]
[Microsoft.Azure.PowerShell.Cmdlets.EventHub.Support.ManagedServiceIdentityType]
[Microsoft.Azure.PowerShell.Cmdlets.EventHub.Runtime.ParameterBreakingChangeAttribute("IdentityType","12.0.0", "5.0.0","2024-05-21" )]
${IdentityType},

[Parameter(HelpMessage = "Properties for User Assigned Identities")]
Expand Down Expand Up @@ -103,6 +104,7 @@ function Set-AzEventHubNamespace{
[Parameter(HelpMessage = "This determines if traffic is allowed over public network. By default it is enabled.")]
[Microsoft.Azure.PowerShell.Cmdlets.EventHub.Category('Body')]
[Microsoft.Azure.PowerShell.Cmdlets.EventHub.Support.PublicNetworkAccess]
[Microsoft.Azure.PowerShell.Cmdlets.EventHub.Runtime.ParameterBreakingChangeAttribute("PublicNetworkAccess","12.0.0", "5.0.0","2024-05-21" )]
${PublicNetworkAccess},

[Parameter(HelpMessage = "The Event Hubs throughput units for Basic or Standard tiers, where value should be 0 to 20 throughput units. The Event Hubs premium units for Premium tier, where value should be 0 to 10 premium units.")]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ function Set-AzEventHubNetworkRuleSet{
[Microsoft.Azure.PowerShell.Cmdlets.EventHub.Category('Body')]
[Microsoft.Azure.PowerShell.Cmdlets.EventHub.Support.PublicNetworkAccess]
#This determines if traffic is allowed over public network. By default it is enabled. If value is SecuredByPerimeter then Inbound and Outbound communication is controlled by the network security perimeter and profile's access rules.
[Microsoft.Azure.PowerShell.Cmdlets.EventHub.Runtime.ParameterBreakingChangeAttribute("PublicNetworkAccess","12.0.0", "5.0.0","2024-05-21" )]
${PublicNetworkAccess},

[Parameter(HelpMessage = "Value that indicates whether Trusted Service Access is Enabled or not.")]
Expand All @@ -66,6 +67,7 @@ function Set-AzEventHubNetworkRuleSet{
[Microsoft.Azure.PowerShell.Cmdlets.EventHub.Category('Body')]
[Microsoft.Azure.PowerShell.Cmdlets.EventHub.Support.DefaultAction]
#Default Action for Network Rule Set
[Microsoft.Azure.PowerShell.Cmdlets.EventHub.Runtime.ParameterBreakingChangeAttribute("DefaultAction","12.0.0", "5.0.0","2024-05-21" )]
${DefaultAction},

[Parameter(HelpMessage = "List of IpRules")]
Expand Down
11 changes: 11 additions & 0 deletions src/EventHub/EventHub.Autorest/examples/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Examples
This directory contains examples from the exported cmdlets of the module. When `build-module.ps1` is ran, example stub files will be generated here. If your module support Azure Profiles, the example stubs will be in individual profile folders. These example stubs should be updated to show how the cmdlet is used. The examples are imported into the documentation when `generate-help.ps1` is ran.

## Info
- Modifiable: yes
- Generated: partial
- Committed: yes
- Packaged: no

## Purpose
This separates the example documentation details from the generated documentation information provided directly from the generated cmdlets. Since the cmdlets don't have examples from the REST spec, this provides a means to add examples easily. The example stubs provide the markdown format that is required. The 3 core elements are: the name of the example, the code information of the example, and the description of the example. That information, if the markdown format is followed, will be available to documentation generation and be part of the documents in the `../docs` folder.
13 changes: 10 additions & 3 deletions src/ServiceBus/ServiceBus.Autorest/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@
This directory contains the PowerShell module for the ServiceBus service.

---
## Status
[![Az.ServiceBus](https://img.shields.io/powershellgallery/v/Az.ServiceBus.svg?style=flat-square&label=Az.ServiceBus "Az.ServiceBus")](https://www.powershellgallery.com/packages/Az.ServiceBus/)

## Info
- Modifiable: yes
- Generated: all
Expand Down Expand Up @@ -528,3 +525,13 @@ directive:

- model-cmdlet:
- KeyVaultProperties

- where:
parameter-name: Status
set:
breaking-change:
old-parameter-type: EntityStatus
new-parameter-type: String
deprecated-by-version: 4.0.0
deprecated-by-azversion: 12.0.0
change-effective-date: 2024/05/21
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ function New-AzServiceBusAuthorizationRule{
[Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Category('Body')]
[Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Support.AccessRights[]]
# The rights associated with the rule.
[Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Runtime.ParameterBreakingChangeAttribute("Rights","12.0.0", "4.0.0","2024-05-21" )]
${Rights},

[Parameter(HelpMessage = "The credentials, account, tenant, and subscription used for communication with Azure.")]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ function New-AzServiceBusIPRuleConfig{
[Parameter(HelpMessage = "The IP Filter Action")]
[Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Support.NetworkRuleIPAction]
# The IP Filter Action
[Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Runtime.ParameterBreakingChangeAttribute("Action","12.0.0", "4.0.0","2024-05-21" )]
${Action}
)

Expand All @@ -46,4 +47,4 @@ function New-AzServiceBusIPRuleConfig{
throw
}
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ function New-AzServiceBusKey{
[Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Category('Body')]
[Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Support.KeyType]
# The access key to regenerate.
[Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Runtime.ParameterBreakingChangeAttribute("KeyType","12.0.0", "4.0.0","2024-05-21" )]
${KeyType},

[Parameter(HelpMessage = "Optional, if the key value provided, is set for KeyType or autogenerated Key value set for keyType")]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ function New-AzServiceBusNamespace{
[Parameter(HelpMessage = "Type of managed service identity.")]
[Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Category('Body')]
[Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Support.ManagedServiceIdentityType]
[Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Runtime.ParameterBreakingChangeAttribute("IdentityType","12.0.0", "4.0.0","2024-05-21" )]
${IdentityType},

[Parameter(HelpMessage = "Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones.")]
Expand All @@ -95,11 +96,13 @@ function New-AzServiceBusNamespace{
[Parameter(HelpMessage = "This determines if traffic is allowed over public network. By default it is enabled.")]
[Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Category('Body')]
[Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Support.PublicNetworkAccess]
[Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Runtime.ParameterBreakingChangeAttribute("PublicNetworkAccess","12.0.0", "4.0.0","2024-05-21" )]
${PublicNetworkAccess},

[Parameter(HelpMessage = "Name of this SKU.")]
[Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Category('Body')]
[Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Support.SkuName]
[Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Runtime.ParameterBreakingChangeAttribute("SkuName","12.0.0", "4.0.0","2024-05-21" )]
${SkuName},

[Parameter(HelpMessage = "The specified messaging units for the tier. For Premium tier, capacity are 1,2 and 4.")]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ function Set-AzServiceBusAuthorizationRule{
[Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Category('Body')]
[Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Support.AccessRights[]]
# The rights associated with the rule.
[Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Runtime.ParameterBreakingChangeAttribute("Rights","12.0.0", "4.0.0","2024-05-21" )]
${Rights},

[Parameter(HelpMessage = "The credentials, account, tenant, and subscription used for communication with Azure.")]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ function Set-AzServiceBusNamespace{
[Parameter(HelpMessage = "Type of managed service identity.")]
[Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Category('Body')]
[Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Support.ManagedServiceIdentityType]
[Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Runtime.ParameterBreakingChangeAttribute("IdentityType","12.0.0", "4.0.0","2024-05-21" )]
${IdentityType},

[Parameter(HelpMessage = "Properties for User Assigned Identities")]
Expand All @@ -87,11 +88,13 @@ function Set-AzServiceBusNamespace{
[Parameter(HelpMessage = "This determines if traffic is allowed over public network. By default it is enabled.")]
[Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Category('Body')]
[Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Support.PublicNetworkAccess]
[Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Runtime.ParameterBreakingChangeAttribute("PublicNetworkAccess","12.0.0", "4.0.0","2024-05-21" )]
${PublicNetworkAccess},

[Parameter(HelpMessage = "Name of this SKU.")]
[Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Category('Body')]
[Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Support.SkuName]
[Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Runtime.ParameterBreakingChangeAttribute("SkuName","12.0.0", "4.0.0","2024-05-21" )]
${SkuName},

[Parameter(HelpMessage = "The specified messaging units for the tier. For Premium tier, capacity are 1,2 and 4.")]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ function Set-AzServiceBusNetworkRuleSet{
[Parameter(HelpMessage = "This determines if traffic is allowed over public network. By default it is enabled. If value is SecuredByPerimeter then Inbound and Outbound communication is controlled by the network security perimeter and profile's access rules. ")]
[Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Category('Body')]
[Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Support.PublicNetworkAccess]
[Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Runtime.ParameterBreakingChangeAttribute("PublicNetworkAccess","12.0.0", "4.0.0","2024-05-21" )]
# This determines if traffic is allowed over public network. By default it is enabled. If value is SecuredByPerimeter then Inbound and Outbound communication is controlled by the network security perimeter and profile's access rules.
${PublicNetworkAccess},

Expand All @@ -65,6 +66,7 @@ function Set-AzServiceBusNetworkRuleSet{
[Parameter(HelpMessage = "Default Action for Network Rule Set")]
[Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Category('Body')]
[Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Support.DefaultAction]
[Microsoft.Azure.PowerShell.Cmdlets.ServiceBus.Runtime.ParameterBreakingChangeAttribute("DefaultAction","12.0.0", "4.0.0","2024-05-21" )]
#Default Action for Network Rule Set
${DefaultAction},

Expand Down
Loading

0 comments on commit a9bd00b

Please sign in to comment.