Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Modules] Updated API version for Private Endpoints and enabled custom NIC name, ASG and Static IP support #2229

Merged
merged 9 commits into from
Oct 29, 2022

Conversation

ahmadabdalla
Copy link
Contributor

@ahmadabdalla ahmadabdalla commented Oct 15, 2022

Closes #2219

Description

Updated the API Version for Private Endpoints to 2022-05-01 and enabled the following properties:

  • Custom NIC name support
  • Application Security Groups
  • Static IP address support via the IpConfigurations property.

Created Parameter usage examples for the 3 new features and updated the Set-Readme Private Endpoint section to include these new features for all modules that support private endpoints

Finally: updated all modules documentation that use private endpoints to leverage the new API

  • Microsoft.AppConfiguration/configurationStores
  • MicrosoftAutomation/automationAccounts
  • Microsoft.Batch/batchAccounts
  • Microsoft.Cache/redis
  • Microsoft.CognitiveServices/accounts
  • Microsoft.ContainerRegistry/registries
  • Microsoft.DataFactory/factories
  • Microsoft.EventGrid/topics
  • Microsoft.EventHub/namespaces
  • Microsoftlnsights/privateLinkScopes
  • Microsoft.KeyVault/vaults
  • Microsoft.MachineLearningServices/workspaces
  • Microsoft.RecoveryServices/vaults
  • MicrosoftServiceBus/namespaces
  • MicrosoftSignalRService/webPubSub
  • MicrosoftSql/servers
  • MicrosoftStorage/storageAccounts
  • Microsoft.Synapse/privateLinkHubs
  • Microsoft.Synapse/workspaces
  • Microsoft.Web/sites
  • Microsoft.Web/staticSites

Pipeline references

For module/pipeline changes, please create and attach the status badge of your successful run.

Pipeline
Network: PrivateEndpoints
Storage: StorageAccounts
AppConfiguration: ConfigurationStores
Batch: BatchAccounts
Cache: Redis
DataFactory: Factories
EventHub: Namespaces
Insights: PrivateLinkScopes

Type of Change

Please delete options that are not relevant.

  • New feature (non-breaking change which adds functionality)

Checklist

  • I'm sure there are no other open Pull Requests for the same update/change
  • My corresponding pipelines / checks run clean and green without any errors or warnings
  • My code follows the style guidelines of this project
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation (readme)
  • I did format my code

@ahmadabdalla ahmadabdalla added the [cat] modules category: modules label Oct 15, 2022
@ahmadabdalla ahmadabdalla added this to the Release v0.8.0 milestone Oct 15, 2022
@ahmadabdalla ahmadabdalla self-assigned this Oct 15, 2022
@ahmadabdalla ahmadabdalla added this to Ready for review in Backlog via automation Oct 15, 2022
@ahmadabdalla ahmadabdalla changed the title Updated API version for Private Endpoints and enabled custom NIC name, ASG and Static IP support [Modules] Updated API version for Private Endpoints and enabled custom NIC name, ASG and Static IP support Oct 15, 2022
@ahmadabdalla ahmadabdalla moved this from Ready for review to In progress in Backlog Oct 15, 2022
@github-actions
Copy link

github-actions bot commented Oct 24, 2022

Unit Test Results

    1 files  ±    0      1 suites  ±0   3m 17s ⏱️ + 2m 44s
441 tests +389  435 ✔️ +384    6 💤 +5  0 ±0 
475 runs  +423  465 ✔️ +414  10 💤 +9  0 ±0 

Results for commit cadfeb8. ± Comparison against base commit aff7708.

