Skip to content

Commit 4775a4b

Browse files
Move Communication to main (#24385)
1 parent 6437569 commit 4775a4b

24 files changed

+800
-714
lines changed

src/Communication/Communication/Az.Communication.psd1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
#
44
# Generated by: Microsoft Corporation
55
#
6-
# Generated on: 3/11/2024
6+
# Generated on: 3/16/2024
77
#
88

99
@{

src/Communication/Communication/help/Az.Communication.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,22 +17,64 @@ Get the CommunicationService and its properties.
1717
### [Get-AzCommunicationServiceKey](Get-AzCommunicationServiceKey.md)
1818
Get the access keys of the CommunicationService resource.
1919

20+
### [Get-AzEmailService](Get-AzEmailService.md)
21+
Get the EmailService and its properties.
22+
23+
### [Get-AzEmailServiceDomain](Get-AzEmailServiceDomain.md)
24+
Get the Domains resource and its properties.
25+
26+
### [Get-AzEmailServiceSenderUsername](Get-AzEmailServiceSenderUsername.md)
27+
Get a valid sender username for a domains resource.
28+
29+
### [Invoke-AzEmailServiceInitiateDomainVerification](Invoke-AzEmailServiceInitiateDomainVerification.md)
30+
Initiate verification of DNS record.
31+
2032
### [New-AzCommunicationService](New-AzCommunicationService.md)
2133
Create a new CommunicationService or update an existing CommunicationService.
2234

2335
### [New-AzCommunicationServiceKey](New-AzCommunicationServiceKey.md)
2436
Regenerate CommunicationService access key.
2537
PrimaryKey and SecondaryKey cannot be regenerated at the same time.
2638

39+
### [New-AzEmailService](New-AzEmailService.md)
40+
Create a new EmailService or update an existing EmailService.
41+
42+
### [New-AzEmailServiceDomain](New-AzEmailServiceDomain.md)
43+
Add a new Domains resource under the parent EmailService resource or update an existing Domains resource.
44+
45+
### [New-AzEmailServiceSenderUsername](New-AzEmailServiceSenderUsername.md)
46+
Add a new SenderUsername resource under the parent Domains resource or update an existing SenderUsername resource.
47+
2748
### [Remove-AzCommunicationService](Remove-AzCommunicationService.md)
2849
Operation to delete a CommunicationService.
2950

51+
### [Remove-AzEmailService](Remove-AzEmailService.md)
52+
Operation to delete a EmailService.
53+
54+
### [Remove-AzEmailServiceDomain](Remove-AzEmailServiceDomain.md)
55+
Operation to delete a Domains resource.
56+
57+
### [Remove-AzEmailServiceSenderUsername](Remove-AzEmailServiceSenderUsername.md)
58+
Operation to delete a SenderUsernames resource.
59+
3060
### [Set-AzCommunicationServiceNotificationHub](Set-AzCommunicationServiceNotificationHub.md)
3161
Links an Azure Notification Hub to this communication service.
3262

63+
### [Stop-AzEmailServiceDomainVerification](Stop-AzEmailServiceDomainVerification.md)
64+
Cancel verification of DNS record.
65+
3366
### [Test-AzCommunicationServiceNameAvailability](Test-AzCommunicationServiceNameAvailability.md)
3467
Checks that the CommunicationService name is valid and is not already in use.
3568

3669
### [Update-AzCommunicationService](Update-AzCommunicationService.md)
3770
Operation to update an existing CommunicationService.
3871

72+
### [Update-AzEmailService](Update-AzEmailService.md)
73+
Operation to update an existing EmailService.
74+
75+
### [Update-AzEmailServiceDomain](Update-AzEmailServiceDomain.md)
76+
Operation to update an existing Domains resource.
77+
78+
### [Update-AzEmailServiceSenderUsername](Update-AzEmailServiceSenderUsername.md)
79+
Add a new SenderUsername resource under the parent Domains resource or update an existing SenderUsername resource.
80+

src/Communication/Communication/help/Get-AzCommunicationService.md

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,8 @@ Returns the information on an ACS resource, if one matching provided parameters
7373
## PARAMETERS
7474

7575
### -DefaultProfile
76-
The credentials, account, tenant, and subscription used for communication with Azure.
76+
The DefaultProfile parameter is not functional.
77+
Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
7778

7879
```yaml
7980
Type: System.Management.Automation.PSObject
@@ -177,17 +178,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
177178
178179
## NOTES
179180
180-
ALIASES
181-
182-
COMPLEX PARAMETER PROPERTIES
183-
184-
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.
185-
186-
187-
INPUTOBJECT `<ICommunicationIdentity>`: Identity Parameter
188-
- `[CommunicationServiceName <String>]`: The name of the CommunicationService resource.
189-
- `[Id <String>]`: Resource identity path
190-
- `[ResourceGroupName <String>]`: The name of the resource group. The name is case insensitive.
191-
- `[SubscriptionId <String>]`: The ID of the target subscription.
192-
193181
## RELATED LINKS

src/Communication/Communication/help/Get-AzCommunicationServiceKey.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,8 @@ Accept wildcard characters: False
5454
```
5555
5656
### -DefaultProfile
57-
The credentials, account, tenant, and subscription used for communication with Azure.
57+
The DefaultProfile parameter is not functional.
58+
Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
5859
5960
```yaml
6061
Type: System.Management.Automation.PSObject
@@ -156,6 +157,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
156157
157158
## NOTES
158159
159-
ALIASES
160-
161160
## RELATED LINKS

src/Communication/Communication/help/Get-AzEmailService.md

Lines changed: 44 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -41,24 +41,56 @@ Get the EmailService and its properties.
4141

4242
## EXAMPLES
4343

44-
### EXAMPLE 1
45-
```
44+
### Example 1: List existing Email Services for a Subscription
45+
```powershell
4646
Get-AzCommunicationService -SubscriptionId 73fc3592-3cef-4300-5e19-8d18b65ce0e8
4747
```
4848

49-
### EXAMPLE 2
49+
```output
50+
Location Name SystemDataCreatedAt SystemDataCreatedBy SystemDataCreated
51+
ByType
52+
-------- ---- ------------------- ------------------- -----------------
53+
global ContosoResource1 06-12-2021 20:19:45 [email protected] User
54+
global ContosoResource2 06-12-2021 20:22:48 [email protected] User
5055
```
56+
57+
Returns a list of all ACS resources under that subscription.
58+
59+
### Example 2: Get infomation on specified Azure Email services resource
60+
```powershell
5161
Get-AzEmailService -Name ContosoAcsResource1 -ResourceGroupName ContosoResourceProvider1
5262
```
5363

64+
```output
65+
DataLocation : unitedstates
66+
Id : /subscriptions/653983b8-683a-427c-8c27-9e9624ce9176/resourceGroups/ContosoResourceProvider1/providers
67+
/Microsoft.Communication/emailServices/ContosoAcsResource1
68+
Location : global
69+
Name : ContosoAcsResource1
70+
ProvisioningState : Succeeded
71+
ResourceGroupName : ContosoResourceProvider1
72+
SystemDataCreatedAt : 08-12-2023 05:24:48
73+
SystemDataCreatedBy : [email protected]
74+
SystemDataCreatedByType : User
75+
SystemDataLastModifiedAt : 12-02-2024 10:35:26
76+
SystemDataLastModifiedBy : [email protected]
77+
SystemDataLastModifiedByType : User
78+
Tag : {
79+
"ExampleKey1": "UpdatedTagValue"
80+
}
81+
Type : microsoft.communication/emailservices
82+
```
83+
84+
Returns the information on an ACS resource, if one matching provided parameters is found.
85+
5486
## PARAMETERS
5587

5688
### -DefaultProfile
5789
The DefaultProfile parameter is not functional.
5890
Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
5991

6092
```yaml
61-
Type: PSObject
93+
Type: System.Management.Automation.PSObject
6294
Parameter Sets: (All)
6395
Aliases: AzureRMContext, AzureCredential
6496

@@ -73,7 +105,7 @@ Accept wildcard characters: False
73105
Identity Parameter
74106
75107
```yaml
76-
Type: IEmailServiceIdentity
108+
Type: Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.IEmailServiceIdentity
77109
Parameter Sets: GetViaIdentity
78110
Aliases:
79111

@@ -88,7 +120,7 @@ Accept wildcard characters: False
88120
The name of the EmailService resource.
89121
90122
```yaml
91-
Type: String
123+
Type: System.String
92124
Parameter Sets: Get
93125
Aliases: EmailServiceName
94126

@@ -103,7 +135,7 @@ Accept wildcard characters: False
103135
{{ Fill ProgressAction Description }}
104136
105137
```yaml
106-
Type: ActionPreference
138+
Type: System.Management.Automation.ActionPreference
107139
Parameter Sets: (All)
108140
Aliases: proga
109141

@@ -119,7 +151,7 @@ The name of the resource group.
119151
The name is case insensitive.
120152
121153
```yaml
122-
Type: String
154+
Type: System.String
123155
Parameter Sets: Get, List1
124156
Aliases:
125157

@@ -135,13 +167,13 @@ The ID of the target subscription.
135167
The value must be an UUID.
136168
137169
```yaml
138-
Type: String[]
170+
Type: System.String[]
139171
Parameter Sets: List, Get, List1
140172
Aliases:
141173

142174
Required: False
143175
Position: Named
144-
Default value: None
176+
Default value: (Get-AzContext).Subscription.Id
145177
Accept pipeline input: False
146178
Accept wildcard characters: False
147179
```
@@ -152,26 +184,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
152184
## INPUTS
153185
154186
### Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.IEmailServiceIdentity
187+
155188
## OUTPUTS
156189
157190
### Microsoft.Azure.PowerShell.Cmdlets.EmailService.Models.IEmailServiceResource
158-
## NOTES
159-
COMPLEX PARAMETER PROPERTIES
160191
161-
To create the parameters described below, construct a hash table containing the appropriate properties.
162-
For information on hash tables, run Get-Help about_Hash_Tables.
163-
164-
INPUTOBJECT \<IEmailServiceIdentity\>: Identity Parameter
165-
\[DomainName \<String\>\]: The name of the Domains resource.
166-
\[EmailServiceName \<String\>\]: The name of the EmailService resource.
167-
\[Id \<String\>\]: Resource identity path
168-
\[ResourceGroupName \<String\>\]: The name of the resource group.
169-
The name is case insensitive.
170-
\[SenderUsername \<String\>\]: The valid sender Username.
171-
\[SubscriptionId \<String\>\]: The ID of the target subscription.
172-
The value must be an UUID.
192+
## NOTES
173193
174194
## RELATED LINKS
175-
176-
[https://learn.microsoft.com/powershell/module/az.communication/get-azemailservice](https://learn.microsoft.com/powershell/module/az.communication/get-azemailservice)
177-

0 commit comments

Comments
 (0)