Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/Communication/Communication/Az.Communication.psd1
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
#
# Generated by: Microsoft Corporation
#
# Generated on: 3/11/2024
# Generated on: 3/16/2024
#

@{
Expand Down
42 changes: 42 additions & 0 deletions src/Communication/Communication/help/Az.Communication.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,22 +17,64 @@ 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.

### [New-AzCommunicationServiceKey](New-AzCommunicationServiceKey.md)
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.

16 changes: 2 additions & 14 deletions src/Communication/Communication/help/Get-AzCommunicationService.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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 `<ICommunicationIdentity>`: Identity Parameter
- `[CommunicationServiceName <String>]`: The name of the CommunicationService resource.
- `[Id <String>]`: Resource identity path
- `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive.
- `[SubscriptionId <String>]`: The ID of the target subscription.

## RELATED LINKS
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -156,6 +157,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## NOTES

ALIASES

## RELATED LINKS
71 changes: 44 additions & 27 deletions src/Communication/Communication/help/Get-AzEmailService.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,24 +41,56 @@ 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 [email protected] User
global ContosoResource2 06-12-2021 20:22:48 [email protected] 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 : [email protected]
SystemDataCreatedByType : User
SystemDataLastModifiedAt : 12-02-2024 10:35:26
SystemDataLastModifiedBy : [email protected]
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
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

Expand All @@ -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:

Expand All @@ -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

Expand All @@ -103,7 +135,7 @@ Accept wildcard characters: False
{{ Fill ProgressAction Description }}

```yaml
Type: ActionPreference
Type: System.Management.Automation.ActionPreference
Parameter Sets: (All)
Aliases: proga

Expand All @@ -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:

Expand All @@ -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
```
Expand All @@ -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 \<IEmailServiceIdentity\>: Identity Parameter
\[DomainName \<String\>\]: The name of the Domains resource.
\[EmailServiceName \<String\>\]: The name of the EmailService resource.
\[Id \<String\>\]: Resource identity path
\[ResourceGroupName \<String\>\]: The name of the resource group.
The name is case insensitive.
\[SenderUsername \<String\>\]: The valid sender Username.
\[SubscriptionId \<String\>\]: 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)

Loading