diff --git a/src/Communication/Communication/Az.Communication.psd1 b/src/Communication/Communication/Az.Communication.psd1 index a954182c273f..497a17f23dff 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/11/2024 +# Generated on: 3/13/2024 # @{ diff --git a/src/Communication/Communication/help/Az.Communication.md b/src/Communication/Communication/help/Az.Communication.md index 0a92c88e8e6d..f26b22c5cccc 100644 --- a/src/Communication/Communication/help/Az.Communication.md +++ b/src/Communication/Communication/help/Az.Communication.md @@ -17,6 +17,18 @@ Get the CommunicationService and its properties. ### [Get-AzCommunicationServiceKey](Get-AzCommunicationServiceKey.md) Get the access keys of the CommunicationService resource. +### [Get-AzEmailService](Get-AzEmailService.md) +Get the EmailService and its properties. + +### [Get-AzEmailServiceDomain](Get-AzEmailServiceDomain.md) +Get the Domains resource and its properties. + +### [Get-AzEmailServiceSenderUsername](Get-AzEmailServiceSenderUsername.md) +Get a valid sender username for a domains resource. + +### [Invoke-AzEmailServiceInitiateDomainVerification](Invoke-AzEmailServiceInitiateDomainVerification.md) +Initiate verification of DNS record. + ### [New-AzCommunicationService](New-AzCommunicationService.md) Create a new CommunicationService or update an existing CommunicationService. @@ -24,15 +36,45 @@ Create a new CommunicationService or update an existing CommunicationService. Regenerate CommunicationService access key. PrimaryKey and SecondaryKey cannot be regenerated at the same time. +### [New-AzEmailService](New-AzEmailService.md) +Create a new EmailService or update an existing EmailService. + +### [New-AzEmailServiceDomain](New-AzEmailServiceDomain.md) +Add a new Domains resource under the parent EmailService resource or update an existing Domains resource. + +### [New-AzEmailServiceSenderUsername](New-AzEmailServiceSenderUsername.md) +Add a new SenderUsername resource under the parent Domains resource or update an existing SenderUsername resource. + ### [Remove-AzCommunicationService](Remove-AzCommunicationService.md) Operation to delete a CommunicationService. +### [Remove-AzEmailService](Remove-AzEmailService.md) +Operation to delete a EmailService. + +### [Remove-AzEmailServiceDomain](Remove-AzEmailServiceDomain.md) +Operation to delete a Domains resource. + +### [Remove-AzEmailServiceSenderUsername](Remove-AzEmailServiceSenderUsername.md) +Operation to delete a SenderUsernames resource. + ### [Set-AzCommunicationServiceNotificationHub](Set-AzCommunicationServiceNotificationHub.md) Links an Azure Notification Hub to this communication service. +### [Stop-AzEmailServiceDomainVerification](Stop-AzEmailServiceDomainVerification.md) +Cancel verification of DNS record. + ### [Test-AzCommunicationServiceNameAvailability](Test-AzCommunicationServiceNameAvailability.md) 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-AzEmailService](Update-AzEmailService.md) +Operation to update an existing EmailService. + +### [Update-AzEmailServiceDomain](Update-AzEmailServiceDomain.md) +Operation to update an existing Domains resource. + +### [Update-AzEmailServiceSenderUsername](Update-AzEmailServiceSenderUsername.md) +Add a new SenderUsername resource under the parent Domains resource or update an existing SenderUsername resource. + diff --git a/src/Communication/Communication/help/Get-AzCommunicationService.md b/src/Communication/Communication/help/Get-AzCommunicationService.md index 397bce589302..326359c1d807 100644 --- a/src/Communication/Communication/help/Get-AzCommunicationService.md +++ b/src/Communication/Communication/help/Get-AzCommunicationService.md @@ -73,7 +73,8 @@ Returns the information on an ACS resource, if one matching provided parameters ## PARAMETERS ### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml Type: System.Management.Automation.PSObject @@ -177,17 +178,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -INPUTOBJECT ``: Identity Parameter - - `[CommunicationServiceName ]`: The name of the CommunicationService resource. - - `[Id ]`: Resource identity path - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[SubscriptionId ]`: The ID of the target subscription. - ## RELATED LINKS diff --git a/src/Communication/Communication/help/Get-AzCommunicationServiceKey.md b/src/Communication/Communication/help/Get-AzCommunicationServiceKey.md index 77ac68a55d99..53fd2e26e4f6 100644 --- a/src/Communication/Communication/help/Get-AzCommunicationServiceKey.md +++ b/src/Communication/Communication/help/Get-AzCommunicationServiceKey.md @@ -54,7 +54,8 @@ Accept wildcard characters: False ``` ### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml Type: System.Management.Automation.PSObject @@ -156,6 +157,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - ## RELATED LINKS diff --git a/src/Communication/Communication/help/Get-AzEmailService.md b/src/Communication/Communication/help/Get-AzEmailService.md index a4b6066efa7f..80769e24c830 100644 --- a/src/Communication/Communication/help/Get-AzEmailService.md +++ b/src/Communication/Communication/help/Get-AzEmailService.md @@ -41,16 +41,48 @@ Get the EmailService and its properties. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: List existing Email Services for a Subscription +```powershell Get-AzCommunicationService -SubscriptionId 73fc3592-3cef-4300-5e19-8d18b65ce0e8 ``` -### EXAMPLE 2 +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreated + ByType +-------- ---- ------------------- ------------------- ----------------- +global ContosoResource1 06-12-2021 20:19:45 test@microsoft.com User +global ContosoResource2 06-12-2021 20:22:48 test@microsoft.com User ``` + +Returns a list of all ACS resources under that subscription. + +### Example 2: Get infomation on specified Azure Email services resource +```powershell Get-AzEmailService -Name ContosoAcsResource1 -ResourceGroupName ContosoResourceProvider1 ``` +```output +DataLocation : unitedstates +Id : /subscriptions/653983b8-683a-427c-8c27-9e9624ce9176/resourceGroups/ContosoResourceProvider1/providers + /Microsoft.Communication/emailServices/ContosoAcsResource1 +Location : global +Name : ContosoAcsResource1 +ProvisioningState : Succeeded +ResourceGroupName : ContosoResourceProvider1 +SystemDataCreatedAt : 08-12-2023 05:24:48 +SystemDataCreatedBy : test@microsoft.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 12-02-2024 10:35:26 +SystemDataLastModifiedBy : test@microsoft.com +SystemDataLastModifiedByType : User +Tag : { + "ExampleKey1": "UpdatedTagValue" + } +Type : microsoft.communication/emailservices +``` + +Returns the information on an ACS resource, if one matching provided parameters is found. + ## PARAMETERS ### -DefaultProfile @@ -58,7 +90,7 @@ The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml -Type: PSObject +Type: System.Management.Automation.PSObject Parameter Sets: (All) Aliases: AzureRMContext, AzureCredential @@ -73,7 +105,7 @@ Accept wildcard characters: False Identity Parameter ```yaml -Type: IEmailServiceIdentity +Type: Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.IEmailServiceIdentity Parameter Sets: GetViaIdentity Aliases: @@ -88,7 +120,7 @@ Accept wildcard characters: False The name of the EmailService resource. ```yaml -Type: String +Type: System.String Parameter Sets: Get Aliases: EmailServiceName @@ -103,7 +135,7 @@ Accept wildcard characters: False {{ Fill ProgressAction Description }} ```yaml -Type: ActionPreference +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) Aliases: proga @@ -119,7 +151,7 @@ The name of the resource group. The name is case insensitive. ```yaml -Type: String +Type: System.String Parameter Sets: Get, List1 Aliases: @@ -135,13 +167,13 @@ The ID of the target subscription. The value must be an UUID. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: List, Get, List1 Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -152,26 +184,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.IEmailServiceIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.IEmailServiceResource -## NOTES -COMPLEX PARAMETER PROPERTIES -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -INPUTOBJECT \: Identity Parameter - \[DomainName \\]: The name of the Domains resource. - \[EmailServiceName \\]: The name of the EmailService resource. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SenderUsername \\]: The valid sender Username. - \[SubscriptionId \\]: The ID of the target subscription. -The value must be an UUID. +## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.communication/get-azemailservice](https://learn.microsoft.com/powershell/module/az.communication/get-azemailservice) - diff --git a/src/Communication/Communication/help/Get-AzEmailServiceDomain.md b/src/Communication/Communication/help/Get-AzEmailServiceDomain.md index e72ca5ce8258..50f717c1515c 100644 --- a/src/Communication/Communication/help/Get-AzEmailServiceDomain.md +++ b/src/Communication/Communication/help/Get-AzEmailServiceDomain.md @@ -42,16 +42,65 @@ Get the Domains resource and its properties. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: List existing Email Service domains for a Subscription +```powershell Get-AzEmailServiceDomain -EmailServiceName ContosoAcsResource1 -ResourceGroupName ContosoResourceProvider1 ``` -### EXAMPLE 2 +```output +Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreatedByType SystemDataLastModifiedAt SystemDataLastM + odifiedBy +-------- ---- ------------------- ------------------- ----------------------- ------------------------ --------------- +global AzureManagedDomain 08-12-2023 05:34:31 test@microsoft.com User 28-01-2024 13:58:25 test@microsoft.com +global customdomain.net 07-02-2024 06:11:24 test@microsoft.com User 14-02-2024 06:25:26 test@microsoft.com ``` + +Returns a list of all domain resources under that email services. + +### Example 2: Get infomation on specified Azure Email services resource +```powershell Get-AzEmailServiceDomain -Name AzureManagedDomain -EmailServiceName ContosoAcsResource1 -ResourceGroupName ContosoResourceProvider1 ``` +```output +DataLocation : unitedstates +Dkim2ErrorCode : +Dkim2Status : Verified +DkimErrorCode : +DkimStatus : Verified +DmarcErrorCode : +DmarcStatus : Verified +DomainErrorCode : +DomainManagement : AzureManaged +DomainStatus : Verified +FromSenderDomain : a3d08608-7f9d-4d33-9c79-8b635d9220ab.azurecomm.net +Id : /subscriptions/653983b8-683a-427c-8c27-9e9624ce9176/resourceGroups/ContosoResourceProvider1/providers + /Microsoft.Communication/emailServices/ContosoAcsResource1/domains/AzureManaged + Domain +Location : global +MailFromSenderDomain : a3d08608-7f9d-4d33-9c79-8b635d9220ab.azurecomm.net +Name : AzureManagedDomain +ProvisioningState : Succeeded +ResourceGroupName : ContosoResourceProvider1 +SpfErrorCode : +SpfStatus : Verified +SystemDataCreatedAt : 08-12-2023 05:34:31 +SystemDataCreatedBy : test@microsoft.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 28-01-2024 13:58:25 +SystemDataLastModifiedBy : test@microsoft.com +SystemDataLastModifiedByType : User +Tag : { + "ExampleKey1": "ExampleValue1" + } +Type : microsoft.communication/emailservices/domains +UserEngagementTracking : Disabled +VerificationRecord : { + } +``` + +Returns the information on an domain resource, if one matching provided parameters is found. + ## PARAMETERS ### -DefaultProfile @@ -59,7 +108,7 @@ The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml -Type: PSObject +Type: System.Management.Automation.PSObject Parameter Sets: (All) Aliases: AzureRMContext, AzureCredential @@ -74,7 +123,7 @@ Accept wildcard characters: False Identity Parameter ```yaml -Type: IEmailServiceIdentity +Type: Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.IEmailServiceIdentity Parameter Sets: GetViaIdentityEmailService Aliases: @@ -89,7 +138,7 @@ Accept wildcard characters: False The name of the EmailService resource. ```yaml -Type: String +Type: System.String Parameter Sets: List, Get Aliases: @@ -104,7 +153,7 @@ Accept wildcard characters: False Identity Parameter ```yaml -Type: IEmailServiceIdentity +Type: Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.IEmailServiceIdentity Parameter Sets: GetViaIdentity Aliases: @@ -119,7 +168,7 @@ Accept wildcard characters: False The name of the Domains resource. ```yaml -Type: String +Type: System.String Parameter Sets: Get, GetViaIdentityEmailService Aliases: DomainName @@ -134,7 +183,7 @@ Accept wildcard characters: False {{ Fill ProgressAction Description }} ```yaml -Type: ActionPreference +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) Aliases: proga @@ -150,7 +199,7 @@ The name of the resource group. The name is case insensitive. ```yaml -Type: String +Type: System.String Parameter Sets: List, Get Aliases: @@ -166,13 +215,13 @@ The ID of the target subscription. The value must be an UUID. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: List, Get Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -183,36 +232,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.IEmailServiceIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.IDomainResource -## NOTES -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. -EMAILSERVICEINPUTOBJECT \: Identity Parameter - \[DomainName \\]: The name of the Domains resource. - \[EmailServiceName \\]: The name of the EmailService resource. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SenderUsername \\]: The valid sender Username. - \[SubscriptionId \\]: The ID of the target subscription. -The value must be an UUID. - -INPUTOBJECT \: Identity Parameter - \[DomainName \\]: The name of the Domains resource. - \[EmailServiceName \\]: The name of the EmailService resource. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SenderUsername \\]: The valid sender Username. - \[SubscriptionId \\]: The ID of the target subscription. -The value must be an UUID. +## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.communication/get-azemailservicedomain](https://learn.microsoft.com/powershell/module/az.communication/get-azemailservicedomain) - diff --git a/src/Communication/Communication/help/Get-AzEmailServiceSenderUsername.md b/src/Communication/Communication/help/Get-AzEmailServiceSenderUsername.md index 63882e358de1..88a817df8ef7 100644 --- a/src/Communication/Communication/help/Get-AzEmailServiceSenderUsername.md +++ b/src/Communication/Communication/help/Get-AzEmailServiceSenderUsername.md @@ -50,16 +50,46 @@ Get a valid sender username for a domains resource. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Get infomation on specified Azure Email services senderusername resource. +```powershell Get-AzEmailServiceSenderUsername -SenderUsername donotreply -DomainName AzureManagedDomain -EmailServiceName ContosoAcsResource1 -ResourceGroupName ContosoResourceProvider1 ``` -### EXAMPLE 2 +```output +DataLocation : +DisplayName : DoNotReply +Id : /subscriptions/653983b8-683a-427c-8c27-9e9624ce9176/resourcegroups/ContosoResourceProvider1/providers/microsoft.communication/emailservices/ + ContosoAcsResource1/domains/azuremanageddomain/senderusernames/donotreply +Name : donotreply +ProvisioningState : +ResourceGroupName : ContosoResourceProvider1 +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : +SystemDataLastModifiedBy : +SystemDataLastModifiedByType : +Type : emailservices/domains/senderusernames +Username : donotreply ``` + +Returns the information on senderusername resource. + +### Example 2: List existing Email Service sender usernames. +```powershell Get-AzEmailServiceSenderUsername -DomainName AzureManagedDomain -EmailServiceName ContosoAcsResource1 -ResourceGroupName ContosoResourceProvider1 ``` +```output +Name SystemData SystemData SystemData SystemData SystemData SystemData ResourceGroup + CreatedAt CreatedBy CreatedByType LastModifiedAt LastModifiedBy LastModifiedByType Name +---- ---------- ---------- ------------- -------------- -------------- ------------------ ------------- +donotreply ContosoResourceProvider1 +test ContosoResourceProvider1 +``` + +Returns the information on existing Email Service sender usernames. + ## PARAMETERS ### -DefaultProfile @@ -67,7 +97,7 @@ The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml -Type: PSObject +Type: System.Management.Automation.PSObject Parameter Sets: (All) Aliases: AzureRMContext, AzureCredential @@ -82,7 +112,7 @@ Accept wildcard characters: False Identity Parameter ```yaml -Type: IEmailServiceIdentity +Type: Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.IEmailServiceIdentity Parameter Sets: GetViaIdentityDomain Aliases: @@ -97,7 +127,7 @@ Accept wildcard characters: False The name of the Domains resource. ```yaml -Type: String +Type: System.String Parameter Sets: List, GetViaIdentityEmailService, Get Aliases: @@ -112,7 +142,7 @@ Accept wildcard characters: False Identity Parameter ```yaml -Type: IEmailServiceIdentity +Type: Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.IEmailServiceIdentity Parameter Sets: GetViaIdentityEmailService Aliases: @@ -127,7 +157,7 @@ Accept wildcard characters: False The name of the EmailService resource. ```yaml -Type: String +Type: System.String Parameter Sets: List, Get Aliases: @@ -142,7 +172,7 @@ Accept wildcard characters: False Identity Parameter ```yaml -Type: IEmailServiceIdentity +Type: Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.IEmailServiceIdentity Parameter Sets: GetViaIdentity Aliases: @@ -157,7 +187,7 @@ Accept wildcard characters: False {{ Fill ProgressAction Description }} ```yaml -Type: ActionPreference +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) Aliases: proga @@ -173,7 +203,7 @@ The name of the resource group. The name is case insensitive. ```yaml -Type: String +Type: System.String Parameter Sets: List, Get Aliases: @@ -188,7 +218,7 @@ Accept wildcard characters: False The valid sender Username. ```yaml -Type: String +Type: System.String Parameter Sets: GetViaIdentityEmailService, Get, GetViaIdentityDomain Aliases: @@ -204,13 +234,13 @@ The ID of the target subscription. The value must be an UUID. ```yaml -Type: String[] +Type: System.String[] Parameter Sets: List, Get Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -221,46 +251,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.IEmailServiceIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.ISenderUsernameResource -## NOTES -COMPLEX PARAMETER PROPERTIES -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -DOMAININPUTOBJECT \: Identity Parameter - \[DomainName \\]: The name of the Domains resource. - \[EmailServiceName \\]: The name of the EmailService resource. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SenderUsername \\]: The valid sender Username. - \[SubscriptionId \\]: The ID of the target subscription. -The value must be an UUID. - -EMAILSERVICEINPUTOBJECT \: Identity Parameter - \[DomainName \\]: The name of the Domains resource. - \[EmailServiceName \\]: The name of the EmailService resource. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SenderUsername \\]: The valid sender Username. - \[SubscriptionId \\]: The ID of the target subscription. -The value must be an UUID. - -INPUTOBJECT \: Identity Parameter - \[DomainName \\]: The name of the Domains resource. - \[EmailServiceName \\]: The name of the EmailService resource. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SenderUsername \\]: The valid sender Username. - \[SubscriptionId \\]: The ID of the target subscription. -The value must be an UUID. +## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.communication/get-azemailservicesenderusername](https://learn.microsoft.com/powershell/module/az.communication/get-azemailservicesenderusername) - diff --git a/src/Communication/Communication/help/Invoke-AzEmailServiceInitiateDomainVerification.md b/src/Communication/Communication/help/Invoke-AzEmailServiceInitiateDomainVerification.md index 7fef7024764b..1f11ee6f04ef 100644 --- a/src/Communication/Communication/help/Invoke-AzEmailServiceInitiateDomainVerification.md +++ b/src/Communication/Communication/help/Invoke-AzEmailServiceInitiateDomainVerification.md @@ -75,24 +75,26 @@ Initiate verification of DNS record. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Invoke initiate domain verification for domain resource. +```powershell Invoke-AzEmailServiceInitiateDomainVerification -DomainName testcustomdomain1.net -EmailServiceName ContosoAcsResource1 -ResourceGroupName ContosoResourceProvider1 -VerificationType Domain ``` +Invoke initiate domain verification for domain resource. + ## PARAMETERS ### -AsJob Run the command as a job ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -102,7 +104,7 @@ The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml -Type: PSObject +Type: System.Management.Automation.PSObject Parameter Sets: (All) Aliases: AzureRMContext, AzureCredential @@ -117,7 +119,7 @@ Accept wildcard characters: False The name of the Domains resource. ```yaml -Type: String +Type: System.String Parameter Sets: InitiateExpanded, InitiateViaJsonString, InitiateViaJsonFilePath, InitiateViaIdentityEmailServiceExpanded, InitiateViaIdentityEmailService, Initiate Aliases: @@ -132,7 +134,7 @@ Accept wildcard characters: False Identity Parameter ```yaml -Type: IEmailServiceIdentity +Type: Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.IEmailServiceIdentity Parameter Sets: InitiateViaIdentityEmailServiceExpanded, InitiateViaIdentityEmailService Aliases: @@ -147,7 +149,7 @@ Accept wildcard characters: False The name of the EmailService resource. ```yaml -Type: String +Type: System.String Parameter Sets: InitiateExpanded, InitiateViaJsonString, InitiateViaJsonFilePath, Initiate Aliases: @@ -162,7 +164,7 @@ Accept wildcard characters: False Identity Parameter ```yaml -Type: IEmailServiceIdentity +Type: Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.IEmailServiceIdentity Parameter Sets: InitiateViaIdentityExpanded, InitiateViaIdentity Aliases: @@ -177,7 +179,7 @@ Accept wildcard characters: False Path of Json file supplied to the Initiate operation ```yaml -Type: String +Type: System.String Parameter Sets: InitiateViaJsonFilePath Aliases: @@ -192,7 +194,7 @@ Accept wildcard characters: False Json string supplied to the Initiate operation ```yaml -Type: String +Type: System.String Parameter Sets: InitiateViaJsonString Aliases: @@ -207,13 +209,13 @@ Accept wildcard characters: False Run the command asynchronously ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -222,7 +224,7 @@ Accept wildcard characters: False Input parameter for verification APIs ```yaml -Type: IVerificationParameter +Type: Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.IVerificationParameter Parameter Sets: InitiateViaIdentityEmailService, Initiate, InitiateViaIdentity Aliases: @@ -237,7 +239,7 @@ Accept wildcard characters: False {{ Fill ProgressAction Description }} ```yaml -Type: ActionPreference +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) Aliases: proga @@ -253,7 +255,7 @@ The name of the resource group. The name is case insensitive. ```yaml -Type: String +Type: System.String Parameter Sets: InitiateExpanded, InitiateViaJsonString, InitiateViaJsonFilePath, Initiate Aliases: @@ -269,13 +271,13 @@ The ID of the target subscription. The value must be an UUID. ```yaml -Type: String +Type: System.String Parameter Sets: InitiateExpanded, InitiateViaJsonString, InitiateViaJsonFilePath, Initiate Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -284,7 +286,7 @@ Accept wildcard characters: False Type of verification. ```yaml -Type: String +Type: System.String Parameter Sets: InitiateExpanded, InitiateViaIdentityEmailServiceExpanded, InitiateViaIdentityExpanded Aliases: @@ -299,7 +301,7 @@ Accept wildcard characters: False Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -315,7 +317,7 @@ Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -332,40 +334,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.IEmailServiceIdentity + ### Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.IVerificationParameter + ## OUTPUTS ### System.Boolean -## NOTES -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. -EMAILSERVICEINPUTOBJECT \: Identity Parameter - \[DomainName \\]: The name of the Domains resource. - \[EmailServiceName \\]: The name of the EmailService resource. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SenderUsername \\]: The valid sender Username. - \[SubscriptionId \\]: The ID of the target subscription. -The value must be an UUID. - -INPUTOBJECT \: Identity Parameter - \[DomainName \\]: The name of the Domains resource. - \[EmailServiceName \\]: The name of the EmailService resource. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SenderUsername \\]: The valid sender Username. - \[SubscriptionId \\]: The ID of the target subscription. -The value must be an UUID. - -PARAMETER \: Input parameter for verification APIs - VerificationType \: Type of verification. +## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.communication/invoke-azemailserviceinitiatedomainverification](https://learn.microsoft.com/powershell/module/az.communication/invoke-azemailserviceinitiatedomainverification) - diff --git a/src/Communication/Communication/help/New-AzCommunicationService.md b/src/Communication/Communication/help/New-AzCommunicationService.md index 0e483c77ccaa..f6a28516ec74 100644 --- a/src/Communication/Communication/help/New-AzCommunicationService.md +++ b/src/Communication/Communication/help/New-AzCommunicationService.md @@ -69,7 +69,8 @@ Accept wildcard characters: False ``` ### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml Type: System.Management.Automation.PSObject @@ -231,6 +232,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - ## RELATED LINKS diff --git a/src/Communication/Communication/help/New-AzCommunicationServiceKey.md b/src/Communication/Communication/help/New-AzCommunicationServiceKey.md index 94aa8b049c05..18f737148431 100644 --- a/src/Communication/Communication/help/New-AzCommunicationServiceKey.md +++ b/src/Communication/Communication/help/New-AzCommunicationServiceKey.md @@ -89,7 +89,8 @@ Accept wildcard characters: False ``` ### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml Type: System.Management.Automation.PSObject @@ -243,20 +244,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -INPUTOBJECT ``: Identity Parameter - - `[CommunicationServiceName ]`: The name of the CommunicationService resource. - - `[Id ]`: Resource identity path - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[SubscriptionId ]`: The ID of the target subscription. - -PARAMETER ``: Parameters describes the request to regenerate access keys - - `[KeyType ]`: The keyType to regenerate. Must be either 'primary' or 'secondary'(case-insensitive). - ## RELATED LINKS diff --git a/src/Communication/Communication/help/New-AzEmailService.md b/src/Communication/Communication/help/New-AzEmailService.md index 1a8807426b3b..09e82b7dbab7 100644 --- a/src/Communication/Communication/help/New-AzEmailService.md +++ b/src/Communication/Communication/help/New-AzEmailService.md @@ -38,24 +38,44 @@ Create a new EmailService or update an existing EmailService. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Create a Email service resource +```powershell New-AzEmailService -Name ContosoAcsResource1 -ResourceGroupName ContosoResourceProvider1 -DataLocation "United States" ``` +```output +DataLocation : United States +Id : /subscriptions/653983b8-683a-427c-8c27-9e9624ce9176/resourceGroups/ContosoResourceProvider1/providers/Microsoft.Communication/emailServices/ContosoAcsResource1 +Location : global +Name : ContosoAcsResource1 +ProvisioningState : Succeeded +ResourceGroupName : ContosoResourceProvider1 +SystemDataCreatedAt : 19-02-2024 07:54:44 +SystemDataCreatedBy : test@microsoft.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 19-02-2024 07:54:44 +SystemDataLastModifiedBy : test@microsoft.com +SystemDataLastModifiedByType : User +Tag : { + } +Type : microsoft.communication/emailservices +``` + +Creates a Email service resource using the specified parameters. + ## PARAMETERS ### -AsJob Run the command as a job ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -64,7 +84,7 @@ Accept wildcard characters: False The location where the email service stores its data at rest. ```yaml -Type: String +Type: System.String Parameter Sets: CreateExpanded Aliases: @@ -80,7 +100,7 @@ The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml -Type: PSObject +Type: System.Management.Automation.PSObject Parameter Sets: (All) Aliases: AzureRMContext, AzureCredential @@ -95,7 +115,7 @@ Accept wildcard characters: False Path of Json file supplied to the Create operation ```yaml -Type: String +Type: System.String Parameter Sets: CreateViaJsonFilePath Aliases: @@ -110,7 +130,7 @@ Accept wildcard characters: False Json string supplied to the Create operation ```yaml -Type: String +Type: System.String Parameter Sets: CreateViaJsonString Aliases: @@ -125,13 +145,13 @@ Accept wildcard characters: False The geo-location where the resource lives ```yaml -Type: String +Type: System.String Parameter Sets: CreateExpanded Aliases: Required: False Position: Named -Default value: None +Default value: "global" Accept pipeline input: False Accept wildcard characters: False ``` @@ -140,7 +160,7 @@ Accept wildcard characters: False The name of the EmailService resource. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: EmailServiceName @@ -155,13 +175,13 @@ Accept wildcard characters: False Run the command asynchronously ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -170,7 +190,7 @@ Accept wildcard characters: False {{ Fill ProgressAction Description }} ```yaml -Type: ActionPreference +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) Aliases: proga @@ -186,7 +206,7 @@ The name of the resource group. The name is case insensitive. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -202,13 +222,13 @@ The ID of the target subscription. The value must be an UUID. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -217,7 +237,7 @@ Accept wildcard characters: False Resource tags. ```yaml -Type: Hashtable +Type: System.Collections.Hashtable Parameter Sets: CreateExpanded Aliases: @@ -232,7 +252,7 @@ Accept wildcard characters: False Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -248,7 +268,7 @@ Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -267,9 +287,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.IEmailServiceResource + ## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.communication/new-azemailservice](https://learn.microsoft.com/powershell/module/az.communication/new-azemailservice) - diff --git a/src/Communication/Communication/help/New-AzEmailServiceDomain.md b/src/Communication/Communication/help/New-AzEmailServiceDomain.md index 9fb1f257d26d..bb8ee95461ce 100644 --- a/src/Communication/Communication/help/New-AzEmailServiceDomain.md +++ b/src/Communication/Communication/help/New-AzEmailServiceDomain.md @@ -54,29 +54,127 @@ Add a new Domains resource under the parent EmailService resource or update an e ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Create a custom domain resource. +```powershell New-AzEmailServiceDomain -Name testcustomdomain2.net -EmailServiceName ContosoAcsResource1 -ResourceGroupName ContosoResourceProvider1 -DomainManagement CustomerManaged ``` -### EXAMPLE 2 -``` +```output +DataLocation : unitedstates +Dkim2ErrorCode : +Dkim2Status : NotStarted +DkimErrorCode : +DkimStatus : NotStarted +DmarcErrorCode : +DmarcStatus : NotStarted +DomainErrorCode : +DomainManagement : CustomerManaged +DomainStatus : NotStarted +FromSenderDomain : testcustomdomain2.net +Id : /subscriptions/653983b8-683a-427c-8c27-9e9624ce9176/resourceGroups/ContosoResourceProvider1/providers/Microsoft.Communication/emailServices/ + ContosoAcsResource1/domains/testcustomdomain2.net +Location : global +MailFromSenderDomain : testcustomdomain2.net +Name : testcustomdomain2.net +ProvisioningState : Succeeded +ResourceGroupName : ContosoResourceProvider1 +SpfErrorCode : +SpfStatus : NotStarted +SystemDataCreatedAt : 21-02-2024 07:30:12 +SystemDataCreatedBy : test@microsoft.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 21-02-2024 07:30:12 +SystemDataLastModifiedBy : test@microsoft.com +SystemDataLastModifiedByType : User +Tag : { + } +Type : microsoft.communication/emailservices/domains +UserEngagementTracking : Disabled +VerificationRecord : { + "Domain": { + "type": "TXT", + "name": "testcustomdomain2.net", + "value": "ms-domain-verification=1ff18540-e0c0-422b-b956-5b4cfa13613b", + "ttl": 3600 + }, + "SPF": { + "type": "TXT", + "name": "testcustomdomain2.net", + "value": "v=spf1 include:spf.protection.outlook.com -all", + "ttl": 3600 + }, + "DKIM": { + "type": "CNAME", + "name": "selector1-azurecomm-prod-net._domainkey", + "value": "selector1-azurecomm-prod-net._domainkey.azurecomm.net", + "ttl": 3600 + }, + "DKIM2": { + "type": "CNAME", + "name": "selector2-azurecomm-prod-net._domainkey", + "value": "selector2-azurecomm-prod-net._domainkey.azurecomm.net", + "ttl": 3600 + } + } +``` + +Create a Azure managed domain resource with the provided parameters. + +### Example 2: Create a Azure managed domain resource. +```powershell New-AzEmailServiceDomain -Name AzureManagedDomain -EmailServiceName ContosoAcsResource1 -ResourceGroupName ContosoResourceProvider1 -DomainManagement AzureManaged ``` +```output +DataLocation : unitedstates +Dkim2ErrorCode : +Dkim2Status : Verified +DkimErrorCode : +DkimStatus : Verified +DmarcErrorCode : +DmarcStatus : Verified +DomainErrorCode : +DomainManagement : AzureManaged +DomainStatus : Verified +FromSenderDomain : fb0053ef-c684-4028-81eb-a582c1330d87.azurecomm.net +Id : /subscriptions/653983b8-683a-427c-8c27-9e9624ce9176/resourceGroups/ContosoResourceProvider1/providers/Microsoft.Communication/emailServices/ + ContosoAcsResource1/domains/AzureManagedDomain +Location : global +MailFromSenderDomain : fb0053ef-c684-4028-81eb-a582c1330d87.azurecomm.net +Name : AzureManagedDomain +ProvisioningState : Succeeded +ResourceGroupName : ContosoResourceProvider1 +SpfErrorCode : +SpfStatus : Verified +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : 21-02-2024 07:34:12 +SystemDataLastModifiedBy : test@microsoft.com +SystemDataLastModifiedByType : User +Tag : { + } +Type : microsoft.communication/emailservices/domains +UserEngagementTracking : Disabled +VerificationRecord : { + } +``` + +Create a Azure managed domain resource with the provided parameters. + ## PARAMETERS ### -AsJob Run the command as a job ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -86,7 +184,7 @@ The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml -Type: PSObject +Type: System.Management.Automation.PSObject Parameter Sets: (All) Aliases: AzureRMContext, AzureCredential @@ -101,7 +199,7 @@ Accept wildcard characters: False Describes how a Domains resource is being managed. ```yaml -Type: String +Type: System.String Parameter Sets: CreateExpanded, CreateViaIdentityEmailServiceExpanded Aliases: @@ -116,7 +214,7 @@ Accept wildcard characters: False Identity Parameter ```yaml -Type: IEmailServiceIdentity +Type: Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.IEmailServiceIdentity Parameter Sets: CreateViaIdentityEmailServiceExpanded, CreateViaIdentityEmailService Aliases: @@ -131,7 +229,7 @@ Accept wildcard characters: False The name of the EmailService resource. ```yaml -Type: String +Type: System.String Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath Aliases: @@ -146,7 +244,7 @@ Accept wildcard characters: False Path of Json file supplied to the Create operation ```yaml -Type: String +Type: System.String Parameter Sets: CreateViaJsonFilePath Aliases: @@ -161,7 +259,7 @@ Accept wildcard characters: False Json string supplied to the Create operation ```yaml -Type: String +Type: System.String Parameter Sets: CreateViaJsonString Aliases: @@ -176,13 +274,13 @@ Accept wildcard characters: False The geo-location where the resource lives ```yaml -Type: String +Type: System.String Parameter Sets: CreateExpanded, CreateViaIdentityEmailServiceExpanded Aliases: Required: False Position: Named -Default value: None +Default value: "global" Accept pipeline input: False Accept wildcard characters: False ``` @@ -191,7 +289,7 @@ Accept wildcard characters: False The name of the Domains resource. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: DomainName @@ -206,13 +304,13 @@ Accept wildcard characters: False Run the command asynchronously ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -221,7 +319,7 @@ Accept wildcard characters: False A class representing a Domains resource. ```yaml -Type: IDomainResource +Type: Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.IDomainResource Parameter Sets: CreateViaIdentityEmailService Aliases: @@ -236,7 +334,7 @@ Accept wildcard characters: False {{ Fill ProgressAction Description }} ```yaml -Type: ActionPreference +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) Aliases: proga @@ -252,7 +350,7 @@ The name of the resource group. The name is case insensitive. ```yaml -Type: String +Type: System.String Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath Aliases: @@ -268,13 +366,13 @@ The ID of the target subscription. The value must be an UUID. ```yaml -Type: String +Type: System.String Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -283,7 +381,7 @@ Accept wildcard characters: False Resource tags. ```yaml -Type: Hashtable +Type: System.Collections.Hashtable Parameter Sets: CreateExpanded, CreateViaIdentityEmailServiceExpanded Aliases: @@ -298,7 +396,7 @@ Accept wildcard characters: False Describes whether user engagement tracking is enabled or disabled. ```yaml -Type: String +Type: System.String Parameter Sets: CreateExpanded, CreateViaIdentityEmailServiceExpanded Aliases: @@ -313,7 +411,7 @@ Accept wildcard characters: False Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -329,7 +427,7 @@ Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -346,34 +444,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.IDomainResource + ### Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.IEmailServiceIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.IDomainResource -## NOTES -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -EMAILSERVICEINPUTOBJECT \: Identity Parameter - \[DomainName \\]: The name of the Domains resource. - \[EmailServiceName \\]: The name of the EmailService resource. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SenderUsername \\]: The valid sender Username. - \[SubscriptionId \\]: The ID of the target subscription. -The value must be an UUID. -PARAMETER \: A class representing a Domains resource. - Location \: The geo-location where the resource lives - \[Tag \\]: Resource tags. - \[(Any) \\]: This indicates any property can be added to this object. - \[DomainManagement \\]: Describes how a Domains resource is being managed. - \[UserEngagementTracking \\]: Describes whether user engagement tracking is enabled or disabled. +## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.communication/new-azemailservicedomain](https://learn.microsoft.com/powershell/module/az.communication/new-azemailservicedomain) - diff --git a/src/Communication/Communication/help/New-AzEmailServiceSenderUsername.md b/src/Communication/Communication/help/New-AzEmailServiceSenderUsername.md index 36e7f6c7b410..802634ff39f0 100644 --- a/src/Communication/Communication/help/New-AzEmailServiceSenderUsername.md +++ b/src/Communication/Communication/help/New-AzEmailServiceSenderUsername.md @@ -66,16 +66,56 @@ Add a new SenderUsername resource under the parent Domains resource or update an ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Creates a sender username resource for custom domain. +```powershell New-AzEmailServiceSenderUsername -SenderUsername test -Username test -DomainName testcustomdomain2.net -EmailServiceName ContosoAcsResource1 -ResourceGroupName ContosoResourceProvider1 ``` -### EXAMPLE 2 -``` +```output +DataLocation : +DisplayName : +Id : /subscriptions/653983b8-683a-427c-8c27-9e9624ce9176/resourceGroups/ContosoResourceProvider1/providers/Microsoft.Communication/emailServices/ + ContosoAcsResource1/domains/testcustomdomain2.net/senderUsernames/test +Name : test +ProvisioningState : Succeeded +ResourceGroupName : ContosoResourceProvider1 +SystemDataCreatedAt : 21-02-2024 08:46:18 +SystemDataCreatedBy : test@microsoft.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 21-02-2024 08:46:18 +SystemDataLastModifiedBy : test@microsoft.com +SystemDataLastModifiedByType : User +Type : microsoft.communication/emailservices/domains/senderusernames +Username : test +``` + +Create a sender username resource for custom domain with the provided parameters. + +### Example 2: Creates a sender username resource for Azure managed domain +```powershell New-AzEmailServiceSenderUsername -SenderUsername test -Username test -DomainName AzureManagedDomain -EmailServiceName ContosoAcsResource1 -ResourceGroupName ContosoResourceProvider1 ``` +```output +DataLocation : +DisplayName : +Id : /subscriptions/653983b8-683a-427c-8c27-9e9624ce9176/resourceGroups/tcsacstest1/providers/Microsoft.Communication/emailServices/ + ContosoAcsResource1/domains/AzureManagedDomain/senderUsernames/test +Name : test +ProvisioningState : Succeeded +ResourceGroupName : ContosoResourceProvider1 +SystemDataCreatedAt : 21-02-2024 08:47:25 +SystemDataCreatedBy : test@microsoft.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 21-02-2024 08:47:25 +SystemDataLastModifiedBy : test@microsoft.com +SystemDataLastModifiedByType : User +Type : microsoft.communication/emailservices/domains/senderusernames +Username : test +``` + +Create a sender username resource for Azure managed domain with the provided parameters. + ## PARAMETERS ### -DefaultProfile @@ -83,7 +123,7 @@ The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml -Type: PSObject +Type: System.Management.Automation.PSObject Parameter Sets: (All) Aliases: AzureRMContext, AzureCredential @@ -98,7 +138,7 @@ Accept wildcard characters: False The display name for the senderUsername. ```yaml -Type: String +Type: System.String Parameter Sets: CreateExpanded, CreateViaIdentityEmailServiceExpanded, CreateViaIdentityDomainExpanded Aliases: @@ -113,7 +153,7 @@ Accept wildcard characters: False Identity Parameter ```yaml -Type: IEmailServiceIdentity +Type: Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.IEmailServiceIdentity Parameter Sets: CreateViaIdentityDomainExpanded, CreateViaIdentityDomain Aliases: @@ -128,7 +168,7 @@ Accept wildcard characters: False The name of the Domains resource. ```yaml -Type: String +Type: System.String Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath, CreateViaIdentityEmailServiceExpanded, CreateViaIdentityEmailService Aliases: @@ -143,7 +183,7 @@ Accept wildcard characters: False Identity Parameter ```yaml -Type: IEmailServiceIdentity +Type: Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.IEmailServiceIdentity Parameter Sets: CreateViaIdentityEmailServiceExpanded, CreateViaIdentityEmailService Aliases: @@ -158,7 +198,7 @@ Accept wildcard characters: False The name of the EmailService resource. ```yaml -Type: String +Type: System.String Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath Aliases: @@ -173,7 +213,7 @@ Accept wildcard characters: False Path of Json file supplied to the Create operation ```yaml -Type: String +Type: System.String Parameter Sets: CreateViaJsonFilePath Aliases: @@ -188,7 +228,7 @@ Accept wildcard characters: False Json string supplied to the Create operation ```yaml -Type: String +Type: System.String Parameter Sets: CreateViaJsonString Aliases: @@ -203,7 +243,7 @@ Accept wildcard characters: False A class representing a SenderUsername resource. ```yaml -Type: ISenderUsernameResource +Type: Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.ISenderUsernameResource Parameter Sets: CreateViaIdentityEmailService, CreateViaIdentityDomain Aliases: @@ -218,7 +258,7 @@ Accept wildcard characters: False {{ Fill ProgressAction Description }} ```yaml -Type: ActionPreference +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) Aliases: proga @@ -234,7 +274,7 @@ The name of the resource group. The name is case insensitive. ```yaml -Type: String +Type: System.String Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath Aliases: @@ -249,7 +289,7 @@ Accept wildcard characters: False The valid sender Username. ```yaml -Type: String +Type: System.String Parameter Sets: (All) Aliases: @@ -265,13 +305,13 @@ The ID of the target subscription. The value must be an UUID. ```yaml -Type: String +Type: System.String Parameter Sets: CreateExpanded, CreateViaJsonString, CreateViaJsonFilePath Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -280,7 +320,7 @@ Accept wildcard characters: False A sender senderUsername to be used when sending emails. ```yaml -Type: String +Type: System.String Parameter Sets: CreateExpanded, CreateViaIdentityEmailServiceExpanded, CreateViaIdentityDomainExpanded Aliases: @@ -295,7 +335,7 @@ Accept wildcard characters: False Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -311,7 +351,7 @@ Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -328,41 +368,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.IEmailServiceIdentity -### Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.ISenderUsernameResource -## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.ISenderUsernameResource -## NOTES -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. -DOMAININPUTOBJECT \: Identity Parameter - \[DomainName \\]: The name of the Domains resource. - \[EmailServiceName \\]: The name of the EmailService resource. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SenderUsername \\]: The valid sender Username. - \[SubscriptionId \\]: The ID of the target subscription. -The value must be an UUID. +## OUTPUTS -EMAILSERVICEINPUTOBJECT \: Identity Parameter - \[DomainName \\]: The name of the Domains resource. - \[EmailServiceName \\]: The name of the EmailService resource. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SenderUsername \\]: The valid sender Username. - \[SubscriptionId \\]: The ID of the target subscription. -The value must be an UUID. +### Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.ISenderUsernameResource -PARAMETER \: A class representing a SenderUsername resource. - \[DisplayName \\]: The display name for the senderUsername. - \[Username \\]: A sender senderUsername to be used when sending emails. +## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.communication/new-azemailservicesenderusername](https://learn.microsoft.com/powershell/module/az.communication/new-azemailservicesenderusername) - diff --git a/src/Communication/Communication/help/Remove-AzCommunicationService.md b/src/Communication/Communication/help/Remove-AzCommunicationService.md index a924f398f8ed..8f9f6092039f 100644 --- a/src/Communication/Communication/help/Remove-AzCommunicationService.md +++ b/src/Communication/Communication/help/Remove-AzCommunicationService.md @@ -55,7 +55,8 @@ Accept wildcard characters: False ``` ### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml Type: System.Management.Automation.PSObject @@ -220,17 +221,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -INPUTOBJECT ``: Identity Parameter - - `[CommunicationServiceName ]`: The name of the CommunicationService resource. - - `[Id ]`: Resource identity path - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[SubscriptionId ]`: The ID of the target subscription. - ## RELATED LINKS diff --git a/src/Communication/Communication/help/Remove-AzEmailService.md b/src/Communication/Communication/help/Remove-AzEmailService.md index f8b5763ec90b..4fee6816a08c 100644 --- a/src/Communication/Communication/help/Remove-AzEmailService.md +++ b/src/Communication/Communication/help/Remove-AzEmailService.md @@ -30,24 +30,26 @@ Operation to delete a EmailService. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Removes Email service resource. +```powershell Remove-AzEmailService -Name ContosoAcsResource1 -ResourceGroupName ContosoResourceProvider1 ``` +Removes Email service resource. + ## PARAMETERS ### -AsJob Run the command as a job ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -57,7 +59,7 @@ The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml -Type: PSObject +Type: System.Management.Automation.PSObject Parameter Sets: (All) Aliases: AzureRMContext, AzureCredential @@ -72,7 +74,7 @@ Accept wildcard characters: False Identity Parameter ```yaml -Type: IEmailServiceIdentity +Type: Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.IEmailServiceIdentity Parameter Sets: DeleteViaIdentity Aliases: @@ -87,7 +89,7 @@ Accept wildcard characters: False The name of the EmailService resource. ```yaml -Type: String +Type: System.String Parameter Sets: Delete Aliases: EmailServiceName @@ -102,13 +104,13 @@ Accept wildcard characters: False Run the command asynchronously ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -117,13 +119,13 @@ Accept wildcard characters: False Returns true when the command succeeds ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -132,7 +134,7 @@ Accept wildcard characters: False {{ Fill ProgressAction Description }} ```yaml -Type: ActionPreference +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) Aliases: proga @@ -148,7 +150,7 @@ The name of the resource group. The name is case insensitive. ```yaml -Type: String +Type: System.String Parameter Sets: Delete Aliases: @@ -164,13 +166,13 @@ The ID of the target subscription. The value must be an UUID. ```yaml -Type: String +Type: System.String Parameter Sets: Delete Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -179,7 +181,7 @@ Accept wildcard characters: False Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -195,7 +197,7 @@ Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -212,26 +214,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.IEmailServiceIdentity + ## OUTPUTS ### System.Boolean -## NOTES -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. -INPUTOBJECT \: Identity Parameter - \[DomainName \\]: The name of the Domains resource. - \[EmailServiceName \\]: The name of the EmailService resource. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SenderUsername \\]: The valid sender Username. - \[SubscriptionId \\]: The ID of the target subscription. -The value must be an UUID. +## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.communication/remove-azemailservice](https://learn.microsoft.com/powershell/module/az.communication/remove-azemailservice) - diff --git a/src/Communication/Communication/help/Remove-AzEmailServiceDomain.md b/src/Communication/Communication/help/Remove-AzEmailServiceDomain.md index 89f580b181b3..5982d8d61117 100644 --- a/src/Communication/Communication/help/Remove-AzEmailServiceDomain.md +++ b/src/Communication/Communication/help/Remove-AzEmailServiceDomain.md @@ -37,29 +37,33 @@ Operation to delete a Domains resource. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Removes Email service custom domain. +```powershell Remove-AzEmailServiceDomain -Name test.net -EmailServiceName ContosoAcsResource1 -ResourceGroupName ContosoResourceProvider1 ``` -### EXAMPLE 2 -``` +Removes Email service custom domain. + +### Example 2: Removes Email service azure managed domain. +```powershell Remove-AzEmailServiceDomain -Name AzureManagedDomain -EmailServiceName ContosoAcsResource1 -ResourceGroupName ContosoResourceProvider1 ``` +Removes Email service azure managed domain. + ## PARAMETERS ### -AsJob Run the command as a job ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -69,7 +73,7 @@ The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml -Type: PSObject +Type: System.Management.Automation.PSObject Parameter Sets: (All) Aliases: AzureRMContext, AzureCredential @@ -84,7 +88,7 @@ Accept wildcard characters: False Identity Parameter ```yaml -Type: IEmailServiceIdentity +Type: Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.IEmailServiceIdentity Parameter Sets: DeleteViaIdentityEmailService Aliases: @@ -99,7 +103,7 @@ Accept wildcard characters: False The name of the EmailService resource. ```yaml -Type: String +Type: System.String Parameter Sets: Delete Aliases: @@ -114,7 +118,7 @@ Accept wildcard characters: False Identity Parameter ```yaml -Type: IEmailServiceIdentity +Type: Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.IEmailServiceIdentity Parameter Sets: DeleteViaIdentity Aliases: @@ -129,7 +133,7 @@ Accept wildcard characters: False The name of the Domains resource. ```yaml -Type: String +Type: System.String Parameter Sets: Delete, DeleteViaIdentityEmailService Aliases: DomainName @@ -144,13 +148,13 @@ Accept wildcard characters: False Run the command asynchronously ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -159,13 +163,13 @@ Accept wildcard characters: False Returns true when the command succeeds ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -174,7 +178,7 @@ Accept wildcard characters: False {{ Fill ProgressAction Description }} ```yaml -Type: ActionPreference +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) Aliases: proga @@ -190,7 +194,7 @@ The name of the resource group. The name is case insensitive. ```yaml -Type: String +Type: System.String Parameter Sets: Delete Aliases: @@ -206,13 +210,13 @@ The ID of the target subscription. The value must be an UUID. ```yaml -Type: String +Type: System.String Parameter Sets: Delete Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -221,7 +225,7 @@ Accept wildcard characters: False Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -237,7 +241,7 @@ Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -254,36 +258,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.IEmailServiceIdentity + ## OUTPUTS ### System.Boolean -## NOTES -COMPLEX PARAMETER PROPERTIES -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -EMAILSERVICEINPUTOBJECT \: Identity Parameter - \[DomainName \\]: The name of the Domains resource. - \[EmailServiceName \\]: The name of the EmailService resource. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SenderUsername \\]: The valid sender Username. - \[SubscriptionId \\]: The ID of the target subscription. -The value must be an UUID. - -INPUTOBJECT \: Identity Parameter - \[DomainName \\]: The name of the Domains resource. - \[EmailServiceName \\]: The name of the EmailService resource. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SenderUsername \\]: The valid sender Username. - \[SubscriptionId \\]: The ID of the target subscription. -The value must be an UUID. +## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.communication/remove-azemailservicedomain](https://learn.microsoft.com/powershell/module/az.communication/remove-azemailservicedomain) - diff --git a/src/Communication/Communication/help/Remove-AzEmailServiceSenderUsername.md b/src/Communication/Communication/help/Remove-AzEmailServiceSenderUsername.md index b13a466e6e68..489c43a3460d 100644 --- a/src/Communication/Communication/help/Remove-AzEmailServiceSenderUsername.md +++ b/src/Communication/Communication/help/Remove-AzEmailServiceSenderUsername.md @@ -44,16 +44,20 @@ Operation to delete a SenderUsernames resource. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Removes Email service custom domain sender username resource. +```powershell Remove-AzEmailServiceSenderUsername -SenderUsername test -DomainName testcustomdomain1.net -EmailServiceName ContosoAcsResource1 -ResourceGroupName ContosoResourceProvider1 ``` -### EXAMPLE 2 -``` +Removes Email service custom domain sender username resource. + +### Example 2: Removes Email service azure managed domain sender username resource. +```powershell Remove-AzEmailServiceSenderUsername -SenderUsername test -DomainName AzureManagedDomain -EmailServiceName ContosoAcsResource1 -ResourceGroupName ContosoResourceProvider1 ``` +Removes Email service azure managed domain sender username resource. + ## PARAMETERS ### -DefaultProfile @@ -61,7 +65,7 @@ The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml -Type: PSObject +Type: System.Management.Automation.PSObject Parameter Sets: (All) Aliases: AzureRMContext, AzureCredential @@ -76,7 +80,7 @@ Accept wildcard characters: False Identity Parameter ```yaml -Type: IEmailServiceIdentity +Type: Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.IEmailServiceIdentity Parameter Sets: DeleteViaIdentityDomain Aliases: @@ -91,7 +95,7 @@ Accept wildcard characters: False The name of the Domains resource. ```yaml -Type: String +Type: System.String Parameter Sets: Delete, DeleteViaIdentityEmailService Aliases: @@ -106,7 +110,7 @@ Accept wildcard characters: False Identity Parameter ```yaml -Type: IEmailServiceIdentity +Type: Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.IEmailServiceIdentity Parameter Sets: DeleteViaIdentityEmailService Aliases: @@ -121,7 +125,7 @@ Accept wildcard characters: False The name of the EmailService resource. ```yaml -Type: String +Type: System.String Parameter Sets: Delete Aliases: @@ -136,7 +140,7 @@ Accept wildcard characters: False Identity Parameter ```yaml -Type: IEmailServiceIdentity +Type: Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.IEmailServiceIdentity Parameter Sets: DeleteViaIdentity Aliases: @@ -151,13 +155,13 @@ Accept wildcard characters: False Returns true when the command succeeds ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -166,7 +170,7 @@ Accept wildcard characters: False {{ Fill ProgressAction Description }} ```yaml -Type: ActionPreference +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) Aliases: proga @@ -182,7 +186,7 @@ The name of the resource group. The name is case insensitive. ```yaml -Type: String +Type: System.String Parameter Sets: Delete Aliases: @@ -197,7 +201,7 @@ Accept wildcard characters: False The valid sender Username. ```yaml -Type: String +Type: System.String Parameter Sets: Delete, DeleteViaIdentityEmailService, DeleteViaIdentityDomain Aliases: @@ -213,13 +217,13 @@ The ID of the target subscription. The value must be an UUID. ```yaml -Type: String +Type: System.String Parameter Sets: Delete Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -228,7 +232,7 @@ Accept wildcard characters: False Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -244,7 +248,7 @@ Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -261,46 +265,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.IEmailServiceIdentity + ## OUTPUTS ### System.Boolean -## NOTES -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. - -DOMAININPUTOBJECT \: Identity Parameter - \[DomainName \\]: The name of the Domains resource. - \[EmailServiceName \\]: The name of the EmailService resource. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SenderUsername \\]: The valid sender Username. - \[SubscriptionId \\]: The ID of the target subscription. -The value must be an UUID. - -EMAILSERVICEINPUTOBJECT \: Identity Parameter - \[DomainName \\]: The name of the Domains resource. - \[EmailServiceName \\]: The name of the EmailService resource. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SenderUsername \\]: The valid sender Username. - \[SubscriptionId \\]: The ID of the target subscription. -The value must be an UUID. -INPUTOBJECT \: Identity Parameter - \[DomainName \\]: The name of the Domains resource. - \[EmailServiceName \\]: The name of the EmailService resource. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SenderUsername \\]: The valid sender Username. - \[SubscriptionId \\]: The ID of the target subscription. -The value must be an UUID. +## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.communication/remove-azemailservicesenderusername](https://learn.microsoft.com/powershell/module/az.communication/remove-azemailservicesenderusername) - diff --git a/src/Communication/Communication/help/Set-AzCommunicationServiceNotificationHub.md b/src/Communication/Communication/help/Set-AzCommunicationServiceNotificationHub.md index 966aaadf0fdc..74a1ba83efc4 100644 --- a/src/Communication/Communication/help/Set-AzCommunicationServiceNotificationHub.md +++ b/src/Communication/Communication/help/Set-AzCommunicationServiceNotificationHub.md @@ -71,7 +71,8 @@ Accept wildcard characters: False ``` ### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml Type: System.Management.Automation.PSObject @@ -206,15 +207,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -LINKNOTIFICATIONHUBPARAMETER ``: Description of an Azure Notification Hub to link to the communication service - - `ConnectionString `: Connection string for the notification hub - - `ResourceId `: The resource ID of the notification hub - ## RELATED LINKS diff --git a/src/Communication/Communication/help/Stop-AzEmailServiceDomainVerification.md b/src/Communication/Communication/help/Stop-AzEmailServiceDomainVerification.md index bff87bdd9c1a..4450fe4f402b 100644 --- a/src/Communication/Communication/help/Stop-AzEmailServiceDomainVerification.md +++ b/src/Communication/Communication/help/Stop-AzEmailServiceDomainVerification.md @@ -74,24 +74,26 @@ Cancel verification of DNS record. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Stop domain verification for domain resource. +```powershell Stop-AzEmailServiceDomainVerification -DomainName testcustomdomain1.net -EmailServiceName ContosoAcsResource1 -ResourceGroupName ContosoResourceProvider1 -VerificationType Domain ``` +Stop domain verification for domain resource. + ## PARAMETERS ### -AsJob Run the command as a job ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -101,7 +103,7 @@ The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml -Type: PSObject +Type: System.Management.Automation.PSObject Parameter Sets: (All) Aliases: AzureRMContext, AzureCredential @@ -116,7 +118,7 @@ Accept wildcard characters: False The name of the Domains resource. ```yaml -Type: String +Type: System.String Parameter Sets: CancelExpanded, CancelViaJsonString, CancelViaJsonFilePath, CancelViaIdentityEmailServiceExpanded, CancelViaIdentityEmailService, Cancel Aliases: @@ -131,7 +133,7 @@ Accept wildcard characters: False Identity Parameter ```yaml -Type: IEmailServiceIdentity +Type: Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.IEmailServiceIdentity Parameter Sets: CancelViaIdentityEmailServiceExpanded, CancelViaIdentityEmailService Aliases: @@ -146,7 +148,7 @@ Accept wildcard characters: False The name of the EmailService resource. ```yaml -Type: String +Type: System.String Parameter Sets: CancelExpanded, CancelViaJsonString, CancelViaJsonFilePath, Cancel Aliases: @@ -161,7 +163,7 @@ Accept wildcard characters: False Identity Parameter ```yaml -Type: IEmailServiceIdentity +Type: Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.IEmailServiceIdentity Parameter Sets: CancelViaIdentityExpanded, CancelViaIdentity Aliases: @@ -176,7 +178,7 @@ Accept wildcard characters: False Path of Json file supplied to the Cancel operation ```yaml -Type: String +Type: System.String Parameter Sets: CancelViaJsonFilePath Aliases: @@ -191,7 +193,7 @@ Accept wildcard characters: False Json string supplied to the Cancel operation ```yaml -Type: String +Type: System.String Parameter Sets: CancelViaJsonString Aliases: @@ -206,13 +208,13 @@ Accept wildcard characters: False Run the command asynchronously ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -221,7 +223,7 @@ Accept wildcard characters: False Input parameter for verification APIs ```yaml -Type: IVerificationParameter +Type: Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.IVerificationParameter Parameter Sets: CancelViaIdentityEmailService, Cancel, CancelViaIdentity Aliases: @@ -236,7 +238,7 @@ Accept wildcard characters: False {{ Fill ProgressAction Description }} ```yaml -Type: ActionPreference +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) Aliases: proga @@ -252,7 +254,7 @@ The name of the resource group. The name is case insensitive. ```yaml -Type: String +Type: System.String Parameter Sets: CancelExpanded, CancelViaJsonString, CancelViaJsonFilePath, Cancel Aliases: @@ -268,13 +270,13 @@ The ID of the target subscription. The value must be an UUID. ```yaml -Type: String +Type: System.String Parameter Sets: CancelExpanded, CancelViaJsonString, CancelViaJsonFilePath, Cancel Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -283,7 +285,7 @@ Accept wildcard characters: False Type of verification. ```yaml -Type: String +Type: System.String Parameter Sets: CancelExpanded, CancelViaIdentityEmailServiceExpanded, CancelViaIdentityExpanded Aliases: @@ -298,7 +300,7 @@ Accept wildcard characters: False Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -314,7 +316,7 @@ Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -331,40 +333,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.IEmailServiceIdentity + ### Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.IVerificationParameter + ## OUTPUTS ### System.Boolean -## NOTES -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. -EMAILSERVICEINPUTOBJECT \: Identity Parameter - \[DomainName \\]: The name of the Domains resource. - \[EmailServiceName \\]: The name of the EmailService resource. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SenderUsername \\]: The valid sender Username. - \[SubscriptionId \\]: The ID of the target subscription. -The value must be an UUID. - -INPUTOBJECT \: Identity Parameter - \[DomainName \\]: The name of the Domains resource. - \[EmailServiceName \\]: The name of the EmailService resource. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SenderUsername \\]: The valid sender Username. - \[SubscriptionId \\]: The ID of the target subscription. -The value must be an UUID. - -PARAMETER \: Input parameter for verification APIs - VerificationType \: Type of verification. +## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.communication/stop-azemailservicedomainverification](https://learn.microsoft.com/powershell/module/az.communication/stop-azemailservicedomainverification) - diff --git a/src/Communication/Communication/help/Test-AzCommunicationServiceNameAvailability.md b/src/Communication/Communication/help/Test-AzCommunicationServiceNameAvailability.md index ef4b5eea4d4a..832ea6930163 100644 --- a/src/Communication/Communication/help/Test-AzCommunicationServiceNameAvailability.md +++ b/src/Communication/Communication/help/Test-AzCommunicationServiceNameAvailability.md @@ -51,7 +51,8 @@ Verified that the requested CommunicationService name already in use. ## PARAMETERS ### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml Type: System.Management.Automation.PSObject @@ -153,6 +154,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - ## RELATED LINKS diff --git a/src/Communication/Communication/help/Update-AzCommunicationService.md b/src/Communication/Communication/help/Update-AzCommunicationService.md index d656a74ef575..c3fd1200937a 100644 --- a/src/Communication/Communication/help/Update-AzCommunicationService.md +++ b/src/Communication/Communication/help/Update-AzCommunicationService.md @@ -62,7 +62,8 @@ Accept wildcard characters: False ``` ### -DefaultProfile -The credentials, account, tenant, and subscription used for communication with Azure. +The DefaultProfile parameter is not functional. +Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml Type: System.Management.Automation.PSObject @@ -227,17 +228,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## NOTES -ALIASES - -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables. - - -INPUTOBJECT ``: Identity Parameter - - `[CommunicationServiceName ]`: The name of the CommunicationService resource. - - `[Id ]`: Resource identity path - - `[ResourceGroupName ]`: The name of the resource group. The name is case insensitive. - - `[SubscriptionId ]`: The ID of the target subscription. - ## RELATED LINKS diff --git a/src/Communication/Communication/help/Update-AzEmailService.md b/src/Communication/Communication/help/Update-AzEmailService.md index d8b9ff64e735..499d5b6c24f1 100644 --- a/src/Communication/Communication/help/Update-AzEmailService.md +++ b/src/Communication/Communication/help/Update-AzEmailService.md @@ -44,24 +44,46 @@ Operation to update an existing EmailService. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Updates an email service resource. +```powershell Update-AzEmailService -Name ContosoAcsResource1 -ResourceGroupName ContosoResourceProvider1 -Tag @{ExampleKey1="UpdatedTagValue"} ``` +```output +DataLocation : United States +Id : /subscriptions/653983b8-683a-427c-8c27-9e9624ce9176/resourceGroups/ContosoResourceProvider1/providers/Microsoft.Communication/emailServices/ + ContosoAcsResource1 +Location : global +Name : ContosoAcsResource1 +ProvisioningState : Succeeded +ResourceGroupName : ContosoResourceProvider1 +SystemDataCreatedAt : 21-02-2024 07:24:19 +SystemDataCreatedBy : test@microsoft.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 21-02-2024 09:00:57 +SystemDataLastModifiedBy : test@microsoft.com +SystemDataLastModifiedByType : User +Tag : { + "ExampleKey1": "UpdatedTagValue" + } +Type : microsoft.communication/emailservices +``` + +Updates an email service resource with the provided tags. + ## PARAMETERS ### -AsJob Run the command as a job ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -71,7 +93,7 @@ The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml -Type: PSObject +Type: System.Management.Automation.PSObject Parameter Sets: (All) Aliases: AzureRMContext, AzureCredential @@ -86,7 +108,7 @@ Accept wildcard characters: False Identity Parameter ```yaml -Type: IEmailServiceIdentity +Type: Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.IEmailServiceIdentity Parameter Sets: UpdateViaIdentityExpanded Aliases: @@ -101,7 +123,7 @@ Accept wildcard characters: False Path of Json file supplied to the Update operation ```yaml -Type: String +Type: System.String Parameter Sets: UpdateViaJsonFilePath Aliases: @@ -116,7 +138,7 @@ Accept wildcard characters: False Json string supplied to the Update operation ```yaml -Type: String +Type: System.String Parameter Sets: UpdateViaJsonString Aliases: @@ -131,7 +153,7 @@ Accept wildcard characters: False The name of the EmailService resource. ```yaml -Type: String +Type: System.String Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath Aliases: EmailServiceName @@ -146,13 +168,13 @@ Accept wildcard characters: False Run the command asynchronously ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -161,7 +183,7 @@ Accept wildcard characters: False {{ Fill ProgressAction Description }} ```yaml -Type: ActionPreference +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) Aliases: proga @@ -177,7 +199,7 @@ The name of the resource group. The name is case insensitive. ```yaml -Type: String +Type: System.String Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath Aliases: @@ -193,13 +215,13 @@ The ID of the target subscription. The value must be an UUID. ```yaml -Type: String +Type: System.String Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -208,7 +230,7 @@ Accept wildcard characters: False Tags of the service which is a list of key value pairs that describe the resource. ```yaml -Type: Hashtable +Type: System.Collections.Hashtable Parameter Sets: UpdateExpanded, UpdateViaIdentityExpanded Aliases: @@ -223,7 +245,7 @@ Accept wildcard characters: False Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -239,7 +261,7 @@ Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -256,26 +278,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.IEmailServiceIdentity + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.IEmailServiceResource -## NOTES -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. -INPUTOBJECT \: Identity Parameter - \[DomainName \\]: The name of the Domains resource. - \[EmailServiceName \\]: The name of the EmailService resource. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SenderUsername \\]: The valid sender Username. - \[SubscriptionId \\]: The ID of the target subscription. -The value must be an UUID. +## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.communication/update-azemailservice](https://learn.microsoft.com/powershell/module/az.communication/update-azemailservice) - diff --git a/src/Communication/Communication/help/Update-AzEmailServiceDomain.md b/src/Communication/Communication/help/Update-AzEmailServiceDomain.md index d799216c531d..8b4e75eefdfe 100644 --- a/src/Communication/Communication/help/Update-AzEmailServiceDomain.md +++ b/src/Communication/Communication/help/Update-AzEmailServiceDomain.md @@ -59,29 +59,129 @@ Operation to update an existing Domains resource. ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Updates email service custom domain. +```powershell Update-AzEmailServiceDomain -Name testcustomdomain2.net -EmailServiceName ContosoAcsResource1 -ResourceGroupName ContosoResourceProvider1 -Tag @{ExampleKey1="ExampleUpdatedValue"} -UserEngagementTracking 1 ``` -### EXAMPLE 2 -``` +```output +DataLocation : unitedstates +Dkim2ErrorCode : +Dkim2Status : NotStarted +DkimErrorCode : +DkimStatus : NotStarted +DmarcErrorCode : +DmarcStatus : NotStarted +DomainErrorCode : +DomainManagement : CustomerManaged +DomainStatus : NotStarted +FromSenderDomain : testcustomdomain2.net +Id : /subscriptions/653983b8-683a-427c-8c27-9e9624ce9176/resourceGroups/ContosoResourceProvider1/providers/Microsoft.Communication/emailServices/ + ContosoAcsResource1/domains/testcustomdomain2.net +Location : global +MailFromSenderDomain : testcustomdomain2.net +Name : testcustomdomain2.net +ProvisioningState : Succeeded +ResourceGroupName : ContosoResourceProvider1 +SpfErrorCode : +SpfStatus : NotStarted +SystemDataCreatedAt : 21-02-2024 07:30:12 +SystemDataCreatedBy : test@microsoft.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 21-02-2024 09:06:45 +SystemDataLastModifiedBy : test@microsoft.com +SystemDataLastModifiedByType : User +Tag : { + "ExampleKey1": "ExampleUpdatedValue" + } +Type : microsoft.communication/emailservices/domains +UserEngagementTracking : Enabled +VerificationRecord : { + "Domain": { + "type": "TXT", + "name": "testcustomdomain2.net", + "value": "ms-domain-verification=1ff18540-e0c0-422b-b956-5b4cfa13613b", + "ttl": 3600 + }, + "SPF": { + "type": "TXT", + "name": "testcustomdomain2.net", + "value": "v=spf1 include:spf.protection.outlook.com -all", + "ttl": 3600 + }, + "DKIM": { + "type": "CNAME", + "name": "selector1-azurecomm-prod-net._domainkey", + "value": "selector1-azurecomm-prod-net._domainkey.azurecomm.net", + "ttl": 3600 + }, + "DKIM2": { + "type": "CNAME", + "name": "selector2-azurecomm-prod-net._domainkey", + "value": "selector2-azurecomm-prod-net._domainkey.azurecomm.net", + "ttl": 3600 + } + } +``` + +Updates email service custom domain with the provided parameters. + +### Example 2: Updates email service azure managed domain. +```powershell Update-AzEmailServiceDomain -Name AzureManagedDomain -EmailServiceName ContosoAcsResource1 -ResourceGroupName ContosoResourceProvider1 -Tag @{ExampleKey1="ExampleValue1updated"} -UserEngagementTracking 1 ``` +```output +DataLocation : unitedstates +Dkim2ErrorCode : +Dkim2Status : Verified +DkimErrorCode : +DkimStatus : Verified +DmarcErrorCode : +DmarcStatus : Verified +DomainErrorCode : +DomainManagement : AzureManaged +DomainStatus : Verified +FromSenderDomain : fb0053ef-c684-4028-81eb-a582c1330d87.azurecomm.net +Id : /subscriptions/653983b8-683a-427c-8c27-9e9624ce9176/resourceGroups/ContosoResourceProvider1/providers/Microsoft.Communication/emailServices/ + ContosoAcsResource1/domains/AzureManagedDomain +Location : global +MailFromSenderDomain : fb0053ef-c684-4028-81eb-a582c1330d87.azurecomm.net +Name : AzureManagedDomain +ProvisioningState : Succeeded +ResourceGroupName : ContosoResourceProvider1 +SpfErrorCode : +SpfStatus : Verified +SystemDataCreatedAt : +SystemDataCreatedBy : +SystemDataCreatedByType : +SystemDataLastModifiedAt : 21-02-2024 09:07:35 +SystemDataLastModifiedBy : test@microsoft.com +SystemDataLastModifiedByType : User +Tag : { + "ExampleKey1": "ExampleValue1updated" + } +Type : microsoft.communication/emailservices/domains +UserEngagementTracking : Enabled +VerificationRecord : { + } +``` + +Updates email service azure managed domain with the provided parameters. + ## PARAMETERS ### -AsJob Run the command as a job ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -91,7 +191,7 @@ The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml -Type: PSObject +Type: System.Management.Automation.PSObject Parameter Sets: (All) Aliases: AzureRMContext, AzureCredential @@ -106,7 +206,7 @@ Accept wildcard characters: False Identity Parameter ```yaml -Type: IEmailServiceIdentity +Type: Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.IEmailServiceIdentity Parameter Sets: UpdateViaIdentityEmailServiceExpanded, UpdateViaIdentityEmailService Aliases: @@ -121,7 +221,7 @@ Accept wildcard characters: False The name of the EmailService resource. ```yaml -Type: String +Type: System.String Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath Aliases: @@ -136,7 +236,7 @@ Accept wildcard characters: False Identity Parameter ```yaml -Type: IEmailServiceIdentity +Type: Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.IEmailServiceIdentity Parameter Sets: UpdateViaIdentityExpanded Aliases: @@ -151,7 +251,7 @@ Accept wildcard characters: False Path of Json file supplied to the Update operation ```yaml -Type: String +Type: System.String Parameter Sets: UpdateViaJsonFilePath Aliases: @@ -166,7 +266,7 @@ Accept wildcard characters: False Json string supplied to the Update operation ```yaml -Type: String +Type: System.String Parameter Sets: UpdateViaJsonString Aliases: @@ -181,7 +281,7 @@ Accept wildcard characters: False The name of the Domains resource. ```yaml -Type: String +Type: System.String Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath, UpdateViaIdentityEmailServiceExpanded, UpdateViaIdentityEmailService Aliases: DomainName @@ -196,13 +296,13 @@ Accept wildcard characters: False Run the command asynchronously ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -211,7 +311,7 @@ Accept wildcard characters: False A class that describes the PATCH request parameters of a Domains resource. ```yaml -Type: IUpdateDomainRequestParameters +Type: Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.IUpdateDomainRequestParameters Parameter Sets: UpdateViaIdentityEmailService Aliases: @@ -226,7 +326,7 @@ Accept wildcard characters: False {{ Fill ProgressAction Description }} ```yaml -Type: ActionPreference +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) Aliases: proga @@ -242,7 +342,7 @@ The name of the resource group. The name is case insensitive. ```yaml -Type: String +Type: System.String Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath Aliases: @@ -258,13 +358,13 @@ The ID of the target subscription. The value must be an UUID. ```yaml -Type: String +Type: System.String Parameter Sets: UpdateExpanded, UpdateViaJsonString, UpdateViaJsonFilePath Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -273,7 +373,7 @@ Accept wildcard characters: False Tags of the service which is a list of key value pairs that describe the resource. ```yaml -Type: Hashtable +Type: System.Collections.Hashtable Parameter Sets: UpdateExpanded, UpdateViaIdentityEmailServiceExpanded, UpdateViaIdentityExpanded Aliases: @@ -288,7 +388,7 @@ Accept wildcard characters: False Describes whether user engagement tracking is enabled or disabled. ```yaml -Type: String +Type: System.String Parameter Sets: UpdateExpanded, UpdateViaIdentityEmailServiceExpanded, UpdateViaIdentityExpanded Aliases: @@ -303,7 +403,7 @@ Accept wildcard characters: False Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -319,7 +419,7 @@ Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -336,42 +436,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.IEmailServiceIdentity + ### Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.IUpdateDomainRequestParameters + ## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.IDomainResource -## NOTES -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. -EMAILSERVICEINPUTOBJECT \: Identity Parameter - \[DomainName \\]: The name of the Domains resource. - \[EmailServiceName \\]: The name of the EmailService resource. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SenderUsername \\]: The valid sender Username. - \[SubscriptionId \\]: The ID of the target subscription. -The value must be an UUID. - -INPUTOBJECT \: Identity Parameter - \[DomainName \\]: The name of the Domains resource. - \[EmailServiceName \\]: The name of the EmailService resource. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SenderUsername \\]: The valid sender Username. - \[SubscriptionId \\]: The ID of the target subscription. -The value must be an UUID. - -PARAMETER \: A class that describes the PATCH request parameters of a Domains resource. - \[Tag \\]: Tags of the service which is a list of key value pairs that describe the resource. - \[(Any) \\]: This indicates any property can be added to this object. - \[UserEngagementTracking \\]: Describes whether user engagement tracking is enabled or disabled. +## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.communication/update-azemailservicedomain](https://learn.microsoft.com/powershell/module/az.communication/update-azemailservicedomain) - diff --git a/src/Communication/Communication/help/Update-AzEmailServiceSenderUsername.md b/src/Communication/Communication/help/Update-AzEmailServiceSenderUsername.md index 61ff03463210..a708ce264bc5 100644 --- a/src/Communication/Communication/help/Update-AzEmailServiceSenderUsername.md +++ b/src/Communication/Communication/help/Update-AzEmailServiceSenderUsername.md @@ -59,16 +59,56 @@ Add a new SenderUsername resource under the parent Domains resource or update an ## EXAMPLES -### EXAMPLE 1 -``` +### Example 1: Updates custom domain sender username resource. +```powershell Update-AzEmailServiceSenderUsername -SenderUsername test -Username test -DisplayName testdisplayname -DomainName testcustomdomain2.net -EmailServiceName ContosoAcsResource1 -ResourceGroupName ContosoResourceProvider1 ``` -### EXAMPLE 2 +```output +DataLocation : +DisplayName : testdisplayname +Id : /subscriptions/653983b8-683a-427c-8c27-9e9624ce9176/resourceGroups/ContosoResourceProvider1/providers/Microsoft.Communication/emailServices/ + ContosoAcsResource1/domains/testcustomdomain2.net/senderUsernames/test +Name : test +ProvisioningState : Succeeded +ResourceGroupName : ContosoResourceProvider1 +SystemDataCreatedAt : 21-02-2024 09:17:38 +SystemDataCreatedBy : test@microsoft.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 21-02-2024 09:17:38 +SystemDataLastModifiedBy : test@microsoft.com +SystemDataLastModifiedByType : User +Type : microsoft.communication/emailservices/domains/senderusernames +Username : test ``` + +Updates custom sender username resource with provided parameters. + +### Example 2: Updates azure managed domain sender username resource. +```powershell Update-AzEmailServiceSenderUsername -SenderUsername test -Username test -DisplayName testAzureDomaindisplayname -DomainName AzureManagedDomain -EmailServiceName ContosoAcsResource1 -ResourceGroupName ContosoResourceProvider1 ``` +```output +DataLocation : +DisplayName : testAzureDomaindisplayname +Id : /subscriptions/653983b8-683a-427c-8c27-9e9624ce9176/resourceGroups/ContosoResourceProvider1/providers/Microsoft.Communication/emailServices/ + ContosoAcsResource1/domains/AzureManagedDomain/senderUsernames/test +Name : test +ProvisioningState : Succeeded +ResourceGroupName : ContosoResourceProvider1 +SystemDataCreatedAt : 21-02-2024 09:34:29 +SystemDataCreatedBy : test@microsoft.com +SystemDataCreatedByType : User +SystemDataLastModifiedAt : 21-02-2024 09:34:29 +SystemDataLastModifiedBy : test@microsoft.com +SystemDataLastModifiedByType : User +Type : microsoft.communication/emailservices/domains/senderusernames +Username : test +``` + +Updates azure managed sender username resource with provided parameters. + ## PARAMETERS ### -DefaultProfile @@ -76,7 +116,7 @@ The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription. ```yaml -Type: PSObject +Type: System.Management.Automation.PSObject Parameter Sets: (All) Aliases: AzureRMContext, AzureCredential @@ -91,7 +131,7 @@ Accept wildcard characters: False The display name for the senderUsername. ```yaml -Type: String +Type: System.String Parameter Sets: UpdateExpanded, UpdateViaIdentityEmailServiceExpanded, UpdateViaIdentityDomainExpanded, UpdateViaIdentityExpanded Aliases: @@ -106,7 +146,7 @@ Accept wildcard characters: False Identity Parameter ```yaml -Type: IEmailServiceIdentity +Type: Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.IEmailServiceIdentity Parameter Sets: UpdateViaIdentityDomainExpanded, UpdateViaIdentityDomain Aliases: @@ -121,7 +161,7 @@ Accept wildcard characters: False The name of the Domains resource. ```yaml -Type: String +Type: System.String Parameter Sets: UpdateExpanded, UpdateViaIdentityEmailServiceExpanded, UpdateViaIdentityEmailService Aliases: @@ -136,7 +176,7 @@ Accept wildcard characters: False Identity Parameter ```yaml -Type: IEmailServiceIdentity +Type: Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.IEmailServiceIdentity Parameter Sets: UpdateViaIdentityEmailServiceExpanded, UpdateViaIdentityEmailService Aliases: @@ -151,7 +191,7 @@ Accept wildcard characters: False The name of the EmailService resource. ```yaml -Type: String +Type: System.String Parameter Sets: UpdateExpanded Aliases: @@ -166,7 +206,7 @@ Accept wildcard characters: False Identity Parameter ```yaml -Type: IEmailServiceIdentity +Type: Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.IEmailServiceIdentity Parameter Sets: UpdateViaIdentityExpanded Aliases: @@ -181,7 +221,7 @@ Accept wildcard characters: False A class representing a SenderUsername resource. ```yaml -Type: ISenderUsernameResource +Type: Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.ISenderUsernameResource Parameter Sets: UpdateViaIdentityEmailService, UpdateViaIdentityDomain Aliases: @@ -196,7 +236,7 @@ Accept wildcard characters: False {{ Fill ProgressAction Description }} ```yaml -Type: ActionPreference +Type: System.Management.Automation.ActionPreference Parameter Sets: (All) Aliases: proga @@ -212,7 +252,7 @@ The name of the resource group. The name is case insensitive. ```yaml -Type: String +Type: System.String Parameter Sets: UpdateExpanded Aliases: @@ -227,7 +267,7 @@ Accept wildcard characters: False The valid sender Username. ```yaml -Type: String +Type: System.String Parameter Sets: UpdateExpanded, UpdateViaIdentityEmailServiceExpanded, UpdateViaIdentityEmailService, UpdateViaIdentityDomainExpanded, UpdateViaIdentityDomain Aliases: @@ -243,13 +283,13 @@ The ID of the target subscription. The value must be an UUID. ```yaml -Type: String +Type: System.String Parameter Sets: UpdateExpanded Aliases: Required: False Position: Named -Default value: None +Default value: (Get-AzContext).Subscription.Id Accept pipeline input: False Accept wildcard characters: False ``` @@ -258,7 +298,7 @@ Accept wildcard characters: False A sender senderUsername to be used when sending emails. ```yaml -Type: String +Type: System.String Parameter Sets: UpdateExpanded, UpdateViaIdentityEmailServiceExpanded, UpdateViaIdentityDomainExpanded, UpdateViaIdentityExpanded Aliases: @@ -273,7 +313,7 @@ Accept wildcard characters: False Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -289,7 +329,7 @@ Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi @@ -306,51 +346,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS ### Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.IEmailServiceIdentity -### Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.ISenderUsernameResource -## OUTPUTS ### Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.ISenderUsernameResource -## NOTES -COMPLEX PARAMETER PROPERTIES - -To create the parameters described below, construct a hash table containing the appropriate properties. -For information on hash tables, run Get-Help about_Hash_Tables. -DOMAININPUTOBJECT \: Identity Parameter - \[DomainName \\]: The name of the Domains resource. - \[EmailServiceName \\]: The name of the EmailService resource. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SenderUsername \\]: The valid sender Username. - \[SubscriptionId \\]: The ID of the target subscription. -The value must be an UUID. - -EMAILSERVICEINPUTOBJECT \: Identity Parameter - \[DomainName \\]: The name of the Domains resource. - \[EmailServiceName \\]: The name of the EmailService resource. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SenderUsername \\]: The valid sender Username. - \[SubscriptionId \\]: The ID of the target subscription. -The value must be an UUID. +## OUTPUTS -INPUTOBJECT \: Identity Parameter - \[DomainName \\]: The name of the Domains resource. - \[EmailServiceName \\]: The name of the EmailService resource. - \[Id \\]: Resource identity path - \[ResourceGroupName \\]: The name of the resource group. -The name is case insensitive. - \[SenderUsername \\]: The valid sender Username. - \[SubscriptionId \\]: The ID of the target subscription. -The value must be an UUID. +### Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.ISenderUsernameResource -PARAMETER \: A class representing a SenderUsername resource. - \[DisplayName \\]: The display name for the senderUsername. - \[Username \\]: A sender senderUsername to be used when sending emails. +## NOTES ## RELATED LINKS - -[https://learn.microsoft.com/powershell/module/az.communication/update-azemailservicesenderusername](https://learn.microsoft.com/powershell/module/az.communication/update-azemailservicesenderusername) -