Package-level declarations

Types

data class AccessControlListConditionPropertiesResponse(val action: String, val annotation: String? = null, val destinationAddress: String, val destinationPort: String, val protocol: Int, val sequenceNumber: Int, val sourceAddress: String, val sourcePort: String)

Access Control List condition model.

Link copied to clipboard

IP Community Properties.

IP Extended Community Properties.

Link copied to clipboard
data class AggregateRouteConfigurationResponse(val ipv4Routes: List<AggregateRouteResponse>? = null, val ipv6Routes: List<AggregateRouteResponse>? = null)

List of IPv4 and IPv6 route configurations.

Link copied to clipboard
data class AggregateRouteResponse(val prefix: String? = null)

Aggregate Route properties.

Link copied to clipboard
data class BfdConfigurationResponse(val administrativeState: String, val interval: Int, val multiplier: Int)

BFD configuration properties

Link copied to clipboard
data class BgpConfigurationResponse(val allowAS: Int? = null, val allowASOverride: String? = null, val annotation: String? = null, val bfdConfiguration: BfdConfigurationResponse? = null, val defaultRouteOriginate: String? = null, val fabricASN: Int, val ipv4ListenRangePrefixes: List<String>? = null, val ipv4NeighborAddress: List<NeighborAddressResponse>? = null, val ipv6ListenRangePrefixes: List<String>? = null, val ipv6NeighborAddress: List<NeighborAddressResponse>? = null, val peerASN: Int)

BGP configuration properties

Link copied to clipboard
data class CommonDynamicMatchConfigurationResponse(val ipGroups: List<IpGroupPropertiesResponse>? = null, val portGroups: List<PortGroupPropertiesResponse>? = null, val vlanGroups: List<VlanGroupPropertiesResponse>? = null)

Dynamic match configuration object.

Link copied to clipboard
data class ConnectedSubnetResponse(val annotation: String? = null, val prefix: String? = null)

Connected Subnet properties.

Link copied to clipboard
data class ErrorAdditionalInfoResponse(val info: Any, val type: String)

The resource management error additional info.

Link copied to clipboard
data class ErrorDetailResponse(val additionalInfo: List<ErrorAdditionalInfoResponse>, val code: String, val details: List<ErrorDetailResponse>, val message: String, val target: String)

The error detail.

data class ExpressRouteConnectionInformationResponse(val expressRouteAuthorizationKey: String, val expressRouteCircuitId: String)

The ExpressRoute circuit ID and the Auth Key are required for you to successfully deploy NFC service.

data class ExternalNetworkPropertiesResponseOptionAProperties(val bfdConfiguration: BfdConfigurationResponse? = null, val fabricASN: Int, val mtu: Int? = null, val peerASN: Int, val primaryIpv4Prefix: String? = null, val primaryIpv6Prefix: String? = null, val secondaryIpv4Prefix: String? = null, val secondaryIpv6Prefix: String? = null, val vlanId: Int)

option A properties object

Link copied to clipboard
data class FabricBfdConfigurationResponse(val interval: Int, val multiplier: Int)

BFD Configuration properties.

Link copied to clipboard
data class FabricOptionBPropertiesResponse(val exportRouteTargets: List<String>, val importRouteTargets: List<String>)

Option B configuration.

