Skip to content

Commit

Permalink
Regenerated all docs
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexanderSehr committed Aug 7, 2024
1 parent 3eea8e2 commit b5c8efb
Show file tree
Hide file tree
Showing 383 changed files with 47 additions and 3,315 deletions.
2 changes: 0 additions & 2 deletions avm/ptn/aca-lza/hosting-environment/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -495,7 +495,6 @@ module hostingEnvironment 'br/public:avm/ptn/aca-lza/hosting-environment:<versio
</details>
<p>


## Parameters

**Required parameters**
Expand Down Expand Up @@ -788,7 +787,6 @@ The name of the workload that is being deployed. Up to 10 characters long.
- Type: string
- Default: `'aca-lza'`


## Outputs

| Output | Type | Description |
Expand Down
2 changes: 0 additions & 2 deletions avm/ptn/ai-platform/baseline/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -331,7 +331,6 @@ module baseline 'br/public:avm/ptn/ai-platform/baseline:<version>' = {
</details>
<p>


## Parameters

**Required parameters**
Expand Down Expand Up @@ -621,7 +620,6 @@ The outbound rule. The name of the rule is the object key.
- Required: Yes
- Type: object


## Outputs

| Output | Type | Description |
Expand Down
7 changes: 0 additions & 7 deletions avm/ptn/authorization/policy-assignment/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ This module deploys a Policy Assignment at a Management Group, Subscription or R
- [Usage examples](#Usage-examples)
- [Parameters](#Parameters)
- [Outputs](#Outputs)
- [Cross-referenced modules](#Cross-referenced-modules)
- [Data Collection](#Data-Collection)

## Resource Types
Expand Down Expand Up @@ -847,7 +846,6 @@ module policyAssignment 'br/public:avm/ptn/authorization/policy-assignment:<vers
</details>
<p>


## Parameters

**Required parameters**
Expand Down Expand Up @@ -1044,7 +1042,6 @@ The Resource ID for the user assigned identity to assign to the policy assignmen
- Type: string
- Default: `''`


## Outputs

| Output | Type | Description |
Expand All @@ -1054,10 +1051,6 @@ The Resource ID for the user assigned identity to assign to the policy assignmen
| `principalId` | string | Policy Assignment principal ID. |
| `resourceId` | string | Policy Assignment resource ID. |

## 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.
10 changes: 1 addition & 9 deletions avm/ptn/authorization/resource-role-assignment/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,11 @@ This module deploys a Role Assignment for a specific resource.
- [Usage examples](#Usage-examples)
- [Parameters](#Parameters)
- [Outputs](#Outputs)
- [Cross-referenced modules](#Cross-referenced-modules)
- [Data Collection](#Data-Collection)

## Resource Types

| Resource Type | API Version |
| :-- | :-- |
_None_

## Usage examples

Expand Down Expand Up @@ -147,7 +145,6 @@ module resourceRoleAssignment 'br/public:avm/ptn/authorization/resource-role-ass
</details>
<p>


## Parameters

**Required parameters**
Expand Down Expand Up @@ -240,7 +237,6 @@ The name for the role, used for logging.
- Type: string
- Default: `''`


## Outputs

| Output | Type | Description |
Expand All @@ -250,10 +246,6 @@ The name for the role, used for logging.
| `resourceId` | string | The resource ID of the Role Assignment. |
| `roleName` | string | The name for the role, used for logging. |

## 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.
7 changes: 0 additions & 7 deletions avm/ptn/authorization/role-assignment/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ This module deploys a Role Assignment at a Management Group, Subscription or Res
- [Usage examples](#Usage-examples)
- [Parameters](#Parameters)
- [Outputs](#Outputs)
- [Cross-referenced modules](#Cross-referenced-modules)
- [Data Collection](#Data-Collection)

## Resource Types
Expand Down Expand Up @@ -408,7 +407,6 @@ module roleAssignment 'br/public:avm/ptn/authorization/role-assignment:<version>
</details>
<p>


## Parameters

**Required parameters**
Expand Down Expand Up @@ -544,7 +542,6 @@ Subscription ID of the subscription to assign the RBAC role to. If no Resource G
- Type: string
- Default: `''`


## Outputs

| Output | Type | Description |
Expand All @@ -553,10 +550,6 @@ Subscription ID of the subscription to assign the RBAC role to. If no Resource G
| `resourceId` | string | The resource ID of the Role Assignment. |
| `scope` | string | The scope this Role Assignment applies to. |

## 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.
2 changes: 0 additions & 2 deletions avm/ptn/deployment-script/import-image-to-acr/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -251,7 +251,6 @@ module importImageToAcr 'br/public:avm/ptn/deployment-script/import-image-to-acr
</details>
<p>


## Parameters

**Required parameters**
Expand Down Expand Up @@ -445,7 +444,6 @@ Tags of the resource.
}
```


## Outputs

| Output | Type | Description |
Expand Down
2 changes: 0 additions & 2 deletions avm/ptn/finops-toolkit/finops-hub/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,6 @@ module finopsHub 'br/public:avm/ptn/finops-toolkit/finops-hub:<version>' = {
</details>
<p>


## Parameters

**Optional parameters**
Expand Down Expand Up @@ -214,7 +213,6 @@ Tags to apply to resources based on their resource type. Resource type specific
- Type: object
- Default: `{}`


## Outputs

| Output | Type | Description |
Expand Down
2 changes: 0 additions & 2 deletions avm/ptn/lz/sub-vending/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -477,7 +477,6 @@ module subVending 'br/public:avm/ptn/lz/sub-vending:<version>' = {
</details>
<p>


## Parameters

**Optional parameters**
Expand Down Expand Up @@ -930,7 +929,6 @@ An array of of objects of virtual hub route table resource IDs to propagate rout
- Type: array
- Default: `[]`


## Outputs

| Output | Type | Description |
Expand Down
2 changes: 0 additions & 2 deletions avm/ptn/network/private-link-private-dns-zones/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,6 @@ module privateLinkPrivateDnsZones 'br/public:avm/ptn/network/private-link-privat
</details>
<p>


## Parameters

**Optional parameters**
Expand Down Expand Up @@ -302,7 +301,6 @@ An array of Virtual Network Resource IDs to link to the Private Link Private DNS
- Type: array
- Default: `[]`


## Outputs

| Output | Type | Description |
Expand Down
7 changes: 0 additions & 7 deletions avm/ptn/policy-insights/remediation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ This module deploys a Policy Insights Remediation.
- [Usage examples](#Usage-examples)
- [Parameters](#Parameters)
- [Outputs](#Outputs)
- [Cross-referenced modules](#Cross-referenced-modules)
- [Data Collection](#Data-Collection)

## Resource Types
Expand Down Expand Up @@ -448,7 +447,6 @@ module remediation 'br/public:avm/ptn/policy-insights/remediation:<version>' = {
</details>
<p>


## Parameters

**Required parameters**
Expand Down Expand Up @@ -583,7 +581,6 @@ The target scope for the remediation. The subscription ID of the subscription fo
- Type: string
- Default: `''`


## Outputs

| Output | Type | Description |
Expand All @@ -592,10 +589,6 @@ The target scope for the remediation. The subscription ID of the subscription fo
| `name` | string | The name of the remediation. |
| `resourceId` | string | The resource ID of the remediation. |

## 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.
7 changes: 0 additions & 7 deletions avm/ptn/security/security-center/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ This module deploys an Azure Security Center (Defender for Cloud) Configuration.
- [Usage examples](#Usage-examples)
- [Parameters](#Parameters)
- [Outputs](#Outputs)
- [Cross-referenced modules](#Cross-referenced-modules)
- [Data Collection](#Data-Collection)

## Resource Types
Expand Down Expand Up @@ -212,7 +211,6 @@ module securityCenter 'br/public:avm/ptn/security/security-center:<version>' = {
</details>
<p>


## Parameters

**Required parameters**
Expand Down Expand Up @@ -510,18 +508,13 @@ The pricing tier value for VMs. Azure Security Center is provided in two pricing
]
```


## Outputs

| Output | Type | Description |
| :-- | :-- | :-- |
| `name` | string | The name of the security center. |
| `workspaceResourceId` | string | The resource ID of the used log analytics workspace. |

## 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.
7 changes: 0 additions & 7 deletions avm/res/aad/domain-service/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ This module deploys an Azure Active Directory Domain Services (AADDS) instance.
- [Usage examples](#Usage-examples)
- [Parameters](#Parameters)
- [Outputs](#Outputs)
- [Cross-referenced modules](#Cross-referenced-modules)
- [Notes](#Notes)
- [Data Collection](#Data-Collection)

Expand Down Expand Up @@ -187,7 +186,6 @@ module domainService 'br/public:avm/res/aad/domain-service:<version>' = {
</details>
<p>


## Parameters

**Required parameters**
Expand Down Expand Up @@ -813,7 +811,6 @@ The value is to enable clients making request using TLSv1.
]
```


## Outputs

| Output | Type | Description |
Expand All @@ -823,10 +820,6 @@ The value is to enable clients making request using TLSv1.
| `resourceGroupName` | string | The name of the resource group the Azure Active Directory Domain Services(Azure ADDS) was created in. |
| `resourceId` | string | The resource ID of the Azure Active Directory Domain Services(Azure ADDS). |

## Cross-referenced modules

_None_

## Notes

This module requires prerequisites, that can't be done via ARM/Bicep at the moment. The prerequisites to create a managed domain are outlined [here](https://learn.microsoft.com/en-us/entra/identity/domain-services/template-create-instance#prerequisites).
Expand Down
7 changes: 0 additions & 7 deletions avm/res/alerts-management/action-rule/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ This module deploys an Alert Processing Rule.
- [Usage examples](#Usage-examples)
- [Parameters](#Parameters)
- [Outputs](#Outputs)
- [Cross-referenced modules](#Cross-referenced-modules)
- [Data Collection](#Data-Collection)

## Resource Types
Expand Down Expand Up @@ -477,7 +476,6 @@ module actionRule 'br/public:avm/res/alerts-management/action-rule:<version>' =
</details>
<p>


## Parameters

**Required parameters**
Expand Down Expand Up @@ -723,7 +721,6 @@ Resource tags.
- Required: No
- Type: object


## Outputs

| Output | Type | Description |
Expand All @@ -733,10 +730,6 @@ Resource tags.
| `resourceGroupName` | string | The resource group the action group was deployed into. |
| `resourceId` | string | The resource ID of the Alert Processing Rule. |

## 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.
7 changes: 0 additions & 7 deletions avm/res/analysis-services/server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ This module deploys an Analysis Services Server.
- [Usage examples](#Usage-examples)
- [Parameters](#Parameters)
- [Outputs](#Outputs)
- [Cross-referenced modules](#Cross-referenced-modules)
- [Data Collection](#Data-Collection)

## Resource Types
Expand Down Expand Up @@ -417,7 +416,6 @@ module server 'br/public:avm/res/analysis-services/server:<version>' = {
</details>
<p>


## Parameters

**Required parameters**
Expand Down Expand Up @@ -785,7 +783,6 @@ Tags of the resource.
- Required: No
- Type: object


## Outputs

| Output | Type | Description |
Expand All @@ -795,10 +792,6 @@ Tags of the resource.
| `resourceGroupName` | string | The resource group the analysis service was deployed into. |
| `resourceId` | string | The resource ID of the analysis service. |

## 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.
Loading

0 comments on commit b5c8efb

Please sign in to comment.