RPS Instance Definition Item

Last updated on June 25, 2021.

Last Reviewed and Approved on PENDING REVIEW

Intended Audience

This document is intended for use by the developer.

Introduction

RPS Instance Definition Items are items on an abstraction layer on top of existing RPS Types. An Instance Definition Item is a wrapper for an RPS Type and associated Properties.

Terms and Definitions

  • Instance Definition The abstraction layer on top of existing RPS Types.
  • Instance Definition Reference The assignment of the Instance Definition to a root Resource Item, which results in a set of one or more Resource Items to be run.
  • Instance Definition Item The item on the abstraction layer on top of existing RPS Types.
  • Instance Definition Node A node item that will result in an association of a node with target items that are created when an Instance Definition is invoked.

Creating, Getting, Setting, and Removing an Instance Definition Item

Before activating any software, you must establish your working session. To do so, execute the following PowerShell Command in PowerShell ISE Administrator Mode.

Important

Start by establishing your working session in PowerShell ISE Administrator Mode.

  1. Click on the Search Icon from the Start Menu. Click on Search Icon Figure 1: Click on Search Icon.

  2. Search for PowerShell ISE by typing PowerShell ISE in the Search bar. Search for PowerShell ISE Figure 2: Search for PowerShell ISE.

  3. Click on Run as administrator. Open PowerShell ISE as Administrator Figure 3: Open PowerShell ISE as Administrator.

Creating an Instance Definition Item

Create new Instance Definition Item by Type Definition ID.

New-RpsInstanceDefinitionItem -EntityName $testEntityName -Properties $prop -TypeDefinitionId $typedefId

Create new Instance Definition Item by Type Definition object.

New-RpsInstanceDefinitionItem -EntityName $testEntityName -Properties $prop -TypeDefinition $typedef

Getting an Instance Definition Item

Find an Instance Definition Item by Type Definition ID.

Get-RpsInstanceDefinitionItem -Id $lookupId

Setting an Instance Definition Item

Updates Instance Definition Item. If it doesn't exist, it will create a New Instance Definition Item.

Set-RpsInstanceDefinitionItem -Name $Name1 -TypeDefinitionId $id -Properties @{Prop1 = "Value1"} -EntityName $entityName

Removing an Instance Definition Item

Delete Instance Definition by ID.

Remove-RpsInstanceDefinitionItem -Id "8825A09C-CCE3-4BB0-BCE1-03B4729AC423"
Remove-RpsInstanceDefinitionItem -InstanceDefinitionItem $RPSInstanceDefinitionItem

More Resources