Skip to content

Commit 76c9945

Browse files
committed
Updated the module name to EmailServicedata
1 parent 5169c09 commit 76c9945

27 files changed

+148
-156
lines changed

src/Communication/CommunicationServicesEmail.Autorest/Az.CommunicationServicesEmail.psd1

Lines changed: 0 additions & 23 deletions
This file was deleted.

src/Communication/CommunicationServicesEmail.Autorest/custom/README.md

Lines changed: 0 additions & 41 deletions
This file was deleted.

src/Communication/CommunicationServicesEmail.Autorest/docs/Az.CommunicationServicesEmail.md

Lines changed: 0 additions & 19 deletions
This file was deleted.

src/Communication/CommunicationServicesEmail.Autorest/docs/README.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

src/Communication/CommunicationServicesEmail.Autorest/test/env.json

Lines changed: 0 additions & 4 deletions
This file was deleted.

src/Communication/CommunicationServicesEmail.Autorest/test/localEnv.json

Lines changed: 0 additions & 4 deletions
This file was deleted.
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
@{
2+
GUID = '5168d495-7a9d-45d6-ab8f-9127f05ee378'
3+
RootModule = './Az.EmailServicedata.psm1'
4+
ModuleVersion = '0.1.0'
5+
CompatiblePSEditions = 'Core', 'Desktop'
6+
Author = 'Microsoft Corporation'
7+
CompanyName = 'Microsoft Corporation'
8+
Copyright = 'Microsoft Corporation. All rights reserved.'
9+
Description = 'Microsoft Azure PowerShell: EmailServicedata cmdlets'
10+
PowerShellVersion = '5.1'
11+
DotNetFrameworkVersion = '4.7.2'
12+
RequiredAssemblies = './bin/Az.EmailServicedata.private.dll'
13+
FormatsToProcess = './Az.EmailServicedata.format.ps1xml'
14+
FunctionsToExport = 'Get-AzEmailServicedataEmailSendResult', 'Send-AzEmailServicedataEmail'
15+
PrivateData = @{
16+
PSData = @{
17+
Tags = 'Azure', 'ResourceManager', 'ARM', 'PSModule', 'EmailServicedata'
18+
LicenseUri = 'https://aka.ms/azps-license'
19+
ProjectUri = 'https://github.com/Azure/azure-powershell'
20+
ReleaseNotes = ''
21+
}
22+
}
23+
}

src/Communication/CommunicationServicesEmail.Autorest/README.md renamed to src/Communication/EmailServicedata.Autorest/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- region Generated -->
2-
# Az.CommunicationServicesEmail
3-
This directory contains the PowerShell module for the CommunicationServicesEmail service.
2+
# Az.EmailServicedata
3+
This directory contains the PowerShell module for the EmailServicedata service.
44

