Skip to content

[App] Create Breaking change message #26083

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
msJinLei merged 2 commits into from
Sep 20, 2024
Merged

[App] Create Breaking change message #26083

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7a6ddcb
create Upcoming breaking change message
lijinpei2008 Sep 12, 2024
050a122
create BreakingChangeIssues.csv
lijinpei2008 Sep 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 22 additions & 3 deletions src/App/App.Autorest/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@
This directory contains the PowerShell module for the App service.

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

## Info
- Modifiable: yes
- Generated: all
Expand Down Expand Up @@ -65,6 +62,8 @@ identity-correction-for-post: true
resourcegroup-append: true
nested-object-to-string: true
auto-switch-view: false
disable-transform-identity-type: true
flatten-userassignedidentity: false

use-extension:
"@autorest/powershell": "4.x"
Expand Down Expand Up @@ -673,4 +672,24 @@ directive:
verb: Remove
subject: ContainerAppSourceControl
remove: true

##### announce upcoming MI-related breaking changes
- where:
parameter-name: IdentityType
set:
breaking-change:
change-description: IdentityType will be removed. EnableSystemAssignedIdentity will be used to enable/disable system assigned identity and UserAssignedIdentity will be used to specify user assigned identities.
deprecated-by-version: 2.0.0
deprecated-by-azversion: 13.0.0
change-effective-date: 2024/11/19
- where:
parameter-name: IdentityUserAssignedIdentity
set:
breaking-change:
old-parameter-type: Hashtable
new-parameter-type: string[]
change-description: IdentityUserAssignedIdentity will be renamed to UserAssignedIdentity. And its type will be simplified as string array.
deprecated-by-version: 2.0.0
deprecated-by-azversion: 13.0.0
change-effective-date: 2024/11/19
```
62 changes: 0 additions & 62 deletions src/App/App.Autorest/UX/Microsoft.App/connectedEnvironments.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,68 +80,6 @@
]
}
]
},
{
"name": "Test-AzContainerAppConnectedEnvNameAvailability",
"description": "Checks if resource connectedEnvironmentName is available.",
"path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/connectedEnvironments/{connectedEnvironmentName}/checkNameAvailability",
"help": {
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.app/test-azcontainerappconnectedenvnameavailability"
},
"parameterSets": [
{
"parameters": [
"-ConnectedEnvironmentName <String>",
"-ResourceGroupName <String>",
"[-SubscriptionId <String>]"
]
},
{
"parameters": [
"-ConnectedEnvironmentName <String>",
"-ResourceGroupName <String>",
"[-SubscriptionId <String>]"
]
}
]
},
"examples": [
{
"description": "Checks if resource connectedEnvironmentName is available.",
"parameters": [
{
"name": "-ConnectedEnvironmentName",
"value": "[Path.connectedEnvironmentName]"
},
{
"name": "-ResourceGroupName",
"value": "[Path.resourceGroupName]"
},
{
"name": "-SubscriptionId",
"value": "[Path.subscriptionId]"
}
]
},
{
"description": "Checks if resource connectedEnvironmentName is available.",
"parameters": [
{
"name": "-ConnectedEnvironmentName",
"value": "[Path.connectedEnvironmentName]"
},
{
"name": "-ResourceGroupName",
"value": "[Path.resourceGroupName]"
},
{
"name": "-SubscriptionId",
"value": "[Path.subscriptionId]"
}
]
}
]
}
]
}
62 changes: 0 additions & 62 deletions src/App/App.Autorest/UX/Microsoft.App/jobs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,68 +80,6 @@
]
}
]
},
{
"name": "Start-AzContainerAppJob",
"description": "Start a Container Apps Job",
"path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/start",
"help": {
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.app/start-azcontainerappjob"
},
"parameterSets": [
{
"parameters": [
"-Name <String>",
"-ResourceGroupName <String>",
"[-SubscriptionId <String>]"
]
},
{
"parameters": [
"-Name <String>",
"-ResourceGroupName <String>",
"[-SubscriptionId <String>]"
]
}
]
},
"examples": [
{
"description": "Start a Container Apps Job",
"parameters": [
{
"name": "-Name",
"value": "[Path.jobName]"
},
{
"name": "-ResourceGroupName",
"value": "[Path.resourceGroupName]"
},
{
"name": "-SubscriptionId",
"value": "[Path.subscriptionId]"
}
]
},
{
"description": "Start a Container Apps Job",
"parameters": [
{
"name": "-Name",
"value": "[Path.jobName]"
},
{
"name": "-ResourceGroupName",
"value": "[Path.resourceGroupName]"
},
{
"name": "-SubscriptionId",
"value": "[Path.subscriptionId]"
}
]
}
]
}
]
}
62 changes: 0 additions & 62 deletions src/App/App.Autorest/UX/Microsoft.App/managedEnvironments.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,68 +156,6 @@
]
}
]
},
{
"name": "Test-AzContainerAppNamespaceAvailability",
"description": "Checks if resource name is available.",
"path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName}/checkNameAvailability",
"help": {
"learnMore": {
"url": "https://learn.microsoft.com/powershell/module/az.app/test-azcontainerappnamespaceavailability"
},
"parameterSets": [
{
"parameters": [
"-EnvName <String>",
"-ResourceGroupName <String>",
"[-SubscriptionId <String>]"
]
},
{
"parameters": [
"-EnvName <String>",
"-ResourceGroupName <String>",
"[-SubscriptionId <String>]"
]
}
]
},
"examples": [
{
"description": "Checks if resource name is available.",
"parameters": [
{
"name": "-EnvName",
"value": "[Path.environmentName]"
},
{
"name": "-ResourceGroupName",
"value": "[Path.resourceGroupName]"
},
{
"name": "-SubscriptionId",
"value": "[Path.subscriptionId]"
}
]
},
{
"description": "Checks if resource name is available.",
"parameters": [
{
"name": "-EnvName",
"value": "[Path.environmentName]"
},
{
"name": "-ResourceGroupName",
"value": "[Path.resourceGroupName]"
},
{
"name": "-SubscriptionId",
"value": "[Path.subscriptionId]"
}
]
}
]
}
]
}
12 changes: 6 additions & 6 deletions src/App/App.Autorest/docs/Az.App.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -276,17 +276,17 @@ Checks if resource name is available.
Patches a Container App using JSON Merge Patch

### [Update-AzContainerAppAuthConfig](Update-AzContainerAppAuthConfig.md)
Create the AuthConfig for a Container App.
Update the AuthConfig for a Container App.

### [Update-AzContainerAppConnectedEnvCert](Update-AzContainerAppConnectedEnvCert.md)
Patches a certificate.
Currently only patching of tags is supported

### [Update-AzContainerAppConnectedEnvDapr](Update-AzContainerAppConnectedEnvDapr.md)
Create a Dapr Component in a connected environment.
Update a Dapr Component in a connected environment.

### [Update-AzContainerAppConnectedEnvStorage](Update-AzContainerAppConnectedEnvStorage.md)
Create storage for a connectedEnvironment.
Update storage for a connectedEnvironment.

### [Update-AzContainerAppJob](Update-AzContainerAppJob.md)
Patches a Container Apps Job using JSON Merge Patch
Expand All @@ -303,11 +303,11 @@ Patches a certificate.
Currently only patching of tags is supported

### [Update-AzContainerAppManagedEnvDapr](Update-AzContainerAppManagedEnvDapr.md)
Create a Dapr Component in a Managed Environment.
Update a Dapr Component in a Managed Environment.

### [Update-AzContainerAppManagedEnvStorage](Update-AzContainerAppManagedEnvStorage.md)
Create storage for a managedEnvironment.
Update storage for a managedEnvironment.

### [Update-AzContainerAppSourceControl](Update-AzContainerAppSourceControl.md)
Create the SourceControl for a Container App.
Update the SourceControl for a Container App.

2 changes: 0 additions & 2 deletions src/App/App.Autorest/docs/Disable-AzContainerAppRevision.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,6 @@ Deactivates a revision for a Container App.

### -ContainerAppInputObject
Identity Parameter
To construct, see NOTES section for CONTAINERAPPINPUTOBJECT properties and create a hash table.

```yaml
Type: Microsoft.Azure.PowerShell.Cmdlets.App.Models.IAppIdentity
Expand Down Expand Up @@ -109,7 +108,6 @@ Accept wildcard characters: False

