New-CmAzIaasPrivateEndpoints

Creates Private Networking components.

Completes following:

  • Creates private DNS zone.
  • Creates private endpoints.
  • Supports integration of DNS Zones with virtual private network.
  • Supports integration of private DNS zone with private endpoint.

This command forms part of the IaaS Building Block.

Parameters

-SettingsFile

Required. (String) File path for the settings file to be converted into a settings object.

-SettingsObject

Required. (Object) Object containing the configuration values required to run this cmdlet.

-TagSettingsFile

Required. (String) File path for the tag settings file to be converted into a tag settings object.

-OmitTags

Required. (Boolean) Parameter to specify if the cmdlet should handle its own tagging.

-WhatIf

(Switch) Run the command without executing any actions, so that no changes are made. The command will output a description of actions to be performed against the affected resources in the console window. Use this option if you are unsure of the overall impact of your command and wish to review it before committing to making changes.

-Confirm

(Switch) Run the command without executing any actions, so that no changes are made. The command will output a description of actions to be performed against the affected resources in the console window. Use this option if you are unsure of the overall impact of your command and wish to review it before committing to making changes.

Usage

Example 1

1
New-CmAzIaasPrivateEndpoints -settingsFile "privateEndpoints.yml"

Example 2

1
New-CmAzIaasPrivateEndpoints -settingsObject $privateEndpoints

Settings

Beta documentation
The following schema documentation is automatically generated as part of a recent roadmap task. There may be inaccuracies or incomplete information while we flush out bugs; please refer to the packed project settings examples where necessary.

Settings Root.

Component

component [string | null]

Value to determine what cmdlet should be dynamically loaded for these settings.

Service

service [object | null]

Contains dependency and publish details for service location.

Dependencies

dependencies [object | null]

Contains dependency details for service location.

ResourceGroup

resourceGroup [string | null]

Dependency value to fetch existing resource type.

Vnet

vnet [string | null]

Global default dependency value to fetch existing resource type.

PrivateZones

privateZones [array | null]

Dependency value to fetch existing resource type. Enables private zone integration.

Publish

publish [object | null]

Contains publish details for service location.

PrivateEndpoint

privateEndpoint [string | null]

Global default value to publish on deployed resource type.

GlobalSubResourceName

globalSubResourceName [string | null]

Global subresource name which will be used if local subresources are not provided.

privateEndpoints

privateEndpoints [array] Mandatory

Container for private DNS zone details.

Name

name [string]

Becomes part of private endpoint name.

Location

location [string | null]

Location to create private endpoint

ResourceNameSpace

resourceNameSpace [string | null]

Azure resource namespace.

SubResourceName

subResourceName [string | null]

Names of underlying sub-resources to create private connection with.

SubnetName

subnetName [string]

Names of underlying sub-resources to create private connection with.

Service

service [object]

Contains dependency and publish details for service location.

Dependencies

dependencies [object]

Contains dependency details for service location.

Vnet

vnet [string | null]

Local overriding dependency value to fetch existing resource type.

ResourceGroup

resourceGroup [string | null]

Local overriding dependency value to fetch existing resource type.

Resource

resource [string]

Dependency value to fetch existing resource type.

PrivateZones

privateZones [array | null]

Dependency value to fetch existing resource type. Enables private zone integration.

Publish

publish [object | null]

Contains publish details for service location.

privateEndpoint

privateEndpoint [string | null]

Local overriding value to publish on deployed existing resource type.

Examples

The following example files are automatically generated from the settings file schema definition to show how the specification can be used in practise. Cloudmarque can accept both JSON and YAML parameter files.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
{
  "component": "string",
  "service": {
    "dependencies": {
      "resourceGroup": "string",
      "vnet": "string",
      "privateZones": [

      ]
    },
    "publish": {
      "privateEndpoint": "string"
    }
  },
  "globalSubResourceName": "string",
  "privateEndpoints": [
    {
      "name": "string",
      "location": "string",
      "resourceNameSpace": "string",
      "subResourceName": "string",
      "subnetName": "string",
      "service": {
        "dependencies": {
          "vnet": "string",
          "resourceGroup": "string",
          "resource": "string",
          "privateZones": [

          ]
        },
        "publish": {
          "privateEndpoint": "string"
        }
      }
    }
  ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
component: "string"    # Optional
service:     # Optional
  dependencies:     # Optional
    resourceGroup: "string"    # Optional
    vnet: "string"    # Optional
    privateZones:     # Optional
      -   publish:     # Optional
    privateEndpoint: "string"    # Optional
globalSubResourceName: "string"    # Optional
privateEndpoints:     # Mandatory
  - name: "string"    # Mandatory
    location: "string"    # Optional
    resourceNameSpace: "string"    # Optional
    subResourceName: "string"    # Optional
    subnetName: "string"    # Mandatory
    service:     # Mandatory
      dependencies:     # Optional
        vnet: "string"    # Optional
        resourceGroup: "string"    # Optional
        resource: "string"    # Mandatory
        privateZones:     # Optional
          -       publish:     # Optional
        privateEndpoint: "string"    # Optional