Skip to content

[Fixes] Readme typo fix and parent addition #1370

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 5 commits into from
May 7, 2022
Merged

[Fixes] Readme typo fix and parent addition #1370

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0862997
add parent to description conditional
eriqua May 7, 2022
f423735
Merge branch 'main' into users/erikag/parent-conditional
eriqua May 7, 2022
ea6cf7d
update readme
eriqua May 7, 2022
fa6e91a
merge parent
eriqua May 7, 2022
adabfa0
Merge branch 'users/alsehr/1247_condName' into users/erikag/parent-co…
eriqua May 7, 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
2 changes: 1 addition & 1 deletion arm/Microsoft.ApiManagement/service/.bicep/nested_authorizationServers.bicep
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
@description('Required. Identifier of the authorization server.')
param name string

@description('Required. The name of the of the API Management service.')
@description('Required. The name of the API Management service.')
param apiManagementServiceName string

@description('Required. OAuth authorization endpoint. See <http://tools.ietf.org/html/rfc6749#section-3.2>.')
Expand Down
2 changes: 1 addition & 1 deletion arm/Microsoft.ApiManagement/service/apiVersionSets/deploy.bicep
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
@description('Conditional. The name of the of the API Management service. Required if the template is used in a standalone deployment.')
@description('Conditional. The name of the parent API Management service. Required if the template is used in a standalone deployment.')
param apiManagementServiceName string

@description('Optional. Enable telemetry via the Customer Usage Attribution ID (GUID).')
Expand Down
2 changes: 1 addition & 1 deletion arm/Microsoft.ApiManagement/service/apiVersionSets/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ This module deploys API Management Service APIs Version Set.
**Conditional parameters**
| Parameter Name | Type | Description |
| :-- | :-- | :-- |
| `apiManagementServiceName` | string | The name of the of the API Management service. Required if the template is used in a standalone deployment. |
| `apiManagementServiceName` | string | The name of the parent API Management service. 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.ApiManagement/service/apis/deploy.bicep
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ param name string
@description('Optional. Array of Policies to apply to the Service API.')
param policies array = []

@description('Conditional. The name of the of the API Management service. Required if the template is used in a standalone deployment.')
@description('Conditional. The name of the parent API Management service. Required if the template is used in a standalone deployment.')
param apiManagementServiceName string

@description('Optional. Describes the Revision of the API. If no value is provided, default revision 1 is created.')
Expand Down
4 changes: 2 additions & 2 deletions arm/Microsoft.ApiManagement/service/apis/policies/deploy.bicep
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
@description('Conditional. The name of the of the API Management service. Required if the template is used in a standalone deployment.')
@description('Conditional. The name of the parent API Management service. Required if the template is used in a standalone deployment.')
param apiManagementServiceName string

@description('Conditional. The name of the of the API. Required if the template is used in a standalone deployment.')
@description('Conditional. The name of the parent API. Required if the template is used in a standalone deployment.')
param apiName string

@description('Optional. The name of the policy.')
Expand Down
4 changes: 2 additions & 2 deletions arm/Microsoft.ApiManagement/service/apis/policies/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ This module deploys API Management Service APIs policies.
**Conditional parameters**
| Parameter Name | Type | Description |
| :-- | :-- | :-- |
| `apiManagementServiceName` | string | The name of the of the API Management service. Required if the template is used in a standalone deployment. |
| `apiName` | string | The name of the of the API. Required if the template is used in a standalone deployment. |
| `apiManagementServiceName` | string | The name of the parent API Management service. Required if the template is used in a standalone deployment. |
| `apiName` | string | The name of the parent API. 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.ApiManagement/service/apis/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The following resources are required to be able to deploy this resource.
**Conditional parameters**
| Parameter Name | Type | Description |
| :-- | :-- | :-- |
| `apiManagementServiceName` | string | The name of the of the API Management service. Required if the template is used in a standalone deployment. |
| `apiManagementServiceName` | string | The name of the parent API Management service. 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.ApiManagement/service/authorizationServers/deploy.bicep
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
@description('Required. Identifier of the authorization server.')
param name string

@description('Conditional. The name of the of the API Management service. Required if the template is used in a standalone deployment.')
@description('Conditional. The name of the parent API Management service. Required if the template is used in a standalone deployment.')
param apiManagementServiceName string

