Skip to content

[Modules] Update Conditional descriptions #1376

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

Merged
eriqua merged 12 commits into from
May 8, 2022
Merged

[Modules] Update Conditional descriptions #1376

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
fe16e12
storage
eriqua May 8, 2022
c11356c
site
eriqua May 8, 2022
6b645fa
the name of the parent
eriqua May 8, 2022
1c4f74d
private dns zone
eriqua May 8, 2022
0f3b944
parent parent
eriqua May 8, 2022
5ae9a24
private dns zones
eriqua May 8, 2022
3ce64ea
MultipleResourceMultipleMetricCriteria.
eriqua May 8, 2022
ad16b25
Required if end
eriqua May 8, 2022
929b392
old unsaved
eriqua May 8, 2022
41abeab
sql mi
eriqua May 8, 2022
76b3164
batch
eriqua May 8, 2022
173930b
readme update
eriqua May 8, 2022
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
4 changes: 2 additions & 2 deletions arm/Microsoft.AAD/DomainServices/deploy.bicep
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,10 @@ param location string = resourceGroup().location
@description('Optional. Additional replica set for the managed domain.')
param replicaSets array = []

@description('Conditional. Required if secure LDAP is enabled and must be valid more than 30 days. The certificate required to configure Secure LDAP. Should be a base64encoded representation of the certificate PFX file.')
@description('Conditional. The certificate required to configure Secure LDAP. Should be a base64encoded representation of the certificate PFX file. Required if secure LDAP is enabled and must be valid more than 30 days.')
param pfxCertificate string = ''

@description('Conditional. Required if secure LDAP is enabled. The password to decrypt the provided Secure LDAP certificate PFX file.')
@description('Conditional. The password to decrypt the provided Secure LDAP certificate PFX file. Required if secure LDAP is enabled.')
@secure()
param pfxCertificatePassword string = ''

Expand Down
4 changes: 2 additions & 2 deletions arm/Microsoft.AAD/DomainServices/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ This template deploys Azure Active Directory Domain Services (AADDS).
**Conditional parameters**
| Parameter Name | Type | Default Value | Description |
| :-- | :-- | :-- | :-- |
| `pfxCertificate` | string | `''` | Required if secure LDAP is enabled and must be valid more than 30 days. The certificate required to configure Secure LDAP. Should be a base64encoded representation of the certificate PFX file. |
| `pfxCertificatePassword` | secureString | `''` | Required if secure LDAP is enabled. The password to decrypt the provided Secure LDAP certificate PFX file. |
| `pfxCertificate` | string | `''` | The certificate required to configure Secure LDAP. Should be a base64encoded representation of the certificate PFX file. Required if secure LDAP is enabled and must be valid more than 30 days. |
| `pfxCertificatePassword` | secureString | `''` | The password to decrypt the provided Secure LDAP certificate PFX file. Required if secure LDAP is enabled. |

**Optional parameters**
| Parameter Name | Type | Default Value | Allowed Values | Description |
Expand Down
4 changes: 2 additions & 2 deletions arm/Microsoft.ApiManagement/service/identityProviders/deploy.bicep
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ param identityProviderAllowedTenants array = []
@description('Optional. OpenID Connect discovery endpoint hostname for AAD or AAD B2C.')
param identityProviderAuthority string = ''

@description('Optional. Client ID of the Application in the external Identity Provider. Required if identity provider is used.')
@description('Conditional. Client ID of the Application in the external Identity Provider. Required if identity provider is used.')
param identityProviderClientId string = ''

@description('Optional. Client secret of the Application in external Identity Provider, used to authenticate login request. Required if identity provider is used.')
@description('Conditional. Client secret of the Application in external Identity Provider, used to authenticate login request. Required if identity provider is used.')
@secure()
param identityProviderClientSecret string = ''

Expand Down
10 changes: 5 additions & 5 deletions arm/Microsoft.ApiManagement/service/identityProviders/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,11 @@ This module deploys API Management Service Identity Provider.
| `name` | string | Identity provider name. |

**Conditional parameters**
| Parameter Name | Type | Description |
| :-- | :-- | :-- |
| `apiManagementServiceName` | string | The name of the parent API Management service. Required if the template is used in a standalone deployment. |
| Parameter Name | Type | Default Value | Description |
| :-- | :-- | :-- | :-- |
| `apiManagementServiceName` | string | | The name of the parent API Management service. Required if the template is used in a standalone deployment. |
| `identityProviderClientId` | string | `''` | Client ID of the Application in the external Identity Provider. Required if identity provider is used. |
| `identityProviderClientSecret` | secureString | `''` | Client secret of the Application in external Identity Provider, used to authenticate login request. Required if identity provider is used. |