55
---
66
## Info
@@ -20,7 +20,7 @@ This module was primarily generated via [AutoRest](https://github.com/Azure/auto
2020
AutoRest does not generate authentication code for the module. Authentication is handled via Az.Accounts by altering the HTTP payload before it is sent.
2121

2222
## Development
23-
For information on how to develop for `Az.CommunicationServicesEmail`, see [how-to.md](how-to.md).
23+
For information on how to develop for `Az.EmailServicedata`, see [how-to.md](how-to.md).
2424
<!-- endregion -->
2525

2626
### AutoRest Configuration
@@ -41,7 +41,7 @@ root-module-name: $(prefix).Communication
4141
# For new RP, the version is 0.1.0
4242
module-version: 0.1.0
4343
# Normally, title is the service name
44-
title: CommunicationServicesEmail
44+
title: EmailServicedata
4545
subject-prefix: $(service-name)
4646

4747
# If there are post APIs for some kinds of actions in the RP, you may need to
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Custom
2+
This directory contains custom implementation for non-generated cmdlets for the `Az.EmailServicedata` module. Both scripts (`.ps1`) and C# files (`.cs`) can be implemented here. They will be used during the build process in `build-module.ps1`, and create cmdlets into the `..\exports` folder. The only generated file into this folder is the `Az.EmailServicedata.custom.psm1`. This file should not be modified.
3+
4+
## Info
5+
- Modifiable: yes
6+
- Generated: partial
7+
- Committed: yes
8+
- Packaged: yes
9+
10+
## Details
11+
For `Az.EmailServicedata` to use custom cmdlets, it does this two different ways. We **highly recommend** creating script cmdlets, as they are easier to write and allow access to the other exported cmdlets. C# cmdlets *cannot access exported cmdlets*.
12+
13+
For C# cmdlets, they are compiled with the rest of the generated low-level cmdlets into the `./bin/Az.EmailServicedata.private.dll`. The names of the cmdlets (methods) and files must follow the `[cmdletName]_[variantName]` syntax used for generated cmdlets. The `variantName` is used as the `ParameterSetName`, so use something appropriate that doesn't clash with already created variant or parameter set names. You cannot use the `ParameterSetName` property in the `Parameter` attribute on C# cmdlets. Each cmdlet must be separated into variants using the same pattern as seen in the `generated/cmdlets` folder.
14+
15+
For script cmdlets, these are loaded via the `Az.EmailServicedata.custom.psm1`. Then, during the build process, this module is loaded and processed in the same manner as the C# cmdlets. The fundamental difference is the script cmdlets use the `ParameterSetName` attribute and C# cmdlets do not. To create a script cmdlet variant of a generated cmdlet, simply decorate all parameters in the script with the new `ParameterSetName` in the `Parameter` attribute. This will appropriately treat each parameter set as a separate variant when processed to be exported during the build.
16+
17+
## Purpose
18+
This allows the modules to have cmdlets that were not defined in the REST specification. It also allows combining logic using generated cmdlets. This is a level of customization beyond what can be done using the [readme configuration options](https://github.com/Azure/autorest/blob/master/docs/powershell/options.md) that are currently available. These custom cmdlets are then referenced by the cmdlets created at build-time in the `..\exports` folder.
19+
20+
## Usage
21+
The easiest way currently to start developing custom cmdlets is to copy an existing cmdlet. For C# cmdlets, copy one from the `generated/cmdlets` folder. For script cmdlets, build the project using `build-module.ps1` and copy one of the scripts from the `..\exports` folder. After that, if you want to add new parameter sets, follow the guidelines in the `Details` section above. For implementing a new cmdlets, at minimum, please keep these parameters:
22+
- Break
23+
- DefaultProfile
24+
- HttpPipelineAppend
25+
- HttpPipelinePrepend
26+
- Proxy
27+
- ProxyCredential
28+
- ProxyUseDefaultCredentials
29+
30+
These provide functionality to our HTTP pipeline and other useful features. In script, you can forward these parameters using `$PSBoundParameters` to the other cmdlets you're calling within `Az.EmailServicedata`. For C#, follow the usage seen in the `ProcessRecordAsync` method.
31+
32+
### Attributes
33+
For processing the cmdlets, we've created some additional attributes:
34+
- `Microsoft.Azure.PowerShell.Cmdlets.EmailServicedata.DescriptionAttribute`
35+
- Used in C# cmdlets to provide a high-level description of the cmdlet. This is propagated to reference documentation via [help comments](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comment_based_help) in the exported scripts.
36+
- `Microsoft.Azure.PowerShell.Cmdlets.EmailServicedata.DoNotExportAttribute`
37+
- Used in C# and script cmdlets to suppress creating an exported cmdlet at build-time. These cmdlets will *not be exposed* by `Az.EmailServicedata`.
38+
- `Microsoft.Azure.PowerShell.Cmdlets.EmailServicedata.InternalExportAttribute`
39+
- Used in C# cmdlets to route exported cmdlets to the `..\internal`, which are *not exposed* by `Az.EmailServicedata`. For more information, see [README.md](..\internal/README.md) in the `..\internal` folder.
40+
- `Microsoft.Azure.PowerShell.Cmdlets.EmailServicedata.ProfileAttribute`
41+
- Used in C# and script cmdlets to define which Azure profiles the cmdlet supports. This is only supported for Azure (`--azure`) modules.
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
Module Name: Az.EmailServicedata
3+
Module Guid: 5168d495-7a9d-45d6-ab8f-9127f05ee378
4+
Download Help Link: https://learn.microsoft.com/powershell/module/az.emailservicedata
5+
Help Version: 1.0.0.0
6+
Locale: en-US
7+
---
8+
9+
# Az.EmailServicedata Module
10+
## Description
11+
Microsoft Azure PowerShell: EmailServicedata cmdlets
12+
13+
## Az.EmailServicedata Cmdlets
14+
### [Get-AzEmailServicedataEmailSendResult](Get-AzEmailServicedataEmailSendResult.md)
15+
Gets the status of the email send operation.
16+
17+
### [Send-AzEmailServicedataEmail](Send-AzEmailServicedataEmail.md)
18+
Queues an email message to be sent to one or more recipients
19+
Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
22
external help file:
33
Module Name: Az.Communication
4-
online version: https://learn.microsoft.com/powershell/module/az.communication/get-azcommunicationservicesemailsendresult
4+
online version: https://learn.microsoft.com/powershell/module/az.communication/get-azemailservicedataemailsendresult
55
schema: 2.0.0
66
---
77

8-
# Get-AzCommunicationServicesEmailSendResult
8+
# Get-AzEmailServicedataEmailSendResult
99

1010
## SYNOPSIS
1111
Gets the status of the email send operation.
@@ -14,14 +14,14 @@ Gets the status of the email send operation.
1414

1515
### Get (Default)
1616
```
17-
Get-AzCommunicationServicesEmailSendResult -Endpoint <String> -OperationId <String>
18-
[-DefaultProfile <PSObject>] [<CommonParameters>]
17+
Get-AzEmailServicedataEmailSendResult -Endpoint <String> -OperationId <String> [-DefaultProfile <PSObject>]
18+
[<CommonParameters>]
1919
```
2020

2121
### GetViaIdentity
2222
```
23-
Get-AzCommunicationServicesEmailSendResult -Endpoint <String>
24-
-InputObject <ICommunicationServicesEmailIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>]
23+
Get-AzEmailServicedataEmailSendResult -Endpoint <String> -InputObject <IEmailServicedataIdentity>
24+
[-DefaultProfile <PSObject>] [<CommonParameters>]
2525
```
2626

2727
## DESCRIPTION
@@ -31,14 +31,14 @@ Gets the status of the email send operation.
3131

3232
### Example 1: Gets the status and operation id of the email send operation.
3333
```powershell
34-
Get-AzCommunicationServicesEmailSendResult -Endpoint "https://contoso.unitedstates.communications.azure.com" -OperationId 8540c0de-899f-5cce-acb5-3ec493af3800
34+
Get-AzEmailServicedataEmailSendResult -Endpoint "https://contoso.unitedstates.communications.azure.com" -OperationId 1111c0de-899f-5cce-acb5-3ec493af3800
3535
```
3636

3737
```output
3838
AdditionalInfo :
3939
Code :
4040
Detail :
41-
Id : 8540c0de-899f-5cce-acb5-3ec493af3800
41+
Id : 1111c0de-899f-5cce-acb5-3ec493af3800
4242
Message :
4343
ResourceGroupName :
4444
RetryAfter :
@@ -85,7 +85,7 @@ Accept wildcard characters: False
8585
Identity Parameter
8686
8787
```yaml
88-
Type: Microsoft.Azure.PowerShell.Cmdlets.CommunicationServicesEmail.Models.ICommunicationServicesEmailIdentity
88+
Type: Microsoft.Azure.PowerShell.Cmdlets.EmailServicedata.Models.IEmailServicedataIdentity
8989
Parameter Sets: GetViaIdentity
9090
Aliases:
9191

@@ -116,11 +116,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
116116
117117
## INPUTS
118118
119-
### Microsoft.Azure.PowerShell.Cmdlets.CommunicationServicesEmail.Models.ICommunicationServicesEmailIdentity
119+
### Microsoft.Azure.PowerShell.Cmdlets.EmailServicedata.Models.IEmailServicedataIdentity
120120
121121
## OUTPUTS
122122
123-
### Microsoft.Azure.PowerShell.Cmdlets.CommunicationServicesEmail.Models.IEmailSendResult
123+
### Microsoft.Azure.PowerShell.Cmdlets.EmailServicedata.Models.IEmailSendResult
124124
125125
## NOTES
126126
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Docs
2+
This directory contains the documentation of the cmdlets for the `Az.EmailServicedata` module. To run documentation generation, use the `generate-help.ps1` script at the root module folder. Files in this folder will *always be overridden on regeneration*. To update documentation examples, please use the `..\examples` folder.
3+
4+
## Info
5+
- Modifiable: no
6+
- Generated: all
7+
- Committed: yes
8+
- Packaged: yes
9+
10+
## Details
11+
The process of documentation generation loads `Az.EmailServicedata` and analyzes the exported cmdlets from the module. It recognizes the [help comments](https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comment_based_help) that are generated into the scripts in the `..\exports` folder. Additionally, when writing custom cmdlets in the `..\custom` folder, you can use the help comments syntax, which decorate the exported scripts at build-time. The documentation examples are taken from the `..\examples` folder.

0 commit comments

Comments
 (0)