Share via


3.1.5.35 Response Content for Errors

If the Network Controller returns an error for any operation, it includes the appropriate HTTP status code and a response body. See the HTTP Status Code Registry definition of specific response codes [RFC7231]. The JSON schema for the response body is given in the appendix, section 6.29.

The following property elements are valid for the response body. 

Element name

Type

Description

error

Read-only

Container for the properties defined following.

error.code

Read-only

A string that is an error identifier. These error identifiers are defined in detail later in this section.

error.message

Read-only

A description of the error. This string is implementation-specific.

error.innerError

Read-only

Optional

A string description of an error that was the initial cause for a subsequent error (for error.code). This string is implementation-specific.

error.target

Read-only

Optional

This string is implementation-specific. It contains extra details about the source of the error.

error.details

Read-only

Optional

An array of structures that describe in more detail any errors that happened while the server was processing a REST method call.

error.details.code

Read-only

The same description applies as for error.code.

error.details.message

Read-only

The same description applies as for error.message.

The following is an example of a complete error response that include headers and JSON body.

   HTTP/1.1 400 Bad Request
   Content-Length: 1552
   Content-Type: application/json; charset=utf-8
   Server: Microsoft-HTTPAPI/2.0
   x-ms-request-id: 3be9ff32-8097-47ad-8961-8de9caad8475
   Date: Thu, 12 Jan 2017 20:11:43 GMT
   Connection: close
   
   {
     "error": {
       "code": "InvalidParameterValue",
       "message": "'2221.1.1.0/24' is not a valid argument for 'addressPrefix' of a subnet.",
       "target": "SubnetAddress",
       "innerError": "Message: '2221.1.1.0/24' is not a valid argument for 'addressPrefix' of a subnet., Target: SubnetAddress, InnerException: null, Exception: Microsoft.Windows.Networking.NetworkController.Framework.Utilities.ParameterInvalidException: '2221.1.1.0/24' is not a valid argument for 'addressPrefix' of a subnet.\r\n   at Microsoft.Windows.Networking.NetworkController.RestApi.Fabric.Fnm.FnmUtility.ParseIpAddressWithPrefix(String addressWithPrefix, IPAddress& ipAddress, UInt32& adressPrefix)\r\n   at Microsoft.Windows.Networking.NetworkController.RestApi.Fabric.Fnm.FnmUtility.ValidateLogicalSubnet(LogicalSubnet newSubnet, LogicalNetwork logicalNetwork)\r\n   at Microsoft.Windows.Networking.NetworkController.RestApi.Fabric.Fnm.FnmUtility.ValidateLogicalNetwork(LogicalNetwork logicalNetwork)\r\n   at Microsoft.Windows.Networking.NetworkController.RestApi.Fabric.Fnm.PutLogicalNetworkOperation.ExecuteInternal(LogicalNetwork logicalNetwork, ITransaction transaction)\r\n   at Microsoft.Windows.Networking.NetworkController.RestApi.Common.Operations.PutResourceDefaultOperation`1.DefaultExecuteTopLevelResource()\r\n   at Microsoft.Windows.Networking.NetworkController.RestApi.Common.Operations.PutResourceDefaultOperation`1.Execute()\r\n   at Microsoft.WindowsAzure.Networking.Nrp.Frontend.Operations.OperationBase`1.Run()"
     }
   }

The following table contains all possible error codes returned by servers, along with a description.

Error.Code value

Description

InternalServerError

An unknown error occurred.

Canceled

The operation was canceled by a different, concurrent operation.

NotFound

The specified resource was not found.

BadRequest

The input contains invalid parameters.

RetryableError

A retry-able error occurred. This error is an indication that the client SHOULD retry the previous operation.

PublicIPAddressInUse

A public IP address specified in the request is already in use.

StaticAllocationMethodNotSupported

The static allocation method for public IP addresses is not supported.

PublicIPAddressMissing

A public IP address is required when the privateIPAllocationMethod is static.

SubnetIsFull

The subnet of the virtual or logical network does not have any more available IP addresses.

PrivateIPAddressMissing

A private IP address is required when the privateIPAllocationMethod property is static.

SubnetIsRequired

Subnet reference is required for IP configuration resources.

PrivateIPAddressNotInSubnet

The specified private static IP address does not belong to the range of subnet prefix.