@description('Required. OAuth authorization endpoint. See <http://tools.ietf.org/html/rfc6749#section-3.2>.')
Expand Down
2 changes: 1 addition & 1 deletion arm/Microsoft.ApiManagement/service/authorizationServers/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ The following resources are required to be able to deploy this resource.
**Conditional parameters**
| Parameter Name | Type | Description |
| :-- | :-- | :-- |
| `apiManagementServiceName` | string | The name of the of the API Management service. Required if the template is used in a standalone deployment. |
| `apiManagementServiceName` | string | The name of the parent API Management service. 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.ApiManagement/service/backends/deploy.bicep
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
@description('Conditional. The name of the of the API Management service. Required if the template is used in a standalone deployment.')
@description('Conditional. The name of the parent API Management service. Required if the template is used in a standalone deployment.')
param apiManagementServiceName string

@description('Required. Backend Name.')
Expand Down
2 changes: 1 addition & 1 deletion arm/Microsoft.ApiManagement/service/backends/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ The following resources are required to be able to deploy this resource.
**Conditional parameters**
| Parameter Name | Type | Description |
| :-- | :-- | :-- |
| `apiManagementServiceName` | string | The name of the of the API Management service. Required if the template is used in a standalone deployment. |
| `apiManagementServiceName` | string | The name of the parent API Management service. 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.ApiManagement/service/caches/deploy.bicep
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
@description('Conditional. The name of the of the API Management service. Required if the template is used in a standalone deployment.')
@description('Conditional. The name of the parent API Management service. Required if the template is used in a standalone deployment.')
param apiManagementServiceName string

@description('Required. Identifier of the Cache entity. Cache identifier (should be either \'default\' or valid Azure region identifier).')
Expand Down
2 changes: 1 addition & 1 deletion arm/Microsoft.ApiManagement/service/caches/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ The following resources are required to be able to deploy this resource.
**Conditional parameters**
| Parameter Name | Type | Description |
| :-- | :-- | :-- |
| `apiManagementServiceName` | string | The name of the of the API Management service. Required if the template is used in a standalone deployment. |
| `apiManagementServiceName` | string | The name of the parent API Management service. 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.ApiManagement/service/deploy.bicep
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
@description('Optional. Additional datacenter locations of the API Management service.')
param additionalLocations array = []

@description('Required. The name of the of the API Management service.')
@description('Required. The name of the API Management service.')
param name string

@description('Optional. List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10.')
Expand Down
2 changes: 1 addition & 1 deletion arm/Microsoft.ApiManagement/service/identityProviders/deploy.bicep
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
@description('Conditional. The name of the of the API Management service. Required if the template is used in a standalone deployment.')
@description('Conditional. The name of the parent API Management service. Required if the template is used in a standalone deployment.')
param apiManagementServiceName string

@description('Optional. Enable telemetry via the Customer Usage Attribution ID (GUID).')
Expand Down
2 changes: 1 addition & 1 deletion arm/Microsoft.ApiManagement/service/identityProviders/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 API Management Service Identity Provider.
**Conditional parameters**
| Parameter Name | Type | Description |
| :-- | :-- | :-- |
| `apiManagementServiceName` | string | The name of the of the API Management service. Required if the template is used in a standalone deployment. |
| `apiManagementServiceName` | string | The name of the parent API Management service. 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.ApiManagement/service/namedValues/deploy.bicep
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
@description('Conditional. The name of the of the API Management service. Required if the template is used in a standalone deployment.')
@description('Conditional. The name of the parent API Management service. Required if the template is used in a standalone deployment.')
param apiManagementServiceName string = ''

@description('Optional. Enable telemetry via the Customer Usage Attribution ID (GUID).')
Expand Down
2 changes: 1 addition & 1 deletion arm/Microsoft.ApiManagement/service/namedValues/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ The following resources are required to be able to deploy this resource.
**Conditional parameters**
| Parameter Name | Type | Default Value | Description |
| :-- | :-- | :-- | :-- |
| `apiManagementServiceName` | string | `''` | The name of the of the API Management service. Required if the template is used in a standalone deployment. |
| `apiManagementServiceName` | string | `''` | The name of the parent API Management service. 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.ApiManagement/service/policies/deploy.bicep
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
@description('Conditional. The name of the of the API Management service. Required if the template is used in a standalone deployment.')
@description('Conditional. The name of the parent API Management service. Required if the template is used in a standalone deployment.')
param apiManagementServiceName string