This pull request removes 52 and adds 441 tests. Note that renamed tests count towards both.
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ API version tests [All apiVersions in the template should be 'recent'].In [Microsoft.VirtualMachineImages/imageTemplates] used resource type [imageTemplates] should use one of the recent API version(s). Currently using [2020-02-14]
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ API version tests [All apiVersions in the template should be 'recent'].In [Microsoft.VirtualMachineImages/imageTemplates] used resource type [locks] should use one of the recent API version(s). Currently using [2017-04-01]
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ API version tests [All apiVersions in the template should be 'recent'].In [Microsoft.VirtualMachineImages/imageTemplates] used resource type [roleassignments] should use one of the recent API version(s). Currently using [2022-04-01]
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ Deployment template tests.Deployment template tests.[Microsoft.VirtualMachineImages/imageTemplates] All apiVersion properties should be set to a static, hard-coded value
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ Deployment template tests.Deployment template tests.[Microsoft.VirtualMachineImages/imageTemplates] All non-required parameters in template file should not have description that start with "Required."
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ Deployment template tests.Deployment template tests.[Microsoft.VirtualMachineImages/imageTemplates] All parameters in parameters files exist in template file (deploy.json)
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ Deployment template tests.Deployment template tests.[Microsoft.VirtualMachineImages/imageTemplates] All required parameters in template file (deploy.json) should exist in parameters files
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ Deployment template tests.Deployment template tests.[Microsoft.VirtualMachineImages/imageTemplates] CUA ID deployment should be present in the template
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ Deployment template tests.Deployment template tests.[Microsoft.VirtualMachineImages/imageTemplates] Conditional parameters' description should contain 'Required if' followed by the condition making the parameter required.
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ Deployment template tests.Deployment template tests.[Microsoft.VirtualMachineImages/imageTemplates] If delete lock is implemented, the template should have a lock parameter with the default value of ['']
…
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ API version tests [All apiVersions in the template should be 'recent'].In [Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies] used resource type [storageAccounts/blobServices/containers/immutabilityPolicies] should use one of the recent API version(s). Currently using [2021-09-01]
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ API version tests [All apiVersions in the template should be 'recent'].In [Microsoft.Storage/storageAccounts/blobServices/containers] used resource type [roleassignments] should use one of the recent API version(s). Currently using [2022-04-01]
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ API version tests [All apiVersions in the template should be 'recent'].In [Microsoft.Storage/storageAccounts/blobServices/containers] used resource type [storageAccounts/blobServices/containers/immutabilityPolicies] should use one of the recent API version(s). Currently using [2021-09-01]
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ API version tests [All apiVersions in the template should be 'recent'].In [Microsoft.Storage/storageAccounts/blobServices/containers] used resource type [storageAccounts/blobServices/containers] should use one of the recent API version(s). Currently using [2021-09-01]
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ API version tests [All apiVersions in the template should be 'recent'].In [Microsoft.Storage/storageAccounts/blobServices] used resource type [diagnosticsettings] should use one of the recent API version(s). Currently using [2021-05-01-preview]
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ API version tests [All apiVersions in the template should be 'recent'].In [Microsoft.Storage/storageAccounts/blobServices] used resource type [roleassignments] should use one of the recent API version(s). Currently using [2022-04-01]
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ API version tests [All apiVersions in the template should be 'recent'].In [Microsoft.Storage/storageAccounts/blobServices] used resource type [storageAccounts/blobServices/containers/immutabilityPolicies] should use one of the recent API version(s). Currently using [2021-09-01]
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ API version tests [All apiVersions in the template should be 'recent'].In [Microsoft.Storage/storageAccounts/blobServices] used resource type [storageAccounts/blobServices/containers] should use one of the recent API version(s). Currently using [2021-09-01]
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ API version tests [All apiVersions in the template should be 'recent'].In [Microsoft.Storage/storageAccounts/blobServices] used resource type [storageAccounts/blobServices] should use one of the recent API version(s). Currently using [2021-09-01]
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ API version tests [All apiVersions in the template should be 'recent'].In [Microsoft.Storage/storageAccounts/fileServices/shares] used resource type [roleassignments] should use one of the recent API version(s). Currently using [2022-04-01]
…
This pull request removes 1 skipped test and adds 6 skipped tests. Note that renamed tests count towards both.
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ File/folder tests..test folder.[Microsoft.VirtualMachineImages/imageTemplates] *parameters.json files in the .test folder should be valid json
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ Deployment template tests.Deployment template tests.[Microsoft.Storage/storageAccounts/blobServices/containers/immutabilityPolicies] Variable names should be camel-cased (no dashes or underscores and must start with lower-case letter)
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ Deployment template tests.Deployment template tests.[Microsoft.Storage/storageAccounts/fileServices/shares] Variable names should be camel-cased (no dashes or underscores and must start with lower-case letter)
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ Deployment template tests.Deployment template tests.[Microsoft.Storage/storageAccounts/managementPolicies] Variable names should be camel-cased (no dashes or underscores and must start with lower-case letter)
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ Deployment template tests.Deployment template tests.[Microsoft.Storage/storageAccounts/queueServices/queues] Variable names should be camel-cased (no dashes or underscores and must start with lower-case letter)
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ Deployment template tests.Deployment template tests.[Microsoft.Storage/storageAccounts/tableServices/tables] Variable names should be camel-cased (no dashes or underscores and must start with lower-case letter)
/home/runner/work/ResourceModules/ResourceModules/utilities/pipelines/staticValidation/module.tests.ps1 ‑ File/folder tests..test folder.[Microsoft.Storage/storageAccounts] *parameters.json files in the .test folder should be valid json

♻️ This comment has been updated with latest results.

@ahmadabdalla ahmadabdalla added the enhancement New feature or request label Oct 29, 2022
@ahmadabdalla ahmadabdalla marked this pull request as ready for review October 29, 2022 03:23
@ahmadabdalla ahmadabdalla requested a review from a team as a code owner October 29, 2022 03:23
@ahmadabdalla
Copy link
Contributor Author

Subsequent PR will be raised to update the Set-Readme documentation to include guidance on how to use the new features.

@ahmadabdalla ahmadabdalla merged commit 9fb101e into main Oct 29, 2022
Backlog automation moved this from In progress to Done Oct 29, 2022
@ahmadabdalla ahmadabdalla deleted the users/ahmad/2219_privateEndpoint branch October 29, 2022 11:02
@eriqua eriqua removed this from the Release v0.8.0 milestone Nov 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[cat] modules category: modules enhancement New feature or request hacktoberfest-accepted
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

[Feature Request]: Update the Private Endpoint Module API Version, Allowing Custom Name for the PE NIC
3 participants