PrivateIPAddressInReservedRange

The specified private static IP address falls within reserved IP range of subnet prefix.

InvalidPrivateIPAddressFormat

The private static IP address value is invalid.

PrivateIPAddressInUse

Another IP configuration is already using the specified IP address.

FrontendPrivateIPAddressIsNotNull

The front-end private IP address MUST NOT be specified when subnet is not specified.

FrontendPrivateIPAllocationMethodIsNotDynamic

The front-end private IP allocation method MUST be set to "Dynamic" when subnet is not specified.

InvalidResourceReference

The specified resource reference is invalid.

InvalidRequestFormat

The request cannot be parsed.

Note This is a top-level error with InvalidJson, InvalidJsonReferenceWrongType used as error details.

InvalidJson

Errors were encountered while parsing the request body.

InvalidJsonReferenceWrongType

An invalid resource reference was encountered.

InvalidJsonReferenceFormat

The resource reference format is invalid.

PublicIPAddressInUseCannotUpdate

The properties for the specified public IP address cannot be updated because the public IP is in use.

MultipleGatwaysUseSameVnet

More than one gateway is associated with subnets of this VNet.

InvalidGatewayIPCount

The specified VPN Gateway has more than one IP configuration.

DuplicateLocalVpnGatewayAddress

The specified VPN Gateway defines two local networks with the same local VPN Gateway address property but different address space.

ReferencedResourceNotProvisioned

The referenced resource has not been successfully provisioned.

DnsRecordInUse

The specified DNS record is already in use by another public IP.

InvalidDomainNameLabel

The domain name label is invalid.

DomainNameLabelCannotBeNullOrEmpty

The domain name label for a DNS record specified for the public IP address is null or empty. If a DNS record is specified, its domain name label MUST NOT be null or empty.

InUseSubnetCannotBeDeleted

The specified subnet is in use and cannot be deleted.

SubnetsOldReferencesNotCleanedUp

Subnets cannot be updated or deleted because old references for following subnets have not been released yet.

InUseSubnetCannotBeUpdated

The subnet is in use and cannot be updated.

VnetInUse

The properties on the virtual network resource cannot be changed because it is in use.

AnotherOperationInProgress

Another operation on this or dependent resource is in progress.

DnsServerCountLimitReached

The limit has been reached for the number of DNS servers allowed for a virtual network.<33>

NicInUse

The networkInterfaces resource is in use.

OperationNotSupported

The specified operation on the specified resource is not supported.

OutboundNatRulesAreNotSupported

Outbound NAT rules are not supported.

RuleNameDuplicate

Two rules of different types use the same name.

InvalidFrontendIPCount

The load balancer resources MUST have one front-end IP configuration.

FrontendIPConfigHasNoSubnetOrPublicIP

The front-end IP configuration MUST reference either a subnet or a public IP address.

FrontendIPConfigHasBothSubnetAndPublicIP

The front-end IP configuration MUST NOT reference both a subnet and a public IP address.

RulesUseSameFrontendPort

Multiple load balancer rules cannot use the same front-end port.

RulesUseSameBackendPort

Multiple load balancer rules cannot use the same back-end port.

InvalidProtocolForProbe

The probe can use only HTTP or TCP protocol.

ProbeRequestPathIsNotNull

The probe request path MUST be null when its protocol is TCP.

ProbeIntervalIsOutOfRange

The probe interval is invalid.

ProbeRequestPathIsRequired

A request path is required for probes that use the HTTP protocol.

PortValueIsOutOfRange

The port value is invalid.

NumberOfProbesIsOutOfRange

The numberOfProbes value for the probe is invalid.

BackendAndFrontendPortsAreDifferent

The load balancer rule MUST use the same front-end and back-end ports, because its enableFloatingIP flag is set to TRUE.

RuleIdleTimeoutIsOutOfRange

The load balancer rule has invalid Idle Timeout.

PublicIPIdleTimeoutIsOutOfRange

The public IP address has invalid Idle Timeout.

BackendIPConfigurationsDontUseSameVnet

Not all back-end IP configurations that are referenced by the load balancer use the same virtual network.

FrontendIPConfigAndBackendIPConfigsAreInDifferentVnets

Not all back-end IP configurations that are referenced by the load balancer use the same virtual network as front-end IP configurations of the load balancer.

