Partager via


Microsoft.ScVmm vmmServers/inventoryItems 2023-10-07

Bicep resource definition

The vmmServers/inventoryItems resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ScVmm/vmmServers/inventoryItems resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.ScVmm/vmmServers/inventoryItems@2023-10-07' = {
  parent: resourceSymbolicName
  kind: 'string'
  name: 'string'
  properties: {
    inventoryType: 'string'
    // For remaining properties, see InventoryItemProperties objects
  }
}

InventoryItemProperties objects

Set the inventoryType property to specify the type of object.

For Cloud, use:

{
  inventoryType: 'Cloud'
}

For VirtualMachine, use:

{
  cloud: {
    inventoryItemId: 'string'
    inventoryItemName: 'string'
  }
  inventoryType: 'VirtualMachine'
  ipAddresses: [
    'string'
  ]
}

For VirtualMachineTemplate, use:

{
  inventoryType: 'VirtualMachineTemplate'
}

For VirtualNetwork, use:

{
  inventoryType: 'VirtualNetwork'
}

Property Values

CloudInventoryItem

Name Description Value
inventoryType They inventory type. 'Cloud' (required)

InventoryItemDetails

Name Description Value
inventoryItemId Gets or sets the inventory Item ID for the resource. string
inventoryItemName Gets or sets the Managed Object name in Vmm for the resource. string

InventoryItemProperties

Name Description Value
inventoryType Set to 'Cloud' for type CloudInventoryItem. Set to 'VirtualMachine' for type VirtualMachineInventoryItem. Set to 'VirtualMachineTemplate' for type VirtualMachineTemplateInventoryItem. Set to 'VirtualNetwork' for type VirtualNetworkInventoryItem. 'Cloud'
'VirtualMachine'
'VirtualMachineTemplate'
'VirtualNetwork' (required)

Microsoft.ScVmm/vmmServers/inventoryItems

Name Description Value
kind Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value. string
name The resource name string

Constraints:
Pattern = ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.
Symbolic name for resource of type: vmmServers
properties The resource-specific properties for this resource. InventoryItemProperties

VirtualMachineInventoryItem

Name Description Value
cloud Cloud inventory resource details where the VM is present. InventoryItemDetails
inventoryType They inventory type. 'VirtualMachine' (required)
ipAddresses Gets or sets the nic ip addresses. string[]

VirtualMachineTemplateInventoryItem

Name Description Value
inventoryType They inventory type. 'VirtualMachineTemplate' (required)

VirtualNetworkInventoryItem

Name Description Value
inventoryType They inventory type. 'VirtualNetwork' (required)

ARM template resource definition

The vmmServers/inventoryItems resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ScVmm/vmmServers/inventoryItems resource, add the following JSON to your template.

{
  "type": "Microsoft.ScVmm/vmmServers/inventoryItems",
  "apiVersion": "2023-10-07",
  "name": "string",
  "kind": "string",
  "properties": {
    "inventoryType": "string"
    // For remaining properties, see InventoryItemProperties objects
  }
}

InventoryItemProperties objects

Set the inventoryType property to specify the type of object.

For Cloud, use:

{
  "inventoryType": "Cloud"
}

For VirtualMachine, use:

{
  "cloud": {
    "inventoryItemId": "string",
    "inventoryItemName": "string"
  },
  "inventoryType": "VirtualMachine",
  "ipAddresses": [ "string" ]
}

For VirtualMachineTemplate, use:

{
  "inventoryType": "VirtualMachineTemplate"
}

For VirtualNetwork, use:

{
  "inventoryType": "VirtualNetwork"
}

Property Values

CloudInventoryItem

Name Description Value
inventoryType They inventory type. 'Cloud' (required)

InventoryItemDetails

Name Description Value
inventoryItemId Gets or sets the inventory Item ID for the resource. string
inventoryItemName Gets or sets the Managed Object name in Vmm for the resource. string

