Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
segraef committed Feb 24, 2024
1 parent 9f024a2 commit 67f545f
Show file tree
Hide file tree
Showing 36 changed files with 609 additions and 323 deletions.
4 changes: 2 additions & 2 deletions avm/res/automation/automation-account/job-schedule/main.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
"metadata": {
"_generator": {
"name": "bicep",
"version": "0.25.53.49325",
"templateHash": "4183701486282199551"
"version": "0.24.24.22086",
"templateHash": "14246826935635972197"
},
"name": "Automation Account Job Schedules",
"description": "This module deploys an Azure Automation Account Job Schedule.",
Expand Down
32 changes: 16 additions & 16 deletions avm/res/automation/automation-account/main.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
"metadata": {
"_generator": {
"name": "bicep",
"version": "0.25.53.49325",
"templateHash": "3223894986476226816"
"version": "0.24.24.22086",
"templateHash": "139832401033434251"
},
"name": "Automation Accounts",
"description": "This module deploys an Azure Automation Account.",
Expand Down Expand Up @@ -808,8 +808,8 @@
"metadata": {
"_generator": {
"name": "bicep",
"version": "0.25.53.49325",
"templateHash": "4277151232699761913"
"version": "0.24.24.22086",
"templateHash": "6758949567913452110"
},
"name": "Automation Account Modules",
"description": "This module deploys an Azure Automation Account Module.",
Expand Down Expand Up @@ -950,8 +950,8 @@
"metadata": {
"_generator": {
"name": "bicep",
"version": "0.25.53.49325",
"templateHash": "15445244253525012229"
"version": "0.24.24.22086",
"templateHash": "17013504570786383965"
},
"name": "Automation Account Schedules",
"description": "This module deploys an Azure Automation Account Schedule.",
Expand Down Expand Up @@ -1129,8 +1129,8 @@
"metadata": {
"_generator": {
"name": "bicep",
"version": "0.25.53.49325",
"templateHash": "16141039584915226874"
"version": "0.24.24.22086",
"templateHash": "12519596207626057781"
},
"name": "Automation Account Runbooks",
"description": "This module deploys an Azure Automation Account Runbook.",
Expand Down Expand Up @@ -1329,8 +1329,8 @@
"metadata": {
"_generator": {
"name": "bicep",
"version": "0.25.53.49325",
"templateHash": "4183701486282199551"
"version": "0.24.24.22086",
"templateHash": "14246826935635972197"
},
"name": "Automation Account Job Schedules",
"description": "This module deploys an Azure Automation Account Job Schedule.",
Expand Down Expand Up @@ -1457,8 +1457,8 @@
"metadata": {
"_generator": {
"name": "bicep",
"version": "0.25.53.49325",
"templateHash": "15605588341437540157"
"version": "0.24.24.22086",
"templateHash": "162568846997583805"
},
"name": "Automation Account Variables",
"description": "This module deploys an Azure Automation Account Variable.",
Expand Down Expand Up @@ -1572,8 +1572,8 @@
"metadata": {
"_generator": {
"name": "bicep",
"version": "0.25.53.49325",
"templateHash": "14301767156435143002"
"version": "0.24.24.22086",
"templateHash": "6280157469343577004"
},
"name": "Log Analytics Workspace Linked Services",
"description": "This module deploys a Log Analytics Workspace Linked Service.",
Expand Down Expand Up @@ -1891,8 +1891,8 @@
"metadata": {
"_generator": {
"name": "bicep",
"version": "0.25.53.49325",
"templateHash": "6467431009828483672"
"version": "0.24.24.22086",
"templateHash": "6362006893081858637"
},
"name": "Automation Account Software Update Configurations",
"description": "This module deploys an Azure Automation Account Software Update Configuration.",
Expand Down
4 changes: 2 additions & 2 deletions avm/res/automation/automation-account/module/main.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
"metadata": {
"_generator": {
"name": "bicep",
"version": "0.25.53.49325",
"templateHash": "4277151232699761913"
"version": "0.24.24.22086",
"templateHash": "6758949567913452110"
},
"name": "Automation Account Modules",
"description": "This module deploys an Azure Automation Account Module.",
Expand Down
4 changes: 2 additions & 2 deletions avm/res/automation/automation-account/runbook/main.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
"metadata": {
"_generator": {
"name": "bicep",
"version": "0.25.53.49325",
"templateHash": "16141039584915226874"
"version": "0.24.24.22086",
"templateHash": "12519596207626057781"
},
"name": "Automation Account Runbooks",
"description": "This module deploys an Azure Automation Account Runbook.",
Expand Down
4 changes: 2 additions & 2 deletions avm/res/automation/automation-account/schedule/main.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
"metadata": {
"_generator": {
"name": "bicep",
"version": "0.25.53.49325",
"templateHash": "15445244253525012229"
"version": "0.24.24.22086",
"templateHash": "17013504570786383965"
},
"name": "Automation Account Schedules",
"description": "This module deploys an Azure Automation Account Schedule.",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
"metadata": {
"_generator": {
"name": "bicep",
"version": "0.25.53.49325",
"templateHash": "6467431009828483672"
"version": "0.24.24.22086",
"templateHash": "6362006893081858637"
},
"name": "Automation Account Software Update Configurations",
"description": "This module deploys an Azure Automation Account Software Update Configuration.",
Expand Down
4 changes: 2 additions & 2 deletions avm/res/automation/automation-account/variable/main.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
"metadata": {
"_generator": {
"name": "bicep",
"version": "0.25.53.49325",
"templateHash": "15605588341437540157"
"version": "0.24.24.22086",
"templateHash": "162568846997583805"
},
"name": "Automation Account Variables",
"description": "This module deploys an Azure Automation Account Variable.",
Expand Down
60 changes: 48 additions & 12 deletions avm/res/batch/batch-account/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -260,6 +260,19 @@ module batchAccount 'br/public:avm/res/batch/batch-account:<version>' = {
roleDefinitionIdOrName: '<roleDefinitionIdOrName>'
}
]
service: 'batchAccount'
subnetResourceId: '<subnetResourceId>'
tags: {
Environment: 'Non-Prod'
'hidden-title': 'This is visible in the resource name'
Role: 'DeploymentValidation'
}
}
{
privateDnsZoneResourceIds: [
'<privateDNSZoneResourceId>'
]
service: 'nodeManagement'
subnetResourceId: '<subnetResourceId>'
tags: {
Environment: 'Non-Prod'
Expand Down Expand Up @@ -395,6 +408,19 @@ module batchAccount 'br/public:avm/res/batch/batch-account:<version>' = {
"roleDefinitionIdOrName": "<roleDefinitionIdOrName>"
}
],
"service": "batchAccount",
"subnetResourceId": "<subnetResourceId>",
"tags": {
"Environment": "Non-Prod",
"hidden-title": "This is visible in the resource name",
"Role": "DeploymentValidation"
}
},
{
"privateDnsZoneResourceIds": [
"<privateDNSZoneResourceId>"
],
"service": "nodeManagement",
"subnetResourceId": "<subnetResourceId>",
"tags": {
"Environment": "Non-Prod",
Expand Down Expand Up @@ -482,6 +508,7 @@ module batchAccount 'br/public:avm/res/batch/batch-account:<version>' = {
privateDnsZoneResourceIds: [
'<privateDNSZoneResourceId>'
]
service: 'batchAccount'
subnetResourceId: '<subnetResourceId>'
}
]
Expand Down Expand Up @@ -549,6 +576,7 @@ module batchAccount 'br/public:avm/res/batch/batch-account:<version>' = {
"privateDnsZoneResourceIds": [
"<privateDNSZoneResourceId>"
],
"service": "batchAccount",
"subnetResourceId": "<subnetResourceId>"
}
]
Expand Down Expand Up @@ -1022,6 +1050,7 @@ Configuration details for private endpoints. For security reasons, it is recomme

| Parameter | Type | Description |
| :-- | :-- | :-- |
| [`service`](#parameter-privateendpointsservice) | string | The subresource to deploy the private endpoint for. For example "blob", "table", "queue" or "file". |
| [`subnetResourceId`](#parameter-privateendpointssubnetresourceid) | string | Resource ID of the subnet where the endpoint needs to be created. |

**Optional parameters**
Expand All @@ -1033,16 +1062,23 @@ Configuration details for private endpoints. For security reasons, it is recomme
| [`customNetworkInterfaceName`](#parameter-privateendpointscustomnetworkinterfacename) | string | The custom name of the network interface attached to the private endpoint. |
| [`enableTelemetry`](#parameter-privateendpointsenabletelemetry) | bool | Enable/Disable usage telemetry for module. |
| [`ipConfigurations`](#parameter-privateendpointsipconfigurations) | array | A list of IP configurations of the private endpoint. This will be used to map to the First Party Service endpoints. |
| [`isManualConnection`](#parameter-privateendpointsismanualconnection) | bool | If Manual Private Link Connection is required. |
| [`location`](#parameter-privateendpointslocation) | string | The location to deploy the private endpoint to. |
| [`lock`](#parameter-privateendpointslock) | object | Specify the type of lock. |
| [`manualPrivateLinkServiceConnections`](#parameter-privateendpointsmanualprivatelinkserviceconnections) | array | Manual PrivateLink Service Connections. |
| [`manualConnectionRequestMessage`](#parameter-privateendpointsmanualconnectionrequestmessage) | string | A message passed to the owner of the remote resource with the manual connection request. Restricted to 140 chars. |
| [`name`](#parameter-privateendpointsname) | string | The name of the private endpoint. |
| [`privateDnsZoneGroupName`](#parameter-privateendpointsprivatednszonegroupname) | string | The name of the private DNS zone group to create if `privateDnsZoneResourceIds` were provided. |
| [`privateDnsZoneResourceIds`](#parameter-privateendpointsprivatednszoneresourceids) | array | The private DNS zone groups to associate the private endpoint with. A DNS zone group can support up to 5 DNS zones. |
| [`roleAssignments`](#parameter-privateendpointsroleassignments) | array | Array of role assignments to create. |
| [`service`](#parameter-privateendpointsservice) | string | The service (sub-) type to deploy the private endpoint for. For example "vault" or "blob". |
| [`tags`](#parameter-privateendpointstags) | object | Tags to be applied on all resources/resource groups in this deployment. |

### Parameter: `privateEndpoints.service`

The subresource to deploy the private endpoint for. For example "blob", "table", "queue" or "file".

- Required: Yes
- Type: string

### Parameter: `privateEndpoints.subnetResourceId`

Resource ID of the subnet where the endpoint needs to be created.
Expand Down Expand Up @@ -1156,6 +1192,13 @@ A private IP address obtained from the private endpoint's subnet.
- Required: Yes
- Type: string

### Parameter: `privateEndpoints.isManualConnection`

If Manual Private Link Connection is required.

- Required: No
- Type: bool

### Parameter: `privateEndpoints.location`

The location to deploy the private endpoint to.
Expand Down Expand Up @@ -1199,12 +1242,12 @@ Specify the name of lock.
- Required: No
- Type: string

### Parameter: `privateEndpoints.manualPrivateLinkServiceConnections`
### Parameter: `privateEndpoints.manualConnectionRequestMessage`

Manual PrivateLink Service Connections.
A message passed to the owner of the remote resource with the manual connection request. Restricted to 140 chars.

- Required: No
- Type: array
- Type: string

### Parameter: `privateEndpoints.name`

Expand Down Expand Up @@ -1316,13 +1359,6 @@ The principal type of the assigned principal ID.
]
```

### Parameter: `privateEndpoints.service`

The service (sub-) type to deploy the private endpoint for. For example "vault" or "blob".

- Required: No
- Type: string

### Parameter: `privateEndpoints.tags`

Tags to be applied on all resources/resource groups in this deployment.
Expand Down
48 changes: 20 additions & 28 deletions avm/res/batch/batch-account/main.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
"metadata": {
"_generator": {
"name": "bicep",
"version": "0.25.53.49325",
"templateHash": "2397736043296643387"
"version": "0.24.24.22086",
"templateHash": "18272738624063996498"
},
"name": "Batch Accounts",
"description": "This module deploys a Batch Account.",
Expand Down Expand Up @@ -220,9 +220,8 @@
},
"service": {
"type": "string",
"nullable": true,
"metadata": {
"description": "Optional. The service (sub-) type to deploy the private endpoint for. For example \"vault\" or \"blob\"."
"description": "Required. The subresource to deploy the private endpoint for. For example \"blob\", \"table\", \"queue\" or \"file\"."
}
},
"subnetResourceId": {
Expand All @@ -248,6 +247,20 @@
"description": "Optional. The private DNS zone groups to associate the private endpoint with. A DNS zone group can support up to 5 DNS zones."
}
},
"isManualConnection": {
"type": "bool",
"nullable": true,
"metadata": {
"description": "Optional. If Manual Private Link Connection is required."
}
},
"manualConnectionRequestMessage": {
"type": "string",
"nullable": true,
"metadata": {
"description": "Optional. A message passed to the owner of the remote resource with the manual connection request. Restricted to 140 chars."
}
},
"customDnsConfigs": {
"type": "array",
"items": {
Expand Down Expand Up @@ -357,13 +370,6 @@
"description": "Optional. Tags to be applied on all resources/resource groups in this deployment."
}
},
"manualPrivateLinkServiceConnections": {
"type": "array",
"nullable": true,
"metadata": {
"description": "Optional. Manual PrivateLink Service Connections."
}
},
"enableTelemetry": {
"type": "bool",
"nullable": true,
Expand Down Expand Up @@ -826,22 +832,11 @@
},
"mode": "Incremental",
"parameters": {
"privateLinkServiceConnections": {
"value": [
{
"name": "[parameters('name')]",
"properties": {
"privateLinkServiceId": "[resourceId('Microsoft.Batch/batchAccounts', parameters('name'))]",
"groupIds": [
"[coalesce(tryGet(coalesce(parameters('privateEndpoints'), createArray())[copyIndex()], 'service'), 'batchAccount')]"
]
}
}
]
},
"name": {
"value": "[coalesce(tryGet(coalesce(parameters('privateEndpoints'), createArray())[copyIndex()], 'name'), format('pep-{0}-{1}-{2}', last(split(resourceId('Microsoft.Batch/batchAccounts', parameters('name')), '/')), coalesce(tryGet(coalesce(parameters('privateEndpoints'), createArray())[copyIndex()], 'service'), 'batchAccount'), copyIndex()))]"
"value": "[coalesce(tryGet(coalesce(parameters('privateEndpoints'), createArray())[copyIndex()], 'name'), format('pep-{0}-{1}-{2}', last(split(resourceId('Microsoft.Batch/batchAccounts', parameters('name')), '/')), coalesce(parameters('privateEndpoints'), createArray())[copyIndex()].service, copyIndex()))]"
},
"privateLinkServiceConnections": "[if(not(equals(tryGet(coalesce(parameters('privateEndpoints'), createArray())[copyIndex()], 'manualPrivateLinkServiceConnections'), true())), createObject('value', createArray(createObject('name', coalesce(tryGet(coalesce(parameters('privateEndpoints'), createArray())[copyIndex()], 'privateLinkServiceConnectionName'), format('{0}-{1}-{2}', last(split(resourceId('Microsoft.Batch/batchAccounts', parameters('name')), '/')), coalesce(parameters('privateEndpoints'), createArray())[copyIndex()].service, copyIndex())), 'properties', createObject('privateLinkServiceId', resourceId('Microsoft.Batch/batchAccounts', parameters('name')), 'groupIds', createArray(coalesce(parameters('privateEndpoints'), createArray())[copyIndex()].service))))), createObject('value', null()))]",
"manualPrivateLinkServiceConnections": "[if(equals(tryGet(coalesce(parameters('privateEndpoints'), createArray())[copyIndex()], 'manualPrivateLinkServiceConnections'), true()), createObject('value', createArray(createObject('name', coalesce(tryGet(coalesce(parameters('privateEndpoints'), createArray())[copyIndex()], 'privateLinkServiceConnectionName'), format('{0}-{1}-{2}', last(split(resourceId('Microsoft.Batch/batchAccounts', parameters('name')), '/')), coalesce(parameters('privateEndpoints'), createArray())[copyIndex()].service, copyIndex())), 'properties', createObject('privateLinkServiceId', resourceId('Microsoft.Batch/batchAccounts', parameters('name')), 'groupIds', createArray(coalesce(parameters('privateEndpoints'), createArray())[copyIndex()].service), 'requestMessage', coalesce(tryGet(coalesce(parameters('privateEndpoints'), createArray())[copyIndex()], 'manualConnectionRequestMessage'), 'Manual approval required.'))))), createObject('value', null()))]",
"subnetResourceId": {
"value": "[coalesce(parameters('privateEndpoints'), createArray())[copyIndex()].subnetResourceId]"
},
Expand All @@ -866,9 +861,6 @@
"tags": {
"value": "[coalesce(tryGet(coalesce(parameters('privateEndpoints'), createArray())[copyIndex()], 'tags'), parameters('tags'))]"
},
"manualPrivateLinkServiceConnections": {
"value": "[tryGet(coalesce(parameters('privateEndpoints'), createArray())[copyIndex()], 'manualPrivateLinkServiceConnections')]"
},
"customDnsConfigs": {
"value": "[tryGet(coalesce(parameters('privateEndpoints'), createArray())[copyIndex()], 'customDnsConfigs')]"
},
Expand Down
Loading

0 comments on commit 67f545f

Please sign in to comment.