CannotSwitchLbBetweenAvailabilitySets

The load balancer cannot be reassigned from one availability set to another.

InvalidResourceName

The resource name is invalid.

InvalidRouteAddressPrefix

The addressPrefix property for the specified route is invalid.

AddressPrefixInRestrictedAddressSpace

The addressPrefix property for the specified route is not allowed.

MissingNextHopIpAddress

The nextHopIpAddress property cannot be null or empty.

InvalidNextHopIpAddress

The nextHopIpAddress property for the specified route is invalid.

AddressPrefixMustBeInPublicAddressSpace

Invalid addressPrefix property for route. The nextHopType property MUST have addressPrefix in public address space.

NextHopIpAddressNotAllowed

The nextHopIpAddress for the route cannot be specified.

InUseRouteTableCannotBeDeleted

The specified route table is in use and cannot be deleted.

RouteCountLimitReached

The number of allowed routes in a route table has been exceeded.

RouteConflict

Two or more routes cannot have the same addressPrefix property.

InUseFrontendIpConfigurationCannotBeDeleted

The specified front-end IP configuration is in use and cannot be deleted.

InUseBackendAddressPoolCannotBeDeleted

The specified back-end address pool is in use and cannot be deleted.

InUseProbeCannotBeDeleted

The specified probe is in use and cannot be deleted.

InUseAccessControlListCannotBeDeleted

The specified accessControlLists resource is in use and cannot be deleted.

InvalidParameterValue

An invalid parameter was specified.

ValidationError

A validation error occurred.

ServiceUnavailable

The Network Controller REST service is unavailable.

InvalidLogicalNetworkReference

A logical network resource is required for creating a virtual network. Specify a valid reference to an existing logical network resource.

InvalidIPAddress

The IP address is not in the correct format.

InvalidIPPrefix

The IP prefix is not in the correct format.

PrivateMacAddressMissing

A private MAC address is required when privateMacAllocationMethod property is static.

InvalidPrivateMacAddress

The private static MAC address is invalid.

InvalidNetworkInterfaceReference

A network interface reference is not valid.

InUseServiceInsertionCannotBeDeleted

The specified serviceInsertions resource is in use and cannot be deleted.

InUseServerCannotBeDeleted

The specified server resource is in use.

InUseVirtualServerCannotBeDeleted

The specified virtualServers resource is in use and cannot be deleted.

InUseIpPoolCannotBeDeleted

The specified ipPool resource is in use and cannot be deleted.

ResourceInUse

A resource cannot be deleted because a related resource is in use.

IsHostVirtualNetworkInterfaceCannotBeUpdated

The isHostVirtualNetworkInterface property cannot be updated after the network interface has been created.

HostVirtualNetworkInterfaceCannotConnectToVirtualNetwork

The host virtual network interface cannot be connected to a virtual network.

PrivateMacAllocationMethodCannotBeUpdated

The privateMacAllocationMethod property cannot be updated after the network interface has been created.

InUseQosSettingsCannotBeUpdated

The quality of service (QoS) settings are referenced by one or more network interfaces and cannot be modified.

QosGlobalSettingsNotConfigured

The QoS global settings are not configured. The QoS configuration cannot be specified on the network interface.

InvalidSubnet

An invalid subnet was specified.

AclRuleNullOrEmptySourceAddressPrefix

The sourceAddressPrefix property cannot be null or empty.

AclRuleNullOrEmptyDestinationAddressPrefix

The destinationAddressPrefix property cannot be null or empty.

AclRuleNullOrEmptySourcePortRange

The sourcePortRange property cannot be null or empty.

AclRuleNullOrEmptyDestinationPortRange

The destinationPortRange property cannot be null or empty.

InvalidAclRuleType

The ACL rules type is invalid.

InvalidAclRuleAction

The ACL rules action is invalid.

InvalidAclRulePriority

The specified priority is invalid.

InvalidAclRuleProtocol

The specified protocol is invalid. Possible values are TCP, UDP, or ALL.

UpgradeInProgress

The operation failed because an internal upgrade is in progress.

NetworkMismatch

Both networks are not of the same type.

VirtualNetworkMismatch

The senderVirtualNetwork property MUST be same as the receiverVirtualNetwork property..