@description('Optional. The name of the policy.')
Expand Down
2 changes: 1 addition & 1 deletion arm/Microsoft.ApiManagement/service/policies/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 API Management Service Policy.
**Conditional parameters**
| Parameter Name | Type | Description |
| :-- | :-- | :-- |
| `apiManagementServiceName` | string | The name of the of the API Management service. Required if the template is used in a standalone deployment. |
| `apiManagementServiceName` | string | The name of the parent API Management service. 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.ApiManagement/service/portalsettings/deploy.bicep
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
@description('Conditional. The name of the of the API Management service. Required if the template is used in a standalone deployment.')
@description('Conditional. The name of the parent API Management service. Required if the template is used in a standalone deployment.')
param apiManagementServiceName string

@description('Optional. Enable telemetry via the Customer Usage Attribution ID (GUID).')
Expand Down
2 changes: 1 addition & 1 deletion arm/Microsoft.ApiManagement/service/portalsettings/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 API Management Service Portal Setting.
**Conditional parameters**
| Parameter Name | Type | Description |
| :-- | :-- | :-- |
| `apiManagementServiceName` | string | The name of the of the API Management service. Required if the template is used in a standalone deployment. |
| `apiManagementServiceName` | string | The name of the parent API Management service. Required if the template is used in a standalone deployment. |

**Optional parameters**
| Parameter Name | Type | Default Value | Description |
Expand Down
4 changes: 2 additions & 2 deletions arm/Microsoft.ApiManagement/service/products/apis/deploy.bicep
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
@description('Conditional. The name of the of the API Management service. Required if the template is used in a standalone deployment.')
@description('Conditional. The name of the parent API Management service. Required if the template is used in a standalone deployment.')
param apiManagementServiceName string

@description('Conditional. The name of the of the Product. Required if the template is used in a standalone deployment.')
@description('Conditional. The name of the parent Product. Required if the template is used in a standalone deployment.')
param productName string

@description('Optional. Enable telemetry via the Customer Usage Attribution ID (GUID).')
Expand Down
4 changes: 2 additions & 2 deletions arm/Microsoft.ApiManagement/service/products/apis/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ This module deploys API Management Service Product APIs.
**Conditional parameters**
| Parameter Name | Type | Description |
| :-- | :-- | :-- |
| `apiManagementServiceName` | string | The name of the of the API Management service. Required if the template is used in a standalone deployment. |
| `productName` | string | The name of the of the Product. Required if the template is used in a standalone deployment. |
| `apiManagementServiceName` | string | The name of the parent API Management service. Required if the template is used in a standalone deployment. |
| `productName` | string | The name of the parent Product. 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.ApiManagement/service/products/deploy.bicep
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
@description('Conditional. The name of the of the API Management service. Required if the template is used in a standalone deployment.')
@description('Conditional. The name of the parent API Management service. Required if the template is used in a standalone deployment.')
param apiManagementServiceName string

@description('Optional. Whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the products APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the products APIs. Can be present only if subscriptionRequired property is present and has a value of false.')
Expand Down
4 changes: 2 additions & 2 deletions arm/Microsoft.ApiManagement/service/products/groups/deploy.bicep
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
@description('Conditional. The name of the of the API Management service. Required if the template is used in a standalone deployment.')
@description('Conditional. The name of the parent API Management service. Required if the template is used in a standalone deployment.')
param apiManagementServiceName string

@description('Conditional. The name of the of the Product. Required if the template is used in a standalone deployment.')
@description('Conditional. The name of the parent Product. Required if the template is used in a standalone deployment.')
param productName string

