Hcn Agenda
Enums
Note: all variants listed should be used as string
ActionType
Referenced by: CommonAclPolicySetting; TierAclRule
| Variants | NewInVersion | Description |
|---|---|---|
"Allow" |
2.0 | |
"Block" |
2.0 | |
"Pass" |
2.10 |
AuthenticationType
Referenced by: PrioritizedAuthenticationMethod
| Variants | NewInVersion | Description |
|---|---|---|
"PresharedKey" |
2.1 | |
"Certificate" |
2.1 |
DirectionType
Referenced by: CommonAclPolicySetting; TierAclPolicySetting
| Variants | NewInVersion | Description |
|---|---|---|
"In" |
2.0 | |
"Out" |
2.0 |
EncryptionMethod
Referenced by: EncryptionPolicySetting
| Variants | NewInVersion | Description |
|---|---|---|
"Ipsec" |
2.1 |
EndpointFlags
Referenced by: HostComputeEndpoint
| Variants | NewInVersion | Description |
|---|---|---|
"None" |
2.0 | |
"RemoteEndpoint" |
2.0 | |
"DisableInterComputeCommunication" |
2.0 | |
"EnableMirroring" |
2.0 | |
"EnableLowInterfaceMetric" |
2.0 | |
"OverrideDNSServerOrder" |
2.0 | |
"EnableDhcp" |
2.0 |
EndpointPolicyType
Referenced by: EndpointPolicy
| Variants | NewInVersion | Description |
|---|---|---|
"PortMapping" |
2.0 | |
"ACL" |
2.0 | |
"QOS" |
2.0 | |
"L2Driver" |
2.0 | |
"OutBoundNAT" |
2.0 | |
"SDNRoute" |
2.0 | |
"L4Proxy" |
2.0 | |
"L4WFPPROXY" |
2.5 | |
"ProviderAddress" |
2.0 | Maps to VNET policy with PA |
"PortName" |
2.0 | |
"EncapOverhead" |
2.0 | |
"InterfaceConstraint" |
2.0 | |
"Encryption" |
2.1 | |
"VLAN" |
2.4 | |
"InterfaceParameters" |
2.4 | |
"Iov" |
2.9 | |
"TierAcl" |
2.10 |
EndpointResourceType
Referenced by: ModifyEndpointSettingRequest
| Variants | NewInVersion | Description |
|---|---|---|
"Port" |
2.0 | |
"Policy" |
2.0 |
EntityFlags
| Variants | NewInVersion | Description |
|---|---|---|
"None" |
2.0 | |
"EnableNonPersistent" |
2.0 |
FirewallPolicyFlags
Referenced by: FirewallPolicySetting
| Variants | NewInVersion | Description |
|---|---|---|
"None" |
2.16 | |
"ConstrainedInterface" |
2.16 |
FirewallVMType
Referenced by: FirewallPolicySetting
| Variants | NewInVersion | Description |
|---|---|---|
"Invalid" |
2.16 | |
"Host" |
2.16 | |
"WSA" |
2.16 | |
"WSL" |
2.16 |
GuestEndpointResourceType
Referenced by: ModifyGuestEndpointSettingRequest
| Variants | NewInVersion | Description |
|---|---|---|
"Interface" |
2.0 | |
"Route" |
2.0 | |
"IPAddress" |
2.0 | |
"DNS" |
2.0 | |
"RegistryKey" |
2.0 | |
"Encryption" |
2.1 | |
"MacAddress" |
2.5 | |
"L4Proxy" |
2.5 | |
"L4WFPPROXY" |
2.5 | |
"Xlat" |
2.5 | |
"Neighbor" |
2.5 |
GuestNamespaceResourceType
Referenced by: ModifyGuestNamespaceSettingRequest
| Variants | NewInVersion | Description |
|---|---|---|
"Container" |
2.0 | |
"Endpoint" |
2.0 |
GuestNetworkServiceFlags
Referenced by: GuestNetworkService
| Variants | NewInVersion | Description |
|---|---|---|
"None" |
2.12 | |
"IsFlowsteered" |
2.12 | |
"IsFlowsteeredSelfManaged" |
2.14 |
GuestNetworkServiceInterfaceState
Referenced by: GuestNetworkServiceInterface
| Variants | NewInVersion | Description |
|---|---|---|
"Created" |
2.2 | |
"Bootstrapping" |
2.2 | |
"Synchronized" |
2.2 | |
"Desynchronized" |
2.2 | |
"Paused" |
2.2 |
GuestNetworkServiceNotificationType
Referenced by: GuestNetworkServiceInterface
| Variants | NewInVersion | Description |
|---|---|---|
"None" |
2.7 | |
"DNSCacheParam" |
2.7 | |
"DHCPParam" |
2.7 | |
"InterfaceParam" |
2.7 | |
"AddressParam" |
2.7 | |
"Route" |
2.7 | |
"DNSParam" |
2.7 | |
"XlatParam" |
2.7 | |
"Neighbor" |
2.7 |
GuestNetworkServiceResourceType
Referenced by: ModifyGuestNetworkServiceSettingRequest
| Variants | NewInVersion | Description |
|---|---|---|
"State" |
2.0 |
GuestNetworkServiceState
Referenced by: GuestNetworkServiceNotificationData; GuestNetworkServiceStateRequest
| Variants | NewInVersion | Description |
|---|---|---|
"None" |
2.0 | |
"Created" |
2.0 | |
"Bootstrapping" |
2.0 | |
"Synchronized" |
2.0 | |
"Paused" |
2.0 | |
"Desynchronized" |
2.5 | |
"Rehydrating" |
2.5 | |
"Degraded" |
2.0 | |
"Destroyed" |
2.0 |
GuestResourceType
Referenced by: GuestModifySettingRequest
| Variants | NewInVersion | Description |
|---|---|---|
"Endpoint" |
2.0 | |
"Namespace" |
2.0 | |
"Service" |
2.0 | |
"Firewall" |
2.0 |
HostComputeQueryFlags
Referenced by: HostComputeQuery
| Variants | NewInVersion | Description |
|---|---|---|
"None" |
2.0 | |
"Detailed" |
2.0 |
HostResourceType
| Variants | NewInVersion | Description |
|---|---|---|
"Network" |
2.0 | |
"Endpoint" |
2.0 | |
"Container" |
2.0 | |
"Namespace" |
2.0 | |
"PolicyList" |
2.0 |
IovInterruptModerationType
Referenced by: IovPolicySetting
| Variants | NewInVersion | Description |
|---|---|---|
"IovInterruptModerationDefault" |
2.9 | |
"IovInterruptModerationAdaptive" |
2.9 | |
"IovInterruptModerationOff" |
2.9 | |
"IovInterruptModerationLow" |
2.9 | |
"IovInterruptModerationMedium" |
2.9 | |
"IovInterruptModerationHigh" |
2.9 |
IpamType
Referenced by: Ipam
| Variants | NewInVersion | Description |
|---|---|---|
"Static" |
2.0 | |
"Dhcp" |
2.0 |
IPSubnetFlags
Referenced by: IpSubnet
| Variants | NewInVersion | Description |
|---|---|---|
"None" |
2.5 | |
"EnableBroadcast" |
2.5 | |
"ReserveNetworkAddress" |
2.5 |
LoadBalancerDistribution
Referenced by: LoadBalancerPortMapping
| Variants | NewInVersion | Description |
|---|---|---|
"None" |
2.7 | |
"SourceIPProtocol" |
2.7 | |
"SourceIP" |
2.7 |
LoadBalancerFlags
Referenced by: HostComputeLoadBalancer
| Variants | NewInVersion | Description |
|---|---|---|
"None" |
2.0 | |
"EnableDirectServerReturn" |
2.0 | |
"IPv6" |
2.8 |
LoadBalancerPortMappingFlags
Referenced by: LoadBalancerPortMapping
| Variants | NewInVersion | Description |
|---|---|---|
"None" |
2.0 | |
"EnableInternalLoadBalancer" |
2.0 | |
"LocalRoutedVip" |
2.0 | |
"NotUsed" |
2.0 | |
"EnablePreserveDip" |
2.0 |
ModifyRequestType
Referenced by: ModifySettingRequest
| Variants | NewInVersion | Description |
|---|---|---|
"Add" |
2.0 | |
"Remove" |
2.0 | |
"Update" |
2.0 | |
"Refresh" |
2.0 | |
"Reset" |
2.0 |
NamespaceResourceType
Referenced by: ModifyNamespaceSettingRequest; NamespaceResource
| Variants | NewInVersion | Description |
|---|---|---|
"Container" |
2.0 | |
"Endpoint" |
2.0 |
NamespaceType
Referenced by: HostComputeNamespace
| Variants | NewInVersion | Description |
|---|---|---|
"Host" |
2.0 | |
"HostDefault" |
2.0 | |
"Guest" |
2.0 | |
"GuestDefault" |
2.0 |
NatFlags
Referenced by: OutboundNatPolicySetting; PortMappingPolicySetting
| Variants | NewInVersion | Description |
|---|---|---|
"None" |
2.0 | |
"LocalRoutedVip" |
2.0 | |
"IPv6" |
2.8 |
NetworkFlags
Referenced by: HostComputeNetwork
| Variants | NewInVersion | Description |
|---|---|---|
"None" |
2.0 | |
"EnableDnsProxy" |
2.0 | |
"EnableDhcpServer" |
2.0 | |
"EnableMirroring" |
2.0 | |
"EnableNonPersistent" |
2.0 | |
"EnablePersistent" |
2.0 | |
"IsolateVSwitch" |
2.0 | |
"EnableFlowSteering" |
2.11 | |
"DisableSharing" |
2.14 | |
"EnableFirewall" |
2.14 |
NetworkMode
Referenced by: HostComputeNetwork
| Variants | NewInVersion | Description |
|---|---|---|
"NAT" |
2.0 | |
"ICS" |
2.0 | |
"Transparent" |
2.0 | |
"L2Bridge" |
2.0 | |
"L2Tunnel" |
2.0 | |
"Overlay" |
2.0 | |
"Private" |
2.0 | |
"Internal" |
2.0 | |
"Mirrored" |
2.4 | Flow Steering Engine |
"Infiniband" |
2.4 | |
"ConstrainedICS" |
2.10 |
NetworkPolicyType
Referenced by: NetworkPolicy
| Variants | NewInVersion | Description |
|---|---|---|
"SourceMacAddress" |
2.0 | |
"NetAdapterName" |
2.0 | |
"InterfaceConstraint" |
2.0 | |
"VSwitchExtension" |
2.0 | |
"ProviderAddress" |
2.0 | |
"DrMacAddress" |
2.0 | |
"AutomaticDNS" |
2.0 | |
"RemoteSubnetRoute" |
2.0 | |
"VxlanPort" |
2.0 | |
"HostRoute" |
2.0 | |
"SetPolicy" |
2.0 | |
"L4Proxy" |
2.0 | |
"LayerConstraint" |
2.0 | |
"NetworkACL" |
2.0 |
NetworkResourceType
Referenced by: ModifyNetworkSettingRequest
| Variants | NewInVersion | Description |
|---|---|---|
"DNS" |
2.0 | |
"Extension" |
2.0 | |
"Policy" |
2.0 | |
"Subnet" |
2.6 | |
"IPSubnet" |
2.6 |
ProtocolType
Referenced by: CommonL4ProxyPolicySetting; LoadBalancerPortMapping; PortMappingPolicySetting
| Variants | NewInVersion | Description |
|---|---|---|
"Unknown" |
2.0 | |
"ICMPv4" |
2.0 | |
"IGMP" |
2.0 | |
"TCP" |
2.0 | |
"UDP" |
2.0 | |
"ICMPv6" |
2.0 |
ProxyType
| Variants | NewInVersion | Description |
|---|---|---|
"VFP" |
2.5 | Virtual Filtering Platform |
"WFP" |
2.5 | Windows Filtering Platform |
RpcEndpointType
Referenced by: RpcConnectionInformation
| Variants | NewInVersion | Description |
|---|---|---|
"HvSocket" |
2.13 | |
"LRpc" |
2.13 |
RuleType
Referenced by: CommonAclPolicySetting
| Variants | NewInVersion | Description |
|---|---|---|
"Host" |
2.0 | WFP |
"Switch" |
2.0 | VFP |
SetPolicyTypes
Referenced by: SetPolicySetting
| Variants | NewInVersion | Description |
|---|---|---|
"IPSET" |
2.0 | |
"NESTEDIPSET" |
2.0 |
SubnetFlags
Referenced by: Subnet
| Variants | NewInVersion | Description |
|---|---|---|
"None" |
2.7 | |
"DoNotReserveGatewayAddress" |
2.7 |
SubnetPolicyType
Referenced by: SubnetPolicy
| Variants | NewInVersion | Description |
|---|---|---|
"VLAN" |
2.0 | |
"VSID" |
2.0 |
Structs
AclPolicySetting
Derived from parent class: FiveTuple; CommonAclPolicySetting
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| Protocols |
string | 2.5 | |
| LocalAddresses |
string | 2.5 | |
| RemoteAddresses |
string | 2.5 | |
| LocalPorts |
string | 2.5 | |
| RemotePorts |
string | 2.5 | |
| Priority |
uint16 | 2.5 | |
| Id |
string | 2.0 | |
| Action |
ActionType | 2.0 | |
| Direction |
DirectionType | 2.0 | |
| RuleType |
RuleType | 2.0 |
AuthenticationCertificate
Derived from parent class: AuthenticationMethod
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| CertificateName |
string | 2.1 |
AuthenticationMethod
Note: This is an empty struct with no fields, and to be used in the JSON document must be specified as an empty object: "{}".
AuthenticationPresharedKey
Derived from parent class: AuthenticationMethod
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| Key |
string | 2.1 |
AutomaticDNSNetworkPolicySetting
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| Enable |
bool | 2.0 |
Base
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| ID |
Guid | 2.0 | |
| Owner |
string | 2.0 | |
| Name |
string | 2.0 | |
| Version |
uint64 | 2.0 | |
| AdditionalParams |
Any | 2.0 | |
| Health |
Health | 2.0 | |
| SchemaVersion |
Version | 2.0 | Schema version should be present in all objects |
| Telemetry |
Telemetry | 2.0 | |
| State |
uint16 | 2.0 |
BasePolicy
Derived from parent class: Base
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| ID |
Guid | 2.0 | |
| Owner |
string | 2.0 | |
| Name |
string | 2.0 | |
| Version |
uint64 | 2.0 | |
| AdditionalParams |
Any | 2.0 | |
| Health |
Health | 2.0 | |
| SchemaVersion |
Version | 2.0 | Schema version should be present in all objects |
| Telemetry |
Telemetry | 2.0 | |
| State |
uint16 | 2.0 | |
| Type |
uint16 | 2.0 | |
| Data |
Any | 2.0 |
CommonAclPolicySetting
Derived from parent class: FiveTuple
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| Protocols |
string | 2.5 | |
| LocalAddresses |
string | 2.5 | |
| RemoteAddresses |
string | 2.5 | |
| LocalPorts |
string | 2.5 | |
| RemotePorts |
string | 2.5 | |
| Priority |
uint16 | 2.5 | |
| Id |
string | 2.0 | |
| Action |
ActionType | 2.0 | |
| Direction |
DirectionType | 2.0 | |
| RuleType |
RuleType | 2.0 |
CommonL4ProxyPolicySetting
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| IP |
string | 2.0 | |
| Port |
string | 2.0 | |
| Protocol |
ProtocolType | 2.0 | |
| ExceptionList |
<string> array | 2.0 | |
| Destination |
string | 2.0 | |
| OutboundNat |
bool | 2.0 |
DNS
Referenced by: HostComputeEndpoint; HostComputeNetwork
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| Domain |
string | 2.0 | |
| Search |
<string> array | 2.0 | |
| ServerList |
<string> array | 2.0 | |
| Options |
<string> array | 2.0 |
DNS_2
Referenced by: GuestEndpointState
Derived from parent class: InterfaceNotificationMessage
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| MessageNumber |
uint64 | 2.0 | |
| Family |
uint16 | 2.0 | |
| Domain |
string | 2.0 | |
| Search |
string | 2.0 | |
| ServerList |
string | 2.0 | |
| Options |
string | 2.0 |
DrMacAddressNetworkPolicySetting
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| Address |
string | 2.0 |
EncapOverheadEndpointPolicySetting
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| Overhead |
uint16 | 2.0 |
EncryptionPolicySetting
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| EncryptionMethodType |
EncryptionMethod | 2.1 | |
| AuthenticationMethods |
<PrioritizedAuthenticationMethod> array | 2.1 | |
| Name |
string | 2.1 | |
| Endpoints1 |
<string> array | 2.1 | default Any |
| Endpoints2 |
<string> array | 2.1 | default Any |
| ProtocolType |
string | 2.1 | default Any |
| Endpoint1Ports |
<string> array | 2.1 | default All ports |
| Endpoint2Ports |
<string> array | 2.1 | default All ports |
EndpointAdditionalParams
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| SwitchId |
Guid | 2.0 | |
| SwitchPortId |
Guid | 2.0 |
EndpointPolicy
Referenced by: HostComputeEndpoint; PolicyEndpointRequest
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| Type |
EndpointPolicyType | 2.0 | |
| Settings |
Any | 2.0 |
Extension
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| Id |
Guid | 2.0 | |
| IsEnabled |
bool | 2.0 |
ExtraParams
Referenced by: Health
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| Resources |
Any | 2.0 | |
| SharedContainers |
Any | 2.0 | |
| LayeredOn |
Guid | 2.0 | |
| SwitchGuid |
Guid | 2.0 | |
| UtilityVM |
Guid | 2.0 | |
| VirtualMachine |
Guid | 2.0 |
Feature
Derived from parent class: Base
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| ID |
Guid | 2.0 | |
| Owner |
string | 2.0 | |
| Name |
string | 2.0 | |
| Version |
uint64 | 2.0 | |
| AdditionalParams |
Any | 2.0 | |
| Health |
Health | 2.0 | |
| SchemaVersion |
Version | 2.0 | Schema version should be present in all objects |
| Telemetry |
Telemetry | 2.0 | |
| State |
uint16 | 2.0 | |
| Enabled |
bool | 2.0 | |
| Data |
Any | 2.0 |
FirewallPolicySetting
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| VmType |
FirewallVMType | 2.16 | |
| FirewallPolicyFlags |
FirewallPolicyFlags | 2.16 |
FiveTuple
Referenced by: L4WfpProxyPolicySetting
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| Protocols |
string | 2.5 | |
| LocalAddresses |
string | 2.5 | |
| RemoteAddresses |
string | 2.5 | |
| LocalPorts |
string | 2.5 | |
| RemotePorts |
string | 2.5 | |
| Priority |
uint16 | 2.5 |
FiveTuple_2
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| Protocols |
string | 2.5 | |
| LocalAddresses |
string | 2.5 | |
| RemoteAddresses |
string | 2.5 | |
| LocalPorts |
string | 2.5 | |
| RemotePorts |
string | 2.5 | |
| Priority |
uint16 | 2.5 |
GuestEndpoint
Derived from parent class: Base
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| ID |
Guid | 2.0 | |
| Owner |
string | 2.0 | |
| Name |
string | 2.0 | |
| Version |
uint64 | 2.0 | |
| AdditionalParams |
Any | 2.0 | |
| Health |
Health | 2.0 | |
| SchemaVersion |
Version | 2.0 | Schema version should be present in all objects |
| Telemetry |
Telemetry | 2.0 | |
| State |
uint16 | 2.0 | |
| NamespaceId |
Guid | 2.0 |
GuestEndpointState
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| NetworkInterfaces |
<NetworkInterface> array | 2.4 | |
| Routes |
<Route_2> array | 2.4 | |
| IPAddresses |
<IPAddress> array | 2.4 | |
| DNS |
<DNS_2> array | 2.4 | |
| Xlat |
<Xlat> array | 2.5 |
GuestFirewall
Derived from parent class: Base
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| ID |
Guid | 2.0 | |
| Owner |
string | 2.0 | |
| Name |
string | 2.0 | |
| Version |
uint64 | 2.0 | |
| AdditionalParams |
Any | 2.0 | |
| Health |
Health | 2.0 | |
| SchemaVersion |
Version | 2.0 | Schema version should be present in all objects |
| Telemetry |
Telemetry | 2.0 | |
| State |
uint16 | 2.0 |
GuestModifySettingRequest
Derived from parent class: ModifySettingRequest
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| ResourceUri |
string | 2.0 | |
| RequestType |
ModifyRequestType | 2.0 | |
| ResourceType |
GuestResourceType | 2.0 | |
| Settings |
Any | 2.0 |
GuestNamespace
Derived from parent class: Base
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| ID |
Guid | 2.0 | |
| Owner |
string | 2.0 | |
| Name |
string | 2.0 | |
| Version |
uint64 | 2.0 | |
| AdditionalParams |
Any | 2.0 | |
| Health |
Health | 2.0 | |
| SchemaVersion |
Version | 2.0 | Schema version should be present in all objects |
| Telemetry |
Telemetry | 2.0 | |
| State |
uint16 | 2.0 | |
| CompartmentId |
uint32 | 2.0 | |
| Resources |
<NamespaceResource_2> array | 2.0 |
GuestNetworkService
Schema to hold the GNS info in HNS
Derived from parent class: Base
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| ID |
Guid | 2.0 | |
| Owner |
string | 2.0 | |
| Name |
string | 2.0 | |
| Version |
uint64 | 2.0 | |
| AdditionalParams |
Any | 2.0 | |
| Health |
Health | 2.0 | |
| SchemaVersion |
Version | 2.0 | Schema version should be present in all objects |
| Telemetry |
Telemetry | 2.0 | |
| State |
uint16 | 2.0 | |
| VirtualMachineId |
Guid | 2.0 | |
| MirroredInterfaces |
<GuestNetworkServiceInterface> array | 2.2 | |
| MirrorHostNetworking |
bool | 2.5 | |
| GnsRpcServerInformation |
RpcConnectionInformation | 2.11 | |
| Flags |
GuestNetworkServiceFlags | 2.12 |
GuestNetworkServiceInterface
Referenced by: GuestNetworkService; GuestNetworkServiceNotificationData
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| EndpointId |
Guid | 2.2 | |
| InterfaceGuid |
Guid | 2.2 | |
| State |
GuestNetworkServiceInterfaceState | 2.2 | |
| MissedNotifications |
GuestNetworkServiceNotificationType | 2.7 |
GuestNetworkServiceNotificationData
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| State |
GuestNetworkServiceState | 2.2 | |
| Interfaces |
<GuestNetworkServiceInterface> array | 2.2 |
GuestNetworkServiceStateRequest
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| State |
GuestNetworkServiceState | 2.0 |
GuestService
Derived from parent class: Base
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| ID |
Guid | 2.0 | |
| Owner |
string | 2.0 | |
| Name |
string | 2.0 | |
| Version |
uint64 | 2.0 | |
| AdditionalParams |
Any | 2.0 | |
| Health |
Health | 2.0 | |
| SchemaVersion |
Version | 2.0 | Schema version should be present in all objects |
| Telemetry |
Telemetry | 2.0 | |
| State |
uint16 | 2.0 | |
| ServiceId |
Guid | 2.0 | |
| Base64EncodedData |
string | 2.0 |
Health
Referenced by: Base
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| Data |
Any | 2.0 | |
| Extra |
ExtraParams | 2.0 |
HostComputeEndpoint
Derived from parent class: Base
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| ID |
Guid | 2.0 | |
| Owner |
string | 2.0 | |
| Name |
string | 2.0 | |
| Version |
uint64 | 2.0 | |
| AdditionalParams |
Any | 2.0 | |
| Health |
Health | 2.0 | |
| SchemaVersion |
Version | 2.0 | Schema version should be present in all objects |
| Telemetry |
Telemetry | 2.0 | |
| State |
uint16 | 2.0 | |
| HostComputeNetwork |
Guid | 2.0 | |
| HostComputeNamespace |
Guid | 2.0 | |
| Policies |
<EndpointPolicy> array | 2.0 | |
| IpConfigurations |
<IpConfig> array | 2.0 | |
| Dns |
DNS | 2.0 | |
| Routes |
<Route> array | 2.0 | |
| MacAddress |
string | 2.0 | |
| Flags |
EndpointFlags | 2.0 |
HostComputeLoadBalancer
Derived from parent class: Base
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| ID |
Guid | 2.0 | |
| Owner |
string | 2.0 | |
| Name |
string | 2.0 | |
| Version |
uint64 | 2.0 | |
| AdditionalParams |
Any | 2.0 | |
| Health |
Health | 2.0 | |
| SchemaVersion |
Version | 2.0 | Schema version should be present in all objects |
| Telemetry |
Telemetry | 2.0 | |
| State |
uint16 | 2.0 | |
| HostComputeNetwork |
string | 2.5 | |
| HostComputeEndpoints |
<string> array | 2.0 | |
| SourceVIP |
string | 2.0 | |
| FrontendVIPs |
<string> array | 2.0 | |
| PortMappings |
<LoadBalancerPortMapping> array | 2.0 | |
| Flags |
LoadBalancerFlags | 2.0 |
HostComputeNamespace
Derived from parent class: Base
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| ID |
Guid | 2.0 | |
| Owner |
string | 2.0 | |
| Name |
string | 2.0 | |
| Version |
uint64 | 2.0 | |
| AdditionalParams |
Any | 2.0 | |
| Health |
Health | 2.0 | |
| SchemaVersion |
Version | 2.0 | Schema version should be present in all objects |
| Telemetry |
Telemetry | 2.0 | |
| State |
uint16 | 2.0 | |
| NamespaceId |
uint32 | 2.0 | |
| NamespaceGuid |
Guid | 2.0 | |
| Type |
NamespaceType | 2.0 | |
| Resources |
<NamespaceResource> array | 2.0 |
HostComputeNetwork
Derived from parent class: Base
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| ID |
Guid | 2.0 | |
| Owner |
string | 2.0 | |
| Name |
string | 2.0 | |
| Version |
uint64 | 2.0 | |
| AdditionalParams |
Any | 2.0 | |
| Health |
Health | 2.0 | |
| SchemaVersion |
Version | 2.0 | Schema version should be present in all objects |
| Telemetry |
Telemetry | 2.0 | |
| State |
uint16 | 2.0 | |
| Type |
NetworkMode | 2.0 | |
| Policies |
<NetworkPolicy> array | 2.0 | |
| MacPool |
MacPool | 2.0 | |
| Dns |
DNS | 2.0 | |
| Ipams |
<Ipam> array | 2.0 | |
| Flags |
NetworkFlags | 2.0 |
HostComputePolicyList
Derived from parent class: Base
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| ID |
Guid | 2.0 | |
| Owner |
string | 2.0 | |
| Name |
string | 2.0 | |
| Version |
uint64 | 2.0 | |
| AdditionalParams |
Any | 2.0 | |
| Health |
Health | 2.0 | |
| SchemaVersion |
Version | 2.0 | Schema version should be present in all objects |
| Telemetry |
Telemetry | 2.0 | |
| State |
uint16 | 2.0 | |
| References |
<string> array | 2.0 | |
| Policies |
<Any> array | 2.0 |
HostComputeQuery
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| SchemaVersion |
Version | 2.0 | |
| Flags |
HostComputeQueryFlags | 2.0 | |
| Filter |
string | 2.0 |
HostComputeRoute
Derived from parent class: Base
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| ID |
Guid | 2.0 | |
| Owner |
string | 2.0 | |
| Name |
string | 2.0 | |
| Version |
uint64 | 2.0 | |
| AdditionalParams |
Any | 2.0 | |
| Health |
Health | 2.0 | |
| SchemaVersion |
Version | 2.0 | Schema version should be present in all objects |
| Telemetry |
Telemetry | 2.0 | |
| State |
uint16 | 2.0 | |
| HostComputeNetwork |
string | 2.5 | |
| HostComputeEndpoints |
<string> array | 2.0 | |
| Routes |
<SDNRoutePolicySetting> array | 2.0 |
HostRoutePolicySetting
Note: This is an empty struct with no fields, and to be used in the JSON document must be specified as an empty object: "{}".
InterfaceConstraintEndpointPolicySetting
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| InterfaceGuid |
Guid | 2.0 | |
| InterfaceLuid |
uint64 | 2.0 | |
| InterfaceIndex |
uint32 | 2.0 | |
| InterfaceMediaType |
uint32 | 2.0 | |
| InterfaceAlias |
string | 2.0 | |
| InterfaceDescription |
string | 2.0 |
InterfaceConstraintNetworkPolicySetting
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| InterfaceGuid |
Guid | 2.0 | |
| InterfaceLuid |
uint64 | 2.0 | |
| InterfaceIndex |
uint32 | 2.0 | |
| InterfaceMediaType |
uint32 | 2.0 | |
| InterfaceAlias |
string | 2.0 | |
| InterfaceDescription |
string | 2.0 |
InterfaceNotificationMessage
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| MessageNumber |
uint64 | 2.0 | |
| Family |
uint16 | 2.0 |
InterfaceParametersPolicySetting
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| Mtu |
uint16 | 2.4 |
IovPolicySetting
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| IovOffloadWeight |
uint32 | 2.9 | |
| QueuePairsRequested |
uint32 | 2.9 | |
| InterruptModeration |
IovInterruptModerationType | 2.9 |
IPAddress
Referenced by: GuestEndpointState
Derived from parent class: InterfaceNotificationMessage
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| MessageNumber |
uint64 | 2.0 | |
| Family |
uint16 | 2.0 | |
| Address |
string | 2.0 | |
| PrefixOrigin |
uint8 | 2.0 | |
| SuffixOrigin |
uint8 | 2.0 | |
| ValidLifetime |
uint32 | 2.0 | |
| PreferredLifetime |
uint32 | 2.0 | |
| OnLinkPrefixLength |
uint8 | 2.0 | |
| SkipAsSource |
bool | 2.0 |
Ipam
Referenced by: HostComputeNetwork
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| Type |
IpamType | 2.0 | Type : dhcp |
| Subnets |
<Subnet> array | 2.0 |
IpConfig
Referenced by: HostComputeEndpoint
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| IpAddress |
string | 2.0 | |
| PrefixLength |
uint8 | 2.0 | |
| IpSubnetId |
Guid | 2.3 |
IpSubnet
Referenced by: IPSubnetNetworkRequest; Subnet
Derived from parent class: Base
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| ID |
Guid | 2.0 | |
| Owner |
string | 2.0 | |
| Name |
string | 2.0 | |
| Version |
uint64 | 2.0 | |
| AdditionalParams |
Any | 2.0 | |
| Health |
Health | 2.0 | |
| SchemaVersion |
Version | 2.0 | Schema version should be present in all objects |
| Telemetry |
Telemetry | 2.0 | |
| State |
uint16 | 2.0 | |
| IpAddressPrefix |
string | 2.3 | |
| Flags |
IPSubnetFlags | 2.5 |
IPSubnetNetworkRequest
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| SubnetId |
Guid | 2.6 | |
| IpSubnets |
<IpSubnet> array | 2.6 |
L4ProxyPolicySetting
Derived from parent class: CommonL4ProxyPolicySetting
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| IP |
string | 2.0 | |
| Port |
string | 2.0 | |
| Protocol |
ProtocolType | 2.0 | |
| ExceptionList |
<string> array | 2.0 | |
| Destination |
string | 2.0 | |
| OutboundNat |
bool | 2.0 |
L4ProxyPolicySetting_2
Derived from parent class: CommonL4ProxyPolicySetting
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| IP |
string | 2.0 | |
| Port |
string | 2.0 | |
| Protocol |
ProtocolType | 2.0 | |
| ExceptionList |
<string> array | 2.0 | |
| Destination |
string | 2.0 | |
| OutboundNat |
bool | 2.0 |
L4WfpProxyPolicySetting
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| InboundProxyPort |
string | 2.11 | Port to deliver inbound proxied traffic to. |
| OutboundProxyPort |
string | 2.11 | Port to deliver outbound proxied traffic to. |
| FilterTuple |
FiveTuple | 2.5 | Matching conditions traffic filtering. |
| UserSID |
string | 2.5 | User account of the Proxy container. |
| InboundExceptions |
ProxyExceptions | 2.14 | IP Addresses or ports to exempt from redirection on inbound traffic. |
| OutboundExceptions |
ProxyExceptions | 2.14 | IP Addresses or ports to exempt from redirection on oubound traffic. |
LayerConstraintNetworkPolicySetting
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| LayerId |
Guid | 2.0 |
LoadBalancerPortMapping
Referenced by: HostComputeLoadBalancer
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| Protocol |
ProtocolType | 2.0 | |
| InternalPort |
uint16 | 2.0 | |
| ExternalPort |
uint16 | 2.0 | |
| DistributionType |
LoadBalancerDistribution | 2.7 | |
| Flags |
LoadBalancerPortMappingFlags | 2.0 |
MacAddress
Derived from parent class: InterfaceNotificationMessage
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| MessageNumber |
uint64 | 2.0 | |
| Family |
uint16 | 2.0 | |
| PhysicalAddress |
string | 2.5 |
MacPool
Referenced by: HostComputeNetwork
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| Ranges |
<MacRange> array | 2.0 |
MacRange
Referenced by: MacPool
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| StartMacAddress |
string | 2.0 | |
| EndMacAddress |
string | 2.0 |
ModifyEndpointSettingRequest
Derived from parent class: ModifySettingRequest
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| ResourceUri |
string | 2.0 | |
| RequestType |
ModifyRequestType | 2.0 | |
| ResourceType |
EndpointResourceType | 2.0 | |
| Settings |
Any | 2.0 |
ModifyGuestEndpointSettingRequest
Derived from parent class: ModifySettingRequest
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| ResourceUri |
string | 2.0 | |
| RequestType |
ModifyRequestType | 2.0 | |
| ResourceType |
GuestEndpointResourceType | 2.0 | |
| Settings |
Any | 2.0 |
ModifyGuestNamespaceSettingRequest
Derived from parent class: ModifySettingRequest
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| ResourceUri |
string | 2.0 | |
| RequestType |
ModifyRequestType | 2.0 | |
| ResourceType |
GuestNamespaceResourceType | 2.0 | |
| Settings |
Any | 2.0 |
ModifyGuestNetworkServiceSettingRequest
Derived from parent class: ModifySettingRequest
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| ResourceUri |
string | 2.0 | |
| RequestType |
ModifyRequestType | 2.0 | |
| ResourceType |
GuestNetworkServiceResourceType | 2.0 | |
| Settings |
Any | 2.0 |
ModifyNamespaceSettingRequest
Derived from parent class: ModifySettingRequest
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| ResourceUri |
string | 2.0 | |
| RequestType |
ModifyRequestType | 2.0 | |
| ResourceType |
NamespaceResourceType | 2.0 | |
| Settings |
Any | 2.0 |
ModifyNamespaceSettingResponse
Find out if Modify can return with a response?
Derived from parent class: Response
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| Success |
bool | 2.0 | |
| Error |
string | 2.0 | |
| ErrorCode |
uint32 | 2.0 | |
| CompartmentId |
uint32 | 2.0 |
ModifyNetworkSettingRequest
Derived from parent class: ModifySettingRequest
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| ResourceUri |
string | 2.0 | |
| RequestType |
ModifyRequestType | 2.0 | |
| ResourceType |
NetworkResourceType | 2.0 | |
| Settings |
Any | 2.0 |
ModifySettingRequest
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| ResourceUri |
string | 2.0 | |
| RequestType |
ModifyRequestType | 2.0 |
ModifySettingResponse
Derived from parent class: Response
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| Success |
bool | 2.0 | |
| Error |
string | 2.0 | |
| ErrorCode |
uint32 | 2.0 | |
| Data |
Any | 2.0 |
NamespaceContainerRequest
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| ContainerId |
string | 2.0 |
NamespaceEndpointRequest
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| EndpointId |
Guid | 2.0 |
NamespaceResource
Referenced by: HostComputeNamespace
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| Type |
NamespaceResourceType | 2.0 | |
| Data |
Any | 2.0 |
NamespaceResource_2
Referenced by: GuestNamespace
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| EndpointId |
Guid | 2.0 | |
| ContainerId |
Guid | 2.0 |
NamespaceResourceContainer
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| Id |
string | 2.0 |
NamespaceResourceEndpoint
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| Id |
string | 2.0 |
Neighbor
Derived from parent class: InterfaceNotificationMessage
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| MessageNumber |
uint64 | 2.0 | |
| Family |
uint16 | 2.0 | |
| Address |
string | 2.5 | |
| InterfaceLuid |
uint64 | 2.5 | |
| InterfaceIndex |
uint32 | 2.5 | |
| PhysicalAddress |
string | 2.5 | |
| PhysicalAddressLength |
uint64 | 2.5 | |
| State |
uint8 | 2.5 | |
| IsRouter |
bool | 2.5 | |
| IsUnreachable |
bool | 2.5 | |
| Flags |
uint8 | 2.5 | |
| LastReachable |
uint64 | 2.5 | |
| LastUnreachable |
uint64 | 2.5 |
NetAdapterNameNetworkPolicySetting
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| NetworkAdapterName |
string | 2.0 |
NetworkAclPolicySetting
Derived from parent class: FiveTuple; CommonAclPolicySetting
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| Protocols |
string | 2.5 | |
| LocalAddresses |
string | 2.5 | |
| RemoteAddresses |
string | 2.5 | |
| LocalPorts |
string | 2.5 | |
| RemotePorts |
string | 2.5 | |
| Priority |
uint16 | 2.5 | |
| Id |
string | 2.0 | |
| Action |
ActionType | 2.0 | |
| Direction |
DirectionType | 2.0 | |
| RuleType |
RuleType | 2.0 |
NetworkAdditionalParams
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| ICSFlags |
uint16 | 2.0 |
NetworkInterface
Referenced by: GuestEndpointState
Derived from parent class: InterfaceNotificationMessage
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| MessageNumber |
uint64 | 2.0 | |
| Family |
uint16 | 2.0 | |
| AdvertisingEnabled |
bool | 2.0 | |
| ForwardingEnabled |
bool | 2.0 | |
| WeakHostSend |
bool | 2.0 | |
| WeakHostReceive |
bool | 2.0 | |
| UseAutomaticMetric |
bool | 2.0 | |
| UseNeighborUnreachabilityDetection |
bool | 2.0 | |
| ManagedAddressConfigurationSupported |
bool | 2.0 | |
| OtherStatefulConfigurationSupported |
bool | 2.0 | |
| AdvertiseDefaultRoute |
bool | 2.0 | |
| RouterDiscoveryBehavior |
uint8 | 2.0 | |
| DadTransmits |
uint32 | 2.0 | DupAddrDetectTransmits in RFC 2462. |
| BaseReachableTime |
uint32 | 2.0 | |
| RetransmitTime |
uint32 | 2.0 | |
| PathMtuDiscoveryTimeout |
uint32 | 2.0 | Path MTU discovery timeout (in ms). |
| LinkLocalAddressBehavior |
uint8 | 2.0 | |
| LinkLocalAddressTimeout |
uint32 | 2.0 | In ms. |
| ZoneIndices |
<uint32> array | 2.0 | Zone part of a SCOPE_ID. |
| SitePrefixLength |
uint32 | 2.0 | |
| Metric |
uint32 | 2.0 | |
| NlMtu |
uint32 | 2.0 | |
| Connected |
bool | 2.0 | |
| SupportsWakeUpPatterns |
bool | 2.0 | |
| SupportsNeighborDiscovery |
bool | 2.0 | |
| SupportsRouterDiscovery |
bool | 2.0 | |
| ReachableTime |
uint32 | 2.0 | |
| TransmitOffload |
uint8 | 2.0 | |
| ReceiveOffload |
uint8 | 2.0 | |
| DisableDefaultRoutes |
bool | 2.0 |
NetworkPolicy
Referenced by: HostComputeNetwork; PolicyNetworkRequest
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| Type |
NetworkPolicyType | 2.0 | |
| Settings |
Any | 2.0 |
NotificationBase
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| ID |
Guid | 2.0 | |
| Flags |
uint32 | 2.0 | |
| Data |
Any | 2.2 |
OutboundNatPolicySetting
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| VirtualIP |
string | 2.0 | |
| Destinations |
<string> array | 2.0 | |
| Exceptions |
<string> array | 2.0 | |
| Flags |
NatFlags | 2.0 |
PolicyEndpointRequest
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| Policies |
<EndpointPolicy> array | 2.0 |
PolicyNetworkRequest
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| Policies |
<NetworkPolicy> array | 2.0 |
PortMappingPolicySetting
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| Protocol |
ProtocolType | 2.0 | |
| InternalPort |
uint16 | 2.0 | |
| ExternalPort |
uint16 | 2.0 | |
| VIP |
string | 2.0 | |
| Flags |
NatFlags | 2.0 |
PortnameEndpointPolicySetting
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| Name |
string | 2.0 |
PrioritizedAuthenticationMethod
Referenced by: EncryptionPolicySetting
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| Type |
AuthenticationType | 2.1 | |
| Settings |
Any | 2.1 |
ProviderAddressEndpointPolicySetting
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| ProviderAddress |
string | 2.0 |
ProviderAddressNetworkPolicySetting
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| ProviderAddress |
string | 2.0 |
ProxyExceptions
Referenced by: L4WfpProxyPolicySetting
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| IpAddressExceptions |
<string> array | 2.14 | |
| PortExceptions |
<string> array | 2.14 |
QosPolicySetting
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| MaximumOutgoingBandwidthInBytes |
uint64 | 2.0 |
RegistryKey
Derived from parent class: InterfaceNotificationMessage
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| MessageNumber |
uint64 | 2.0 | |
| Family |
uint16 | 2.0 | |
| RegKeys |
<RegKey> array | 2.1 | |
| Keyword |
string | 2.5 | |
| AdapterCLSID |
string | 2.5 |
RegKey
Referenced by: RegistryKey
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| Path |
string | 2.1 | |
| Key |
string | 2.1 | |
| Type |
uint16 | 2.1 | |
| Value |
ByteArray | 2.1 |
RemoteSubnetRoutePolicySetting
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| DestinationPrefix |
string | 2.0 | |
| IsolationId |
uint32 | 2.0 | |
| ProviderAddress |
string | 2.0 | |
| DistributedRouterMacAddress |
string | 2.0 |
Response
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| Success |
bool | 2.0 | |
| Error |
string | 2.0 | |
| ErrorCode |
uint32 | 2.0 |
Route
Referenced by: HostComputeEndpoint; Subnet
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| NextHop |
string | 2.0 | |
| DestinationPrefix |
string | 2.0 | |
| Metric |
uint16 | 2.0 |
Route_2
Referenced by: GuestEndpointState
Derived from parent class: InterfaceNotificationMessage
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| MessageNumber |
uint64 | 2.0 | |
| Family |
uint16 | 2.0 | |
| NextHop |
string | 2.0 | |
| DestinationPrefix |
string | 2.0 | |
| SitePrefixLength |
uint8 | 2.0 | |
| ValidLifetime |
uint32 | 2.0 | |
| PreferredLifetime |
uint32 | 2.0 | |
| Metric |
uint32 | 2.0 | |
| Protocol |
uint8 | 2.0 | |
| Loopback |
bool | 2.0 | |
| AutoconfigureAddress |
bool | 2.0 | |
| Publish |
bool | 2.0 | |
| Immortal |
bool | 2.0 |
RpcConnectionInformation
Referenced by: GuestNetworkService
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| NetworkAddress |
string | 2.11 | |
| EndpointAddress |
string | 2.11 | |
| EndpointType |
RpcEndpointType | 2.13 | |
| ObjectUuid |
Guid | 2.13 |
SDNRoutePolicySetting
Referenced by: HostComputeRoute
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| DestinationPrefix |
string | 2.0 | |
| NextHop |
string | 2.0 | |
| NeedEncap |
bool | 2.0 | |
| AutomaticEndpointMonitor |
bool | 2.0 |
SetPolicySetting
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| Id |
string | 2.0 | |
| Name |
string | 2.0 | |
| PolicyType |
SetPolicyTypes | 2.0 | |
| Values |
string | 2.0 |
SourceMacAddressNetworkPolicySetting
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| SourceMacAddress |
string | 2.0 |
Subnet
Referenced by: Ipam; SubnetNetworkRequest
Derived from parent class: Base
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| ID |
Guid | 2.0 | |
| Owner |
string | 2.0 | |
| Name |
string | 2.0 | |
| Version |
uint64 | 2.0 | |
| AdditionalParams |
Any | 2.0 | |
| Health |
Health | 2.0 | |
| SchemaVersion |
Version | 2.0 | Schema version should be present in all objects |
| Telemetry |
Telemetry | 2.0 | |
| State |
uint16 | 2.0 | |
| IpAddressPrefix |
string | 2.0 | |
| Policies |
<SubnetPolicy> array | 2.0 | |
| Routes |
<Route> array | 2.0 | |
| IpSubnets |
<IpSubnet> array | 2.3 | |
| Flags |
SubnetFlags | 2.7 |
SubnetNetworkRequest
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| Subnets |
<Subnet> array | 2.6 |
SubnetPolicy
Referenced by: Subnet
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| Type |
SubnetPolicyType | 2.0 | |
| Settings |
Any | 2.0 |
Telemetry
Referenced by: Base
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| Data |
Any | 2.0 |
TierAclPolicySetting
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| Name |
string | 2.10 | |
| Direction |
DirectionType | 2.10 | |
| Order |
uint16 | 2.10 | |
| TierAclRules |
<TierAclRule> array | 2.10 |
TierAclRule
Referenced by: TierAclPolicySetting
Derived from parent class: FiveTuple
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| Protocols |
string | 2.5 | |
| LocalAddresses |
string | 2.5 | |
| RemoteAddresses |
string | 2.5 | |
| LocalPorts |
string | 2.5 | |
| RemotePorts |
string | 2.5 | |
| Priority |
uint16 | 2.5 | |
| Id |
string | 2.10 | |
| TierAclRuleAction |
ActionType | 2.10 |
Version
Referenced by: Base; HostComputeQuery
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| Major |
uint32 | 2.0 | |
| Minor |
uint32 | 2.0 |
VlanPolicySetting
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| IsolationId |
uint32 | 2.0 |
VmEndpointRequest
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| PortId |
Guid | 2.0 | |
| VirtualNicName |
string | 2.0 | |
| VirtualMachineId |
Guid | 2.0 |
VsidPolicySetting
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| IsolationId |
uint32 | 2.0 |
VSwitchExtensionNetworkPolicySetting
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| ExtensionID |
Guid | 2.0 | |
| Enable |
bool | 2.0 |
VxlanPortPolicySetting
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| Port |
uint16 | 2.0 |
Xlat
Referenced by: GuestEndpointState
Derived from parent class: InterfaceNotificationMessage
| Field | Type | NewInVersion | Description |
|---|---|---|---|
| MessageNumber |
uint64 | 2.0 | |
| Family |
uint16 | 2.0 | |
| SyntheticIPv4Address |
string | 2.5 | |
| FallbackIPv4Address |
string | 2.5 | |
| LocalPrefix |
string | 2.5 | |
| LocalPrefixLength |
uint8 | 2.5 | |
| RemotePrefix |
string | 2.5 | |
| RemotePrefixLength |
uint8 | 2.5 |
JSON type
The table shows the mapping from type name for field of classes to JSON type, its format and pattern. See details in Swagger IO spec
| Name | JSON Type | Format | Pattern |
|---|---|---|---|
| Any | object | ||
| bool | boolean | ||
| ByteArray | string | byte | |
| Guid | string | ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$ | |
| string | string | ||
| uint16 | integer | uint16 | |
| uint32 | integer | uint32 | |
| uint64 | integer | uint64 | |
| uint8 | integer | uint8 |
Schema Version Map
| Schema Version | Release Version |
|---|---|
| 2.0 | Windows 10, version 1809 (10.0.17763.0) |
| 2.6 | Windows 10, version 2004 (10.0.19041.0) |
| 2.11 | Windows Server 2022 (10.0.20348.0) |
| 2.14 | Windows 11, version 2004 (10.0.2200.0) |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for