InventoryItemProperties

Name Description Value
inventoryType Set to 'Cloud' for type CloudInventoryItem. Set to 'VirtualMachine' for type VirtualMachineInventoryItem. Set to 'VirtualMachineTemplate' for type VirtualMachineTemplateInventoryItem. Set to 'VirtualNetwork' for type VirtualNetworkInventoryItem. 'Cloud'
'VirtualMachine'
'VirtualMachineTemplate'
'VirtualNetwork' (required)

Microsoft.ScVmm/vmmServers/inventoryItems

Name Description Value
apiVersion The api version '2023-10-07'
kind Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value. string
name The resource name string

Constraints:
Pattern = ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ (required)
properties The resource-specific properties for this resource. InventoryItemProperties
type The resource type 'Microsoft.ScVmm/vmmServers/inventoryItems'

VirtualMachineInventoryItem

Name Description Value
cloud Cloud inventory resource details where the VM is present. InventoryItemDetails
inventoryType They inventory type. 'VirtualMachine' (required)
ipAddresses Gets or sets the nic ip addresses. string[]

VirtualMachineTemplateInventoryItem

Name Description Value
inventoryType They inventory type. 'VirtualMachineTemplate' (required)

VirtualNetworkInventoryItem

Name Description Value
inventoryType They inventory type. 'VirtualNetwork' (required)

Exemples d’utilisation

Terraform (AzAPI provider) resource definition

The vmmServers/inventoryItems resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ScVmm/vmmServers/inventoryItems resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ScVmm/vmmServers/inventoryItems@2023-10-07"
  name = "string"
  body = {
    kind = "string"
    properties = {
      inventoryType = "string"
      // For remaining properties, see InventoryItemProperties objects
    }
  }
}

InventoryItemProperties objects

Set the inventoryType property to specify the type of object.

For Cloud, use:

{
  inventoryType = "Cloud"
}

For VirtualMachine, use:

{
  cloud = {
    inventoryItemId = "string"
    inventoryItemName = "string"
  }
  inventoryType = "VirtualMachine"
  ipAddresses = [
    "string"
  ]
}

For VirtualMachineTemplate, use:

{
  inventoryType = "VirtualMachineTemplate"
}

For VirtualNetwork, use:

{
  inventoryType = "VirtualNetwork"
}

Property Values

CloudInventoryItem

Name Description Value
inventoryType They inventory type. 'Cloud' (required)

InventoryItemDetails

Name Description Value
inventoryItemId Gets or sets the inventory Item ID for the resource. string
inventoryItemName Gets or sets the Managed Object name in Vmm for the resource. string

InventoryItemProperties

Name Description Value
inventoryType Set to 'Cloud' for type CloudInventoryItem. Set to 'VirtualMachine' for type VirtualMachineInventoryItem. Set to 'VirtualMachineTemplate' for type VirtualMachineTemplateInventoryItem. Set to 'VirtualNetwork' for type VirtualNetworkInventoryItem. 'Cloud'
'VirtualMachine'
'VirtualMachineTemplate'
'VirtualNetwork' (required)

Microsoft.ScVmm/vmmServers/inventoryItems

Name Description Value
kind Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value. string
name The resource name string

Constraints:
Pattern = ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: vmmServers
properties The resource-specific properties for this resource. InventoryItemProperties
type The resource type "Microsoft.ScVmm/vmmServers/inventoryItems@2023-10-07"

VirtualMachineInventoryItem

Name Description Value
cloud Cloud inventory resource details where the VM is present. InventoryItemDetails
inventoryType They inventory type. 'VirtualMachine' (required)
ipAddresses Gets or sets the nic ip addresses. string[]

VirtualMachineTemplateInventoryItem

Name Description Value
inventoryType They inventory type. 'VirtualMachineTemplate' (required)

VirtualNetworkInventoryItem

Name Description Value
inventoryType They inventory type. 'VirtualNetwork' (required)