Link copied to clipboard
data class GetAccessControlListResult(val addressFamily: String, val annotation: String? = null, val conditions: List<AccessControlListConditionPropertiesResponse>, val id: String, val location: String, val name: String, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

The AccessControlList resource definition.

Link copied to clipboard
data class GetExternalNetworkResult(val administrativeState: String, val annotation: String? = null, val disabledOnResources: List<String>, val exportRoutePolicyId: String? = null, val id: String, val importRoutePolicyId: String? = null, val name: String, val networkToNetworkInterconnectId: String, val optionAProperties: ExternalNetworkPropertiesResponseOptionAProperties? = null, val optionBProperties: OptionBPropertiesResponse? = null, val peeringOption: String, val provisioningState: String, val systemData: SystemDataResponse, val type: String)

Defines the ExternalNetwork item.

Link copied to clipboard
data class GetInternalNetworkResult(val administrativeState: String, val annotation: String? = null, val bfdDisabledOnResources: List<String>, val bfdForStaticRoutesDisabledOnResources: List<String>, val bgpConfiguration: BgpConfigurationResponse? = null, val bgpDisabledOnResources: List<String>, val connectedIPv4Subnets: List<ConnectedSubnetResponse>? = null, val connectedIPv6Subnets: List<ConnectedSubnetResponse>? = null, val disabledOnResources: List<String>, val exportRoutePolicyId: String? = null, val id: String, val importRoutePolicyId: String? = null, val mtu: Int? = null, val name: String, val provisioningState: String, val staticRouteConfiguration: StaticRouteConfigurationResponse? = null, val systemData: SystemDataResponse, val type: String, val vlanId: Int)

Defines the InternalNetwork item.

Link copied to clipboard
data class GetInternetGatewayResult(val annotation: String? = null, val id: String, val internetGatewayRuleId: String? = null, val ipv4Address: String, val location: String, val name: String, val networkFabricControllerId: String, val port: Int, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

The Internet Gateway resource definition.

Link copied to clipboard
data class GetInternetGatewayRuleResult(val annotation: String? = null, val id: String, val internetGatewayIds: List<String>, val location: String, val name: String, val provisioningState: String, val ruleProperties: RulePropertiesResponse, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

The Internet Gateway Rule resource definition.

Link copied to clipboard
data class GetIpCommunityResult(val action: String, val annotation: String? = null, val communityMembers: List<String>, val id: String, val location: String, val name: String, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val wellKnownCommunities: List<String>? = null)

The IpCommunity resource definition.

Link copied to clipboard
data class GetIpExtendedCommunityResult(val action: String, val annotation: String? = null, val id: String, val location: String, val name: String, val provisioningState: String, val routeTargets: List<String>, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

The IpExtendedCommunity resource definition.

Link copied to clipboard
data class GetIpPrefixResult(val annotation: String? = null, val id: String, val ipPrefixRules: List<IpPrefixPropertiesResponseIpPrefixRules>, val location: String, val name: String, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

The IPPrefix resource definition.

Link copied to clipboard
data class GetL2IsolationDomainResult(val administrativeState: String, val annotation: String? = null, val disabledOnResources: List<String>, val id: String, val location: String, val mtu: Int? = null, val name: String, val networkFabricId: String, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val vlanId: Int)

The L2IsolationDomain resource definition.

Link copied to clipboard
data class GetL3IsolationDomainResult(val administrativeState: String, val aggregateRouteConfiguration: AggregateRouteConfigurationResponse? = null, val annotation: String? = null, val connectedSubnetRoutePolicy: L3IsolationDomainPatchPropertiesResponseConnectedSubnetRoutePolicy? = null, val description: String? = null, val disabledOnResources: List<String>, val id: String, val location: String, val name: String, val networkFabricId: String, val optionBDisabledOnResources: List<String>, val provisioningState: String, val redistributeConnectedSubnets: String? = null, val redistributeStaticRoutes: String? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

The L3IsolationDomain resource definition.

Link copied to clipboard
data class GetNeighborGroupResult(val annotation: String? = null, val destination: NeighborGroupDestinationResponse, val id: String, val location: String, val name: String, val networkTapIds: List<String>, val networkTapRuleIds: List<String>, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Defines the Neighbor Group.

Link copied to clipboard
data class GetNetworkDeviceResult(val annotation: String? = null, val hostName: String? = null, val id: String, val location: String, val name: String, val networkDeviceRole: String, val networkDeviceSku: String, val networkRackId: String, val provisioningState: String, val serialNumber: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val version: String)

The NetworkDevice resource definition.

Link copied to clipboard
data class GetNetworkDeviceStatusResult(val operationalStatus: String, val powerCycleState: String, val serialNumber: String)

Get Device status response properties.

Link copied to clipboard
data class GetNetworkFabricControllerResult(val annotation: String? = null, val id: String, val infrastructureExpressRouteConnections: List<ExpressRouteConnectionInformationResponse>? = null, val infrastructureServices: InfrastructureServicesResponse, val ipv4AddressSpace: String? = null, val ipv6AddressSpace: String? = null, val location: String, val managedResourceGroupConfiguration: ManagedResourceGroupConfigurationResponse? = null, val name: String, val networkFabricIds: List<String>, val operationalState: String, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String, val workloadExpressRouteConnections: List<ExpressRouteConnectionInformationResponse>? = null, val workloadManagementNetwork: Boolean, val workloadServices: WorkloadServicesResponse)

The NetworkFabricController resource definition.

Link copied to clipboard
data class GetNetworkFabricResult(val annotation: String? = null, val fabricASN: Int, val id: String, val ipv4Prefix: String? = null, val ipv6Prefix: String? = null, val l2IsolationDomains: List<String>, val l3IsolationDomains: List<String>, val location: String, val managementNetworkConfiguration: ManagementNetworkConfigurationResponse, val name: String, val networkFabricControllerId: String, val networkFabricSku: String, val operationalState: String, val provisioningState: String, val rackCount: Int, val racks: List<String>, val routerId: String, val serverCountPerRack: Int, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val terminalServerConfiguration: TerminalServerConfigurationResponse, val type: String)

The NetworkFabric resource definition.

Link copied to clipboard
data class GetNetworkFabricTopologyResult(val configurationState: String, val error: ErrorDetailResponse? = null, val url: String? = null)

The response of the action validate configuration.

Link copied to clipboard
data class GetNetworkInterfaceResult(val administrativeState: String, val annotation: String? = null, val connectedTo: String, val id: String, val interfaceType: String, val ipv4Address: String, val ipv6Address: String, val name: String, val physicalIdentifier: String, val provisioningState: String, val systemData: SystemDataResponse, val type: String)

Defines the NetworkInterface resource.

Link copied to clipboard
data class GetNetworkInterfaceStatusResult(val administrativeState: String, val connectedTo: String? = null, val operationalStatus: String? = null, val phyStatus: String? = null, val transceiverStatus: String? = null)

Interface running status properties

Link copied to clipboard
data class GetNetworkPacketBrokerResult(val id: String, val location: String, val name: String, val neighborGroupIds: List<String>, val networkDeviceIds: List<String>, val networkFabricId: String, val networkTapIds: List<String>, val provisioningState: String, val sourceInterfaceIds: List<String>, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

The NetworkPacketBroker resource definition.

Link copied to clipboard
data class GetNetworkRackResult(val annotation: String? = null, val id: String, val location: String, val name: String, val networkDevices: List<String>, val networkFabricId: String, val networkRackSku: String, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

The NetworkRack resource definition.

Link copied to clipboard
data class GetNetworkTapResult(val administrativeState: String, val annotation: String? = null, val configurationState: String, val destinations: List<NetworkTapPropertiesResponseDestinations>, val id: String, val location: String, val name: String, val networkPacketBrokerId: String, val pollingType: String? = null, val provisioningState: String, val sourceTapRuleId: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

The Network Tap resource definition.

Link copied to clipboard
data class GetNetworkTapRuleResult(val administrativeState: String, val annotation: String? = null, val configurationState: String, val configurationType: String, val dynamicMatchConfigurations: List<CommonDynamicMatchConfigurationResponse>? = null, val id: String, val lastSyncedTime: String, val location: String, val matchConfigurations: List<NetworkTapRuleMatchConfigurationResponse>? = null, val name: String, val networkTapId: String, val pollingIntervalInSeconds: Int? = null, val provisioningState: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val tapRulesUrl: String? = null, val type: String)

The NetworkTapRule resource definition.

Link copied to clipboard
data class GetNetworkToNetworkInterconnectResult(val administrativeState: String, val id: String, val isManagementType: String, val layer2Configuration: Layer2ConfigurationResponse? = null, val layer3Configuration: Layer3ConfigurationResponse? = null, val name: String, val nniType: String? = null, val provisioningState: String, val systemData: SystemDataResponse, val type: String, val useOptionB: String)

The NetworkToNetworkInterconnect resource definition.

Link copied to clipboard
data class GetRoutePolicyResult(val annotation: String? = null, val id: String, val location: String, val name: String, val provisioningState: String, val statements: List<RoutePolicyStatementPropertiesResponse>, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

The RoutePolicy resource definition.

Link copied to clipboard
data class InfrastructureServicesResponse(val ipv4AddressSpaces: List<String>? = null, val ipv6AddressSpaces: List<String>? = null)

InfrastructureServices IP ranges.

Link copied to clipboard
data class IpCommunityIdListResponse(val ipCommunityIds: List<String>? = null)

IP Community ID list properties.

Link copied to clipboard
data class IpExtendedCommunityIdListResponse(val ipExtendedCommunityIds: List<String>? = null)

IP Extended Community Id list properties.

Link copied to clipboard
data class IpGroupPropertiesResponse(val ipAddressType: String? = null, val ipPrefixes: List<String>? = null, val name: String? = null)

IP Group properties.

Link copied to clipboard
data class IpMatchConditionResponse(val ipGroupNames: List<String>? = null, val ipPrefixValues: List<String>? = null, val prefixType: String? = null, val type: String? = null)

Defines the condition that can be filtered using the selected IPs.

Link copied to clipboard
data class IpPrefixPropertiesResponseIpPrefixRules(val action: String, val condition: String? = null, val networkPrefix: String, val sequenceNumber: Double, val subnetMaskLength: Int? = null)
Link copied to clipboard
data class IsolationDomainPropertiesResponse(val encapsulation: String? = null, val neighborGroupIds: List<String>? = null)

Isolation Domain Properties.

data class L3IsolationDomainPatchPropertiesResponseConnectedSubnetRoutePolicy(val administrativeState: String, val exportRoutePolicyId: String? = null)

Connected Subnet RoutePolicy

Link copied to clipboard
data class Layer2ConfigurationResponse(val interfaces: List<String>, val mtu: Int, val portCount: Int? = null)

layer2Configuration

Link copied to clipboard
data class Layer3ConfigurationResponse(val exportRoutePolicyId: String? = null, val fabricASN: Int, val importRoutePolicyId: String? = null, val peerASN: Int? = null, val primaryIpv4Prefix: String? = null, val primaryIpv6Prefix: String? = null, val secondaryIpv4Prefix: String? = null, val secondaryIpv6Prefix: String? = null, val vlanId: Int? = null)

layer3Configuration

data class ManagedResourceGroupConfigurationResponse(val location: String? = null, val name: String? = null)

Managed Resource Group configuration properties.

Link copied to clipboard
data class ManagementNetworkConfigurationResponse(val infrastructureVpnConfiguration: VpnConfigurationPropertiesResponse, val workloadVpnConfiguration: VpnConfigurationPropertiesResponse)

Configuration to be used to setup the management network.

Link copied to clipboard
data class NeighborAddressResponse(val address: String? = null, val operationalState: String)

Neighbor Address properties.

Link copied to clipboard
data class NeighborGroupDestinationResponse(val ipv4Addresses: List<String>? = null, val ipv6Addresses: List<String>? = null)

An array of destination IPv4 Addresses or IPv6 Addresses.

Link copied to clipboard
data class NetworkTapPropertiesResponseDestinations(val destinationId: String, val destinationTapRuleId: String? = null, val destinationType: String, val isolationDomainProperties: IsolationDomainPropertiesResponse? = null, val name: String)

Destination.

Link copied to clipboard
data class NetworkTapRuleActionResponse(val destinationId: String? = null, val isTimestampEnabled: String? = null, val matchConfigurationName: String? = null, val truncate: String? = null, val type: String? = null)

Action that need to performed.

Link copied to clipboard
data class NetworkTapRuleMatchConditionResponse(val encapsulationType: String? = null, val ipCondition: IpMatchConditionResponse? = null, val portCondition: PortConditionResponse? = null, val protocolTypes: List<String>? = null, val vlanMatchCondition: VlanMatchConditionResponse? = null)

Defines the match condition that is supported to filter the traffic.

Link copied to clipboard
data class NetworkTapRuleMatchConfigurationResponse(val actions: List<NetworkTapRuleActionResponse>? = null, val ipAddressType: String? = null, val matchConditions: List<NetworkTapRuleMatchConditionResponse>? = null, val matchConfigurationName: String? = null, val sequenceNumber: Double? = null)

Defines the match configuration that are supported to filter the traffic.

Link copied to clipboard
data class OptionAPropertiesResponse(val bfdConfiguration: FabricBfdConfigurationResponse? = null, val mtu: Int? = null, val peerASN: Int? = null, val primaryIpv4Prefix: String? = null, val primaryIpv6Prefix: String? = null, val secondaryIpv4Prefix: String? = null, val secondaryIpv6Prefix: String? = null, val vlanId: Int? = null)

Peering optionA properties

Link copied to clipboard
data class OptionBPropertiesResponse(val exportRouteTargets: List<String>? = null, val importRouteTargets: List<String>? = null)

Option B configuration.

Link copied to clipboard
data class PortConditionResponse(val layer4Protocol: String, val portGroupNames: List<String>? = null, val portType: String? = null, val ports: List<String>? = null)

Port condition that needs to be matched.

Link copied to clipboard
data class PortGroupPropertiesResponse(val name: String? = null, val ports: List<String>? = null)

Port Group properties.

Link copied to clipboard
data class RoutePolicyStatementPropertiesResponse(val action: StatementActionPropertiesResponse, val annotation: String? = null, val condition: StatementConditionPropertiesResponse, val sequenceNumber: Double)

Route Policy Statement properties..

Link copied to clipboard
data class RulePropertiesResponse(val action: String, val addressList: List<String>)

Rules for the InternetGateways

Link copied to clipboard
data class StatementActionPropertiesResponse(val actionType: String, val ipCommunityProperties: ActionIpCommunityPropertiesResponse? = null, val ipExtendedCommunityProperties: ActionIpExtendedCommunityPropertiesResponse? = null, val localPreference: Double? = null)

Route policy action properties.

Link copied to clipboard
data class StatementConditionPropertiesResponse(val ipCommunityIds: List<String>? = null, val ipExtendedCommunityIds: List<String>? = null, val ipPrefixId: String? = null)

Route policy statement condition properties.

Link copied to clipboard
data class StaticRouteConfigurationResponse(val bfdConfiguration: BfdConfigurationResponse? = null, val ipv4Routes: List<StaticRoutePropertiesResponse>? = null, val ipv6Routes: List<StaticRoutePropertiesResponse>? = null)

staticRouteConfiguration model.

Link copied to clipboard
data class StaticRoutePropertiesResponse(val nextHop: List<String>, val prefix: String)

Static Route properties.

Link copied to clipboard
data class SystemDataResponse(val createdAt: String? = null, val createdBy: String? = null, val createdByType: String? = null, val lastModifiedAt: String? = null, val lastModifiedBy: String? = null, val lastModifiedByType: String? = null)

Metadata pertaining to creation and last modification of the resource.

Link copied to clipboard
data class TerminalServerConfigurationResponse(val networkDeviceId: String, val password: String, val primaryIpv4Prefix: String, val primaryIpv6Prefix: String? = null, val secondaryIpv4Prefix: String, val secondaryIpv6Prefix: String? = null, val serialNumber: String? = null, val username: String)

Network and credentials configuration currently applied to terminal server.

Link copied to clipboard
data class VlanGroupPropertiesResponse(val name: String? = null, val vlans: List<String>? = null)

Vlan group properties.

Link copied to clipboard
data class VlanMatchConditionResponse(val innerVlans: List<String>? = null, val vlanGroupNames: List<String>? = null, val vlans: List<String>? = null)

The vlan match conditions that need to be matched.

Link copied to clipboard
data class VpnConfigurationPropertiesResponse(val administrativeState: String, val networkToNetworkInterconnectId: String, val optionAProperties: OptionAPropertiesResponse? = null, val optionBProperties: FabricOptionBPropertiesResponse? = null, val peeringOption: String)

Configuration for infrastructure vpn.

Link copied to clipboard
data class WorkloadServicesResponse(val ipv4AddressSpaces: List<String>? = null, val ipv6AddressSpaces: List<String>? = null)

WorkloadServices IP ranges.