PowerShell Support for Email Services Control Plane CRUD operations (#…

…24230) * Powershell Support for Email Services Control Plane CRUD operations - # 3442118 * Powershell Support for Email Services Control Plane CRUD operations - test recordings- #3442118 * Removed .gitignore * Updated test recordings * readme.md file root-module-name changes * Updated examples * Remove use autorest.powershell 4.x --------- Co-authored-by: Jin Lei <[email protected]>
Azure · Feb 28, 2024 · c590c38 · c590c38
1 parent dff1cf2
commit c590c38
Show file tree

Hide file tree

Showing 91 changed files with 19,488 additions and 0 deletions.
diff --git a/src/Communication/EmailService.Autorest/.gitattributes b/src/Communication/EmailService.Autorest/.gitattributes
@@ -0,0 +1 @@
+* text=auto
diff --git a/src/Communication/EmailService.Autorest/.gitignore b/src/Communication/EmailService.Autorest/.gitignore
@@ -0,0 +1,16 @@
+bin
+obj
+.vs
+generated
+internal
+exports
+tools
+custom/*.psm1
+custom/autogen-model-cmdlets
+test/*-TestResults.xml
+/*.ps1
+/*.ps1xml
+/*.psm1
+/*.snk
+/*.csproj
+/*.nuspec
diff --git a/src/Communication/EmailService.Autorest/Az.EmailService.psd1 b/src/Communication/EmailService.Autorest/Az.EmailService.psd1
@@ -0,0 +1,23 @@
+@{
+  GUID = '21bdebd2-08fb-474b-9b85-a6b7415bd1f2'
+  RootModule = './Az.EmailService.psm1'
+  ModuleVersion = '0.1.0'
+  CompatiblePSEditions = 'Core', 'Desktop'
+  Author = 'Microsoft Corporation'
+  CompanyName = 'Microsoft Corporation'
+  Copyright = 'Microsoft Corporation. All rights reserved.'
+  Description = 'Microsoft Azure PowerShell: EmailService cmdlets'
+  PowerShellVersion = '5.1'
+  DotNetFrameworkVersion = '4.7.2'
+  RequiredAssemblies = './bin/Az.EmailService.private.dll'
+  FormatsToProcess = './Az.EmailService.format.ps1xml'
+  FunctionsToExport = 'Get-AzEmailService', 'Get-AzEmailServiceDomain', 'Get-AzEmailServiceSenderUsername', 'Invoke-AzEmailServiceInitiateDomainVerification', 'New-AzEmailService', 'New-AzEmailServiceDomain', 'New-AzEmailServiceSenderUsername', 'Remove-AzEmailService', 'Remove-AzEmailServiceDomain', 'Remove-AzEmailServiceSenderUsername', 'Stop-AzEmailServiceDomainVerification', 'Update-AzEmailService', 'Update-AzEmailServiceDomain', 'Update-AzEmailServiceSenderUsername'
+  PrivateData = @{
+    PSData = @{
+      Tags = 'Azure', 'ResourceManager', 'ARM', 'PSModule', 'EmailService'
+      LicenseUri = 'https://aka.ms/azps-license'
+      ProjectUri = 'https://github.com/Azure/azure-powershell'
+      ReleaseNotes = ''
+    }
+  }
+}
diff --git a/src/Communication/EmailService.Autorest/README.md b/src/Communication/EmailService.Autorest/README.md
@@ -0,0 +1,80 @@
+<!-- region Generated -->
+# Az.EmailService
+This directory contains the PowerShell module for the EmailService service.
+
+---
+## Status
+[![Az.EmailService](https://img.shields.io/powershellgallery/v/Az.EmailService.svg?style=flat-square&label=Az.EmailService "Az.EmailService")](https://www.powershellgallery.com/packages/Az.EmailService/)
+
+## Info
+- Modifiable: yes
+- Generated: all
+- Committed: yes
+- Packaged: yes
+
+---
+## Detail
+This module was primarily generated via [AutoRest](https://github.com/Azure/autorest) using the [PowerShell](https://github.com/Azure/autorest.powershell) extension.
+
+## Module Requirements
+- [Az.Accounts module](https://www.powershellgallery.com/packages/Az.Accounts/), version 2.7.5 or greater
+
+## Authentication
+AutoRest does not generate authentication code for the module. Authentication is handled via Az.Accounts by altering the HTTP payload before it is sent.
+
+## Development
+For information on how to develop for `Az.EmailService`, see [how-to.md](how-to.md).
+<!-- endregion -->
+
+### AutoRest Configuration
+> see https://aka.ms/autorest
+
+``` yaml
+commit: 663ea6835c33bca216b63f777227db6a459a06b3
+require:
+# readme.azure.noprofile.md is the common configuration file
+  - $(this-folder)/../../readme.azure.noprofile.md
+input-file:
+# You need to specify your swagger files here.
+  - $(repo)/specification/communication/resource-manager/Microsoft.Communication/preview/2023-06-01-preview/EmailServices.json
+  - $(repo)/specification/communication/resource-manager/Microsoft.Communication/preview/2023-06-01-preview/Domains.json
+  - $(repo)/specification/communication/resource-manager/Microsoft.Communication/preview/2023-06-01-preview/SenderUsernames.json
+# If the swagger has not been put in the repo, you may uncomment the following line and refer to it locally
+# - (this-folder)/relative-path-to-your-swagger 
+
+root-module-name: $(prefix).Communication
+# For new RP, the version is 0.1.0
+module-version: 0.1.0
+# Normally, title is the service name
+title: EmailService
+subject-prefix: $(service-name)
+
+# If there are post APIs for some kinds of actions in the RP, you may need to 
+# uncomment following line to support viaIdentity for these post APIs
+# identity-correction-for-post: true
+
+directive:
+  # Following is two common directive which are normally required in all the RPs
+  # 1. Remove the unexpanded parameter set
+  # 2. For New-* cmdlets, ViaIdentity is not required, so CreateViaIdentityExpanded is removed as well
+  - where:
+      variant: ^Create$|^CreateViaIdentity$|^CreateViaIdentityExpanded$|^Update$|^UpdateViaIdentity$
+    remove: true
+  # Remove the set-* cmdlet
+  - where:
+      verb: Set
+    remove: true  
+  # Remove the GetEmailServiceVerifiedExchangeOnlineDomain cmdlet
+  - where:
+      verb: Get
+      subject: EmailServiceVerifiedExchangeOnlineDomain
+    remove: true
+  # set the location default value to global
+  - where:
+      parameter-name: Location
+    set:     
+      default:
+        name: Location default
+        description: Sets the Location default value to Global.
+        script: '"global"'   
+```
diff --git a/...ailService.Autorest/UX/Microsoft.Communication/emailServices-domains-senderUsernames.json b/...ailService.Autorest/UX/Microsoft.Communication/emailServices-domains-senderUsernames.json
@@ -0,0 +1,105 @@
+{
+  "resourceType": "emailServices/domains/senderUsernames",
+  "apiVersion": "2023-06-01-preview",
+  "learnMore": {
+    "url": "https://learn.microsoft.com/powershell/module/az.communication"
+  },
+  "commands": [
+    {
+      "name": "Get-AzEmailServiceSenderUsername",
+      "description": "Get a valid sender username for a domains resource.",
+      "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/emailServices/{emailServiceName}/domains/{domainName}/senderUsernames/{senderUsername}",
+      "help": {
+        "learnMore": {
+          "url": "https://learn.microsoft.com/powershell/module/az.communication/get-azemailservicesenderusername"
+        },
+        "parameterSets": [
+          {
+            "parameters": [
+              "-DomainName <String>",
+              "-EmailServiceName <String>",
+              "-ResourceGroupName <String>",
+              "-SenderUsername <String>",
+              "[-SubscriptionId <String[]>]"
+            ]
+          }
+        ]
+      },
+      "examples": [
+        {
+          "description": "Get a valid sender username for a domains resource.",
+          "parameters": [
+            {
+              "name": "-DomainName",
+              "value": "[Path.domainName]"
+            },
+            {
+              "name": "-EmailServiceName",
+              "value": "[Path.emailServiceName]"
+            },
+            {
+              "name": "-ResourceGroupName",
+              "value": "[Path.resourceGroupName]"
+            },
+            {
+              "name": "-SenderUsername",
+              "value": "[Path.senderUsername]"
+            },
+            {
+              "name": "-SubscriptionId",
+              "value": "[Path.subscriptionId]"
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "name": "Remove-AzEmailServiceSenderUsername",
+      "description": "Operation to delete a SenderUsernames resource.",
+      "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/emailServices/{emailServiceName}/domains/{domainName}/senderUsernames/{senderUsername}",
+      "help": {
+        "learnMore": {
+          "url": "https://learn.microsoft.com/powershell/module/az.communication/remove-azemailservicesenderusername"
+        },
+        "parameterSets": [
+          {
+            "parameters": [
+              "-DomainName <String>",
+              "-EmailServiceName <String>",
+              "-ResourceGroupName <String>",
+              "-SenderUsername <String>",
+              "[-SubscriptionId <String>]"
+            ]
+          }
+        ]
+      },
+      "examples": [
+        {
+          "description": "Operation to delete a SenderUsernames resource.",
+          "parameters": [
+            {
+              "name": "-DomainName",
+              "value": "[Path.domainName]"
+            },
+            {
+              "name": "-EmailServiceName",
+              "value": "[Path.emailServiceName]"
+            },
+            {
+              "name": "-ResourceGroupName",
+              "value": "[Path.resourceGroupName]"
+            },
+            {
+              "name": "-SenderUsername",
+              "value": "[Path.senderUsername]"
+            },
+            {
+              "name": "-SubscriptionId",
+              "value": "[Path.subscriptionId]"
+            }
+          ]
+        }
+      ]
+    }
+  ]
+}
diff --git a/...Communication/EmailService.Autorest/UX/Microsoft.Communication/emailServices-domains.json b/...Communication/EmailService.Autorest/UX/Microsoft.Communication/emailServices-domains.json
@@ -0,0 +1,95 @@
+{
+  "resourceType": "emailServices/domains",
+  "apiVersion": "2023-06-01-preview",
+  "learnMore": {
+    "url": "https://learn.microsoft.com/powershell/module/az.communication"
+  },
+  "commands": [
+    {
+      "name": "Get-AzEmailServiceDomain",
+      "description": "Get the Domains resource and its properties.",
+      "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/emailServices/{emailServiceName}/domains/{domainName}",
+      "help": {
+        "learnMore": {
+          "url": "https://learn.microsoft.com/powershell/module/az.communication/get-azemailservicedomain"
+        },
+        "parameterSets": [
+          {
+            "parameters": [
+              "-EmailServiceName <String>",
+              "-Name <String>",
+              "-ResourceGroupName <String>",
+              "[-SubscriptionId <String[]>]"
+            ]
+          }
+        ]
+      },
+      "examples": [
+        {
+          "description": "Get the Domains resource and its properties.",
+          "parameters": [
+            {
+              "name": "-EmailServiceName",
+              "value": "[Path.emailServiceName]"
+            },
+            {
+              "name": "-Name",
+              "value": "[Path.domainName]"
+            },
+            {
+              "name": "-ResourceGroupName",
+              "value": "[Path.resourceGroupName]"
+            },
+            {
+              "name": "-SubscriptionId",
+              "value": "[Path.subscriptionId]"
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "name": "Remove-AzEmailServiceDomain",
+      "description": "Operation to delete a Domains resource.",
+      "path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/emailServices/{emailServiceName}/domains/{domainName}",
+      "help": {
+        "learnMore": {
+          "url": "https://learn.microsoft.com/powershell/module/az.communication/remove-azemailservicedomain"
+        },
+        "parameterSets": [
+          {
+            "parameters": [
+              "-EmailServiceName <String>",
+              "-Name <String>",
+              "-ResourceGroupName <String>",
+              "[-SubscriptionId <String>]"
+            ]
+          }
+        ]
+      },
+      "examples": [
+        {
+          "description": "Operation to delete a Domains resource.",
+          "parameters": [
+            {
+              "name": "-EmailServiceName",
+              "value": "[Path.emailServiceName]"
+            },
+            {
+              "name": "-Name",
+              "value": "[Path.domainName]"
+            },
+            {
+              "name": "-ResourceGroupName",
+              "value": "[Path.resourceGroupName]"
+            },
+            {
+              "name": "-SubscriptionId",
+              "value": "[Path.subscriptionId]"
+            }
+          ]
+        }
+      ]
+    }
+  ]
+}