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

[Fixes] Corrected Private Endpoint Parameter Usage documentation #1805

Merged
merged 2 commits into from
Aug 27, 2022
Merged

[Fixes] Corrected Private Endpoint Parameter Usage documentation #1805

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9db03a4
updated resourceUsage-privateEndpoint main doc
ahmadabdalla Aug 26, 2022
45e7944
updated readmes for all modules that use PE
ahmadabdalla Aug 27, 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
16 changes: 10 additions & 6 deletions modules/Microsoft.AppConfiguration/configurationStores/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,9 +209,11 @@ To use Private Endpoint the following dependencies must be deployed:
"name": "sxx-az-pe", // Optional: Name will be automatically generated if one is not provided here
"subnetResourceId": "/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.Network/virtualNetworks/sxx-az-vnet-x-001/subnets/sxx-az-subnet-x-001",
"service": "<<serviceName>>", // e.g. vault, registry, file, blob, queue, table etc.
"privateDnsZoneResourceIds": [ // Optional: No DNS record will be created if a private DNS zone Resource ID is not specified
"/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.Network/privateDnsZones/privatelink.blob.core.windows.net"
],
"privateDnsZoneGroup": {
"privateDNSResourceIds": [ // Optional: No DNS record will be created if a private DNS zone Resource ID is not specified
"/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.Network/privateDnsZones/privatelink.blob.core.windows.net"
]
},
"customDnsConfigs": [ // Optional
{
"fqdn": "customname.test.local",
Expand Down Expand Up @@ -243,9 +245,11 @@ privateEndpoints: [
name: 'sxx-az-pe' // Optional: Name will be automatically generated if one is not provided here
subnetResourceId: '/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.Network/virtualNetworks/sxx-az-vnet-x-001/subnets/sxx-az-subnet-x-001'
service: '<<serviceName>>' // e.g. vault registry file blob queue table etc.
privateDnsZoneResourceIds: [ // Optional: No DNS record will be created if a private DNS zone Resource ID is not specified
'/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.Network/privateDnsZones/privatelink.blob.core.windows.net'
]
privateDnsZoneGroups: {
privateDNSResourceIds: [ // Optional: No DNS record will be created if a private DNS zone Resource ID is not specified
'/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.Network/privateDnsZones/privatelink.blob.core.windows.net'
]
}
// Optional
customDnsConfigs: [
{
Expand Down
16 changes: 10 additions & 6 deletions modules/Microsoft.Automation/automationAccounts/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,9 +144,11 @@ To use Private Endpoint the following dependencies must be deployed:
"name": "sxx-az-pe", // Optional: Name will be automatically generated if one is not provided here
"subnetResourceId": "/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.Network/virtualNetworks/sxx-az-vnet-x-001/subnets/sxx-az-subnet-x-001",
"service": "<<serviceName>>", // e.g. vault, registry, file, blob, queue, table etc.
"privateDnsZoneResourceIds": [ // Optional: No DNS record will be created if a private DNS zone Resource ID is not specified
"/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.Network/privateDnsZones/privatelink.blob.core.windows.net"
],
"privateDnsZoneGroup": {
"privateDNSResourceIds": [ // Optional: No DNS record will be created if a private DNS zone Resource ID is not specified
"/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.Network/privateDnsZones/privatelink.blob.core.windows.net"
]
},
"customDnsConfigs": [ // Optional
{
"fqdn": "customname.test.local",
Expand Down Expand Up @@ -178,9 +180,11 @@ privateEndpoints: [
name: 'sxx-az-pe' // Optional: Name will be automatically generated if one is not provided here
subnetResourceId: '/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.Network/virtualNetworks/sxx-az-vnet-x-001/subnets/sxx-az-subnet-x-001'
service: '<<serviceName>>' // e.g. vault registry file blob queue table etc.
privateDnsZoneResourceIds: [ // Optional: No DNS record will be created if a private DNS zone Resource ID is not specified
'/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.Network/privateDnsZones/privatelink.blob.core.windows.net'
]
privateDnsZoneGroups: {
privateDNSResourceIds: [ // Optional: No DNS record will be created if a private DNS zone Resource ID is not specified
'/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.Network/privateDnsZones/privatelink.blob.core.windows.net'
]
}
// Optional
customDnsConfigs: [
{
Expand Down
16 changes: 10 additions & 6 deletions modules/Microsoft.Batch/batchAccounts/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,9 +153,11 @@ To use Private Endpoint the following dependencies must be deployed:
"name": "sxx-az-pe", // Optional: Name will be automatically generated if one is not provided here
"subnetResourceId": "/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.Network/virtualNetworks/sxx-az-vnet-x-001/subnets/sxx-az-subnet-x-001",
"service": "<<serviceName>>", // e.g. vault, registry, file, blob, queue, table etc.
"privateDnsZoneResourceIds": [ // Optional: No DNS record will be created if a private DNS zone Resource ID is not specified
"/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.Network/privateDnsZones/privatelink.blob.core.windows.net"
],
"privateDnsZoneGroup": {
"privateDNSResourceIds": [ // Optional: No DNS record will be created if a private DNS zone Resource ID is not specified
"/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.Network/privateDnsZones/privatelink.blob.core.windows.net"
]
},
"customDnsConfigs": [ // Optional
{
"fqdn": "customname.test.local",
Expand Down Expand Up @@ -187,9 +189,11 @@ privateEndpoints: [
name: 'sxx-az-pe' // Optional: Name will be automatically generated if one is not provided here
subnetResourceId: '/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.Network/virtualNetworks/sxx-az-vnet-x-001/subnets/sxx-az-subnet-x-001'
service: '<<serviceName>>' // e.g. vault registry file blob queue table etc.
privateDnsZoneResourceIds: [ // Optional: No DNS record will be created if a private DNS zone Resource ID is not specified
'/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.Network/privateDnsZones/privatelink.blob.core.windows.net'
]
privateDnsZoneGroups: {
privateDNSResourceIds: [ // Optional: No DNS record will be created if a private DNS zone Resource ID is not specified
'/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.Network/privateDnsZones/privatelink.blob.core.windows.net'
]
}
// Optional
customDnsConfigs: [
{
Expand Down
16 changes: 10 additions & 6 deletions modules/Microsoft.Cache/redis/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,9 +247,11 @@ To use Private Endpoint the following dependencies must be deployed:
"name": "sxx-az-pe", // Optional: Name will be automatically generated if one is not provided here
"subnetResourceId": "/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.Network/virtualNetworks/sxx-az-vnet-x-001/subnets/sxx-az-subnet-x-001",
"service": "<<serviceName>>", // e.g. vault, registry, file, blob, queue, table etc.
"privateDnsZoneResourceIds": [ // Optional: No DNS record will be created if a private DNS zone Resource ID is not specified
"/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.Network/privateDnsZones/privatelink.blob.core.windows.net"
],
"privateDnsZoneGroup": {
"privateDNSResourceIds": [ // Optional: No DNS record will be created if a private DNS zone Resource ID is not specified
"/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.Network/privateDnsZones/privatelink.blob.core.windows.net"
]
},
"customDnsConfigs": [ // Optional
{
"fqdn": "customname.test.local",
Expand Down Expand Up @@ -281,9 +283,11 @@ privateEndpoints: [
name: 'sxx-az-pe' // Optional: Name will be automatically generated if one is not provided here
subnetResourceId: '/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.Network/virtualNetworks/sxx-az-vnet-x-001/subnets/sxx-az-subnet-x-001'
service: '<<serviceName>>' // e.g. vault registry file blob queue table etc.
privateDnsZoneResourceIds: [ // Optional: No DNS record will be created if a private DNS zone Resource ID is not specified
'/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.Network/privateDnsZones/privatelink.blob.core.windows.net'
]
privateDnsZoneGroups: {
privateDNSResourceIds: [ // Optional: No DNS record will be created if a private DNS zone Resource ID is not specified
'/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.Network/privateDnsZones/privatelink.blob.core.windows.net'
]
}
// Optional
customDnsConfigs: [
{
Expand Down
16 changes: 10 additions & 6 deletions modules/Microsoft.CognitiveServices/accounts/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,9 +86,11 @@ To use Private Endpoint the following dependencies must be deployed:
"name": "sxx-az-pe", // Optional: Name will be automatically generated if one is not provided here
"subnetResourceId": "/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.Network/virtualNetworks/sxx-az-vnet-x-001/subnets/sxx-az-subnet-x-001",
"service": "<<serviceName>>", // e.g. vault, registry, file, blob, queue, table etc.
"privateDnsZoneResourceIds": [ // Optional: No DNS record will be created if a private DNS zone Resource ID is not specified
"/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.Network/privateDnsZones/privatelink.blob.core.windows.net"
],
"privateDnsZoneGroup": {
"privateDNSResourceIds": [ // Optional: No DNS record will be created if a private DNS zone Resource ID is not specified
"/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.Network/privateDnsZones/privatelink.blob.core.windows.net"
]
},
"customDnsConfigs": [ // Optional
{
"fqdn": "customname.test.local",
Expand Down Expand Up @@ -120,9 +122,11 @@ privateEndpoints: [
name: 'sxx-az-pe' // Optional: Name will be automatically generated if one is not provided here
subnetResourceId: '/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.Network/virtualNetworks/sxx-az-vnet-x-001/subnets/sxx-az-subnet-x-001'
service: '<<serviceName>>' // e.g. vault registry file blob queue table etc.
privateDnsZoneResourceIds: [ // Optional: No DNS record will be created if a private DNS zone Resource ID is not specified
'/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.Network/privateDnsZones/privatelink.blob.core.windows.net'
]
privateDnsZoneGroups: {
privateDNSResourceIds: [ // Optional: No DNS record will be created if a private DNS zone Resource ID is not specified
'/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.Network/privateDnsZones/privatelink.blob.core.windows.net'
]
}
// Optional
customDnsConfigs: [
{
Expand Down
16 changes: 10 additions & 6 deletions modules/Microsoft.ContainerRegistry/registries/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,9 +187,11 @@ To use Private Endpoint the following dependencies must be deployed:
"name": "sxx-az-pe", // Optional: Name will be automatically generated if one is not provided here
"subnetResourceId": "/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.Network/virtualNetworks/sxx-az-vnet-x-001/subnets/sxx-az-subnet-x-001",
"service": "<<serviceName>>", // e.g. vault, registry, file, blob, queue, table etc.
"privateDnsZoneResourceIds": [ // Optional: No DNS record will be created if a private DNS zone Resource ID is not specified
"/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.Network/privateDnsZones/privatelink.blob.core.windows.net"
],
"privateDnsZoneGroup": {
"privateDNSResourceIds": [ // Optional: No DNS record will be created if a private DNS zone Resource ID is not specified
"/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.Network/privateDnsZones/privatelink.blob.core.windows.net"
]
},
"customDnsConfigs": [ // Optional
{
"fqdn": "customname.test.local",
Expand Down Expand Up @@ -221,9 +223,11 @@ privateEndpoints: [
name: 'sxx-az-pe' // Optional: Name will be automatically generated if one is not provided here
subnetResourceId: '/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.Network/virtualNetworks/sxx-az-vnet-x-001/subnets/sxx-az-subnet-x-001'
service: '<<serviceName>>' // e.g. vault registry file blob queue table etc.
privateDnsZoneResourceIds: [ // Optional: No DNS record will be created if a private DNS zone Resource ID is not specified
'/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.Network/privateDnsZones/privatelink.blob.core.windows.net'
]
privateDnsZoneGroups: {
privateDNSResourceIds: [ // Optional: No DNS record will be created if a private DNS zone Resource ID is not specified
'/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.Network/privateDnsZones/privatelink.blob.core.windows.net'
]
}
// Optional
customDnsConfigs: [
{
Expand Down
1 change: 1 addition & 0 deletions ...t.DataFactory/factories/managedVirtualNetwork/managedPrivateEndpoints/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ This module deploys a Managed Private Endpoint in a Managed Virtual Network for
| :-- | :-- | :-- | :-- |
| `enableDefaultTelemetry` | bool | `True` | Enable telemetry via the Customer Usage Attribution ID (GUID). |


## Outputs

| Output Name | Type | Description |
Expand Down
16 changes: 10 additions & 6 deletions modules/Microsoft.DataFactory/factories/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,9 +217,11 @@ To use Private Endpoint the following dependencies must be deployed:
"name": "sxx-az-pe", // Optional: Name will be automatically generated if one is not provided here
"subnetResourceId": "/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.Network/virtualNetworks/sxx-az-vnet-x-001/subnets/sxx-az-subnet-x-001",
"service": "<<serviceName>>", // e.g. vault, registry, file, blob, queue, table etc.
"privateDnsZoneResourceIds": [ // Optional: No DNS record will be created if a private DNS zone Resource ID is not specified
"/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.Network/privateDnsZones/privatelink.blob.core.windows.net"
],
"privateDnsZoneGroup": {
"privateDNSResourceIds": [ // Optional: No DNS record will be created if a private DNS zone Resource ID is not specified
"/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.Network/privateDnsZones/privatelink.blob.core.windows.net"
]
},
"customDnsConfigs": [ // Optional
{
"fqdn": "customname.test.local",
Expand Down Expand Up @@ -251,9 +253,11 @@ privateEndpoints: [
name: 'sxx-az-pe' // Optional: Name will be automatically generated if one is not provided here
subnetResourceId: '/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.Network/virtualNetworks/sxx-az-vnet-x-001/subnets/sxx-az-subnet-x-001'
service: '<<serviceName>>' // e.g. vault registry file blob queue table etc.
privateDnsZoneResourceIds: [ // Optional: No DNS record will be created if a private DNS zone Resource ID is not specified
'/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.Network/privateDnsZones/privatelink.blob.core.windows.net'
]
privateDnsZoneGroups: {
privateDNSResourceIds: [ // Optional: No DNS record will be created if a private DNS zone Resource ID is not specified
'/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.Network/privateDnsZones/privatelink.blob.core.windows.net'
]
}
// Optional
customDnsConfigs: [
{
Expand Down
16 changes: 10 additions & 6 deletions modules/Microsoft.EventGrid/topics/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,9 +68,11 @@ To use Private Endpoint the following dependencies must be deployed:
"name": "sxx-az-pe", // Optional: Name will be automatically generated if one is not provided here
"subnetResourceId": "/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.Network/virtualNetworks/sxx-az-vnet-x-001/subnets/sxx-az-subnet-x-001",
"service": "<<serviceName>>", // e.g. vault, registry, file, blob, queue, table etc.
"privateDnsZoneResourceIds": [ // Optional: No DNS record will be created if a private DNS zone Resource ID is not specified
"/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.Network/privateDnsZones/privatelink.blob.core.windows.net"
],
"privateDnsZoneGroup": {
"privateDNSResourceIds": [ // Optional: No DNS record will be created if a private DNS zone Resource ID is not specified
"/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.Network/privateDnsZones/privatelink.blob.core.windows.net"
]
},
"customDnsConfigs": [ // Optional
{
"fqdn": "customname.test.local",
Expand Down Expand Up @@ -102,9 +104,11 @@ privateEndpoints: [
name: 'sxx-az-pe' // Optional: Name will be automatically generated if one is not provided here
subnetResourceId: '/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.Network/virtualNetworks/sxx-az-vnet-x-001/subnets/sxx-az-subnet-x-001'
service: '<<serviceName>>' // e.g. vault registry file blob queue table etc.
privateDnsZoneResourceIds: [ // Optional: No DNS record will be created if a private DNS zone Resource ID is not specified
'/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.Network/privateDnsZones/privatelink.blob.core.windows.net'
]
privateDnsZoneGroups: {
privateDNSResourceIds: [ // Optional: No DNS record will be created if a private DNS zone Resource ID is not specified
'/subscriptions/<<subscriptionId>>/resourceGroups/validation-rg/providers/Microsoft.Network/privateDnsZones/privatelink.blob.core.windows.net'
]
}
// Optional
customDnsConfigs: [
{
Expand Down
Loading