Get-AzEmailService
Get the EmailService and its properties.
Syntax
Get-AzEmailService
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>] Get-AzEmailService
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>] Get-AzEmailService
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>] Get-AzEmailService
-InputObject <IEmailServiceIdentity>
[-DefaultProfile <PSObject>]
[<CommonParameters>] Description
Get the EmailService and its properties.
Examples
Example 1: List existing Email Services for a Subscription
Get-AzCommunicationService -SubscriptionId 73fc3592-3cef-4300-5e19-8d18b65ce0e8
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 UserReturns a list of all ACS resources under that subscription.
Example 2: Get infomation on specified Azure Email services resource
Get-AzEmailService -Name ContosoAcsResource1 -ResourceGroupName ContosoResourceProvider1
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/emailservicesReturns 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.
| Type: | PSObject |
| Aliases: | AzureRMContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
Identity Parameter
| Type: | IEmailServiceIdentity |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
The name of the EmailService resource.
| Type: | String |
| Aliases: | EmailServiceName |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceGroupName
The name of the resource group. The name is case insensitive.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SubscriptionId
The ID of the target subscription. The value must be an UUID.
| Type: | String[] |
| Position: | Named |
| Default value: | (Get-AzContext).Subscription.Id |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |