-
Notifications
You must be signed in to change notification settings - Fork 420
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.
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
feat: Added support for Discrimintor-based variants to readme utility #4146
base: main
Are you sure you want to change the base?
Changes from 46 commits
6c06b68
dbbfcb3
0c16632
2529217
7d7ad9b
9fc4f89
7571241
c3e5384
6b72f5f
81c5095
18a5527
b0afd17
a0029a8
2bca0f4
7258adb
4be63d2
d0c4354
6613708
79a94b1
cdbcdc0
0c9cc1c
612ed21
b23dcfd
417fef6
0edc305
1b5a6ea
a08850c
6368299
4889247
5a3c1ef
42fc000
c12c4f5
a7d99e4
5cadd3f
7f4e4c3
d38d771
715b259
dfa413e
a6e4643
502fbe9
6178501
6fd858c
aa138e1
0f83616
d83d9a8
191a834
1a310ad
0cd4975
7930c8e
3ee82ff
ef91287
dc60f61
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -1608,6 +1608,249 @@ The outbound rule. The name of the rule is the object key. | |
|
||
- Required: Yes | ||
- Type: object | ||
- Type-deciding property: type | ||
|
||
<h4>The available variants are:</h4> | ||
|
||
| Variant | Description | | ||
| :-- | :-- | | ||
| [`FQDN`](#variant-workspaceconfigurationnetworkoutboundrules>any_other_property<type-fqdn) | The type for a FQDN outbound rule. | | ||
| [`PrivateEndpoint`](#variant-workspaceconfigurationnetworkoutboundrules>any_other_property<type-privateendpoint) | The type for a private endpoint outbound rule. | | ||
| [`ServiceTag`](#variant-workspaceconfigurationnetworkoutboundrules>any_other_property<type-servicetag) | The type for an service tag outbound rule. | | ||
|
||
### Variant: `workspaceConfiguration.networkOutboundRules.>Any_other_property<.type-FQDN` | ||
The type for a FQDN outbound rule. | ||
|
||
To use this variant, set the property `type` to `FQDN`. | ||
|
||
**Required parameters** | ||
|
||
| Parameter | Type | Description | | ||
| :-- | :-- | :-- | | ||
| [`destination`](#parameter-workspaceconfigurationnetworkoutboundrules>any_other_property<type-fqdndestination) | string | Fully Qualified Domain Name to allow for outbound traffic. | | ||
| [`type`](#parameter-workspaceconfigurationnetworkoutboundrules>any_other_property<type-fqdntype) | string | Type of a managed network Outbound Rule of the workspace hub. Only supported when 'isolationMode' is 'AllowOnlyApprovedOutbound'. | | ||
|
||
**Optional parameters** | ||
|
||
| Parameter | Type | Description | | ||
| :-- | :-- | :-- | | ||
| [`category`](#parameter-workspaceconfigurationnetworkoutboundrules>any_other_property<type-fqdncategory) | string | Category of a managed network Outbound Rule of the workspace hub. | | ||
|
||
### Parameter: `workspaceConfiguration.networkOutboundRules.>Any_other_property<.type-FQDN.destination` | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Is it intended to have variant parameters with the same header level 3 ( There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It is a great question and it took me a while to understand why it's implemented in the way it is. If you collapse all sections in a readme (like this one) you'll see that the I can't recall why this was done for the parameters originally - but - my best guess is that we'd run the hazard of having parameters being nested like |
||
|
||
Fully Qualified Domain Name to allow for outbound traffic. | ||
|
||
- Required: Yes | ||
- Type: string | ||
|
||
### Parameter: `workspaceConfiguration.networkOutboundRules.>Any_other_property<.type-FQDN.type` | ||
|
||
Type of a managed network Outbound Rule of the workspace hub. Only supported when 'isolationMode' is 'AllowOnlyApprovedOutbound'. | ||
|
||
- Required: Yes | ||
- Type: string | ||
- Allowed: | ||
```Bicep | ||
[ | ||
'FQDN' | ||
] | ||
``` | ||
|
||
### Parameter: `workspaceConfiguration.networkOutboundRules.>Any_other_property<.type-FQDN.category` | ||
|
||
Category of a managed network Outbound Rule of the workspace hub. | ||
|
||
- Required: No | ||
- Type: string | ||
- Allowed: | ||
```Bicep | ||
[ | ||
'Dependency' | ||
'Recommended' | ||
'Required' | ||
'UserDefined' | ||
] | ||
``` | ||
|
||
### Variant: `workspaceConfiguration.networkOutboundRules.>Any_other_property<.type-PrivateEndpoint` | ||
The type for a private endpoint outbound rule. | ||
|
||
To use this variant, set the property `type` to `PrivateEndpoint`. | ||
|
||
**Required parameters** | ||
|
||
| Parameter | Type | Description | | ||
| :-- | :-- | :-- | | ||
| [`destination`](#parameter-workspaceconfigurationnetworkoutboundrules>any_other_property<type-privateendpointdestination) | object | Service Tag destination for a Service Tag Outbound Rule for the managed network of the workspace hub. | | ||
| [`type`](#parameter-workspaceconfigurationnetworkoutboundrules>any_other_property<type-privateendpointtype) | string | Type of a managed network Outbound Rule of the workspace hub. | | ||
|
||
**Optional parameters** | ||
|
||
| Parameter | Type | Description | | ||
| :-- | :-- | :-- | | ||
| [`category`](#parameter-workspaceconfigurationnetworkoutboundrules>any_other_property<type-privateendpointcategory) | string | Category of a managed network Outbound Rule of the workspace hub. | | ||
|
||
### Parameter: `workspaceConfiguration.networkOutboundRules.>Any_other_property<.type-PrivateEndpoint.destination` | ||
|
||
Service Tag destination for a Service Tag Outbound Rule for the managed network of the workspace hub. | ||
|
||
- Required: Yes | ||
- Type: object | ||
|
||
**Required parameters** | ||
|
||
| Parameter | Type | Description | | ||
| :-- | :-- | :-- | | ||
| [`serviceResourceId`](#parameter-workspaceconfigurationnetworkoutboundrules>any_other_property<type-privateendpointdestinationserviceresourceid) | string | The resource ID of the target resource for the private endpoint. | | ||
| [`subresourceTarget`](#parameter-workspaceconfigurationnetworkoutboundrules>any_other_property<type-privateendpointdestinationsubresourcetarget) | string | The sub resource to connect for the private endpoint. | | ||
|
||
**Optional parameters** | ||
|
||
| Parameter | Type | Description | | ||
| :-- | :-- | :-- | | ||
| [`sparkEnabled`](#parameter-workspaceconfigurationnetworkoutboundrules>any_other_property<type-privateendpointdestinationsparkenabled) | bool | Whether the private endpoint can be used by jobs running on Spark. | | ||
|
||
### Parameter: `workspaceConfiguration.networkOutboundRules.>Any_other_property<.type-PrivateEndpoint.destination.serviceResourceId` | ||
|
||
The resource ID of the target resource for the private endpoint. | ||
|
||
- Required: Yes | ||
- Type: string | ||
|
||
### Parameter: `workspaceConfiguration.networkOutboundRules.>Any_other_property<.type-PrivateEndpoint.destination.subresourceTarget` | ||
|
||
The sub resource to connect for the private endpoint. | ||
|
||
- Required: Yes | ||
- Type: string | ||
|
||
### Parameter: `workspaceConfiguration.networkOutboundRules.>Any_other_property<.type-PrivateEndpoint.destination.sparkEnabled` | ||
|
||
Whether the private endpoint can be used by jobs running on Spark. | ||
|
||
- Required: No | ||
- Type: bool | ||
|
||
### Parameter: `workspaceConfiguration.networkOutboundRules.>Any_other_property<.type-PrivateEndpoint.type` | ||
|
||
Type of a managed network Outbound Rule of the workspace hub. | ||
|
||
- Required: Yes | ||
- Type: string | ||
- Allowed: | ||
```Bicep | ||
[ | ||
'PrivateEndpoint' | ||
] | ||
``` | ||
|
||
### Parameter: `workspaceConfiguration.networkOutboundRules.>Any_other_property<.type-PrivateEndpoint.category` | ||
|
||
Category of a managed network Outbound Rule of the workspace hub. | ||
|
||
- Required: No | ||
- Type: string | ||
- Allowed: | ||
```Bicep | ||
[ | ||
'Dependency' | ||
'Recommended' | ||
'Required' | ||
'UserDefined' | ||
] | ||
``` | ||
|
||
### Variant: `workspaceConfiguration.networkOutboundRules.>Any_other_property<.type-ServiceTag` | ||
The type for an service tag outbound rule. | ||
|
||
To use this variant, set the property `type` to `ServiceTag`. | ||
|
||
**Required parameters** | ||
|
||
| Parameter | Type | Description | | ||
| :-- | :-- | :-- | | ||
| [`destination`](#parameter-workspaceconfigurationnetworkoutboundrules>any_other_property<type-servicetagdestination) | object | Service Tag destination for a Service Tag Outbound Rule for the managed network of the workspace hub. | | ||
| [`type`](#parameter-workspaceconfigurationnetworkoutboundrules>any_other_property<type-servicetagtype) | string | Type of a managed network Outbound Rule of the workspace hub. Only supported when 'isolationMode' is 'AllowOnlyApprovedOutbound'. | | ||
|
||
**Optional parameters** | ||
|
||
| Parameter | Type | Description | | ||
| :-- | :-- | :-- | | ||
| [`category`](#parameter-workspaceconfigurationnetworkoutboundrules>any_other_property<type-servicetagcategory) | string | Category of a managed network Outbound Rule of the workspace hub. | | ||
|
||
### Parameter: `workspaceConfiguration.networkOutboundRules.>Any_other_property<.type-ServiceTag.destination` | ||
|
||
Service Tag destination for a Service Tag Outbound Rule for the managed network of the workspace hub. | ||
|
||
- Required: Yes | ||
- Type: object | ||
|
||
**Required parameters** | ||
|
||
| Parameter | Type | Description | | ||
| :-- | :-- | :-- | | ||
| [`portRanges`](#parameter-workspaceconfigurationnetworkoutboundrules>any_other_property<type-servicetagdestinationportranges) | string | The name of the service tag to allow. | | ||
| [`protocol`](#parameter-workspaceconfigurationnetworkoutboundrules>any_other_property<type-servicetagdestinationprotocol) | string | The protocol to allow. Provide an asterisk(*) to allow any protocol. | | ||
| [`serviceTag`](#parameter-workspaceconfigurationnetworkoutboundrules>any_other_property<type-servicetagdestinationservicetag) | string | Which ports will be allow traffic by this rule. Provide an asterisk(*) to allow any port. | | ||
|
||
### Parameter: `workspaceConfiguration.networkOutboundRules.>Any_other_property<.type-ServiceTag.destination.portRanges` | ||
|
||
The name of the service tag to allow. | ||
|
||
- Required: Yes | ||
- Type: string | ||
|
||
### Parameter: `workspaceConfiguration.networkOutboundRules.>Any_other_property<.type-ServiceTag.destination.protocol` | ||
|
||
The protocol to allow. Provide an asterisk(*) to allow any protocol. | ||
|
||
- Required: Yes | ||
- Type: string | ||
- Allowed: | ||
```Bicep | ||
[ | ||
'*' | ||
'ICMP' | ||
'TCP' | ||
'UDP' | ||
] | ||
``` | ||
|
||
### Parameter: `workspaceConfiguration.networkOutboundRules.>Any_other_property<.type-ServiceTag.destination.serviceTag` | ||
|
||
Which ports will be allow traffic by this rule. Provide an asterisk(*) to allow any port. | ||
|
||
- Required: Yes | ||
- Type: string | ||
|
||
### Parameter: `workspaceConfiguration.networkOutboundRules.>Any_other_property<.type-ServiceTag.type` | ||
|
||
Type of a managed network Outbound Rule of the workspace hub. Only supported when 'isolationMode' is 'AllowOnlyApprovedOutbound'. | ||
|
||
- Required: Yes | ||
- Type: string | ||
- Allowed: | ||
```Bicep | ||
[ | ||
'ServiceTag' | ||
] | ||
``` | ||
|
||
### Parameter: `workspaceConfiguration.networkOutboundRules.>Any_other_property<.type-ServiceTag.category` | ||
|
||
Category of a managed network Outbound Rule of the workspace hub. | ||
|
||
- Required: No | ||
- Type: string | ||
- Allowed: | ||
```Bicep | ||
[ | ||
'Dependency' | ||
'Recommended' | ||
'Required' | ||
'UserDefined' | ||
] | ||
``` | ||
|
||
### Parameter: `workspaceConfiguration.projectName` | ||
|
||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Waiting for readmes to be regenerated after agreeing on https://github.com/Azure/bicep-registry-modules/pull/4146/files?file-filters%5B%5D=.ps1&file-filters%5B%5D=.psm1&show-viewed-files=true#r1995727675