feat: Add new ptn modules azd/apim-api (#3206)

## Description  Fixes [Azure/Azure-Verified-Modules/issues#1232](Azure/Azure-Verified-Modules#1232) ## Pipeline Reference  | Pipeline | | -------- | | [![avm.ptn.azd.apim-api](https://github.com/jianingwang123/bicep-registry-modules/actions/workflows/avm.ptn.azd.apim-api.yml/badge.svg?branch=apim-api)](https://github.com/jianingwang123/bicep-registry-modules/actions/workflows/avm.ptn.azd.apim-api.yml) | ## Type of Change  - [ ] Update to CI Environment or utilities (Non-module affecting changes) - [x] Azure Verified Module updates: - [ ] Bugfix containing backwards-compatible bug fixes, and I have NOT bumped the MAJOR or MINOR version in `version.json`: - [ ] Someone has opened a bug report issue, and I have included "Closes #{bug_report_issue_number}" in the PR description. - [ ] The bug was found by the module author, and no one has opened an issue to report it yet. - [ ] Feature update backwards compatible feature updates, and I have bumped the MINOR version in `version.json`. - [ ] Breaking changes and I have bumped the MAJOR version in `version.json`. - [ ] Update to documentation ## Checklist - [x] I'm sure there are no other open Pull Requests for the same update/change - [x] I have run `Set-AVMModule` locally to generate the supporting module files. - [x] My corresponding pipelines / checks run clean and green without any errors or warnings  @jongio for notification.
Azure · Sep 10, 2024 · 4ca0ccd · 4ca0ccd
1 parent e5ac2f6
commit 4ca0ccd
Show file tree

Hide file tree

Showing 11 changed files with 1,247 additions and 0 deletions.
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -12,6 +12,7 @@
 #/avm/ptn/avd-lza/management-plane/ @Azure/avm-ptn-avd-lza-managementplane-module-owners-bicep @Azure/avm-module-reviewers-bicep
 #/avm/ptn/avd-lza/networking/ @Azure/avm-ptn-avd-lza-networking-module-owners-bicep @Azure/avm-module-reviewers-bicep
 #/avm/ptn/avd-lza/session-hosts/ @Azure/avm-ptn-avd-lza-sessionhosts-module-owners-bicep @Azure/avm-module-reviewers-bicep
+/avm/ptn/azd/apim-api/ @Azure/avm-ptn-azd-apimapi-module-owners-bicep @Azure/avm-module-reviewers-bicep
 /avm/ptn/azd/container-apps/ @Azure/avm-ptn-azd-containerapps-module-owners-bicep @Azure/avm-module-reviewers-bicep
 /avm/ptn/azd/insights-dashboard/ @Azure/avm-ptn-azd-insightsdashboard-module-owners-bicep @Azure/avm-module-reviewers-bicep
 /avm/ptn/deployment-script/import-image-to-acr/ @Azure/avm-ptn-deploymentscript-importimagetoacr-module-owners-bicep @Azure/avm-module-reviewers-bicep

diff --git a/.github/ISSUE_TEMPLATE/avm_module_issue.yml b/.github/ISSUE_TEMPLATE/avm_module_issue.yml
@@ -47,6 +47,7 @@ body:
         # - "avm/ptn/avd-lza/management-plane"
         # - "avm/ptn/avd-lza/networking"
         # - "avm/ptn/avd-lza/session-hosts"
+        - "avm/ptn/azd/apim-api"
         - "avm/ptn/azd/container-apps"
         - "avm/ptn/azd/insights-dashboard"
         - "avm/ptn/deployment-script/import-image-to-acr"

diff --git a/.github/workflows/avm.ptn.azd.apim-api.yml b/.github/workflows/avm.ptn.azd.apim-api.yml
@@ -0,0 +1,88 @@
+name: "avm.ptn.azd.apim-api"
+
+on:
+    workflow_dispatch:
+      inputs:
+        staticValidation:
+          type: boolean
+          description: "Execute static validation"
+          required: false
+          default: true
+        deploymentValidation:
+          type: boolean
+          description: "Execute deployment validation"
+          required: false
+          default: true
+        removeDeployment:
+          type: boolean
+          description: "Remove deployed module"
+          required: false
+          default: true
+        customLocation:
+          type: string
+          description: "Default location overwrite (e.g., eastus)"
+          required: false
+    push:
+      branches:
+        - main
+      paths:
+        - ".github/actions/templates/avm-**"
+        - ".github/workflows/avm.template.module.yml"
+        - ".github/workflows/avm.ptn.azd.apim-api.yml"
+        - "avm/ptn/azd/apim-api/**"
+        - "avm/utilities/pipelines/**"
+        - "!avm/utilities/pipelines/platform/**"
+        - "!*/**/README.md"
+
+env:
+    modulePath: "avm/ptn/azd/apim-api"
+    workflowPath: ".github/workflows/avm.ptn.azd.apim-api.yml"
+
+concurrency:
+    group: ${{ github.workflow }}
+
+jobs:
+    ###########################
+    #   Initialize pipeline   #
+    ###########################
+    job_initialize_pipeline:
+      runs-on: ubuntu-latest
+      name: "Initialize pipeline"
+      steps:
+        - name: "Checkout"
+          uses: actions/checkout@v4
+          with:
+            fetch-depth: 0
+        - name: "Set input parameters to output variables"
+          id: get-workflow-param
+          uses: ./.github/actions/templates/avm-getWorkflowInput
+          with:
+            workflowPath: "${{ env.workflowPath}}"
+        - name: "Get module test file paths"
+          id: get-module-test-file-paths
+          uses: ./.github/actions/templates/avm-getModuleTestFiles
+          with:
+            modulePath: "${{ env.modulePath }}"
+      outputs:
+        workflowInput: ${{ steps.get-workflow-param.outputs.workflowInput }}
+        moduleTestFilePaths: ${{ steps.get-module-test-file-paths.outputs.moduleTestFilePaths }}
+        psRuleModuleTestFilePaths: ${{ steps.get-module-test-file-paths.outputs.psRuleModuleTestFilePaths }}
+        modulePath: "${{ env.modulePath }}"
+
+    ##############################
+    #   Call reusable workflow   #
+    ##############################
+    call-workflow-passing-data:
+      name: "Run"
+      permissions:
+        id-token: write # For OIDC
+        contents: write # For release tags
+      needs:
+        - job_initialize_pipeline
+      uses: ./.github/workflows/avm.template.module.yml
+      with:
+        workflowInput: "${{ needs.job_initialize_pipeline.outputs.workflowInput }}"
+        moduleTestFilePaths: "${{ needs.job_initialize_pipeline.outputs.moduleTestFilePaths }}"
+        psRuleModuleTestFilePaths: "${{ needs.job_initialize_pipeline.outputs.psRuleModuleTestFilePaths }}"
+        modulePath: "${{ needs.job_initialize_pipeline.outputs.modulePath}}"
+      secrets: inherit
diff --git a/avm/ptn/azd/apim-api/README.md b/avm/ptn/azd/apim-api/README.md
@@ -0,0 +1,217 @@
+# avm/ptn/azd/apim-api `[Azd/ApimApi]`
+
+Creates and configure an API within an API Management service instance.
+
+**Note:** This module is not intended for broad, generic use, as it was designed to cater for the requirements of the AZD CLI product. Feature requests and bug fix requests are welcome if they support the development of the AZD CLI but may not be incorporated if they aim to make this module more generic than what it needs to be for its primary use case.
+
+## Navigation
+
+- [Resource Types](#Resource-Types)
+- [Usage examples](#Usage-examples)
+- [Parameters](#Parameters)
+- [Outputs](#Outputs)
+- [Cross-referenced modules](#Cross-referenced-modules)
+- [Data Collection](#Data-Collection)
+
+## Resource Types
+
+| Resource Type | API Version |
+| :-- | :-- |
+| `Microsoft.ApiManagement/service/apis` | [2022-08-01](https://learn.microsoft.com/en-us/azure/templates/Microsoft.ApiManagement/2022-08-01/service/apis) |
+| `Microsoft.ApiManagement/service/apis/diagnostics` | [2022-08-01](https://learn.microsoft.com/en-us/azure/templates/Microsoft.ApiManagement/2022-08-01/service/apis/diagnostics) |
+| `Microsoft.ApiManagement/service/apis/policies` | [2022-08-01](https://learn.microsoft.com/en-us/azure/templates/Microsoft.ApiManagement/2022-08-01/service/apis/policies) |
+| `Microsoft.Web/sites/config` | [2022-09-01](https://learn.microsoft.com/en-us/azure/templates/Microsoft.Web/sites) |
+
+## Usage examples
+
+The following section provides usage examples for the module, which were used to validate and deploy the module successfully. For a full reference, please review the module's test folder in its repository.
+
+>**Note**: Each example lists all the required parameters first, followed by the rest - each in alphabetical order.
+
+>**Note**: To reference the module, please use the following syntax `br/public:avm/ptn/azd/apim-api:<version>`.
+
+- [Using only defaults](#example-1-using-only-defaults)
+
+### Example 1: _Using only defaults_
+
+This instance deploys the module with the minimum set of required parameters.
+
+
+<details>
+
+<summary>via Bicep module</summary>
+
+```bicep
+module apimApi 'br/public:avm/ptn/azd/apim-api:<version>' = {
+  name: 'apimApiDeployment'
+  params: {
+    // Required parameters
+    apiBackendUrl: '<apiBackendUrl>'
+    apiDescription: 'api description'
+    apiDisplayName: 'apd-aapmin'
+    apiName: 'an-aapmin001'
+    apiPath: 'apipath-aapmin'
+    name: '<name>'
+    webFrontendUrl: '<webFrontendUrl>'
+    // Non-required parameters
+    location: '<location>'
+  }
+}
+```
+
+</details>
+<p>
+
+<details>
+
+<summary>via JSON Parameter file</summary>
+
+```json
+{
+  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
+  "contentVersion": "1.0.0.0",
+  "parameters": {
+    // Required parameters
+    "apiBackendUrl": {
+      "value": "<apiBackendUrl>"
+    },
+    "apiDescription": {
+      "value": "api description"
+    },
+    "apiDisplayName": {
+      "value": "apd-aapmin"
+    },
+    "apiName": {
+      "value": "an-aapmin001"
+    },
+    "apiPath": {
+      "value": "apipath-aapmin"
+    },
+    "name": {
+      "value": "<name>"
+    },
+    "webFrontendUrl": {
+      "value": "<webFrontendUrl>"
+    },
+    // Non-required parameters
+    "location": {
+      "value": "<location>"
+    }
+  }
+}
+```
+
+</details>
+<p>
+
+
+## Parameters
+
+**Required parameters**
+
+| Parameter | Type | Description |
+| :-- | :-- | :-- |
+| [`apiBackendUrl`](#parameter-apibackendurl) | string | Absolute URL of the backend service implementing this API. |
+| [`apiDescription`](#parameter-apidescription) | string | Description of the API. May include HTML formatting tags. |
+| [`apiDisplayName`](#parameter-apidisplayname) | string | The Display Name of the API. |
+| [`apiName`](#parameter-apiname) | string | Resource name to uniquely identify this API within the API Management service instance. |
+| [`apiPath`](#parameter-apipath) | string | Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API. |
+| [`name`](#parameter-name) | string | Name of the API Management service instance. |
+| [`webFrontendUrl`](#parameter-webfrontendurl) | string | Absolute URL of the web frontend. |
+
+**Optional parameters**
+
+| Parameter | Type | Description |
+| :-- | :-- | :-- |
+| [`apiAppName`](#parameter-apiappname) | string | Resource name for backend Web App or Function App. |
+| [`enableTelemetry`](#parameter-enabletelemetry) | bool | Enable/Disable usage telemetry for module. |
+| [`location`](#parameter-location) | string | Location for all Resources. |
+
+### Parameter: `apiBackendUrl`
+
+Absolute URL of the backend service implementing this API.
+
+- Required: Yes
+- Type: string
+
+### Parameter: `apiDescription`
+
+Description of the API. May include HTML formatting tags.
+
+- Required: Yes
+- Type: string
+
+### Parameter: `apiDisplayName`
+
+The Display Name of the API.
+
+- Required: Yes
+- Type: string
+
+### Parameter: `apiName`
+
+Resource name to uniquely identify this API within the API Management service instance.
+
+- Required: Yes
+- Type: string
+
+### Parameter: `apiPath`
+
+Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.
+
+- Required: Yes
+- Type: string
+
+### Parameter: `name`
+
+Name of the API Management service instance.
+
+- Required: Yes
+- Type: string
+
+### Parameter: `webFrontendUrl`
+
+Absolute URL of the web frontend.
+
+- Required: Yes
+- Type: string
+
+### Parameter: `apiAppName`
+
+Resource name for backend Web App or Function App.
+
+- Required: No
+- Type: string
+- Default: `''`
+
+### Parameter: `enableTelemetry`
+
+Enable/Disable usage telemetry for module.
+
+- Required: No
+- Type: bool
+- Default: `True`
+
+### Parameter: `location`
+
+Location for all Resources.
+
+- Required: No
+- Type: string
+- Default: `[resourceGroup().location]`
+
+
+## Outputs
+
+| Output | Type | Description |
+| :-- | :-- | :-- |
+| `resourceGroupName` | string | The name of the resource group. |
+| `serviceApiUri` | string | The complete URL for accessing the API. |
+
+## Cross-referenced modules
+
+_None_
+
+## Data Collection
+
+The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described in the [repository](https://aka.ms/avm/telemetry). There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft’s privacy statement. Our privacy statement is located at <https://go.microsoft.com/fwlink/?LinkID=824704>. You can learn more about data collection and use in the help documentation and our privacy statement. Your use of the software operates as your consent to these practices.