AclRuleTagsNotSupportedOnLogicalNetwork

The ACL rule does not support tags on network interfaces with an IP configuration in a logical subnet.

RouteNextHopIpAddressNotFound

The nextHopIpAddress route resource was not found within the virtual network to which the route table is connected.

UnmanagedAllocationMethodNotSupported

Unmanaged IP allocation is not supported on virtual network or logical networks where virtualization is enabled.

InUseVipPoolCannotBeRemoved

A pool that has VIPs allocated from it cannot be removed from the load balancer manager.

LbManagerResourceNotConfigured

The loadBalancerManager resource MUST be configured before a loadBalancers resource can be configured.

FrontEndIpNotInVipPool

The specified front-end IP address is not part of a VIP Pool.

FrontendPrivateIpAllocationMethodIsNotStatic

The front-end private IP allocation method MUST be set to "Static" when subnet is specified.

VipRangeTooLarge

The maximum number of addresses allowed in a single VIP range has been exceeded.

PrimaryNicPropertyCannotBeUpdated

The primary NIC property for a network interface resource cannot be updated after the resource has been created.

OnlyPrimaryNetworkInterfaceCanHaveDnsSettings

Only primary network interfaces can have DNS settings.

RestoreOperationInProgress

A restore operation is in progress.

AclRuleInvalidSourcePortRange

The sourcePortRange value is invalid.

BackupFolderNotEmpty

The backup folder path is not empty.

AclRuleInvalidDestinationPortRange

The destinationPortRange value is invalid.

AclRuleInvalidSourceAddressPrefix

The sourceAddressPrefix value is invalid.

AclRuleInvalidDestinationAddressPrefix

The destinationAddressPrefix value is invalid.

TransientError

A retry-able error occurred. This error is an indication that the client SHOULD retry the previous operation.

PublicIPAddressVersionCannotUpdate

The IP version cannot be changed from IPv4 to IPv6 or vice-versa.

UnsupportedCredentialType

Only the X509Certificate credential can be used to encrypt the subnet.

InUseCredentialCannotBeDeleted

The credential is in use and cannot be deleted.

InboundNatRuleInUse

The network interface cannot use the NAT rule because it is already in use by another network interface.

InvalidVsidRangeFormat

The virtualSubnetIdRange property value is invalid. The range start value MUST be lower than the end value.

InvalidVsidRangeValues

The virtualSubnetIdRange property value is invalid. The range start and end values MUST be between the listed bounds.

MinimumApiVersionNotSpecifiedForVsidRange

Specified API version (URI version) does not meet the minimum required API version for the virtual subnet ID range configuration.

InvalidUnbilledAddressRange

An invalid unbilled address range was specified for the resource.

UseRemoteAndAllowTransitCannotBeTrue

Peering cannot have both useRemoteGateways flag and allowGatewayTransit flag set to TRUE.

RemoteVnetHasNoGateways

Peering cannot have useRemoteGateways flag set to TRUE, because the remote virtual network referenced by the peering does not have any gateways.

ParentVnetAlreadyHasGateways

Peering cannot have useRemoteGateways flag set to TRUE, because the parent virtual network already has a gateway configured.

AnotherPeeringAlreadyUsesRemoteGateways

Peering cannot have useRemoteGateways flag set to TRUE, because another peering already has useRemoteGateways flag set to TRUE.

RemotePeeringDoesNotAllowGatewayTransit

Peering cannot have useRemoteGateways flag set to TRUE, because corresponding remote peering has allowGatewayTransit flag set to FALSE.

RemoteVirtualNetworkNotSpecified

A remoteVirtualNetwork property is required for peering.

ChangingRemoteVirtualNetworkNotAllowed

Changing the remoteVirtualNetwork property of a peering is not allowed. Delete and re-create the peering with new remoteVirtualNetwork value instead.

AnotherPeeringAlreadyReferencesRemoteVnet

The peering resource already references the remote virtual network. Cannot add another peering referencing the same remote virtual network.

VnetAddressSpacesOverlap

The peering resource cannot be created or updated. The virtual networks cannot be peered because their address spaces overlap.

VnetAddressSpaceOverlapsWithAlreadyPeeredVnet

The peering resource cannot be created or updated. The virtual networks cannot be peered because address space of the first virtual network overlaps with address space of a third virtual network that is already peered with the second virtual network.

