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.

Sign up for GitHub

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

Jump to bottom

Regenerated modules 241-300 #4088

Merged
merged 4 commits into from
Oct 16, 2023
Merged

Regenerated modules 241-300 #4088

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3ad8efe
Regen readmes 5
AlexanderSehr Oct 15, 2023
b410436
Fixed templates
AlexanderSehr Oct 15, 2023
d528e19
Regen
AlexanderSehr Oct 15, 2023
1602adb
Renamed header
AlexanderSehr Oct 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions modules/network/service-endpoint-policy/.test/common/main.test.bicep
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
targetScope = 'subscription'

metadata name = 'Using large parameter set'
metadata description = 'This instance deploys the module with most of its features enabled.'

// ========== //
// Parameters //
// ========== //
Expand Down
3 changes: 3 additions & 0 deletions modules/network/service-endpoint-policy/.test/min/main.test.bicep
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
targetScope = 'subscription'

metadata name = 'Using only defaults'
metadata description = 'This instance deploys the module with the minimum set of required parameters.'

// ========== //
// Parameters //
// ========== //
Expand Down
155 changes: 115 additions & 40 deletions modules/network/service-endpoint-policy/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ This module deploys a Service Endpoint Policy.
## Navigation

- [Resource Types](#Resource-Types)
- [Usage examples](#Usage-examples)
- [Parameters](#Parameters)
- [Outputs](#Outputs)
- [Cross-referenced modules](#Cross-referenced-modules)
- [Deployment examples](#Deployment-examples)

## Resource Types

Expand All @@ -18,56 +18,29 @@ This module deploys a Service Endpoint Policy.
| `Microsoft.Authorization/roleAssignments` | [2022-04-01](https://learn.microsoft.com/en-us/azure/templates/Microsoft.Authorization/2022-04-01/roleAssignments) |
| `Microsoft.Network/serviceEndpointPolicies` | [2023-04-01](https://learn.microsoft.com/en-us/azure/templates/Microsoft.Network/2023-04-01/serviceEndpointPolicies) |

## Parameters

**Required parameters**

| Parameter Name | Type | Description |
| :-- | :-- | :-- |
| `name` | string | The Service Endpoint Policy name. |

**Optional parameters**

| Parameter Name | Type | Default Value | Allowed Values | Description |
| :-- | :-- | :-- | :-- | :-- |
| `contextualServiceEndpointPolicies` | array | `[]` | | An Array of contextual service endpoint policy. |
| `enableDefaultTelemetry` | bool | `True` | | Enable telemetry via a Globally Unique Identifier (GUID). |
| `location` | string | `[resourceGroup().location]` | | Location for all resources. |
| `lock` | string | `''` | `['', CanNotDelete, ReadOnly]` | Specify the type of lock. |
| `roleAssignments` | array | `[]` | | Array of role assignment objects that contain the 'roleDefinitionIdOrName' and 'principalId' to define RBAC role assignments on this resource. In the roleDefinitionIdOrName attribute, you can provide either the display name of the role definition, or its fully qualified ID in the following format: '/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11'. |
| `serviceAlias` | string | `''` | | The alias indicating if the policy belongs to a service. |
| `serviceEndpointPolicyDefinitions` | array | `[]` | | An Array of service endpoint policy definitions. |
| `tags` | object | `{object}` | | Tags of the resource. |

## Usage examples

## Outputs

| Output Name | Type | Description |
| :-- | :-- | :-- |
| `location` | string | The location the resource was deployed into. |
| `name` | string | The name of the Service Endpoint Policy. |
| `resourceGroupName` | string | The resource group the Service Endpoint Policy was deployed into. |
| `resourceId` | string | The resource ID of the Service Endpoint Policy. |
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**: The name of each example is based on the name of the file from which it is taken.

## Cross-referenced modules
>**Note**: Each example lists all the required parameters first, followed by the rest - each in alphabetical order.

_None_
>**Note**: To reference the module, please use the following syntax `br:bicep/modules/network.service-endpoint-policy:1.0.0`.

## Deployment examples
- [Using large parameter set](#example-1-using-large-parameter-set)
- [Using only defaults](#example-2-using-only-defaults)

The following module usage examples are retrieved from the content of the files hosted in the module's `.test` folder.
>**Note**: The name of each example is based on the name of the file from which it is taken.
### Example 1: _Using large parameter set_

>**Note**: Each example lists all the required parameters first, followed by the rest - each in alphabetical order.
This instance deploys the module with most of its features enabled.

<h3>Example 1: Common</h3>

<details>

<summary>via Bicep module</summary>

```bicep
module serviceEndpointPolicy './network/service-endpoint-policy/main.bicep' = {
module serviceEndpointPolicy 'br:bicep/modules/network.service-endpoint-policy:1.0.0' = {
name: '${uniqueString(deployment().name, location)}-test-nsnpcom'
params: {
// Required parameters
Expand Down Expand Up @@ -169,14 +142,17 @@ module serviceEndpointPolicy './network/service-endpoint-policy/main.bicep' = {
</details>
<p>

<h3>Example 2: Min</h3>
### Example 2: _Using only defaults_

This instance deploys the module with the minimum set of required parameters.


<details>

<summary>via Bicep module</summary>

```bicep
module serviceEndpointPolicy './network/service-endpoint-policy/main.bicep' = {
module serviceEndpointPolicy 'br:bicep/modules/network.service-endpoint-policy:1.0.0' = {
name: '${uniqueString(deployment().name, location)}-test-nsnpmin'
params: {
// Required parameters
Expand Down Expand Up @@ -213,3 +189,102 @@ module serviceEndpointPolicy './network/service-endpoint-policy/main.bicep' = {

</details>
<p>


## Parameters

**Required parameters**

| Parameter | Type | Description |
| :-- | :-- | :-- |
| [`name`](#parameter-name) | string | The Service Endpoint Policy name. |

**Optional parameters**

| Parameter | Type | Description |
| :-- | :-- | :-- |
| [`contextualServiceEndpointPolicies`](#parameter-contextualserviceendpointpolicies) | array | An Array of contextual service endpoint policy. |
| [`enableDefaultTelemetry`](#parameter-enabledefaulttelemetry) | bool | Enable telemetry via a Globally Unique Identifier (GUID). |
| [`location`](#parameter-location) | string | Location for all resources. |
| [`lock`](#parameter-lock) | string | Specify the type of lock. |
| [`roleAssignments`](#parameter-roleassignments) | array | Array of role assignment objects that contain the 'roleDefinitionIdOrName' and 'principalId' to define RBAC role assignments on this resource. In the roleDefinitionIdOrName attribute, you can provide either the display name of the role definition, or its fully qualified ID in the following format: '/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11'. |
| [`serviceAlias`](#parameter-servicealias) | string | The alias indicating if the policy belongs to a service. |
| [`serviceEndpointPolicyDefinitions`](#parameter-serviceendpointpolicydefinitions) | array | An Array of service endpoint policy definitions. |
| [`tags`](#parameter-tags) | object | Tags of the resource. |

### Parameter: `contextualServiceEndpointPolicies`

An Array of contextual service endpoint policy.
- Required: No
- Type: array
- Default: `[]`

### Parameter: `enableDefaultTelemetry`

Enable telemetry via a Globally Unique Identifier (GUID).
- Required: No
- Type: bool
- Default: `True`

### Parameter: `location`

Location for all resources.
- Required: No
- Type: string
- Default: `[resourceGroup().location]`

### Parameter: `lock`

Specify the type of lock.
- Required: No
- Type: string
- Default: `''`
- Allowed: `['', CanNotDelete, ReadOnly]`

### Parameter: `name`

The Service Endpoint Policy name.
- Required: Yes
- Type: string

### Parameter: `roleAssignments`

Array of role assignment objects that contain the 'roleDefinitionIdOrName' and 'principalId' to define RBAC role assignments on this resource. In the roleDefinitionIdOrName attribute, you can provide either the display name of the role definition, or its fully qualified ID in the following format: '/providers/Microsoft.Authorization/roleDefinitions/c2f4ef07-c644-48eb-af81-4b1b4947fb11'.
- Required: No
- Type: array
- Default: `[]`

### Parameter: `serviceAlias`

The alias indicating if the policy belongs to a service.
- Required: No
- Type: string
- Default: `''`

### Parameter: `serviceEndpointPolicyDefinitions`

An Array of service endpoint policy definitions.
- Required: No
- Type: array
- Default: `[]`

### Parameter: `tags`

Tags of the resource.
- Required: No
- Type: object
- Default: `{object}`


## Outputs

| Output | Type | Description |
| :-- | :-- | :-- |
| `location` | string | The location the resource was deployed into. |
| `name` | string | The name of the Service Endpoint Policy. |
| `resourceGroupName` | string | The resource group the Service Endpoint Policy was deployed into. |
| `resourceId` | string | The resource ID of the Service Endpoint Policy. |

## Cross-referenced modules

_None_
8 changes: 4 additions & 4 deletions modules/network/service-endpoint-policy/main.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
"metadata": {
"_generator": {
"name": "bicep",
"version": "0.21.1.54444",
"templateHash": "7581628455026938381"
"version": "0.22.6.54827",
"templateHash": "702238259297546605"
},
"name": "Service Endpoint Policies",
"description": "This module deploys a Service Endpoint Policy.",
Expand Down Expand Up @@ -155,8 +155,8 @@
"metadata": {
"_generator": {
"name": "bicep",
"version": "0.21.1.54444",
"templateHash": "15055971962075100955"
"version": "0.22.6.54827",
"templateHash": "1377119003389114371"
}
},
"parameters": {
Expand Down
3 changes: 3 additions & 0 deletions modules/network/trafficmanagerprofile/.test/common/main.test.bicep
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
targetScope = 'subscription'

metadata name = 'Using large parameter set'
metadata description = 'This instance deploys the module with most of its features enabled.'

// ========== //
// Parameters //
// ========== //
Expand Down
3 changes: 3 additions & 0 deletions modules/network/trafficmanagerprofile/.test/min/main.test.bicep
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
targetScope = 'subscription'

metadata name = 'Using only defaults'
metadata description = 'This instance deploys the module with the minimum set of required parameters.'

// ========== //
// Parameters //
// ========== //
Expand Down
Loading
Loading