Skip to content

Latest commit

 

History

History
85 lines (60 loc) · 1.74 KB

New-AvmTelemetryIdPrefix.md

File metadata and controls

85 lines (60 loc) · 1.74 KB

New-AvmTelemetryIdPrefix

Synopsis

Generate a seven-character hexadecimal telemetry identifier.

Description

Returns a random Bicep or Terraform telemetry prefix. Retries if the candidate is in KnownPrefix, which should include current and former identifiers from the relevant module inventory.

Syntax

New-AvmTelemetryIdPrefix [-Ecosystem] <string> [-Kind] <string> [[-KnownPrefix] <string[]>] [-SkipModuleVersionCheck] [<CommonParameters>]

Parameters

-Ecosystem

The module ecosystem: bicep or terraform.

Property Value
Type String
Required true
Position 1
Default value
Accept pipeline input false
Accept wildcard characters false

-Kind

The module kind: res, ptn, or utl.

Property Value
Type String
Required true
Position 2
Default value
Accept pipeline input false
Accept wildcard characters false

-KnownPrefix

Prefixes that must not be reused.

Property Value
Type String[]
Required false
Position 3
Default value @()
Accept pipeline input false
Accept wildcard characters false

-SkipModuleVersionCheck

Skip the installed-module version check for a trusted checkout.

Property Value
Type Switch
Required false
Position named
Default value False
Accept pipeline input false
Accept wildcard characters false

Examples

EXAMPLE 1

New-AvmTelemetryIdPrefix -Ecosystem bicep -Kind res -KnownPrefix $existing -SkipModuleVersionCheck

Outputs

  • A telemetry prefix string.