@description('Optional. Enable telemetry via the Customer Usage Attribution ID (GUID).')
Expand Down
4 changes: 2 additions & 2 deletions arm/Microsoft.ApiManagement/service/products/groups/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ This module deploys API Management Service Product Groups.
**Conditional parameters**
| Parameter Name | Type | Description |
| :-- | :-- | :-- |
| `apiManagementServiceName` | string | The name of the of the API Management service. Required if the template is used in a standalone deployment. |
| `productName` | string | The name of the of the Product. Required if the template is used in a standalone deployment. |
| `apiManagementServiceName` | string | The name of the parent API Management service. Required if the template is used in a standalone deployment. |
| `productName` | string | The name of the parent Product. 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.ApiManagement/service/products/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ The following resources are required to be able to deploy this resource.
**Conditional parameters**
| Parameter Name | Type | Description |
| :-- | :-- | :-- |
| `apiManagementServiceName` | string | The name of the of the API Management service. Required if the template is used in a standalone deployment. |
| `apiManagementServiceName` | string | The name of the parent API Management service. 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.ApiManagement/service/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ This module deploys an API management service.
**Required parameters**
| Parameter Name | Type | Description |
| :-- | :-- | :-- |
| `name` | string | The name of the of the API Management service. |
| `name` | string | The name of the API Management service. |
| `publisherEmail` | string | The email address of the owner of the service. |
| `publisherName` | string | The name of the owner of the service. |

Expand Down
2 changes: 1 addition & 1 deletion arm/Microsoft.ApiManagement/service/subscriptions/deploy.bicep
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
@description('Optional. Determines whether tracing can be enabled.')
param allowTracing bool = true

@description('Conditional. The name of the of the API Management service. Required if the template is used in a standalone deployment.')
@description('Conditional. The name of the parent API Management service. Required if the template is used in a standalone deployment.')
param apiManagementServiceName string

@description('Optional. Enable telemetry via the Customer Usage Attribution ID (GUID).')
Expand Down
2 changes: 1 addition & 1 deletion arm/Microsoft.ApiManagement/service/subscriptions/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ The following resources are required to be able to deploy this resource.
**Conditional parameters**
| Parameter Name | Type | Description |
| :-- | :-- | :-- |
| `apiManagementServiceName` | string | The name of the of the API Management service. Required if the template is used in a standalone deployment. |
| `apiManagementServiceName` | string | The name of the parent API Management service. 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.Compute/virtualMachineScaleSets/extensions/deploy.bicep
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
@description('Conditional. The name of the virtual machine scale set that extension is provisioned for. Required if the template is used in a standalone deployment.')
@description('Conditional. The name of the parent virtual machine scale set that extension is provisioned for. Required if the template is used in a standalone deployment.')
param virtualMachineScaleSetName string

@description('Required. The name of the virtual machine scale set extension.')
Expand Down
2 changes: 1 addition & 1 deletion arm/Microsoft.Compute/virtualMachineScaleSets/extensions/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 a virtual machine scale set extension.
**Conditional parameters**
| Parameter Name | Type | Description |
| :-- | :-- | :-- |
| `virtualMachineScaleSetName` | string | The name of the virtual machine scale set that extension is provisioned for. Required if the template is used in a standalone deployment. |
| `virtualMachineScaleSetName` | string | The name of the parent virtual machine scale set that extension is provisioned for. 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.Compute/virtualMachines/extensions/deploy.bicep
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
@description('Conditional. The name of the virtual machine that extension is provisioned for. Required if the template is used in a standalone deployment.')
@description('Conditional. The name of the parent virtual machine that extension is provisioned for. Required if the template is used in a standalone deployment.')
param virtualMachineName string

@description('Required. The name of the virtual machine extension.')
Expand Down
2 changes: 1 addition & 1 deletion arm/Microsoft.Compute/virtualMachines/extensions/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 a virtual machine extension.
**Conditional parameters**
| Parameter Name | Type | Description |
| :-- | :-- | :-- |
| `virtualMachineName` | string | The name of the virtual machine that extension is provisioned for. Required if the template is used in a standalone deployment. |
| `virtualMachineName` | string | The name of the parent virtual machine that extension is provisioned for. 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.ContainerRegistry/registries/replications/deploy.bicep
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
@description('Conditional. The name of the registry. Required if the template is used in a standalone deployment.')
@description('Conditional. The name of the parent registry. Required if the template is used in a standalone deployment.')
param registryName string

@description('Required. The name of the replication.')
Expand Down
2 changes: 1 addition & 1 deletion arm/Microsoft.ContainerRegistry/registries/replications/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 ContainerRegistry Registries Replications.
**Conditional parameters**
| Parameter Name | Type | Description |
| :-- | :-- | :-- |
| `registryName` | string | The name of the registry. Required if the template is used in a standalone deployment. |
| `registryName` | string | The name of the parent registry. Required if the template is used in a standalone deployment. |

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