Skip to main content

Entity Relation Object Helper

Generated Cmdlet Help

This page has been generated from the NinjaOne PowerShell module source. To make changes please edit the appropriate PowerShell source file.

SYNOPSIS

Create a new Entity Relation object.

SYNTAX

New-NinjaOneEntityRelationObject [-EntityType] <String> [-RelationEntityType] <String> [[-Property] <String>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

Creates a new Entity Relation object containing required / specified properties / structure.

EXAMPLES

EXAMPLE 1

$newObject = @{ entityType = 'device'; relationEntityType = 'organization' }
PS> New-NinjaOneEntityRelationObject @newObject

Creates a new entity relation object with the specified properties.

PARAMETERS

-EntityType

The entity type of the relation.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-RelationEntityType

The related entity type.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Property

The relation property name.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

[Object]

A new Entity Relation object.

NOTES