RemotePeeringIsStaleBecauseVnetWasRecreated

The peering resource cannot be created or updated because a remote peering resource is stale. It became stale because the virtual network was deleted and re-created. Update or re-create the remote peering to make sure it is in sync with the virtual network.

PeeringRemoteVnetIsSameAsParentVnet

The remoteVirtualNetwork property of the peering resource cannot reference the parent virtual network of the peering.

VnetAddressSpaceCannotChangeDueToPeerings

The address space of the virtual network cannot be changed when the virtual network has peering resources.

AclRuleBothDestinationAddressPrefixAndSecurityTagsPresent

The destinationAddressPrefix and the destinationSecurityTags properties cannot both have values.

AclRuleBothSourceAddressPrefixAndSecurityTagsPresent

The sourceAddressPrefix and the sourceSecurityTags properties cannot both have values.

AclRuleDestinationNeitherAddressPrefixNorSecurityTagsPresent

The destinationAddressPrefix and destinationSecurityTags properties cannot both be null or empty.

AclRuleSourceNeitherAddressPrefixNorSecurityTagsPresent

The sourceAddressPrefix and the sourceSecurityTags properties cannot both be null or empty.

InUseSecurityTagCannotBeDeleted

A security tag is in use and cannot be deleted.

MultisiteCannotSpecifyBothCertificateSubjectNameAndSecurityGroup

The certificate subject name and security group cannot both be specified for multisite configuration.

MultisiteCertificateSubjectNameCannotBeSpecifiedWithWindowsAuth

The certificate subject name cannot be specified for site if multisite is configured to use Windows authorization.

InvalidMultisiteApiVersion

Invalid API version specified in the request URL.

BackendPoolReferenceNotProvided

The load balancer rule does not have any reference to back-end address pool.

FrontendIpConfigReferenceNotProvided

The load balancer rule does not have any reference to front-end IP configuration.

AnyPortProtocolNotAllowedWithOtherInboundRules

The front-end IP configuration SHOULD only have one inbound rule if that rule load balances across all ports. Remove other load balancing rules and inbound NAT rules.

InvalidAnyPortAnyProtocolInboundRule

A rule that supports any port and protocol load balancing MUST have the following settings: FrontendPort: 0, BackendPort: 0, and Protocol: All.

AnyPortProtocolNotAllowedWithOtherOutboundNatRules

The front-end IP configuration cannot have an outbound NAT rule because it has an inbound rule that load balances across all ports.

IpConfigCannotHaveFloatingIpAnyPortLbRulesWithNonFloatingIpRules

The network interface IP configuration cannot reference Floating IP-enabled AnyPort (HA Port) Protocol rules with other Floating IP-disabled load balancing rules.

IpConfigCannotHaveOtherLbRulesWithNonFloatingIpAnyPortRule

The network interface IP configuration cannot reference Floating IP-disabled AnyPort (HA Port) Protocol rule with any other load balancing rule.

LoadBalancerHasBothPublicAndInternalFrontends

The load balancer contains both public and internal front ends. All front-end IPs SHOULD either be from a logical network or a virtual network.

IpConfigCannotChangeFromInternalToPublicViceVersa

The front-end IP configuration cannot change from internal to public or vice versa.

LearnedIpConfigModified

The IP configurations with AddressAllocationType Learned or IP addresses for learned IP cannot be modified

LearnedIpConfigMissingPrimary

The IP configurations with AddressAllocationType Learned require a primary IP configuration on the network interface.

LearnedIpConfigCannotBePrimary

The IP configuration with AddressAllocationType Learned cannot be the primary IP configuration.

LearnedIpConfigCannotBeLoadbalancedOrHavePublicIP

The IP configuration with AddressAllocationType Learned cannot be load balanced or contain a public IP address.

LearnedIpConfigInvalidConfiguration

The IP configuration with AddressAllocationType Learned is invalid.

SingleLearnedIpPerNic

Only one IP configuration with AddressAllocationType Learned is supported per virtual network interface card (VNIC).

LearnedIpConfigurationNotSupported

Only URI version v5 and above support Learned IP configurations.

LearnedIpAddressSubnetMissing

A valid subnet reference MUST be provided for Learned IP configuration.

LearnedIpInvalidIpAddress

