VMNetwork [SPFSDK][VMMREF]

  • Article

 

Applies To: Windows Azure Pack

The VMNetwork entity represents a virtual network.

For an example on how to create and assign a VM network, see Example: Create a VM network and assign it to a virtual network adapter.

Inheritance Hierarchy

VMM
  VMNetwork

Entity Properties

For more information about how the properties of an entity interact with HTTP operations, see Entity Basics.

Name

Create (POST)

Read (GET)

Update (PUT)

Delete (DELETE)

Type

Nullable

Description

ID

-

Optional

Required

Required

Edm.Guid

False

Key Property

The identifier of the entity.

StampId

Required

Optional

Required

Required

Edm.Guid

False

Key Property

The identifier of the stamp that contains the entity.

AddedTime

-

Optional

-

-

Edm.DateTime

True

When the virtual machine network object was added.

AutoCreateSubnet

Optional

Optional

-

-

Edm.Boolean

True

Whether VM subnets can be provisioned using existing virtual LANs on the logical network.

CAIPAddressPoolType

Optional

Optional

-

-

Edm.String

True

An address pool type.

  • IPV4

  • IPV6

Description

Optional

Optional

Optional

-

Edm.String

True

The description of the entity.

Enabled

-

Optional

-

-

Edm.Boolean

True

Whether the VMNetwork is enabled.

ExternalName

Optional

Optional

-

-

Edm.String

True

The external name of the VMNetwork.

GrantedToList

-

Optional

Optional

-

Collection(UserAndRole)

False

The users that have access rights to this VM network.

IsAssigned

-

Optional

-

-

Edm.Boolean

True

Whether the VM network has been provisioned.

IsolationType

Optional*

Optional

-

-

Edm.String

True

The isolation type of the VM network.

  • NoIsolation

  • WindowsNetworkVirtualization

  • External

  • VLANNetwork

*Only Hoster Administrators can set this property on Create.

LogicalNetworkId

Required

Optional

-

-

Edm.Guid

True

The identifier of the associated logical network.

LogicalNetworkName

-

Optional

-

-

Edm.String

True

The name of the associated logical network.

ModifiedTime

-

Optional

-

-

Edm.DateTime

True

The time the entity was last modified.

Name

Required

Optional

Optional

-

Edm.String

True

The name of the virtual network.

Owner

-

Optional

Optional

-

UserAndRole

True

The owner of the virtual network in the form of a valid domain user account.

PAIPAddressPoolType

Optional

Optional

-

-

Edm.String

True

The address pool type.

  • IPV4

  • IPV6

PROTipID

Optional

Optional

Optional

-

Edm.Guid

True

The ID of the PRO tip.

RoutingDomainId

Optional

Optional

-

-

Edm.Guid

True

The ID of a routing domain.

Relationships

For more information about how the relationships of an entity are used, see Entity Basics.

Name

Relationship Type

From Property

To Entity

To Property

MostRecentTask

One or None

Not specified

Job [SPFSDK][VMMREF]

Not specified

VMNetworkGateways

Many

Not specified

VMNetworkGateway [SPFSDK][VMMREF]

Not specified

OData Operations

None

Examples

See Also

Entities [SPFSDK][VMMREF]
VMNetworks Collection [SPFSDK][VMMREF]