**Optional parameters**
| Parameter Name | Type | Default Value | Allowed Values | Description |
Expand All @@ -33,8 +35,6 @@ This module deploys API Management Service Identity Provider.
| `enableIdentityProviders` | bool | `False` | | Used to enable the deployment of the identityProviders child resource. |
| `identityProviderAllowedTenants` | array | `[]` | | List of Allowed Tenants when configuring Azure Active Directory login. - string. |
| `identityProviderAuthority` | string | `''` | | OpenID Connect discovery endpoint hostname for AAD or AAD B2C. |
| `identityProviderClientId` | string | `''` | | Client ID of the Application in the external Identity Provider. Required if identity provider is used. |
| `identityProviderClientSecret` | secureString | `''` | | Client secret of the Application in external Identity Provider, used to authenticate login request. Required if identity provider is used. |
| `identityProviderPasswordResetPolicyName` | string | `''` | | Password Reset Policy Name. Only applies to AAD B2C Identity Provider. |
| `identityProviderProfileEditingPolicyName` | string | `''` | | Profile Editing Policy Name. Only applies to AAD B2C Identity Provider. |
| `identityProviderSignInPolicyName` | string | `''` | | Signin Policy Name. Only applies to AAD B2C Identity Provider. |
Expand Down
2 changes: 1 addition & 1 deletion arm/Microsoft.Automation/automationAccounts/jobSchedules/deploy.bicep
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
@description('Optional. Name of the Automation Account job schedule. Must be a GUID. If not provided, a new GUID is generated.')
param name string = newGuid()

@description('Conditional. Name of the parent Automation Account. Required if the template is used in a standalone deployment.')
@description('Conditional. The name of the parent Automation Account. Required if the template is used in a standalone deployment.')
param automationAccountName string

@description('Required. The runbook property associated with the entity.')
Expand Down
2 changes: 1 addition & 1 deletion arm/Microsoft.Automation/automationAccounts/jobSchedules/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ This module deploys an Azure Automation Account Job Schedule.
**Conditional parameters**
| Parameter Name | Type | Description |
| :-- | :-- | :-- |
| `automationAccountName` | string | Name of the parent Automation Account. Required if the template is used in a standalone deployment. |
| `automationAccountName` | string | The name of the parent Automation Account. Required if the template is used in a standalone deployment. |

**Optional parameters**
| Parameter Name | Type | Default Value | Description |
Expand Down
2 changes: 1 addition & 1 deletion arm/Microsoft.Automation/automationAccounts/modules/deploy.bicep
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
@description('Required. Name of the Automation Account module.')
param name string

@description('Conditional. Name of the parent Automation Account. Required if the template is used in a standalone deployment.')
@description('Conditional. The name of the parent Automation Account. Required if the template is used in a standalone deployment.')
param automationAccountName string

@description('Required. Module package uri, e.g. https://www.powershellgallery.com/api/v2/package.')
Expand Down
2 changes: 1 addition & 1 deletion arm/Microsoft.Automation/automationAccounts/modules/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ This module deploys an Azure Automation Account Module.
**Conditional parameters**
| Parameter Name | Type | Description |
| :-- | :-- | :-- |
| `automationAccountName` | string | Name of the parent Automation Account. Required if the template is used in a standalone deployment. |
| `automationAccountName` | string | The name of the parent Automation Account. Required if the template is used in a standalone deployment. |

**Optional parameters**
| Parameter Name | Type | Default Value | Description |
Expand Down
2 changes: 1 addition & 1 deletion arm/Microsoft.Automation/automationAccounts/runbooks/deploy.bicep
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
@description('Required. Name of the Automation Account runbook.')
param name string

@description('Conditional. Name of the parent Automation Account. Required if the template is used in a standalone deployment.')
@description('Conditional. The name of the parent Automation Account. Required if the template is used in a standalone deployment.')
param automationAccountName string