A valid IP address was not provided for Learned IP configuration.

LearnedIpSubnetNotReady

The subnet is not ready for provisioning a Learned IP address.

LearnedIpNotPartofSubnet

The Learned IP is not a part of the subnet.

LearnedIpConfigPrivateIpNotSet

The IP address is not set for the Learned IP resource.

LearnedIpSubnetInUse

The subnet cannot be removed because it is in use by learned IP.

InvalidMacAddressForMacPool

Invalid MAC address as start or end of a MAC pool.

MacPoolContainsMulticastAddresses

A MAC pool cannot contain any multicast addresses.

PrivateIpAllocationMethodCannotBeUpdated

The privateIpAllocationMethod property cannot be updated after the network interface has been created.

PrivateIpAllocationMethodMustBeUnmanaged

The privateIpAllocationMethod property of network interface MUST be set to "Unmanaged" if it belongs to a logical subnet without an address prefix.

OutboundIdleTimeoutImmutableIfLessThanV4_2

The default outbound idle timeout cannot be changed if the version of the NRP API is &lt; 4.2 (less than 4.2).

FeatureDisabled

The feature  is disabled on this platform.

FrontendIPConfigDoesNotSupportServiceInsertion

The logical subnet has a reference to service insertion, which is not supported.

ServiceInsertionElementWithUnsupportedNetworkInterface

The service insertion element does not support a network interface with IP configuration in a logical subnet.

VirtualSubnetIsRequiredForServiceInsertion

The IP configuration has a reference to service insertion, which requires virtual subnet reference.

SiteCountLimitReached

The limit of (the count of) Network Controller sites has been reached. No more can be created.

SecurityTagAlreadyHasAclApplied

The security tag already has access control list applied.

BrownfieldSites

Both sites have global resources. Delete global resources on one of the sites and retry the operation.

ResourceFailedRemoteSiteValidation

The resource failed validation in the remote site.

SiteHasConflictingResource

A conflicting resource already exists in site.

CanceledByRemoteSite

The operation was canceled by another operation from a remote site.

CanceledByPrimarySite

The operation was canceled by primary site.

OperationFailedInPrimarySite

The operation failed in primary site.

InvalidOutboundNatProtocolType

There is an invalid outbound NAT rule protocol type on this version of NetworkController.

LnetDynamicAllocationBlocked

The logical network dynamic IP address allocation is blocked until the one-time migration of currently configured static IP addresses to address space manager is complete.

LnetDynamicAllocationBlockedIfLessThanV6

The logical network dynamic IP address allocation is not supported for NRP API versions earlier than V5.

FrontendIpConfigSubnetNoAddrPrefix

The front-end IP configuration cannot reference a subnet with no address prefix.

CannotUpdateDisconnectedPeeringWithNullRemoteVnet

A disconnected peering with a null remote virtual network reference cannot be updated.

CannotUpdateMuxModeAfterCreatingLoadBalancerMuxes

The mux mode cannot be updated because one or more load balancer muxes have already been created.

CannotUpdateMuxModeAfterCreatingNetworkInterfaceWithPublicIP

The mux mode cannot be updated because one or more network interfaces with public IP addresses are configured.

CannotUpdateMuxModeAfterCreatingLoadBalancers

The mux mode cannot be updated because one or more load balancers have already been created.

CannotUpdateMuxModeAfterCreatingVirtualGatewayWithIPSecConnection

The mux mode cannot be updated because one or more virtual gateways have already been created with an IPSec network connection.

LoadBalancerMuxModeNotSupported

An invalid load balancer mux mode is on this version of the Network Controller.

DuplicateNonZeroVIPSubnetVLanID

More than one VIP subnet have same VLAN ID.

CannotUpdateNetworkInterfaceAfterCreationInL2ForwardingMode

The internal or external network interface references for a load balancer mux in L2Forwarding mode cannot be updated.

RequiredParamMissing

A required parameter is missing.

CannotUpdateVLanId

The VLAN ID cannot be modified for the subnet because it has one or more vipIpPools properties allocated from it.

CommonNameExtractionFailed

Subject distinguished name detected but failed to extract common name from subject distinguished name.

UpdateBackendAddressPoolsNotAllowed

Cannot specify updateBackendAddressPools if NRP API version is earlier than V7.