### -InputObject
Identity Parameter
To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

```yaml
Type: Microsoft.Azure.PowerShell.Cmdlets.App.Models.IAppIdentity
Expand Down
2 changes: 0 additions & 2 deletions src/App/App.Autorest/docs/Enable-AzContainerAppRevision.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,6 @@ Activates a revision for a Container App.

### -ContainerAppInputObject
Identity Parameter
To construct, see NOTES section for CONTAINERAPPINPUTOBJECT properties and create a hash table.

```yaml
Type: Microsoft.Azure.PowerShell.Cmdlets.App.Models.IAppIdentity
Expand Down Expand Up @@ -109,7 +108,6 @@ Accept wildcard characters: False

### -InputObject
Identity Parameter
To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

```yaml
Type: Microsoft.Azure.PowerShell.Cmdlets.App.Models.IAppIdentity
Expand Down
20 changes: 2 additions & 18 deletions src/App/App.Autorest/docs/Get-AzContainerApp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,12 @@ Get-AzContainerApp [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>] [<C
### Get
```
Get-AzContainerApp -Name <String> -ResourceGroupName <String> [-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>] [-PassThru] [<CommonParameters>]
[-DefaultProfile <PSObject>] [<CommonParameters>]
```

### GetViaIdentity
```
Get-AzContainerApp -InputObject <IAppIdentity> [-DefaultProfile <PSObject>] [-PassThru] [<CommonParameters>]
Get-AzContainerApp -InputObject <IAppIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>]
```

### List1
Expand Down Expand Up @@ -100,7 +100,6 @@ Accept wildcard characters: False

### -InputObject
Identity Parameter
To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

```yaml
Type: Microsoft.Azure.PowerShell.Cmdlets.App.Models.IAppIdentity
Expand Down Expand Up @@ -129,21 +128,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### -PassThru
Returns true when the command succeeds

```yaml
Type: System.Management.Automation.SwitchParameter
Parameter Sets: Get, GetViaIdentity
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -ResourceGroupName
The name of the resource group.
The name is case insensitive.
Expand Down
2 changes: 0 additions & 2 deletions src/App/App.Autorest/docs/Get-AzContainerAppAuthConfig.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,6 @@ Get a AuthConfig of a Container App.

### -ContainerAppInputObject
Identity Parameter
To construct, see NOTES section for CONTAINERAPPINPUTOBJECT properties and create a hash table.

```yaml
Type: Microsoft.Azure.PowerShell.Cmdlets.App.Models.IAppIdentity
Expand Down Expand Up @@ -131,7 +130,6 @@ Accept wildcard characters: False

### -InputObject
Identity Parameter
To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

```yaml
Type: Microsoft.Azure.PowerShell.Cmdlets.App.Models.IAppIdentity
Expand Down
Loading