diff --git a/src/Communication/Communication.Autorest/Properties/AssemblyInfo.cs b/src/Communication/Communication.Autorest/Properties/AssemblyInfo.cs new file mode 100644 index 000000000000..740c2a72d281 --- /dev/null +++ b/src/Communication/Communication.Autorest/Properties/AssemblyInfo.cs @@ -0,0 +1,26 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the Apache License, Version 2.0 (the ""License""); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// http://www.apache.org/licenses/LICENSE-2.0 +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an ""AS IS"" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// Code generated by Microsoft (R) AutoRest Code Generator.Changes may cause incorrect behavior and will be lost if the code +// is regenerated. + +using System; +using System.Reflection; +using System.Runtime.CompilerServices; +using System.Runtime.InteropServices; + +[assembly: System.Reflection.AssemblyCompanyAttribute("Microsoft")] +[assembly: System.Reflection.AssemblyCopyrightAttribute("Copyright © Microsoft")] +[assembly: System.Reflection.AssemblyProductAttribute("Microsoft Azure PowerShell")] +[assembly: System.Reflection.AssemblyTitleAttribute("Microsoft Azure PowerShell - Communication")] +[assembly: System.Reflection.AssemblyFileVersionAttribute("0.4.2")] +[assembly: System.Reflection.AssemblyVersionAttribute("0.4.2")] +[assembly: System.Runtime.InteropServices.ComVisibleAttribute(false)] +[assembly: System.CLSCompliantAttribute(false)] diff --git a/src/Communication/Communication.Autorest/README.md b/src/Communication/Communication.Autorest/README.md index b56c22034cfc..0448299a25a8 100644 --- a/src/Communication/Communication.Autorest/README.md +++ b/src/Communication/Communication.Autorest/README.md @@ -35,29 +35,16 @@ input-file: # You need to specify your swagger files here. - $(repo)/specification/communication/resource-manager/Microsoft.Communication/preview/2023-06-01-preview/CommunicationServices.json -# If the swagger has not been put in the repo, you may uncomment the following line and refer to it locally -# - (this-folder)/relative-path-to-your-swagger - -# For new RP, the version is 0.1.0 module-version: 0.1.0 -# Normally, title is the service name title: Communication subject-prefix: $(service-name) -# If there are post APIs for some kinds of actions in the RP, you may need to -# uncomment following line to support viaIdentity for these post APIs -# identity-correction-for-post: true - -# For new modules, please avoid setting 3.x using the use-extension method and instead, use 4.x as the default option -use-extension: - "@autorest/powershell": "3.x" - directive: - # Following is two common directive which are normally required in all the RPs - # 1. Remove the unexpanded parameter set - # 2. For New-* cmdlets, ViaIdentity is not required, so CreateViaIdentityExpanded is removed as well - where: - variant: ^Create$|^CreateViaIdentity$|^CreateViaIdentityExpanded$|^Update$|^UpdateViaIdentity$ + variant: ^(Create|Update|Regenerate|Link)(?!.*?(Expanded|JsonFilePath|JsonString)) + remove: true + - where: + variant: ^CreateViaIdentity$|^CreateViaIdentityExpanded$|^RegenerateViaIdentity$|^RegenerateViaIdentityExpanded$ remove: true # Remove the set-* cmdlet - where: diff --git a/src/Communication/Communication.Autorest/docs/Az.Communication.md b/src/Communication/Communication.Autorest/docs/Az.Communication.md index 0a92c88e8e6d..4bf038d2c7fe 100644 --- a/src/Communication/Communication.Autorest/docs/Az.Communication.md +++ b/src/Communication/Communication.Autorest/docs/Az.Communication.md @@ -1,6 +1,6 @@ --- Module Name: Az.Communication -Module Guid: 32c4dede-9b85-43d4-83ab-447e2938c400 +Module Guid: 669fb84c-45ab-4b4d-8d73-1f2418b8df76 Download Help Link: https://learn.microsoft.com/powershell/module/az.communication Help Version: 1.0.0.0 Locale: en-US @@ -18,7 +18,7 @@ Get the CommunicationService and its properties. Get the access keys of the CommunicationService resource. ### [New-AzCommunicationService](New-AzCommunicationService.md) -Create a new CommunicationService or update an existing CommunicationService. +create a new CommunicationService or create an existing CommunicationService. ### [New-AzCommunicationServiceKey](New-AzCommunicationServiceKey.md) Regenerate CommunicationService access key. @@ -34,5 +34,5 @@ Links an Azure Notification Hub to this communication service. Checks that the CommunicationService name is valid and is not already in use. ### [Update-AzCommunicationService](Update-AzCommunicationService.md) -Operation to update an existing CommunicationService. +update a new CommunicationService or update an existing CommunicationService. diff --git a/src/Communication/Communication.Autorest/docs/Get-AzCommunicationService.md b/src/Communication/Communication.Autorest/docs/Get-AzCommunicationService.md index d982cc1d31f2..27b74d28ff71 100644 --- a/src/Communication/Communication.Autorest/docs/Get-AzCommunicationService.md +++ b/src/Communication/Communication.Autorest/docs/Get-AzCommunicationService.md @@ -90,7 +90,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.Communication.Models.ICommunicationIdentity @@ -160,7 +159,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Communication.Models.Api20230601Preview.ICommunicationServiceResource +### Microsoft.Azure.PowerShell.Cmdlets.Communication.Models.ICommunicationServiceResource ## NOTES diff --git a/src/Communication/Communication.Autorest/docs/Get-AzCommunicationServiceKey.md b/src/Communication/Communication.Autorest/docs/Get-AzCommunicationServiceKey.md index 75d08448e13c..ef99210cbd69 100644 --- a/src/Communication/Communication.Autorest/docs/Get-AzCommunicationServiceKey.md +++ b/src/Communication/Communication.Autorest/docs/Get-AzCommunicationServiceKey.md @@ -138,7 +138,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Communication.Models.Api20230601Preview.ICommunicationServiceKeys +### Microsoft.Azure.PowerShell.Cmdlets.Communication.Models.ICommunicationServiceKeys ## NOTES diff --git a/src/Communication/Communication.Autorest/docs/New-AzCommunicationService.md b/src/Communication/Communication.Autorest/docs/New-AzCommunicationService.md index 2a841245436f..2935f7ec2495 100644 --- a/src/Communication/Communication.Autorest/docs/New-AzCommunicationService.md +++ b/src/Communication/Communication.Autorest/docs/New-AzCommunicationService.md @@ -8,19 +8,34 @@ schema: 2.0.0 # New-AzCommunicationService ## SYNOPSIS -Create a new CommunicationService or update an existing CommunicationService. +create a new CommunicationService or create an existing CommunicationService. ## SYNTAX +### CreateExpanded (Default) ``` New-AzCommunicationService -Name -ResourceGroupName -Location - [-SubscriptionId ] [-DataLocation ] [-IdentityType ] - [-IdentityUserAssignedIdentity ] [-LinkedDomain ] [-Tag ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] + [-SubscriptionId ] [-DataLocation ] [-EnableSystemAssignedIdentity] + [-LinkedDomain ] [-Tag ] [-UserAssignedIdentity ] [-DefaultProfile ] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] +``` + +### CreateViaJsonFilePath +``` +New-AzCommunicationService -Name -ResourceGroupName -JsonFilePath + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] +``` + +### CreateViaJsonString +``` +New-AzCommunicationService -Name -ResourceGroupName -JsonString + [-SubscriptionId ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] + [] ``` ## DESCRIPTION -Create a new CommunicationService or update an existing CommunicationService. +create a new CommunicationService or create an existing CommunicationService. ## EXAMPLES @@ -76,7 +91,7 @@ The location where the communication service stores its data at rest. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded Aliases: Required: False @@ -102,12 +117,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IdentityType -Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). +### -EnableSystemAssignedIdentity +Determines whether to enable a system-assigned identity for the resource. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Communication.Support.ManagedServiceIdentityType -Parameter Sets: (All) +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateExpanded Aliases: Required: False @@ -117,17 +132,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IdentityUserAssignedIdentity -The set of user assigned identities associated with the resource. -The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. -The dictionary values can be empty objects ({}) in requests. +### -JsonFilePath +Path of Json file supplied to the Create operation ```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) +Type: System.String +Parameter Sets: CreateViaJsonFilePath Aliases: -Required: False +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonString +Aliases: + +Required: True Position: Named Default value: None Accept pipeline input: False @@ -139,7 +167,7 @@ List of email Domain resource Ids. ```yaml Type: System.String[] -Parameter Sets: (All) +Parameter Sets: CreateExpanded Aliases: Required: False @@ -154,7 +182,7 @@ The geo-location where the resource lives ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded Aliases: Required: True @@ -231,7 +259,23 @@ Resource tags. ```yaml Type: System.Collections.Hashtable -Parameter Sets: (All) +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentity +The array of user assigned identities associated with the resource. +The elements in array will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.' + +```yaml +Type: System.String[] +Parameter Sets: CreateExpanded Aliases: Required: False @@ -279,7 +323,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Communication.Models.Api20230601Preview.ICommunicationServiceResource +### Microsoft.Azure.PowerShell.Cmdlets.Communication.Models.ICommunicationServiceResource ## NOTES diff --git a/src/Communication/Communication.Autorest/docs/New-AzCommunicationServiceKey.md b/src/Communication/Communication.Autorest/docs/New-AzCommunicationServiceKey.md index 62653cf33cdd..9473e5368471 100644 --- a/src/Communication/Communication.Autorest/docs/New-AzCommunicationServiceKey.md +++ b/src/Communication/Communication.Autorest/docs/New-AzCommunicationServiceKey.md @@ -16,27 +16,22 @@ PrimaryKey and SecondaryKey cannot be regenerated at the same time. ### RegenerateExpanded (Default) ``` New-AzCommunicationServiceKey -CommunicationServiceName -ResourceGroupName - [-SubscriptionId ] [-KeyType ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [-SubscriptionId ] [-KeyType ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] ``` -### Regenerate +### RegenerateViaJsonFilePath ``` New-AzCommunicationServiceKey -CommunicationServiceName -ResourceGroupName - -Parameter [-SubscriptionId ] [-DefaultProfile ] [-Confirm] - [-WhatIf] [] -``` - -### RegenerateViaIdentity -``` -New-AzCommunicationServiceKey -InputObject -Parameter - [-DefaultProfile ] [-Confirm] [-WhatIf] [] + -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] ``` -### RegenerateViaIdentityExpanded +### RegenerateViaJsonString ``` -New-AzCommunicationServiceKey -InputObject [-KeyType ] - [-DefaultProfile ] [-Confirm] [-WhatIf] [] +New-AzCommunicationServiceKey -CommunicationServiceName -ResourceGroupName + -JsonString [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] ``` ## DESCRIPTION @@ -78,7 +73,7 @@ The name of the CommunicationService resource. ```yaml Type: System.String -Parameter Sets: Regenerate, RegenerateExpanded +Parameter Sets: (All) Aliases: Required: True @@ -104,51 +99,49 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. +### -JsonFilePath +Path of Json file supplied to the Regenerate operation ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Communication.Models.ICommunicationIdentity -Parameter Sets: RegenerateViaIdentity, RegenerateViaIdentityExpanded +Type: System.String +Parameter Sets: RegenerateViaJsonFilePath Aliases: Required: True Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -KeyType -The keyType to regenerate. -Must be either 'primary' or 'secondary'(case-insensitive). +### -JsonString +Json string supplied to the Regenerate operation ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Communication.Support.KeyType -Parameter Sets: RegenerateExpanded, RegenerateViaIdentityExpanded +Type: System.String +Parameter Sets: RegenerateViaJsonString Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Parameter -Parameters describes the request to regenerate access keys -To construct, see NOTES section for PARAMETER properties and create a hash table. +### -KeyType +The keyType to regenerate. +Must be either 'primary' or 'secondary'(case-insensitive). ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Communication.Models.Api20230601Preview.IRegenerateKeyParameters -Parameter Sets: Regenerate, RegenerateViaIdentity +Type: System.String +Parameter Sets: RegenerateExpanded Aliases: -Required: True +Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` @@ -158,7 +151,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: Regenerate, RegenerateExpanded +Parameter Sets: (All) Aliases: Required: True @@ -174,7 +167,7 @@ The value must be an UUID. ```yaml Type: System.String -Parameter Sets: Regenerate, RegenerateExpanded +Parameter Sets: (All) Aliases: Required: False @@ -220,13 +213,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Communication.Models.Api20230601Preview.IRegenerateKeyParameters - -### Microsoft.Azure.PowerShell.Cmdlets.Communication.Models.ICommunicationIdentity - ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Communication.Models.Api20230601Preview.ICommunicationServiceKeys +### Microsoft.Azure.PowerShell.Cmdlets.Communication.Models.ICommunicationServiceKeys ## NOTES diff --git a/src/Communication/Communication.Autorest/docs/Remove-AzCommunicationService.md b/src/Communication/Communication.Autorest/docs/Remove-AzCommunicationService.md index 5d75cd05edd3..91a0ec459dcf 100644 --- a/src/Communication/Communication.Autorest/docs/Remove-AzCommunicationService.md +++ b/src/Communication/Communication.Autorest/docs/Remove-AzCommunicationService.md @@ -71,7 +71,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.Communication.Models.ICommunicationIdentity diff --git a/src/Communication/Communication.Autorest/docs/Set-AzCommunicationServiceNotificationHub.md b/src/Communication/Communication.Autorest/docs/Set-AzCommunicationServiceNotificationHub.md index 91ee6fa89202..15e02cf1a7da 100644 --- a/src/Communication/Communication.Autorest/docs/Set-AzCommunicationServiceNotificationHub.md +++ b/src/Communication/Communication.Autorest/docs/Set-AzCommunicationServiceNotificationHub.md @@ -15,15 +15,22 @@ Links an Azure Notification Hub to this communication service. ### LinkExpanded (Default) ``` Set-AzCommunicationServiceNotificationHub -CommunicationServiceName -ResourceGroupName - -ConnectionString -NotificationHubResourceId [-SubscriptionId ] + [-SubscriptionId ] [-ConnectionString ] [-NotificationHubResourceId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] ``` -### Link +### LinkViaJsonFilePath ``` Set-AzCommunicationServiceNotificationHub -CommunicationServiceName -ResourceGroupName - -LinkNotificationHubParameter [-SubscriptionId ] - [-DefaultProfile ] [-Confirm] [-WhatIf] [] + -JsonFilePath [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] +``` + +### LinkViaJsonString +``` +Set-AzCommunicationServiceNotificationHub -CommunicationServiceName -ResourceGroupName + -JsonString [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [] ``` ## DESCRIPTION @@ -63,7 +70,7 @@ Type: System.String Parameter Sets: LinkExpanded Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -86,19 +93,33 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LinkNotificationHubParameter -Description of an Azure Notification Hub to link to the communication service -To construct, see NOTES section for LINKNOTIFICATIONHUBPARAMETER properties and create a hash table. +### -JsonFilePath +Path of Json file supplied to the Link operation + +```yaml +Type: System.String +Parameter Sets: LinkViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Link operation ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Communication.Models.Api20230601Preview.ILinkNotificationHubParameters -Parameter Sets: Link +Type: System.String +Parameter Sets: LinkViaJsonString Aliases: Required: True Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` @@ -110,7 +131,7 @@ Type: System.String Parameter Sets: LinkExpanded Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -185,11 +206,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Communication.Models.Api20230601Preview.ILinkNotificationHubParameters - ## OUTPUTS -### System.String +### Microsoft.Azure.PowerShell.Cmdlets.Communication.Models.ILinkedNotificationHub ## NOTES diff --git a/src/Communication/Communication.Autorest/docs/Test-AzCommunicationServiceNameAvailability.md b/src/Communication/Communication.Autorest/docs/Test-AzCommunicationServiceNameAvailability.md index 05a10c882fa7..1dfd8d82d25f 100644 --- a/src/Communication/Communication.Autorest/docs/Test-AzCommunicationServiceNameAvailability.md +++ b/src/Communication/Communication.Autorest/docs/Test-AzCommunicationServiceNameAvailability.md @@ -12,11 +12,24 @@ Checks that the CommunicationService name is valid and is not already in use. ## SYNTAX +### CheckExpanded (Default) ``` Test-AzCommunicationServiceNameAvailability -Name [-SubscriptionId ] [-DefaultProfile ] [-Confirm] [-WhatIf] [] ``` +### CheckViaJsonFilePath +``` +Test-AzCommunicationServiceNameAvailability -JsonFilePath [-SubscriptionId ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + +### CheckViaJsonString +``` +Test-AzCommunicationServiceNameAvailability -JsonString [-SubscriptionId ] + [-DefaultProfile ] [-Confirm] [-WhatIf] [] +``` + ## DESCRIPTION Checks that the CommunicationService name is valid and is not already in use. @@ -66,12 +79,42 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the Check operation + +```yaml +Type: System.String +Parameter Sets: CheckViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Check operation + +```yaml +Type: System.String +Parameter Sets: CheckViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name The name of the resource for which availability needs to be checked. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CheckExpanded Aliases: Required: True @@ -135,7 +178,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Communication.Models.Api40.ICheckNameAvailabilityResponse +### Microsoft.Azure.PowerShell.Cmdlets.Communication.Models.ICheckNameAvailabilityResponse ## NOTES diff --git a/src/Communication/Communication.Autorest/docs/Update-AzCommunicationService.md b/src/Communication/Communication.Autorest/docs/Update-AzCommunicationService.md index fbdbff690887..1011a1103938 100644 --- a/src/Communication/Communication.Autorest/docs/Update-AzCommunicationService.md +++ b/src/Communication/Communication.Autorest/docs/Update-AzCommunicationService.md @@ -8,28 +8,27 @@ schema: 2.0.0 # Update-AzCommunicationService ## SYNOPSIS -Operation to update an existing CommunicationService. +update a new CommunicationService or update an existing CommunicationService. ## SYNTAX ### UpdateExpanded (Default) ``` Update-AzCommunicationService -Name -ResourceGroupName [-SubscriptionId ] - [-IdentityType ] [-IdentityUserAssignedIdentity ] - [-LinkedDomain ] [-Tag ] [-DefaultProfile ] [-Confirm] [-WhatIf] + [-EnableSystemAssignedIdentity ] [-LinkedDomain ] [-Tag ] + [-UserAssignedIdentity ] [-DefaultProfile ] [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] ``` ### UpdateViaIdentityExpanded ``` -Update-AzCommunicationService -InputObject - [-IdentityType ] [-IdentityUserAssignedIdentity ] - [-LinkedDomain ] [-Tag ] [-DefaultProfile ] [-Confirm] [-WhatIf] - [] +Update-AzCommunicationService -InputObject [-EnableSystemAssignedIdentity ] + [-LinkedDomain ] [-Tag ] [-UserAssignedIdentity ] [-DefaultProfile ] + [-AsJob] [-NoWait] [-Confirm] [-WhatIf] [] ``` ## DESCRIPTION -Operation to update an existing CommunicationService. +update a new CommunicationService or update an existing CommunicationService. ## EXAMPLES @@ -65,14 +64,13 @@ Attaches the given tags and links the doamin to the specified ACS resource. ## PARAMETERS -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. +### -AsJob +Run the command as a job ```yaml -Type: System.Management.Automation.PSObject +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential +Aliases: Required: False Position: Named @@ -81,13 +79,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IdentityType -Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Communication.Support.ManagedServiceIdentityType +Type: System.Management.Automation.PSObject Parameter Sets: (All) -Aliases: +Aliases: AzureRMContext, AzureCredential Required: False Position: Named @@ -96,13 +95,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IdentityUserAssignedIdentity -The set of user assigned identities associated with the resource. -The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. -The dictionary values can be empty objects ({}) in requests. +### -EnableSystemAssignedIdentity +Determines whether to enable a system-assigned identity for the resource. ```yaml -Type: System.Collections.Hashtable +Type: System.Nullable`1[[System.Boolean, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] Parameter Sets: (All) Aliases: @@ -115,7 +112,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.Communication.Models.ICommunicationIdentity @@ -159,6 +155,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +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. @@ -192,7 +203,7 @@ Accept wildcard characters: False ``` ### -Tag -Tags of the service which is a list of key value pairs that describe the resource. +Resource tags. ```yaml Type: System.Collections.Hashtable @@ -206,6 +217,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -UserAssignedIdentity +The array of user assigned identities associated with the resource. +The elements in array will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.' + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Confirm Prompts you for confirmation before running the cmdlet. @@ -246,7 +273,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Communication.Models.Api20230601Preview.ICommunicationServiceResource +### Microsoft.Azure.PowerShell.Cmdlets.Communication.Models.ICommunicationServiceResource ## NOTES diff --git a/src/Communication/Communication.Autorest/generate-info.json b/src/Communication/Communication.Autorest/generate-info.json index 6a74cb79760e..6723231ee82b 100644 --- a/src/Communication/Communication.Autorest/generate-info.json +++ b/src/Communication/Communication.Autorest/generate-info.json @@ -1,3 +1,3 @@ { - "generate_Id": "4405bc8b-161b-4247-ba2f-e092faf5af6f" + "generate_Id": "1b704d56-88ac-41b0-a6dd-671a77f39a20" } diff --git a/src/Communication/Communication.Autorest/resources/README.md b/src/Communication/Communication.Autorest/resources/README.md new file mode 100644 index 000000000000..937f07f8fec2 --- /dev/null +++ b/src/Communication/Communication.Autorest/resources/README.md @@ -0,0 +1,11 @@ +# Resources +This directory can contain any additional resources for module that are not required at runtime. This directory **does not** get packaged with the module. If you have assets for custom implementation, place them into the `..\custom` folder. + +## Info +- Modifiable: yes +- Generated: no +- Committed: yes +- Packaged: no + +## Purpose +Use this folder to put anything you want to keep around as part of the repository for the module, but is not something that is required for the module. For example, development files, packaged builds, or additional information. This is only intended to be used in repositories where the module's output directory is cleaned, but tangential resources for the module want to remain intact. \ No newline at end of file diff --git a/src/Communication/Communication.Autorest/test/New-AzCommunicationServiceKey.Tests.ps1 b/src/Communication/Communication.Autorest/test/New-AzCommunicationServiceKey.Tests.ps1 index 69ade14d7646..be2d153bd4d3 100644 --- a/src/Communication/Communication.Autorest/test/New-AzCommunicationServiceKey.Tests.ps1 +++ b/src/Communication/Communication.Autorest/test/New-AzCommunicationServiceKey.Tests.ps1 @@ -20,7 +20,7 @@ Describe 'New-AzCommunicationServiceKey' { $keys[0].SecondaryKey | Should -Not -Be $keyPair[0].SecondaryKey } - It 'Regenerate' { + It 'Regenerate' -Skip { $keys = New-AzCommunicationServiceKey -CommunicationServiceName $env.persistentResourceName -ResourceGroupName $env.resourceGroup -Parameter @{KeyType="Primary"} $keys[0].PrimaryKey | Should -Not -Be $keyPair[0].PrimaryKey diff --git a/src/Communication/Communication.Autorest/test/Set-AzCommunicationServiceNotificationHub.Tests.ps1 b/src/Communication/Communication.Autorest/test/Set-AzCommunicationServiceNotificationHub.Tests.ps1 index 95226428ab08..28ae568cbb15 100644 --- a/src/Communication/Communication.Autorest/test/Set-AzCommunicationServiceNotificationHub.Tests.ps1 +++ b/src/Communication/Communication.Autorest/test/Set-AzCommunicationServiceNotificationHub.Tests.ps1 @@ -17,7 +17,7 @@ Describe 'Set-AzCommunicationServiceNotificationHub' { $returnedResourceId | Should -Be $env.notificationHubResourceId } - It 'Link' { + It 'Link' -Skip { $returnedResourceId = Set-AzCommunicationServiceNotificationHub -CommunicationServiceName $env.persistentResourceName -ResourceGroupName $env.resourceGroup -LinkNotificationHubParameter @{ConnectionString=$env.notificationHubConnectionString; ResourceId=$env.notificationHubResourceId} $returnedResourceId | Should -Be $env.notificationHubResourceId } diff --git a/src/Communication/Communication.sln b/src/Communication/Communication.sln index 8f786e075575..e4d789c7d659 100644 --- a/src/Communication/Communication.sln +++ b/src/Communication/Communication.sln @@ -19,8 +19,6 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Authenticators", "..\Accoun EndProject Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Communication", "Communication\Communication.csproj", "{BC377B3E-760F-4C72-8E2B-64F295F35AC6}" EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Az.Communication", "..\..\generated\Communication\Communication.Autorest\Az.Communication.csproj", "{E18D84BA-5062-4501-BA00-C338AF217BEB}" -EndProject Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Az.EmailService", "..\..\generated\Communication\EmailService.Autorest\Az.EmailService.csproj", "{5BCC6E35-8357-444D-B68A-6C166C5D4D0B}" EndProject Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Az.EmailServicedata", "..\..\generated\Communication\EmailServicedata.Autorest\Az.EmailServicedata.csproj", "{4668F25E-ECA4-477A-B6C5-B77538DD5A3B}" @@ -29,6 +27,10 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "CommunicationServiceSmtpUse EndProject Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Az.CommunicationServiceSmtpUsername", "..\..\generated\Communication\CommunicationServiceSmtpUsername.Autorest\Az.CommunicationServiceSmtpUsername.csproj", "{E7F84369-DAC3-4224-A420-8F35DCFFD850}" EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Communication.Autorest", "Communication.Autorest", "{BCE3E3DF-E07E-B821-4E48-5392005D2B98}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Az.Communication", "..\..\generated\Communication\Communication.Autorest\Az.Communication.csproj", "{05C21CFD-66D9-4456-9D8C-4C79E5C69867}" +EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution Debug|Any CPU = Debug|Any CPU @@ -123,18 +125,6 @@ Global {BC377B3E-760F-4C72-8E2B-64F295F35AC6}.Release|x64.Build.0 = Release|Any CPU {BC377B3E-760F-4C72-8E2B-64F295F35AC6}.Release|x86.ActiveCfg = Release|Any CPU {BC377B3E-760F-4C72-8E2B-64F295F35AC6}.Release|x86.Build.0 = Release|Any CPU - {E18D84BA-5062-4501-BA00-C338AF217BEB}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {E18D84BA-5062-4501-BA00-C338AF217BEB}.Debug|Any CPU.Build.0 = Debug|Any CPU - {E18D84BA-5062-4501-BA00-C338AF217BEB}.Debug|x64.ActiveCfg = Debug|Any CPU - {E18D84BA-5062-4501-BA00-C338AF217BEB}.Debug|x64.Build.0 = Debug|Any CPU - {E18D84BA-5062-4501-BA00-C338AF217BEB}.Debug|x86.ActiveCfg = Debug|Any CPU - {E18D84BA-5062-4501-BA00-C338AF217BEB}.Debug|x86.Build.0 = Debug|Any CPU - {E18D84BA-5062-4501-BA00-C338AF217BEB}.Release|Any CPU.ActiveCfg = Release|Any CPU - {E18D84BA-5062-4501-BA00-C338AF217BEB}.Release|Any CPU.Build.0 = Release|Any CPU - {E18D84BA-5062-4501-BA00-C338AF217BEB}.Release|x64.ActiveCfg = Release|Any CPU - {E18D84BA-5062-4501-BA00-C338AF217BEB}.Release|x64.Build.0 = Release|Any CPU - {E18D84BA-5062-4501-BA00-C338AF217BEB}.Release|x86.ActiveCfg = Release|Any CPU - {E18D84BA-5062-4501-BA00-C338AF217BEB}.Release|x86.Build.0 = Release|Any CPU {5BCC6E35-8357-444D-B68A-6C166C5D4D0B}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {5BCC6E35-8357-444D-B68A-6C166C5D4D0B}.Debug|Any CPU.Build.0 = Debug|Any CPU {5BCC6E35-8357-444D-B68A-6C166C5D4D0B}.Debug|x64.ActiveCfg = Debug|Any CPU @@ -171,6 +161,18 @@ Global {E7F84369-DAC3-4224-A420-8F35DCFFD850}.Release|x64.Build.0 = Release|Any CPU {E7F84369-DAC3-4224-A420-8F35DCFFD850}.Release|x86.ActiveCfg = Release|Any CPU {E7F84369-DAC3-4224-A420-8F35DCFFD850}.Release|x86.Build.0 = Release|Any CPU + {05C21CFD-66D9-4456-9D8C-4C79E5C69867}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {05C21CFD-66D9-4456-9D8C-4C79E5C69867}.Debug|Any CPU.Build.0 = Debug|Any CPU + {05C21CFD-66D9-4456-9D8C-4C79E5C69867}.Debug|x64.ActiveCfg = Debug|Any CPU + {05C21CFD-66D9-4456-9D8C-4C79E5C69867}.Debug|x64.Build.0 = Debug|Any CPU + {05C21CFD-66D9-4456-9D8C-4C79E5C69867}.Debug|x86.ActiveCfg = Debug|Any CPU + {05C21CFD-66D9-4456-9D8C-4C79E5C69867}.Debug|x86.Build.0 = Debug|Any CPU + {05C21CFD-66D9-4456-9D8C-4C79E5C69867}.Release|Any CPU.ActiveCfg = Release|Any CPU + {05C21CFD-66D9-4456-9D8C-4C79E5C69867}.Release|Any CPU.Build.0 = Release|Any CPU + {05C21CFD-66D9-4456-9D8C-4C79E5C69867}.Release|x64.ActiveCfg = Release|Any CPU + {05C21CFD-66D9-4456-9D8C-4C79E5C69867}.Release|x64.Build.0 = Release|Any CPU + {05C21CFD-66D9-4456-9D8C-4C79E5C69867}.Release|x86.ActiveCfg = Release|Any CPU + {05C21CFD-66D9-4456-9D8C-4C79E5C69867}.Release|x86.Build.0 = Release|Any CPU EndGlobalSection GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE @@ -183,5 +185,6 @@ Global {63065A51-3037-4C14-B1B8-B626B5F3B2B5} = {8C6025CF-0F63-49CE-8FBE-8275AFC0AD14} {273AA0BD-A4B9-45CF-86E6-898B6F7F4B80} = {8C6025CF-0F63-49CE-8FBE-8275AFC0AD14} {E7F84369-DAC3-4224-A420-8F35DCFFD850} = {363A57FD-EAEB-6866-1998-C16C508A4822} + {05C21CFD-66D9-4456-9D8C-4C79E5C69867} = {BCE3E3DF-E07E-B821-4E48-5392005D2B98} EndGlobalSection EndGlobal diff --git a/src/Communication/Communication/Az.Communication.psd1 b/src/Communication/Communication/Az.Communication.psd1 index c9d2581447ca..9c30ec42da0e 100644 --- a/src/Communication/Communication/Az.Communication.psd1 +++ b/src/Communication/Communication/Az.Communication.psd1 @@ -3,7 +3,7 @@ # # Generated by: Microsoft Corporation # -# Generated on: 3/31/2025 +# Generated on: 2025-04-11 # @{ diff --git a/src/Communication/Communication/ChangeLog.md b/src/Communication/Communication/ChangeLog.md index 71f49dcc6ca0..7be29b83449f 100644 --- a/src/Communication/Communication/ChangeLog.md +++ b/src/Communication/Communication/ChangeLog.md @@ -18,6 +18,7 @@ - Additional information about change #1 --> ## Upcoming Release +* Introduced various new features by upgrading code generator. Please see detail [here](https://github.com/Azure/azure-powershell/blob/main/documentation/Autorest-powershell-v4-new-features.md). * First preview release for module Az.CommunicationServiceSmtpUsername ## Version 0.4.2 diff --git a/src/Communication/Communication/help/Az.Communication.md b/src/Communication/Communication/help/Az.Communication.md index 04f1cb9a65d5..11ff6ab71d7a 100644 --- a/src/Communication/Communication/help/Az.Communication.md +++ b/src/Communication/Communication/help/Az.Communication.md @@ -36,7 +36,7 @@ Get a valid sender username for a domains resource. Initiate verification of DNS record. ### [New-AzCommunicationService](New-AzCommunicationService.md) -Create a new CommunicationService or update an existing CommunicationService. +create a new CommunicationService or create an existing CommunicationService. ### [New-AzCommunicationServiceKey](New-AzCommunicationServiceKey.md) Regenerate CommunicationService access key. @@ -82,7 +82,7 @@ Cancel verification of DNS record. Checks that the CommunicationService name is valid and is not already in use. ### [Update-AzCommunicationService](Update-AzCommunicationService.md) -Operation to update an existing CommunicationService. +update a new CommunicationService or update an existing CommunicationService. ### [Update-AzCommunicationServiceSmtpUsername](Update-AzCommunicationServiceSmtpUsername.md) update an SmtpUsernameResource. diff --git a/src/Communication/Communication/help/Get-AzCommunicationService.md b/src/Communication/Communication/help/Get-AzCommunicationService.md index 26f7cb4a7ff4..ee1e885ba287 100644 --- a/src/Communication/Communication/help/Get-AzCommunicationService.md +++ b/src/Communication/Communication/help/Get-AzCommunicationService.md @@ -91,7 +91,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.Communication.Models.ICommunicationIdentity @@ -161,7 +160,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Communication.Models.Api20230601Preview.ICommunicationServiceResource +### Microsoft.Azure.PowerShell.Cmdlets.Communication.Models.ICommunicationServiceResource ## NOTES diff --git a/src/Communication/Communication/help/Get-AzCommunicationServiceKey.md b/src/Communication/Communication/help/Get-AzCommunicationServiceKey.md index c77e594c7f19..3053ebd4695c 100644 --- a/src/Communication/Communication/help/Get-AzCommunicationServiceKey.md +++ b/src/Communication/Communication/help/Get-AzCommunicationServiceKey.md @@ -139,7 +139,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Communication.Models.Api20230601Preview.ICommunicationServiceKeys +### Microsoft.Azure.PowerShell.Cmdlets.Communication.Models.ICommunicationServiceKeys ## NOTES diff --git a/src/Communication/Communication/help/New-AzCommunicationService.md b/src/Communication/Communication/help/New-AzCommunicationService.md index 38b7be1f3d4b..6b1f29159d8e 100644 --- a/src/Communication/Communication/help/New-AzCommunicationService.md +++ b/src/Communication/Communication/help/New-AzCommunicationService.md @@ -8,20 +8,34 @@ schema: 2.0.0 # New-AzCommunicationService ## SYNOPSIS -Create a new CommunicationService or update an existing CommunicationService. +create a new CommunicationService or create an existing CommunicationService. ## SYNTAX +### CreateExpanded (Default) ``` New-AzCommunicationService -Name -ResourceGroupName [-SubscriptionId ] - -Location [-DataLocation ] [-IdentityType ] - [-IdentityUserAssignedIdentity ] [-LinkedDomain ] [-Tag ] - [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] - [] + -Location [-DataLocation ] [-EnableSystemAssignedIdentity] [-LinkedDomain ] + [-Tag ] [-UserAssignedIdentity ] [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### CreateViaJsonFilePath +``` +New-AzCommunicationService -Name -ResourceGroupName [-SubscriptionId ] + -JsonFilePath [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] +``` + +### CreateViaJsonString +``` +New-AzCommunicationService -Name -ResourceGroupName [-SubscriptionId ] + -JsonString [-DefaultProfile ] [-AsJob] [-NoWait] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -Create a new CommunicationService or update an existing CommunicationService. +create a new CommunicationService or create an existing CommunicationService. ## EXAMPLES @@ -77,7 +91,7 @@ The location where the communication service stores its data at rest. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded Aliases: Required: False @@ -103,12 +117,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IdentityType -Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). +### -EnableSystemAssignedIdentity +Determines whether to enable a system-assigned identity for the resource. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Communication.Support.ManagedServiceIdentityType -Parameter Sets: (All) +Type: System.Management.Automation.SwitchParameter +Parameter Sets: CreateExpanded Aliases: Required: False @@ -118,17 +132,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IdentityUserAssignedIdentity -The set of user assigned identities associated with the resource. -The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. -The dictionary values can be empty objects ({}) in requests. +### -JsonFilePath +Path of Json file supplied to the Create operation ```yaml -Type: System.Collections.Hashtable -Parameter Sets: (All) +Type: System.String +Parameter Sets: CreateViaJsonFilePath Aliases: -Required: False +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Create operation + +```yaml +Type: System.String +Parameter Sets: CreateViaJsonString +Aliases: + +Required: True Position: Named Default value: None Accept pipeline input: False @@ -140,7 +167,7 @@ List of email Domain resource Ids. ```yaml Type: System.String[] -Parameter Sets: (All) +Parameter Sets: CreateExpanded Aliases: Required: False @@ -155,7 +182,7 @@ The geo-location where the resource lives ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CreateExpanded Aliases: Required: True @@ -232,7 +259,23 @@ Resource tags. ```yaml Type: System.Collections.Hashtable -Parameter Sets: (All) +Parameter Sets: CreateExpanded +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserAssignedIdentity +The array of user assigned identities associated with the resource. +The elements in array will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.' + +```yaml +Type: System.String[] +Parameter Sets: CreateExpanded Aliases: Required: False @@ -280,7 +323,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Communication.Models.Api20230601Preview.ICommunicationServiceResource +### Microsoft.Azure.PowerShell.Cmdlets.Communication.Models.ICommunicationServiceResource ## NOTES diff --git a/src/Communication/Communication/help/New-AzCommunicationServiceKey.md b/src/Communication/Communication/help/New-AzCommunicationServiceKey.md index 22d3fc4745f0..b27e819d8b65 100644 --- a/src/Communication/Communication/help/New-AzCommunicationServiceKey.md +++ b/src/Communication/Communication/help/New-AzCommunicationServiceKey.md @@ -16,27 +16,22 @@ PrimaryKey and SecondaryKey cannot be regenerated at the same time. ### RegenerateExpanded (Default) ``` New-AzCommunicationServiceKey -CommunicationServiceName -ResourceGroupName - [-SubscriptionId ] [-KeyType ] [-DefaultProfile ] + [-SubscriptionId ] [-KeyType ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` -### Regenerate +### RegenerateViaJsonFilePath ``` New-AzCommunicationServiceKey -CommunicationServiceName -ResourceGroupName - [-SubscriptionId ] -Parameter [-DefaultProfile ] + [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` -### RegenerateViaIdentityExpanded +### RegenerateViaJsonString ``` -New-AzCommunicationServiceKey -InputObject [-KeyType ] - [-DefaultProfile ] [-WhatIf] [-Confirm] [] -``` - -### RegenerateViaIdentity -``` -New-AzCommunicationServiceKey -InputObject -Parameter - [-DefaultProfile ] [-WhatIf] [-Confirm] [] +New-AzCommunicationServiceKey -CommunicationServiceName -ResourceGroupName + [-SubscriptionId ] -JsonString [-DefaultProfile ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -78,7 +73,7 @@ The name of the CommunicationService resource. ```yaml Type: System.String -Parameter Sets: RegenerateExpanded, Regenerate +Parameter Sets: (All) Aliases: Required: True @@ -104,51 +99,49 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InputObject -Identity Parameter -To construct, see NOTES section for INPUTOBJECT properties and create a hash table. +### -JsonFilePath +Path of Json file supplied to the Regenerate operation ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Communication.Models.ICommunicationIdentity -Parameter Sets: RegenerateViaIdentityExpanded, RegenerateViaIdentity +Type: System.String +Parameter Sets: RegenerateViaJsonFilePath Aliases: Required: True Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -KeyType -The keyType to regenerate. -Must be either 'primary' or 'secondary'(case-insensitive). +### -JsonString +Json string supplied to the Regenerate operation ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Communication.Support.KeyType -Parameter Sets: RegenerateExpanded, RegenerateViaIdentityExpanded +Type: System.String +Parameter Sets: RegenerateViaJsonString Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Parameter -Parameters describes the request to regenerate access keys -To construct, see NOTES section for PARAMETER properties and create a hash table. +### -KeyType +The keyType to regenerate. +Must be either 'primary' or 'secondary'(case-insensitive). ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Communication.Models.Api20230601Preview.IRegenerateKeyParameters -Parameter Sets: Regenerate, RegenerateViaIdentity +Type: System.String +Parameter Sets: RegenerateExpanded Aliases: -Required: True +Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` @@ -158,7 +151,7 @@ The name is case insensitive. ```yaml Type: System.String -Parameter Sets: RegenerateExpanded, Regenerate +Parameter Sets: (All) Aliases: Required: True @@ -174,7 +167,7 @@ The value must be an UUID. ```yaml Type: System.String -Parameter Sets: RegenerateExpanded, Regenerate +Parameter Sets: (All) Aliases: Required: False @@ -220,13 +213,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Communication.Models.Api20230601Preview.IRegenerateKeyParameters - -### Microsoft.Azure.PowerShell.Cmdlets.Communication.Models.ICommunicationIdentity - ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Communication.Models.Api20230601Preview.ICommunicationServiceKeys +### Microsoft.Azure.PowerShell.Cmdlets.Communication.Models.ICommunicationServiceKeys ## NOTES diff --git a/src/Communication/Communication/help/Remove-AzCommunicationService.md b/src/Communication/Communication/help/Remove-AzCommunicationService.md index 8c14a8b76b3d..5d45c87db897 100644 --- a/src/Communication/Communication/help/Remove-AzCommunicationService.md +++ b/src/Communication/Communication/help/Remove-AzCommunicationService.md @@ -72,7 +72,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.Communication.Models.ICommunicationIdentity diff --git a/src/Communication/Communication/help/Set-AzCommunicationServiceNotificationHub.md b/src/Communication/Communication/help/Set-AzCommunicationServiceNotificationHub.md index 056778f0a599..fcec0f42cca0 100644 --- a/src/Communication/Communication/help/Set-AzCommunicationServiceNotificationHub.md +++ b/src/Communication/Communication/help/Set-AzCommunicationServiceNotificationHub.md @@ -15,15 +15,22 @@ Links an Azure Notification Hub to this communication service. ### LinkExpanded (Default) ``` Set-AzCommunicationServiceNotificationHub -CommunicationServiceName -ResourceGroupName - [-SubscriptionId ] -ConnectionString -NotificationHubResourceId + [-SubscriptionId ] [-ConnectionString ] [-NotificationHubResourceId ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` -### Link +### LinkViaJsonFilePath ``` Set-AzCommunicationServiceNotificationHub -CommunicationServiceName -ResourceGroupName - [-SubscriptionId ] -LinkNotificationHubParameter - [-DefaultProfile ] [-WhatIf] [-Confirm] [] + [-SubscriptionId ] -JsonFilePath [-DefaultProfile ] + [-WhatIf] [-Confirm] [] +``` + +### LinkViaJsonString +``` +Set-AzCommunicationServiceNotificationHub -CommunicationServiceName -ResourceGroupName + [-SubscriptionId ] -JsonString [-DefaultProfile ] + [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -63,7 +70,7 @@ Type: System.String Parameter Sets: LinkExpanded Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -86,19 +93,33 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LinkNotificationHubParameter -Description of an Azure Notification Hub to link to the communication service -To construct, see NOTES section for LINKNOTIFICATIONHUBPARAMETER properties and create a hash table. +### -JsonFilePath +Path of Json file supplied to the Link operation + +```yaml +Type: System.String +Parameter Sets: LinkViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Link operation ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Communication.Models.Api20230601Preview.ILinkNotificationHubParameters -Parameter Sets: Link +Type: System.String +Parameter Sets: LinkViaJsonString Aliases: Required: True Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` @@ -110,7 +131,7 @@ Type: System.String Parameter Sets: LinkExpanded Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -185,11 +206,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Communication.Models.Api20230601Preview.ILinkNotificationHubParameters - ## OUTPUTS -### System.String +### Microsoft.Azure.PowerShell.Cmdlets.Communication.Models.ILinkedNotificationHub ## NOTES diff --git a/src/Communication/Communication/help/Test-AzCommunicationServiceNameAvailability.md b/src/Communication/Communication/help/Test-AzCommunicationServiceNameAvailability.md index 0cc250080435..a238cae30af3 100644 --- a/src/Communication/Communication/help/Test-AzCommunicationServiceNameAvailability.md +++ b/src/Communication/Communication/help/Test-AzCommunicationServiceNameAvailability.md @@ -12,11 +12,24 @@ Checks that the CommunicationService name is valid and is not already in use. ## SYNTAX +### CheckExpanded (Default) ``` Test-AzCommunicationServiceNameAvailability [-SubscriptionId ] -Name [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` +### CheckViaJsonFilePath +``` +Test-AzCommunicationServiceNameAvailability [-SubscriptionId ] -JsonFilePath + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + +### CheckViaJsonString +``` +Test-AzCommunicationServiceNameAvailability [-SubscriptionId ] -JsonString + [-DefaultProfile ] [-WhatIf] [-Confirm] [] +``` + ## DESCRIPTION Checks that the CommunicationService name is valid and is not already in use. @@ -66,12 +79,42 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -JsonFilePath +Path of Json file supplied to the Check operation + +```yaml +Type: System.String +Parameter Sets: CheckViaJsonFilePath +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -JsonString +Json string supplied to the Check operation + +```yaml +Type: System.String +Parameter Sets: CheckViaJsonString +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name The name of the resource for which availability needs to be checked. ```yaml Type: System.String -Parameter Sets: (All) +Parameter Sets: CheckExpanded Aliases: Required: True @@ -135,7 +178,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Communication.Models.Api40.ICheckNameAvailabilityResponse +### Microsoft.Azure.PowerShell.Cmdlets.Communication.Models.ICheckNameAvailabilityResponse ## NOTES diff --git a/src/Communication/Communication/help/Update-AzCommunicationService.md b/src/Communication/Communication/help/Update-AzCommunicationService.md index f6678390489d..00dac0bd21f2 100644 --- a/src/Communication/Communication/help/Update-AzCommunicationService.md +++ b/src/Communication/Communication/help/Update-AzCommunicationService.md @@ -8,28 +8,27 @@ schema: 2.0.0 # Update-AzCommunicationService ## SYNOPSIS -Operation to update an existing CommunicationService. +update a new CommunicationService or update an existing CommunicationService. ## SYNTAX ### UpdateExpanded (Default) ``` Update-AzCommunicationService -Name -ResourceGroupName [-SubscriptionId ] - [-IdentityType ] [-IdentityUserAssignedIdentity ] - [-LinkedDomain ] [-Tag ] [-DefaultProfile ] + [-EnableSystemAssignedIdentity ] [-LinkedDomain ] [-Tag ] + [-UserAssignedIdentity ] [-DefaultProfile ] [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] ``` ### UpdateViaIdentityExpanded ``` -Update-AzCommunicationService -InputObject - [-IdentityType ] [-IdentityUserAssignedIdentity ] - [-LinkedDomain ] [-Tag ] [-DefaultProfile ] - [-WhatIf] [-Confirm] [] +Update-AzCommunicationService -InputObject [-EnableSystemAssignedIdentity ] + [-LinkedDomain ] [-Tag ] [-UserAssignedIdentity ] [-DefaultProfile ] + [-AsJob] [-NoWait] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -Operation to update an existing CommunicationService. +update a new CommunicationService or update an existing CommunicationService. ## EXAMPLES @@ -65,14 +64,13 @@ Attaches the given tags and links the doamin to the specified ACS resource. ## PARAMETERS -### -DefaultProfile -The DefaultProfile parameter is not functional. -Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. +### -AsJob +Run the command as a job ```yaml -Type: System.Management.Automation.PSObject +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) -Aliases: AzureRMContext, AzureCredential +Aliases: Required: False Position: Named @@ -81,13 +79,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IdentityType -Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). +### -DefaultProfile +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml -Type: Microsoft.Azure.PowerShell.Cmdlets.Communication.Support.ManagedServiceIdentityType +Type: System.Management.Automation.PSObject Parameter Sets: (All) -Aliases: +Aliases: AzureRMContext, AzureCredential Required: False Position: Named @@ -96,13 +95,11 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IdentityUserAssignedIdentity -The set of user assigned identities associated with the resource. -The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. -The dictionary values can be empty objects ({}) in requests. +### -EnableSystemAssignedIdentity +Determines whether to enable a system-assigned identity for the resource. ```yaml -Type: System.Collections.Hashtable +Type: System.Nullable`1[System.Boolean] Parameter Sets: (All) Aliases: @@ -115,7 +112,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.Communication.Models.ICommunicationIdentity @@ -159,6 +155,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -NoWait +Run the command asynchronously + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +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. @@ -192,7 +203,7 @@ Accept wildcard characters: False ``` ### -Tag -Tags of the service which is a list of key value pairs that describe the resource. +Resource tags. ```yaml Type: System.Collections.Hashtable @@ -206,6 +217,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -UserAssignedIdentity +The array of user assigned identities associated with the resource. +The elements in array will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.' + +```yaml +Type: System.String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Confirm Prompts you for confirmation before running the cmdlet. @@ -246,7 +273,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### Microsoft.Azure.PowerShell.Cmdlets.Communication.Models.Api20230601Preview.ICommunicationServiceResource +### Microsoft.Azure.PowerShell.Cmdlets.Communication.Models.ICommunicationServiceResource ## NOTES