@allowed([
Expand Down
2 changes: 1 addition & 1 deletion arm/Microsoft.Automation/automationAccounts/runbooks/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ This module deploys an Azure Automation Account Runbook.
**Conditional parameters**
| Parameter Name | Type | Description |
| :-- | :-- | :-- |
| `automationAccountName` | string | Name of the parent Automation Account. Required if the template is used in a standalone deployment. |
| `automationAccountName` | string | The name of the parent Automation Account. Required if the template is used in a standalone deployment. |

**Optional parameters**
| Parameter Name | Type | Default Value | Description |
Expand Down
2 changes: 1 addition & 1 deletion arm/Microsoft.Automation/automationAccounts/schedules/deploy.bicep
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
@description('Required. Name of the Automation Account schedule.')
param name string

@description('Conditional. Name of the parent Automation Account. Required if the template is used in a standalone deployment.')
@description('Conditional. The name of the parent Automation Account. Required if the template is used in a standalone deployment.')
param automationAccountName string

@description('Optional. The properties of the create Advanced Schedule.')
Expand Down
2 changes: 1 addition & 1 deletion arm/Microsoft.Automation/automationAccounts/schedules/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ This module deploys an Azure Automation Account Schedule.
**Conditional parameters**
| Parameter Name | Type | Description |
| :-- | :-- | :-- |
| `automationAccountName` | string | Name of the parent Automation Account. Required if the template is used in a standalone deployment. |
| `automationAccountName` | string | The name of the parent Automation Account. Required if the template is used in a standalone deployment. |

**Optional parameters**
| Parameter Name | Type | Default Value | Allowed Values | Description |
Expand Down
2 changes: 1 addition & 1 deletion arm/Microsoft.Automation/automationAccounts/softwareUpdateConfigurations/deploy.bicep
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
@description('Required. The name of the Deployment schedule.')
param name string

@description('Conditional. Name of the parent Automation Account. Required if the template is used in a standalone deployment.')
@description('Conditional. The name of the parent Automation Account. Required if the template is used in a standalone deployment.')
param automationAccountName string

@description('Required. The operating system to be configured by the deployment schedule.')
Expand Down
2 changes: 1 addition & 1 deletion arm/Microsoft.Automation/automationAccounts/softwareUpdateConfigurations/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ This module deploys an Azure Automation Account Software update Configuration.
**Conditional parameters**
| Parameter Name | Type | Description |
| :-- | :-- | :-- |
| `automationAccountName` | string | Name of the parent Automation Account. Required if the template is used in a standalone deployment. |
| `automationAccountName` | string | The name of the parent Automation Account. Required if the template is used in a standalone deployment. |

**Optional parameters**
| Parameter Name | Type | Default Value | Allowed Values | Description |
Expand Down
2 changes: 1 addition & 1 deletion arm/Microsoft.Automation/automationAccounts/variables/deploy.bicep
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
@sys.description('Conditional. Name of the parent Automation Account. Required if the template is used in a standalone deployment.')
@sys.description('Conditional. The name of the parent Automation Account. Required if the template is used in a standalone deployment.')
param automationAccountName string

@sys.description('Required. The name of the variable.')
Expand Down
2 changes: 1 addition & 1 deletion arm/Microsoft.Automation/automationAccounts/variables/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ This module deploys a variable to an Azure Automation Account.
**Conditional parameters**
| Parameter Name | Type | Description |
| :-- | :-- | :-- |
| `automationAccountName` | string | Name of the parent Automation Account. Required if the template is used in a standalone deployment. |
| `automationAccountName` | string | The name of the parent Automation Account. Required if the template is used in a standalone deployment. |

**Optional parameters**
| Parameter Name | Type | Default Value | Description |
Expand Down
6 changes: 3 additions & 3 deletions arm/Microsoft.Batch/batchAccounts/deploy.bicep
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,13 +80,13 @@ param allowedAuthenticationModes array = []
@description('Optional. Type of the key source.')
param encryptionKeySource string = 'Microsoft.Batch'

@description('Conditional. Full path to the versioned secret. Must be set if `encryptionKeySource` is set to `Microsoft.KeyVault` or `poolAllocationMode` is set to `UserSubscription`.')
@description('Conditional. Full path to the versioned secret. Required if `encryptionKeySource` is set to `Microsoft.KeyVault` or `poolAllocationMode` is set to `UserSubscription`.')
param encryptionKeyIdentifier string = ''

@description('Conditional. The resource ID of the Azure key vault associated with the Batch account. Must be set if `encryptionKeySource` is set to `Microsoft.KeyVault` or `poolAllocationMode` is set to `UserSubscription`.')
@description('Conditional. The resource ID of the Azure key vault associated with the Batch account. Required if `encryptionKeySource` is set to `Microsoft.KeyVault` or `poolAllocationMode` is set to `UserSubscription`.')
param keyVaultResourceId string = ''

@description('Conditional. The URL of the Azure key vault associated with the Batch account. Must be set if `encryptionKeySource` is set to `Microsoft.KeyVault` or `poolAllocationMode` is set to `UserSubscription`.')
@description('Conditional. The URL of the Azure key vault associated with the Batch account. Required if `encryptionKeySource` is set to `Microsoft.KeyVault` or `poolAllocationMode` is set to `UserSubscription`.')
param keyVaultUri string = ''

@description('Optional. Enable telemetry via the Customer Usage Attribution ID (GUID).')
Expand Down
6 changes: 3 additions & 3 deletions arm/Microsoft.Batch/batchAccounts/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@
**Conditional parameters**
| Parameter Name | Type | Default Value | Description |
| :-- | :-- | :-- | :-- |
| `encryptionKeyIdentifier` | string | `''` | Full path to the versioned secret. Must be set if `encryptionKeySource` is set to `Microsoft.KeyVault` or `poolAllocationMode` is set to `UserSubscription`. |
| `keyVaultResourceId` | string | `''` | The resource ID of the Azure key vault associated with the Batch account. Must be set if `encryptionKeySource` is set to `Microsoft.KeyVault` or `poolAllocationMode` is set to `UserSubscription`. |
| `keyVaultUri` | string | `''` | The URL of the Azure key vault associated with the Batch account. Must be set if `encryptionKeySource` is set to `Microsoft.KeyVault` or `poolAllocationMode` is set to `UserSubscription`. |
| `encryptionKeyIdentifier` | string | `''` | Full path to the versioned secret. Required if `encryptionKeySource` is set to `Microsoft.KeyVault` or `poolAllocationMode` is set to `UserSubscription`. |
| `keyVaultResourceId` | string | `''` | The resource ID of the Azure key vault associated with the Batch account. Required if `encryptionKeySource` is set to `Microsoft.KeyVault` or `poolAllocationMode` is set to `UserSubscription`. |
| `keyVaultUri` | string | `''` | The URL of the Azure key vault associated with the Batch account. Required if `encryptionKeySource` is set to `Microsoft.KeyVault` or `poolAllocationMode` is set to `UserSubscription`. |

**Optional parameters**
| Parameter Name | Type | Default Value | Allowed Values | Description |
Expand Down
2 changes: 1 addition & 1 deletion arm/Microsoft.CognitiveServices/accounts/deploy.bicep
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ param diagnosticEventHubAuthorizationRuleId string = ''
@description('Optional. Name of the diagnostic event hub within the namespace to which logs are streamed. Without this, an event hub is created for each log category.')
param diagnosticEventHubName string = ''

@description('Optional. Subdomain name used for token-based authentication. Required if \'networkAcls\' are set.')
@description('Conditional. Subdomain name used for token-based authentication. Required if \'networkAcls\' are set.')
param customSubDomainName string = ''

@description('Optional. Subdomain name used for token-based authentication. Must be set if \'networkAcls\' are set.')
Expand Down
6 changes: 5 additions & 1 deletion arm/Microsoft.CognitiveServices/accounts/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,16 @@ This module deploys different kinds of cognitive services resources
| `kind` | string | `[AnomalyDetector, Bing.Autosuggest.v7, Bing.CustomSearch, Bing.EntitySearch, Bing.Search.v7, Bing.SpellCheck.v7, CognitiveServices, ComputerVision, ContentModerator, CustomVision.Prediction, CustomVision.Training, Face, FormRecognizer, ImmersiveReader, Internal.AllInOne, LUIS, LUIS.Authoring, Personalizer, QnAMaker, SpeechServices, TextAnalytics, TextTranslation]` | Kind of the Cognitive Services. Use 'Get-AzCognitiveServicesAccountSku' to determine a valid combinations of 'kind' and 'sku' for your Azure region. |
| `name` | string | | The name of Cognitive Services account. |

**Conditional parameters**
| Parameter Name | Type | Default Value | Description |
| :-- | :-- | :-- | :-- |
| `customSubDomainName` | string | `''` | Subdomain name used for token-based authentication. Required if 'networkAcls' are set. |

**Optional parameters**
| Parameter Name | Type | Default Value | Allowed Values | Description |
| :-- | :-- | :-- | :-- | :-- |
| `allowedFqdnList` | array | `[]` | | List of allowed FQDN. |
| `apiProperties` | object | `{object}` | | The API properties for special APIs. |
| `customSubDomainName` | string | `''` | | Subdomain name used for token-based authentication. Required if 'networkAcls' are set. |
| `diagnosticEventHubAuthorizationRuleId` | string | `''` | | Resource ID of the diagnostic event hub authorization rule for the Event Hubs namespace in which the event hub should be created or streamed to. |
| `diagnosticEventHubName` | string | `''` | | Name of the diagnostic event hub within the namespace to which logs are streamed. Without this, an event hub is created for each log category. |
| `diagnosticLogCategoriesToEnable` | array | `[Audit, RequestResponse]` | `[Audit, RequestResponse]` | The name of logs that will be streamed. |
Expand Down
2 changes: 1 addition & 1 deletion arm/Microsoft.Compute/galleries/images/deploy.bicep
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ param enableDefaultTelemetry bool = true
@description('Optional. Location for all resources.')
param location string = resourceGroup().location

@description('Conditional. Name of the Azure Shared Image Gallery. Required if the template is used in a standalone deployment.')
@description('Conditional. The name of the parent Azure Shared Image Gallery. Required if the template is used in a standalone deployment.')
@minLength(1)
param galleryName string

Expand Down
2 changes: 1 addition & 1 deletion arm/Microsoft.Compute/galleries/images/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ This module deploys an Image Definition in a Shared Image Gallery.
**Conditional parameters**
| Parameter Name | Type | Description |
| :-- | :-- | :-- |
| `galleryName` | string | Name of the Azure Shared Image Gallery. Required if the template is used in a standalone deployment. |
| `galleryName` | string | The name of the parent Azure Shared Image Gallery. Required if the template is used in a standalone deployment. |

**Optional parameters**
| Parameter Name | Type | Default Value | Allowed Values | Description |
Expand Down
2 changes: 1 addition & 1 deletion arm/Microsoft.ContainerService/managedClusters/agentPools/deploy.bicep
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
@description('Conditional. Name of the managed cluster. Required if the template is used in a standalone deployment.')
@description('Conditional. The name of the parent managed cluster. Required if the template is used in a standalone deployment.')
@minLength(1)
param managedClusterName string

Expand Down
2 changes: 1 addition & 1 deletion arm/Microsoft.ContainerService/managedClusters/agentPools/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ This module deploys an Agent Pool for a Container Service Managed Cluster
**Conditional parameters**
| Parameter Name | Type | Description |
| :-- | :-- | :-- |
| `managedClusterName` | string | Name of the managed cluster. Required if the template is used in a standalone deployment. |
| `managedClusterName` | string | The name of the parent managed cluster. Required if the template is used in a standalone deployment. |

**Optional parameters**
| Parameter Name | Type | Default Value | Allowed Values | Description |
Expand Down
2 changes: 1 addition & 1 deletion arm/Microsoft.ContainerService/managedClusters/deploy.bicep
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ param httpApplicationRoutingEnabled bool = false
@description('Optional. Specifies whether the ingressApplicationGateway (AGIC) add-on is enabled or not.')
param ingressApplicationGatewayEnabled bool = false

@description('Conditional. Required if `ingressApplicationGatewayEnabled` is set to `true`. Specifies the resource ID of connected application gateway.')
@description('Conditional. Specifies the resource ID of connected application gateway. Required if `ingressApplicationGatewayEnabled` is set to `true`.')
param appGatewayResourceId string = ''

@description('Optional. Specifies whether the aciConnectorLinux add-on is enabled or not.')
Expand Down
2 changes: 1 addition & 1 deletion arm/Microsoft.ContainerService/managedClusters/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ This module deploys Azure Kubernetes Cluster (AKS).
**Conditional parameters**
| Parameter Name | Type | Default Value | Description |
| :-- | :-- | :-- | :-- |
| `appGatewayResourceId` | string | `''` | Required if `ingressApplicationGatewayEnabled` is set to `true`. Specifies the resource ID of connected application gateway. |
| `appGatewayResourceId` | string | `''` | Specifies the resource ID of connected application gateway. Required if `ingressApplicationGatewayEnabled` is set to `true`. |

**Optional parameters**
| Parameter Name | Type | Default Value | Allowed Values | Description |
Expand Down
Loading