models Package
Classes
| AddressSpace |
AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. |
| ApplicationGateway |
Application gateway resource. Variables are only populated by the server, and will be ignored when sending a request. |
| ApplicationGatewayAuthenticationCertificate |
Authentication certificates of an application gateway. |
| ApplicationGatewayBackendAddress |
Backend address of an application gateway. |
| ApplicationGatewayBackendAddressPool |
Backend Address Pool of an application gateway. |
| ApplicationGatewayBackendHealth |
List of ApplicationGatewayBackendHealthPool resources. |
| ApplicationGatewayBackendHealthHttpSettings |
Application gateway BackendHealthHttp settings. |
| ApplicationGatewayBackendHealthPool |
Application gateway BackendHealth pool. |
| ApplicationGatewayBackendHealthServer |
Application gateway backendhealth http settings. |
| ApplicationGatewayBackendHttpSettings |
Backend address pool settings of an application gateway. |
| ApplicationGatewayConnectionDraining |
Connection draining allows open connections to a backend server to be active for a specified time after the backend server got removed from the configuration. All required parameters must be populated in order to send to Azure. |
| ApplicationGatewayFrontendIPConfiguration |
Frontend IP configuration of an application gateway. |
| ApplicationGatewayFrontendPort |
Frontend port of an application gateway. |
| ApplicationGatewayHttpListener |
Http listener of an application gateway. |
| ApplicationGatewayIPConfiguration |
IP configuration of an application gateway. Currently 1 public and 1 private IP configuration is allowed. |
| ApplicationGatewayListResult |
Response for ListApplicationGateways API service call. |
| ApplicationGatewayPathRule |
Path rule of URL path map of an application gateway. |
| ApplicationGatewayProbe |
Probe of the application gateway. |
| ApplicationGatewayRequestRoutingRule |
Request routing rule of an application gateway. |
| ApplicationGatewaySku |
SKU of an application gateway. |
| ApplicationGatewaySslCertificate |
SSL certificates of an application gateway. |
| ApplicationGatewaySslPolicy |
Application gateway SSL policy. |
| ApplicationGatewayUrlPathMap |
UrlPathMaps give a url path to the backend mapping information for PathBasedRouting. |
| ApplicationGatewayWebApplicationFirewallConfiguration |
Application gateway web application firewall configuration. All required parameters must be populated in order to send to Azure. |
| AuthorizationListResult |
Response for ListAuthorizations API service call retrieves all authorizations that belongs to an ExpressRouteCircuit. |
| AzureAsyncOperationResult |
The response body contains the status of the specified asynchronous operation, indicating whether it has succeeded, is in progress, or has failed. Note that this status is distinct from the HTTP status code returned for the Get Operation Status operation itself. If the asynchronous operation succeeded, the response body includes the HTTP status code for the successful request. If the asynchronous operation failed, the response body includes the HTTP status code for the failed request and error information regarding the failure. |
| BGPCommunity |
Contains bgp community information offered in Service Community resources. |
| BackendAddressPool |
Pool of backend IP addresses. Variables are only populated by the server, and will be ignored when sending a request. |
| BgpPeerStatus |
BgpPeerStatus. Variables are only populated by the server, and will be ignored when sending a request. |
| BgpPeerStatusListResult |
Response for list BGP peer status API service call. |
| BgpServiceCommunity |
Service Community Properties. Variables are only populated by the server, and will be ignored when sending a request. |
| BgpServiceCommunityListResult |
Response for the ListServiceCommunity API service call. |
| BgpSettings |
BgpSettings. |
| ConnectionResetSharedKey |
ConnectionResetSharedKey. All required parameters must be populated in order to send to Azure. |
| ConnectionSharedKey |
Response for GetConnectionSharedKey API service call. All required parameters must be populated in order to send to Azure. |
| DhcpOptions |
DhcpOptions contains an array of DNS servers available to VMs deployed in the virtual network. Standard DHCP option for a subnet overrides VNET DHCP options. |
| DnsNameAvailabilityResult |
Response for the CheckDnsNameAvailability API service call. |
| EffectiveNetworkSecurityGroup |
Effective network security group. |
| EffectiveNetworkSecurityGroupAssociation |
The effective network security group association. |
| EffectiveNetworkSecurityGroupListResult |
Response for list effective network security groups API service call. |
| EffectiveNetworkSecurityRule |
Effective network security rules. |
| EffectiveRoute |
Effective Route. |
| EffectiveRouteListResult |
Response for list effective route API service call. |
| Error |
Error. |
| ErrorDetails |
ErrorDetails. |
| ExpressRouteCircuit |
ExpressRouteCircuit resource. Variables are only populated by the server, and will be ignored when sending a request. |
| ExpressRouteCircuitArpTable |
The ARP table associated with the ExpressRouteCircuit. |
| ExpressRouteCircuitAuthorization |
Authorization in an ExpressRouteCircuit resource. Variables are only populated by the server, and will be ignored when sending a request. |
| ExpressRouteCircuitListResult |
Response for ListExpressRouteCircuit API service call. |
| ExpressRouteCircuitPeering |
Peering in an ExpressRouteCircuit resource. Variables are only populated by the server, and will be ignored when sending a request. |
| ExpressRouteCircuitPeeringConfig |
Specifies the peering configuration. |
| ExpressRouteCircuitPeeringListResult |
Response for ListPeering API service call retrieves all peerings that belong to an ExpressRouteCircuit. |
| ExpressRouteCircuitRoutesTable |
The routes table associated with the ExpressRouteCircuit. |
| ExpressRouteCircuitRoutesTableSummary |
The routes table associated with the ExpressRouteCircuit. |
| ExpressRouteCircuitServiceProviderProperties |
Contains ServiceProviderProperties in an ExpressRouteCircuit. |
| ExpressRouteCircuitSku |
Contains SKU in an ExpressRouteCircuit. |
| ExpressRouteCircuitStats |
Contains stats associated with the peering. |
| ExpressRouteCircuitsArpTableListResult |
Response for ListArpTable associated with the Express Route Circuits API. |
| ExpressRouteCircuitsRoutesTableListResult |
Response for ListRoutesTable associated with the Express Route Circuits API. |
| ExpressRouteCircuitsRoutesTableSummaryListResult |
Response for ListRoutesTable associated with the Express Route Circuits API. |
| ExpressRouteServiceProvider |
A ExpressRouteResourceProvider object. Variables are only populated by the server, and will be ignored when sending a request. |
| ExpressRouteServiceProviderBandwidthsOffered |
Contains bandwidths offered in ExpressRouteServiceProvider resources. |
| ExpressRouteServiceProviderListResult |
Response for the ListExpressRouteServiceProvider API service call. |
| FlowLogInformation |
Information on the configuration of flow log. All required parameters must be populated in order to send to Azure. |
| FlowLogStatusParameters |
Parameters that define a resource to query flow log status. All required parameters must be populated in order to send to Azure. |
| FrontendIPConfiguration |
Frontend IP address of the load balancer. Variables are only populated by the server, and will be ignored when sending a request. |
| GatewayRoute |
GatewayRoute. Variables are only populated by the server, and will be ignored when sending a request. |
| GatewayRouteListResult |
List of virtual network gateway routes. |
| IPAddressAvailabilityResult |
Response for CheckIPAddressAvailability API service call. |
| IPConfiguration |
IPConfiguration. |
| InboundNatPool |
Inbound NAT pool of the load balancer. |
| InboundNatRule |
Inbound NAT rule of the load balancer. Variables are only populated by the server, and will be ignored when sending a request. |
| LoadBalancer |
LoadBalancer resource. Variables are only populated by the server, and will be ignored when sending a request. |
| LoadBalancerListResult |
Response for ListLoadBalancers API service call. |
| LoadBalancingRule |
A load balancing rule for a load balancer. |
| LocalNetworkGateway |
A common class for general resource information. Variables are only populated by the server, and will be ignored when sending a request. |
| LocalNetworkGatewayListResult |
Response for ListLocalNetworkGateways API service call. |
| NetworkInterface |
A network interface in a resource group. Variables are only populated by the server, and will be ignored when sending a request. |
| NetworkInterfaceAssociation |
Network interface and its custom security rules. Variables are only populated by the server, and will be ignored when sending a request. |
| NetworkInterfaceDnsSettings |
DNS settings of a network interface. |
| NetworkInterfaceIPConfiguration |
IPConfiguration in a network interface. |
| NetworkInterfaceListResult |
Response for the ListNetworkInterface API service call. |
| NetworkSecurityGroup |
NetworkSecurityGroup resource. Variables are only populated by the server, and will be ignored when sending a request. |
| NetworkSecurityGroupListResult |
Response for ListNetworkSecurityGroups API service call. |
| NetworkWatcher |
Network watcher in a resource group. Variables are only populated by the server, and will be ignored when sending a request. |
| NetworkWatcherListResult |
List of network watcher resources. |
| NextHopParameters |
Parameters that define the source and destination endpoint. All required parameters must be populated in order to send to Azure. |
| NextHopResult |
The information about next hop from the specified VM. |
| OutboundNatRule |
Outbound NAT pool of the load balancer. |
| PacketCapture |
Parameters that define the create packet capture operation. All required parameters must be populated in order to send to Azure. |
| PacketCaptureFilter |
Filter that is applied to packet capture request. Multiple filters can be applied. |
| PacketCaptureListResult |
List of packet capture sessions. |
| PacketCaptureParameters |
Parameters that define the create packet capture operation. All required parameters must be populated in order to send to Azure. |
| PacketCaptureQueryStatusResult |
Status of packet capture session. |
| PacketCaptureResult |
Information about packet capture session. Variables are only populated by the server, and will be ignored when sending a request. |
| PacketCaptureResultProperties |
Describes the properties of a packet capture session. All required parameters must be populated in order to send to Azure. |
| PacketCaptureStorageLocation |
Describes the storage location for a packet capture session. |
| PatchRouteFilter |
Route Filter Resource. Variables are only populated by the server, and will be ignored when sending a request. |
| PatchRouteFilterRule |
Route Filter Rule Resource. Variables are only populated by the server, and will be ignored when sending a request. |
| Probe |
A load balancer probe. Variables are only populated by the server, and will be ignored when sending a request. |
| PublicIPAddress |
Public IP address resource. Variables are only populated by the server, and will be ignored when sending a request. |
| PublicIPAddressDnsSettings |
Contains FQDN of the DNS record associated with the public IP address. |
| PublicIPAddressListResult |
Response for ListPublicIpAddresses API service call. |
| QueryTroubleshootingParameters |
Parameters that define the resource to query the troubleshooting result. All required parameters must be populated in order to send to Azure. |
| Resource |
Resource. Variables are only populated by the server, and will be ignored when sending a request. |
| ResourceNavigationLink |
ResourceNavigationLink resource. Variables are only populated by the server, and will be ignored when sending a request. |
| RetentionPolicyParameters |
Parameters that define the retention policy for flow log. |
| Route |
Route resource. |
| RouteFilter |
Route Filter Resource. Variables are only populated by the server, and will be ignored when sending a request. |
| RouteFilterListResult |
Response for the ListRouteFilters API service call. |
| RouteFilterRule |
Route Filter Rule Resource. Variables are only populated by the server, and will be ignored when sending a request. |
| RouteFilterRuleListResult |
Response for the ListRouteFilterRules API service call. |
| RouteListResult |
Response for the ListRoute API service call. |
| RouteTable |
Route table resource. Variables are only populated by the server, and will be ignored when sending a request. |
| RouteTableListResult |
Response for the ListRouteTable API service call. |
| SecurityGroupNetworkInterface |
Network interface and all its associated security rules. |
| SecurityGroupViewParameters |
Parameters that define the VM to check security groups for. All required parameters must be populated in order to send to Azure. |
| SecurityGroupViewResult |
The information about security rules applied to the specified VM. |
| SecurityRule |
Network security rule. |
| SecurityRuleAssociations |
All security rules associated with the network interface. |
| SecurityRuleListResult |
Response for ListSecurityRule API service call. Retrieves all security rules that belongs to a network security group. |
| SubResource |
SubResource. |
| Subnet |
Subnet in a virtual network resource. Variables are only populated by the server, and will be ignored when sending a request. |
| SubnetAssociation |
Network interface and its custom security rules. Variables are only populated by the server, and will be ignored when sending a request. |
| SubnetListResult |
Response for ListSubnets API service callRetrieves all subnet that belongs to a virtual network. |
| Topology |
Topology of the specified resource group. Variables are only populated by the server, and will be ignored when sending a request. |
| TopologyAssociation |
Resources that have an association with the parent resource. |
| TopologyParameters |
Parameters that define the representation of topology. All required parameters must be populated in order to send to Azure. |
| TopologyResource |
The network resource topology information for the given resource group. |
| TroubleshootingDetails |
Information gained from troubleshooting of specified resource. |
| TroubleshootingParameters |
Parameters that define the resource to troubleshoot. All required parameters must be populated in order to send to Azure. |
| TroubleshootingRecommendedActions |
Recommended actions based on discovered issues. |
| TroubleshootingResult |
Troubleshooting information gained from specified resource. |
| TunnelConnectionHealth |
VirtualNetworkGatewayConnection properties. Variables are only populated by the server, and will be ignored when sending a request. |
| Usage |
Describes network resource usage. All required parameters must be populated in order to send to Azure. |
| UsageName |
The usage names. |
| UsagesListResult |
The list usages operation response. |
| VerificationIPFlowParameters |
Parameters that define the IP flow to be verified. All required parameters must be populated in order to send to Azure. |
| VerificationIPFlowResult |
Results of IP flow verification on the target resource. |
| VirtualNetwork |
Virtual Network resource. Variables are only populated by the server, and will be ignored when sending a request. |
| VirtualNetworkGateway |
A common class for general resource information. Variables are only populated by the server, and will be ignored when sending a request. |
| VirtualNetworkGatewayConnection |
A common class for general resource information. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
| VirtualNetworkGatewayConnectionListResult |
Response for the ListVirtualNetworkGatewayConnections API service call. |
| VirtualNetworkGatewayIPConfiguration |
IP configuration for virtual network gateway. Variables are only populated by the server, and will be ignored when sending a request. |
| VirtualNetworkGatewayListResult |
Response for the ListVirtualNetworkGateways API service call. |
| VirtualNetworkGatewaySku |
VirtualNetworkGatewaySku details. |
| VirtualNetworkListResult |
Response for the ListVirtualNetworks API service call. |
| VirtualNetworkPeering |
Peerings in a virtual network resource. |
| VirtualNetworkPeeringListResult |
Response for ListSubnets API service call. Retrieves all subnets that belong to a virtual network. |
| VpnClientConfiguration |
VpnClientConfiguration for P2S client. |
| VpnClientParameters |
VpnClientParameters. All required parameters must be populated in order to send to Azure. |
| VpnClientRevokedCertificate |
VPN client revoked certificate of virtual network gateway. Variables are only populated by the server, and will be ignored when sending a request. |
| VpnClientRootCertificate |
VPN client root certificate of virtual network gateway. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure. |
Enums
| Access |
Indicates whether the traffic is allowed or denied. |
| ApplicationGatewayBackendHealthServerHealth |
Health of backend server. Possible values are: 'Unknown', 'Up', 'Down', and 'Partial'. |
| ApplicationGatewayCookieBasedAffinity |
Cookie based affinity. Possible values are: 'Enabled' and 'Disabled'. |
| ApplicationGatewayFirewallMode |
Web application firewall mode. Possible values are: 'Detection' and 'Prevention'. |
| ApplicationGatewayOperationalState |
Operational state of the application gateway resource. Possible values are: 'Stopped', 'Started', 'Running', and 'Stopping'. |
| ApplicationGatewayProtocol |
Protocol. Possible values are: 'Http' and 'Https'. |
| ApplicationGatewayRequestRoutingRuleType |
Rule type. Possible values are: 'Basic' and 'PathBasedRouting'. |
| ApplicationGatewaySkuName |
Name of an application gateway SKU. Possible values are: 'Standard_Small', 'Standard_Medium', 'Standard_Large', 'WAF_Medium', and 'WAF_Large'. |
| ApplicationGatewaySslProtocol |
An enumeration. |
| ApplicationGatewayTier |
Tier of an application gateway. Possible values are: 'Standard' and 'WAF'. |
| AssociationType |
The association type of the child resource to the parent resource. |
| AuthorizationUseStatus |
AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'. |
| BgpPeerState |
The BGP peer state |
| Direction |
The direction of the packet represented as a 5-tuple. |
| EffectiveRouteSource |
Who created the route. Possible values are: 'Unknown', 'User', 'VirtualNetworkGateway', and 'Default'. |
| EffectiveRouteState |
The value of effective route. Possible values are: 'Active' and 'Invalid'. |
| ExpressRouteCircuitPeeringAdvertisedPublicPrefixState |
AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'. |
| ExpressRouteCircuitPeeringState |
The state of peering. Possible values are: 'Disabled' and 'Enabled' |
| ExpressRouteCircuitPeeringType |
The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'. |
| ExpressRouteCircuitSkuFamily |
The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'. |
| ExpressRouteCircuitSkuTier |
The tier of the SKU. Possible values are 'Standard' and 'Premium'. |
| IPAllocationMethod |
PrivateIP allocation method. Possible values are: 'Static' and 'Dynamic'. |
| IPVersion |
Available from Api-Version 2016-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. |
| LoadDistribution |
The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'. |
| NetworkOperationStatus |
Status of the Azure async operation. Possible values are: 'InProgress', 'Succeeded', and 'Failed'. |
| NextHopType |
Next hop type. |
| PcError |
An enumeration. |
| PcProtocol |
Protocol to be filtered on. |
| PcStatus |
The status of the packet capture session. |
| ProbeProtocol |
The protocol of the end point. Possible values are: 'Http' or 'Tcp'. If 'Tcp' is specified, a received ACK is required for the probe to be successful. If 'Http' is specified, a 200 OK response from the specifies URI is required for the probe to be successful. |
| ProcessorArchitecture |
VPN client Processor Architecture. Possible values are: 'AMD64' and 'X86'. |
| Protocol |
Protocol to be verified on. |
| ProvisioningState |
The provisioning state of the resource. |
| RouteFilterRuleType |
The rule type of the rule. Valid value is: 'Community' |
| RouteNextHopType |
The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'. |
| SecurityRuleAccess |
Whether network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'. |
| SecurityRuleDirection |
The direction of the rule. Possible values are: 'Inbound and Outbound'. |
| SecurityRuleProtocol |
The network protocol this rule applies to. Possible values are: 'Tcp', 'Udp', and '*'. |
| ServiceProviderProvisioningState |
The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'. |
| TransportProtocol |
The transport protocol for the external endpoint. Possible values are 'Udp' or 'Tcp' |
| UsageUnit |
An enum describing the unit of measurement. |
| VirtualNetworkGatewayConnectionStatus |
Virtual network Gateway connection status |
| VirtualNetworkGatewayConnectionType |
Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient. |
| VirtualNetworkGatewaySkuName |
Gateway SKU name. Possible values are: 'Basic', 'HighPerformance','Standard', and 'UltraPerformance'. |
| VirtualNetworkGatewaySkuTier |
Gateway SKU tier. Possible values are: 'Basic', 'HighPerformance','Standard', and 'UltraPerformance'. |
| VirtualNetworkGatewayType |
The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'. |
| VirtualNetworkPeeringState |
The status of the virtual network peering. Possible values are 'Initiated', 'Connected', and 'Disconnected'. |
| VpnType |
The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'. |
Feedback
Submit and view feedback for